Class: IntersightClient::EquipmentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EquipmentApi

Returns a new instance of EquipmentApi.



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

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#get_equipment_chassis_by_moid(moid, opts = {}) ⇒ EquipmentChassis

Read a ‘equipment.Chassis’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



26
27
28
29
# File 'lib/intersight_client/api/equipment_api.rb', line 26

def get_equipment_chassis_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_chassis_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_chassis_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentChassis, Integer, Hash)>

Read a &#39;equipment.Chassis&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentChassis, Integer, Hash)>)

    EquipmentChassis data, response status code and response headers



35
36
37
38
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
# File 'lib/intersight_client/api/equipment_api.rb', line 35

def get_equipment_chassis_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_chassis_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 EquipmentApi.get_equipment_chassis_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Chasses/{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] || 'EquipmentChassis'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_chassis_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: EquipmentApi#get_equipment_chassis_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_chassis_identity_by_moid(moid, opts = {}) ⇒ EquipmentChassisIdentity

Read a ‘equipment.ChassisIdentity’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



87
88
89
90
# File 'lib/intersight_client/api/equipment_api.rb', line 87

def get_equipment_chassis_identity_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_chassis_identity_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_chassis_identity_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentChassisIdentity, Integer, Hash)>

Read a &#39;equipment.ChassisIdentity&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentChassisIdentity, Integer, Hash)>)

    EquipmentChassisIdentity data, response status code and response headers



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
# File 'lib/intersight_client/api/equipment_api.rb', line 96

def get_equipment_chassis_identity_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_chassis_identity_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 EquipmentApi.get_equipment_chassis_identity_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ChassisIdentities/{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] || 'EquipmentChassisIdentity'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_chassis_identity_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: EquipmentApi#get_equipment_chassis_identity_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_chassis_identity_list(opts = {}) ⇒ EquipmentChassisIdentityResponse

Read a ‘equipment.ChassisIdentity’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



158
159
160
161
# File 'lib/intersight_client/api/equipment_api.rb', line 158

def get_equipment_chassis_identity_list(opts = {})
  data, _status_code, _headers = get_equipment_chassis_identity_list_with_http_info(opts)
  data
end

#get_equipment_chassis_identity_list_with_http_info(opts = {}) ⇒ Array<(EquipmentChassisIdentityResponse, Integer, Hash)>

Read a &#39;equipment.ChassisIdentity&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



177
178
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
226
227
228
229
230
231
232
233
234
# File 'lib/intersight_client/api/equipment_api.rb', line 177

def get_equipment_chassis_identity_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_chassis_identity_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/equipment/ChassisIdentities'

  # 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] || 'EquipmentChassisIdentityResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_chassis_identity_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: EquipmentApi#get_equipment_chassis_identity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_chassis_list(opts = {}) ⇒ EquipmentChassisResponse

Read a ‘equipment.Chassis’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



250
251
252
253
# File 'lib/intersight_client/api/equipment_api.rb', line 250

def get_equipment_chassis_list(opts = {})
  data, _status_code, _headers = get_equipment_chassis_list_with_http_info(opts)
  data
end

#get_equipment_chassis_list_with_http_info(opts = {}) ⇒ Array<(EquipmentChassisResponse, Integer, Hash)>

Read a &#39;equipment.Chassis&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassisResponse, Integer, Hash)>)

    EquipmentChassisResponse data, response status code and response headers



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/intersight_client/api/equipment_api.rb', line 269

def get_equipment_chassis_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_chassis_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/equipment/Chasses'

  # 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] || 'EquipmentChassisResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_chassis_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: EquipmentApi#get_equipment_chassis_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_chassis_operation_by_moid(moid, opts = {}) ⇒ EquipmentChassisOperation

Read a ‘equipment.ChassisOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



332
333
334
335
# File 'lib/intersight_client/api/equipment_api.rb', line 332

def get_equipment_chassis_operation_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_chassis_operation_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_chassis_operation_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentChassisOperation, Integer, Hash)>

Read a &#39;equipment.ChassisOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentChassisOperation, Integer, Hash)>)

    EquipmentChassisOperation data, response status code and response headers



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
379
380
381
382
383
384
385
386
387
# File 'lib/intersight_client/api/equipment_api.rb', line 341

def get_equipment_chassis_operation_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_chassis_operation_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 EquipmentApi.get_equipment_chassis_operation_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ChassisOperations/{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] || 'EquipmentChassisOperation'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_chassis_operation_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: EquipmentApi#get_equipment_chassis_operation_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_chassis_operation_list(opts = {}) ⇒ EquipmentChassisOperationResponse

Read a ‘equipment.ChassisOperation’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



403
404
405
406
# File 'lib/intersight_client/api/equipment_api.rb', line 403

def get_equipment_chassis_operation_list(opts = {})
  data, _status_code, _headers = get_equipment_chassis_operation_list_with_http_info(opts)
  data
end

#get_equipment_chassis_operation_list_with_http_info(opts = {}) ⇒ Array<(EquipmentChassisOperationResponse, Integer, Hash)>

Read a &#39;equipment.ChassisOperation&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
# File 'lib/intersight_client/api/equipment_api.rb', line 422

def get_equipment_chassis_operation_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_chassis_operation_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/equipment/ChassisOperations'

  # 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] || 'EquipmentChassisOperationResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_chassis_operation_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: EquipmentApi#get_equipment_chassis_operation_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_device_summary_by_moid(moid, opts = {}) ⇒ EquipmentDeviceSummary

Read a ‘equipment.DeviceSummary’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



485
486
487
488
# File 'lib/intersight_client/api/equipment_api.rb', line 485

def get_equipment_device_summary_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_device_summary_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_device_summary_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentDeviceSummary, Integer, Hash)>

Read a &#39;equipment.DeviceSummary&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentDeviceSummary, Integer, Hash)>)

    EquipmentDeviceSummary data, response status code and response headers



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
532
533
534
535
536
537
538
539
540
# File 'lib/intersight_client/api/equipment_api.rb', line 494

def get_equipment_device_summary_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_device_summary_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 EquipmentApi.get_equipment_device_summary_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/DeviceSummaries/{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] || 'EquipmentDeviceSummary'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_device_summary_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: EquipmentApi#get_equipment_device_summary_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_device_summary_list(opts = {}) ⇒ EquipmentDeviceSummaryResponse

Read a ‘equipment.DeviceSummary’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



556
557
558
559
# File 'lib/intersight_client/api/equipment_api.rb', line 556

def get_equipment_device_summary_list(opts = {})
  data, _status_code, _headers = get_equipment_device_summary_list_with_http_info(opts)
  data
end

#get_equipment_device_summary_list_with_http_info(opts = {}) ⇒ Array<(EquipmentDeviceSummaryResponse, Integer, Hash)>

Read a &#39;equipment.DeviceSummary&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
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
# File 'lib/intersight_client/api/equipment_api.rb', line 575

def get_equipment_device_summary_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_device_summary_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/equipment/DeviceSummaries'

  # 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] || 'EquipmentDeviceSummaryResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_device_summary_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: EquipmentApi#get_equipment_device_summary_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_expander_module_by_moid(moid, opts = {}) ⇒ EquipmentExpanderModule

Read a ‘equipment.ExpanderModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



638
639
640
641
# File 'lib/intersight_client/api/equipment_api.rb', line 638

def get_equipment_expander_module_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_expander_module_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_expander_module_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentExpanderModule, Integer, Hash)>

Read a &#39;equipment.ExpanderModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentExpanderModule, Integer, Hash)>)

    EquipmentExpanderModule data, response status code and response headers



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'lib/intersight_client/api/equipment_api.rb', line 647

def get_equipment_expander_module_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_expander_module_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 EquipmentApi.get_equipment_expander_module_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ExpanderModules/{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] || 'EquipmentExpanderModule'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_expander_module_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: EquipmentApi#get_equipment_expander_module_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_expander_module_list(opts = {}) ⇒ EquipmentExpanderModuleResponse

Read a ‘equipment.ExpanderModule’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



709
710
711
712
# File 'lib/intersight_client/api/equipment_api.rb', line 709

def get_equipment_expander_module_list(opts = {})
  data, _status_code, _headers = get_equipment_expander_module_list_with_http_info(opts)
  data
end

#get_equipment_expander_module_list_with_http_info(opts = {}) ⇒ Array<(EquipmentExpanderModuleResponse, Integer, Hash)>

Read a &#39;equipment.ExpanderModule&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'lib/intersight_client/api/equipment_api.rb', line 728

def get_equipment_expander_module_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_expander_module_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/equipment/ExpanderModules'

  # 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] || 'EquipmentExpanderModuleResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_expander_module_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: EquipmentApi#get_equipment_expander_module_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fan_by_moid(moid, opts = {}) ⇒ EquipmentFan

Read a ‘equipment.Fan’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



791
792
793
794
# File 'lib/intersight_client/api/equipment_api.rb', line 791

def get_equipment_fan_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fan_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fan_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFan, Integer, Hash)>

Read a &#39;equipment.Fan&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFan, Integer, Hash)>)

    EquipmentFan data, response status code and response headers



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
838
839
840
841
842
843
844
845
846
# File 'lib/intersight_client/api/equipment_api.rb', line 800

def get_equipment_fan_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fan_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 EquipmentApi.get_equipment_fan_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Fans/{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] || 'EquipmentFan'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fan_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: EquipmentApi#get_equipment_fan_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fan_control_by_moid(moid, opts = {}) ⇒ EquipmentFanControl

Read a ‘equipment.FanControl’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



852
853
854
855
# File 'lib/intersight_client/api/equipment_api.rb', line 852

def get_equipment_fan_control_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fan_control_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fan_control_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFanControl, Integer, Hash)>

Read a &#39;equipment.FanControl&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFanControl, Integer, Hash)>)

    EquipmentFanControl data, response status code and response headers



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
899
900
901
902
903
904
905
906
907
# File 'lib/intersight_client/api/equipment_api.rb', line 861

def get_equipment_fan_control_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fan_control_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 EquipmentApi.get_equipment_fan_control_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FanControls/{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] || 'EquipmentFanControl'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fan_control_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: EquipmentApi#get_equipment_fan_control_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fan_control_list(opts = {}) ⇒ EquipmentFanControlResponse

Read a ‘equipment.FanControl’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



923
924
925
926
# File 'lib/intersight_client/api/equipment_api.rb', line 923

def get_equipment_fan_control_list(opts = {})
  data, _status_code, _headers = get_equipment_fan_control_list_with_http_info(opts)
  data
end

#get_equipment_fan_control_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFanControlResponse, Integer, Hash)>

Read a &#39;equipment.FanControl&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanControlResponse, Integer, Hash)>)

    EquipmentFanControlResponse data, response status code and response headers



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
991
992
993
994
995
996
997
998
999
# File 'lib/intersight_client/api/equipment_api.rb', line 942

def get_equipment_fan_control_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fan_control_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/equipment/FanControls'

  # 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] || 'EquipmentFanControlResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fan_control_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: EquipmentApi#get_equipment_fan_control_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fan_list(opts = {}) ⇒ EquipmentFanResponse

Read a ‘equipment.Fan’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1015
1016
1017
1018
# File 'lib/intersight_client/api/equipment_api.rb', line 1015

def get_equipment_fan_list(opts = {})
  data, _status_code, _headers = get_equipment_fan_list_with_http_info(opts)
  data
end

#get_equipment_fan_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFanResponse, Integer, Hash)>

Read a &#39;equipment.Fan&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanResponse, Integer, Hash)>)

    EquipmentFanResponse data, response status code and response headers



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
# File 'lib/intersight_client/api/equipment_api.rb', line 1034

def get_equipment_fan_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fan_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/equipment/Fans'

  # 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] || 'EquipmentFanResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fan_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: EquipmentApi#get_equipment_fan_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fan_module_by_moid(moid, opts = {}) ⇒ EquipmentFanModule

Read a ‘equipment.FanModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1097
1098
1099
1100
# File 'lib/intersight_client/api/equipment_api.rb', line 1097

def get_equipment_fan_module_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fan_module_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fan_module_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFanModule, Integer, Hash)>

Read a &#39;equipment.FanModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFanModule, Integer, Hash)>)

    EquipmentFanModule data, response status code and response headers



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
1144
1145
1146
1147
1148
1149
1150
1151
1152
# File 'lib/intersight_client/api/equipment_api.rb', line 1106

def get_equipment_fan_module_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fan_module_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 EquipmentApi.get_equipment_fan_module_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FanModules/{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] || 'EquipmentFanModule'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fan_module_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: EquipmentApi#get_equipment_fan_module_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fan_module_list(opts = {}) ⇒ EquipmentFanModuleResponse

Read a ‘equipment.FanModule’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1168
1169
1170
1171
# File 'lib/intersight_client/api/equipment_api.rb', line 1168

def get_equipment_fan_module_list(opts = {})
  data, _status_code, _headers = get_equipment_fan_module_list_with_http_info(opts)
  data
end

#get_equipment_fan_module_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFanModuleResponse, Integer, Hash)>

Read a &#39;equipment.FanModule&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanModuleResponse, Integer, Hash)>)

    EquipmentFanModuleResponse data, response status code and response headers



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
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
# File 'lib/intersight_client/api/equipment_api.rb', line 1187

def get_equipment_fan_module_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fan_module_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/equipment/FanModules'

  # 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] || 'EquipmentFanModuleResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fan_module_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: EquipmentApi#get_equipment_fan_module_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fex_by_moid(moid, opts = {}) ⇒ EquipmentFex

Read a ‘equipment.Fex’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1250
1251
1252
1253
# File 'lib/intersight_client/api/equipment_api.rb', line 1250

def get_equipment_fex_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fex_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fex_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFex, Integer, Hash)>

Read a &#39;equipment.Fex&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFex, Integer, Hash)>)

    EquipmentFex data, response status code and response headers



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
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
# File 'lib/intersight_client/api/equipment_api.rb', line 1259

def get_equipment_fex_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fex_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 EquipmentApi.get_equipment_fex_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Fexes/{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] || 'EquipmentFex'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fex_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: EquipmentApi#get_equipment_fex_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fex_identity_by_moid(moid, opts = {}) ⇒ EquipmentFexIdentity

Read a ‘equipment.FexIdentity’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1311
1312
1313
1314
# File 'lib/intersight_client/api/equipment_api.rb', line 1311

def get_equipment_fex_identity_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fex_identity_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fex_identity_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFexIdentity, Integer, Hash)>

