Class: IntersightClient::IaasApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IaasApi

Returns a new instance of IaasApi.



19
20
21
# File 'lib/intersight_client/api/iaas_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/iaas_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Delete a ‘iaas.UcsdInfo’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

  • (nil)


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

def delete_iaas_ucsd_info(moid, opts = {})
  delete_iaas_ucsd_info_with_http_info(moid, opts)
  nil
end

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

Delete a &#39;iaas.UcsdInfo&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    nil, 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/iaas_api.rb', line 35

def delete_iaas_ucsd_info_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.delete_iaas_ucsd_info ...'
  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 IaasApi.delete_iaas_ucsd_info"
  end
  # resource path
  local_var_path = '/api/v1/iaas/UcsdInfos/{Moid}'.sub('{' + 'Moid' + '}', CGI.escape(moid.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#get_iaas_connector_pack_by_moid(moid, opts = {}) ⇒ IaasConnectorPack

Read a ‘iaas.ConnectorPack’ 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/iaas_api.rb', line 87

def get_iaas_connector_pack_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_connector_pack_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_connector_pack_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasConnectorPack, Integer, Hash)>

Read a &#39;iaas.ConnectorPack&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasConnectorPack 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/iaas_api.rb', line 96

def get_iaas_connector_pack_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_connector_pack_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 IaasApi.get_iaas_connector_pack_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/ConnectorPacks/{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] || 'IaasConnectorPack'

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

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

#get_iaas_connector_pack_list(opts = {}) ⇒ IaasConnectorPackResponse

Read a ‘iaas.ConnectorPack’ 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/iaas_api.rb', line 158

def get_iaas_connector_pack_list(opts = {})
  data, _status_code, _headers = get_iaas_connector_pack_list_with_http_info(opts)
  data
end

#get_iaas_connector_pack_list_with_http_info(opts = {}) ⇒ Array<(IaasConnectorPackResponse, Integer, Hash)>

Read a &#39;iaas.ConnectorPack&#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<(IaasConnectorPackResponse, Integer, Hash)>)

    IaasConnectorPackResponse data, response status code and response headers



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/iaas_api.rb', line 177

def get_iaas_connector_pack_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_connector_pack_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/iaas/ConnectorPacks'

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

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

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

#get_iaas_device_status_by_moid(moid, opts = {}) ⇒ IaasDeviceStatus

Read a ‘iaas.DeviceStatus’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



240
241
242
243
# File 'lib/intersight_client/api/iaas_api.rb', line 240

def get_iaas_device_status_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_device_status_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_device_status_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasDeviceStatus, Integer, Hash)>

Read a &#39;iaas.DeviceStatus&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasDeviceStatus data, response status code and response headers



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/intersight_client/api/iaas_api.rb', line 249

def get_iaas_device_status_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_device_status_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 IaasApi.get_iaas_device_status_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/DeviceStatuses/{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] || 'IaasDeviceStatus'

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

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

#get_iaas_device_status_list(opts = {}) ⇒ IaasDeviceStatusResponse

Read a ‘iaas.DeviceStatus’ 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:



311
312
313
314
# File 'lib/intersight_client/api/iaas_api.rb', line 311

def get_iaas_device_status_list(opts = {})
  data, _status_code, _headers = get_iaas_device_status_list_with_http_info(opts)
  data
end

#get_iaas_device_status_list_with_http_info(opts = {}) ⇒ Array<(IaasDeviceStatusResponse, Integer, Hash)>

Read a &#39;iaas.DeviceStatus&#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<(IaasDeviceStatusResponse, Integer, Hash)>)

    IaasDeviceStatusResponse data, response status code and response headers



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/intersight_client/api/iaas_api.rb', line 330

def get_iaas_device_status_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_device_status_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/iaas/DeviceStatuses'

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

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

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

#get_iaas_diagnostic_messages_by_moid(moid, opts = {}) ⇒ IaasDiagnosticMessages

Read a ‘iaas.DiagnosticMessages’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



393
394
395
396
# File 'lib/intersight_client/api/iaas_api.rb', line 393

def get_iaas_diagnostic_messages_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_diagnostic_messages_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_diagnostic_messages_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasDiagnosticMessages, Integer, Hash)>

Read a &#39;iaas.DiagnosticMessages&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasDiagnosticMessages data, response status code and response headers



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/intersight_client/api/iaas_api.rb', line 402

