nutanix_volumes 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (480) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +11 -0
  3. data/Gemfile +9 -0
  4. data/README.md +290 -0
  5. data/Rakefile +10 -0
  6. data/docs/AssociateCategory202Response.md +20 -0
  7. data/docs/AssociateCategory4XXResponse.md +20 -0
  8. data/docs/AttachIscsiClient202Response.md +20 -0
  9. data/docs/AttachIscsiClient4XXResponse.md +20 -0
  10. data/docs/AttachVm202Response.md +20 -0
  11. data/docs/AttachVm4XXResponse.md +20 -0
  12. data/docs/CommonV10ConfigEntityReference.md +24 -0
  13. data/docs/CommonV10ConfigEntityType.md +15 -0
  14. data/docs/CommonV10ConfigFQDN.md +18 -0
  15. data/docs/CommonV10ConfigFlag.md +20 -0
  16. data/docs/CommonV10ConfigIPAddressOrFQDN.md +22 -0
  17. data/docs/CommonV10ConfigIPv4Address.md +20 -0
  18. data/docs/CommonV10ConfigIPv6Address.md +20 -0
  19. data/docs/CommonV10ConfigKVPair.md +20 -0
  20. data/docs/CommonV10ConfigKVPairValue.md +59 -0
  21. data/docs/CommonV10ConfigMapOfStringWrapper.md +18 -0
  22. data/docs/CommonV10ConfigMessage.md +24 -0
  23. data/docs/CommonV10ConfigMessageSeverity.md +15 -0
  24. data/docs/CommonV10ConfigMetadata.md +26 -0
  25. data/docs/CommonV10ConfigTenantAwareModel.md +18 -0
  26. data/docs/CommonV10ResponseApiLink.md +20 -0
  27. data/docs/CommonV10ResponseApiResponseMetadata.md +26 -0
  28. data/docs/CommonV10ResponseExternalizableAbstractModel.md +22 -0
  29. data/docs/CommonV10StatsDownSamplingOperator.md +15 -0
  30. data/docs/CreateVolumeDisk202Response.md +20 -0
  31. data/docs/CreateVolumeDisk4XXResponse.md +20 -0
  32. data/docs/CreateVolumeGroup202Response.md +20 -0
  33. data/docs/CreateVolumeGroup4XXResponse.md +20 -0
  34. data/docs/DeleteVolumeDiskById202Response.md +20 -0
  35. data/docs/DeleteVolumeDiskById4XXResponse.md +20 -0
  36. data/docs/DeleteVolumeGroupById202Response.md +20 -0
  37. data/docs/DeleteVolumeGroupById4XXResponse.md +20 -0
  38. data/docs/DetachIscsiClient202Response.md +20 -0
  39. data/docs/DetachIscsiClient4XXResponse.md +20 -0
  40. data/docs/DetachVm202Response.md +20 -0
  41. data/docs/DetachVm4XXResponse.md +20 -0
  42. data/docs/DisassociateCategory202Response.md +20 -0
  43. data/docs/DisassociateCategory4XXResponse.md +20 -0
  44. data/docs/GetIscsiClientById200Response.md +20 -0
  45. data/docs/GetIscsiClientById4XXResponse.md +20 -0
  46. data/docs/GetVolumeDiskById200Response.md +20 -0
  47. data/docs/GetVolumeDiskById4XXResponse.md +20 -0
  48. data/docs/GetVolumeDiskStats200Response.md +20 -0
  49. data/docs/GetVolumeDiskStats4XXResponse.md +20 -0
  50. data/docs/GetVolumeGroupById200Response.md +20 -0
  51. data/docs/GetVolumeGroupById4XXResponse.md +20 -0
  52. data/docs/GetVolumeGroupMetadataById200Response.md +20 -0
  53. data/docs/GetVolumeGroupMetadataById4XXResponse.md +20 -0
  54. data/docs/GetVolumeGroupStats200Response.md +20 -0
  55. data/docs/GetVolumeGroupStats4XXResponse.md +20 -0
  56. data/docs/IscsiClientsApi.md +253 -0
  57. data/docs/ListCategoryAssociationsByVolumeGroupId200Response.md +20 -0
  58. data/docs/ListCategoryAssociationsByVolumeGroupId4XXResponse.md +20 -0
  59. data/docs/ListExternalIscsiAttachmentsByVolumeGroupId200Response.md +20 -0
  60. data/docs/ListExternalIscsiAttachmentsByVolumeGroupId4XXResponse.md +20 -0
  61. data/docs/ListIscsiClients200Response.md +20 -0
  62. data/docs/ListIscsiClients4XXResponse.md +20 -0
  63. data/docs/ListVmAttachmentsByVolumeGroupId200Response.md +20 -0
  64. data/docs/ListVmAttachmentsByVolumeGroupId4XXResponse.md +20 -0
  65. data/docs/ListVolumeDisksByVolumeGroupId200Response.md +20 -0
  66. data/docs/ListVolumeDisksByVolumeGroupId4XXResponse.md +20 -0
  67. data/docs/ListVolumeGroups200Response.md +20 -0
  68. data/docs/ListVolumeGroups4XXResponse.md +20 -0
  69. data/docs/PrismV40ConfigTaskReference.md +18 -0
  70. data/docs/RevertVolumeGroup202Response.md +20 -0
  71. data/docs/RevertVolumeGroup4XXResponse.md +20 -0
  72. data/docs/UpdateIscsiClientById202Response.md +20 -0
  73. data/docs/UpdateIscsiClientById4XXResponse.md +20 -0
  74. data/docs/UpdateVolumeDiskById202Response.md +20 -0
  75. data/docs/UpdateVolumeDiskById4XXResponse.md +20 -0
  76. data/docs/UpdateVolumeGroupById202Response.md +20 -0
  77. data/docs/UpdateVolumeGroupById4XXResponse.md +20 -0
  78. data/docs/VolumeGroupsApi.md +1887 -0
  79. data/docs/VolumesV40ConfigAssociateCategoryApiResponse.md +20 -0
  80. data/docs/VolumesV40ConfigAttachIscsiClientApiResponse.md +20 -0
  81. data/docs/VolumesV40ConfigAttachNvmfClientApiResponse.md +20 -0
  82. data/docs/VolumesV40ConfigAttachVmApiResponse.md +20 -0
  83. data/docs/VolumesV40ConfigAttachmentType.md +15 -0
  84. data/docs/VolumesV40ConfigAuthenticationType.md +15 -0
  85. data/docs/VolumesV40ConfigCategoryDetails.md +24 -0
  86. data/docs/VolumesV40ConfigCategoryEntityReferences.md +18 -0
  87. data/docs/VolumesV40ConfigCluster.md +20 -0
  88. data/docs/VolumesV40ConfigCreateVolumeDiskApiResponse.md +20 -0
  89. data/docs/VolumesV40ConfigCreateVolumeGroupApiResponse.md +20 -0
  90. data/docs/VolumesV40ConfigDeleteVolumeDiskApiResponse.md +20 -0
  91. data/docs/VolumesV40ConfigDeleteVolumeGroupApiResponse.md +20 -0
  92. data/docs/VolumesV40ConfigDetachIscsiClientApiResponse.md +20 -0
  93. data/docs/VolumesV40ConfigDetachNvmfClientApiResponse.md +20 -0
  94. data/docs/VolumesV40ConfigDetachVmApiResponse.md +20 -0
  95. data/docs/VolumesV40ConfigDisassociateCategoryApiResponse.md +20 -0
  96. data/docs/VolumesV40ConfigDiskStorageFeatures.md +18 -0
  97. data/docs/VolumesV40ConfigFlashMode.md +18 -0
  98. data/docs/VolumesV40ConfigGetIscsiClientApiResponse.md +20 -0
  99. data/docs/VolumesV40ConfigGetIscsiClientApiResponseData.md +49 -0
  100. data/docs/VolumesV40ConfigGetVolumeDiskApiResponse.md +20 -0
  101. data/docs/VolumesV40ConfigGetVolumeDiskApiResponseData.md +49 -0
  102. data/docs/VolumesV40ConfigGetVolumeGroupApiResponse.md +20 -0
  103. data/docs/VolumesV40ConfigGetVolumeGroupApiResponseData.md +49 -0
  104. data/docs/VolumesV40ConfigGetVolumeGroupMetadataApiResponse.md +20 -0
  105. data/docs/VolumesV40ConfigGetVolumeGroupMetadataApiResponseData.md +49 -0
  106. data/docs/VolumesV40ConfigIscsiClient.md +38 -0
  107. data/docs/VolumesV40ConfigIscsiClientAttachment.md +20 -0
  108. data/docs/VolumesV40ConfigIscsiFeatures.md +20 -0
  109. data/docs/VolumesV40ConfigListCategoryAssociationsApiResponse.md +20 -0
  110. data/docs/VolumesV40ConfigListCategoryAssociationsApiResponseData.md +49 -0
  111. data/docs/VolumesV40ConfigListExternalIscsiAttachmentsApiResponse.md +20 -0
  112. data/docs/VolumesV40ConfigListExternalIscsiAttachmentsApiResponseData.md +49 -0
  113. data/docs/VolumesV40ConfigListIscsiClientsApiResponse.md +20 -0
  114. data/docs/VolumesV40ConfigListIscsiClientsApiResponseData.md +49 -0
  115. data/docs/VolumesV40ConfigListVmAttachmentsApiResponse.md +20 -0
  116. data/docs/VolumesV40ConfigListVmAttachmentsApiResponseData.md +49 -0
  117. data/docs/VolumesV40ConfigListVolumeDisksApiResponse.md +20 -0
  118. data/docs/VolumesV40ConfigListVolumeDisksApiResponseData.md +49 -0
  119. data/docs/VolumesV40ConfigListVolumeGroupsApiResponse.md +20 -0
  120. data/docs/VolumesV40ConfigListVolumeGroupsApiResponseData.md +49 -0
  121. data/docs/VolumesV40ConfigMigrateVolumeGroupApiResponse.md +20 -0
  122. data/docs/VolumesV40ConfigNvmfClient.md +28 -0
  123. data/docs/VolumesV40ConfigNvmfClientAttachment.md +24 -0
  124. data/docs/VolumesV40ConfigPauseVolumeGroupSynchronousReplicationApiResponse.md +20 -0
  125. data/docs/VolumesV40ConfigProtocol.md +15 -0
  126. data/docs/VolumesV40ConfigResumeVolumeGroupSynchronousReplicationApiResponse.md +20 -0
  127. data/docs/VolumesV40ConfigResumeVolumeGroupSynchronousReplicationApiResponseData.md +47 -0
  128. data/docs/VolumesV40ConfigRevertSpec.md +18 -0
  129. data/docs/VolumesV40ConfigRevertVolumeGroupApiResponse.md +20 -0
  130. data/docs/VolumesV40ConfigSharingStatus.md +15 -0
  131. data/docs/VolumesV40ConfigStorageFeatures.md +18 -0
  132. data/docs/VolumesV40ConfigTargetParam.md +20 -0
  133. data/docs/VolumesV40ConfigUpdateIscsiClientApiResponse.md +20 -0
  134. data/docs/VolumesV40ConfigUpdateIscsiClientApiResponseData.md +49 -0
  135. data/docs/VolumesV40ConfigUpdateIscsiClientByIdApiResponse.md +20 -0
  136. data/docs/VolumesV40ConfigUpdateVolumeDiskApiResponse.md +20 -0
  137. data/docs/VolumesV40ConfigUpdateVolumeDiskByIdApiResponse.md +20 -0
  138. data/docs/VolumesV40ConfigUpdateVolumeGroupApiResponse.md +20 -0
  139. data/docs/VolumesV40ConfigUpdateVolumeGroupByIdApiResponse.md +20 -0
  140. data/docs/VolumesV40ConfigUpdateVolumeGroupMetadataApiResponse.md +20 -0
  141. data/docs/VolumesV40ConfigUpdateVolumeGroupMetadataInfoApiResponse.md +20 -0
  142. data/docs/VolumesV40ConfigUsageType.md +15 -0
  143. data/docs/VolumesV40ConfigVmAttachment.md +20 -0
  144. data/docs/VolumesV40ConfigVolumeDisk.md +34 -0
  145. data/docs/VolumesV40ConfigVolumeGroup.md +54 -0
  146. data/docs/VolumesV40ConfigVolumeGroupAttachmentSite.md +15 -0
  147. data/docs/VolumesV40ConfigVolumeGroupMetadata.md +20 -0
  148. data/docs/VolumesV40ErrorAppMessage.md +28 -0
  149. data/docs/VolumesV40ErrorErrorResponse.md +18 -0
  150. data/docs/VolumesV40ErrorErrorResponseError.md +49 -0
  151. data/docs/VolumesV40ErrorMessageSeverity.md +15 -0
  152. data/docs/VolumesV40ErrorSchemaValidationError.md +26 -0
  153. data/docs/VolumesV40ErrorSchemaValidationErrorMessage.md +22 -0
  154. data/docs/VolumesV40StatsGetVolumeDiskStatsApiResponse.md +20 -0
  155. data/docs/VolumesV40StatsGetVolumeDiskStatsApiResponseData.md +49 -0
  156. data/docs/VolumesV40StatsGetVolumeGroupStatsApiResponse.md +20 -0
  157. data/docs/VolumesV40StatsGetVolumeGroupStatsApiResponseData.md +49 -0
  158. data/docs/VolumesV40StatsTimeValuePair.md +20 -0
  159. data/docs/VolumesV40StatsVolumeDiskStats.md +44 -0
  160. data/docs/VolumesV40StatsVolumeGroupStats.md +44 -0
  161. data/git_push.sh +57 -0
  162. data/lib/nutanix_volumes/api/iscsi_clients_api.rb +270 -0
  163. data/lib/nutanix_volumes/api/volume_groups_api.rb +2003 -0
  164. data/lib/nutanix_volumes/api_client.rb +394 -0
  165. data/lib/nutanix_volumes/api_error.rb +58 -0
  166. data/lib/nutanix_volumes/configuration.rb +315 -0
  167. data/lib/nutanix_volumes/models/associate_category202_response.rb +224 -0
  168. data/lib/nutanix_volumes/models/associate_category4_xx_response.rb +224 -0
  169. data/lib/nutanix_volumes/models/attach_iscsi_client202_response.rb +224 -0
  170. data/lib/nutanix_volumes/models/attach_iscsi_client4_xx_response.rb +224 -0
  171. data/lib/nutanix_volumes/models/attach_vm202_response.rb +224 -0
  172. data/lib/nutanix_volumes/models/attach_vm4_xx_response.rb +224 -0
  173. data/lib/nutanix_volumes/models/common_v10_config_entity_reference.rb +336 -0
  174. data/lib/nutanix_volumes/models/common_v10_config_entity_type.rb +68 -0
  175. data/lib/nutanix_volumes/models/common_v10_config_flag.rb +256 -0
  176. data/lib/nutanix_volumes/models/common_v10_config_fqdn.rb +237 -0
  177. data/lib/nutanix_volumes/models/common_v10_config_ip_address_or_fqdn.rb +233 -0
  178. data/lib/nutanix_volumes/models/common_v10_config_ipv4_address.rb +284 -0
  179. data/lib/nutanix_volumes/models/common_v10_config_ipv6_address.rb +284 -0
  180. data/lib/nutanix_volumes/models/common_v10_config_kv_pair.rb +253 -0
  181. data/lib/nutanix_volumes/models/common_v10_config_kv_pair_value.rb +111 -0
  182. data/lib/nutanix_volumes/models/common_v10_config_map_of_string_wrapper.rb +218 -0
  183. data/lib/nutanix_volumes/models/common_v10_config_message.rb +268 -0
  184. data/lib/nutanix_volumes/models/common_v10_config_message_severity.rb +43 -0
  185. data/lib/nutanix_volumes/models/common_v10_config_metadata.rb +366 -0
  186. data/lib/nutanix_volumes/models/common_v10_config_tenant_aware_model.rb +237 -0
  187. data/lib/nutanix_volumes/models/common_v10_response_api_link.rb +226 -0
  188. data/lib/nutanix_volumes/models/common_v10_response_api_response_metadata.rb +376 -0
  189. data/lib/nutanix_volumes/models/common_v10_response_externalizable_abstract_model.rb +312 -0
  190. data/lib/nutanix_volumes/models/common_v10_stats_down_sampling_operator.rb +46 -0
  191. data/lib/nutanix_volumes/models/create_volume_disk202_response.rb +224 -0
  192. data/lib/nutanix_volumes/models/create_volume_disk4_xx_response.rb +224 -0
  193. data/lib/nutanix_volumes/models/create_volume_group202_response.rb +224 -0
  194. data/lib/nutanix_volumes/models/create_volume_group4_xx_response.rb +224 -0
  195. data/lib/nutanix_volumes/models/delete_volume_disk_by_id202_response.rb +224 -0
  196. data/lib/nutanix_volumes/models/delete_volume_disk_by_id4_xx_response.rb +224 -0
  197. data/lib/nutanix_volumes/models/delete_volume_group_by_id202_response.rb +224 -0
  198. data/lib/nutanix_volumes/models/delete_volume_group_by_id4_xx_response.rb +224 -0
  199. data/lib/nutanix_volumes/models/detach_iscsi_client202_response.rb +224 -0
  200. data/lib/nutanix_volumes/models/detach_iscsi_client4_xx_response.rb +224 -0
  201. data/lib/nutanix_volumes/models/detach_vm202_response.rb +224 -0
  202. data/lib/nutanix_volumes/models/detach_vm4_xx_response.rb +224 -0
  203. data/lib/nutanix_volumes/models/disassociate_category202_response.rb +224 -0
  204. data/lib/nutanix_volumes/models/disassociate_category4_xx_response.rb +224 -0
  205. data/lib/nutanix_volumes/models/get_iscsi_client_by_id200_response.rb +224 -0
  206. data/lib/nutanix_volumes/models/get_iscsi_client_by_id4_xx_response.rb +224 -0
  207. data/lib/nutanix_volumes/models/get_volume_disk_by_id200_response.rb +224 -0
  208. data/lib/nutanix_volumes/models/get_volume_disk_by_id4_xx_response.rb +224 -0
  209. data/lib/nutanix_volumes/models/get_volume_disk_stats200_response.rb +224 -0
  210. data/lib/nutanix_volumes/models/get_volume_disk_stats4_xx_response.rb +224 -0
  211. data/lib/nutanix_volumes/models/get_volume_group_by_id200_response.rb +224 -0
  212. data/lib/nutanix_volumes/models/get_volume_group_by_id4_xx_response.rb +224 -0
  213. data/lib/nutanix_volumes/models/get_volume_group_metadata_by_id200_response.rb +224 -0
  214. data/lib/nutanix_volumes/models/get_volume_group_metadata_by_id4_xx_response.rb +224 -0
  215. data/lib/nutanix_volumes/models/get_volume_group_stats200_response.rb +224 -0
  216. data/lib/nutanix_volumes/models/get_volume_group_stats4_xx_response.rb +224 -0
  217. data/lib/nutanix_volumes/models/list_category_associations_by_volume_group_id200_response.rb +226 -0
  218. data/lib/nutanix_volumes/models/list_category_associations_by_volume_group_id4_xx_response.rb +224 -0
  219. data/lib/nutanix_volumes/models/list_external_iscsi_attachments_by_volume_group_id200_response.rb +226 -0
  220. data/lib/nutanix_volumes/models/list_external_iscsi_attachments_by_volume_group_id4_xx_response.rb +224 -0
  221. data/lib/nutanix_volumes/models/list_iscsi_clients200_response.rb +226 -0
  222. data/lib/nutanix_volumes/models/list_iscsi_clients4_xx_response.rb +224 -0
  223. data/lib/nutanix_volumes/models/list_vm_attachments_by_volume_group_id200_response.rb +226 -0
  224. data/lib/nutanix_volumes/models/list_vm_attachments_by_volume_group_id4_xx_response.rb +224 -0
  225. data/lib/nutanix_volumes/models/list_volume_disks_by_volume_group_id200_response.rb +226 -0
  226. data/lib/nutanix_volumes/models/list_volume_disks_by_volume_group_id4_xx_response.rb +224 -0
  227. data/lib/nutanix_volumes/models/list_volume_groups200_response.rb +226 -0
  228. data/lib/nutanix_volumes/models/list_volume_groups4_xx_response.rb +224 -0
  229. data/lib/nutanix_volumes/models/prism_v40_config_task_reference.rb +237 -0
  230. data/lib/nutanix_volumes/models/revert_volume_group202_response.rb +224 -0
  231. data/lib/nutanix_volumes/models/revert_volume_group4_xx_response.rb +224 -0
  232. data/lib/nutanix_volumes/models/update_iscsi_client_by_id202_response.rb +224 -0
  233. data/lib/nutanix_volumes/models/update_iscsi_client_by_id4_xx_response.rb +224 -0
  234. data/lib/nutanix_volumes/models/update_volume_disk_by_id202_response.rb +224 -0
  235. data/lib/nutanix_volumes/models/update_volume_disk_by_id4_xx_response.rb +224 -0
  236. data/lib/nutanix_volumes/models/update_volume_group_by_id202_response.rb +224 -0
  237. data/lib/nutanix_volumes/models/update_volume_group_by_id4_xx_response.rb +224 -0
  238. data/lib/nutanix_volumes/models/volumes_v40_config_associate_category_api_response.rb +224 -0
  239. data/lib/nutanix_volumes/models/volumes_v40_config_attach_iscsi_client_api_response.rb +224 -0
  240. data/lib/nutanix_volumes/models/volumes_v40_config_attach_nvmf_client_api_response.rb +224 -0
  241. data/lib/nutanix_volumes/models/volumes_v40_config_attach_vm_api_response.rb +224 -0
  242. data/lib/nutanix_volumes/models/volumes_v40_config_attachment_type.rb +43 -0
  243. data/lib/nutanix_volumes/models/volumes_v40_config_authentication_type.rb +42 -0
  244. data/lib/nutanix_volumes/models/volumes_v40_config_category_details.rb +344 -0
  245. data/lib/nutanix_volumes/models/volumes_v40_config_category_entity_references.rb +246 -0
  246. data/lib/nutanix_volumes/models/volumes_v40_config_cluster.rb +265 -0
  247. data/lib/nutanix_volumes/models/volumes_v40_config_create_volume_disk_api_response.rb +224 -0
  248. data/lib/nutanix_volumes/models/volumes_v40_config_create_volume_group_api_response.rb +224 -0
  249. data/lib/nutanix_volumes/models/volumes_v40_config_delete_volume_disk_api_response.rb +224 -0
  250. data/lib/nutanix_volumes/models/volumes_v40_config_delete_volume_group_api_response.rb +224 -0
  251. data/lib/nutanix_volumes/models/volumes_v40_config_detach_iscsi_client_api_response.rb +224 -0
  252. data/lib/nutanix_volumes/models/volumes_v40_config_detach_nvmf_client_api_response.rb +224 -0
  253. data/lib/nutanix_volumes/models/volumes_v40_config_detach_vm_api_response.rb +224 -0
  254. data/lib/nutanix_volumes/models/volumes_v40_config_disassociate_category_api_response.rb +224 -0
  255. data/lib/nutanix_volumes/models/volumes_v40_config_disk_storage_features.rb +215 -0
  256. data/lib/nutanix_volumes/models/volumes_v40_config_flash_mode.rb +218 -0
  257. data/lib/nutanix_volumes/models/volumes_v40_config_get_iscsi_client_api_response.rb +224 -0
  258. data/lib/nutanix_volumes/models/volumes_v40_config_get_iscsi_client_api_response_data.rb +105 -0
  259. data/lib/nutanix_volumes/models/volumes_v40_config_get_volume_disk_api_response.rb +224 -0
  260. data/lib/nutanix_volumes/models/volumes_v40_config_get_volume_disk_api_response_data.rb +105 -0
  261. data/lib/nutanix_volumes/models/volumes_v40_config_get_volume_group_api_response.rb +224 -0
  262. data/lib/nutanix_volumes/models/volumes_v40_config_get_volume_group_api_response_data.rb +105 -0
  263. data/lib/nutanix_volumes/models/volumes_v40_config_get_volume_group_metadata_api_response.rb +224 -0
  264. data/lib/nutanix_volumes/models/volumes_v40_config_get_volume_group_metadata_api_response_data.rb +105 -0
  265. data/lib/nutanix_volumes/models/volumes_v40_config_iscsi_client.rb +508 -0
  266. data/lib/nutanix_volumes/models/volumes_v40_config_iscsi_client_attachment.rb +268 -0
  267. data/lib/nutanix_volumes/models/volumes_v40_config_iscsi_features.rb +275 -0
  268. data/lib/nutanix_volumes/models/volumes_v40_config_list_category_associations_api_response.rb +224 -0
  269. data/lib/nutanix_volumes/models/volumes_v40_config_list_category_associations_api_response_data.rb +105 -0
  270. data/lib/nutanix_volumes/models/volumes_v40_config_list_external_iscsi_attachments_api_response.rb +224 -0
  271. data/lib/nutanix_volumes/models/volumes_v40_config_list_external_iscsi_attachments_api_response_data.rb +105 -0
  272. data/lib/nutanix_volumes/models/volumes_v40_config_list_iscsi_clients_api_response.rb +224 -0
  273. data/lib/nutanix_volumes/models/volumes_v40_config_list_iscsi_clients_api_response_data.rb +105 -0
  274. data/lib/nutanix_volumes/models/volumes_v40_config_list_vm_attachments_api_response.rb +224 -0
  275. data/lib/nutanix_volumes/models/volumes_v40_config_list_vm_attachments_api_response_data.rb +105 -0
  276. data/lib/nutanix_volumes/models/volumes_v40_config_list_volume_disks_api_response.rb +224 -0
  277. data/lib/nutanix_volumes/models/volumes_v40_config_list_volume_disks_api_response_data.rb +105 -0
  278. data/lib/nutanix_volumes/models/volumes_v40_config_list_volume_groups_api_response.rb +224 -0
  279. data/lib/nutanix_volumes/models/volumes_v40_config_list_volume_groups_api_response_data.rb +105 -0
  280. data/lib/nutanix_volumes/models/volumes_v40_config_migrate_volume_group_api_response.rb +224 -0
  281. data/lib/nutanix_volumes/models/volumes_v40_config_nvmf_client.rb +412 -0
  282. data/lib/nutanix_volumes/models/volumes_v40_config_nvmf_client_attachment.rb +343 -0
  283. data/lib/nutanix_volumes/models/volumes_v40_config_pause_volume_group_synchronous_replication_api_response.rb +224 -0
  284. data/lib/nutanix_volumes/models/volumes_v40_config_protocol.rb +43 -0
  285. data/lib/nutanix_volumes/models/volumes_v40_config_resume_volume_group_synchronous_replication_api_response.rb +224 -0
  286. data/lib/nutanix_volumes/models/volumes_v40_config_resume_volume_group_synchronous_replication_api_response_data.rb +104 -0
  287. data/lib/nutanix_volumes/models/volumes_v40_config_revert_spec.rb +244 -0
  288. data/lib/nutanix_volumes/models/volumes_v40_config_revert_volume_group_api_response.rb +224 -0
  289. data/lib/nutanix_volumes/models/volumes_v40_config_sharing_status.rb +42 -0
  290. data/lib/nutanix_volumes/models/volumes_v40_config_storage_features.rb +215 -0
  291. data/lib/nutanix_volumes/models/volumes_v40_config_target_param.rb +273 -0
  292. data/lib/nutanix_volumes/models/volumes_v40_config_update_iscsi_client_api_response.rb +224 -0
  293. data/lib/nutanix_volumes/models/volumes_v40_config_update_iscsi_client_api_response_data.rb +105 -0
  294. data/lib/nutanix_volumes/models/volumes_v40_config_update_iscsi_client_by_id_api_response.rb +224 -0
  295. data/lib/nutanix_volumes/models/volumes_v40_config_update_volume_disk_api_response.rb +224 -0
  296. data/lib/nutanix_volumes/models/volumes_v40_config_update_volume_disk_by_id_api_response.rb +224 -0
  297. data/lib/nutanix_volumes/models/volumes_v40_config_update_volume_group_api_response.rb +224 -0
  298. data/lib/nutanix_volumes/models/volumes_v40_config_update_volume_group_by_id_api_response.rb +224 -0
  299. data/lib/nutanix_volumes/models/volumes_v40_config_update_volume_group_metadata_api_response.rb +224 -0
  300. data/lib/nutanix_volumes/models/volumes_v40_config_update_volume_group_metadata_info_api_response.rb +224 -0
  301. data/lib/nutanix_volumes/models/volumes_v40_config_usage_type.rb +44 -0
  302. data/lib/nutanix_volumes/models/volumes_v40_config_vm_attachment.rb +254 -0
  303. data/lib/nutanix_volumes/models/volumes_v40_config_volume_disk.rb +466 -0
  304. data/lib/nutanix_volumes/models/volumes_v40_config_volume_group.rb +657 -0
  305. data/lib/nutanix_volumes/models/volumes_v40_config_volume_group_attachment_site.rb +42 -0
  306. data/lib/nutanix_volumes/models/volumes_v40_config_volume_group_metadata.rb +255 -0
  307. data/lib/nutanix_volumes/models/volumes_v40_error_app_message.rb +291 -0
  308. data/lib/nutanix_volumes/models/volumes_v40_error_error_response.rb +215 -0
  309. data/lib/nutanix_volumes/models/volumes_v40_error_error_response_error.rb +105 -0
  310. data/lib/nutanix_volumes/models/volumes_v40_error_message_severity.rb +43 -0
  311. data/lib/nutanix_volumes/models/volumes_v40_error_schema_validation_error.rb +258 -0
  312. data/lib/nutanix_volumes/models/volumes_v40_error_schema_validation_error_message.rb +236 -0
  313. data/lib/nutanix_volumes/models/volumes_v40_stats_get_volume_disk_stats_api_response.rb +224 -0
  314. data/lib/nutanix_volumes/models/volumes_v40_stats_get_volume_disk_stats_api_response_data.rb +105 -0
  315. data/lib/nutanix_volumes/models/volumes_v40_stats_get_volume_group_stats_api_response.rb +224 -0
  316. data/lib/nutanix_volumes/models/volumes_v40_stats_get_volume_group_stats_api_response_data.rb +105 -0
  317. data/lib/nutanix_volumes/models/volumes_v40_stats_time_value_pair.rb +225 -0
  318. data/lib/nutanix_volumes/models/volumes_v40_stats_volume_disk_stats.rb +743 -0
  319. data/lib/nutanix_volumes/models/volumes_v40_stats_volume_group_stats.rb +743 -0
  320. data/lib/nutanix_volumes/version.rb +15 -0
  321. data/lib/nutanix_volumes.rb +194 -0
  322. data/nutanix_volumes.gemspec +39 -0
  323. data/spec/api/iscsi_clients_api_spec.rb +79 -0
  324. data/spec/api/volume_groups_api_spec.rb +370 -0
  325. data/spec/models/associate_category202_response_spec.rb +42 -0
  326. data/spec/models/associate_category4_xx_response_spec.rb +42 -0
  327. data/spec/models/attach_iscsi_client202_response_spec.rb +42 -0
  328. data/spec/models/attach_iscsi_client4_xx_response_spec.rb +42 -0
  329. data/spec/models/attach_vm202_response_spec.rb +42 -0
  330. data/spec/models/attach_vm4_xx_response_spec.rb +42 -0
  331. data/spec/models/common_v10_config_entity_reference_spec.rb +54 -0
  332. data/spec/models/common_v10_config_entity_type_spec.rb +30 -0
  333. data/spec/models/common_v10_config_flag_spec.rb +42 -0
  334. data/spec/models/common_v10_config_fqdn_spec.rb +36 -0
  335. data/spec/models/common_v10_config_ip_address_or_fqdn_spec.rb +48 -0
  336. data/spec/models/common_v10_config_ipv4_address_spec.rb +42 -0
  337. data/spec/models/common_v10_config_ipv6_address_spec.rb +42 -0
  338. data/spec/models/common_v10_config_kv_pair_spec.rb +42 -0
  339. data/spec/models/common_v10_config_kv_pair_value_spec.rb +32 -0
  340. data/spec/models/common_v10_config_map_of_string_wrapper_spec.rb +36 -0
  341. data/spec/models/common_v10_config_message_severity_spec.rb +30 -0
  342. data/spec/models/common_v10_config_message_spec.rb +54 -0
  343. data/spec/models/common_v10_config_metadata_spec.rb +60 -0
  344. data/spec/models/common_v10_config_tenant_aware_model_spec.rb +36 -0
  345. data/spec/models/common_v10_response_api_link_spec.rb +42 -0
  346. data/spec/models/common_v10_response_api_response_metadata_spec.rb +60 -0
  347. data/spec/models/common_v10_response_externalizable_abstract_model_spec.rb +48 -0
  348. data/spec/models/common_v10_stats_down_sampling_operator_spec.rb +30 -0
  349. data/spec/models/create_volume_disk202_response_spec.rb +42 -0
  350. data/spec/models/create_volume_disk4_xx_response_spec.rb +42 -0
  351. data/spec/models/create_volume_group202_response_spec.rb +42 -0
  352. data/spec/models/create_volume_group4_xx_response_spec.rb +42 -0
  353. data/spec/models/delete_volume_disk_by_id202_response_spec.rb +42 -0
  354. data/spec/models/delete_volume_disk_by_id4_xx_response_spec.rb +42 -0
  355. data/spec/models/delete_volume_group_by_id202_response_spec.rb +42 -0
  356. data/spec/models/delete_volume_group_by_id4_xx_response_spec.rb +42 -0
  357. data/spec/models/detach_iscsi_client202_response_spec.rb +42 -0
  358. data/spec/models/detach_iscsi_client4_xx_response_spec.rb +42 -0
  359. data/spec/models/detach_vm202_response_spec.rb +42 -0
  360. data/spec/models/detach_vm4_xx_response_spec.rb +42 -0
  361. data/spec/models/disassociate_category202_response_spec.rb +42 -0
  362. data/spec/models/disassociate_category4_xx_response_spec.rb +42 -0
  363. data/spec/models/get_iscsi_client_by_id200_response_spec.rb +42 -0
  364. data/spec/models/get_iscsi_client_by_id4_xx_response_spec.rb +42 -0
  365. data/spec/models/get_volume_disk_by_id200_response_spec.rb +42 -0
  366. data/spec/models/get_volume_disk_by_id4_xx_response_spec.rb +42 -0
  367. data/spec/models/get_volume_disk_stats200_response_spec.rb +42 -0
  368. data/spec/models/get_volume_disk_stats4_xx_response_spec.rb +42 -0
  369. data/spec/models/get_volume_group_by_id200_response_spec.rb +42 -0
  370. data/spec/models/get_volume_group_by_id4_xx_response_spec.rb +42 -0
  371. data/spec/models/get_volume_group_metadata_by_id200_response_spec.rb +42 -0
  372. data/spec/models/get_volume_group_metadata_by_id4_xx_response_spec.rb +42 -0
  373. data/spec/models/get_volume_group_stats200_response_spec.rb +42 -0
  374. data/spec/models/get_volume_group_stats4_xx_response_spec.rb +42 -0
  375. data/spec/models/list_category_associations_by_volume_group_id200_response_spec.rb +42 -0
  376. data/spec/models/list_category_associations_by_volume_group_id4_xx_response_spec.rb +42 -0
  377. data/spec/models/list_external_iscsi_attachments_by_volume_group_id200_response_spec.rb +42 -0
  378. data/spec/models/list_external_iscsi_attachments_by_volume_group_id4_xx_response_spec.rb +42 -0
  379. data/spec/models/list_iscsi_clients200_response_spec.rb +42 -0
  380. data/spec/models/list_iscsi_clients4_xx_response_spec.rb +42 -0
  381. data/spec/models/list_vm_attachments_by_volume_group_id200_response_spec.rb +42 -0
  382. data/spec/models/list_vm_attachments_by_volume_group_id4_xx_response_spec.rb +42 -0
  383. data/spec/models/list_volume_disks_by_volume_group_id200_response_spec.rb +42 -0
  384. data/spec/models/list_volume_disks_by_volume_group_id4_xx_response_spec.rb +42 -0
  385. data/spec/models/list_volume_groups200_response_spec.rb +42 -0
  386. data/spec/models/list_volume_groups4_xx_response_spec.rb +42 -0
  387. data/spec/models/prism_v40_config_task_reference_spec.rb +36 -0
  388. data/spec/models/revert_volume_group202_response_spec.rb +42 -0
  389. data/spec/models/revert_volume_group4_xx_response_spec.rb +42 -0
  390. data/spec/models/update_iscsi_client_by_id202_response_spec.rb +42 -0
  391. data/spec/models/update_iscsi_client_by_id4_xx_response_spec.rb +42 -0
  392. data/spec/models/update_volume_disk_by_id202_response_spec.rb +42 -0
  393. data/spec/models/update_volume_disk_by_id4_xx_response_spec.rb +42 -0
  394. data/spec/models/update_volume_group_by_id202_response_spec.rb +42 -0
  395. data/spec/models/update_volume_group_by_id4_xx_response_spec.rb +42 -0
  396. data/spec/models/volumes_v40_config_associate_category_api_response_spec.rb +42 -0
  397. data/spec/models/volumes_v40_config_attach_iscsi_client_api_response_spec.rb +42 -0
  398. data/spec/models/volumes_v40_config_attach_nvmf_client_api_response_spec.rb +42 -0
  399. data/spec/models/volumes_v40_config_attach_vm_api_response_spec.rb +42 -0
  400. data/spec/models/volumes_v40_config_attachment_type_spec.rb +30 -0
  401. data/spec/models/volumes_v40_config_authentication_type_spec.rb +30 -0
  402. data/spec/models/volumes_v40_config_category_details_spec.rb +54 -0
  403. data/spec/models/volumes_v40_config_category_entity_references_spec.rb +36 -0
  404. data/spec/models/volumes_v40_config_cluster_spec.rb +42 -0
  405. data/spec/models/volumes_v40_config_create_volume_disk_api_response_spec.rb +42 -0
  406. data/spec/models/volumes_v40_config_create_volume_group_api_response_spec.rb +42 -0
  407. data/spec/models/volumes_v40_config_delete_volume_disk_api_response_spec.rb +42 -0
  408. data/spec/models/volumes_v40_config_delete_volume_group_api_response_spec.rb +42 -0
  409. data/spec/models/volumes_v40_config_detach_iscsi_client_api_response_spec.rb +42 -0
  410. data/spec/models/volumes_v40_config_detach_nvmf_client_api_response_spec.rb +42 -0
  411. data/spec/models/volumes_v40_config_detach_vm_api_response_spec.rb +42 -0
  412. data/spec/models/volumes_v40_config_disassociate_category_api_response_spec.rb +42 -0
  413. data/spec/models/volumes_v40_config_disk_storage_features_spec.rb +36 -0
  414. data/spec/models/volumes_v40_config_flash_mode_spec.rb +36 -0
  415. data/spec/models/volumes_v40_config_get_iscsi_client_api_response_data_spec.rb +32 -0
  416. data/spec/models/volumes_v40_config_get_iscsi_client_api_response_spec.rb +42 -0
  417. data/spec/models/volumes_v40_config_get_volume_disk_api_response_data_spec.rb +32 -0
  418. data/spec/models/volumes_v40_config_get_volume_disk_api_response_spec.rb +42 -0
  419. data/spec/models/volumes_v40_config_get_volume_group_api_response_data_spec.rb +32 -0
  420. data/spec/models/volumes_v40_config_get_volume_group_api_response_spec.rb +42 -0
  421. data/spec/models/volumes_v40_config_get_volume_group_metadata_api_response_data_spec.rb +32 -0
  422. data/spec/models/volumes_v40_config_get_volume_group_metadata_api_response_spec.rb +42 -0
  423. data/spec/models/volumes_v40_config_iscsi_client_attachment_spec.rb +42 -0
  424. data/spec/models/volumes_v40_config_iscsi_client_spec.rb +96 -0
  425. data/spec/models/volumes_v40_config_iscsi_features_spec.rb +42 -0
  426. data/spec/models/volumes_v40_config_list_category_associations_api_response_data_spec.rb +32 -0
  427. data/spec/models/volumes_v40_config_list_category_associations_api_response_spec.rb +42 -0
  428. data/spec/models/volumes_v40_config_list_external_iscsi_attachments_api_response_data_spec.rb +32 -0
  429. data/spec/models/volumes_v40_config_list_external_iscsi_attachments_api_response_spec.rb +42 -0
  430. data/spec/models/volumes_v40_config_list_iscsi_clients_api_response_data_spec.rb +32 -0
  431. data/spec/models/volumes_v40_config_list_iscsi_clients_api_response_spec.rb +42 -0
  432. data/spec/models/volumes_v40_config_list_vm_attachments_api_response_data_spec.rb +32 -0
  433. data/spec/models/volumes_v40_config_list_vm_attachments_api_response_spec.rb +42 -0
  434. data/spec/models/volumes_v40_config_list_volume_disks_api_response_data_spec.rb +32 -0
  435. data/spec/models/volumes_v40_config_list_volume_disks_api_response_spec.rb +42 -0
  436. data/spec/models/volumes_v40_config_list_volume_groups_api_response_data_spec.rb +32 -0
  437. data/spec/models/volumes_v40_config_list_volume_groups_api_response_spec.rb +42 -0
  438. data/spec/models/volumes_v40_config_migrate_volume_group_api_response_spec.rb +42 -0
  439. data/spec/models/volumes_v40_config_nvmf_client_attachment_spec.rb +54 -0
  440. data/spec/models/volumes_v40_config_nvmf_client_spec.rb +66 -0
  441. data/spec/models/volumes_v40_config_pause_volume_group_synchronous_replication_api_response_spec.rb +42 -0
  442. data/spec/models/volumes_v40_config_protocol_spec.rb +30 -0
  443. data/spec/models/volumes_v40_config_resume_volume_group_synchronous_replication_api_response_data_spec.rb +32 -0
  444. data/spec/models/volumes_v40_config_resume_volume_group_synchronous_replication_api_response_spec.rb +42 -0
  445. data/spec/models/volumes_v40_config_revert_spec_spec.rb +36 -0
  446. data/spec/models/volumes_v40_config_revert_volume_group_api_response_spec.rb +42 -0
  447. data/spec/models/volumes_v40_config_sharing_status_spec.rb +30 -0
  448. data/spec/models/volumes_v40_config_storage_features_spec.rb +36 -0
  449. data/spec/models/volumes_v40_config_target_param_spec.rb +42 -0
  450. data/spec/models/volumes_v40_config_update_iscsi_client_api_response_data_spec.rb +32 -0
  451. data/spec/models/volumes_v40_config_update_iscsi_client_api_response_spec.rb +42 -0
  452. data/spec/models/volumes_v40_config_update_iscsi_client_by_id_api_response_spec.rb +42 -0
  453. data/spec/models/volumes_v40_config_update_volume_disk_api_response_spec.rb +42 -0
  454. data/spec/models/volumes_v40_config_update_volume_disk_by_id_api_response_spec.rb +42 -0
  455. data/spec/models/volumes_v40_config_update_volume_group_api_response_spec.rb +42 -0
  456. data/spec/models/volumes_v40_config_update_volume_group_by_id_api_response_spec.rb +42 -0
  457. data/spec/models/volumes_v40_config_update_volume_group_metadata_api_response_spec.rb +42 -0
  458. data/spec/models/volumes_v40_config_update_volume_group_metadata_info_api_response_spec.rb +42 -0
  459. data/spec/models/volumes_v40_config_usage_type_spec.rb +30 -0
  460. data/spec/models/volumes_v40_config_vm_attachment_spec.rb +42 -0
  461. data/spec/models/volumes_v40_config_volume_disk_spec.rb +84 -0
  462. data/spec/models/volumes_v40_config_volume_group_attachment_site_spec.rb +30 -0
  463. data/spec/models/volumes_v40_config_volume_group_metadata_spec.rb +42 -0
  464. data/spec/models/volumes_v40_config_volume_group_spec.rb +144 -0
  465. data/spec/models/volumes_v40_error_app_message_spec.rb +66 -0
  466. data/spec/models/volumes_v40_error_error_response_error_spec.rb +32 -0
  467. data/spec/models/volumes_v40_error_error_response_spec.rb +36 -0
  468. data/spec/models/volumes_v40_error_message_severity_spec.rb +30 -0
  469. data/spec/models/volumes_v40_error_schema_validation_error_message_spec.rb +48 -0
  470. data/spec/models/volumes_v40_error_schema_validation_error_spec.rb +60 -0
  471. data/spec/models/volumes_v40_stats_get_volume_disk_stats_api_response_data_spec.rb +32 -0
  472. data/spec/models/volumes_v40_stats_get_volume_disk_stats_api_response_spec.rb +42 -0
  473. data/spec/models/volumes_v40_stats_get_volume_group_stats_api_response_data_spec.rb +32 -0
  474. data/spec/models/volumes_v40_stats_get_volume_group_stats_api_response_spec.rb +42 -0
  475. data/spec/models/volumes_v40_stats_time_value_pair_spec.rb +42 -0
  476. data/spec/models/volumes_v40_stats_volume_disk_stats_spec.rb +114 -0
  477. data/spec/models/volumes_v40_stats_volume_group_stats_spec.rb +114 -0
  478. data/spec/spec_helper.rb +111 -0
  479. data/swagger-volumes-v4.0-all.yaml +8140 -0
  480. metadata +714 -0