Read a &#39;equipment.FexIdentity&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFexIdentity, Integer, Hash)>)

    EquipmentFexIdentity data, response status code and response headers



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
# File 'lib/intersight_client/api/equipment_api.rb', line 1320

def get_equipment_fex_identity_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fex_identity_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 EquipmentApi.get_equipment_fex_identity_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FexIdentities/{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] || 'EquipmentFexIdentity'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fex_identity_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: EquipmentApi#get_equipment_fex_identity_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fex_identity_list(opts = {}) ⇒ EquipmentFexIdentityResponse

Read a ‘equipment.FexIdentity’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1382
1383
1384
1385
# File 'lib/intersight_client/api/equipment_api.rb', line 1382

def get_equipment_fex_identity_list(opts = {})
  data, _status_code, _headers = get_equipment_fex_identity_list_with_http_info(opts)
  data
end

#get_equipment_fex_identity_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFexIdentityResponse, Integer, Hash)>

Read a &#39;equipment.FexIdentity&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
# File 'lib/intersight_client/api/equipment_api.rb', line 1401

def get_equipment_fex_identity_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fex_identity_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/equipment/FexIdentities'

  # 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] || 'EquipmentFexIdentityResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fex_identity_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: EquipmentApi#get_equipment_fex_identity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fex_list(opts = {}) ⇒ EquipmentFexResponse

Read a ‘equipment.Fex’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1474
1475
1476
1477
# File 'lib/intersight_client/api/equipment_api.rb', line 1474

def get_equipment_fex_list(opts = {})
  data, _status_code, _headers = get_equipment_fex_list_with_http_info(opts)
  data
end

#get_equipment_fex_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFexResponse, Integer, Hash)>

Read a &#39;equipment.Fex&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFexResponse, Integer, Hash)>)

    EquipmentFexResponse data, response status code and response headers



1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
# File 'lib/intersight_client/api/equipment_api.rb', line 1493

def get_equipment_fex_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fex_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/equipment/Fexes'

  # 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] || 'EquipmentFexResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fex_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: EquipmentApi#get_equipment_fex_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fex_operation_by_moid(moid, opts = {}) ⇒ EquipmentFexOperation

Read a ‘equipment.FexOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1556
1557
1558
1559
# File 'lib/intersight_client/api/equipment_api.rb', line 1556

def get_equipment_fex_operation_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fex_operation_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fex_operation_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFexOperation, Integer, Hash)>

Read a &#39;equipment.FexOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFexOperation, Integer, Hash)>)

    EquipmentFexOperation data, response status code and response headers



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'lib/intersight_client/api/equipment_api.rb', line 1565

def get_equipment_fex_operation_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fex_operation_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 EquipmentApi.get_equipment_fex_operation_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FexOperations/{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] || 'EquipmentFexOperation'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fex_operation_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: EquipmentApi#get_equipment_fex_operation_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fex_operation_list(opts = {}) ⇒ EquipmentFexOperationResponse

Read a ‘equipment.FexOperation’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1627
1628
1629
1630
# File 'lib/intersight_client/api/equipment_api.rb', line 1627

def get_equipment_fex_operation_list(opts = {})
  data, _status_code, _headers = get_equipment_fex_operation_list_with_http_info(opts)
  data
end

#get_equipment_fex_operation_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFexOperationResponse, Integer, Hash)>

Read a &#39;equipment.FexOperation&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
# File 'lib/intersight_client/api/equipment_api.rb', line 1646

def get_equipment_fex_operation_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fex_operation_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/equipment/FexOperations'

  # 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] || 'EquipmentFexOperationResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fex_operation_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: EquipmentApi#get_equipment_fex_operation_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fru_by_moid(moid, opts = {}) ⇒ EquipmentFru

Read a ‘equipment.Fru’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1709
1710
1711
1712
# File 'lib/intersight_client/api/equipment_api.rb', line 1709

def get_equipment_fru_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_fru_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_fru_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentFru, Integer, Hash)>

Read a &#39;equipment.Fru&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentFru, Integer, Hash)>)

    EquipmentFru data, response status code and response headers



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
# File 'lib/intersight_client/api/equipment_api.rb', line 1718

def get_equipment_fru_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fru_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 EquipmentApi.get_equipment_fru_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Frus/{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] || 'EquipmentFru'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fru_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: EquipmentApi#get_equipment_fru_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_fru_list(opts = {}) ⇒ EquipmentFruResponse

Read a ‘equipment.Fru’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1780
1781
1782
1783
# File 'lib/intersight_client/api/equipment_api.rb', line 1780

def get_equipment_fru_list(opts = {})
  data, _status_code, _headers = get_equipment_fru_list_with_http_info(opts)
  data
end

#get_equipment_fru_list_with_http_info(opts = {}) ⇒ Array<(EquipmentFruResponse, Integer, Hash)>

Read a &#39;equipment.Fru&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFruResponse, Integer, Hash)>)

    EquipmentFruResponse data, response status code and response headers



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
# File 'lib/intersight_client/api/equipment_api.rb', line 1799

def get_equipment_fru_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_fru_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/equipment/Frus'

  # 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] || 'EquipmentFruResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_fru_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: EquipmentApi#get_equipment_fru_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_identity_summary_by_moid(moid, opts = {}) ⇒ EquipmentIdentitySummary

Read a ‘equipment.IdentitySummary’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1862
1863
1864
1865
# File 'lib/intersight_client/api/equipment_api.rb', line 1862

def get_equipment_identity_summary_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_identity_summary_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_identity_summary_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentIdentitySummary, Integer, Hash)>

Read a &#39;equipment.IdentitySummary&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentIdentitySummary, Integer, Hash)>)

    EquipmentIdentitySummary data, response status code and response headers



1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
# File 'lib/intersight_client/api/equipment_api.rb', line 1871

def get_equipment_identity_summary_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_identity_summary_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 EquipmentApi.get_equipment_identity_summary_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IdentitySummaries/{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] || 'EquipmentIdentitySummary'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_identity_summary_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: EquipmentApi#get_equipment_identity_summary_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_identity_summary_list(opts = {}) ⇒ EquipmentIdentitySummaryResponse

Read a ‘equipment.IdentitySummary’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1933
1934
1935
1936
# File 'lib/intersight_client/api/equipment_api.rb', line 1933

def get_equipment_identity_summary_list(opts = {})
  data, _status_code, _headers = get_equipment_identity_summary_list_with_http_info(opts)
  data
end

#get_equipment_identity_summary_list_with_http_info(opts = {}) ⇒ Array<(EquipmentIdentitySummaryResponse, Integer, Hash)>

Read a &#39;equipment.IdentitySummary&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'lib/intersight_client/api/equipment_api.rb', line 1952

def get_equipment_identity_summary_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_identity_summary_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/equipment/IdentitySummaries'

  # 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] || 'EquipmentIdentitySummaryResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_identity_summary_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: EquipmentApi#get_equipment_identity_summary_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_io_card_by_moid(moid, opts = {}) ⇒ EquipmentIoCard

Read a ‘equipment.IoCard’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2015
2016
2017
2018
# File 'lib/intersight_client/api/equipment_api.rb', line 2015

def get_equipment_io_card_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_io_card_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_io_card_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentIoCard, Integer, Hash)>

Read a &#39;equipment.IoCard&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentIoCard, Integer, Hash)>)

    EquipmentIoCard data, response status code and response headers



2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
# File 'lib/intersight_client/api/equipment_api.rb', line 2024

def get_equipment_io_card_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_io_card_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 EquipmentApi.get_equipment_io_card_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoCards/{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] || 'EquipmentIoCard'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_io_card_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: EquipmentApi#get_equipment_io_card_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_io_card_list(opts = {}) ⇒ EquipmentIoCardResponse

Read a ‘equipment.IoCard’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2086
2087
2088
2089
# File 'lib/intersight_client/api/equipment_api.rb', line 2086

def get_equipment_io_card_list(opts = {})
  data, _status_code, _headers = get_equipment_io_card_list_with_http_info(opts)
  data
end

#get_equipment_io_card_list_with_http_info(opts = {}) ⇒ Array<(EquipmentIoCardResponse, Integer, Hash)>

Read a &#39;equipment.IoCard&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoCardResponse, Integer, Hash)>)

    EquipmentIoCardResponse data, response status code and response headers



2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
# File 'lib/intersight_client/api/equipment_api.rb', line 2105

def get_equipment_io_card_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_io_card_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/equipment/IoCards'

  # 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] || 'EquipmentIoCardResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_io_card_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: EquipmentApi#get_equipment_io_card_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_io_card_operation_by_moid(moid, opts = {}) ⇒ EquipmentIoCardOperation

Read a ‘equipment.IoCardOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2168
2169
2170
2171
# File 'lib/intersight_client/api/equipment_api.rb', line 2168

def get_equipment_io_card_operation_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_io_card_operation_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_io_card_operation_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentIoCardOperation, Integer, Hash)>

Read a &#39;equipment.IoCardOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentIoCardOperation, Integer, Hash)>)

    EquipmentIoCardOperation data, response status code and response headers



2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'lib/intersight_client/api/equipment_api.rb', line 2177

def get_equipment_io_card_operation_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_io_card_operation_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 EquipmentApi.get_equipment_io_card_operation_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoCardOperations/{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] || 'EquipmentIoCardOperation'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_io_card_operation_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: EquipmentApi#get_equipment_io_card_operation_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_io_card_operation_list(opts = {}) ⇒ EquipmentIoCardOperationResponse

Read a ‘equipment.IoCardOperation’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2239
2240
2241
2242
# File 'lib/intersight_client/api/equipment_api.rb', line 2239

def get_equipment_io_card_operation_list(opts = {})
  data, _status_code, _headers = get_equipment_io_card_operation_list_with_http_info(opts)
  data
end

#get_equipment_io_card_operation_list_with_http_info(opts = {}) ⇒ Array<(EquipmentIoCardOperationResponse, Integer, Hash)>

Read a &#39;equipment.IoCardOperation&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
# File 'lib/intersight_client/api/equipment_api.rb', line 2258

def get_equipment_io_card_operation_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_io_card_operation_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/equipment/IoCardOperations'

  # 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] || 'EquipmentIoCardOperationResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_io_card_operation_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: EquipmentApi#get_equipment_io_card_operation_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_io_expander_by_moid(moid, opts = {}) ⇒ EquipmentIoExpander

Read a ‘equipment.IoExpander’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2321
2322
2323
2324
# File 'lib/intersight_client/api/equipment_api.rb', line 2321

def get_equipment_io_expander_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_io_expander_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_io_expander_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentIoExpander, Integer, Hash)>

Read a &#39;equipment.IoExpander&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentIoExpander, Integer, Hash)>)

    EquipmentIoExpander data, response status code and response headers



2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
# File 'lib/intersight_client/api/equipment_api.rb', line 2330

def get_equipment_io_expander_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_io_expander_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 EquipmentApi.get_equipment_io_expander_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoExpanders/{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] || 'EquipmentIoExpander'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_io_expander_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: EquipmentApi#get_equipment_io_expander_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_io_expander_list(opts = {}) ⇒ EquipmentIoExpanderResponse

Read a ‘equipment.IoExpander’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2392
2393
2394
2395
# File 'lib/intersight_client/api/equipment_api.rb', line 2392

def get_equipment_io_expander_list(opts = {})
  data, _status_code, _headers = get_equipment_io_expander_list_with_http_info(opts)
  data
end

#get_equipment_io_expander_list_with_http_info(opts = {}) ⇒ Array<(EquipmentIoExpanderResponse, Integer, Hash)>

Read a &#39;equipment.IoExpander&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoExpanderResponse, Integer, Hash)>)

    EquipmentIoExpanderResponse data, response status code and response headers



2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
# File 'lib/intersight_client/api/equipment_api.rb', line 2411

def get_equipment_io_expander_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_io_expander_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/equipment/IoExpanders'

  # 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] || 'EquipmentIoExpanderResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_io_expander_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: EquipmentApi#get_equipment_io_expander_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_locator_led_by_moid(moid, opts = {}) ⇒ EquipmentLocatorLed

Read a ‘equipment.LocatorLed’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2474
2475
2476
2477
# File 'lib/intersight_client/api/equipment_api.rb', line 2474

def get_equipment_locator_led_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_locator_led_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_locator_led_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentLocatorLed, Integer, Hash)>

Read a &#39;equipment.LocatorLed&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentLocatorLed, Integer, Hash)>)

    EquipmentLocatorLed data, response status code and response headers



2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
# File 'lib/intersight_client/api/equipment_api.rb', line 2483

def get_equipment_locator_led_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_locator_led_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 EquipmentApi.get_equipment_locator_led_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/LocatorLeds/{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] || 'EquipmentLocatorLed'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_locator_led_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: EquipmentApi#get_equipment_locator_led_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_locator_led_list(opts = {}) ⇒ EquipmentLocatorLedResponse

Read a ‘equipment.LocatorLed’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2545
2546
2547
2548
# File 'lib/intersight_client/api/equipment_api.rb', line 2545

def get_equipment_locator_led_list(opts = {})
  data, _status_code, _headers = get_equipment_locator_led_list_with_http_info(opts)
  data
end

#get_equipment_locator_led_list_with_http_info(opts = {}) ⇒ Array<(EquipmentLocatorLedResponse, Integer, Hash)>

Read a &#39;equipment.LocatorLed&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentLocatorLedResponse, Integer, Hash)>)

    EquipmentLocatorLedResponse data, response status code and response headers



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'lib/intersight_client/api/equipment_api.rb', line 2564

def get_equipment_locator_led_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_locator_led_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/equipment/LocatorLeds'

  # 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] || 'EquipmentLocatorLedResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_locator_led_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: EquipmentApi#get_equipment_locator_led_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_psu_by_moid(moid, opts = {}) ⇒ EquipmentPsu

Read a ‘equipment.Psu’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2627
2628
2629
2630
# File 'lib/intersight_client/api/equipment_api.rb', line 2627

def get_equipment_psu_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_psu_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_psu_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentPsu, Integer, Hash)>

Read a &#39;equipment.Psu&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentPsu, Integer, Hash)>)

    EquipmentPsu data, response status code and response headers



2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
# File 'lib/intersight_client/api/equipment_api.rb', line 2636

def get_equipment_psu_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_psu_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 EquipmentApi.get_equipment_psu_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Psus/{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] || 'EquipmentPsu'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_psu_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: EquipmentApi#get_equipment_psu_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_psu_control_by_moid(moid, opts = {}) ⇒ EquipmentPsuControl