def get_iaas_diagnostic_messages_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_diagnostic_messages_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 IaasApi.get_iaas_diagnostic_messages_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/DiagnosticMessages/{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] || 'IaasDiagnosticMessages'

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

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

#get_iaas_diagnostic_messages_list(opts = {}) ⇒ IaasDiagnosticMessagesResponse

Read a ‘iaas.DiagnosticMessages’ 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:



464
465
466
467
# File 'lib/intersight_client/api/iaas_api.rb', line 464

def get_iaas_diagnostic_messages_list(opts = {})
  data, _status_code, _headers = get_iaas_diagnostic_messages_list_with_http_info(opts)
  data
end

#get_iaas_diagnostic_messages_list_with_http_info(opts = {}) ⇒ Array<(IaasDiagnosticMessagesResponse, Integer, Hash)>

Read a &#39;iaas.DiagnosticMessages&#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:



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/intersight_client/api/iaas_api.rb', line 483

def get_iaas_diagnostic_messages_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_diagnostic_messages_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/iaas/DiagnosticMessages'

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

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

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

#get_iaas_license_info_by_moid(moid, opts = {}) ⇒ IaasLicenseInfo

Read a ‘iaas.LicenseInfo’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



546
547
548
549
# File 'lib/intersight_client/api/iaas_api.rb', line 546

def get_iaas_license_info_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_license_info_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_license_info_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasLicenseInfo, Integer, Hash)>

Read a &#39;iaas.LicenseInfo&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasLicenseInfo data, response status code and response headers



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
# File 'lib/intersight_client/api/iaas_api.rb', line 555

def get_iaas_license_info_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_license_info_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 IaasApi.get_iaas_license_info_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/LicenseInfos/{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] || 'IaasLicenseInfo'

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

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

#get_iaas_license_info_list(opts = {}) ⇒ IaasLicenseInfoResponse

Read a ‘iaas.LicenseInfo’ 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:



617
618
619
620
# File 'lib/intersight_client/api/iaas_api.rb', line 617

def get_iaas_license_info_list(opts = {})
  data, _status_code, _headers = get_iaas_license_info_list_with_http_info(opts)
  data
end

#get_iaas_license_info_list_with_http_info(opts = {}) ⇒ Array<(IaasLicenseInfoResponse, Integer, Hash)>

Read a &#39;iaas.LicenseInfo&#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<(IaasLicenseInfoResponse, Integer, Hash)>)

    IaasLicenseInfoResponse data, response status code and response headers



636
637
638
639
640
641
642
643
644
645
646
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/iaas_api.rb', line 636

def get_iaas_license_info_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_license_info_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/iaas/LicenseInfos'

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

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

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

#get_iaas_most_run_tasks_by_moid(moid, opts = {}) ⇒ IaasMostRunTasks

Read a ‘iaas.MostRunTasks’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



699
700
701
702
# File 'lib/intersight_client/api/iaas_api.rb', line 699

def get_iaas_most_run_tasks_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_most_run_tasks_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_most_run_tasks_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasMostRunTasks, Integer, Hash)>

Read a &#39;iaas.MostRunTasks&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasMostRunTasks data, response status code and response headers



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
# File 'lib/intersight_client/api/iaas_api.rb', line 708

def get_iaas_most_run_tasks_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_most_run_tasks_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 IaasApi.get_iaas_most_run_tasks_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/MostRunTasks/{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] || 'IaasMostRunTasks'

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

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

#get_iaas_most_run_tasks_list(opts = {}) ⇒ IaasMostRunTasksResponse

Read a ‘iaas.MostRunTasks’ 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:



770
771
772
773
# File 'lib/intersight_client/api/iaas_api.rb', line 770

def get_iaas_most_run_tasks_list(opts = {})
  data, _status_code, _headers = get_iaas_most_run_tasks_list_with_http_info(opts)
  data
end

#get_iaas_most_run_tasks_list_with_http_info(opts = {}) ⇒ Array<(IaasMostRunTasksResponse, Integer, Hash)>

Read a &#39;iaas.MostRunTasks&#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<(IaasMostRunTasksResponse, Integer, Hash)>)

    IaasMostRunTasksResponse data, response status code and response headers



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/intersight_client/api/iaas_api.rb', line 789

def get_iaas_most_run_tasks_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_most_run_tasks_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/iaas/MostRunTasks'

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

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

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

#get_iaas_service_request_by_moid(moid, opts = {}) ⇒ IaasServiceRequest