@@ -0,0 +1,1887 @@
1
+ # NutanixVolumes::VolumeGroupsApi
2
+
3
+ All URIs are relative to *https://:9440/api*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**associate_category**](VolumeGroupsApi.md#associate_category) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/associate-category | Associate category to a Volume Group |
8
+ | [**attach_iscsi_client**](VolumeGroupsApi.md#attach_iscsi_client) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/attach-iscsi-client | Attach an iSCSI client to the given Volume Group |
9
+ | [**attach_vm**](VolumeGroupsApi.md#attach_vm) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/attach-vm | Attach an AHV VM to the given Volume Group |
10
+ | [**create_volume_disk**](VolumeGroupsApi.md#create_volume_disk) | **POST** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks | Creates a new Volume Disk |
11
+ | [**create_volume_group**](VolumeGroupsApi.md#create_volume_group) | **POST** /volumes/v4.0/config/volume-groups | Creates a new Volume Group |
12
+ | [**delete_volume_disk_by_id**](VolumeGroupsApi.md#delete_volume_disk_by_id) | **DELETE** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks/{extId} | Delete a Volume Disk |
13
+ | [**delete_volume_group_by_id**](VolumeGroupsApi.md#delete_volume_group_by_id) | **DELETE** /volumes/v4.0/config/volume-groups/{extId} | Delete the Volume Group |
14
+ | [**detach_iscsi_client**](VolumeGroupsApi.md#detach_iscsi_client) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/detach-iscsi-client | Detach an iSCSi client from the given Volume Group |
15
+ | [**detach_vm**](VolumeGroupsApi.md#detach_vm) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/detach-vm | Detach an AHV VM from the given Volume Group |
16
+ | [**disassociate_category**](VolumeGroupsApi.md#disassociate_category) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/disassociate-category | Disassociate category from a Volume Group |
17
+ | [**get_volume_disk_by_id**](VolumeGroupsApi.md#get_volume_disk_by_id) | **GET** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks/{extId} | Get the details of a Volume Disk |
18
+ | [**get_volume_disk_stats**](VolumeGroupsApi.md#get_volume_disk_stats) | **GET** /volumes/v4.0/stats/volume-groups/{volumeGroupExtId}/disks/{extId} | Get statistics for a Volume Disk |
19
+ | [**get_volume_group_by_id**](VolumeGroupsApi.md#get_volume_group_by_id) | **GET** /volumes/v4.0/config/volume-groups/{extId} | Get a Volume Group |
20
+ | [**get_volume_group_metadata_by_id**](VolumeGroupsApi.md#get_volume_group_metadata_by_id) | **GET** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/metadata | Fetch metadata information associated with a Volume Group. |
21
+ | [**get_volume_group_stats**](VolumeGroupsApi.md#get_volume_group_stats) | **GET** /volumes/v4.0/stats/volume-groups/{extId} | Get statistics for a Volume Group |
22
+ | [**list_category_associations_by_volume_group_id**](VolumeGroupsApi.md#list_category_associations_by_volume_group_id) | **GET** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/category-associations | List all the category details that are associated with the Volume Group |
23
+ | [**list_external_iscsi_attachments_by_volume_group_id**](VolumeGroupsApi.md#list_external_iscsi_attachments_by_volume_group_id) | **GET** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/external-iscsi-attachments | List all the iSCSI attachments associated with the given Volume Group |
24
+ | [**list_vm_attachments_by_volume_group_id**](VolumeGroupsApi.md#list_vm_attachments_by_volume_group_id) | **GET** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/vm-attachments | List all the VM attachments for a Volume Group |
25
+ | [**list_volume_disks_by_volume_group_id**](VolumeGroupsApi.md#list_volume_disks_by_volume_group_id) | **GET** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks | List all the Volume Disks attached to the Volume Group |
26
+ | [**list_volume_groups**](VolumeGroupsApi.md#list_volume_groups) | **GET** /volumes/v4.0/config/volume-groups | List all the Volume Groups |
27
+ | [**revert_volume_group**](VolumeGroupsApi.md#revert_volume_group) | **POST** /volumes/v4.0/config/volume-groups/{extId}/$actions/revert | Revert a Volume Group |
28
+ | [**update_volume_disk_by_id**](VolumeGroupsApi.md#update_volume_disk_by_id) | **PUT** /volumes/v4.0/config/volume-groups/{volumeGroupExtId}/disks/{extId} | Update a specified Volume Disk |
29
+ | [**update_volume_group_by_id**](VolumeGroupsApi.md#update_volume_group_by_id) | **PUT** /volumes/v4.0/config/volume-groups/{extId} | Update details of a specified Volume Group |
30
+
31
+
32
+ ## associate_category
33
+
34
+ > <AssociateCategory202Response> associate_category(ext_id, volumes_v40_config_category_entity_references)
35
+
36
+ Associate category to a Volume Group
37
+
38
+ Associates a category to a Volume Group identified by {extId}.
39
+
40
+ ### Examples
41
+
42
+ ```ruby
43
+ require 'time'
44
+ require 'nutanix_volumes'
45
+ # setup authorization
46
+ NutanixVolumes.configure do |config|
47
+ # Configure API key authorization: apiKeyAuthScheme
48
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
49
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
50
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
51
+
52
+ # Configure HTTP basic authorization: basicAuthScheme
53
+ config.username = 'YOUR USERNAME'
54
+ config.password = 'YOUR PASSWORD'
55
+ end
56
+
57
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
58
+ ext_id = '54d75100-6542-4136-9437-c87f8ff5b4b1' # String | The external identifier of a Volume Group.
59
+ volumes_v40_config_category_entity_references = NutanixVolumes::VolumesV40ConfigCategoryEntityReferences.new # VolumesV40ConfigCategoryEntityReferences | The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field.
60
+
61
+ begin
62
+ # Associate category to a Volume Group
63
+ result = api_instance.associate_category(ext_id, volumes_v40_config_category_entity_references)
64
+ p result
65
+ rescue NutanixVolumes::ApiError => e
66
+ puts "Error when calling VolumeGroupsApi->associate_category: #{e}"
67
+ end
68
+ ```
69
+
70
+ #### Using the associate_category_with_http_info variant
71
+
72
+ This returns an Array which contains the response data, status code and headers.
73
+
74
+ > <Array(<AssociateCategory202Response>, Integer, Hash)> associate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references)
75
+
76
+ ```ruby
77
+ begin
78
+ # Associate category to a Volume Group
79
+ data, status_code, headers = api_instance.associate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references)
80
+ p status_code # => 2xx
81
+ p headers # => { ... }
82
+ p data # => <AssociateCategory202Response>
83
+ rescue NutanixVolumes::ApiError => e
84
+ puts "Error when calling VolumeGroupsApi->associate_category_with_http_info: #{e}"
85
+ end
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ | Name | Type | Description | Notes |
91
+ | ---- | ---- | ----------- | ----- |
92
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
93
+ | **volumes_v40_config_category_entity_references** | [**VolumesV40ConfigCategoryEntityReferences**](VolumesV40ConfigCategoryEntityReferences.md) | The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field. | |
94
+
95
+ ### Return type
96
+
97
+ [**AssociateCategory202Response**](AssociateCategory202Response.md)
98
+
99
+ ### Authorization
100
+
101
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: application/json
106
+ - **Accept**: application/json
107
+
108
+
109
+ ## attach_iscsi_client
110
+
111
+ > <AttachIscsiClient202Response> attach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client)
112
+
113
+ Attach an iSCSI client to the given Volume Group
114
+
115
+ Attaches iSCSI initiator to a Volume Group identified by {extId}.
116
+
117
+ ### Examples
118
+
119
+ ```ruby
120
+ require 'time'
121
+ require 'nutanix_volumes'
122
+ # setup authorization
123
+ NutanixVolumes.configure do |config|
124
+ # Configure API key authorization: apiKeyAuthScheme
125
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
126
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
127
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
128
+
129
+ # Configure HTTP basic authorization: basicAuthScheme
130
+ config.username = 'YOUR USERNAME'
131
+ config.password = 'YOUR PASSWORD'
132
+ end
133
+
134
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
135
+ ext_id = '629ecbdf-2378-4056-b031-6f2c0e0c29fc' # String | The external identifier of a Volume Group.
136
+ ntnx_request_id = '5ad58356-ab16-42b9-8e46-5e0c55228610' # 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.
137
+ volumes_v40_config_iscsi_client = NutanixVolumes::VolumesV40ConfigIscsiClient.new # VolumesV40ConfigIscsiClient | A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment.
138
+
139
+ begin
140
+ # Attach an iSCSI client to the given Volume Group
141
+ result = api_instance.attach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client)
142
+ p result
143
+ rescue NutanixVolumes::ApiError => e
144
+ puts "Error when calling VolumeGroupsApi->attach_iscsi_client: #{e}"
145
+ end
146
+ ```
147
+
148
+ #### Using the attach_iscsi_client_with_http_info variant
149
+
150
+ This returns an Array which contains the response data, status code and headers.
151
+
152
+ > <Array(<AttachIscsiClient202Response>, Integer, Hash)> attach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client)
153
+
154
+ ```ruby
155
+ begin
156
+ # Attach an iSCSI client to the given Volume Group
157
+ data, status_code, headers = api_instance.attach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client)
158
+ p status_code # => 2xx
159
+ p headers # => { ... }
160
+ p data # => <AttachIscsiClient202Response>
161
+ rescue NutanixVolumes::ApiError => e
162
+ puts "Error when calling VolumeGroupsApi->attach_iscsi_client_with_http_info: #{e}"
163
+ end
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ | Name | Type | Description | Notes |
169
+ | ---- | ---- | ----------- | ----- |
170
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
171
+ | **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. | |
172
+ | **volumes_v40_config_iscsi_client** | [**VolumesV40ConfigIscsiClient**](VolumesV40ConfigIscsiClient.md) | A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment. | |
173
+
174
+ ### Return type
175
+
176
+ [**AttachIscsiClient202Response**](AttachIscsiClient202Response.md)
177
+
178
+ ### Authorization
179
+
180
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
181
+
182
+ ### HTTP request headers
183
+
184
+ - **Content-Type**: application/json
185
+ - **Accept**: application/json
186
+
187
+
188
+ ## attach_vm
189
+
190
+ > <AttachVm202Response> attach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
191
+
192
+ Attach an AHV VM to the given Volume Group
193
+
194
+ Attaches VM to a Volume Group identified by {extId}.
195
+
196
+ ### Examples
197
+
198
+ ```ruby
199
+ require 'time'
200
+ require 'nutanix_volumes'
201
+ # setup authorization
202
+ NutanixVolumes.configure do |config|
203
+ # Configure API key authorization: apiKeyAuthScheme
204
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
205
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
206
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
207
+
208
+ # Configure HTTP basic authorization: basicAuthScheme
209
+ config.username = 'YOUR USERNAME'
210
+ config.password = 'YOUR PASSWORD'
211
+ end
212
+
213
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
214
+ ext_id = '1cdb5b48-fb2c-41b6-b751-b504117ee3e2' # String | The external identifier of a Volume Group.
215
+ ntnx_request_id = '3a9ce3a7-e6e6-4001-8826-3e83b1e51868' # 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.
216
+ volumes_v40_config_vm_attachment = NutanixVolumes::VolumesV40ConfigVmAttachment.new({ext_id: '1eafb1ad-21a1-4c3d-81da-1a99d3c05c72'}) # VolumesV40ConfigVmAttachment | A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment.
217
+
218
+ begin
219
+ # Attach an AHV VM to the given Volume Group
220
+ result = api_instance.attach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
221
+ p result
222
+ rescue NutanixVolumes::ApiError => e
223
+ puts "Error when calling VolumeGroupsApi->attach_vm: #{e}"
224
+ end
225
+ ```
226
+
227
+ #### Using the attach_vm_with_http_info variant
228
+
229
+ This returns an Array which contains the response data, status code and headers.
230
+
231
+ > <Array(<AttachVm202Response>, Integer, Hash)> attach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
232
+
233
+ ```ruby
234
+ begin
235
+ # Attach an AHV VM to the given Volume Group
236
+ data, status_code, headers = api_instance.attach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
237
+ p status_code # => 2xx
238
+ p headers # => { ... }
239
+ p data # => <AttachVm202Response>
240
+ rescue NutanixVolumes::ApiError => e
241
+ puts "Error when calling VolumeGroupsApi->attach_vm_with_http_info: #{e}"
242
+ end
243
+ ```
244
+
245
+ ### Parameters
246
+
247
+ | Name | Type | Description | Notes |
248
+ | ---- | ---- | ----------- | ----- |
249
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
250
+ | **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. | |
251
+ | **volumes_v40_config_vm_attachment** | [**VolumesV40ConfigVmAttachment**](VolumesV40ConfigVmAttachment.md) | A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment. | |
252
+
253
+ ### Return type
254
+
255
+ [**AttachVm202Response**](AttachVm202Response.md)
256
+
257
+ ### Authorization
258
+
259
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
260
+
261
+ ### HTTP request headers
262
+
263
+ - **Content-Type**: application/json
264
+ - **Accept**: application/json
265
+
266
+
267
+ ## create_volume_disk
268
+
269
+ > <CreateVolumeDisk202Response> create_volume_disk(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk)
270
+
271
+ Creates a new Volume Disk
272
+
273
+ Creates a new Volume Disk.
274
+
275
+ ### Examples
276
+
277
+ ```ruby
278
+ require 'time'
279
+ require 'nutanix_volumes'
280
+ # setup authorization
281
+ NutanixVolumes.configure do |config|
282
+ # Configure API key authorization: apiKeyAuthScheme
283
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
284
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
285
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
286
+
287
+ # Configure HTTP basic authorization: basicAuthScheme
288
+ config.username = 'YOUR USERNAME'
289
+ config.password = 'YOUR PASSWORD'
290
+ end
291
+
292
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
293
+ volume_group_ext_id = 'cf7de8b9-88ed-477d-a602-c34ab7174c01' # String | The external identifier of a Volume Group.
294
+ ntnx_request_id = 'f417325e-35f5-4e77-a7a9-c00f5eb3a2d6' # 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.
295
+ volumes_v40_config_volume_disk = NutanixVolumes::VolumesV40ConfigVolumeDisk.new # VolumesV40ConfigVolumeDisk | A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF.
296
+
297
+ begin
298
+ # Creates a new Volume Disk
299
+ result = api_instance.create_volume_disk(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk)
300
+ p result
301
+ rescue NutanixVolumes::ApiError => e
302
+ puts "Error when calling VolumeGroupsApi->create_volume_disk: #{e}"
303
+ end
304
+ ```
305
+
306
+ #### Using the create_volume_disk_with_http_info variant
307
+
308
+ This returns an Array which contains the response data, status code and headers.
309
+
310
+ > <Array(<CreateVolumeDisk202Response>, Integer, Hash)> create_volume_disk_with_http_info(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk)
311
+
312
+ ```ruby
313
+ begin
314
+ # Creates a new Volume Disk
315
+ data, status_code, headers = api_instance.create_volume_disk_with_http_info(volume_group_ext_id, ntnx_request_id, volumes_v40_config_volume_disk)
316
+ p status_code # => 2xx
317
+ p headers # => { ... }
318
+ p data # => <CreateVolumeDisk202Response>
319
+ rescue NutanixVolumes::ApiError => e
320
+ puts "Error when calling VolumeGroupsApi->create_volume_disk_with_http_info: #{e}"
321
+ end
322
+ ```
323
+
324
+ ### Parameters
325
+
326
+ | Name | Type | Description | Notes |
327
+ | ---- | ---- | ----------- | ----- |
328
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
329
+ | **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. | |
330
+ | **volumes_v40_config_volume_disk** | [**VolumesV40ConfigVolumeDisk**](VolumesV40ConfigVolumeDisk.md) | A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF. | |
331
+
332
+ ### Return type
333
+
334
+ [**CreateVolumeDisk202Response**](CreateVolumeDisk202Response.md)
335
+
336
+ ### Authorization
337
+
338
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
339
+
340
+ ### HTTP request headers
341
+
342
+ - **Content-Type**: application/json
343
+ - **Accept**: application/json
344
+
345
+
346
+ ## create_volume_group
347
+
348
+ > <CreateVolumeGroup202Response> create_volume_group(ntnx_request_id, volumes_v40_config_volume_group)
349
+
350
+ Creates a new Volume Group
351
+
352
+ Creates a new Volume Group.
353
+
354
+ ### Examples
355
+
356
+ ```ruby
357
+ require 'time'
358
+ require 'nutanix_volumes'
359
+ # setup authorization
360
+ NutanixVolumes.configure do |config|
361
+ # Configure API key authorization: apiKeyAuthScheme
362
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
363
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
364
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
365
+
366
+ # Configure HTTP basic authorization: basicAuthScheme
367
+ config.username = 'YOUR USERNAME'
368
+ config.password = 'YOUR PASSWORD'
369
+ end
370
+
371
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
372
+ ntnx_request_id = '19b737b6-1fa1-4e19-9016-361ce80999a5' # 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.
373
+ volumes_v40_config_volume_group = NutanixVolumes::VolumesV40ConfigVolumeGroup.new # VolumesV40ConfigVolumeGroup | A model that represents a Volume Group resource.
374
+
375
+ begin
376
+ # Creates a new Volume Group
377
+ result = api_instance.create_volume_group(ntnx_request_id, volumes_v40_config_volume_group)
378
+ p result
379
+ rescue NutanixVolumes::ApiError => e
380
+ puts "Error when calling VolumeGroupsApi->create_volume_group: #{e}"
381
+ end
382
+ ```
383
+
384
+ #### Using the create_volume_group_with_http_info variant
385
+
386
+ This returns an Array which contains the response data, status code and headers.
387
+
388
+ > <Array(<CreateVolumeGroup202Response>, Integer, Hash)> create_volume_group_with_http_info(ntnx_request_id, volumes_v40_config_volume_group)
389
+
390
+ ```ruby
391
+ begin
392
+ # Creates a new Volume Group
393
+ data, status_code, headers = api_instance.create_volume_group_with_http_info(ntnx_request_id, volumes_v40_config_volume_group)
394
+ p status_code # => 2xx
395
+ p headers # => { ... }
396
+ p data # => <CreateVolumeGroup202Response>
397
+ rescue NutanixVolumes::ApiError => e
398
+ puts "Error when calling VolumeGroupsApi->create_volume_group_with_http_info: #{e}"
399
+ end
400
+ ```
401
+
402
+ ### Parameters
403
+
404
+ | Name | Type | Description | Notes |
405
+ | ---- | ---- | ----------- | ----- |
406
+ | **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. | |
407
+ | **volumes_v40_config_volume_group** | [**VolumesV40ConfigVolumeGroup**](VolumesV40ConfigVolumeGroup.md) | A model that represents a Volume Group resource. | |
408
+
409
+ ### Return type
410
+
411
+ [**CreateVolumeGroup202Response**](CreateVolumeGroup202Response.md)
412
+
413
+ ### Authorization
414
+
415
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
416
+
417
+ ### HTTP request headers
418
+
419
+ - **Content-Type**: application/json
420
+ - **Accept**: application/json
421
+
422
+
423
+ ## delete_volume_disk_by_id
424
+
425
+ > <DeleteVolumeDiskById202Response> delete_volume_disk_by_id(volume_group_ext_id, ext_id, ntnx_request_id)
426
+
427
+ Delete a Volume Disk
428
+
429
+ Deletes a Volume Disk identified by {extId} in the Volume Group identified by {volumeGroupExtId}.
430
+
431
+ ### Examples
432
+
433
+ ```ruby
434
+ require 'time'
435
+ require 'nutanix_volumes'
436
+ # setup authorization
437
+ NutanixVolumes.configure do |config|
438
+ # Configure API key authorization: apiKeyAuthScheme
439
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
440
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
441
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
442
+
443
+ # Configure HTTP basic authorization: basicAuthScheme
444
+ config.username = 'YOUR USERNAME'
445
+ config.password = 'YOUR PASSWORD'
446
+ end
447
+
448
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
449
+ volume_group_ext_id = '924abd43-6bef-4a44-b3b5-16f2ad6fc2a5' # String | The external identifier of a Volume Group.
450
+ ext_id = 'c67de97b-a302-453f-9295-7cd235e7b0db' # String | The external identifier of a Volume Disk.
451
+ ntnx_request_id = '0a4cfff7-ab9c-42c4-bc01-c3b53ab1fb4e' # 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.
452
+
453
+ begin
454
+ # Delete a Volume Disk
455
+ result = api_instance.delete_volume_disk_by_id(volume_group_ext_id, ext_id, ntnx_request_id)
456
+ p result
457
+ rescue NutanixVolumes::ApiError => e
458
+ puts "Error when calling VolumeGroupsApi->delete_volume_disk_by_id: #{e}"
459
+ end
460
+ ```
461
+
462
+ #### Using the delete_volume_disk_by_id_with_http_info variant
463
+
464
+ This returns an Array which contains the response data, status code and headers.
465
+
466
+ > <Array(<DeleteVolumeDiskById202Response>, Integer, Hash)> delete_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, ntnx_request_id)
467
+
468
+ ```ruby
469
+ begin
470
+ # Delete a Volume Disk
471
+ data, status_code, headers = api_instance.delete_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, ntnx_request_id)
472
+ p status_code # => 2xx
473
+ p headers # => { ... }
474
+ p data # => <DeleteVolumeDiskById202Response>
475
+ rescue NutanixVolumes::ApiError => e
476
+ puts "Error when calling VolumeGroupsApi->delete_volume_disk_by_id_with_http_info: #{e}"
477
+ end
478
+ ```
479
+
480
+ ### Parameters
481
+
482
+ | Name | Type | Description | Notes |
483
+ | ---- | ---- | ----------- | ----- |
484
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
485
+ | **ext_id** | **String** | The external identifier of a Volume Disk. | |
486
+ | **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. | |
487
+
488
+ ### Return type
489
+
490
+ [**DeleteVolumeDiskById202Response**](DeleteVolumeDiskById202Response.md)
491
+
492
+ ### Authorization
493
+
494
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: Not defined
499
+ - **Accept**: application/json
500
+
501
+
502
+ ## delete_volume_group_by_id
503
+
504
+ > <DeleteVolumeGroupById202Response> delete_volume_group_by_id(ext_id, ntnx_request_id)
505
+
506
+ Delete the Volume Group
507
+
508
+ Delete the Volume Group identified by {extId}.
509
+
510
+ ### Examples
511
+
512
+ ```ruby
513
+ require 'time'
514
+ require 'nutanix_volumes'
515
+ # setup authorization
516
+ NutanixVolumes.configure do |config|
517
+ # Configure API key authorization: apiKeyAuthScheme
518
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
519
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
520
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
521
+
522
+ # Configure HTTP basic authorization: basicAuthScheme
523
+ config.username = 'YOUR USERNAME'
524
+ config.password = 'YOUR PASSWORD'
525
+ end
526
+
527
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
528
+ ext_id = 'ccf79021-64c1-49aa-8abb-3bf328a0556e' # String | The external identifier of a Volume Group.
529
+ ntnx_request_id = '0ff16953-91de-4cf4-9e9e-7a7f3ef6cacb' # 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.
530
+
531
+ begin
532
+ # Delete the Volume Group
533
+ result = api_instance.delete_volume_group_by_id(ext_id, ntnx_request_id)
534
+ p result
535
+ rescue NutanixVolumes::ApiError => e
536
+ puts "Error when calling VolumeGroupsApi->delete_volume_group_by_id: #{e}"
537
+ end
538
+ ```
539
+
540
+ #### Using the delete_volume_group_by_id_with_http_info variant
541
+
542
+ This returns an Array which contains the response data, status code and headers.
543
+
544
+ > <Array(<DeleteVolumeGroupById202Response>, Integer, Hash)> delete_volume_group_by_id_with_http_info(ext_id, ntnx_request_id)
545
+
546
+ ```ruby
547
+ begin
548
+ # Delete the Volume Group
549
+ data, status_code, headers = api_instance.delete_volume_group_by_id_with_http_info(ext_id, ntnx_request_id)
550
+ p status_code # => 2xx
551
+ p headers # => { ... }
552
+ p data # => <DeleteVolumeGroupById202Response>
553
+ rescue NutanixVolumes::ApiError => e
554
+ puts "Error when calling VolumeGroupsApi->delete_volume_group_by_id_with_http_info: #{e}"
555
+ end
556
+ ```
557
+
558
+ ### Parameters
559
+
560
+ | Name | Type | Description | Notes |
561
+ | ---- | ---- | ----------- | ----- |
562
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
563
+ | **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. | |
564
+
565
+ ### Return type
566
+
567
+ [**DeleteVolumeGroupById202Response**](DeleteVolumeGroupById202Response.md)
568
+
569
+ ### Authorization
570
+
571
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
572
+
573
+ ### HTTP request headers
574
+
575
+ - **Content-Type**: Not defined
576
+ - **Accept**: application/json
577
+
578
+
579
+ ## detach_iscsi_client
580
+
581
+ > <DetachIscsiClient202Response> detach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment)
582
+
583
+ Detach an iSCSi client from the given Volume Group
584
+
585
+ Detaches iSCSI initiator identified by {extId} from a Volume Group identified by {volumeGroupExtId}.
586
+
587
+ ### Examples
588
+
589
+ ```ruby
590
+ require 'time'
591
+ require 'nutanix_volumes'
592
+ # setup authorization
593
+ NutanixVolumes.configure do |config|
594
+ # Configure API key authorization: apiKeyAuthScheme
595
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
596
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
597
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
598
+
599
+ # Configure HTTP basic authorization: basicAuthScheme
600
+ config.username = 'YOUR USERNAME'
601
+ config.password = 'YOUR PASSWORD'
602
+ end
603
+
604
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
605
+ ext_id = '8173a21d-2c50-4e1d-a9f4-e7df86ceb2ad' # String | The external identifier of a Volume Group.
606
+ ntnx_request_id = '9c6eb62a-21fa-42a1-9438-5361e76758c2' # 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.
607
+ volumes_v40_config_iscsi_client_attachment = NutanixVolumes::VolumesV40ConfigIscsiClientAttachment.new # 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.
608
+
609
+ begin
610
+ # Detach an iSCSi client from the given Volume Group
611
+ result = api_instance.detach_iscsi_client(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment)
612
+ p result
613
+ rescue NutanixVolumes::ApiError => e
614
+ puts "Error when calling VolumeGroupsApi->detach_iscsi_client: #{e}"
615
+ end
616
+ ```
617
+
618
+ #### Using the detach_iscsi_client_with_http_info variant
619
+
620
+ This returns an Array which contains the response data, status code and headers.
621
+
622
+ > <Array(<DetachIscsiClient202Response>, Integer, Hash)> detach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment)
623
+
624
+ ```ruby
625
+ begin
626
+ # Detach an iSCSi client from the given Volume Group
627
+ data, status_code, headers = api_instance.detach_iscsi_client_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_iscsi_client_attachment)
628
+ p status_code # => 2xx
629
+ p headers # => { ... }
630
+ p data # => <DetachIscsiClient202Response>
631
+ rescue NutanixVolumes::ApiError => e
632
+ puts "Error when calling VolumeGroupsApi->detach_iscsi_client_with_http_info: #{e}"
633
+ end
634
+ ```
635
+
636
+ ### Parameters
637
+
638
+ | Name | Type | Description | Notes |
639
+ | ---- | ---- | ----------- | ----- |
640
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
641
+ | **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. | |
642
+ | **volumes_v40_config_iscsi_client_attachment** | [**VolumesV40ConfigIscsiClientAttachment**](VolumesV40ConfigIscsiClientAttachment.md) | 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. | |
643
+
644
+ ### Return type
645
+
646
+ [**DetachIscsiClient202Response**](DetachIscsiClient202Response.md)
647
+
648
+ ### Authorization
649
+
650
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
651
+
652
+ ### HTTP request headers
653
+
654
+ - **Content-Type**: application/json
655
+ - **Accept**: application/json
656
+
657
+
658
+ ## detach_vm
659
+
660
+ > <DetachVm202Response> detach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
661
+
662
+ Detach an AHV VM from the given Volume Group
663
+
664
+ Detaches VM identified by {extId} from a Volume Group identified by {volumeGroupExtId}.
665
+
666
+ ### Examples
667
+
668
+ ```ruby
669
+ require 'time'
670
+ require 'nutanix_volumes'
671
+ # setup authorization
672
+ NutanixVolumes.configure do |config|
673
+ # Configure API key authorization: apiKeyAuthScheme
674
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
675
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
676
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
677
+
678
+ # Configure HTTP basic authorization: basicAuthScheme
679
+ config.username = 'YOUR USERNAME'
680
+ config.password = 'YOUR PASSWORD'
681
+ end
682
+
683
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
684
+ ext_id = 'd09f033e-c851-4ca4-acfd-5e051b6a4692' # String | The external identifier of a Volume Group.
685
+ ntnx_request_id = 'f8a7f68d-3fec-41d2-9daa-e1036fce507e' # 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.
686
+ volumes_v40_config_vm_attachment = NutanixVolumes::VolumesV40ConfigVmAttachment.new({ext_id: '1eafb1ad-21a1-4c3d-81da-1a99d3c05c72'}) # VolumesV40ConfigVmAttachment | A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment.
687
+
688
+ begin
689
+ # Detach an AHV VM from the given Volume Group
690
+ result = api_instance.detach_vm(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
691
+ p result
692
+ rescue NutanixVolumes::ApiError => e
693
+ puts "Error when calling VolumeGroupsApi->detach_vm: #{e}"
694
+ end
695
+ ```
696
+
697
+ #### Using the detach_vm_with_http_info variant
698
+
699
+ This returns an Array which contains the response data, status code and headers.
700
+
701
+ > <Array(<DetachVm202Response>, Integer, Hash)> detach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
702
+
703
+ ```ruby
704
+ begin
705
+ # Detach an AHV VM from the given Volume Group
706
+ data, status_code, headers = api_instance.detach_vm_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_vm_attachment)
707
+ p status_code # => 2xx
708
+ p headers # => { ... }
709
+ p data # => <DetachVm202Response>
710
+ rescue NutanixVolumes::ApiError => e
711
+ puts "Error when calling VolumeGroupsApi->detach_vm_with_http_info: #{e}"
712
+ end
713
+ ```
714
+
715
+ ### Parameters
716
+
717
+ | Name | Type | Description | Notes |
718
+ | ---- | ---- | ----------- | ----- |
719
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
720
+ | **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. | |
721
+ | **volumes_v40_config_vm_attachment** | [**VolumesV40ConfigVmAttachment**](VolumesV40ConfigVmAttachment.md) | A model that represents a VM reference that can be associated with a Volume Group as an AHV hypervisor attachment. | |
722
+
723
+ ### Return type
724
+
725
+ [**DetachVm202Response**](DetachVm202Response.md)
726
+
727
+ ### Authorization
728
+
729
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
730
+
731
+ ### HTTP request headers
732
+
733
+ - **Content-Type**: application/json
734
+ - **Accept**: application/json
735
+
736
+
737
+ ## disassociate_category
738
+
739
+ > <DisassociateCategory202Response> disassociate_category(ext_id, volumes_v40_config_category_entity_references)
740
+
741
+ Disassociate category from a Volume Group
742
+
743
+ Disassociates a category from a Volume Group identified by {extId}.
744
+
745
+ ### Examples
746
+
747
+ ```ruby
748
+ require 'time'
749
+ require 'nutanix_volumes'
750
+ # setup authorization
751
+ NutanixVolumes.configure do |config|
752
+ # Configure API key authorization: apiKeyAuthScheme
753
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
754
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
755
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
756
+
757
+ # Configure HTTP basic authorization: basicAuthScheme
758
+ config.username = 'YOUR USERNAME'
759
+ config.password = 'YOUR PASSWORD'
760
+ end
761
+
762
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
763
+ ext_id = '3e05bb6a-a87b-45de-96ca-e3dfaaedcc60' # String | The external identifier of a Volume Group.
764
+ volumes_v40_config_category_entity_references = NutanixVolumes::VolumesV40ConfigCategoryEntityReferences.new # VolumesV40ConfigCategoryEntityReferences | The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field.
765
+
766
+ begin
767
+ # Disassociate category from a Volume Group
768
+ result = api_instance.disassociate_category(ext_id, volumes_v40_config_category_entity_references)
769
+ p result
770
+ rescue NutanixVolumes::ApiError => e
771
+ puts "Error when calling VolumeGroupsApi->disassociate_category: #{e}"
772
+ end
773
+ ```
774
+
775
+ #### Using the disassociate_category_with_http_info variant
776
+
777
+ This returns an Array which contains the response data, status code and headers.
778
+
779
+ > <Array(<DisassociateCategory202Response>, Integer, Hash)> disassociate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references)
780
+
781
+ ```ruby
782
+ begin
783
+ # Disassociate category from a Volume Group
784
+ data, status_code, headers = api_instance.disassociate_category_with_http_info(ext_id, volumes_v40_config_category_entity_references)
785
+ p status_code # => 2xx
786
+ p headers # => { ... }
787
+ p data # => <DisassociateCategory202Response>
788
+ rescue NutanixVolumes::ApiError => e
789
+ puts "Error when calling VolumeGroupsApi->disassociate_category_with_http_info: #{e}"
790
+ end
791
+ ```
792
+
793
+ ### Parameters
794
+
795
+ | Name | Type | Description | Notes |
796
+ | ---- | ---- | ----------- | ----- |
797
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
798
+ | **volumes_v40_config_category_entity_references** | [**VolumesV40ConfigCategoryEntityReferences**](VolumesV40ConfigCategoryEntityReferences.md) | The list of categories to be associated/disassociated with the Volume Group. This is a mandatory field. | |
799
+
800
+ ### Return type
801
+
802
+ [**DisassociateCategory202Response**](DisassociateCategory202Response.md)
803
+
804
+ ### Authorization
805
+
806
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
807
+
808
+ ### HTTP request headers
809
+
810
+ - **Content-Type**: application/json
811
+ - **Accept**: application/json
812
+
813
+
814
+ ## get_volume_disk_by_id
815
+
816
+ > <GetVolumeDiskById200Response> get_volume_disk_by_id(volume_group_ext_id, ext_id)
817
+
818
+ Get the details of a Volume Disk
819
+
820
+ Query the Volume Disk identified by {extId} in the Volume Group identified by {volumeGroupExtId}.
821
+
822
+ ### Examples
823
+
824
+ ```ruby
825
+ require 'time'
826
+ require 'nutanix_volumes'
827
+ # setup authorization
828
+ NutanixVolumes.configure do |config|
829
+ # Configure API key authorization: apiKeyAuthScheme
830
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
831
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
832
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
833
+
834
+ # Configure HTTP basic authorization: basicAuthScheme
835
+ config.username = 'YOUR USERNAME'
836
+ config.password = 'YOUR PASSWORD'
837
+ end
838
+
839
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
840
+ volume_group_ext_id = '3770be9d-06be-4e25-b85d-3457d9b0ceb1' # String | The external identifier of a Volume Group.
841
+ ext_id = '1d92110d-26b5-46c0-8c93-20b8171373e0' # String | The external identifier of a Volume Disk.
842
+
843
+ begin
844
+ # Get the details of a Volume Disk
845
+ result = api_instance.get_volume_disk_by_id(volume_group_ext_id, ext_id)
846
+ p result
847
+ rescue NutanixVolumes::ApiError => e
848
+ puts "Error when calling VolumeGroupsApi->get_volume_disk_by_id: #{e}"
849
+ end
850
+ ```
851
+
852
+ #### Using the get_volume_disk_by_id_with_http_info variant
853
+
854
+ This returns an Array which contains the response data, status code and headers.
855
+
856
+ > <Array(<GetVolumeDiskById200Response>, Integer, Hash)> get_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id)
857
+
858
+ ```ruby
859
+ begin
860
+ # Get the details of a Volume Disk
861
+ data, status_code, headers = api_instance.get_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id)
862
+ p status_code # => 2xx
863
+ p headers # => { ... }
864
+ p data # => <GetVolumeDiskById200Response>
865
+ rescue NutanixVolumes::ApiError => e
866
+ puts "Error when calling VolumeGroupsApi->get_volume_disk_by_id_with_http_info: #{e}"
867
+ end
868
+ ```
869
+
870
+ ### Parameters
871
+
872
+ | Name | Type | Description | Notes |
873
+ | ---- | ---- | ----------- | ----- |
874
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
875
+ | **ext_id** | **String** | The external identifier of a Volume Disk. | |
876
+
877
+ ### Return type
878
+
879
+ [**GetVolumeDiskById200Response**](GetVolumeDiskById200Response.md)
880
+
881
+ ### Authorization
882
+
883
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
884
+
885
+ ### HTTP request headers
886
+
887
+ - **Content-Type**: Not defined
888
+ - **Accept**: application/json
889
+
890
+
891
+ ## get_volume_disk_stats
892
+
893
+ > <GetVolumeDiskStats200Response> get_volume_disk_stats(volume_group_ext_id, ext_id, start_time, end_time, opts)
894
+
895
+ Get statistics for a Volume Disk
896
+
897
+ Query the Volume Disk stats identified by {diskExtId}.
898
+
899
+ ### Examples
900
+
901
+ ```ruby
902
+ require 'time'
903
+ require 'nutanix_volumes'
904
+ # setup authorization
905
+ NutanixVolumes.configure do |config|
906
+ # Configure API key authorization: apiKeyAuthScheme
907
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
908
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
909
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
910
+
911
+ # Configure HTTP basic authorization: basicAuthScheme
912
+ config.username = 'YOUR USERNAME'
913
+ config.password = 'YOUR PASSWORD'
914
+ end
915
+
916
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
917
+ volume_group_ext_id = '452d0b7f-b000-4ff7-9d48-911df2585c9a' # String | The external identifier of a Volume Group.
918
+ ext_id = 'cdb79e18-a475-4ab5-80fb-174b6b678e92' # String | The external identifier of a Volume Disk.
919
+ start_time = Time.parse('2009-09-23T14:30-07:00') # 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 https://www.iso.org/standard/70907.html
920
+ end_time = Time.parse('2009-09-23T14:30-07:00') # 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 https://www.iso.org/standard/70907.html
921
+ opts = {
922
+ sampling_interval: 85, # 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.
923
+ stat_type: NutanixVolumes::CommonV10StatsDownSamplingOperator::SUM, # CommonV10StatsDownSamplingOperator |
924
+ select: 'select_example' # 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](https://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
925
+ }
926
+
927
+ begin
928
+ # Get statistics for a Volume Disk
929
+ result = api_instance.get_volume_disk_stats(volume_group_ext_id, ext_id, start_time, end_time, opts)
930
+ p result
931
+ rescue NutanixVolumes::ApiError => e
932
+ puts "Error when calling VolumeGroupsApi->get_volume_disk_stats: #{e}"
933
+ end
934
+ ```
935
+
936
+ #### Using the get_volume_disk_stats_with_http_info variant
937
+
938
+ This returns an Array which contains the response data, status code and headers.
939
+
940
+ > <Array(<GetVolumeDiskStats200Response>, Integer, Hash)> get_volume_disk_stats_with_http_info(volume_group_ext_id, ext_id, start_time, end_time, opts)
941
+
942
+ ```ruby
943
+ begin
944
+ # Get statistics for a Volume Disk
945
+ data, status_code, headers = api_instance.get_volume_disk_stats_with_http_info(volume_group_ext_id, ext_id, start_time, end_time, opts)
946
+ p status_code # => 2xx
947
+ p headers # => { ... }
948
+ p data # => <GetVolumeDiskStats200Response>
949
+ rescue NutanixVolumes::ApiError => e
950
+ puts "Error when calling VolumeGroupsApi->get_volume_disk_stats_with_http_info: #{e}"
951
+ end
952
+ ```
953
+
954
+ ### Parameters
955
+
956
+ | Name | Type | Description | Notes |
957
+ | ---- | ---- | ----------- | ----- |
958
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
959
+ | **ext_id** | **String** | The external identifier of a Volume Disk. | |
960
+ | **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 https://www.iso.org/standard/70907.html | |
961
+ | **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 https://www.iso.org/standard/70907.html | |
962
+ | **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. | [optional] |
963
+ | **stat_type** | [**CommonV10StatsDownSamplingOperator**](.md) | | [optional] |
964
+ | **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](https://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 | [optional] |
965
+
966
+ ### Return type
967
+
968
+ [**GetVolumeDiskStats200Response**](GetVolumeDiskStats200Response.md)
969
+
970
+ ### Authorization
971
+
972
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
973
+
974
+ ### HTTP request headers
975
+
976
+ - **Content-Type**: Not defined
977
+ - **Accept**: application/json
978
+
979
+
980
+ ## get_volume_group_by_id
981
+
982
+ > <GetVolumeGroupById200Response> get_volume_group_by_id(ext_id)
983
+
984
+ Get a Volume Group
985
+
986
+ Query the Volume Group identified by {extId}.
987
+
988
+ ### Examples
989
+
990
+ ```ruby
991
+ require 'time'
992
+ require 'nutanix_volumes'
993
+ # setup authorization
994
+ NutanixVolumes.configure do |config|
995
+ # Configure API key authorization: apiKeyAuthScheme
996
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
997
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
998
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
999
+
1000
+ # Configure HTTP basic authorization: basicAuthScheme
1001
+ config.username = 'YOUR USERNAME'
1002
+ config.password = 'YOUR PASSWORD'
1003
+ end
1004
+
1005
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1006
+ ext_id = 'd09aeec9-5bb7-4bfd-9717-a051178f6e7c' # String | The external identifier of a Volume Group.
1007
+
1008
+ begin
1009
+ # Get a Volume Group
1010
+ result = api_instance.get_volume_group_by_id(ext_id)
1011
+ p result
1012
+ rescue NutanixVolumes::ApiError => e
1013
+ puts "Error when calling VolumeGroupsApi->get_volume_group_by_id: #{e}"
1014
+ end
1015
+ ```
1016
+
1017
+ #### Using the get_volume_group_by_id_with_http_info variant
1018
+
1019
+ This returns an Array which contains the response data, status code and headers.
1020
+
1021
+ > <Array(<GetVolumeGroupById200Response>, Integer, Hash)> get_volume_group_by_id_with_http_info(ext_id)
1022
+
1023
+ ```ruby
1024
+ begin
1025
+ # Get a Volume Group
1026
+ data, status_code, headers = api_instance.get_volume_group_by_id_with_http_info(ext_id)
1027
+ p status_code # => 2xx
1028
+ p headers # => { ... }
1029
+ p data # => <GetVolumeGroupById200Response>
1030
+ rescue NutanixVolumes::ApiError => e
1031
+ puts "Error when calling VolumeGroupsApi->get_volume_group_by_id_with_http_info: #{e}"
1032
+ end
1033
+ ```
1034
+
1035
+ ### Parameters
1036
+
1037
+ | Name | Type | Description | Notes |
1038
+ | ---- | ---- | ----------- | ----- |
1039
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
1040
+
1041
+ ### Return type
1042
+
1043
+ [**GetVolumeGroupById200Response**](GetVolumeGroupById200Response.md)
1044
+
1045
+ ### Authorization
1046
+
1047
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1048
+
1049
+ ### HTTP request headers
1050
+
1051
+ - **Content-Type**: Not defined
1052
+ - **Accept**: application/json
1053
+
1054
+
1055
+ ## get_volume_group_metadata_by_id
1056
+
1057
+ > <GetVolumeGroupMetadataById200Response> get_volume_group_metadata_by_id(volume_group_ext_id)
1058
+
1059
+ Fetch metadata information associated with a Volume Group.
1060
+
1061
+ Query for metadata information which is associated with the Volume Group identified by {extId}.
1062
+
1063
+ ### Examples
1064
+
1065
+ ```ruby
1066
+ require 'time'
1067
+ require 'nutanix_volumes'
1068
+ # setup authorization
1069
+ NutanixVolumes.configure do |config|
1070
+ # Configure API key authorization: apiKeyAuthScheme
1071
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1072
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1073
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1074
+
1075
+ # Configure HTTP basic authorization: basicAuthScheme
1076
+ config.username = 'YOUR USERNAME'
1077
+ config.password = 'YOUR PASSWORD'
1078
+ end
1079
+
1080
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1081
+ volume_group_ext_id = 'ff9d2a26-0380-48e0-8b6b-a5cc76867297' # String | The external identifier of a Volume Group.
1082
+
1083
+ begin
1084
+ # Fetch metadata information associated with a Volume Group.
1085
+ result = api_instance.get_volume_group_metadata_by_id(volume_group_ext_id)
1086
+ p result
1087
+ rescue NutanixVolumes::ApiError => e
1088
+ puts "Error when calling VolumeGroupsApi->get_volume_group_metadata_by_id: #{e}"
1089
+ end
1090
+ ```
1091
+
1092
+ #### Using the get_volume_group_metadata_by_id_with_http_info variant
1093
+
1094
+ This returns an Array which contains the response data, status code and headers.
1095
+
1096
+ > <Array(<GetVolumeGroupMetadataById200Response>, Integer, Hash)> get_volume_group_metadata_by_id_with_http_info(volume_group_ext_id)
1097
+
1098
+ ```ruby
1099
+ begin
1100
+ # Fetch metadata information associated with a Volume Group.
1101
+ data, status_code, headers = api_instance.get_volume_group_metadata_by_id_with_http_info(volume_group_ext_id)
1102
+ p status_code # => 2xx
1103
+ p headers # => { ... }
1104
+ p data # => <GetVolumeGroupMetadataById200Response>
1105
+ rescue NutanixVolumes::ApiError => e
1106
+ puts "Error when calling VolumeGroupsApi->get_volume_group_metadata_by_id_with_http_info: #{e}"
1107
+ end
1108
+ ```
1109
+
1110
+ ### Parameters
1111
+
1112
+ | Name | Type | Description | Notes |
1113
+ | ---- | ---- | ----------- | ----- |
1114
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
1115
+
1116
+ ### Return type
1117
+
1118
+ [**GetVolumeGroupMetadataById200Response**](GetVolumeGroupMetadataById200Response.md)
1119
+
1120
+ ### Authorization
1121
+
1122
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1123
+
1124
+ ### HTTP request headers
1125
+
1126
+ - **Content-Type**: Not defined
1127
+ - **Accept**: application/json
1128
+
1129
+
1130
+ ## get_volume_group_stats
1131
+
1132
+ > <GetVolumeGroupStats200Response> get_volume_group_stats(ext_id, start_time, end_time, opts)
1133
+
1134
+ Get statistics for a Volume Group
1135
+
1136
+ Query the Volume Group stats identified by {extId}.
1137
+
1138
+ ### Examples
1139
+
1140
+ ```ruby
1141
+ require 'time'
1142
+ require 'nutanix_volumes'
1143
+ # setup authorization
1144
+ NutanixVolumes.configure do |config|
1145
+ # Configure API key authorization: apiKeyAuthScheme
1146
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1147
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1148
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1149
+
1150
+ # Configure HTTP basic authorization: basicAuthScheme
1151
+ config.username = 'YOUR USERNAME'
1152
+ config.password = 'YOUR PASSWORD'
1153
+ end
1154
+
1155
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1156
+ ext_id = '4572dfb1-6321-469e-80bc-059771fc6f61' # String | The external identifier of a Volume Group.
1157
+ start_time = Time.parse('2009-09-23T14:30-07:00') # 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 https://www.iso.org/standard/70907.html
1158
+ end_time = Time.parse('2009-09-23T14:30-07:00') # 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 https://www.iso.org/standard/70907.html
1159
+ opts = {
1160
+ sampling_interval: 41, # 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.
1161
+ stat_type: NutanixVolumes::CommonV10StatsDownSamplingOperator::SUM, # CommonV10StatsDownSamplingOperator |
1162
+ select: 'select_example' # 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](https://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
1163
+ }
1164
+
1165
+ begin
1166
+ # Get statistics for a Volume Group
1167
+ result = api_instance.get_volume_group_stats(ext_id, start_time, end_time, opts)
1168
+ p result
1169
+ rescue NutanixVolumes::ApiError => e
1170
+ puts "Error when calling VolumeGroupsApi->get_volume_group_stats: #{e}"
1171
+ end
1172
+ ```
1173
+
1174
+ #### Using the get_volume_group_stats_with_http_info variant
1175
+
1176
+ This returns an Array which contains the response data, status code and headers.
1177
+
1178
+ > <Array(<GetVolumeGroupStats200Response>, Integer, Hash)> get_volume_group_stats_with_http_info(ext_id, start_time, end_time, opts)
1179
+
1180
+ ```ruby
1181
+ begin
1182
+ # Get statistics for a Volume Group
1183
+ data, status_code, headers = api_instance.get_volume_group_stats_with_http_info(ext_id, start_time, end_time, opts)
1184
+ p status_code # => 2xx
1185
+ p headers # => { ... }
1186
+ p data # => <GetVolumeGroupStats200Response>
1187
+ rescue NutanixVolumes::ApiError => e
1188
+ puts "Error when calling VolumeGroupsApi->get_volume_group_stats_with_http_info: #{e}"
1189
+ end
1190
+ ```
1191
+
1192
+ ### Parameters
1193
+
1194
+ | Name | Type | Description | Notes |
1195
+ | ---- | ---- | ----------- | ----- |
1196
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
1197
+ | **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 https://www.iso.org/standard/70907.html | |
1198
+ | **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 https://www.iso.org/standard/70907.html | |
1199
+ | **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. | [optional] |
1200
+ | **stat_type** | [**CommonV10StatsDownSamplingOperator**](.md) | | [optional] |
1201
+ | **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](https://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 | [optional] |
1202
+
1203
+ ### Return type
1204
+
1205
+ [**GetVolumeGroupStats200Response**](GetVolumeGroupStats200Response.md)
1206
+
1207
+ ### Authorization
1208
+
1209
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1210
+
1211
+ ### HTTP request headers
1212
+
1213
+ - **Content-Type**: Not defined
1214
+ - **Accept**: application/json
1215
+
1216
+
1217
+ ## list_category_associations_by_volume_group_id
1218
+
1219
+ > <ListCategoryAssociationsByVolumeGroupId200Response> list_category_associations_by_volume_group_id(volume_group_ext_id, opts)
1220
+
1221
+ List all the category details that are associated with the Volume Group
1222
+
1223
+ Query the category details that are associated with the Volume Group identified by {volumeGroupExtId}.
1224
+
1225
+ ### Examples
1226
+
1227
+ ```ruby
1228
+ require 'time'
1229
+ require 'nutanix_volumes'
1230
+ # setup authorization
1231
+ NutanixVolumes.configure do |config|
1232
+ # Configure API key authorization: apiKeyAuthScheme
1233
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1234
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1235
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1236
+
1237
+ # Configure HTTP basic authorization: basicAuthScheme
1238
+ config.username = 'YOUR USERNAME'
1239
+ config.password = 'YOUR PASSWORD'
1240
+ end
1241
+
1242
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1243
+ volume_group_ext_id = '1424a657-255c-4c8f-ae75-762a6e6c7947' # String | The external identifier of a Volume Group.
1244
+ opts = {
1245
+ page: 56, # 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.
1246
+ limit: 56 # 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.
1247
+ }
1248
+
1249
+ begin
1250
+ # List all the category details that are associated with the Volume Group
1251
+ result = api_instance.list_category_associations_by_volume_group_id(volume_group_ext_id, opts)
1252
+ p result
1253
+ rescue NutanixVolumes::ApiError => e
1254
+ puts "Error when calling VolumeGroupsApi->list_category_associations_by_volume_group_id: #{e}"
1255
+ end
1256
+ ```
1257
+
1258
+ #### Using the list_category_associations_by_volume_group_id_with_http_info variant
1259
+
1260
+ This returns an Array which contains the response data, status code and headers.
1261
+
1262
+ > <Array(<ListCategoryAssociationsByVolumeGroupId200Response>, Integer, Hash)> list_category_associations_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1263
+
1264
+ ```ruby
1265
+ begin
1266
+ # List all the category details that are associated with the Volume Group
1267
+ data, status_code, headers = api_instance.list_category_associations_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1268
+ p status_code # => 2xx
1269
+ p headers # => { ... }
1270
+ p data # => <ListCategoryAssociationsByVolumeGroupId200Response>
1271
+ rescue NutanixVolumes::ApiError => e
1272
+ puts "Error when calling VolumeGroupsApi->list_category_associations_by_volume_group_id_with_http_info: #{e}"
1273
+ end
1274
+ ```
1275
+
1276
+ ### Parameters
1277
+
1278
+ | Name | Type | Description | Notes |
1279
+ | ---- | ---- | ----------- | ----- |
1280
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
1281
+ | **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. | [optional][default to 0] |
1282
+ | **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. | [optional][default to 50] |
1283
+
1284
+ ### Return type
1285
+
1286
+ [**ListCategoryAssociationsByVolumeGroupId200Response**](ListCategoryAssociationsByVolumeGroupId200Response.md)
1287
+
1288
+ ### Authorization
1289
+
1290
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1291
+
1292
+ ### HTTP request headers
1293
+
1294
+ - **Content-Type**: Not defined
1295
+ - **Accept**: application/json
1296
+
1297
+
1298
+ ## list_external_iscsi_attachments_by_volume_group_id
1299
+
1300
+ > <ListExternalIscsiAttachmentsByVolumeGroupId200Response> list_external_iscsi_attachments_by_volume_group_id(volume_group_ext_id, opts)
1301
+
1302
+ List all the iSCSI attachments associated with the given Volume Group
1303
+
1304
+ Query the list of external iSCSI attachments for a Volume Group identified by {extId}.
1305
+
1306
+ ### Examples
1307
+
1308
+ ```ruby
1309
+ require 'time'
1310
+ require 'nutanix_volumes'
1311
+ # setup authorization
1312
+ NutanixVolumes.configure do |config|
1313
+ # Configure API key authorization: apiKeyAuthScheme
1314
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1315
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1316
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1317
+
1318
+ # Configure HTTP basic authorization: basicAuthScheme
1319
+ config.username = 'YOUR USERNAME'
1320
+ config.password = 'YOUR PASSWORD'
1321
+ end
1322
+
1323
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1324
+ volume_group_ext_id = '7feee66b-a334-49ad-ba99-09c93bb5a35d' # String | The external identifier of a Volume Group.
1325
+ opts = {
1326
+ page: 56, # 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.
1327
+ limit: 56, # 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.
1328
+ filter: 'filter_example', # 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: - clusterReference - extId
1329
+ orderby: 'orderby_example', # 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, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - clusterReference - extId
1330
+ expand: 'expand_example', # 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
1331
+ select: 'select_example' # 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](https://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
1332
+ }
1333
+
1334
+ begin
1335
+ # List all the iSCSI attachments associated with the given Volume Group
1336
+ result = api_instance.list_external_iscsi_attachments_by_volume_group_id(volume_group_ext_id, opts)
1337
+ p result
1338
+ rescue NutanixVolumes::ApiError => e
1339
+ puts "Error when calling VolumeGroupsApi->list_external_iscsi_attachments_by_volume_group_id: #{e}"
1340
+ end
1341
+ ```
1342
+
1343
+ #### Using the list_external_iscsi_attachments_by_volume_group_id_with_http_info variant
1344
+
1345
+ This returns an Array which contains the response data, status code and headers.
1346
+
1347
+ > <Array(<ListExternalIscsiAttachmentsByVolumeGroupId200Response>, Integer, Hash)> list_external_iscsi_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1348
+
1349
+ ```ruby
1350
+ begin
1351
+ # List all the iSCSI attachments associated with the given Volume Group
1352
+ data, status_code, headers = api_instance.list_external_iscsi_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1353
+ p status_code # => 2xx
1354
+ p headers # => { ... }
1355
+ p data # => <ListExternalIscsiAttachmentsByVolumeGroupId200Response>
1356
+ rescue NutanixVolumes::ApiError => e
1357
+ puts "Error when calling VolumeGroupsApi->list_external_iscsi_attachments_by_volume_group_id_with_http_info: #{e}"
1358
+ end
1359
+ ```
1360
+
1361
+ ### Parameters
1362
+
1363
+ | Name | Type | Description | Notes |
1364
+ | ---- | ---- | ----------- | ----- |
1365
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
1366
+ | **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. | [optional][default to 0] |
1367
+ | **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. | [optional][default to 50] |
1368
+ | **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](https://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 | [optional] |
1369
+ | **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 | [optional] |
1370
+ | **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 | [optional] |
1371
+ | **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](https://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 | [optional] |
1372
+
1373
+ ### Return type
1374
+
1375
+ [**ListExternalIscsiAttachmentsByVolumeGroupId200Response**](ListExternalIscsiAttachmentsByVolumeGroupId200Response.md)
1376
+
1377
+ ### Authorization
1378
+
1379
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1380
+
1381
+ ### HTTP request headers
1382
+
1383
+ - **Content-Type**: Not defined
1384
+ - **Accept**: application/json
1385
+
1386
+
1387
+ ## list_vm_attachments_by_volume_group_id
1388
+
1389
+ > <ListVmAttachmentsByVolumeGroupId200Response> list_vm_attachments_by_volume_group_id(volume_group_ext_id, opts)
1390
+
1391
+ List all the VM attachments for a Volume Group
1392
+
1393
+ Query the list of VM attachments for a Volume Group identified by {extId}.
1394
+
1395
+ ### Examples
1396
+
1397
+ ```ruby
1398
+ require 'time'
1399
+ require 'nutanix_volumes'
1400
+ # setup authorization
1401
+ NutanixVolumes.configure do |config|
1402
+ # Configure API key authorization: apiKeyAuthScheme
1403
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1404
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1405
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1406
+
1407
+ # Configure HTTP basic authorization: basicAuthScheme
1408
+ config.username = 'YOUR USERNAME'
1409
+ config.password = 'YOUR PASSWORD'
1410
+ end
1411
+
1412
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1413
+ volume_group_ext_id = '1e3ab246-d742-4b38-b366-5972476daa98' # String | The external identifier of a Volume Group.
1414
+ opts = {
1415
+ page: 56, # 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.
1416
+ limit: 56, # 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.
1417
+ filter: 'filter_example', # 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: - extId
1418
+ orderby: 'orderby_example' # 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, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - extId
1419
+ }
1420
+
1421
+ begin
1422
+ # List all the VM attachments for a Volume Group
1423
+ result = api_instance.list_vm_attachments_by_volume_group_id(volume_group_ext_id, opts)
1424
+ p result
1425
+ rescue NutanixVolumes::ApiError => e
1426
+ puts "Error when calling VolumeGroupsApi->list_vm_attachments_by_volume_group_id: #{e}"
1427
+ end
1428
+ ```
1429
+
1430
+ #### Using the list_vm_attachments_by_volume_group_id_with_http_info variant
1431
+
1432
+ This returns an Array which contains the response data, status code and headers.
1433
+
1434
+ > <Array(<ListVmAttachmentsByVolumeGroupId200Response>, Integer, Hash)> list_vm_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1435
+
1436
+ ```ruby
1437
+ begin
1438
+ # List all the VM attachments for a Volume Group
1439
+ data, status_code, headers = api_instance.list_vm_attachments_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1440
+ p status_code # => 2xx
1441
+ p headers # => { ... }
1442
+ p data # => <ListVmAttachmentsByVolumeGroupId200Response>
1443
+ rescue NutanixVolumes::ApiError => e
1444
+ puts "Error when calling VolumeGroupsApi->list_vm_attachments_by_volume_group_id_with_http_info: #{e}"
1445
+ end
1446
+ ```
1447
+
1448
+ ### Parameters
1449
+
1450
+ | Name | Type | Description | Notes |
1451
+ | ---- | ---- | ----------- | ----- |
1452
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
1453
+ | **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. | [optional][default to 0] |
1454
+ | **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. | [optional][default to 50] |
1455
+ | **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](https://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 | [optional] |
1456
+ | **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 | [optional] |
1457
+
1458
+ ### Return type
1459
+
1460
+ [**ListVmAttachmentsByVolumeGroupId200Response**](ListVmAttachmentsByVolumeGroupId200Response.md)
1461
+
1462
+ ### Authorization
1463
+
1464
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1465
+
1466
+ ### HTTP request headers
1467
+
1468
+ - **Content-Type**: Not defined
1469
+ - **Accept**: application/json
1470
+
1471
+
1472
+ ## list_volume_disks_by_volume_group_id
1473
+
1474
+ > <ListVolumeDisksByVolumeGroupId200Response> list_volume_disks_by_volume_group_id(volume_group_ext_id, opts)
1475
+
1476
+ List all the Volume Disks attached to the Volume Group
1477
+
1478
+ Query the list of disks corresponding to a Volume Group identified by {volumeGroupExtId}.
1479
+
1480
+ ### Examples
1481
+
1482
+ ```ruby
1483
+ require 'time'
1484
+ require 'nutanix_volumes'
1485
+ # setup authorization
1486
+ NutanixVolumes.configure do |config|
1487
+ # Configure API key authorization: apiKeyAuthScheme
1488
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1489
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1490
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1491
+
1492
+ # Configure HTTP basic authorization: basicAuthScheme
1493
+ config.username = 'YOUR USERNAME'
1494
+ config.password = 'YOUR PASSWORD'
1495
+ end
1496
+
1497
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1498
+ volume_group_ext_id = '07c2da68-bb67-4535-9b2a-81504f6bb2e3' # String | The external identifier of a Volume Group.
1499
+ opts = {
1500
+ page: 56, # 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.
1501
+ limit: 56, # 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.
1502
+ filter: 'filter_example', # 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: - storageContainerId
1503
+ orderby: 'orderby_example', # 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, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - diskSizeBytes
1504
+ select: 'select_example' # 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](https://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
1505
+ }
1506
+
1507
+ begin
1508
+ # List all the Volume Disks attached to the Volume Group
1509
+ result = api_instance.list_volume_disks_by_volume_group_id(volume_group_ext_id, opts)
1510
+ p result
1511
+ rescue NutanixVolumes::ApiError => e
1512
+ puts "Error when calling VolumeGroupsApi->list_volume_disks_by_volume_group_id: #{e}"
1513
+ end
1514
+ ```
1515
+
1516
+ #### Using the list_volume_disks_by_volume_group_id_with_http_info variant
1517
+
1518
+ This returns an Array which contains the response data, status code and headers.
1519
+
1520
+ > <Array(<ListVolumeDisksByVolumeGroupId200Response>, Integer, Hash)> list_volume_disks_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1521
+
1522
+ ```ruby
1523
+ begin
1524
+ # List all the Volume Disks attached to the Volume Group
1525
+ data, status_code, headers = api_instance.list_volume_disks_by_volume_group_id_with_http_info(volume_group_ext_id, opts)
1526
+ p status_code # => 2xx
1527
+ p headers # => { ... }
1528
+ p data # => <ListVolumeDisksByVolumeGroupId200Response>
1529
+ rescue NutanixVolumes::ApiError => e
1530
+ puts "Error when calling VolumeGroupsApi->list_volume_disks_by_volume_group_id_with_http_info: #{e}"
1531
+ end
1532
+ ```
1533
+
1534
+ ### Parameters
1535
+
1536
+ | Name | Type | Description | Notes |
1537
+ | ---- | ---- | ----------- | ----- |
1538
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
1539
+ | **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. | [optional][default to 0] |
1540
+ | **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. | [optional][default to 50] |
1541
+ | **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](https://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 | [optional] |
1542
+ | **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 | [optional] |
1543
+ | **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](https://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 | [optional] |
1544
+
1545
+ ### Return type
1546
+
1547
+ [**ListVolumeDisksByVolumeGroupId200Response**](ListVolumeDisksByVolumeGroupId200Response.md)
1548
+
1549
+ ### Authorization
1550
+
1551
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1552
+
1553
+ ### HTTP request headers
1554
+
1555
+ - **Content-Type**: Not defined
1556
+ - **Accept**: application/json
1557
+
1558
+
1559
+ ## list_volume_groups
1560
+
1561
+ > <ListVolumeGroups200Response> list_volume_groups(opts)
1562
+
1563
+ List all the Volume Groups
1564
+
1565
+ Query the list of Volume Groups.
1566
+
1567
+ ### Examples
1568
+
1569
+ ```ruby
1570
+ require 'time'
1571
+ require 'nutanix_volumes'
1572
+ # setup authorization
1573
+ NutanixVolumes.configure do |config|
1574
+ # Configure API key authorization: apiKeyAuthScheme
1575
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1576
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1577
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1578
+
1579
+ # Configure HTTP basic authorization: basicAuthScheme
1580
+ config.username = 'YOUR USERNAME'
1581
+ config.password = 'YOUR PASSWORD'
1582
+ end
1583
+
1584
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1585
+ opts = {
1586
+ page: 56, # 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.
1587
+ limit: 56, # 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.
1588
+ filter: 'filter_example', # 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: - clusterReference - extId - name
1589
+ orderby: 'orderby_example', # 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, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: - clusterReference - extId - name
1590
+ expand: 'expand_example', # 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
1591
+ select: 'select_example' # 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](https://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
1592
+ }
1593
+
1594
+ begin
1595
+ # List all the Volume Groups
1596
+ result = api_instance.list_volume_groups(opts)
1597
+ p result
1598
+ rescue NutanixVolumes::ApiError => e
1599
+ puts "Error when calling VolumeGroupsApi->list_volume_groups: #{e}"
1600
+ end
1601
+ ```
1602
+
1603
+ #### Using the list_volume_groups_with_http_info variant
1604
+
1605
+ This returns an Array which contains the response data, status code and headers.
1606
+
1607
+ > <Array(<ListVolumeGroups200Response>, Integer, Hash)> list_volume_groups_with_http_info(opts)
1608
+
1609
+ ```ruby
1610
+ begin
1611
+ # List all the Volume Groups
1612
+ data, status_code, headers = api_instance.list_volume_groups_with_http_info(opts)
1613
+ p status_code # => 2xx
1614
+ p headers # => { ... }
1615
+ p data # => <ListVolumeGroups200Response>
1616
+ rescue NutanixVolumes::ApiError => e
1617
+ puts "Error when calling VolumeGroupsApi->list_volume_groups_with_http_info: #{e}"
1618
+ end
1619
+ ```
1620
+
1621
+ ### Parameters
1622
+
1623
+ | Name | Type | Description | Notes |
1624
+ | ---- | ---- | ----------- | ----- |
1625
+ | **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. | [optional][default to 0] |
1626
+ | **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. | [optional][default to 50] |
1627
+ | **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](https://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 | [optional] |
1628
+ | **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 | [optional] |
1629
+ | **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 | [optional] |
1630
+ | **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](https://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 | [optional] |
1631
+
1632
+ ### Return type
1633
+
1634
+ [**ListVolumeGroups200Response**](ListVolumeGroups200Response.md)
1635
+
1636
+ ### Authorization
1637
+
1638
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1639
+
1640
+ ### HTTP request headers
1641
+
1642
+ - **Content-Type**: Not defined
1643
+ - **Accept**: application/json
1644
+
1645
+
1646
+ ## revert_volume_group
1647
+
1648
+ > <RevertVolumeGroup202Response> revert_volume_group(ext_id, ntnx_request_id, volumes_v40_config_revert_spec)
1649
+
1650
+ Revert a Volume Group
1651
+
1652
+ Reverts a Volume Group identified by Volume Group external identifier. This API performs an in-place restore from a specified Volume Group recovery point.
1653
+
1654
+ ### Examples
1655
+
1656
+ ```ruby
1657
+ require 'time'
1658
+ require 'nutanix_volumes'
1659
+ # setup authorization
1660
+ NutanixVolumes.configure do |config|
1661
+ # Configure API key authorization: apiKeyAuthScheme
1662
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1663
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1664
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1665
+
1666
+ # Configure HTTP basic authorization: basicAuthScheme
1667
+ config.username = 'YOUR USERNAME'
1668
+ config.password = 'YOUR PASSWORD'
1669
+ end
1670
+
1671
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1672
+ ext_id = 'c3ed0675-f478-40ad-8d94-03a2b1fd0a74' # String | The external identifier of a Volume Group.
1673
+ ntnx_request_id = 'f4d12837-55ea-4afd-9635-ac89477cfd6c' # 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.
1674
+ volumes_v40_config_revert_spec = NutanixVolumes::VolumesV40ConfigRevertSpec.new({volume_group_recovery_point_ext_id: 'f0a47be2-aef7-4c0f-97f4-25b5e512a360'}) # VolumesV40ConfigRevertSpec | Specify the Volume Group recovery point ID to which the Volume Group would be reverted.
1675
+
1676
+ begin
1677
+ # Revert a Volume Group
1678
+ result = api_instance.revert_volume_group(ext_id, ntnx_request_id, volumes_v40_config_revert_spec)
1679
+ p result
1680
+ rescue NutanixVolumes::ApiError => e
1681
+ puts "Error when calling VolumeGroupsApi->revert_volume_group: #{e}"
1682
+ end
1683
+ ```
1684
+
1685
+ #### Using the revert_volume_group_with_http_info variant
1686
+
1687
+ This returns an Array which contains the response data, status code and headers.
1688
+
1689
+ > <Array(<RevertVolumeGroup202Response>, Integer, Hash)> revert_volume_group_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_revert_spec)
1690
+
1691
+ ```ruby
1692
+ begin
1693
+ # Revert a Volume Group
1694
+ data, status_code, headers = api_instance.revert_volume_group_with_http_info(ext_id, ntnx_request_id, volumes_v40_config_revert_spec)
1695
+ p status_code # => 2xx
1696
+ p headers # => { ... }
1697
+ p data # => <RevertVolumeGroup202Response>
1698
+ rescue NutanixVolumes::ApiError => e
1699
+ puts "Error when calling VolumeGroupsApi->revert_volume_group_with_http_info: #{e}"
1700
+ end
1701
+ ```
1702
+
1703
+ ### Parameters
1704
+
1705
+ | Name | Type | Description | Notes |
1706
+ | ---- | ---- | ----------- | ----- |
1707
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
1708
+ | **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. | |
1709
+ | **volumes_v40_config_revert_spec** | [**VolumesV40ConfigRevertSpec**](VolumesV40ConfigRevertSpec.md) | Specify the Volume Group recovery point ID to which the Volume Group would be reverted. | |
1710
+
1711
+ ### Return type
1712
+
1713
+ [**RevertVolumeGroup202Response**](RevertVolumeGroup202Response.md)
1714
+
1715
+ ### Authorization
1716
+
1717
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1718
+
1719
+ ### HTTP request headers
1720
+
1721
+ - **Content-Type**: application/json
1722
+ - **Accept**: application/json
1723
+
1724
+
1725
+ ## update_volume_disk_by_id
1726
+
1727
+ > <UpdateVolumeDiskById202Response> update_volume_disk_by_id(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk)
1728
+
1729
+ Update a specified Volume Disk
1730
+
1731
+ Updates a specific Volume Disk identified by {extId}.
1732
+
1733
+ ### Examples
1734
+
1735
+ ```ruby
1736
+ require 'time'
1737
+ require 'nutanix_volumes'
1738
+ # setup authorization
1739
+ NutanixVolumes.configure do |config|
1740
+ # Configure API key authorization: apiKeyAuthScheme
1741
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1742
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1743
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1744
+
1745
+ # Configure HTTP basic authorization: basicAuthScheme
1746
+ config.username = 'YOUR USERNAME'
1747
+ config.password = 'YOUR PASSWORD'
1748
+ end
1749
+
1750
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1751
+ volume_group_ext_id = '06dcf5f0-a7cd-4f16-997a-63e99271fc7b' # String | The external identifier of a Volume Group.
1752
+ ext_id = '2a9e95a1-a3df-45bf-ae47-88afb6583ac2' # String | The external identifier of a Volume Disk.
1753
+ if_match = 'if_match_example' # 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.
1754
+ ntnx_request_id = '3e4bbb78-e162-4e00-857d-9b8a5859bdc2' # 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.
1755
+ volumes_v40_config_volume_disk = NutanixVolumes::VolumesV40ConfigVolumeDisk.new # VolumesV40ConfigVolumeDisk | A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF.
1756
+
1757
+ begin
1758
+ # Update a specified Volume Disk
1759
+ result = api_instance.update_volume_disk_by_id(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk)
1760
+ p result
1761
+ rescue NutanixVolumes::ApiError => e
1762
+ puts "Error when calling VolumeGroupsApi->update_volume_disk_by_id: #{e}"
1763
+ end
1764
+ ```
1765
+
1766
+ #### Using the update_volume_disk_by_id_with_http_info variant
1767
+
1768
+ This returns an Array which contains the response data, status code and headers.
1769
+
1770
+ > <Array(<UpdateVolumeDiskById202Response>, Integer, Hash)> update_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk)
1771
+
1772
+ ```ruby
1773
+ begin
1774
+ # Update a specified Volume Disk
1775
+ data, status_code, headers = api_instance.update_volume_disk_by_id_with_http_info(volume_group_ext_id, ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_disk)
1776
+ p status_code # => 2xx
1777
+ p headers # => { ... }
1778
+ p data # => <UpdateVolumeDiskById202Response>
1779
+ rescue NutanixVolumes::ApiError => e
1780
+ puts "Error when calling VolumeGroupsApi->update_volume_disk_by_id_with_http_info: #{e}"
1781
+ end
1782
+ ```
1783
+
1784
+ ### Parameters
1785
+
1786
+ | Name | Type | Description | Notes |
1787
+ | ---- | ---- | ----------- | ----- |
1788
+ | **volume_group_ext_id** | **String** | The external identifier of a Volume Group. | |
1789
+ | **ext_id** | **String** | The external identifier of a Volume Disk. | |
1790
+ | **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. | |
1791
+ | **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. | |
1792
+ | **volumes_v40_config_volume_disk** | [**VolumesV40ConfigVolumeDisk**](VolumesV40ConfigVolumeDisk.md) | A model that represents a Volume Disk associated with a Volume Group, supported by a backing file on DSF. | |
1793
+
1794
+ ### Return type
1795
+
1796
+ [**UpdateVolumeDiskById202Response**](UpdateVolumeDiskById202Response.md)
1797
+
1798
+ ### Authorization
1799
+
1800
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1801
+
1802
+ ### HTTP request headers
1803
+
1804
+ - **Content-Type**: application/json
1805
+ - **Accept**: application/json
1806
+
1807
+
1808
+ ## update_volume_group_by_id
1809
+
1810
+ > <UpdateVolumeGroupById202Response> update_volume_group_by_id(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group)
1811
+
1812
+ Update details of a specified Volume Group
1813
+
1814
+ Updates details of a specific Volume Group identified by {extId}.
1815
+
1816
+ ### Examples
1817
+
1818
+ ```ruby
1819
+ require 'time'
1820
+ require 'nutanix_volumes'
1821
+ # setup authorization
1822
+ NutanixVolumes.configure do |config|
1823
+ # Configure API key authorization: apiKeyAuthScheme
1824
+ config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
1825
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1826
+ # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
1827
+
1828
+ # Configure HTTP basic authorization: basicAuthScheme
1829
+ config.username = 'YOUR USERNAME'
1830
+ config.password = 'YOUR PASSWORD'
1831
+ end
1832
+
1833
+ api_instance = NutanixVolumes::VolumeGroupsApi.new
1834
+ ext_id = '2eb3971e-7d53-4f3d-b046-8cc9c0e72845' # String | The external identifier of a Volume Group.
1835
+ if_match = 'if_match_example' # 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.
1836
+ ntnx_request_id = '1dd2f8cf-772a-41ac-b3b9-fa41f7316a75' # 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.
1837
+ volumes_v40_config_volume_group = NutanixVolumes::VolumesV40ConfigVolumeGroup.new # VolumesV40ConfigVolumeGroup | A model that represents a Volume Group resource.
1838
+
1839
+ begin
1840
+ # Update details of a specified Volume Group
1841
+ result = api_instance.update_volume_group_by_id(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group)
1842
+ p result
1843
+ rescue NutanixVolumes::ApiError => e
1844
+ puts "Error when calling VolumeGroupsApi->update_volume_group_by_id: #{e}"
1845
+ end
1846
+ ```
1847
+
1848
+ #### Using the update_volume_group_by_id_with_http_info variant
1849
+
1850
+ This returns an Array which contains the response data, status code and headers.
1851
+
1852
+ > <Array(<UpdateVolumeGroupById202Response>, Integer, Hash)> update_volume_group_by_id_with_http_info(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group)
1853
+
1854
+ ```ruby
1855
+ begin
1856
+ # Update details of a specified Volume Group
1857
+ data, status_code, headers = api_instance.update_volume_group_by_id_with_http_info(ext_id, if_match, ntnx_request_id, volumes_v40_config_volume_group)
1858
+ p status_code # => 2xx
1859
+ p headers # => { ... }
1860
+ p data # => <UpdateVolumeGroupById202Response>
1861
+ rescue NutanixVolumes::ApiError => e
1862
+ puts "Error when calling VolumeGroupsApi->update_volume_group_by_id_with_http_info: #{e}"
1863
+ end
1864
+ ```
1865
+
1866
+ ### Parameters
1867
+
1868
+ | Name | Type | Description | Notes |
1869
+ | ---- | ---- | ----------- | ----- |
1870
+ | **ext_id** | **String** | The external identifier of a Volume Group. | |
1871
+ | **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. | |
1872
+ | **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. | |
1873
+ | **volumes_v40_config_volume_group** | [**VolumesV40ConfigVolumeGroup**](VolumesV40ConfigVolumeGroup.md) | A model that represents a Volume Group resource. | |
1874
+
1875
+ ### Return type
1876
+
1877
+ [**UpdateVolumeGroupById202Response**](UpdateVolumeGroupById202Response.md)
1878
+
1879
+ ### Authorization
1880
+
1881
+ [apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
1882
+
1883
+ ### HTTP request headers
1884
+
1885
+ - **Content-Type**: application/json
1886
+ - **Accept**: application/json
1887
+