Read a ‘equipment.PsuControl’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2688
2689
2690
2691
# File 'lib/intersight_client/api/equipment_api.rb', line 2688

def get_equipment_psu_control_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_psu_control_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_psu_control_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentPsuControl, Integer, Hash)>

Read a &#39;equipment.PsuControl&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentPsuControl, Integer, Hash)>)

    EquipmentPsuControl data, response status code and response headers



2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
# File 'lib/intersight_client/api/equipment_api.rb', line 2697

def get_equipment_psu_control_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_psu_control_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 EquipmentApi.get_equipment_psu_control_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/PsuControls/{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] || 'EquipmentPsuControl'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_psu_control_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: EquipmentApi#get_equipment_psu_control_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_psu_control_list(opts = {}) ⇒ EquipmentPsuControlResponse

Read a ‘equipment.PsuControl’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2759
2760
2761
2762
# File 'lib/intersight_client/api/equipment_api.rb', line 2759

def get_equipment_psu_control_list(opts = {})
  data, _status_code, _headers = get_equipment_psu_control_list_with_http_info(opts)
  data
end

#get_equipment_psu_control_list_with_http_info(opts = {}) ⇒ Array<(EquipmentPsuControlResponse, Integer, Hash)>

Read a &#39;equipment.PsuControl&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentPsuControlResponse, Integer, Hash)>)

    EquipmentPsuControlResponse data, response status code and response headers



2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
# File 'lib/intersight_client/api/equipment_api.rb', line 2778

def get_equipment_psu_control_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_psu_control_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/equipment/PsuControls'

  # 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] || 'EquipmentPsuControlResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_psu_control_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: EquipmentApi#get_equipment_psu_control_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_psu_list(opts = {}) ⇒ EquipmentPsuResponse

Read a ‘equipment.Psu’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



2851
2852
2853
2854
# File 'lib/intersight_client/api/equipment_api.rb', line 2851

def get_equipment_psu_list(opts = {})
  data, _status_code, _headers = get_equipment_psu_list_with_http_info(opts)
  data
end

#get_equipment_psu_list_with_http_info(opts = {}) ⇒ Array<(EquipmentPsuResponse, Integer, Hash)>

Read a &#39;equipment.Psu&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentPsuResponse, Integer, Hash)>)

    EquipmentPsuResponse data, response status code and response headers



2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
# File 'lib/intersight_client/api/equipment_api.rb', line 2870

def get_equipment_psu_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_psu_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/equipment/Psus'

  # 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] || 'EquipmentPsuResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_psu_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: EquipmentApi#get_equipment_psu_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_rack_enclosure_by_moid(moid, opts = {}) ⇒ EquipmentRackEnclosure

Read a ‘equipment.RackEnclosure’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2933
2934
2935
2936
# File 'lib/intersight_client/api/equipment_api.rb', line 2933

def get_equipment_rack_enclosure_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_rack_enclosure_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_rack_enclosure_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentRackEnclosure, Integer, Hash)>

Read a &#39;equipment.RackEnclosure&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentRackEnclosure, Integer, Hash)>)

    EquipmentRackEnclosure data, response status code and response headers



2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'lib/intersight_client/api/equipment_api.rb', line 2942

def get_equipment_rack_enclosure_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_rack_enclosure_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 EquipmentApi.get_equipment_rack_enclosure_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/RackEnclosures/{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] || 'EquipmentRackEnclosure'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_rack_enclosure_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: EquipmentApi#get_equipment_rack_enclosure_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_rack_enclosure_list(opts = {}) ⇒ EquipmentRackEnclosureResponse

Read a ‘equipment.RackEnclosure’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3004
3005
3006
3007
# File 'lib/intersight_client/api/equipment_api.rb', line 3004

def get_equipment_rack_enclosure_list(opts = {})
  data, _status_code, _headers = get_equipment_rack_enclosure_list_with_http_info(opts)
  data
end

#get_equipment_rack_enclosure_list_with_http_info(opts = {}) ⇒ Array<(EquipmentRackEnclosureResponse, Integer, Hash)>

Read a &#39;equipment.RackEnclosure&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
# File 'lib/intersight_client/api/equipment_api.rb', line 3023

def get_equipment_rack_enclosure_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_rack_enclosure_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/equipment/RackEnclosures'

  # 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] || 'EquipmentRackEnclosureResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_rack_enclosure_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: EquipmentApi#get_equipment_rack_enclosure_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_rack_enclosure_slot_by_moid(moid, opts = {}) ⇒ EquipmentRackEnclosureSlot

Read a ‘equipment.RackEnclosureSlot’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3086
3087
3088
3089
# File 'lib/intersight_client/api/equipment_api.rb', line 3086

def get_equipment_rack_enclosure_slot_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_rack_enclosure_slot_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_rack_enclosure_slot_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentRackEnclosureSlot, Integer, Hash)>

Read a &#39;equipment.RackEnclosureSlot&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentRackEnclosureSlot, Integer, Hash)>)

    EquipmentRackEnclosureSlot data, response status code and response headers



3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'lib/intersight_client/api/equipment_api.rb', line 3095

def get_equipment_rack_enclosure_slot_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_rack_enclosure_slot_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 EquipmentApi.get_equipment_rack_enclosure_slot_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/RackEnclosureSlots/{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] || 'EquipmentRackEnclosureSlot'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_rack_enclosure_slot_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: EquipmentApi#get_equipment_rack_enclosure_slot_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_rack_enclosure_slot_list(opts = {}) ⇒ EquipmentRackEnclosureSlotResponse

Read a ‘equipment.RackEnclosureSlot’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3157
3158
3159
3160
# File 'lib/intersight_client/api/equipment_api.rb', line 3157

def get_equipment_rack_enclosure_slot_list(opts = {})
  data, _status_code, _headers = get_equipment_rack_enclosure_slot_list_with_http_info(opts)
  data
end

#get_equipment_rack_enclosure_slot_list_with_http_info(opts = {}) ⇒ Array<(EquipmentRackEnclosureSlotResponse, Integer, Hash)>

Read a &#39;equipment.RackEnclosureSlot&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
# File 'lib/intersight_client/api/equipment_api.rb', line 3176

def get_equipment_rack_enclosure_slot_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_rack_enclosure_slot_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/equipment/RackEnclosureSlots'

  # 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] || 'EquipmentRackEnclosureSlotResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_rack_enclosure_slot_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: EquipmentApi#get_equipment_rack_enclosure_slot_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_shared_io_module_by_moid(moid, opts = {}) ⇒ EquipmentSharedIoModule

Read a ‘equipment.SharedIoModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3239
3240
3241
3242
# File 'lib/intersight_client/api/equipment_api.rb', line 3239

def get_equipment_shared_io_module_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_shared_io_module_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_shared_io_module_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentSharedIoModule, Integer, Hash)>

Read a &#39;equipment.SharedIoModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentSharedIoModule, Integer, Hash)>)

    EquipmentSharedIoModule data, response status code and response headers



3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/intersight_client/api/equipment_api.rb', line 3248

def get_equipment_shared_io_module_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_shared_io_module_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 EquipmentApi.get_equipment_shared_io_module_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SharedIoModules/{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] || 'EquipmentSharedIoModule'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_shared_io_module_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: EquipmentApi#get_equipment_shared_io_module_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_shared_io_module_list(opts = {}) ⇒ EquipmentSharedIoModuleResponse

Read a ‘equipment.SharedIoModule’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3310
3311
3312
3313
# File 'lib/intersight_client/api/equipment_api.rb', line 3310

def get_equipment_shared_io_module_list(opts = {})
  data, _status_code, _headers = get_equipment_shared_io_module_list_with_http_info(opts)
  data
end

#get_equipment_shared_io_module_list_with_http_info(opts = {}) ⇒ Array<(EquipmentSharedIoModuleResponse, Integer, Hash)>

Read a &#39;equipment.SharedIoModule&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# File 'lib/intersight_client/api/equipment_api.rb', line 3329

def get_equipment_shared_io_module_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_shared_io_module_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/equipment/SharedIoModules'

  # 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] || 'EquipmentSharedIoModuleResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_shared_io_module_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: EquipmentApi#get_equipment_shared_io_module_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_switch_card_by_moid(moid, opts = {}) ⇒ EquipmentSwitchCard

Read a ‘equipment.SwitchCard’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3392
3393
3394
3395
# File 'lib/intersight_client/api/equipment_api.rb', line 3392

def get_equipment_switch_card_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_switch_card_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_switch_card_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentSwitchCard, Integer, Hash)>

Read a &#39;equipment.SwitchCard&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentSwitchCard, Integer, Hash)>)

    EquipmentSwitchCard data, response status code and response headers



3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
# File 'lib/intersight_client/api/equipment_api.rb', line 3401

def get_equipment_switch_card_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_switch_card_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 EquipmentApi.get_equipment_switch_card_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SwitchCards/{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] || 'EquipmentSwitchCard'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_switch_card_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: EquipmentApi#get_equipment_switch_card_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_switch_card_list(opts = {}) ⇒ EquipmentSwitchCardResponse

Read a ‘equipment.SwitchCard’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3463
3464
3465
3466
# File 'lib/intersight_client/api/equipment_api.rb', line 3463

def get_equipment_switch_card_list(opts = {})
  data, _status_code, _headers = get_equipment_switch_card_list_with_http_info(opts)
  data
end

#get_equipment_switch_card_list_with_http_info(opts = {}) ⇒ Array<(EquipmentSwitchCardResponse, Integer, Hash)>

Read a &#39;equipment.SwitchCard&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSwitchCardResponse, Integer, Hash)>)

    EquipmentSwitchCardResponse data, response status code and response headers



3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
# File 'lib/intersight_client/api/equipment_api.rb', line 3482

def get_equipment_switch_card_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_switch_card_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/equipment/SwitchCards'

  # 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] || 'EquipmentSwitchCardResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_switch_card_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: EquipmentApi#get_equipment_switch_card_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_system_io_controller_by_moid(moid, opts = {}) ⇒ EquipmentSystemIoController

Read a ‘equipment.SystemIoController’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3545
3546
3547
3548
# File 'lib/intersight_client/api/equipment_api.rb', line 3545

def get_equipment_system_io_controller_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_system_io_controller_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_system_io_controller_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentSystemIoController, Integer, Hash)>

Read a &#39;equipment.SystemIoController&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentSystemIoController, Integer, Hash)>)

    EquipmentSystemIoController data, response status code and response headers



3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
# File 'lib/intersight_client/api/equipment_api.rb', line 3554

def get_equipment_system_io_controller_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_system_io_controller_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 EquipmentApi.get_equipment_system_io_controller_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SystemIoControllers/{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] || 'EquipmentSystemIoController'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_system_io_controller_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: EquipmentApi#get_equipment_system_io_controller_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_system_io_controller_list(opts = {}) ⇒ EquipmentSystemIoControllerResponse

Read a ‘equipment.SystemIoController’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3616
3617
3618
3619
# File 'lib/intersight_client/api/equipment_api.rb', line 3616

def get_equipment_system_io_controller_list(opts = {})
  data, _status_code, _headers = get_equipment_system_io_controller_list_with_http_info(opts)
  data
end

#get_equipment_system_io_controller_list_with_http_info(opts = {}) ⇒ Array<(EquipmentSystemIoControllerResponse, Integer, Hash)>

Read a &#39;equipment.SystemIoController&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
# File 'lib/intersight_client/api/equipment_api.rb', line 3635

def get_equipment_system_io_controller_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_system_io_controller_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/equipment/SystemIoControllers'

  # 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] || 'EquipmentSystemIoControllerResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_system_io_controller_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: EquipmentApi#get_equipment_system_io_controller_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_tpm_by_moid(moid, opts = {}) ⇒ EquipmentTpm

Read a ‘equipment.Tpm’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3698
3699
3700
3701
# File 'lib/intersight_client/api/equipment_api.rb', line 3698

def get_equipment_tpm_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_tpm_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_tpm_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentTpm, Integer, Hash)>

Read a &#39;equipment.Tpm&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentTpm, Integer, Hash)>)

    EquipmentTpm data, response status code and response headers



3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
# File 'lib/intersight_client/api/equipment_api.rb', line 3707

def get_equipment_tpm_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_tpm_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 EquipmentApi.get_equipment_tpm_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Tpms/{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] || 'EquipmentTpm'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_tpm_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: EquipmentApi#get_equipment_tpm_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_tpm_list(opts = {}) ⇒ EquipmentTpmResponse

Read a ‘equipment.Tpm’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3769
3770
3771
3772
# File 'lib/intersight_client/api/equipment_api.rb', line 3769

def get_equipment_tpm_list(opts = {})
  data, _status_code, _headers = get_equipment_tpm_list_with_http_info(opts)
  data
end

#get_equipment_tpm_list_with_http_info(opts = {}) ⇒ Array<(EquipmentTpmResponse, Integer, Hash)>

Read a &#39;equipment.Tpm&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentTpmResponse, Integer, Hash)>)

    EquipmentTpmResponse data, response status code and response headers



3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
# File 'lib/intersight_client/api/equipment_api.rb', line 3788

def get_equipment_tpm_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_tpm_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/equipment/Tpms'

  # 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] || 'EquipmentTpmResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_tpm_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: EquipmentApi#get_equipment_tpm_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_transceiver_by_moid(moid, opts = {}) ⇒ EquipmentTransceiver

Read a ‘equipment.Transceiver’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3851
3852
3853
3854
# File 'lib/intersight_client/api/equipment_api.rb', line 3851

def get_equipment_transceiver_by_moid(moid, opts = {})
  data, _status_code, _headers = get_equipment_transceiver_by_moid_with_http_info(moid, opts)
  data
end

#get_equipment_transceiver_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(EquipmentTransceiver, Integer, Hash)>

Read a &#39;equipment.Transceiver&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(EquipmentTransceiver, Integer, Hash)>)

    EquipmentTransceiver data, response status code and response headers



3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
# File 'lib/intersight_client/api/equipment_api.rb', line 3860

def get_equipment_transceiver_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_transceiver_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 EquipmentApi.get_equipment_transceiver_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Transceivers/{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] || 'EquipmentTransceiver'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_transceiver_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: EquipmentApi#get_equipment_transceiver_by_moid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_equipment_transceiver_list(opts = {}) ⇒ EquipmentTransceiverResponse

Read a ‘equipment.Transceiver’ resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3922
3923
3924
3925
# File 'lib/intersight_client/api/equipment_api.rb', line 3922

def get_equipment_transceiver_list(opts = {})
  data, _status_code, _headers = get_equipment_transceiver_list_with_http_info(opts)
  data
