Class: IntersightClient::ChassisApi

Inherits:
Object
  • Object
show all
Defined in:
lib/intersight_client/api/chassis_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ChassisApi 



19
20
21
 
# File 'lib/intersight_client/api/chassis_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/intersight_client/api/chassis_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_chassis_config_import(chassis_config_import, opts = {}) ⇒ ChassisConfigImport

Create a ‘chassis.ConfigImport’ resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.

  • :if_none_match (String) —

    For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don't have to be identical byte for byte.



28
29
30
31
 
# File 'lib/intersight_client/api/chassis_api.rb', line 28

def create_chassis_config_import(chassis_config_import, opts = {})
  data, _status_code, _headers = create_chassis_config_import_with_http_info(chassis_config_import, opts)
  data
end

#create_chassis_config_import_with_http_info(chassis_config_import, opts = {}) ⇒ Array<(ChassisConfigImport, Integer, Hash)>

Create a &#39;chassis.ConfigImport&#39; resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.

  • :if_none_match (String) —

    For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn&#39;t happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource&#39;s ETag doesn&#39;t match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don&#39;t have to be identical byte for byte.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/intersight_client/api/chassis_api.rb', line 39

def create_chassis_config_import_with_http_info(chassis_config_import, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.create_chassis_config_import ...'
  end
  # verify the required parameter 'chassis_config_import' is set
  if @api_client.config.client_side_validation && chassis_config_import.nil?
    fail ArgumentError, "Missing the required parameter 'chassis_config_import' when calling ChassisApi.create_chassis_config_import"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigImports'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(chassis_config_import)

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigImport'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.create_chassis_config_import",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#create_chassis_config_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_chassis_profile(chassis_profile, opts = {}) ⇒ ChassisProfile

Create a ‘chassis.Profile’ resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.

  • :if_none_match (String) —

    For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn&#39;t happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource&#39;s ETag doesn&#39;t match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don&#39;t have to be identical byte for byte.



100
101
102
103
 
# File 'lib/intersight_client/api/chassis_api.rb', line 100

def create_chassis_profile(chassis_profile, opts = {})
  data, _status_code, _headers = create_chassis_profile_with_http_info(chassis_profile, opts)
  data
end

#create_chassis_profile_with_http_info(chassis_profile, opts = {}) ⇒ Array<(ChassisProfile, Integer, Hash)>

Create a &#39;chassis.Profile&#39; resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.

  • :if_none_match (String) —

    For methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn&#39;t happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource&#39;s ETag doesn&#39;t match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don&#39;t have to be identical byte for byte.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/intersight_client/api/chassis_api.rb', line 111

def create_chassis_profile_with_http_info(chassis_profile, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.create_chassis_profile ...'
  end
  # verify the required parameter 'chassis_profile' is set
  if @api_client.config.client_side_validation && chassis_profile.nil?
    fail ArgumentError, "Missing the required parameter 'chassis_profile' when calling ChassisApi.create_chassis_profile"
  end
  # resource path
  local_var_path = '/api/v1/chassis/Profiles'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(chassis_profile)

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisProfile'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.create_chassis_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#create_chassis_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_chassis_profile(moid, opts = {}) ⇒ nil

Delete a ‘chassis.Profile’ resource.



170
171
172
173
 
# File 'lib/intersight_client/api/chassis_api.rb', line 170

def delete_chassis_profile(moid, opts = {})
  delete_chassis_profile_with_http_info(moid, opts)
  nil
end

#delete_chassis_profile_with_http_info(moid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a &#39;chassis.Profile&#39; resource.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/intersight_client/api/chassis_api.rb', line 179

def delete_chassis_profile_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.delete_chassis_profile ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.delete_chassis_profile"
  end
  # resource path
  local_var_path = '/api/v1/chassis/Profiles/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.delete_chassis_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#delete_chassis_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_change_detail_by_moid(moid, opts = {}) ⇒ ChassisConfigChangeDetail

Read a ‘chassis.ConfigChangeDetail’ resource.



231
232
233
234
 
# File 'lib/intersight_client/api/chassis_api.rb', line 231

def get_chassis_config_change_detail_by_moid(moid, opts = {})
  data, _status_code, _headers = get_chassis_config_change_detail_by_moid_with_http_info(moid, opts)
  data
end

#get_chassis_config_change_detail_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ChassisConfigChangeDetail, Integer, Hash)>

Read a &#39;chassis.ConfigChangeDetail&#39; resource.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/intersight_client/api/chassis_api.rb', line 240

def get_chassis_config_change_detail_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_change_detail_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.get_chassis_config_change_detail_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigChangeDetails/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigChangeDetail'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_change_detail_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_change_detail_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_change_detail_list(opts = {}) ⇒ ChassisConfigChangeDetailResponse

Read a ‘chassis.ConfigChangeDetail’ resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (default to ”)

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response. (default to 100)

  • :skip (Integer) —

    Specifies the number of resources to skip in the response. (default to 0)

  • :select (String) —

    Specifies a subset of properties to return. (default to ”)

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



302
303
304
305
 
# File 'lib/intersight_client/api/chassis_api.rb', line 302

def get_chassis_config_change_detail_list(opts = {})
  data, _status_code, _headers = get_chassis_config_change_detail_list_with_http_info(opts)
  data
end

#get_chassis_config_change_detail_list_with_http_info(opts = {}) ⇒ Array<(ChassisConfigChangeDetailResponse, Integer, Hash)>

Read a &#39;chassis.ConfigChangeDetail&#39; resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response.

  • :skip (Integer) —

    Specifies the number of resources to skip in the response.

  • :select (String) —

    Specifies a subset of properties to return.

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/intersight_client/api/chassis_api.rb', line 321

def get_chassis_config_change_detail_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_change_detail_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigChangeDetails'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigChangeDetailResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_change_detail_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_change_detail_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_import_by_moid(moid, opts = {}) ⇒ ChassisConfigImport

Read a ‘chassis.ConfigImport’ resource.



384
385
386
387
 
# File 'lib/intersight_client/api/chassis_api.rb', line 384

def get_chassis_config_import_by_moid(moid, opts = {})
  data, _status_code, _headers = get_chassis_config_import_by_moid_with_http_info(moid, opts)
  data
end

#get_chassis_config_import_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ChassisConfigImport, Integer, Hash)>

Read a &#39;chassis.ConfigImport&#39; resource.



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/intersight_client/api/chassis_api.rb', line 393

def get_chassis_config_import_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_import_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.get_chassis_config_import_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigImports/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigImport'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_import_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_import_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_import_list(opts = {}) ⇒ ChassisConfigImportResponse

Read a ‘chassis.ConfigImport’ resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (default to ”)

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response. (default to 100)

  • :skip (Integer) —

    Specifies the number of resources to skip in the response. (default to 0)

  • :select (String) —

    Specifies a subset of properties to return. (default to ”)

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



455
456
457
458
 
# File 'lib/intersight_client/api/chassis_api.rb', line 455

def get_chassis_config_import_list(opts = {})
  data, _status_code, _headers = get_chassis_config_import_list_with_http_info(opts)
  data
end

#get_chassis_config_import_list_with_http_info(opts = {}) ⇒ Array<(ChassisConfigImportResponse, Integer, Hash)>

Read a &#39;chassis.ConfigImport&#39; resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response.

  • :skip (Integer) —

    Specifies the number of resources to skip in the response.

  • :select (String) —

    Specifies a subset of properties to return.

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/intersight_client/api/chassis_api.rb', line 474

def get_chassis_config_import_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_import_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigImports'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigImportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_import_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_import_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_result_by_moid(moid, opts = {}) ⇒ ChassisConfigResult

Read a ‘chassis.ConfigResult’ resource.



537
538
539
540
 
# File 'lib/intersight_client/api/chassis_api.rb', line 537

def get_chassis_config_result_by_moid(moid, opts = {})
  data, _status_code, _headers = get_chassis_config_result_by_moid_with_http_info(moid, opts)
  data
end

#get_chassis_config_result_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ChassisConfigResult, Integer, Hash)>

Read a &#39;chassis.ConfigResult&#39; resource.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/intersight_client/api/chassis_api.rb', line 546

def get_chassis_config_result_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_result_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.get_chassis_config_result_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigResults/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_result_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_result_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_result_entry_by_moid(moid, opts = {}) ⇒ ChassisConfigResultEntry

Read a ‘chassis.ConfigResultEntry’ resource.



598
599
600
601
 
# File 'lib/intersight_client/api/chassis_api.rb', line 598

def get_chassis_config_result_entry_by_moid(moid, opts = {})
  data, _status_code, _headers = get_chassis_config_result_entry_by_moid_with_http_info(moid, opts)
  data
end

#get_chassis_config_result_entry_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ChassisConfigResultEntry, Integer, Hash)>

Read a &#39;chassis.ConfigResultEntry&#39; resource.



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/intersight_client/api/chassis_api.rb', line 607

def get_chassis_config_result_entry_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_result_entry_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.get_chassis_config_result_entry_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigResultEntries/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigResultEntry'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_result_entry_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_result_entry_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_result_entry_list(opts = {}) ⇒ ChassisConfigResultEntryResponse

Read a ‘chassis.ConfigResultEntry’ resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (default to ”)

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response. (default to 100)

  • :skip (Integer) —

    Specifies the number of resources to skip in the response. (default to 0)

  • :select (String) —

    Specifies a subset of properties to return. (default to ”)

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



669
670
671
672
 
# File 'lib/intersight_client/api/chassis_api.rb', line 669

def get_chassis_config_result_entry_list(opts = {})
  data, _status_code, _headers = get_chassis_config_result_entry_list_with_http_info(opts)
  data
end

#get_chassis_config_result_entry_list_with_http_info(opts = {}) ⇒ Array<(ChassisConfigResultEntryResponse, Integer, Hash)>

Read a &#39;chassis.ConfigResultEntry&#39; resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response.

  • :skip (Integer) —

    Specifies the number of resources to skip in the response.

  • :select (String) —

    Specifies a subset of properties to return.

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/intersight_client/api/chassis_api.rb', line 688

def get_chassis_config_result_entry_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_result_entry_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigResultEntries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigResultEntryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_result_entry_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_result_entry_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_config_result_list(opts = {}) ⇒ ChassisConfigResultResponse

Read a ‘chassis.ConfigResult’ resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (default to ”)

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response. (default to 100)

  • :skip (Integer) —

    Specifies the number of resources to skip in the response. (default to 0)

  • :select (String) —

    Specifies a subset of properties to return. (default to ”)

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



761
762
763
764
 
# File 'lib/intersight_client/api/chassis_api.rb', line 761

def get_chassis_config_result_list(opts = {})
  data, _status_code, _headers = get_chassis_config_result_list_with_http_info(opts)
  data
end

#get_chassis_config_result_list_with_http_info(opts = {}) ⇒ Array<(ChassisConfigResultResponse, Integer, Hash)>

Read a &#39;chassis.ConfigResult&#39; resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response.

  • :skip (Integer) —

    Specifies the number of resources to skip in the response.

  • :select (String) —

    Specifies a subset of properties to return.

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/intersight_client/api/chassis_api.rb', line 780

def get_chassis_config_result_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_config_result_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/chassis/ConfigResults'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisConfigResultResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_config_result_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_config_result_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_iom_profile_by_moid(moid, opts = {}) ⇒ ChassisIomProfile

Read a ‘chassis.IomProfile’ resource.



843
844
845
846
 
# File 'lib/intersight_client/api/chassis_api.rb', line 843

def get_chassis_iom_profile_by_moid(moid, opts = {})
  data, _status_code, _headers = get_chassis_iom_profile_by_moid_with_http_info(moid, opts)
  data
end

#get_chassis_iom_profile_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ChassisIomProfile, Integer, Hash)>

Read a &#39;chassis.IomProfile&#39; resource.



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/intersight_client/api/chassis_api.rb', line 852

def get_chassis_iom_profile_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_iom_profile_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.get_chassis_iom_profile_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/chassis/IomProfiles/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisIomProfile'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_iom_profile_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_iom_profile_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_iom_profile_list(opts = {}) ⇒ ChassisIomProfileResponse

Read a ‘chassis.IomProfile’ resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (default to ”)

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response. (default to 100)

  • :skip (Integer) —

    Specifies the number of resources to skip in the response. (default to 0)

  • :select (String) —

    Specifies a subset of properties to return. (default to ”)

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



914
915
916
917
 
# File 'lib/intersight_client/api/chassis_api.rb', line 914

def get_chassis_iom_profile_list(opts = {})
  data, _status_code, _headers = get_chassis_iom_profile_list_with_http_info(opts)
  data
end

#get_chassis_iom_profile_list_with_http_info(opts = {}) ⇒ Array<(ChassisIomProfileResponse, Integer, Hash)>

Read a &#39;chassis.IomProfile&#39; resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response.

  • :skip (Integer) —

    Specifies the number of resources to skip in the response.

  • :select (String) —

    Specifies a subset of properties to return.

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/intersight_client/api/chassis_api.rb', line 933

def get_chassis_iom_profile_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_iom_profile_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/chassis/IomProfiles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisIomProfileResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_iom_profile_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_iom_profile_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_profile_by_moid(moid, opts = {}) ⇒ ChassisProfile

Read a ‘chassis.Profile’ resource.



996
997
998
999
 
# File 'lib/intersight_client/api/chassis_api.rb', line 996

def get_chassis_profile_by_moid(moid, opts = {})
  data, _status_code, _headers = get_chassis_profile_by_moid_with_http_info(moid, opts)
  data
end

#get_chassis_profile_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ChassisProfile, Integer, Hash)>

Read a &#39;chassis.Profile&#39; resource.



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1005

def get_chassis_profile_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_profile_by_moid ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.get_chassis_profile_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/chassis/Profiles/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisProfile'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_profile_by_moid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_profile_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chassis_profile_list(opts = {}) ⇒ ChassisProfileResponse

Read a ‘chassis.Profile’ resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (default to ”)

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response. (default to 100)

  • :skip (Integer) —

    Specifies the number of resources to skip in the response. (default to 0)

  • :select (String) —

    Specifies a subset of properties to return. (default to ”)

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (default to ‘allpages’)

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



1067
1068
1069
1070
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1067

def get_chassis_profile_list(opts = {})
  data, _status_code, _headers = get_chassis_profile_list_with_http_info(opts)
  data
end

#get_chassis_profile_list_with_http_info(opts = {}) ⇒ Array<(ChassisProfileResponse, Integer, Hash)>

Read a &#39;chassis.Profile&#39; resource.

Options Hash (opts):

  • :filter (String) —

    Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false).

  • :orderby (String) —

    Determines what properties are used to sort the collection of resources.

  • :top (Integer) —

    Specifies the maximum number of resources to return in the response.

  • :skip (Integer) —

    Specifies the number of resources to skip in the response.

  • :select (String) —

    Specifies a subset of properties to return.

  • :expand (String) —

    Specify additional attributes or related resources to return in addition to the primary resources.

  • :apply (String) —

    Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The &quot;$apply&quot; query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e. the result of each transformation is the input to the next transformation. Supported aggregation methods are &quot;aggregate&quot; and &quot;groupby&quot;. The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set.

  • :count (Boolean) —

    The $count query specifies the service should return the count of the matching resources, instead of returning the resources.

  • :inlinecount (String) —

    The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.

  • :at (String) —

    Similar to &quot;$filter&quot;, but &quot;at&quot; is specifically used to filter versioning information properties for resources to return. A URI with an &quot;at&quot; Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section.

  • :tags (String) —

    The &#39;tags&#39; parameter is used to request a summary of the Tag utilization for this resource. When the &#39;tags&#39; parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1086

def get_chassis_profile_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.get_chassis_profile_list ...'
  end
  allowable_values = ["allpages", "none"]
  if @api_client.config.client_side_validation && opts[:'inlinecount'] && !allowable_values.include?(opts[:'inlinecount'])
    fail ArgumentError, "invalid value for \"inlinecount\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/chassis/Profiles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$apply'] = opts[:'apply'] if !opts[:'apply'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisProfileResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.get_chassis_profile_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#get_chassis_profile_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_chassis_profile(moid, chassis_profile, opts = {}) ⇒ ChassisProfile

Update a ‘chassis.Profile’ resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.



1151
1152
1153
1154
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1151

def patch_chassis_profile(moid, chassis_profile, opts = {})
  data, _status_code, _headers = patch_chassis_profile_with_http_info(moid, chassis_profile, opts)
  data
end

#patch_chassis_profile_with_http_info(moid, chassis_profile, opts = {}) ⇒ Array<(ChassisProfile, Integer, Hash)>

Update a &#39;chassis.Profile&#39; resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1162

def patch_chassis_profile_with_http_info(moid, chassis_profile, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.patch_chassis_profile ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.patch_chassis_profile"
  end
  # verify the required parameter 'chassis_profile' is set
  if @api_client.config.client_side_validation && chassis_profile.nil?
    fail ArgumentError, "Missing the required parameter 'chassis_profile' when calling ChassisApi.patch_chassis_profile"
  end
  # resource path
  local_var_path = '/api/v1/chassis/Profiles/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/json-patch+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(chassis_profile)

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisProfile'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.patch_chassis_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#patch_chassis_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_chassis_profile(moid, chassis_profile, opts = {}) ⇒ ChassisProfile

Update a ‘chassis.Profile’ resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.



1226
1227
1228
1229
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1226

def update_chassis_profile(moid, chassis_profile, opts = {})
  data, _status_code, _headers = update_chassis_profile_with_http_info(moid, chassis_profile, opts)
  data
end

#update_chassis_profile_with_http_info(moid, chassis_profile, opts = {}) ⇒ Array<(ChassisProfile, Integer, Hash)>

Update a &#39;chassis.Profile&#39; resource.

Options Hash (opts):

  • :if_match (String) —

    For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/intersight_client/api/chassis_api.rb', line 1237

def update_chassis_profile_with_http_info(moid, chassis_profile, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChassisApi.update_chassis_profile ...'
  end
  # verify the required parameter 'moid' is set
  if @api_client.config.client_side_validation && moid.nil?
    fail ArgumentError, "Missing the required parameter 'moid' when calling ChassisApi.update_chassis_profile"
  end
  # verify the required parameter 'chassis_profile' is set
  if @api_client.config.client_side_validation && chassis_profile.nil?
    fail ArgumentError, "Missing the required parameter 'chassis_profile' when calling ChassisApi.update_chassis_profile"
  end
  # resource path
  local_var_path = '/api/v1/chassis/Profiles/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/json-patch+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(chassis_profile)

  # return_type
  return_type = opts[:debug_return_type] || 'ChassisProfile'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']

  new_options = opts.merge(
    :operation => :"ChassisApi.update_chassis_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChassisApi#update_chassis_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end