Read a ‘iaas.ServiceRequest’ 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/iaas_api.rb', line 852

def get_iaas_service_request_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_service_request_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_service_request_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasServiceRequest, Integer, Hash)>

Read a &#39;iaas.ServiceRequest&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasServiceRequest 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/iaas_api.rb', line 861

def get_iaas_service_request_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_service_request_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 IaasApi.get_iaas_service_request_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/ServiceRequests/{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] || 'IaasServiceRequest'

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

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

#get_iaas_service_request_list(opts = {}) ⇒ IaasServiceRequestResponse

Read a ‘iaas.ServiceRequest’ 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/iaas_api.rb', line 923

def get_iaas_service_request_list(opts = {})
  data, _status_code, _headers = get_iaas_service_request_list_with_http_info(opts)
  data
end

#get_iaas_service_request_list_with_http_info(opts = {}) ⇒ Array<(IaasServiceRequestResponse, Integer, Hash)>

Read a &#39;iaas.ServiceRequest&#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<(IaasServiceRequestResponse, Integer, Hash)>)

    IaasServiceRequestResponse 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/iaas_api.rb', line 942

def get_iaas_service_request_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_service_request_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/iaas/ServiceRequests'

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

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

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

#get_iaas_ucsd_info_by_moid(moid, opts = {}) ⇒ IaasUcsdInfo

Read a ‘iaas.UcsdInfo’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



1005
1006
1007
1008
# File 'lib/intersight_client/api/iaas_api.rb', line 1005

def get_iaas_ucsd_info_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_ucsd_info_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_ucsd_info_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasUcsdInfo, Integer, Hash)>

Read a &#39;iaas.UcsdInfo&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasUcsdInfo data, response status code and response headers



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
# File 'lib/intersight_client/api/iaas_api.rb', line 1014

def get_iaas_ucsd_info_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_ucsd_info_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 IaasApi.get_iaas_ucsd_info_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/UcsdInfos/{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] || 'IaasUcsdInfo'

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

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

#get_iaas_ucsd_info_list(opts = {}) ⇒ IaasUcsdInfoResponse

Read a ‘iaas.UcsdInfo’ 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:



1076
1077
1078
1079
# File 'lib/intersight_client/api/iaas_api.rb', line 1076

def get_iaas_ucsd_info_list(opts = {})
  data, _status_code, _headers = get_iaas_ucsd_info_list_with_http_info(opts)
  data
end

#get_iaas_ucsd_info_list_with_http_info(opts = {}) ⇒ Array<(IaasUcsdInfoResponse, Integer, Hash)>

Read a &#39;iaas.UcsdInfo&#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<(IaasUcsdInfoResponse, Integer, Hash)>)

    IaasUcsdInfoResponse data, response status code and response headers



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
# File 'lib/intersight_client/api/iaas_api.rb', line 1095

def get_iaas_ucsd_info_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_ucsd_info_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/iaas/UcsdInfos'

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

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

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

#get_iaas_ucsd_managed_infra_by_moid(moid, opts = {}) ⇒ IaasUcsdManagedInfra

Read a ‘iaas.UcsdManagedInfra’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



1158
1159
1160
1161
# File 'lib/intersight_client/api/iaas_api.rb', line 1158

def get_iaas_ucsd_managed_infra_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_ucsd_managed_infra_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_ucsd_managed_infra_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasUcsdManagedInfra, Integer, Hash)>

Read a &#39;iaas.UcsdManagedInfra&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasUcsdManagedInfra data, response status code and response headers



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

def get_iaas_ucsd_managed_infra_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_ucsd_managed_infra_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 IaasApi.get_iaas_ucsd_managed_infra_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/UcsdManagedInfras/{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] || 'IaasUcsdManagedInfra'

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

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

#get_iaas_ucsd_managed_infra_list(opts = {}) ⇒ IaasUcsdManagedInfraResponse

Read a ‘iaas.UcsdManagedInfra’ 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:



1229
1230
1231
1232
# File 'lib/intersight_client/api/iaas_api.rb', line 1229

def get_iaas_ucsd_managed_infra_list(opts = {})
  data, _status_code, _headers = get_iaas_ucsd_managed_infra_list_with_http_info(opts)
  data
end

#get_iaas_ucsd_managed_infra_list_with_http_info(opts = {}) ⇒ Array<(IaasUcsdManagedInfraResponse, Integer, Hash)>