end

#get_equipment_transceiver_list_with_http_info(opts = {}) ⇒ Array<(EquipmentTransceiverResponse, Integer, Hash)>

Read a &#39;equipment.Transceiver&#39; resource.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
# File 'lib/intersight_client/api/equipment_api.rb', line 3941

def get_equipment_transceiver_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.get_equipment_transceiver_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/equipment/Transceivers'

  # 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] || 'EquipmentTransceiverResponse'

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.get_equipment_transceiver_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: EquipmentApi#get_equipment_transceiver_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_chassis(moid, equipment_chassis, opts = {}) ⇒ EquipmentChassis

Update a ‘equipment.Chassis’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis (EquipmentChassis)

    The &#39;equipment.Chassis&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4006
4007
4008
4009
# File 'lib/intersight_client/api/equipment_api.rb', line 4006

def patch_equipment_chassis(moid, equipment_chassis, opts = {})
  data, _status_code, _headers = patch_equipment_chassis_with_http_info(moid, equipment_chassis, opts)
  data
end

#patch_equipment_chassis_identity(moid, equipment_chassis_identity, opts = {}) ⇒ EquipmentChassisIdentity

Update a ‘equipment.ChassisIdentity’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_identity (EquipmentChassisIdentity)

    The &#39;equipment.ChassisIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4081
4082
4083
4084
# File 'lib/intersight_client/api/equipment_api.rb', line 4081

def patch_equipment_chassis_identity(moid, equipment_chassis_identity, opts = {})
  data, _status_code, _headers = patch_equipment_chassis_identity_with_http_info(moid, equipment_chassis_identity, opts)
  data
end

#patch_equipment_chassis_identity_with_http_info(moid, equipment_chassis_identity, opts = {}) ⇒ Array<(EquipmentChassisIdentity, Integer, Hash)>

Update a &#39;equipment.ChassisIdentity&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_identity (EquipmentChassisIdentity)

    The &#39;equipment.ChassisIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassisIdentity, Integer, Hash)>)

    EquipmentChassisIdentity data, response status code and response headers



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
# File 'lib/intersight_client/api/equipment_api.rb', line 4092

