Class: IntersightClient::ConvergedinfraApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConvergedinfraApi

Returns a new instance of ConvergedinfraApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#create_convergedinfra_health_check_definition(convergedinfra_health_check_definition, opts = {}) ⇒ ConvergedinfraHealthCheckDefinition

Create a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • convergedinfra_health_check_definition (ConvergedinfraHealthCheckDefinition) —

    The 'convergedinfra.HealthCheckDefinition' resource to create.

  • 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.

  • :if_none_match (String) —

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

Returns:



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

def create_convergedinfra_health_check_definition(convergedinfra_health_check_definition, opts = {})
  data, _status_code, _headers = create_convergedinfra_health_check_definition_with_http_info(convergedinfra_health_check_definition, opts)
  data
end

#create_convergedinfra_health_check_definition_with_http_info(convergedinfra_health_check_definition, opts = {}) ⇒ Array<(ConvergedinfraHealthCheckDefinition, Integer, Hash)>

Create a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • convergedinfra_health_check_definition (ConvergedinfraHealthCheckDefinition) —

    The 'convergedinfra.HealthCheckDefinition' resource to create.

  • 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.

  • :if_none_match (String) —

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

Returns:



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

def create_convergedinfra_health_check_definition_with_http_info(convergedinfra_health_check_definition, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.create_convergedinfra_health_check_definition ...'
  end
  # verify the required parameter 'convergedinfra_health_check_definition' is set
  if @api_client.config.client_side_validation && convergedinfra_health_check_definition.nil?
    fail ArgumentError, "Missing the required parameter 'convergedinfra_health_check_definition' when calling ConvergedinfraApi.create_convergedinfra_health_check_definition"
  end
  # resource path
  local_var_path = '/api/v1/convergedinfra/HealthCheckDefinitions'

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

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

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

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

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

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

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

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

Delete a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

  • (nil) 


98
99
100
101
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 98

def delete_convergedinfra_health_check_definition(moid, opts = {})
  delete_convergedinfra_health_check_definition_with_http_info(moid, opts)
  nil
end

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

Delete a 'convergedinfra.HealthCheckDefinition' 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



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
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 107

def delete_convergedinfra_health_check_definition_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.delete_convergedinfra_health_check_definition ...'
  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 ConvergedinfraApi.delete_convergedinfra_health_check_definition"
  end
  # resource path
  local_var_path = '/api/v1/convergedinfra/HealthCheckDefinitions/{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 => :"ConvergedinfraApi.delete_convergedinfra_health_check_definition",
    :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: ConvergedinfraApi#delete_convergedinfra_health_check_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_convergedinfra_health_check_definition_by_moid(moid, opts = {}) ⇒ ConvergedinfraHealthCheckDefinition

Read a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 159

def get_convergedinfra_health_check_definition_by_moid(moid, opts = {})
  data, _status_code, _headers = get_convergedinfra_health_check_definition_by_moid_with_http_info(moid, opts)
  data
end

#get_convergedinfra_health_check_definition_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ConvergedinfraHealthCheckDefinition, Integer, Hash)>

Read a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



168
169
170
171
172
173
174
175
176
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
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 168

def get_convergedinfra_health_check_definition_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.get_convergedinfra_health_check_definition_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 ConvergedinfraApi.get_convergedinfra_health_check_definition_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/convergedinfra/HealthCheckDefinitions/{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] || 'ConvergedinfraHealthCheckDefinition'

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

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

#get_convergedinfra_health_check_definition_list(opts = {}) ⇒ ConvergedinfraHealthCheckDefinitionResponse

Read a 'convergedinfra.HealthCheckDefinition' 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 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' 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:



230
231
232
233
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 230

def get_convergedinfra_health_check_definition_list(opts = {})
  data, _status_code, _headers = get_convergedinfra_health_check_definition_list_with_http_info(opts)
  data
end

#get_convergedinfra_health_check_definition_list_with_http_info(opts = {}) ⇒ Array<(ConvergedinfraHealthCheckDefinitionResponse, Integer, Hash)>

Read a 'convergedinfra.HealthCheckDefinition' 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 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' 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:



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
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 249

def get_convergedinfra_health_check_definition_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.get_convergedinfra_health_check_definition_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/convergedinfra/HealthCheckDefinitions'

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

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

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

#get_convergedinfra_health_check_execution_by_moid(moid, opts = {}) ⇒ ConvergedinfraHealthCheckExecution

Read a 'convergedinfra.HealthCheckExecution' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



312
313
314
315
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 312

def get_convergedinfra_health_check_execution_by_moid(moid, opts = {})
  data, _status_code, _headers = get_convergedinfra_health_check_execution_by_moid_with_http_info(moid, opts)
  data
end

#get_convergedinfra_health_check_execution_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ConvergedinfraHealthCheckExecution, Integer, Hash)>

Read a 'convergedinfra.HealthCheckExecution' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



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

def get_convergedinfra_health_check_execution_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.get_convergedinfra_health_check_execution_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 ConvergedinfraApi.get_convergedinfra_health_check_execution_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/convergedinfra/HealthCheckExecutions/{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] || 'ConvergedinfraHealthCheckExecution'

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

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

#get_convergedinfra_health_check_execution_list(opts = {}) ⇒ ConvergedinfraHealthCheckExecutionResponse

Read a 'convergedinfra.HealthCheckExecution' 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 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' 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:



383
384
385
386
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 383

def get_convergedinfra_health_check_execution_list(opts = {})
  data, _status_code, _headers = get_convergedinfra_health_check_execution_list_with_http_info(opts)
  data
end

#get_convergedinfra_health_check_execution_list_with_http_info(opts = {}) ⇒ Array<(ConvergedinfraHealthCheckExecutionResponse, Integer, Hash)>

Read a 'convergedinfra.HealthCheckExecution' 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 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' 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:



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
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 402

def get_convergedinfra_health_check_execution_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.get_convergedinfra_health_check_execution_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/convergedinfra/HealthCheckExecutions'

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

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

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

#get_convergedinfra_pod_by_moid(moid, opts = {}) ⇒ ConvergedinfraPod

Read a 'convergedinfra.Pod' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:



465
466
467
468
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 465

def get_convergedinfra_pod_by_moid(moid, opts = {})
  data, _status_code, _headers = get_convergedinfra_pod_by_moid_with_http_info(moid, opts)
  data
end

#get_convergedinfra_pod_by_moid_with_http_info(moid, opts = {}) ⇒ Array<(ConvergedinfraPod, Integer, Hash)>

Read a 'convergedinfra.Pod' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

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

    the optional parameters

Returns:

  • (Array<(ConvergedinfraPod, Integer, Hash)>) —

    ConvergedinfraPod data, response status code and response headers



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

def get_convergedinfra_pod_by_moid_with_http_info(moid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.get_convergedinfra_pod_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 ConvergedinfraApi.get_convergedinfra_pod_by_moid"
  end
  # resource path
  local_var_path = '/api/v1/convergedinfra/Pods/{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] || 'ConvergedinfraPod'

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

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

#get_convergedinfra_pod_list(opts = {}) ⇒ ConvergedinfraPodResponse

Read a 'convergedinfra.Pod' 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 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' 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:



536
537
538
539
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 536

def get_convergedinfra_pod_list(opts = {})
  data, _status_code, _headers = get_convergedinfra_pod_list_with_http_info(opts)
  data
end

#get_convergedinfra_pod_list_with_http_info(opts = {}) ⇒ Array<(ConvergedinfraPodResponse, Integer, Hash)>

Read a 'convergedinfra.Pod' 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 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' 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<(ConvergedinfraPodResponse, Integer, Hash)>) —

    ConvergedinfraPodResponse 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
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 555

def get_convergedinfra_pod_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConvergedinfraApi.get_convergedinfra_pod_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/convergedinfra/Pods'

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

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

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

#patch_convergedinfra_health_check_definition(moid, convergedinfra_health_check_definition, opts = {}) ⇒ ConvergedinfraHealthCheckDefinition

Update a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_health_check_definition (ConvergedinfraHealthCheckDefinition) —

    The 'convergedinfra.HealthCheckDefinition' 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:



620
621
622
623
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 620

def patch_convergedinfra_health_check_definition(moid, convergedinfra_health_check_definition, opts = {})
  data, _status_code, _headers = patch_convergedinfra_health_check_definition_with_http_info(moid, convergedinfra_health_check_definition, opts)
  data
end

#patch_convergedinfra_health_check_definition_with_http_info(moid, convergedinfra_health_check_definition, opts = {}) ⇒ Array<(ConvergedinfraHealthCheckDefinition, Integer, Hash)>

Update a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_health_check_definition (ConvergedinfraHealthCheckDefinition) —

    The 'convergedinfra.HealthCheckDefinition' 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:



631
632
633
634
635
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
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 631

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

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

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

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

#patch_convergedinfra_pod(moid, convergedinfra_pod, opts = {}) ⇒ ConvergedinfraPod

Update a 'convergedinfra.Pod' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_pod (ConvergedinfraPod) —

    The 'convergedinfra.Pod' 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:



695
696
697
698
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 695

def patch_convergedinfra_pod(moid, convergedinfra_pod, opts = {})
  data, _status_code, _headers = patch_convergedinfra_pod_with_http_info(moid, convergedinfra_pod, opts)
  data
end

#patch_convergedinfra_pod_with_http_info(moid, convergedinfra_pod, opts = {}) ⇒ Array<(ConvergedinfraPod, Integer, Hash)>

Update a 'convergedinfra.Pod' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_pod (ConvergedinfraPod) —

    The 'convergedinfra.Pod' 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<(ConvergedinfraPod, Integer, Hash)>) —

    ConvergedinfraPod data, response status code and response headers



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

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

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

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

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

#update_convergedinfra_health_check_definition(moid, convergedinfra_health_check_definition, opts = {}) ⇒ ConvergedinfraHealthCheckDefinition

Update a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_health_check_definition (ConvergedinfraHealthCheckDefinition) —

    The 'convergedinfra.HealthCheckDefinition' 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:



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

def update_convergedinfra_health_check_definition(moid, convergedinfra_health_check_definition, opts = {})
  data, _status_code, _headers = update_convergedinfra_health_check_definition_with_http_info(moid, convergedinfra_health_check_definition, opts)
  data
end

#update_convergedinfra_health_check_definition_with_http_info(moid, convergedinfra_health_check_definition, opts = {}) ⇒ Array<(ConvergedinfraHealthCheckDefinition, Integer, Hash)>

Update a 'convergedinfra.HealthCheckDefinition' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_health_check_definition (ConvergedinfraHealthCheckDefinition) —

    The 'convergedinfra.HealthCheckDefinition' 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:



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

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

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

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

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

#update_convergedinfra_pod(moid, convergedinfra_pod, opts = {}) ⇒ ConvergedinfraPod

Update a 'convergedinfra.Pod' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_pod (ConvergedinfraPod) —

    The 'convergedinfra.Pod' 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:



845
846
847
848
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 845

def update_convergedinfra_pod(moid, convergedinfra_pod, opts = {})
  data, _status_code, _headers = update_convergedinfra_pod_with_http_info(moid, convergedinfra_pod, opts)
  data
end

#update_convergedinfra_pod_with_http_info(moid, convergedinfra_pod, opts = {}) ⇒ Array<(ConvergedinfraPod, Integer, Hash)>

Update a 'convergedinfra.Pod' resource.

Parameters:

  • moid (String) —

    The unique Moid identifier of a resource instance.

  • convergedinfra_pod (ConvergedinfraPod) —

    The 'convergedinfra.Pod' 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<(ConvergedinfraPod, Integer, Hash)>) —

    ConvergedinfraPod data, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/intersight_client/api/convergedinfra_api.rb', line 856

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

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

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

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