Class: NutanixVolumes::VolumeGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nutanix_volumes/api/volume_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VolumeGroupsApi

Returns a new instance of VolumeGroupsApi.



19
20
21
 
# File 'lib/nutanix_volumes/api/volume_groups_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/nutanix_volumes/api/volume_groups_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#associate_category(ext_id, volumes_v40_config_category_entity_references, opts = {}) ⇒ AssociateCategory202Response

Associate category to a Volume Group Associates a category to a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • volumes_v40_config_category_entity_references (VolumesV40ConfigCategoryEntityReferences) —

    The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 28

def associate_category(ext_id, volumes_v40_config_category_entity_references, opts = {})
  data, _status_code, _headers = associate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references, opts)
  data
end

#associate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references, opts = {}) ⇒ Array<(AssociateCategory202Response, Integer, Hash)>

Associate category to a Volume Group Associates a category to a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • volumes_v40_config_category_entity_references (VolumesV40ConfigCategoryEntityReferences) —

    The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field.

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

    the optional parameters

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
93
94
95
96
97
98
99
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 39

def associate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.associate_category ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.associate_category"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.associate_category, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'volumes_v40_config_category_entity_references' is set
  if @api_client.config.client_side_validation && volumes_v40_config_category_entity_references.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_category_entity_references' when calling VolumeGroupsApi.associate_category"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/associate-category'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#attach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client, opts = {}) ⇒ AttachIscsiClient202Response

Attach an iSCSI client to the given Volume Group Attaches iSCSI initiator to a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_iscsi_client (VolumesV40ConfigIscsiClient) —

    A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment.

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

    the optional parameters

Returns:



108
109
110
111
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 108

def attach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client, opts = {})
  data, _status_code, _headers = attach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client, opts)
  data
end

#attach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client, opts = {}) ⇒ Array<(AttachIscsiClient202Response, Integer, Hash)>

Attach an iSCSI client to the given Volume Group Attaches iSCSI initiator to a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_iscsi_client (VolumesV40ConfigIscsiClient) —

    A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment.

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

    the optional parameters

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 120

def attach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.attach_iscsi_client ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.attach_iscsi_client"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.attach_iscsi_client, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.attach_iscsi_client"
  end
  # verify the required parameter 'volumes_v40_config_iscsi_client' is set
  if @api_client.config.client_side_validation && volumes_v40_config_iscsi_client.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_iscsi_client' when calling VolumeGroupsApi.attach_iscsi_client"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/attach-iscsi-client'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#attach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {}) ⇒ AttachVm202Response

Attach an AHV VM to the given Volume Group Attaches VM to a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_vm_attachment (VolumesV40ConfigVmAttachment) —

    A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment.

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

    the optional parameters

Returns:



194
195
196
197
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 194

def attach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {})
  data, _status_code, _headers = attach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts)
  data
end

#attach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {}) ⇒ Array<(AttachVm202Response, Integer, Hash)>

Attach an AHV VM to the given Volume Group Attaches VM to a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_vm_attachment (VolumesV40ConfigVmAttachment) —

    A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment.

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

    the optional parameters

Returns:

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

    AttachVm202Response data, response status code and response headers



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 206

def attach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.attach_vm ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.attach_vm"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.attach_vm, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.attach_vm"
  end
  # verify the required parameter 'volumes_v40_config_vm_attachment' is set
  if @api_client.config.client_side_validation && volumes_v40_config_vm_attachment.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_vm_attachment' when calling VolumeGroupsApi.attach_vm"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/attach-vm'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#create_volume_disk(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk, opts = {}) ⇒ CreateVolumeDisk202Response

Creates a new Volume Disk Creates a new Volume Disk.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_disk (VolumesV40ConfigVolumeDisk) —

    A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF.

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

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 280

def create_volume_disk(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk, opts = {})
  data, _status_code, _headers = create_volume_disk_with_http_info(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk, opts)
  data
end

#create_volume_disk_with_http_info(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk, opts = {}) ⇒ Array<(CreateVolumeDisk202Response, Integer, Hash)>

Creates a new Volume Disk Creates a new Volume Disk.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_disk (VolumesV40ConfigVolumeDisk) —

    A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF.

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

    the optional parameters

Returns:

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

    CreateVolumeDisk202Response data, response status code and response headers



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
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
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 292