def patch_equipment_chassis_identity_with_http_info(moid, equipment_chassis_identity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_chassis_identity ...'
  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 EquipmentApi.patch_equipment_chassis_identity"
  end
  # verify the required parameter 'equipment_chassis_identity' is set
  if @api_client.config.client_side_validation && equipment_chassis_identity.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_chassis_identity' when calling EquipmentApi.patch_equipment_chassis_identity"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ChassisIdentities/{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(equipment_chassis_identity)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_chassis_identity",
    :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: EquipmentApi#patch_equipment_chassis_identity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_chassis_operation(moid, equipment_chassis_operation, opts = {}) ⇒ EquipmentChassisOperation

Update a ‘equipment.ChassisOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_operation (EquipmentChassisOperation)

    The &#39;equipment.ChassisOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4156
4157
4158
4159
# File 'lib/intersight_client/api/equipment_api.rb', line 4156

def patch_equipment_chassis_operation(moid, equipment_chassis_operation, opts = {})
  data, _status_code, _headers = patch_equipment_chassis_operation_with_http_info(moid, equipment_chassis_operation, opts)
  data
end

#patch_equipment_chassis_operation_with_http_info(moid, equipment_chassis_operation, opts = {}) ⇒ Array<(EquipmentChassisOperation, Integer, Hash)>

Update a &#39;equipment.ChassisOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_operation (EquipmentChassisOperation)

    The &#39;equipment.ChassisOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassisOperation, Integer, Hash)>)

    EquipmentChassisOperation data, response status code and response headers



4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
# File 'lib/intersight_client/api/equipment_api.rb', line 4167

def patch_equipment_chassis_operation_with_http_info(moid, equipment_chassis_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_chassis_operation ...'
  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 EquipmentApi.patch_equipment_chassis_operation"
  end
  # verify the required parameter 'equipment_chassis_operation' is set
  if @api_client.config.client_side_validation && equipment_chassis_operation.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_chassis_operation' when calling EquipmentApi.patch_equipment_chassis_operation"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ChassisOperations/{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(equipment_chassis_operation)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_chassis_operation",
    :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: EquipmentApi#patch_equipment_chassis_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_chassis_with_http_info(moid, equipment_chassis, opts = {}) ⇒ Array<(EquipmentChassis, Integer, Hash)>

Update a &#39;equipment.Chassis&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis (EquipmentChassis)

    The &#39;equipment.Chassis&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassis, Integer, Hash)>)

    EquipmentChassis data, response status code and response headers



4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
# File 'lib/intersight_client/api/equipment_api.rb', line 4017

def patch_equipment_chassis_with_http_info(moid, equipment_chassis, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_chassis ...'
  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 EquipmentApi.patch_equipment_chassis"
  end
  # verify the required parameter 'equipment_chassis' is set
  if @api_client.config.client_side_validation && equipment_chassis.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_chassis' when calling EquipmentApi.patch_equipment_chassis"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Chasses/{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(equipment_chassis)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_chassis",
    :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: EquipmentApi#patch_equipment_chassis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_expander_module(moid, equipment_expander_module, opts = {}) ⇒ EquipmentExpanderModule

Update a ‘equipment.ExpanderModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_expander_module (EquipmentExpanderModule)

    The &#39;equipment.ExpanderModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4231
4232
4233
4234
# File 'lib/intersight_client/api/equipment_api.rb', line 4231

def patch_equipment_expander_module(moid, equipment_expander_module, opts = {})
  data, _status_code, _headers = patch_equipment_expander_module_with_http_info(moid, equipment_expander_module, opts)
  data
end

#patch_equipment_expander_module_with_http_info(moid, equipment_expander_module, opts = {}) ⇒ Array<(EquipmentExpanderModule, Integer, Hash)>

Update a &#39;equipment.ExpanderModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_expander_module (EquipmentExpanderModule)

    The &#39;equipment.ExpanderModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentExpanderModule, Integer, Hash)>)

    EquipmentExpanderModule data, response status code and response headers



4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
# File 'lib/intersight_client/api/equipment_api.rb', line 4242

def patch_equipment_expander_module_with_http_info(moid, equipment_expander_module, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_expander_module ...'
  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 EquipmentApi.patch_equipment_expander_module"
  end
  # verify the required parameter 'equipment_expander_module' is set
  if @api_client.config.client_side_validation && equipment_expander_module.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_expander_module' when calling EquipmentApi.patch_equipment_expander_module"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ExpanderModules/{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(equipment_expander_module)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_expander_module",
    :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: EquipmentApi#patch_equipment_expander_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fan(moid, equipment_fan, opts = {}) ⇒ EquipmentFan

Update a ‘equipment.Fan’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan (EquipmentFan)

    The &#39;equipment.Fan&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4306
4307
4308
4309
# File 'lib/intersight_client/api/equipment_api.rb', line 4306

def patch_equipment_fan(moid, equipment_fan, opts = {})
  data, _status_code, _headers = patch_equipment_fan_with_http_info(moid, equipment_fan, opts)
  data
end

#patch_equipment_fan_control(moid, equipment_fan_control, opts = {}) ⇒ EquipmentFanControl

Update a ‘equipment.FanControl’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_control (EquipmentFanControl)

    The &#39;equipment.FanControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4381
4382
4383
4384
# File 'lib/intersight_client/api/equipment_api.rb', line 4381

def patch_equipment_fan_control(moid, equipment_fan_control, opts = {})
  data, _status_code, _headers = patch_equipment_fan_control_with_http_info(moid, equipment_fan_control, opts)
  data
end

#patch_equipment_fan_control_with_http_info(moid, equipment_fan_control, opts = {}) ⇒ Array<(EquipmentFanControl, Integer, Hash)>

Update a &#39;equipment.FanControl&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_control (EquipmentFanControl)

    The &#39;equipment.FanControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanControl, Integer, Hash)>)

    EquipmentFanControl data, response status code and response headers



4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
# File 'lib/intersight_client/api/equipment_api.rb', line 4392

def patch_equipment_fan_control_with_http_info(moid, equipment_fan_control, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fan_control ...'
  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 EquipmentApi.patch_equipment_fan_control"
  end
  # verify the required parameter 'equipment_fan_control' is set
  if @api_client.config.client_side_validation && equipment_fan_control.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fan_control' when calling EquipmentApi.patch_equipment_fan_control"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FanControls/{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(equipment_fan_control)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fan_control",
    :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: EquipmentApi#patch_equipment_fan_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fan_module(moid, equipment_fan_module, opts = {}) ⇒ EquipmentFanModule

Update a ‘equipment.FanModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_module (EquipmentFanModule)

    The &#39;equipment.FanModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4456
4457
4458
4459
# File 'lib/intersight_client/api/equipment_api.rb', line 4456

def patch_equipment_fan_module(moid, equipment_fan_module, opts = {})
  data, _status_code, _headers = patch_equipment_fan_module_with_http_info(moid, equipment_fan_module, opts)
  data
end

#patch_equipment_fan_module_with_http_info(moid, equipment_fan_module, opts = {}) ⇒ Array<(EquipmentFanModule, Integer, Hash)>

Update a &#39;equipment.FanModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_module (EquipmentFanModule)

    The &#39;equipment.FanModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanModule, Integer, Hash)>)

    EquipmentFanModule data, response status code and response headers



4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
# File 'lib/intersight_client/api/equipment_api.rb', line 4467

def patch_equipment_fan_module_with_http_info(moid, equipment_fan_module, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fan_module ...'
  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 EquipmentApi.patch_equipment_fan_module"
  end
  # verify the required parameter 'equipment_fan_module' is set
  if @api_client.config.client_side_validation && equipment_fan_module.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fan_module' when calling EquipmentApi.patch_equipment_fan_module"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FanModules/{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(equipment_fan_module)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fan_module",
    :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: EquipmentApi#patch_equipment_fan_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fan_with_http_info(moid, equipment_fan, opts = {}) ⇒ Array<(EquipmentFan, Integer, Hash)>

Update a &#39;equipment.Fan&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan (EquipmentFan)

    The &#39;equipment.Fan&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFan, Integer, Hash)>)

    EquipmentFan data, response status code and response headers



4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
# File 'lib/intersight_client/api/equipment_api.rb', line 4317

def patch_equipment_fan_with_http_info(moid, equipment_fan, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fan ...'
  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 EquipmentApi.patch_equipment_fan"
  end
  # verify the required parameter 'equipment_fan' is set
  if @api_client.config.client_side_validation && equipment_fan.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fan' when calling EquipmentApi.patch_equipment_fan"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Fans/{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(equipment_fan)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fan",
    :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: EquipmentApi#patch_equipment_fan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fex(moid, equipment_fex, opts = {}) ⇒ EquipmentFex

Update a ‘equipment.Fex’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex (EquipmentFex)

    The &#39;equipment.Fex&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4531
4532
4533
4534
# File 'lib/intersight_client/api/equipment_api.rb', line 4531

def patch_equipment_fex(moid, equipment_fex, opts = {})
  data, _status_code, _headers = patch_equipment_fex_with_http_info(moid, equipment_fex, opts)
  data
end

#patch_equipment_fex_identity(moid, equipment_fex_identity, opts = {}) ⇒ EquipmentFexIdentity

Update a ‘equipment.FexIdentity’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_identity (EquipmentFexIdentity)

    The &#39;equipment.FexIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4606
4607
4608
4609
# File 'lib/intersight_client/api/equipment_api.rb', line 4606

def patch_equipment_fex_identity(moid, equipment_fex_identity, opts = {})
  data, _status_code, _headers = patch_equipment_fex_identity_with_http_info(moid, equipment_fex_identity, opts)
  data
end

#patch_equipment_fex_identity_with_http_info(moid, equipment_fex_identity, opts = {}) ⇒ Array<(EquipmentFexIdentity, Integer, Hash)>

Update a &#39;equipment.FexIdentity&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_identity (EquipmentFexIdentity)

    The &#39;equipment.FexIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFexIdentity, Integer, Hash)>)

    EquipmentFexIdentity data, response status code and response headers



4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
# File 'lib/intersight_client/api/equipment_api.rb', line 4617

def patch_equipment_fex_identity_with_http_info(moid, equipment_fex_identity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fex_identity ...'
  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 EquipmentApi.patch_equipment_fex_identity"
  end
  # verify the required parameter 'equipment_fex_identity' is set
  if @api_client.config.client_side_validation && equipment_fex_identity.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fex_identity' when calling EquipmentApi.patch_equipment_fex_identity"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FexIdentities/{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(equipment_fex_identity)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fex_identity",
    :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: EquipmentApi#patch_equipment_fex_identity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fex_operation(moid, equipment_fex_operation, opts = {}) ⇒ EquipmentFexOperation

Update a ‘equipment.FexOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_operation (EquipmentFexOperation)

    The &#39;equipment.FexOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4681
4682
4683
4684
# File 'lib/intersight_client/api/equipment_api.rb', line 4681

def patch_equipment_fex_operation(moid, equipment_fex_operation, opts = {})
  data, _status_code, _headers = patch_equipment_fex_operation_with_http_info(moid, equipment_fex_operation, opts)
  data
end

#patch_equipment_fex_operation_with_http_info(moid, equipment_fex_operation, opts = {}) ⇒ Array<(EquipmentFexOperation, Integer, Hash)>

Update a &#39;equipment.FexOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_operation (EquipmentFexOperation)

    The &#39;equipment.FexOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFexOperation, Integer, Hash)>)

    EquipmentFexOperation data, response status code and response headers



4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
# File 'lib/intersight_client/api/equipment_api.rb', line 4692

def patch_equipment_fex_operation_with_http_info(moid, equipment_fex_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fex_operation ...'
  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 EquipmentApi.patch_equipment_fex_operation"
  end
  # verify the required parameter 'equipment_fex_operation' is set
  if @api_client.config.client_side_validation && equipment_fex_operation.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fex_operation' when calling EquipmentApi.patch_equipment_fex_operation"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FexOperations/{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(equipment_fex_operation)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fex_operation",
    :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: EquipmentApi#patch_equipment_fex_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fex_with_http_info(moid, equipment_fex, opts = {}) ⇒ Array<(EquipmentFex, Integer, Hash)>

Update a &#39;equipment.Fex&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex (EquipmentFex)

    The &#39;equipment.Fex&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFex, Integer, Hash)>)

    EquipmentFex data, response status code and response headers



4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
# File 'lib/intersight_client/api/equipment_api.rb', line 4542

def patch_equipment_fex_with_http_info(moid, equipment_fex, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fex ...'
  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 EquipmentApi.patch_equipment_fex"
  end
  # verify the required parameter 'equipment_fex' is set
  if @api_client.config.client_side_validation && equipment_fex.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fex' when calling EquipmentApi.patch_equipment_fex"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Fexes/{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(equipment_fex)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fex",
    :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: EquipmentApi#patch_equipment_fex\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_fru(moid, equipment_fru, opts = {}) ⇒ EquipmentFru

Update a ‘equipment.Fru’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fru (EquipmentFru)

    The &#39;equipment.Fru&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4756
4757
4758
4759
# File 'lib/intersight_client/api/equipment_api.rb', line 4756

def patch_equipment_fru(moid, equipment_fru, opts = {})
  data, _status_code, _headers = patch_equipment_fru_with_http_info(moid, equipment_fru, opts)
  data
end

#patch_equipment_fru_with_http_info(moid, equipment_fru, opts = {}) ⇒ Array<(EquipmentFru, Integer, Hash)>

Update a &#39;equipment.Fru&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fru (EquipmentFru)

    The &#39;equipment.Fru&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFru, Integer, Hash)>)

    EquipmentFru data, response status code and response headers



4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'lib/intersight_client/api/equipment_api.rb', line 4767

def patch_equipment_fru_with_http_info(moid, equipment_fru, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_fru ...'
  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 EquipmentApi.patch_equipment_fru"
  end
  # verify the required parameter 'equipment_fru' is set
  if @api_client.config.client_side_validation && equipment_fru.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fru' when calling EquipmentApi.patch_equipment_fru"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Frus/{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(equipment_fru)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_fru",
    :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: EquipmentApi#patch_equipment_fru\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_io_card(moid, equipment_io_card, opts = {}) ⇒ EquipmentIoCard

Update a ‘equipment.IoCard’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card (EquipmentIoCard)

    The &#39;equipment.IoCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4831
4832
4833
4834
# File 'lib/intersight_client/api/equipment_api.rb', line 4831

def patch_equipment_io_card(moid, equipment_io_card, opts = {})
  data, _status_code, _headers = patch_equipment_io_card_with_http_info(moid, equipment_io_card, opts)
  data
end

#patch_equipment_io_card_operation(moid, equipment_io_card_operation, opts = {}) ⇒ EquipmentIoCardOperation

Update a ‘equipment.IoCardOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card_operation (EquipmentIoCardOperation)

    The &#39;equipment.IoCardOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4906
4907
4908
4909
# File 'lib/intersight_client/api/equipment_api.rb', line 4906

def patch_equipment_io_card_operation(moid, equipment_io_card_operation, opts = {})
  data, _status_code, _headers = patch_equipment_io_card_operation_with_http_info(moid, equipment_io_card_operation, opts)
  data
end

#patch_equipment_io_card_operation_with_http_info(moid, equipment_io_card_operation, opts = {}) ⇒ Array<(EquipmentIoCardOperation, Integer, Hash)>

Update a &#39;equipment.IoCardOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card_operation (EquipmentIoCardOperation)

    The &#39;equipment.IoCardOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoCardOperation, Integer, Hash)>)

    EquipmentIoCardOperation data, response status code and response headers



4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'lib/intersight_client/api/equipment_api.rb', line 4917

def patch_equipment_io_card_operation_with_http_info(moid, equipment_io_card_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_io_card_operation ...'
  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 EquipmentApi.patch_equipment_io_card_operation"
  end
  # verify the required parameter 'equipment_io_card_operation' is set
  if @api_client.config.client_side_validation && equipment_io_card_operation.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_io_card_operation' when calling EquipmentApi.patch_equipment_io_card_operation"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoCardOperations/{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(equipment_io_card_operation)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_io_card_operation",
    :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: EquipmentApi#patch_equipment_io_card_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_io_card_with_http_info(moid, equipment_io_card, opts = {}) ⇒ Array<(EquipmentIoCard, Integer, Hash)>

Update a &#39;equipment.IoCard&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card (EquipmentIoCard)

    The &#39;equipment.IoCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoCard, Integer, Hash)>)

    EquipmentIoCard data, response status code and response headers



4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
# File 'lib/intersight_client/api/equipment_api.rb', line 4842

def patch_equipment_io_card_with_http_info(moid, equipment_io_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_io_card ...'
  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 EquipmentApi.patch_equipment_io_card"
  end
  # verify the required parameter 'equipment_io_card' is set
  if @api_client.config.client_side_validation && equipment_io_card.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_io_card' when calling EquipmentApi.patch_equipment_io_card"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoCards/{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(equipment_io_card)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_io_card",
    :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: EquipmentApi#patch_equipment_io_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_io_expander(moid, equipment_io_expander, opts = {}) ⇒ EquipmentIoExpander

Update a ‘equipment.IoExpander’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_expander (EquipmentIoExpander)

    The &#39;equipment.IoExpander&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



4981
4982
4983
4984
# File 'lib/intersight_client/api/equipment_api.rb', line 4981

def patch_equipment_io_expander(moid, equipment_io_expander, opts = {})
  data, _status_code, _headers = patch_equipment_io_expander_with_http_info(moid, equipment_io_expander, opts)
  data
end

#patch_equipment_io_expander_with_http_info(moid, equipment_io_expander, opts = {}) ⇒ Array<(EquipmentIoExpander, Integer, Hash)>

Update a &#39;equipment.IoExpander&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_expander (EquipmentIoExpander)

    The &#39;equipment.IoExpander&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoExpander, Integer, Hash)>)

    EquipmentIoExpander data, response status code and response headers



4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
# File 'lib/intersight_client/api/equipment_api.rb', line 4992

def patch_equipment_io_expander_with_http_info(moid, equipment_io_expander, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_io_expander ...'
  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 EquipmentApi.patch_equipment_io_expander"
  end
  # verify the required parameter 'equipment_io_expander' is set
  if @api_client.config.client_side_validation && equipment_io_expander.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_io_expander' when calling EquipmentApi.patch_equipment_io_expander"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoExpanders/{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(equipment_io_expander)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_io_expander",
    :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: EquipmentApi#patch_equipment_io_expander\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_locator_led(moid, equipment_locator_led, opts = {}) ⇒ EquipmentLocatorLed

Update a ‘equipment.LocatorLed’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_locator_led (EquipmentLocatorLed)

    The &#39;equipment.LocatorLed&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5056
5057
5058
5059
# File 'lib/intersight_client/api/equipment_api.rb', line 5056

def patch_equipment_locator_led(moid, equipment_locator_led, opts = {})
  data, _status_code, _headers = patch_equipment_locator_led_with_http_info(moid, equipment_locator_led, opts)
  data
end

#patch_equipment_locator_led_with_http_info(moid, equipment_locator_led, opts = {}) ⇒ Array<(EquipmentLocatorLed, Integer, Hash)>

Update a &#39;equipment.LocatorLed&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_locator_led (EquipmentLocatorLed)

    The &#39;equipment.LocatorLed&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentLocatorLed, Integer, Hash)>)

    EquipmentLocatorLed data, response status code and response headers



5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
# File 'lib/intersight_client/api/equipment_api.rb', line 5067

def patch_equipment_locator_led_with_http_info(moid, equipment_locator_led, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_locator_led ...'
  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 EquipmentApi.patch_equipment_locator_led"
  end
  # verify the required parameter 'equipment_locator_led' is set
  if @api_client.config.client_side_validation && equipment_locator_led.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_locator_led' when calling EquipmentApi.patch_equipment_locator_led"
  end
  # resource path
  local_var_path = '/api/v1/equipment/LocatorLeds/{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(equipment_locator_led)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_locator_led",
    :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: EquipmentApi#patch_equipment_locator_led\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_psu(moid, equipment_psu, opts = {}) ⇒ EquipmentPsu

Update a ‘equipment.Psu’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu (EquipmentPsu)

    The &#39;equipment.Psu&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5131
5132
5133
5134
# File 'lib/intersight_client/api/equipment_api.rb', line 5131

def patch_equipment_psu(moid, equipment_psu, opts = {})
  data, _status_code, _headers = patch_equipment_psu_with_http_info(moid, equipment_psu, opts)
  data
end

#patch_equipment_psu_control(moid, equipment_psu_control, opts = {}) ⇒ EquipmentPsuControl

Update a ‘equipment.PsuControl’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu_control (EquipmentPsuControl)

    The &#39;equipment.PsuControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5206
5207
5208
5209
# File 'lib/intersight_client/api/equipment_api.rb', line 5206

def patch_equipment_psu_control(moid, equipment_psu_control, opts = {})
  data, _status_code, _headers = patch_equipment_psu_control_with_http_info(moid, equipment_psu_control, opts)
  data
end

#patch_equipment_psu_control_with_http_info(moid, equipment_psu_control, opts = {}) ⇒ Array<(EquipmentPsuControl, Integer, Hash)>

Update a &#39;equipment.PsuControl&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu_control (EquipmentPsuControl)

    The &#39;equipment.PsuControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentPsuControl, Integer, Hash)>)

    EquipmentPsuControl data, response status code and response headers



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
# File 'lib/intersight_client/api/equipment_api.rb', line 5217

def patch_equipment_psu_control_with_http_info(moid, equipment_psu_control, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_psu_control ...'
  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 EquipmentApi.patch_equipment_psu_control"
  end
  # verify the required parameter 'equipment_psu_control' is set
  if @api_client.config.client_side_validation && equipment_psu_control.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_psu_control' when calling EquipmentApi.patch_equipment_psu_control"
  end
  # resource path
  local_var_path = '/api/v1/equipment/PsuControls/{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(equipment_psu_control)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_psu_control",
    :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: EquipmentApi#patch_equipment_psu_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_psu_with_http_info(moid, equipment_psu, opts = {}) ⇒ Array<(EquipmentPsu, Integer, Hash)>

Update a &#39;equipment.Psu&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu (EquipmentPsu)

    The &#39;equipment.Psu&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentPsu, Integer, Hash)>)

    EquipmentPsu data, response status code and response headers



5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
# File 'lib/intersight_client/api/equipment_api.rb', line 5142

def patch_equipment_psu_with_http_info(moid, equipment_psu, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_psu ...'
  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 EquipmentApi.patch_equipment_psu"
  end
  # verify the required parameter 'equipment_psu' is set
  if @api_client.config.client_side_validation && equipment_psu.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_psu' when calling EquipmentApi.patch_equipment_psu"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Psus/{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(equipment_psu)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_psu",
    :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: EquipmentApi#patch_equipment_psu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_rack_enclosure(moid, equipment_rack_enclosure, opts = {}) ⇒ EquipmentRackEnclosure

Update a ‘equipment.RackEnclosure’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure (EquipmentRackEnclosure)

    The &#39;equipment.RackEnclosure&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5281
5282
5283
5284
# File 'lib/intersight_client/api/equipment_api.rb', line 5281

def patch_equipment_rack_enclosure(moid, equipment_rack_enclosure, opts = {})
  data, _status_code, _headers = patch_equipment_rack_enclosure_with_http_info(moid, equipment_rack_enclosure, opts)
  data
end

#patch_equipment_rack_enclosure_slot(moid, equipment_rack_enclosure_slot, opts = {}) ⇒ EquipmentRackEnclosureSlot

Update a ‘equipment.RackEnclosureSlot’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure_slot (EquipmentRackEnclosureSlot)

    The &#39;equipment.RackEnclosureSlot&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5356
5357
5358
5359
# File 'lib/intersight_client/api/equipment_api.rb', line 5356

def patch_equipment_rack_enclosure_slot(moid, equipment_rack_enclosure_slot, opts = {})
  data, _status_code, _headers = patch_equipment_rack_enclosure_slot_with_http_info(moid, equipment_rack_enclosure_slot, opts)
  data
end

#patch_equipment_rack_enclosure_slot_with_http_info(moid, equipment_rack_enclosure_slot, opts = {}) ⇒ Array<(EquipmentRackEnclosureSlot, Integer, Hash)>

Update a &#39;equipment.RackEnclosureSlot&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure_slot (EquipmentRackEnclosureSlot)

    The &#39;equipment.RackEnclosureSlot&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentRackEnclosureSlot, Integer, Hash)>)

    EquipmentRackEnclosureSlot data, response status code and response headers



5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
# File 'lib/intersight_client/api/equipment_api.rb', line 5367

def patch_equipment_rack_enclosure_slot_with_http_info(moid, equipment_rack_enclosure_slot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_rack_enclosure_slot ...'
  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 EquipmentApi.patch_equipment_rack_enclosure_slot"
  end
  # verify the required parameter 'equipment_rack_enclosure_slot' is set
  if @api_client.config.client_side_validation && equipment_rack_enclosure_slot.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_rack_enclosure_slot' when calling EquipmentApi.patch_equipment_rack_enclosure_slot"
  end
  # resource path
  local_var_path = '/api/v1/equipment/RackEnclosureSlots/{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(equipment_rack_enclosure_slot)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_rack_enclosure_slot",
    :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: EquipmentApi#patch_equipment_rack_enclosure_slot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_rack_enclosure_with_http_info(moid, equipment_rack_enclosure, opts = {}) ⇒ Array<(EquipmentRackEnclosure, Integer, Hash)>

Update a &#39;equipment.RackEnclosure&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure (EquipmentRackEnclosure)

    The &#39;equipment.RackEnclosure&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentRackEnclosure, Integer, Hash)>)

    EquipmentRackEnclosure data, response status code and response headers



5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
# File 'lib/intersight_client/api/equipment_api.rb', line 5292

def patch_equipment_rack_enclosure_with_http_info(moid, equipment_rack_enclosure, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_rack_enclosure ...'
  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 EquipmentApi.patch_equipment_rack_enclosure"
  end
  # verify the required parameter 'equipment_rack_enclosure' is set
  if @api_client.config.client_side_validation && equipment_rack_enclosure.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_rack_enclosure' when calling EquipmentApi.patch_equipment_rack_enclosure"
  end
  # resource path
  local_var_path = '/api/v1/equipment/RackEnclosures/{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(equipment_rack_enclosure)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_rack_enclosure",
    :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: EquipmentApi#patch_equipment_rack_enclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_shared_io_module(moid, equipment_shared_io_module, opts = {}) ⇒ EquipmentSharedIoModule

Update a ‘equipment.SharedIoModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_shared_io_module (EquipmentSharedIoModule)

    The &#39;equipment.SharedIoModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5431
5432
5433
5434
# File 'lib/intersight_client/api/equipment_api.rb', line 5431

def patch_equipment_shared_io_module(moid, equipment_shared_io_module, opts = {})
  data, _status_code, _headers = patch_equipment_shared_io_module_with_http_info(moid, equipment_shared_io_module, opts)
  data
end

#patch_equipment_shared_io_module_with_http_info(moid, equipment_shared_io_module, opts = {}) ⇒ Array<(EquipmentSharedIoModule, Integer, Hash)>

Update a &#39;equipment.SharedIoModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_shared_io_module (EquipmentSharedIoModule)

    The &#39;equipment.SharedIoModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSharedIoModule, Integer, Hash)>)

    EquipmentSharedIoModule data, response status code and response headers



5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
# File 'lib/intersight_client/api/equipment_api.rb', line 5442

def patch_equipment_shared_io_module_with_http_info(moid, equipment_shared_io_module, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_shared_io_module ...'
  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 EquipmentApi.patch_equipment_shared_io_module"
  end
  # verify the required parameter 'equipment_shared_io_module' is set
  if @api_client.config.client_side_validation && equipment_shared_io_module.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_shared_io_module' when calling EquipmentApi.patch_equipment_shared_io_module"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SharedIoModules/{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(equipment_shared_io_module)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_shared_io_module",
    :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: EquipmentApi#patch_equipment_shared_io_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_switch_card(moid, equipment_switch_card, opts = {}) ⇒ EquipmentSwitchCard

Update a ‘equipment.SwitchCard’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_switch_card (EquipmentSwitchCard)

    The &#39;equipment.SwitchCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5506
5507
5508
5509
# File 'lib/intersight_client/api/equipment_api.rb', line 5506

def patch_equipment_switch_card(moid, equipment_switch_card, opts = {})
  data, _status_code, _headers = patch_equipment_switch_card_with_http_info(moid, equipment_switch_card, opts)
  data
end

#patch_equipment_switch_card_with_http_info(moid, equipment_switch_card, opts = {}) ⇒ Array<(EquipmentSwitchCard, Integer, Hash)>

Update a &#39;equipment.SwitchCard&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_switch_card (EquipmentSwitchCard)

    The &#39;equipment.SwitchCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSwitchCard, Integer, Hash)>)

    EquipmentSwitchCard data, response status code and response headers



5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
# File 'lib/intersight_client/api/equipment_api.rb', line 5517

def patch_equipment_switch_card_with_http_info(moid, equipment_switch_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_switch_card ...'
  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 EquipmentApi.patch_equipment_switch_card"
  end
  # verify the required parameter 'equipment_switch_card' is set
  if @api_client.config.client_side_validation && equipment_switch_card.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_switch_card' when calling EquipmentApi.patch_equipment_switch_card"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SwitchCards/{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(equipment_switch_card)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_switch_card",
    :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: EquipmentApi#patch_equipment_switch_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_system_io_controller(moid, equipment_system_io_controller, opts = {}) ⇒ EquipmentSystemIoController

Update a ‘equipment.SystemIoController’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_system_io_controller (EquipmentSystemIoController)

    The &#39;equipment.SystemIoController&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5581
5582
5583
5584
# File 'lib/intersight_client/api/equipment_api.rb', line 5581

def patch_equipment_system_io_controller(moid, equipment_system_io_controller, opts = {})
  data, _status_code, _headers = patch_equipment_system_io_controller_with_http_info(moid, equipment_system_io_controller, opts)
  data
end

#patch_equipment_system_io_controller_with_http_info(moid, equipment_system_io_controller, opts = {}) ⇒ Array<(EquipmentSystemIoController, Integer, Hash)>

Update a &#39;equipment.SystemIoController&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_system_io_controller (EquipmentSystemIoController)

    The &#39;equipment.SystemIoController&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSystemIoController, Integer, Hash)>)

    EquipmentSystemIoController data, response status code and response headers



5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
# File 'lib/intersight_client/api/equipment_api.rb', line 5592

def patch_equipment_system_io_controller_with_http_info(moid, equipment_system_io_controller, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_system_io_controller ...'
  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 EquipmentApi.patch_equipment_system_io_controller"
  end
  # verify the required parameter 'equipment_system_io_controller' is set
  if @api_client.config.client_side_validation && equipment_system_io_controller.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_system_io_controller' when calling EquipmentApi.patch_equipment_system_io_controller"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SystemIoControllers/{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(equipment_system_io_controller)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_system_io_controller",
    :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: EquipmentApi#patch_equipment_system_io_controller\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_tpm(moid, equipment_tpm, opts = {}) ⇒ EquipmentTpm

Update a ‘equipment.Tpm’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_tpm (EquipmentTpm)

    The &#39;equipment.Tpm&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5656
5657
5658
5659
# File 'lib/intersight_client/api/equipment_api.rb', line 5656

def patch_equipment_tpm(moid, equipment_tpm, opts = {})
  data, _status_code, _headers = patch_equipment_tpm_with_http_info(moid, equipment_tpm, opts)
  data
end

#patch_equipment_tpm_with_http_info(moid, equipment_tpm, opts = {}) ⇒ Array<(EquipmentTpm, Integer, Hash)>

Update a &#39;equipment.Tpm&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_tpm (EquipmentTpm)

    The &#39;equipment.Tpm&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentTpm, Integer, Hash)>)

    EquipmentTpm data, response status code and response headers



5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
# File 'lib/intersight_client/api/equipment_api.rb', line 5667

def patch_equipment_tpm_with_http_info(moid, equipment_tpm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_tpm ...'
  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 EquipmentApi.patch_equipment_tpm"
  end
  # verify the required parameter 'equipment_tpm' is set
  if @api_client.config.client_side_validation && equipment_tpm.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_tpm' when calling EquipmentApi.patch_equipment_tpm"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Tpms/{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(equipment_tpm)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_tpm",
    :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: EquipmentApi#patch_equipment_tpm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_equipment_transceiver(moid, equipment_transceiver, opts = {}) ⇒ EquipmentTransceiver

Update a ‘equipment.Transceiver’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_transceiver (EquipmentTransceiver)

    The &#39;equipment.Transceiver&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5731
5732
5733
5734
# File 'lib/intersight_client/api/equipment_api.rb', line 5731

def patch_equipment_transceiver(moid, equipment_transceiver, opts = {})
  data, _status_code, _headers = patch_equipment_transceiver_with_http_info(moid, equipment_transceiver, opts)
  data
end

#patch_equipment_transceiver_with_http_info(moid, equipment_transceiver, opts = {}) ⇒ Array<(EquipmentTransceiver, Integer, Hash)>

Update a &#39;equipment.Transceiver&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_transceiver (EquipmentTransceiver)

    The &#39;equipment.Transceiver&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentTransceiver, Integer, Hash)>)

    EquipmentTransceiver data, response status code and response headers



5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
# File 'lib/intersight_client/api/equipment_api.rb', line 5742

def patch_equipment_transceiver_with_http_info(moid, equipment_transceiver, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.patch_equipment_transceiver ...'
  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 EquipmentApi.patch_equipment_transceiver"
  end
  # verify the required parameter 'equipment_transceiver' is set
  if @api_client.config.client_side_validation && equipment_transceiver.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_transceiver' when calling EquipmentApi.patch_equipment_transceiver"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Transceivers/{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(equipment_transceiver)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.patch_equipment_transceiver",
    :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: EquipmentApi#patch_equipment_transceiver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_chassis(moid, equipment_chassis, opts = {}) ⇒ EquipmentChassis

Update a ‘equipment.Chassis’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis (EquipmentChassis)

    The &#39;equipment.Chassis&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5806
5807
5808
5809
# File 'lib/intersight_client/api/equipment_api.rb', line 5806

def update_equipment_chassis(moid, equipment_chassis, opts = {})
  data, _status_code, _headers = update_equipment_chassis_with_http_info(moid, equipment_chassis, opts)
  data
end

#update_equipment_chassis_identity(moid, equipment_chassis_identity, opts = {}) ⇒ EquipmentChassisIdentity

Update a ‘equipment.ChassisIdentity’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_identity (EquipmentChassisIdentity)

    The &#39;equipment.ChassisIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5881
5882
5883
5884
# File 'lib/intersight_client/api/equipment_api.rb', line 5881

def update_equipment_chassis_identity(moid, equipment_chassis_identity, opts = {})
  data, _status_code, _headers = update_equipment_chassis_identity_with_http_info(moid, equipment_chassis_identity, opts)
  data
end

#update_equipment_chassis_identity_with_http_info(moid, equipment_chassis_identity, opts = {}) ⇒ Array<(EquipmentChassisIdentity, Integer, Hash)>

Update a &#39;equipment.ChassisIdentity&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_identity (EquipmentChassisIdentity)

    The &#39;equipment.ChassisIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassisIdentity, Integer, Hash)>)

    EquipmentChassisIdentity data, response status code and response headers



5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
# File 'lib/intersight_client/api/equipment_api.rb', line 5892

def update_equipment_chassis_identity_with_http_info(moid, equipment_chassis_identity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_chassis_identity ...'
  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 EquipmentApi.update_equipment_chassis_identity"
  end
  # verify the required parameter 'equipment_chassis_identity' is set
  if @api_client.config.client_side_validation && equipment_chassis_identity.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_chassis_identity' when calling EquipmentApi.update_equipment_chassis_identity"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ChassisIdentities/{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(equipment_chassis_identity)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_chassis_identity",
    :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: EquipmentApi#update_equipment_chassis_identity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_chassis_operation(moid, equipment_chassis_operation, opts = {}) ⇒ EquipmentChassisOperation

Update a ‘equipment.ChassisOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_operation (EquipmentChassisOperation)

    The &#39;equipment.ChassisOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



5956
5957
5958
5959
# File 'lib/intersight_client/api/equipment_api.rb', line 5956

def update_equipment_chassis_operation(moid, equipment_chassis_operation, opts = {})
  data, _status_code, _headers = update_equipment_chassis_operation_with_http_info(moid, equipment_chassis_operation, opts)
  data
end

#update_equipment_chassis_operation_with_http_info(moid, equipment_chassis_operation, opts = {}) ⇒ Array<(EquipmentChassisOperation, Integer, Hash)>

Update a &#39;equipment.ChassisOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis_operation (EquipmentChassisOperation)

    The &#39;equipment.ChassisOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassisOperation, Integer, Hash)>)

    EquipmentChassisOperation data, response status code and response headers



5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# File 'lib/intersight_client/api/equipment_api.rb', line 5967

def update_equipment_chassis_operation_with_http_info(moid, equipment_chassis_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_chassis_operation ...'
  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 EquipmentApi.update_equipment_chassis_operation"
  end
  # verify the required parameter 'equipment_chassis_operation' is set
  if @api_client.config.client_side_validation && equipment_chassis_operation.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_chassis_operation' when calling EquipmentApi.update_equipment_chassis_operation"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ChassisOperations/{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(equipment_chassis_operation)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_chassis_operation",
    :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: EquipmentApi#update_equipment_chassis_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_chassis_with_http_info(moid, equipment_chassis, opts = {}) ⇒ Array<(EquipmentChassis, Integer, Hash)>

Update a &#39;equipment.Chassis&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_chassis (EquipmentChassis)

    The &#39;equipment.Chassis&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentChassis, Integer, Hash)>)

    EquipmentChassis data, response status code and response headers



5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
# File 'lib/intersight_client/api/equipment_api.rb', line 5817

def update_equipment_chassis_with_http_info(moid, equipment_chassis, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_chassis ...'
  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 EquipmentApi.update_equipment_chassis"
  end
  # verify the required parameter 'equipment_chassis' is set
  if @api_client.config.client_side_validation && equipment_chassis.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_chassis' when calling EquipmentApi.update_equipment_chassis"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Chasses/{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(equipment_chassis)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_chassis",
    :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: EquipmentApi#update_equipment_chassis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_expander_module(moid, equipment_expander_module, opts = {}) ⇒ EquipmentExpanderModule

Update a ‘equipment.ExpanderModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_expander_module (EquipmentExpanderModule)

    The &#39;equipment.ExpanderModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6031
6032
6033
6034
# File 'lib/intersight_client/api/equipment_api.rb', line 6031

def update_equipment_expander_module(moid, equipment_expander_module, opts = {})
  data, _status_code, _headers = update_equipment_expander_module_with_http_info(moid, equipment_expander_module, opts)
  data
end

#update_equipment_expander_module_with_http_info(moid, equipment_expander_module, opts = {}) ⇒ Array<(EquipmentExpanderModule, Integer, Hash)>

Update a &#39;equipment.ExpanderModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_expander_module (EquipmentExpanderModule)

    The &#39;equipment.ExpanderModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentExpanderModule, Integer, Hash)>)

    EquipmentExpanderModule data, response status code and response headers



6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
# File 'lib/intersight_client/api/equipment_api.rb', line 6042

def update_equipment_expander_module_with_http_info(moid, equipment_expander_module, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_expander_module ...'
  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 EquipmentApi.update_equipment_expander_module"
  end
  # verify the required parameter 'equipment_expander_module' is set
  if @api_client.config.client_side_validation && equipment_expander_module.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_expander_module' when calling EquipmentApi.update_equipment_expander_module"
  end
  # resource path
  local_var_path = '/api/v1/equipment/ExpanderModules/{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(equipment_expander_module)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_expander_module",
    :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: EquipmentApi#update_equipment_expander_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fan(moid, equipment_fan, opts = {}) ⇒ EquipmentFan

Update a ‘equipment.Fan’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan (EquipmentFan)

    The &#39;equipment.Fan&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6106
6107
6108
6109
# File 'lib/intersight_client/api/equipment_api.rb', line 6106

def update_equipment_fan(moid, equipment_fan, opts = {})
  data, _status_code, _headers = update_equipment_fan_with_http_info(moid, equipment_fan, opts)
  data
end

#update_equipment_fan_control(moid, equipment_fan_control, opts = {}) ⇒ EquipmentFanControl

Update a ‘equipment.FanControl’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_control (EquipmentFanControl)

    The &#39;equipment.FanControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6181
6182
6183
6184
# File 'lib/intersight_client/api/equipment_api.rb', line 6181

def update_equipment_fan_control(moid, equipment_fan_control, opts = {})
  data, _status_code, _headers = update_equipment_fan_control_with_http_info(moid, equipment_fan_control, opts)
  data
end

#update_equipment_fan_control_with_http_info(moid, equipment_fan_control, opts = {}) ⇒ Array<(EquipmentFanControl, Integer, Hash)>

Update a &#39;equipment.FanControl&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_control (EquipmentFanControl)

    The &#39;equipment.FanControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanControl, Integer, Hash)>)

    EquipmentFanControl data, response status code and response headers



6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
# File 'lib/intersight_client/api/equipment_api.rb', line 6192

def update_equipment_fan_control_with_http_info(moid, equipment_fan_control, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fan_control ...'
  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 EquipmentApi.update_equipment_fan_control"
  end
  # verify the required parameter 'equipment_fan_control' is set
  if @api_client.config.client_side_validation && equipment_fan_control.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fan_control' when calling EquipmentApi.update_equipment_fan_control"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FanControls/{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(equipment_fan_control)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fan_control",
    :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: EquipmentApi#update_equipment_fan_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fan_module(moid, equipment_fan_module, opts = {}) ⇒ EquipmentFanModule

Update a ‘equipment.FanModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_module (EquipmentFanModule)

    The &#39;equipment.FanModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6256
6257
6258
6259
# File 'lib/intersight_client/api/equipment_api.rb', line 6256

def update_equipment_fan_module(moid, equipment_fan_module, opts = {})
  data, _status_code, _headers = update_equipment_fan_module_with_http_info(moid, equipment_fan_module, opts)
  data
end

#update_equipment_fan_module_with_http_info(moid, equipment_fan_module, opts = {}) ⇒ Array<(EquipmentFanModule, Integer, Hash)>

Update a &#39;equipment.FanModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan_module (EquipmentFanModule)

    The &#39;equipment.FanModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFanModule, Integer, Hash)>)

    EquipmentFanModule data, response status code and response headers



6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
# File 'lib/intersight_client/api/equipment_api.rb', line 6267

def update_equipment_fan_module_with_http_info(moid, equipment_fan_module, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fan_module ...'
  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 EquipmentApi.update_equipment_fan_module"
  end
  # verify the required parameter 'equipment_fan_module' is set
  if @api_client.config.client_side_validation && equipment_fan_module.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fan_module' when calling EquipmentApi.update_equipment_fan_module"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FanModules/{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(equipment_fan_module)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fan_module",
    :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: EquipmentApi#update_equipment_fan_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fan_with_http_info(moid, equipment_fan, opts = {}) ⇒ Array<(EquipmentFan, Integer, Hash)>

Update a &#39;equipment.Fan&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fan (EquipmentFan)

    The &#39;equipment.Fan&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFan, Integer, Hash)>)

    EquipmentFan data, response status code and response headers



6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
# File 'lib/intersight_client/api/equipment_api.rb', line 6117

def update_equipment_fan_with_http_info(moid, equipment_fan, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fan ...'
  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 EquipmentApi.update_equipment_fan"
  end
  # verify the required parameter 'equipment_fan' is set
  if @api_client.config.client_side_validation && equipment_fan.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fan' when calling EquipmentApi.update_equipment_fan"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Fans/{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(equipment_fan)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fan",
    :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: EquipmentApi#update_equipment_fan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fex(moid, equipment_fex, opts = {}) ⇒ EquipmentFex

Update a ‘equipment.Fex’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex (EquipmentFex)

    The &#39;equipment.Fex&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6331
6332
6333
6334
# File 'lib/intersight_client/api/equipment_api.rb', line 6331

def update_equipment_fex(moid, equipment_fex, opts = {})
  data, _status_code, _headers = update_equipment_fex_with_http_info(moid, equipment_fex, opts)
  data
end

#update_equipment_fex_identity(moid, equipment_fex_identity, opts = {}) ⇒ EquipmentFexIdentity

Update a ‘equipment.FexIdentity’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_identity (EquipmentFexIdentity)

    The &#39;equipment.FexIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6406
6407
6408
6409
# File 'lib/intersight_client/api/equipment_api.rb', line 6406

def update_equipment_fex_identity(moid, equipment_fex_identity, opts = {})
  data, _status_code, _headers = update_equipment_fex_identity_with_http_info(moid, equipment_fex_identity, opts)
  data
end

#update_equipment_fex_identity_with_http_info(moid, equipment_fex_identity, opts = {}) ⇒ Array<(EquipmentFexIdentity, Integer, Hash)>

Update a &#39;equipment.FexIdentity&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_identity (EquipmentFexIdentity)

    The &#39;equipment.FexIdentity&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFexIdentity, Integer, Hash)>)

    EquipmentFexIdentity data, response status code and response headers



6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
# File 'lib/intersight_client/api/equipment_api.rb', line 6417

def update_equipment_fex_identity_with_http_info(moid, equipment_fex_identity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fex_identity ...'
  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 EquipmentApi.update_equipment_fex_identity"
  end
  # verify the required parameter 'equipment_fex_identity' is set
  if @api_client.config.client_side_validation && equipment_fex_identity.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fex_identity' when calling EquipmentApi.update_equipment_fex_identity"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FexIdentities/{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(equipment_fex_identity)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fex_identity",
    :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: EquipmentApi#update_equipment_fex_identity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fex_operation(moid, equipment_fex_operation, opts = {}) ⇒ EquipmentFexOperation

Update a ‘equipment.FexOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_operation (EquipmentFexOperation)

    The &#39;equipment.FexOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6481
6482
6483
6484
# File 'lib/intersight_client/api/equipment_api.rb', line 6481

def update_equipment_fex_operation(moid, equipment_fex_operation, opts = {})
  data, _status_code, _headers = update_equipment_fex_operation_with_http_info(moid, equipment_fex_operation, opts)
  data
end

#update_equipment_fex_operation_with_http_info(moid, equipment_fex_operation, opts = {}) ⇒ Array<(EquipmentFexOperation, Integer, Hash)>

Update a &#39;equipment.FexOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex_operation (EquipmentFexOperation)

    The &#39;equipment.FexOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFexOperation, Integer, Hash)>)

    EquipmentFexOperation data, response status code and response headers



6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
# File 'lib/intersight_client/api/equipment_api.rb', line 6492

def update_equipment_fex_operation_with_http_info(moid, equipment_fex_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fex_operation ...'
  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 EquipmentApi.update_equipment_fex_operation"
  end
  # verify the required parameter 'equipment_fex_operation' is set
  if @api_client.config.client_side_validation && equipment_fex_operation.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fex_operation' when calling EquipmentApi.update_equipment_fex_operation"
  end
  # resource path
  local_var_path = '/api/v1/equipment/FexOperations/{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(equipment_fex_operation)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fex_operation",
    :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: EquipmentApi#update_equipment_fex_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fex_with_http_info(moid, equipment_fex, opts = {}) ⇒ Array<(EquipmentFex, Integer, Hash)>

Update a &#39;equipment.Fex&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fex (EquipmentFex)

    The &#39;equipment.Fex&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFex, Integer, Hash)>)

    EquipmentFex data, response status code and response headers



6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
# File 'lib/intersight_client/api/equipment_api.rb', line 6342

def update_equipment_fex_with_http_info(moid, equipment_fex, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fex ...'
  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 EquipmentApi.update_equipment_fex"
  end
  # verify the required parameter 'equipment_fex' is set
  if @api_client.config.client_side_validation && equipment_fex.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fex' when calling EquipmentApi.update_equipment_fex"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Fexes/{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(equipment_fex)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fex",
    :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: EquipmentApi#update_equipment_fex\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_fru(moid, equipment_fru, opts = {}) ⇒ EquipmentFru

Update a ‘equipment.Fru’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fru (EquipmentFru)

    The &#39;equipment.Fru&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6556
6557
6558
6559
# File 'lib/intersight_client/api/equipment_api.rb', line 6556

def update_equipment_fru(moid, equipment_fru, opts = {})
  data, _status_code, _headers = update_equipment_fru_with_http_info(moid, equipment_fru, opts)
  data
end

#update_equipment_fru_with_http_info(moid, equipment_fru, opts = {}) ⇒ Array<(EquipmentFru, Integer, Hash)>

Update a &#39;equipment.Fru&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_fru (EquipmentFru)

    The &#39;equipment.Fru&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentFru, Integer, Hash)>)

    EquipmentFru data, response status code and response headers



6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
# File 'lib/intersight_client/api/equipment_api.rb', line 6567

def update_equipment_fru_with_http_info(moid, equipment_fru, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_fru ...'
  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 EquipmentApi.update_equipment_fru"
  end
  # verify the required parameter 'equipment_fru' is set
  if @api_client.config.client_side_validation && equipment_fru.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_fru' when calling EquipmentApi.update_equipment_fru"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Frus/{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(equipment_fru)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_fru",
    :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: EquipmentApi#update_equipment_fru\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_io_card(moid, equipment_io_card, opts = {}) ⇒ EquipmentIoCard

Update a ‘equipment.IoCard’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card (EquipmentIoCard)

    The &#39;equipment.IoCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6631
6632
6633
6634
# File 'lib/intersight_client/api/equipment_api.rb', line 6631

def update_equipment_io_card(moid, equipment_io_card, opts = {})
  data, _status_code, _headers = update_equipment_io_card_with_http_info(moid, equipment_io_card, opts)
  data
end

#update_equipment_io_card_operation(moid, equipment_io_card_operation, opts = {}) ⇒ EquipmentIoCardOperation

Update a ‘equipment.IoCardOperation’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card_operation (EquipmentIoCardOperation)

    The &#39;equipment.IoCardOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6706
6707
6708
6709
# File 'lib/intersight_client/api/equipment_api.rb', line 6706

def update_equipment_io_card_operation(moid, equipment_io_card_operation, opts = {})
  data, _status_code, _headers = update_equipment_io_card_operation_with_http_info(moid, equipment_io_card_operation, opts)
  data
end

#update_equipment_io_card_operation_with_http_info(moid, equipment_io_card_operation, opts = {}) ⇒ Array<(EquipmentIoCardOperation, Integer, Hash)>

Update a &#39;equipment.IoCardOperation&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card_operation (EquipmentIoCardOperation)

    The &#39;equipment.IoCardOperation&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoCardOperation, Integer, Hash)>)

    EquipmentIoCardOperation data, response status code and response headers



6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
# File 'lib/intersight_client/api/equipment_api.rb', line 6717

def update_equipment_io_card_operation_with_http_info(moid, equipment_io_card_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_io_card_operation ...'
  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 EquipmentApi.update_equipment_io_card_operation"
  end
  # verify the required parameter 'equipment_io_card_operation' is set
  if @api_client.config.client_side_validation && equipment_io_card_operation.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_io_card_operation' when calling EquipmentApi.update_equipment_io_card_operation"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoCardOperations/{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(equipment_io_card_operation)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_io_card_operation",
    :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: EquipmentApi#update_equipment_io_card_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_io_card_with_http_info(moid, equipment_io_card, opts = {}) ⇒ Array<(EquipmentIoCard, Integer, Hash)>

Update a &#39;equipment.IoCard&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_card (EquipmentIoCard)

    The &#39;equipment.IoCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoCard, Integer, Hash)>)

    EquipmentIoCard data, response status code and response headers



6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
# File 'lib/intersight_client/api/equipment_api.rb', line 6642

def update_equipment_io_card_with_http_info(moid, equipment_io_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_io_card ...'
  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 EquipmentApi.update_equipment_io_card"
  end
  # verify the required parameter 'equipment_io_card' is set
  if @api_client.config.client_side_validation && equipment_io_card.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_io_card' when calling EquipmentApi.update_equipment_io_card"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoCards/{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(equipment_io_card)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_io_card",
    :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: EquipmentApi#update_equipment_io_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_io_expander(moid, equipment_io_expander, opts = {}) ⇒ EquipmentIoExpander

Update a ‘equipment.IoExpander’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_expander (EquipmentIoExpander)

    The &#39;equipment.IoExpander&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6781
6782
6783
6784
# File 'lib/intersight_client/api/equipment_api.rb', line 6781

def update_equipment_io_expander(moid, equipment_io_expander, opts = {})
  data, _status_code, _headers = update_equipment_io_expander_with_http_info(moid, equipment_io_expander, opts)
  data
end

#update_equipment_io_expander_with_http_info(moid, equipment_io_expander, opts = {}) ⇒ Array<(EquipmentIoExpander, Integer, Hash)>

Update a &#39;equipment.IoExpander&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_io_expander (EquipmentIoExpander)

    The &#39;equipment.IoExpander&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentIoExpander, Integer, Hash)>)

    EquipmentIoExpander data, response status code and response headers



6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
# File 'lib/intersight_client/api/equipment_api.rb', line 6792

def update_equipment_io_expander_with_http_info(moid, equipment_io_expander, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_io_expander ...'
  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 EquipmentApi.update_equipment_io_expander"
  end
  # verify the required parameter 'equipment_io_expander' is set
  if @api_client.config.client_side_validation && equipment_io_expander.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_io_expander' when calling EquipmentApi.update_equipment_io_expander"
  end
  # resource path
  local_var_path = '/api/v1/equipment/IoExpanders/{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(equipment_io_expander)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_io_expander",
    :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: EquipmentApi#update_equipment_io_expander\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_locator_led(moid, equipment_locator_led, opts = {}) ⇒ EquipmentLocatorLed

Update a ‘equipment.LocatorLed’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_locator_led (EquipmentLocatorLed)

    The &#39;equipment.LocatorLed&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6856
6857
6858
6859
# File 'lib/intersight_client/api/equipment_api.rb', line 6856

def update_equipment_locator_led(moid, equipment_locator_led, opts = {})
  data, _status_code, _headers = update_equipment_locator_led_with_http_info(moid, equipment_locator_led, opts)
  data
end

#update_equipment_locator_led_with_http_info(moid, equipment_locator_led, opts = {}) ⇒ Array<(EquipmentLocatorLed, Integer, Hash)>

Update a &#39;equipment.LocatorLed&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_locator_led (EquipmentLocatorLed)

    The &#39;equipment.LocatorLed&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentLocatorLed, Integer, Hash)>)

    EquipmentLocatorLed data, response status code and response headers



6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
# File 'lib/intersight_client/api/equipment_api.rb', line 6867

def update_equipment_locator_led_with_http_info(moid, equipment_locator_led, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_locator_led ...'
  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 EquipmentApi.update_equipment_locator_led"
  end
  # verify the required parameter 'equipment_locator_led' is set
  if @api_client.config.client_side_validation && equipment_locator_led.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_locator_led' when calling EquipmentApi.update_equipment_locator_led"
  end
  # resource path
  local_var_path = '/api/v1/equipment/LocatorLeds/{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(equipment_locator_led)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_locator_led",
    :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: EquipmentApi#update_equipment_locator_led\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_psu(moid, equipment_psu, opts = {}) ⇒ EquipmentPsu

Update a ‘equipment.Psu’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu (EquipmentPsu)

    The &#39;equipment.Psu&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



6931
6932
6933
6934
# File 'lib/intersight_client/api/equipment_api.rb', line 6931

def update_equipment_psu(moid, equipment_psu, opts = {})
  data, _status_code, _headers = update_equipment_psu_with_http_info(moid, equipment_psu, opts)
  data
end

#update_equipment_psu_control(moid, equipment_psu_control, opts = {}) ⇒ EquipmentPsuControl

Update a ‘equipment.PsuControl’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu_control (EquipmentPsuControl)

    The &#39;equipment.PsuControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7006
7007
7008
7009
# File 'lib/intersight_client/api/equipment_api.rb', line 7006

def update_equipment_psu_control(moid, equipment_psu_control, opts = {})
  data, _status_code, _headers = update_equipment_psu_control_with_http_info(moid, equipment_psu_control, opts)
  data
end

#update_equipment_psu_control_with_http_info(moid, equipment_psu_control, opts = {}) ⇒ Array<(EquipmentPsuControl, Integer, Hash)>

Update a &#39;equipment.PsuControl&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu_control (EquipmentPsuControl)

    The &#39;equipment.PsuControl&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentPsuControl, Integer, Hash)>)

    EquipmentPsuControl data, response status code and response headers



7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
# File 'lib/intersight_client/api/equipment_api.rb', line 7017

def update_equipment_psu_control_with_http_info(moid, equipment_psu_control, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_psu_control ...'
  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 EquipmentApi.update_equipment_psu_control"
  end
  # verify the required parameter 'equipment_psu_control' is set
  if @api_client.config.client_side_validation && equipment_psu_control.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_psu_control' when calling EquipmentApi.update_equipment_psu_control"
  end
  # resource path
  local_var_path = '/api/v1/equipment/PsuControls/{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(equipment_psu_control)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_psu_control",
    :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: EquipmentApi#update_equipment_psu_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_psu_with_http_info(moid, equipment_psu, opts = {}) ⇒ Array<(EquipmentPsu, Integer, Hash)>

Update a &#39;equipment.Psu&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_psu (EquipmentPsu)

    The &#39;equipment.Psu&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentPsu, Integer, Hash)>)

    EquipmentPsu data, response status code and response headers



6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
# File 'lib/intersight_client/api/equipment_api.rb', line 6942

def update_equipment_psu_with_http_info(moid, equipment_psu, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_psu ...'
  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 EquipmentApi.update_equipment_psu"
  end
  # verify the required parameter 'equipment_psu' is set
  if @api_client.config.client_side_validation && equipment_psu.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_psu' when calling EquipmentApi.update_equipment_psu"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Psus/{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(equipment_psu)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_psu",
    :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: EquipmentApi#update_equipment_psu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_rack_enclosure(moid, equipment_rack_enclosure, opts = {}) ⇒ EquipmentRackEnclosure

Update a ‘equipment.RackEnclosure’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure (EquipmentRackEnclosure)

    The &#39;equipment.RackEnclosure&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7081
7082
7083
7084
# File 'lib/intersight_client/api/equipment_api.rb', line 7081

def update_equipment_rack_enclosure(moid, equipment_rack_enclosure, opts = {})
  data, _status_code, _headers = update_equipment_rack_enclosure_with_http_info(moid, equipment_rack_enclosure, opts)
  data
end

#update_equipment_rack_enclosure_slot(moid, equipment_rack_enclosure_slot, opts = {}) ⇒ EquipmentRackEnclosureSlot

Update a ‘equipment.RackEnclosureSlot’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure_slot (EquipmentRackEnclosureSlot)

    The &#39;equipment.RackEnclosureSlot&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7156
7157
7158
7159
# File 'lib/intersight_client/api/equipment_api.rb', line 7156

def update_equipment_rack_enclosure_slot(moid, equipment_rack_enclosure_slot, opts = {})
  data, _status_code, _headers = update_equipment_rack_enclosure_slot_with_http_info(moid, equipment_rack_enclosure_slot, opts)
  data
end

#update_equipment_rack_enclosure_slot_with_http_info(moid, equipment_rack_enclosure_slot, opts = {}) ⇒ Array<(EquipmentRackEnclosureSlot, Integer, Hash)>

Update a &#39;equipment.RackEnclosureSlot&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure_slot (EquipmentRackEnclosureSlot)

    The &#39;equipment.RackEnclosureSlot&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentRackEnclosureSlot, Integer, Hash)>)

    EquipmentRackEnclosureSlot data, response status code and response headers



7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
# File 'lib/intersight_client/api/equipment_api.rb', line 7167

def update_equipment_rack_enclosure_slot_with_http_info(moid, equipment_rack_enclosure_slot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_rack_enclosure_slot ...'
  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 EquipmentApi.update_equipment_rack_enclosure_slot"
  end
  # verify the required parameter 'equipment_rack_enclosure_slot' is set
  if @api_client.config.client_side_validation && equipment_rack_enclosure_slot.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_rack_enclosure_slot' when calling EquipmentApi.update_equipment_rack_enclosure_slot"
  end
  # resource path
  local_var_path = '/api/v1/equipment/RackEnclosureSlots/{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(equipment_rack_enclosure_slot)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_rack_enclosure_slot",
    :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: EquipmentApi#update_equipment_rack_enclosure_slot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_rack_enclosure_with_http_info(moid, equipment_rack_enclosure, opts = {}) ⇒ Array<(EquipmentRackEnclosure, Integer, Hash)>

Update a &#39;equipment.RackEnclosure&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_rack_enclosure (EquipmentRackEnclosure)

    The &#39;equipment.RackEnclosure&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentRackEnclosure, Integer, Hash)>)

    EquipmentRackEnclosure data, response status code and response headers



7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
# File 'lib/intersight_client/api/equipment_api.rb', line 7092

def update_equipment_rack_enclosure_with_http_info(moid, equipment_rack_enclosure, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_rack_enclosure ...'
  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 EquipmentApi.update_equipment_rack_enclosure"
  end
  # verify the required parameter 'equipment_rack_enclosure' is set
  if @api_client.config.client_side_validation && equipment_rack_enclosure.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_rack_enclosure' when calling EquipmentApi.update_equipment_rack_enclosure"
  end
  # resource path
  local_var_path = '/api/v1/equipment/RackEnclosures/{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(equipment_rack_enclosure)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_rack_enclosure",
    :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: EquipmentApi#update_equipment_rack_enclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_shared_io_module(moid, equipment_shared_io_module, opts = {}) ⇒ EquipmentSharedIoModule

Update a ‘equipment.SharedIoModule’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_shared_io_module (EquipmentSharedIoModule)

    The &#39;equipment.SharedIoModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7231
7232
7233
7234
# File 'lib/intersight_client/api/equipment_api.rb', line 7231

def update_equipment_shared_io_module(moid, equipment_shared_io_module, opts = {})
  data, _status_code, _headers = update_equipment_shared_io_module_with_http_info(moid, equipment_shared_io_module, opts)
  data
end

#update_equipment_shared_io_module_with_http_info(moid, equipment_shared_io_module, opts = {}) ⇒ Array<(EquipmentSharedIoModule, Integer, Hash)>

Update a &#39;equipment.SharedIoModule&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_shared_io_module (EquipmentSharedIoModule)

    The &#39;equipment.SharedIoModule&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSharedIoModule, Integer, Hash)>)

    EquipmentSharedIoModule data, response status code and response headers



7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
# File 'lib/intersight_client/api/equipment_api.rb', line 7242

def update_equipment_shared_io_module_with_http_info(moid, equipment_shared_io_module, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_shared_io_module ...'
  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 EquipmentApi.update_equipment_shared_io_module"
  end
  # verify the required parameter 'equipment_shared_io_module' is set
  if @api_client.config.client_side_validation && equipment_shared_io_module.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_shared_io_module' when calling EquipmentApi.update_equipment_shared_io_module"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SharedIoModules/{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(equipment_shared_io_module)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_shared_io_module",
    :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: EquipmentApi#update_equipment_shared_io_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_switch_card(moid, equipment_switch_card, opts = {}) ⇒ EquipmentSwitchCard

Update a ‘equipment.SwitchCard’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_switch_card (EquipmentSwitchCard)

    The &#39;equipment.SwitchCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7306
7307
7308
7309
# File 'lib/intersight_client/api/equipment_api.rb', line 7306

def update_equipment_switch_card(moid, equipment_switch_card, opts = {})
  data, _status_code, _headers = update_equipment_switch_card_with_http_info(moid, equipment_switch_card, opts)
  data
end

#update_equipment_switch_card_with_http_info(moid, equipment_switch_card, opts = {}) ⇒ Array<(EquipmentSwitchCard, Integer, Hash)>

Update a &#39;equipment.SwitchCard&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_switch_card (EquipmentSwitchCard)

    The &#39;equipment.SwitchCard&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSwitchCard, Integer, Hash)>)

    EquipmentSwitchCard data, response status code and response headers



7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
# File 'lib/intersight_client/api/equipment_api.rb', line 7317

def update_equipment_switch_card_with_http_info(moid, equipment_switch_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_switch_card ...'
  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 EquipmentApi.update_equipment_switch_card"
  end
  # verify the required parameter 'equipment_switch_card' is set
  if @api_client.config.client_side_validation && equipment_switch_card.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_switch_card' when calling EquipmentApi.update_equipment_switch_card"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SwitchCards/{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(equipment_switch_card)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_switch_card",
    :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: EquipmentApi#update_equipment_switch_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_system_io_controller(moid, equipment_system_io_controller, opts = {}) ⇒ EquipmentSystemIoController

Update a ‘equipment.SystemIoController’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_system_io_controller (EquipmentSystemIoController)

    The &#39;equipment.SystemIoController&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7381
7382
7383
7384
# File 'lib/intersight_client/api/equipment_api.rb', line 7381

def update_equipment_system_io_controller(moid, equipment_system_io_controller, opts = {})
  data, _status_code, _headers = update_equipment_system_io_controller_with_http_info(moid, equipment_system_io_controller, opts)
  data
end

#update_equipment_system_io_controller_with_http_info(moid, equipment_system_io_controller, opts = {}) ⇒ Array<(EquipmentSystemIoController, Integer, Hash)>

Update a &#39;equipment.SystemIoController&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_system_io_controller (EquipmentSystemIoController)

    The &#39;equipment.SystemIoController&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentSystemIoController, Integer, Hash)>)

    EquipmentSystemIoController data, response status code and response headers



7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
# File 'lib/intersight_client/api/equipment_api.rb', line 7392

def update_equipment_system_io_controller_with_http_info(moid, equipment_system_io_controller, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_system_io_controller ...'
  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 EquipmentApi.update_equipment_system_io_controller"
  end
  # verify the required parameter 'equipment_system_io_controller' is set
  if @api_client.config.client_side_validation && equipment_system_io_controller.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_system_io_controller' when calling EquipmentApi.update_equipment_system_io_controller"
  end
  # resource path
  local_var_path = '/api/v1/equipment/SystemIoControllers/{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(equipment_system_io_controller)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_system_io_controller",
    :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: EquipmentApi#update_equipment_system_io_controller\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_tpm(moid, equipment_tpm, opts = {}) ⇒ EquipmentTpm

Update a ‘equipment.Tpm’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_tpm (EquipmentTpm)

    The &#39;equipment.Tpm&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7456
7457
7458
7459
# File 'lib/intersight_client/api/equipment_api.rb', line 7456

def update_equipment_tpm(moid, equipment_tpm, opts = {})
  data, _status_code, _headers = update_equipment_tpm_with_http_info(moid, equipment_tpm, opts)
  data
end

#update_equipment_tpm_with_http_info(moid, equipment_tpm, opts = {}) ⇒ Array<(EquipmentTpm, Integer, Hash)>

Update a &#39;equipment.Tpm&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_tpm (EquipmentTpm)

    The &#39;equipment.Tpm&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentTpm, Integer, Hash)>)

    EquipmentTpm data, response status code and response headers



7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
# File 'lib/intersight_client/api/equipment_api.rb', line 7467

def update_equipment_tpm_with_http_info(moid, equipment_tpm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_tpm ...'
  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 EquipmentApi.update_equipment_tpm"
  end
  # verify the required parameter 'equipment_tpm' is set
  if @api_client.config.client_side_validation && equipment_tpm.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_tpm' when calling EquipmentApi.update_equipment_tpm"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Tpms/{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(equipment_tpm)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_tpm",
    :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: EquipmentApi#update_equipment_tpm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_equipment_transceiver(moid, equipment_transceiver, opts = {}) ⇒ EquipmentTransceiver

Update a ‘equipment.Transceiver’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_transceiver (EquipmentTransceiver)

    The &#39;equipment.Transceiver&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:



7531
7532
7533
7534
# File 'lib/intersight_client/api/equipment_api.rb', line 7531

def update_equipment_transceiver(moid, equipment_transceiver, opts = {})
  data, _status_code, _headers = update_equipment_transceiver_with_http_info(moid, equipment_transceiver, opts)
  data
end

#update_equipment_transceiver_with_http_info(moid, equipment_transceiver, opts = {}) ⇒ Array<(EquipmentTransceiver, Integer, Hash)>

Update a &#39;equipment.Transceiver&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • equipment_transceiver (EquipmentTransceiver)

    The &#39;equipment.Transceiver&#39; resource to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

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.

Returns:

  • (Array<(EquipmentTransceiver, Integer, Hash)>)

    EquipmentTransceiver data, response status code and response headers



7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
# File 'lib/intersight_client/api/equipment_api.rb', line 7542

def update_equipment_transceiver_with_http_info(moid, equipment_transceiver, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EquipmentApi.update_equipment_transceiver ...'
  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 EquipmentApi.update_equipment_transceiver"
  end
  # verify the required parameter 'equipment_transceiver' is set
  if @api_client.config.client_side_validation && equipment_transceiver.nil?
    fail ArgumentError, "Missing the required parameter 'equipment_transceiver' when calling EquipmentApi.update_equipment_transceiver"
  end
  # resource path
  local_var_path = '/api/v1/equipment/Transceivers/{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(equipment_transceiver)

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

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

  new_options = opts.merge(
    :operation => :"EquipmentApi.update_equipment_transceiver",
    :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: EquipmentApi#update_equipment_transceiver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end