Read a &#39;iaas.UcsdManagedInfra&#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:



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
# File 'lib/intersight_client/api/iaas_api.rb', line 1248

def get_iaas_ucsd_managed_infra_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_ucsd_managed_infra_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/iaas/UcsdManagedInfras'

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

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

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

#get_iaas_ucsd_messages_by_moid(moid, opts = {}) ⇒ IaasUcsdMessages

Read a ‘iaas.UcsdMessages’ 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/iaas_api.rb', line 1311

def get_iaas_ucsd_messages_by_moid(moid, opts = {})
  data, _status_code, _headers = get_iaas_ucsd_messages_by_moid_with_http_info(moid, opts)
  data
end

#get_iaas_ucsd_messages_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(IaasUcsdMessages, Integer, Hash)>

Read a &#39;iaas.UcsdMessages&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

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

    IaasUcsdMessages 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/iaas_api.rb', line 1320

def get_iaas_ucsd_messages_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_ucsd_messages_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 IaasApi.get_iaas_ucsd_messages_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/iaas/UcsdMessages/{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] || 'IaasUcsdMessages'

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

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

#get_iaas_ucsd_messages_list(opts = {}) ⇒ IaasUcsdMessagesResponse

Read a ‘iaas.UcsdMessages’ 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/iaas_api.rb', line 1382

def get_iaas_ucsd_messages_list(opts = {})
  data, _status_code, _headers = get_iaas_ucsd_messages_list_with_http_info(opts)
  data
end

#get_iaas_ucsd_messages_list_with_http_info(opts = {}) ⇒ Array<(IaasUcsdMessagesResponse, Integer, Hash)>

Read a &#39;iaas.UcsdMessages&#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<(IaasUcsdMessagesResponse, Integer, Hash)>)

    IaasUcsdMessagesResponse data, response status code and response headers



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/iaas_api.rb', line 1401

def get_iaas_ucsd_messages_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IaasApi.get_iaas_ucsd_messages_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/iaas/UcsdMessages'

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

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

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

#patch_iaas_ucsd_info(moid, iaas_ucsd_info, opts = {}) ⇒ IaasUcsdInfo

Update a ‘iaas.UcsdInfo’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • iaas_ucsd_info (IaasUcsdInfo)

    The &#39;iaas.UcsdInfo&#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:



1466
1467
1468
1469
# File 'lib/intersight_client/api/iaas_api.rb', line 1466

def patch_iaas_ucsd_info(moid, iaas_ucsd_info, opts = {})
  data, _status_code, _headers = patch_iaas_ucsd_info_with_http_info(moid, iaas_ucsd_info, opts)
  data
end

#patch_iaas_ucsd_info_with_http_info(moid, iaas_ucsd_info, opts = {}) ⇒ Array<(IaasUcsdInfo, Integer, Hash)>

Update a &#39;iaas.UcsdInfo&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • iaas_ucsd_info (IaasUcsdInfo)

    The &#39;iaas.UcsdInfo&#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<(IaasUcsdInfo, Integer, Hash)>)

    IaasUcsdInfo data, response status code and response headers



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
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
# File 'lib/intersight_client/api/iaas_api.rb', line 1477

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

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

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

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

#update_iaas_ucsd_info(moid, iaas_ucsd_info, opts = {}) ⇒ IaasUcsdInfo

Update a ‘iaas.UcsdInfo’ resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • iaas_ucsd_info (IaasUcsdInfo)

    The &#39;iaas.UcsdInfo&#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:



1541
1542
1543
1544
# File 'lib/intersight_client/api/iaas_api.rb', line 1541

def update_iaas_ucsd_info(moid, iaas_ucsd_info, opts = {})
  data, _status_code, _headers = update_iaas_ucsd_info_with_http_info(moid, iaas_ucsd_info, opts)
  data
end

#update_iaas_ucsd_info_with_http_info(moid, iaas_ucsd_info, opts = {}) ⇒ Array<(IaasUcsdInfo, Integer, Hash)>

Update a &#39;iaas.UcsdInfo&#39; resource.

Parameters:

  • moid (String)

    The unique Moid identifier of a resource instance.

  • iaas_ucsd_info (IaasUcsdInfo)

    The &#39;iaas.UcsdInfo&#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<(IaasUcsdInfo, Integer, Hash)>)

    IaasUcsdInfo data, response status code and response headers



1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
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
# File 'lib/intersight_client/api/iaas_api.rb', line 1552

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

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

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

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