def create_volume_disk_with_http_info(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.create_volume_disk ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.create_volume_disk"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.create_volume_disk, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.create_volume_disk"
  end
  # verify the required parameter 'volumes_v40_config_volume_disk' is set
  if @api_client.config.client_side_validation && volumes_v40_config_volume_disk.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_volume_disk' when calling VolumeGroupsApi.create_volume_disk"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#create_volume_group(ntnx_request_id, volumes_v40_config_volume_group, opts = {}) ⇒ CreateVolumeGroup202Response

Creates a new Volume Group Creates a new Volume Group.

Parameters:

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_group (VolumesV40ConfigVolumeGroup) —

    A model that represents a Volume Group resource.

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

    the optional parameters

Returns:



365
366
367
368
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 365

def create_volume_group(ntnx_request_id, volumes_v40_config_volume_group, opts = {})
  data, _status_code, _headers = create_volume_group_with_http_info(ntnx_request_id, volumes_v40_config_volume_group, opts)
  data
end

#create_volume_group_with_http_info(ntnx_request_id, volumes_v40_config_volume_group, opts = {}) ⇒ Array<(CreateVolumeGroup202Response, Integer, Hash)>

Creates a new Volume Group Creates a new Volume Group.

Parameters:

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_group (VolumesV40ConfigVolumeGroup) —

    A model that represents a Volume Group resource.

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

    the optional parameters

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 376

def create_volume_group_with_http_info(ntnx_request_id, volumes_v40_config_volume_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.create_volume_group ...'
  end
  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.create_volume_group"
  end
  # verify the required parameter 'volumes_v40_config_volume_group' is set
  if @api_client.config.client_side_validation && volumes_v40_config_volume_group.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_volume_group' when calling VolumeGroupsApi.create_volume_group"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups'

  # 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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#delete_volume_disk_by_id(volume_group_ext_id, ext_id, ntnx_request_id, opts = {}) ⇒ DeleteVolumeDiskById202Response

Delete a Volume Disk Deletes a Volume Disk identified by extId in the Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

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

    the optional parameters

Returns:



441
442
443
444
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 441

def delete_volume_disk_by_id(volume_group_ext_id, ext_id, ntnx_request_id, opts = {})
  data, _status_code, _headers = delete_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, ntnx_request_id, opts)
  data
end

#delete_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, ntnx_request_id, opts = {}) ⇒ Array<(DeleteVolumeDiskById202Response, Integer, Hash)>

Delete a Volume Disk Deletes a Volume Disk identified by extId in the Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

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

    the optional parameters

Returns:



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
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
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 453

def delete_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, ntnx_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.delete_volume_disk_by_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.delete_volume_disk_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.delete_volume_disk_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.delete_volume_disk_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.delete_volume_disk_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.delete_volume_disk_by_id"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks/{extId}'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s)).sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  header_params[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#delete_volume_group_by_id(ext_id, ntnx_request_id, opts = {}) ⇒ DeleteVolumeGroupById202Response

Delete the Volume Group Delete the Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

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

    the optional parameters

Returns:



526
527
528
529
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 526

def delete_volume_group_by_id(ext_id, ntnx_request_id, opts = {})
  data, _status_code, _headers = delete_volume_group_by_id_with_http_info(ext_id, ntnx_request_id, opts)
  data
end

#delete_volume_group_by_id_with_http_info(ext_id, ntnx_request_id, opts = {}) ⇒ Array<(DeleteVolumeGroupById202Response, Integer, Hash)>

Delete the Volume Group Delete the Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

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

    the optional parameters

Returns:



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

def delete_volume_group_by_id_with_http_info(ext_id, ntnx_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.delete_volume_group_by_id ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.delete_volume_group_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.delete_volume_group_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.delete_volume_group_by_id"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  header_params[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#detach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment, opts = {}) ⇒ DetachIscsiClient202Response

Detach an iSCSi client from the given Volume Group Detaches iSCSI initiator identified by extId from a Volume Group identified by volumeGroupExtId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_iscsi_client_attachment (VolumesV40ConfigIscsiClientAttachment) —

    A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment. It contains the minimal properties required for the attachment.

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

    the optional parameters

Returns:



602
603
604
605
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 602

def detach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment, opts = {})
  data, _status_code, _headers = detach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment, opts)
  data
end

#detach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment, opts = {}) ⇒ Array<(DetachIscsiClient202Response, Integer, Hash)>

Detach an iSCSi client from the given Volume Group Detaches iSCSI initiator identified by extId from a Volume Group identified by volumeGroupExtId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_iscsi_client_attachment (VolumesV40ConfigIscsiClientAttachment) —

    A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment. It contains the minimal properties required for the attachment.

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

    the optional parameters

Returns:



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 614

def detach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.detach_iscsi_client ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.detach_iscsi_client"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.detach_iscsi_client, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.detach_iscsi_client"
  end
  # verify the required parameter 'volumes_v40_config_iscsi_client_attachment' is set
  if @api_client.config.client_side_validation && volumes_v40_config_iscsi_client_attachment.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_iscsi_client_attachment' when calling VolumeGroupsApi.detach_iscsi_client"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/detach-iscsi-client'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#detach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {}) ⇒ DetachVm202Response

Detach an AHV VM from the given Volume Group Detaches VM identified by extId from a Volume Group identified by volumeGroupExtId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_vm_attachment (VolumesV40ConfigVmAttachment) —

    A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment.

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

    the optional parameters

Returns:



688
689
690
691
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 688

def detach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {})
  data, _status_code, _headers = detach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts)
  data
end

#detach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {}) ⇒ Array<(DetachVm202Response, Integer, Hash)>

Detach an AHV VM from the given Volume Group Detaches VM identified by extId from a Volume Group identified by volumeGroupExtId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_vm_attachment (VolumesV40ConfigVmAttachment) —

    A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment.

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

    the optional parameters

Returns:

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

    DetachVm202Response data, response status code and response headers



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

def detach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.detach_vm ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.detach_vm"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.detach_vm, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.detach_vm"
  end
  # verify the required parameter 'volumes_v40_config_vm_attachment' is set
  if @api_client.config.client_side_validation && volumes_v40_config_vm_attachment.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_vm_attachment' when calling VolumeGroupsApi.detach_vm"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/detach-vm'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#disassociate_category(ext_id, volumes_v40_config_category_entity_references, opts = {}) ⇒ DisassociateCategory202Response

Disassociate category from a Volume Group Disassociates a category from a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • volumes_v40_config_category_entity_references (VolumesV40ConfigCategoryEntityReferences) —

    The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field.

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

    the optional parameters

Returns:



773
774
775
776
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 773

def disassociate_category(ext_id, volumes_v40_config_category_entity_references, opts = {})
  data, _status_code, _headers = disassociate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references, opts)
  data
end

#disassociate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references, opts = {}) ⇒ Array<(DisassociateCategory202Response, Integer, Hash)>

Disassociate category from a Volume Group Disassociates a category from a Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • volumes_v40_config_category_entity_references (VolumesV40ConfigCategoryEntityReferences) —

    The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field.

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

    the optional parameters

Returns:



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
838
839
840
841
842
843
844
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 784

def disassociate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.disassociate_category ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.disassociate_category"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.disassociate_category, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'volumes_v40_config_category_entity_references' is set
  if @api_client.config.client_side_validation && volumes_v40_config_category_entity_references.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_category_entity_references' when calling VolumeGroupsApi.disassociate_category"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/disassociate-category'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#get_volume_disk_by_id(volume_group_ext_id, ext_id, opts = {}) ⇒ GetVolumeDiskById200Response

Get the details of a Volume Disk Query the Volume Disk identified by extId in the Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

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

    the optional parameters

Returns:



852
853
854
855
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 852

def get_volume_disk_by_id(volume_group_ext_id, ext_id, opts = {})
  data, _status_code, _headers = get_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, opts)
  data
end

#get_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, opts = {}) ⇒ Array<(GetVolumeDiskById200Response, Integer, Hash)>

Get the details of a Volume Disk Query the Volume Disk identified by extId in the Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

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

    the optional parameters

Returns:



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
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 863

def get_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.get_volume_disk_by_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.get_volume_disk_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.get_volume_disk_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.get_volume_disk_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.get_volume_disk_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks/{extId}'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s)).sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#get_volume_disk_stats(volume_group_ext_id, ext_id, start_time, end_time, opts = {}) ⇒ GetVolumeDiskStats200Response

Get statistics for a Volume Disk Query the Volume Disk stats identified by diskExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

  • start_time (Time) —

    The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

  • end_time (Time) —

    The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

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

    the optional parameters

Options Hash (opts):

  • :sampling_interval (Integer) —

    The sampling interval in seconds at which statistical data should be collected. For example, if you want performance statistics every 30 seconds, then provide the value as 30.

  • :stat_type (CommonV10StatsDownSamplingOperator)
  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - controllerAvgIOLatencyUsecs - controllerAvgReadIOLatencyUsecs - controllerAvgWriteIOLatencyUsecs - controllerIOBandwidthKBps - controllerNumIOPS - controllerNumReadIOPS - controllerNumWriteIOPS - controllerReadIOBandwidthKBps - controllerUserBytes - controllerWriteIOBandwidthKBps

Returns:



936
937
938
939
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 936

def get_volume_disk_stats(volume_group_ext_id, ext_id, start_time, end_time, opts = {})
  data, _status_code, _headers = get_volume_disk_stats_with_http_info(volume_group_ext_id, ext_id, start_time, end_time, opts)
  data
end

#get_volume_disk_stats_with_http_info(volume_group_ext_id, ext_id, start_time, end_time, opts = {}) ⇒ Array<(GetVolumeDiskStats200Response, Integer, Hash)>

Get statistics for a Volume Disk Query the Volume Disk stats identified by diskExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

  • start_time (Time) —

    The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

  • end_time (Time) —

    The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

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

    the optional parameters

Options Hash (opts):

  • :sampling_interval (Integer) —

    The sampling interval in seconds at which statistical data should be collected. For example, if you want performance statistics every 30 seconds, then provide the value as 30.

  • :stat_type (CommonV10StatsDownSamplingOperator)
  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - controllerAvgIOLatencyUsecs - controllerAvgReadIOLatencyUsecs - controllerAvgWriteIOLatencyUsecs - controllerIOBandwidthKBps - controllerNumIOPS - controllerNumReadIOPS - controllerNumWriteIOPS - controllerReadIOBandwidthKBps - controllerUserBytes - controllerWriteIOBandwidthKBps

Returns:



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
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 952

def get_volume_disk_stats_with_http_info(volume_group_ext_id, ext_id, start_time, end_time, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.get_volume_disk_stats ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.get_volume_disk_stats"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.get_volume_disk_stats, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.get_volume_disk_stats"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.get_volume_disk_stats, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'start_time' is set
  if @api_client.config.client_side_validation && start_time.nil?
    fail ArgumentError, "Missing the required parameter 'start_time' when calling VolumeGroupsApi.get_volume_disk_stats"
  end
  # verify the required parameter 'end_time' is set
  if @api_client.config.client_side_validation && end_time.nil?
    fail ArgumentError, "Missing the required parameter 'end_time' when calling VolumeGroupsApi.get_volume_disk_stats"
  end
  if @api_client.config.client_side_validation && !opts[:'sampling_interval'].nil? && opts[:'sampling_interval'] < 1
    fail ArgumentError, 'invalid value for "opts[:"sampling_interval"]" when calling VolumeGroupsApi.get_volume_disk_stats, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/stats/volume-groups/{volumeGroupExtId}/disks/{extId}'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s)).sub('{' + 'extId' + '}', CGI.escape(ext_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$startTime'] = start_time
  query_params[:'$endTime'] = end_time
  query_params[:'$samplingInterval'] = opts[:'sampling_interval'] if !opts[:'sampling_interval'].nil?
  query_params[:'$statType'] = opts[:'stat_type'] if !opts[:'stat_type'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#get_volume_group_by_id(ext_id, opts = {}) ⇒ GetVolumeGroupById200Response

Get a Volume Group Query the Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Returns:



1036
1037
1038
1039
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1036

def get_volume_group_by_id(ext_id, opts = {})
  data, _status_code, _headers = get_volume_group_by_id_with_http_info(ext_id, opts)
  data
end

#get_volume_group_by_id_with_http_info(ext_id, opts = {}) ⇒ Array<(GetVolumeGroupById200Response, Integer, Hash)>

Get a Volume Group Query the Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1046

def get_volume_group_by_id_with_http_info(ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.get_volume_group_by_id ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.get_volume_group_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.get_volume_group_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#get_volume_group_metadata_by_id(volume_group_ext_id, opts = {}) ⇒ GetVolumeGroupMetadataById200Response

Fetch metadata information associated with a Volume Group. Query for metadata information which is associated with the Volume Group identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Returns:



1104
1105
1106
1107
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1104

def get_volume_group_metadata_by_id(volume_group_ext_id, opts = {})
  data, _status_code, _headers = get_volume_group_metadata_by_id_with_http_info(volume_group_ext_id, opts)
  data
end

#get_volume_group_metadata_by_id_with_http_info(volume_group_ext_id, opts = {}) ⇒ Array<(GetVolumeGroupMetadataById200Response, Integer, Hash)>

Fetch metadata information associated with a Volume Group. Query for metadata information which is associated with the Volume Group identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Returns:



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
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1114

def get_volume_group_metadata_by_id_with_http_info(volume_group_ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.get_volume_group_metadata_by_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.get_volume_group_metadata_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.get_volume_group_metadata_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/metadata'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#get_volume_group_stats(ext_id, start_time, end_time, opts = {}) ⇒ GetVolumeGroupStats200Response

Get statistics for a Volume Group Query the Volume Group stats identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • start_time (Time) —

    The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

  • end_time (Time) —

    The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

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

    the optional parameters

Options Hash (opts):

  • :sampling_interval (Integer) —

    The sampling interval in seconds at which statistical data should be collected. For example, if you want performance statistics every 30 seconds, then provide the value as 30.

  • :stat_type (CommonV10StatsDownSamplingOperator)
  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - controllerAvgIOLatencyUsecs - controllerAvgReadIOLatencyUsecs - controllerAvgWriteIOLatencyUsecs - controllerIOBandwidthKBps - controllerNumIOPS - controllerNumReadIOPS - controllerNumWriteIOPS - controllerReadIOBandwidthKBps - controllerUserBytes - controllerWriteIOBandwidthKBps

Returns:



1177
1178
1179
1180
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1177

def get_volume_group_stats(ext_id, start_time, end_time, opts = {})
  data, _status_code, _headers = get_volume_group_stats_with_http_info(ext_id, start_time, end_time, opts)
  data
end

#get_volume_group_stats_with_http_info(ext_id, start_time, end_time, opts = {}) ⇒ Array<(GetVolumeGroupStats200Response, Integer, Hash)>

Get statistics for a Volume Group Query the Volume Group stats identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • start_time (Time) —

    The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

  • end_time (Time) —

    The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at www.iso.org/standard/70907.html

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

    the optional parameters

Options Hash (opts):

  • :sampling_interval (Integer) —

    The sampling interval in seconds at which statistical data should be collected. For example, if you want performance statistics every 30 seconds, then provide the value as 30.

  • :stat_type (CommonV10StatsDownSamplingOperator)
  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - controllerAvgIOLatencyUsecs - controllerAvgReadIOLatencyUsecs - controllerAvgWriteIOLatencyUsecs - controllerIOBandwidthKBps - controllerNumIOPS - controllerNumReadIOPS - controllerNumWriteIOPS - controllerReadIOBandwidthKBps - controllerUserBytes - controllerWriteIOBandwidthKBps

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1192

def get_volume_group_stats_with_http_info(ext_id, start_time, end_time, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.get_volume_group_stats ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.get_volume_group_stats"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.get_volume_group_stats, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'start_time' is set
  if @api_client.config.client_side_validation && start_time.nil?
    fail ArgumentError, "Missing the required parameter 'start_time' when calling VolumeGroupsApi.get_volume_group_stats"
  end
  # verify the required parameter 'end_time' is set
  if @api_client.config.client_side_validation && end_time.nil?
    fail ArgumentError, "Missing the required parameter 'end_time' when calling VolumeGroupsApi.get_volume_group_stats"
  end
  if @api_client.config.client_side_validation && !opts[:'sampling_interval'].nil? && opts[:'sampling_interval'] < 1
    fail ArgumentError, 'invalid value for "opts[:"sampling_interval"]" when calling VolumeGroupsApi.get_volume_group_stats, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/stats/volume-groups/{extId}'.sub('{' + 'extId' + '}', CGI.escape(ext_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$startTime'] = start_time
  query_params[:'$endTime'] = end_time
  query_params[:'$samplingInterval'] = opts[:'sampling_interval'] if !opts[:'sampling_interval'].nil?
  query_params[:'$statType'] = opts[:'stat_type'] if !opts[:'stat_type'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#list_category_associations_by_volume_group_id(volume_group_ext_id, opts = {}) ⇒ ListCategoryAssociationsByVolumeGroupId200Response

List all the category details that are associated with the Volume Group Query the category details that are associated with the Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

Returns:



1269
1270
1271
1272
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1269

def list_category_associations_by_volume_group_id(volume_group_ext_id, opts = {})
  data, _status_code, _headers = list_category_associations_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
  data
end

#list_category_associations_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {}) ⇒ Array<(ListCategoryAssociationsByVolumeGroupId200Response, Integer, Hash)>

List all the category details that are associated with the Volume Group Query the category details that are associated with the Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

Returns:



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
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
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
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1281

def list_category_associations_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.list_category_associations_by_volume_group_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.list_category_associations_by_volume_group_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.list_category_associations_by_volume_group_id, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VolumeGroupsApi.list_category_associations_by_volume_group_id, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_category_associations_by_volume_group_id, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_category_associations_by_volume_group_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/category-associations'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'$limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#list_external_iscsi_attachments_by_volume_group_id(volume_group_ext_id, opts = {}) ⇒ ListExternalIscsiAttachmentsByVolumeGroupId200Response

List all the iSCSI attachments associated with the given Volume Group Query the list of external iSCSI attachments for a Volume Group identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - clusterReference - extId

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - clusterReference - extId

  • :expand (String) —

    A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported. - iscsiClient

  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - clusterReference - extId

Returns:



1359
1360
1361
1362
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1359

def list_external_iscsi_attachments_by_volume_group_id(volume_group_ext_id, opts = {})
  data, _status_code, _headers = list_external_iscsi_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
  data
end

#list_external_iscsi_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {}) ⇒ Array<(ListExternalIscsiAttachmentsByVolumeGroupId200Response, Integer, Hash)>

List all the iSCSI attachments associated with the given Volume Group Query the list of external iSCSI attachments for a Volume Group identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - clusterReference - extId

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - clusterReference - extId

  • :expand (String) —

    A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported. - iscsiClient

  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - clusterReference - extId

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
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
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1375

def list_external_iscsi_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.list_external_iscsi_attachments_by_volume_group_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.list_external_iscsi_attachments_by_volume_group_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.list_external_iscsi_attachments_by_volume_group_id, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VolumeGroupsApi.list_external_iscsi_attachments_by_volume_group_id, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_external_iscsi_attachments_by_volume_group_id, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_external_iscsi_attachments_by_volume_group_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/external-iscsi-attachments'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'$limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#list_vm_attachments_by_volume_group_id(volume_group_ext_id, opts = {}) ⇒ ListVmAttachmentsByVolumeGroupId200Response

List all the VM attachments for a Volume Group Query the list of VM attachments for a Volume Group identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - extId

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - extId

Returns:



1455
1456
1457
1458
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1455

def list_vm_attachments_by_volume_group_id(volume_group_ext_id, opts = {})
  data, _status_code, _headers = list_vm_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
  data
end

#list_vm_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {}) ⇒ Array<(ListVmAttachmentsByVolumeGroupId200Response, Integer, Hash)>

List all the VM attachments for a Volume Group Query the list of VM attachments for a Volume Group identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - extId

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - extId

Returns:



1469
1470
1471
1472
1473
1474
1475
1476
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
1534
1535
1536
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1469

def list_vm_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.list_vm_attachments_by_volume_group_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.list_vm_attachments_by_volume_group_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.list_vm_attachments_by_volume_group_id, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VolumeGroupsApi.list_vm_attachments_by_volume_group_id, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_vm_attachments_by_volume_group_id, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_vm_attachments_by_volume_group_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/vm-attachments'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'$limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#list_volume_disks_by_volume_group_id(volume_group_ext_id, opts = {}) ⇒ ListVolumeDisksByVolumeGroupId200Response

List all the Volume Disks attached to the Volume Group Query the list of disks corresponding to a Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - storageContainerId

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - diskSizeBytes

  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - extId - storageContainerId

Returns:



1548
1549
1550
1551
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1548

def list_volume_disks_by_volume_group_id(volume_group_ext_id, opts = {})
  data, _status_code, _headers = list_volume_disks_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
  data
end

#list_volume_disks_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {}) ⇒ Array<(ListVolumeDisksByVolumeGroupId200Response, Integer, Hash)>

List all the Volume Disks attached to the Volume Group Query the list of disks corresponding to a Volume Group identified by volumeGroupExtId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - storageContainerId

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - diskSizeBytes

  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - extId - storageContainerId

Returns:



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
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1563

def list_volume_disks_by_volume_group_id_with_http_info(volume_group_ext_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.list_volume_disks_by_volume_group_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.list_volume_disks_by_volume_group_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.list_volume_disks_by_volume_group_id, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VolumeGroupsApi.list_volume_disks_by_volume_group_id, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_volume_disks_by_volume_group_id, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_volume_disks_by_volume_group_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'$limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#list_volume_groups(opts = {}) ⇒ ListVolumeGroups200Response

List all the Volume Groups Query the list of Volume Groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - clusterReference - extId - name

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - clusterReference - extId - name

  • :expand (String) —

    A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported. - cluster - metadata

  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - clusterReference - extId - name

Returns:



1643
1644
1645
1646
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1643

def list_volume_groups(opts = {})
  data, _status_code, _headers = list_volume_groups_with_http_info(opts)
  data
end

#list_volume_groups_with_http_info(opts = {}) ⇒ Array<(ListVolumeGroups200Response, Integer, Hash)>

List all the Volume Groups Query the list of Volume Groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. (default to 0)

  • :limit (Integer) —

    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. (default to 50)

  • :filter (String) —

    A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter &#39;$filter&#x3D;name eq &#39;karbon-ntnx-1.0&#39; would filter the result on cluster name &#39;karbon-ntnx1.0&#39;, filter &#39;$filter&#x3D;startswith(name, &#39;C&#39;)&#39; would filter on cluster name starting with &#39;C&#39;. The filter can be applied to the following fields: - clusterReference - extId - name

  • :orderby (String) —

    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, &#39;$orderby&#x3D;templateName desc&#39; would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - clusterReference - extId - name

  • :expand (String) —

    A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported. - cluster - metadata

  • :select (String) —

    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - clusterReference - extId - name

Returns:

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

    ListVolumeGroups200Response data, response status code and response headers



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1658

def list_volume_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.list_volume_groups ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VolumeGroupsApi.list_volume_groups, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_volume_groups, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VolumeGroupsApi.list_volume_groups, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'$limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#revert_volume_group(ext_id, ntnx_request_id, volumes_v40_config_revert_spec, opts = {}) ⇒ RevertVolumeGroup202Response

Revert a Volume Group Reverts a Volume Group identified by Volume Group external identifier. This API performs an in-place restore from a specified Volume Group recovery point.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_revert_spec (VolumesV40ConfigRevertSpec) —

    Specify the Volume Group recovery point ID to which the Volume Group would be reverted.

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

    the optional parameters

Returns:



1727
1728
1729
1730
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1727

def revert_volume_group(ext_id, ntnx_request_id, volumes_v40_config_revert_spec, opts = {})
  data, _status_code, _headers = revert_volume_group_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_revert_spec, opts)
  data
end

#revert_volume_group_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_revert_spec, opts = {}) ⇒ Array<(RevertVolumeGroup202Response, Integer, Hash)>

Revert a Volume Group Reverts a Volume Group identified by Volume Group external identifier. This API performs an in-place restore from a specified Volume Group recovery point.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_revert_spec (VolumesV40ConfigRevertSpec) —

    Specify the Volume Group recovery point ID to which the Volume Group would be reverted.

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

    the optional parameters

Returns:



1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1739

def revert_volume_group_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_revert_spec, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.revert_volume_group ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.revert_volume_group"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.revert_volume_group, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.revert_volume_group"
  end
  # verify the required parameter 'volumes_v40_config_revert_spec' is set
  if @api_client.config.client_side_validation && volumes_v40_config_revert_spec.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_revert_spec' when calling VolumeGroupsApi.revert_volume_group"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}/$actions/revert'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

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

#update_volume_disk_by_id(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk, opts = {}) ⇒ UpdateVolumeDiskById202Response

Update a specified Volume Disk Updates a specific Volume Disk identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

  • if_match (String) —

    The If-Match request header makes the request conditional. When not provided, the server will respond with an HTTP-428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow the successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP-412 (Precondition Failed) response will be returned.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_disk (VolumesV40ConfigVolumeDisk) —

    A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF.

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

    the optional parameters

Returns:



1815
1816
1817
1818
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1815

def update_volume_disk_by_id(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk, opts = {})
  data, _status_code, _headers = update_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk, opts)
  data
end

#update_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk, opts = {}) ⇒ Array<(UpdateVolumeDiskById202Response, Integer, Hash)>

Update a specified Volume Disk Updates a specific Volume Disk identified by extId.

Parameters:

  • volume_group_ext_id (String) —

    The external identifier of a Volume Group.

  • ext_id (String) —

    The external identifier of a Volume Disk.

  • if_match (String) —

    The If-Match request header makes the request conditional. When not provided, the server will respond with an HTTP-428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow the successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP-412 (Precondition Failed) response will be returned.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_disk (VolumesV40ConfigVolumeDisk) —

    A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF.

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

    the optional parameters

Returns:



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1829

def update_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.update_volume_disk_by_id ...'
  end
  # verify the required parameter 'volume_group_ext_id' is set
  if @api_client.config.client_side_validation && volume_group_ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_group_ext_id' when calling VolumeGroupsApi.update_volume_disk_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && volume_group_ext_id !~ pattern
    fail ArgumentError, "invalid value for 'volume_group_ext_id' when calling VolumeGroupsApi.update_volume_disk_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.update_volume_disk_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.update_volume_disk_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'if_match' is set
  if @api_client.config.client_side_validation && if_match.nil?
    fail ArgumentError, "Missing the required parameter 'if_match' when calling VolumeGroupsApi.update_volume_disk_by_id"
  end
  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.update_volume_disk_by_id"
  end
  # verify the required parameter 'volumes_v40_config_volume_disk' is set
  if @api_client.config.client_side_validation && volumes_v40_config_volume_disk.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_volume_disk' when calling VolumeGroupsApi.update_volume_disk_by_id"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks/{extId}'.sub('{' + 'volumeGroupExtId' + '}', CGI.escape(volume_group_ext_id.to_s)).sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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'] = if_match
  header_params[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

  new_options = opts.merge(
    :operation => :"VolumeGroupsApi.update_volume_disk_by_id",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VolumeGroupsApi#update_volume_disk_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_volume_group_by_id(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group, opts = {}) ⇒ UpdateVolumeGroupById202Response

Update details of a specified Volume Group Updates details of a specific Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • if_match (String) —

    The If-Match request header makes the request conditional. When not provided, the server will respond with an HTTP-428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow the successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP-412 (Precondition Failed) response will be returned.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_group (VolumesV40ConfigVolumeGroup) —

    A model that represents a Volume Group resource.

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

    the optional parameters

Returns:



1918
1919
1920
1921
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1918

def update_volume_group_by_id(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group, opts = {})
  data, _status_code, _headers = update_volume_group_by_id_with_http_info(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group, opts)
  data
end

#update_volume_group_by_id_with_http_info(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group, opts = {}) ⇒ Array<(UpdateVolumeGroupById202Response, Integer, Hash)>

Update details of a specified Volume Group Updates details of a specific Volume Group identified by extId.

Parameters:

  • ext_id (String) —

    The external identifier of a Volume Group.

  • if_match (String) —

    The If-Match request header makes the request conditional. When not provided, the server will respond with an HTTP-428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow the successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP-412 (Precondition Failed) response will be returned.

  • ntnx_request_id (String) —

    A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.

  • volumes_v40_config_volume_group (VolumesV40ConfigVolumeGroup) —

    A model that represents a Volume Group resource.

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

    the optional parameters

Returns:



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
 
# File 'lib/nutanix_volumes/api/volume_groups_api.rb', line 1931

def update_volume_group_by_id_with_http_info(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VolumeGroupsApi.update_volume_group_by_id ...'
  end
  # verify the required parameter 'ext_id' is set
  if @api_client.config.client_side_validation && ext_id.nil?
    fail ArgumentError, "Missing the required parameter 'ext_id' when calling VolumeGroupsApi.update_volume_group_by_id"
  end
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if @api_client.config.client_side_validation && ext_id !~ pattern
    fail ArgumentError, "invalid value for 'ext_id' when calling VolumeGroupsApi.update_volume_group_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'if_match' is set
  if @api_client.config.client_side_validation && if_match.nil?
    fail ArgumentError, "Missing the required parameter 'if_match' when calling VolumeGroupsApi.update_volume_group_by_id"
  end
  # verify the required parameter 'ntnx_request_id' is set
  if @api_client.config.client_side_validation && ntnx_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'ntnx_request_id' when calling VolumeGroupsApi.update_volume_group_by_id"
  end
  # verify the required parameter 'volumes_v40_config_volume_group' is set
  if @api_client.config.client_side_validation && volumes_v40_config_volume_group.nil?
    fail ArgumentError, "Missing the required parameter 'volumes_v40_config_volume_group' when calling VolumeGroupsApi.update_volume_group_by_id"
  end
  # resource path
  local_var_path = '/volumes/v4.0/config/volume-groups/{extId}'.sub('{' + 'extId' + '}', CGI.escape(ext_id.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']) unless header_params['Accept']
  # 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'] = if_match
  header_params[:'NTNX-Request-Id'] = ntnx_request_id

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuthScheme', 'basicAuthScheme']

  new_options = opts.merge(
    :operation => :"VolumeGroupsApi.update_volume_group_by_id",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VolumeGroupsApi#update_volume_group_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end