openapi: 3.0.1 info: title: Nutanix Storage APIs description: Manage storage configuration and operations. version: 4.0.1-alpha-3 x-repo-name: storage x-logo: altText: Storage Logo url: https://developers.nutanix.com/api/v1/namespaces/storage/images/storage-logo-img.svg x-minimum-negotiation-version: v4.2 servers: - url: "https://{pc-ip}:9440/api" security: - basicAuthScheme: [] paths: /storage/v4.0.a3/config/iscsi-clients/{clientId}: get: tags: - IscsiClient summary: "Get an iSCSI client identified by {clientId}." description: "Query the iSCSI client identified by {clientId}." operationId: getIscsiClientById parameters: - name: clientId in: path description: The external identifier of the iSCSI client. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b2c5913f-5109-49fa-abab-b18a3a93d883 responses: "200": description: Details of the queried iSCSI client. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetIscsiClientApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetIscsiClientApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetIscsiClientApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.IscsiClientApi;\n\ import dp1.sto.storage.v4.config.GetIscsiClientApiResponse;\n\npublic class\ \ JavaSdkSample {\n\tprivate static final IscsiClientApi iscsiClientApi\ \ = new IscsiClientApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tiscsiClientApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tiscsiClientApi.getApiClient().setBackOffPeriod(100);\n\t\tiscsiClientApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString clientId = \"^Cb2e5B51-DB8F-2acA-3ee8-e4fcbfdAA0FA$\";\n\t\t\ GetIscsiClientApiResponse getIscsiClientApiResponse = iscsiClientApi.getIscsiClientById(clientId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {IscsiClientApi} from "../src/apis/IscsiClient-endpoints"; import GetIscsiClientApiResponse from "../src/models/storage/v4/config/GetIscsiClientApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var iscsiClientApi = new IscsiClientApi(apiClientInstance); function sample() { let clientId = "^Efe7ecB8-cca3-fec7-e7dF-f8AbD060A5BA$"; iscsiClientApi.getIscsiClientById(clientId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) iscsiClientApi = swagger_client.IscsiClientApi(api_client) clientId = "^9dD3ACf1-ab1E-dB01-EFDD-45CFEB35C8B0$" api_response = iscsiClientApi.get_iscsi_client_by_id(clientId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var IscsiClientApiInstance *api.IscsiClientApi IscsiClientApiInstance = api.NewIscsiClientApi() IscsiClientApiInstance.ApiClient.BasePath = "http://localhost:8080" IscsiClientApiInstance.ApiClient.AllowVersionNegotiation = true clientId := "^eB1a0Cde-fEE4-cF2F-fC8b-cEde5edD9eC8$" response, _ := IscsiClientApiInstance.GetIscsiClientById(clientId) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/iscsi-clients/^1DFF0a49-9dcC-bbAB-4eBC-f57796fEe32A$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/iscsi-clients/^aecde4BB-a532-f14B-d7FD-fAbE0848AAf4$" patch: tags: - IscsiClient summary: "Update an iSCSI client identified by {clientId}." description: "Modify an existing iSCSI client configuration identified by {clientId}." operationId: updateIscsiClientById parameters: - name: clientId in: path description: The external identifier of the iSCSI client. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 5ff0e53d-7e1d-44e0-a7b5-a558656ce260 requestBody: description: A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.IscsiClient' required: true responses: "202": description: iSCSI client after the update operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateIscsiClientApiResponse' default: description: iSCSI client after the update operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateIscsiClientApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateIscsiClientApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateIscsiClientApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.IscsiClientApi;\n\ import dp1.sto.storage.v4.config.IscsiClient;\nimport dp1.sto.storage.v4.config.UpdateIscsiClientApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final IscsiClientApi iscsiClientApi\ \ = new IscsiClientApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tiscsiClientApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tiscsiClientApi.getApiClient().setBackOffPeriod(100);\n\t\tiscsiClientApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tIscsiClient iscsiClient = new IscsiClient();\n\n\t\t// IscsiClient\ \ object initializations here...\n\n\t\tString clientId = \"^B3b0dBf1-9cea-8ABe-Df4c-bcA72f304bEA$\"\ ;\n\t\tUpdateIscsiClientApiResponse updateIscsiClientApiResponse = iscsiClientApi.updateIscsiClientById(iscsiClient,\ \ clientId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {IscsiClientApi} from "../src/apis/IscsiClient-endpoints"; import IscsiClient from "../src/models/storage/v4/config/IscsiClient"; import UpdateIscsiClientApiResponse from "../src/models/storage/v4/config/UpdateIscsiClientApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var iscsiClientApi = new IscsiClientApi(apiClientInstance); function sample() { let iscsiClient = new IscsiClient(); // IscsiClient object initializations here... let clientId = "^ab9Ae8F9-e3Ba-Fae2-11e9-a7cFb909e5dD$"; iscsiClientApi.updateIscsiClientById(iscsiClient, clientId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) iscsiClientApi = swagger_client.IscsiClientApi(api_client) iscsiClient = swagger_client.IscsiClient() # IscsiClient object initializations here... clientId = "^fCdE79Cd-abfd-d039-1abE-cBefFA6B69eC$" api_response = iscsiClientApi.update_iscsi_client_by_id(iscsiClient, clientId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var IscsiClientApiInstance *api.IscsiClientApi IscsiClientApiInstance = api.NewIscsiClientApi() IscsiClientApiInstance.ApiClient.BasePath = "http://localhost:8080" IscsiClientApiInstance.ApiClient.AllowVersionNegotiation = true iscsiClient := import1.newIscsiClient() // IscsiClient object initializations here... clientId := "^aCdeEE4A-3CaB-ff4b-eaDA-D5Be0b34D3ea$" response, _ := IscsiClientApiInstance.UpdateIscsiClientById(iscsiClient, clientId) fmt.Println(response) } - lang: cURL source: |2 curl --request PATCH \ --url "https://api.nutanix.com/storage/v4.0.a3/config/iscsi-clients/^dd2Cd0Db-703F-Db2B-D3b7-F3EAeE942adD$" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"iscsiInitiatorName":"string","iscsiInitiatorNetworkId":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"},"clientSecret":"string","enabledAuthentications":"$UNKNOWN","targetParams":[{"numVirtualTargets":0,"$objectType":"storage.v4.config.TargetParam"}],"clusterReference":"string","attachmentSite":"$UNKNOWN","iscsiTargetNames":["string"],"$objectType":"storage.v4.config.IscsiClient"} \ - lang: Wget source: |2 wget --verbose \ --method PATCH \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"iscsiInitiatorName":"string","iscsiInitiatorNetworkId":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"},"clientSecret":"string","enabledAuthentications":"$UNKNOWN","targetParams":[{"numVirtualTargets":0,"$objectType":"storage.v4.config.TargetParam"}],"clusterReference":"string","attachmentSite":"$UNKNOWN","iscsiTargetNames":["string"],"$objectType":"storage.v4.config.IscsiClient"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/iscsi-clients/^87D1CcAA-dCEA-cEA7-f2FD-ACaaEd6bB1BB$" /storage/v4.0.a3/config/iscsi-clients: get: tags: - IscsiClient summary: Get a list of all the iSCSI clients. description: Query for list of iSCSI clients. operationId: getIscsiClients parameters: - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 - name: $filter in: query description: | 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 URL conventions. The filter can be applied on the following fields: - extId required: false style: form explode: true schema: type: string example: string - name: $orderby in: query description: | 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 desc order. The orderby can be applied to the following fields: - extId required: false style: form explode: true schema: type: string example: string responses: "200": description: Paginated list of iSCSI clients. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetIscsiClientsApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetIscsiClientsApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetIscsiClientsApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.IscsiClientApi;\n\ import dp1.sto.storage.v4.config.GetIscsiClientsApiResponse;\n\npublic class\ \ JavaSdkSample {\n\tprivate static final IscsiClientApi iscsiClientApi\ \ = new IscsiClientApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tiscsiClientApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tiscsiClientApi.getApiClient().setBackOffPeriod(100);\n\t\tiscsiClientApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tString $filter = \"string_sample_data\"\ ;\n\t\tString $orderby = \"string_sample_data\";\n\t\tGetIscsiClientsApiResponse\ \ getIscsiClientsApiResponse = iscsiClientApi.getIscsiClients($page, $limit,\ \ $filter, $orderby);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {IscsiClientApi} from "../src/apis/IscsiClient-endpoints"; import GetIscsiClientsApiResponse from "../src/models/storage/v4/config/GetIscsiClientsApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var iscsiClientApi = new IscsiClientApi(apiClientInstance); function sample() { let $page = 0; let $limit = 50; let $filter = "string_sample_data"; let $orderby = "string_sample_data"; iscsiClientApi.getIscsiClients($page, $limit, $filter, $orderby).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) iscsiClientApi = swagger_client.IscsiClientApi(api_client) $page = 0 $limit = 50 $filter = "string_sample_data" $orderby = "string_sample_data" api_response = iscsiClientApi.get_iscsi_clients($page, $limit, $filter, $orderby) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var IscsiClientApiInstance *api.IscsiClientApi IscsiClientApiInstance = api.NewIscsiClientApi() IscsiClientApiInstance.ApiClient.BasePath = "http://localhost:8080" IscsiClientApiInstance.ApiClient.AllowVersionNegotiation = true $page := 0 $limit := 50 $filter := "string_sample_data" $orderby := "string_sample_data" response, _ := IscsiClientApiInstance.GetIscsiClients($page, $limit, $filter, $orderby) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/iscsi-clients?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/iscsi-clients?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0" /storage/v4.0.a3/config/storage-containers: get: tags: - StorageContainer summary: Get Storage containers for the cluster. description: Query the list of Storage containers. operationId: getAllStorageContainers parameters: - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 - name: $filter in: query description: | 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 URL conventions. The filter can be applied on the following fields: - affinityHostUuid - clusterExtId - containerExtId - containerId - name - ownerUuid - replicationFactor - storagePoolUuid required: false style: form explode: true schema: type: string example: string - name: $orderby in: query description: | 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 desc order. The orderby can be applied to the following fields: - name required: false style: form explode: true schema: type: string example: string - name: $select in: query description: | 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 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. - advertisedCapacity - affinityHostUuid - clusterExtId - compressionDelayInSecs - compressionEnabled - containerExtId - containerId - downMigrateTimesInSecs - enableSoftwareEncryption - encrypted - erasureCode - erasureCodeDelaySecs - extId - fingerPrintOnWrite - inlineEcEnabled - isNfsWhitelistInherited - isNutanixManaged - links - mappedRemoteContainers - markedForRemoval - maxCapacity - name - nfsWhitelistAddress - onDiskDedup - oplogReplicationFactor - ownerUuid - preferHigherECFaultDomain - randomIoPreference - replicationFactor - seqIoPreference - storagePoolUuid - tenantId - totalExplicitReservedCapacity - totalImplicitReservedCapacity - vstoreNameList required: false style: form explode: true schema: type: string example: string responses: "200": description: Successfully retrieved the list of Storage containers in the cluster. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainersResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainersResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainersResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainersResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.StorageContainersResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tString $filter = \"string_sample_data\"\ ;\n\t\tString $orderby = \"string_sample_data\";\n\t\tString $select = \"\ string_sample_data\";\n\t\tStorageContainersResponse storageContainersResponse\ \ = storageContainerApi.getAllStorageContainers($page, $limit, $filter,\ \ $orderby, $select);\n\t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import StorageContainersResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainersResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let $page = 0; let $limit = 50; let $filter = "string_sample_data"; let $orderby = "string_sample_data"; let $select = "string_sample_data"; storageContainerApi.getAllStorageContainers($page, $limit, $filter, $orderby, $select).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) $page = 0 $limit = 50 $filter = "string_sample_data" $orderby = "string_sample_data" $select = "string_sample_data" api_response = storageContainerApi.get_all_storage_containers($page, $limit, $filter, $orderby, $select) - lang: Go source: |2+ package main import { "fmt" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) $page := 0 $limit := 50 $filter := "string_sample_data" $orderby := "string_sample_data" $select := "string_sample_data" response, _ := StorageContainerApiInstance.GetAllStorageContainers($page, $limit, $filter, $orderby, $select) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" post: tags: - StorageContainer summary: Add Storage container to the cluster. description: Create a new Storage container on a cluster. operationId: addStorageContainerForCluster parameters: - name: X-Cluster-Id in: header description: Remote cluster uuid to forward the request. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 24a94e0a-2eec-46ec-9b82-9e2458aa95eb requestBody: content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainer' required: true responses: "202": description: | Http Status code when the request has been accepted by the server but has not been completed yet. The Location Header contains the URL of the Task object that can be used to track the status of the request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.StorageContainer;\n\ import com.nutanix.dp1.sto.storage.v4.config.StorageContainerTaskResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tStorageContainer storageContainer = new StorageContainer();\n\n\t\t\ // StorageContainer object initializations here...\n\n\t\tString X-Cluster-Id\ \ = \"^3AC8BEf0-A4df-Afa0-Fefe-DefdeEdBaE73$\";\n\t\tStorageContainerTaskResponse\ \ storageContainerTaskResponse = storageContainerApi.addStorageContainerForCluster(storageContainer,\ \ X-Cluster-Id);\n\t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import StorageContainer from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainer"; import StorageContainerTaskResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainerTaskResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let storageContainer = new StorageContainer(); // StorageContainer object initializations here... let X-Cluster-Id = "^e7C480de-D866-FCeb-af9d-1ffbddfCCfA5$"; storageContainerApi.addStorageContainerForCluster(storageContainer, X-Cluster-Id).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) storageContainer = ntnx_prism-apis_py_client.StorageContainer() # StorageContainer object initializations here... X-Cluster-Id = "^5f2bdeB3-8e5C-0ffd-5c0D-62bc74aDC3af$" api_response = storageContainerApi.add_storage_container_for_cluster(storageContainer, X-Cluster-Id) - lang: Go source: |2+ package main import { "fmt" import1 "nutanix/prism-apis-go-client/models/prism-apis/v4/defaultapi" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) storageContainer := import1.newStorageContainer() // StorageContainer object initializations here... X-Cluster-Id := "^D0a1AdB4-07ee-dB0f-c9C5-C2e8AfeA0db2$" response, _ := StorageContainerApiInstance.AddStorageContainerForCluster(storageContainer, X-Cluster-Id) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Cluster-Id: ^ce71DDfB-D4B0-eDCe-d6a1-0CEc84EfdC64$' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"containerId":"string","containerExtId":"string","ownerUuid":"string","name":"string","clusterExtId":"string","storagePoolUuid":"string","markedForRemoval":true,"maxCapacity":0,"totalExplicitReservedCapacity":0,"totalImplicitReservedCapacity":0,"advertisedCapacity":0,"replicationFactor":0,"oplogReplicationFactor":0,"nfsWhitelistAddress":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"}],"isNfsWhitelistInherited":true,"randomIoPreference":["string"],"seqIoPreference":["string"],"downMigrateTimesInSecs":{"additionalProp1":0,"additionalProp2":0,"additionalProp3":0},"erasureCode":"$UNKNOWN","inlineEcEnabled":true,"preferHigherECFaultDomain":true,"erasureCodeDelaySecs":0,"fingerPrintOnWrite":"$UNKNOWN","onDiskDedup":"$UNKNOWN","compressionEnabled":true,"compressionDelayInSecs":0,"isNutanixManaged":true,"enableSoftwareEncryption":true,"vstoreNameList":["string"],"mappedRemoteContainers":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"encrypted":true,"affinityHostUuid":"string","$objectType":"storage.v4.config.StorageContainer"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Cluster-Id: ^A12a33bb-A41d-E7c0-9e00-c8cAED9B2Fd5$' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"containerId":"string","containerExtId":"string","ownerUuid":"string","name":"string","clusterExtId":"string","storagePoolUuid":"string","markedForRemoval":true,"maxCapacity":0,"totalExplicitReservedCapacity":0,"totalImplicitReservedCapacity":0,"advertisedCapacity":0,"replicationFactor":0,"oplogReplicationFactor":0,"nfsWhitelistAddress":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"}],"isNfsWhitelistInherited":true,"randomIoPreference":["string"],"seqIoPreference":["string"],"downMigrateTimesInSecs":{"additionalProp1":0,"additionalProp2":0,"additionalProp3":0},"erasureCode":"$UNKNOWN","inlineEcEnabled":true,"preferHigherECFaultDomain":true,"erasureCodeDelaySecs":0,"fingerPrintOnWrite":"$UNKNOWN","onDiskDedup":"$UNKNOWN","compressionEnabled":true,"compressionDelayInSecs":0,"isNutanixManaged":true,"enableSoftwareEncryption":true,"vstoreNameList":["string"],"mappedRemoteContainers":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"encrypted":true,"affinityHostUuid":"string","$objectType":"storage.v4.config.StorageContainer"} \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers" /storage/v4.0.a3/config/storage-containers/{containerExtId}: get: tags: - StorageContainer summary: Get existing Storage container. description: "Query for metadata information which is associated with the Storage\ \ container identified by {containerExtId}." operationId: getStorageContainerByExtId parameters: - name: containerExtId in: path description: Uuid of the Storage container. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b2fb095c-f935-4ef4-97d2-a7d84583a643 responses: "200": description: Successfully retrieved specified Storage container in the cluster. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.StorageContainerResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tStorageContainerResponse storageContainerResponse = storageContainerApi.getStorageContainerByExtId();\n\ \t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import StorageContainerResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainerResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { storageContainerApi.getStorageContainerByExtId().then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) api_response = storageContainerApi.get_storage_container_by_ext_id() - lang: Go source: |2+ package main import { "fmt" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) response, _ := StorageContainerApiInstance.GetStorageContainerByExtId() fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}" put: tags: - StorageContainer summary: Update existing Storage container. description: "Update an existing Storage container identified by {containerExtId}." operationId: updateStorageContainer parameters: - name: containerExtId in: path description: Uuid of the Storage container. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b2fb095c-f935-4ef4-97d2-a7d84583a643 requestBody: content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainer' required: true responses: "202": description: | Http Status code when the request has been accepted by the server but has not been completed yet. The Location Header contains the URL of the Task object that can be used to track the status of the request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.StorageContainer;\n\ import com.nutanix.dp1.sto.storage.v4.config.StorageContainerTaskResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tStorageContainer storageContainer = new StorageContainer();\n\n\t\t\ // StorageContainer object initializations here...\n\n\t\tStorageContainerTaskResponse\ \ storageContainerTaskResponse = storageContainerApi.updateStorageContainer(storageContainer);\n\ \t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import StorageContainer from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainer"; import StorageContainerTaskResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainerTaskResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let storageContainer = new StorageContainer(); // StorageContainer object initializations here... storageContainerApi.updateStorageContainer(storageContainer, ).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) storageContainer = ntnx_prism-apis_py_client.StorageContainer() # StorageContainer object initializations here... api_response = storageContainerApi.update_storage_container(storageContainer) - lang: Go source: |2+ package main import { "fmt" import1 "nutanix/prism-apis-go-client/models/prism-apis/v4/defaultapi" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) storageContainer := import1.newStorageContainer() // StorageContainer object initializations here... response, _ := StorageContainerApiInstance.UpdateStorageContainer(storageContainer) fmt.Println(response) } - lang: cURL source: |2 curl --request PUT \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"containerId":"string","containerExtId":"string","ownerUuid":"string","name":"string","clusterExtId":"string","storagePoolUuid":"string","markedForRemoval":true,"maxCapacity":0,"totalExplicitReservedCapacity":0,"totalImplicitReservedCapacity":0,"advertisedCapacity":0,"replicationFactor":0,"oplogReplicationFactor":0,"nfsWhitelistAddress":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"}],"isNfsWhitelistInherited":true,"randomIoPreference":["string"],"seqIoPreference":["string"],"downMigrateTimesInSecs":{"additionalProp1":0,"additionalProp2":0,"additionalProp3":0},"erasureCode":"$UNKNOWN","inlineEcEnabled":true,"preferHigherECFaultDomain":true,"erasureCodeDelaySecs":0,"fingerPrintOnWrite":"$UNKNOWN","onDiskDedup":"$UNKNOWN","compressionEnabled":true,"compressionDelayInSecs":0,"isNutanixManaged":true,"enableSoftwareEncryption":true,"vstoreNameList":["string"],"mappedRemoteContainers":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"encrypted":true,"affinityHostUuid":"string","$objectType":"storage.v4.config.StorageContainer"} \ - lang: Wget source: |2 wget --verbose \ --method PUT \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"containerId":"string","containerExtId":"string","ownerUuid":"string","name":"string","clusterExtId":"string","storagePoolUuid":"string","markedForRemoval":true,"maxCapacity":0,"totalExplicitReservedCapacity":0,"totalImplicitReservedCapacity":0,"advertisedCapacity":0,"replicationFactor":0,"oplogReplicationFactor":0,"nfsWhitelistAddress":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"}],"isNfsWhitelistInherited":true,"randomIoPreference":["string"],"seqIoPreference":["string"],"downMigrateTimesInSecs":{"additionalProp1":0,"additionalProp2":0,"additionalProp3":0},"erasureCode":"$UNKNOWN","inlineEcEnabled":true,"preferHigherECFaultDomain":true,"erasureCodeDelaySecs":0,"fingerPrintOnWrite":"$UNKNOWN","onDiskDedup":"$UNKNOWN","compressionEnabled":true,"compressionDelayInSecs":0,"isNutanixManaged":true,"enableSoftwareEncryption":true,"vstoreNameList":["string"],"mappedRemoteContainers":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"encrypted":true,"affinityHostUuid":"string","$objectType":"storage.v4.config.StorageContainer"} \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}" delete: tags: - StorageContainer summary: Delete an existing Storage container. description: "Delete an existing Storage container identified by {containerExtId}." operationId: deleteStorageContainerByExtId parameters: - name: containerExtId in: path description: Uuid of the Storage container. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b2fb095c-f935-4ef4-97d2-a7d84583a643 - name: ignoreSmallFiles in: query required: false style: form explode: true schema: type: boolean description: Indicates whether to ignore the small file. default: true responses: "202": description: | Http Status code when the request has been accepted by the server but has not been completed yet. The Location Header contains the URL of the Task object that can be used to track the status of the request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.StorageContainerTaskResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tboolean ignoreSmallFiles = true;\n\t\tStorageContainerTaskResponse\ \ storageContainerTaskResponse = storageContainerApi.deleteStorageContainerByExtId(ignoreSmallFiles);\n\ \t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import StorageContainerTaskResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainerTaskResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let ignoreSmallFiles = true; storageContainerApi.deleteStorageContainerByExtId(ignoreSmallFiles).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) ignoreSmallFiles = true api_response = storageContainerApi.delete_storage_container_by_ext_id(ignoreSmallFiles) - lang: Go source: |2+ package main import { "fmt" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) ignoreSmallFiles := true response, _ := StorageContainerApiInstance.DeleteStorageContainerByExtId(ignoreSmallFiles) fmt.Println(response) } - lang: cURL source: |2 curl --request DELETE \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}?ignoreSmallFiles=true" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method DELETE \ --header 'Accept: application/json' \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}?ignoreSmallFiles=true" /storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/mount: post: tags: - StorageContainer summary: Add a Data Store instance to the cluster. description: "Create a Data Store instance on the Storage container identified\ \ by {containerExtId}." operationId: addDataStoreForCluster parameters: - name: containerExtId in: path description: Uuid of the Storage container. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 727052eb-0c4b-45dd-bf48-4b4db7ece115 requestBody: content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreMount' required: true responses: "202": description: | Http Status code when the request has been accepted by the server but has not been completed yet. The Location Header contains the URL of the Task object that can be used to track the status of the request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainerTaskResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.DataStoreMount;\n\ import com.nutanix.dp1.sto.storage.v4.config.StorageContainerTaskResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tDataStoreMount dataStoreMount = new DataStoreMount();\n\n\t\t// DataStoreMount\ \ object initializations here...\n\n\t\tStorageContainerTaskResponse storageContainerTaskResponse\ \ = storageContainerApi.addDataStoreForCluster(dataStoreMount);\n\t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import DataStoreMount from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/DataStoreMount"; import StorageContainerTaskResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/StorageContainerTaskResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let dataStoreMount = new DataStoreMount(); // DataStoreMount object initializations here... storageContainerApi.addDataStoreForCluster(dataStoreMount, ).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) dataStoreMount = ntnx_prism-apis_py_client.DataStoreMount() # DataStoreMount object initializations here... api_response = storageContainerApi.add_data_store_for_cluster(dataStoreMount) - lang: Go source: |2+ package main import { "fmt" import1 "nutanix/prism-apis-go-client/models/prism-apis/v4/defaultapi" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) dataStoreMount := import1.newDataStoreMount() // DataStoreMount object initializations here... response, _ := StorageContainerApiInstance.AddDataStoreForCluster(dataStoreMount) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/mount" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"datastoreName":"string","containerName":"string","nodeIds":["string"],"nodeExtIds":["string"],"readOnly":true,"targetPath":"string","$objectType":"storage.v4.config.DataStoreMount"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"datastoreName":"string","containerName":"string","nodeIds":["string"],"nodeExtIds":["string"],"readOnly":true,"targetPath":"string","$objectType":"storage.v4.config.DataStoreMount"} \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/mount" /storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/unmount: post: tags: - StorageContainer summary: Delete a Data Store instance in the cluster. description: "Delete an existing Data Store instance from the Storage container\ \ identified by {containerExtId}." operationId: deleteDataStoreForCluster parameters: - name: containerExtId in: path description: Uuid of the Storage container. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 8330b8fe-4655-499f-84fd-e705525651b6 requestBody: content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreUnmount' required: true responses: "202": description: | Http Status code when the request has been accepted by the server but has not been completed yet. The Location Header contains the URL of the Task object that can be used to track the status of the request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreTaskResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreTaskResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreTaskResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreTaskResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.DataStoreUnmount;\n\ import com.nutanix.dp1.sto.storage.v4.config.DataStoreTaskResponse;\n\n\ public class JavaSdkSample {\n\tpublic static void main(String[] args) {\n\ \t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tDataStoreUnmount dataStoreUnmount = new DataStoreUnmount();\n\n\t\t\ // DataStoreUnmount object initializations here...\n\n\t\tDataStoreTaskResponse\ \ dataStoreTaskResponse = storageContainerApi.deleteDataStoreForCluster(dataStoreUnmount);\n\ \t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import DataStoreUnmount from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/DataStoreUnmount"; import DataStoreTaskResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/DataStoreTaskResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let dataStoreUnmount = new DataStoreUnmount(); // DataStoreUnmount object initializations here... storageContainerApi.deleteDataStoreForCluster(dataStoreUnmount, ).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) dataStoreUnmount = ntnx_prism-apis_py_client.DataStoreUnmount() # DataStoreUnmount object initializations here... api_response = storageContainerApi.delete_data_store_for_cluster(dataStoreUnmount) - lang: Go source: |2+ package main import { "fmt" import1 "nutanix/prism-apis-go-client/models/prism-apis/v4/defaultapi" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) dataStoreUnmount := import1.newDataStoreUnmount() // DataStoreUnmount object initializations here... response, _ := StorageContainerApiInstance.DeleteDataStoreForCluster(dataStoreUnmount) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/unmount" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"datastoreName":"string","nodeIds":["string"],"nodeExtIds":["string"],"$objectType":"storage.v4.config.DataStoreUnmount"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"datastoreName":"string","nodeIds":["string"],"nodeExtIds":["string"],"$objectType":"storage.v4.config.DataStoreUnmount"} \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/unmount" /storage/v4.0.a3/config/storage-containers/datastores: get: tags: - StorageContainer summary: Get the Data Stores. description: Query the list of Data Stores. operationId: getDataStores parameters: - name: $filter in: query description: | 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 URL conventions. The filter can be applied on the following fields: - containerExtId required: false style: form explode: true schema: type: string example: string responses: "200": description: Successfully retrieved the list of Data Stores. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreResponse' default: description: Default Error Response. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStoreResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.sto.java.client.ApiClient;\n\ import com.nutanix.sto.java.client.api.StorageContainerApi;\nimport com.nutanix.dp1.sto.storage.v4.config.DataStoreResponse;\n\ \npublic class JavaSdkSample {\n\tpublic static void main(String[] args)\ \ {\n\t\tApiClient client = new ApiClient();\n\t\tclient.setHost(\"localhost\"\ );\n\t\tclient.setPort(9440);\n\t\tclient.setRetryInterval(100);\n\t\tclient.setMaxRetryAttempts(2);\n\ \t\tclient.setUsername(\"username\");\n\t\tclient.setPassword(\"password\"\ );\n\n\t\tStorageContainerApi storageContainerApi = new StorageContainerApi(client);\n\ \n\t\tString $filter = \"string_sample_data\";\n\t\tDataStoreResponse dataStoreResponse\ \ = storageContainerApi.getDataStores($filter);\n\t}\n}\n" - lang: JavaScript source: |2 import ApiClient from "@nutanix/prism-apis-js-client/src/ApiClient"; import StorageContainerApi from "@nutanix/prism-apis-js-client/src/apis/StorageContainer-endpoints"; import DataStoreResponse from "@nutanix/prism-apis-js-client/src/models/storage/v4/config/DataStoreResponse"; let apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.retryInterval = 500; apiClientInstance.host = 'localhost' apiClientInstance.port = '9440'; apiClientInstance.username = 'username'; apiClientInstance.password = 'password'; let storageContainerApi = new StorageContainerApi(apiClientInstance); function sample() { let $filter = "string_sample_data"; storageContainerApi.getDataStores($filter).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import ntnx_prism-apis_py_client if __name__ == "__main__": config = ntnx_prism-apis_py_client.configuration.Configuration() config.host = "localhost" config.port = 9440 config.max_retry_attempts = 1 config.backoff_factor = 3 config.username = "username" config.password = "password" client = ntnx_prism-apis_py_client.ApiClient(configuration=config) storageContainerApi = ntnx_prism-apis_py_client.StorageContainerApi(api_client=client) $filter = "string_sample_data" api_response = storageContainerApi.get_data_stores($filter) - lang: Go source: |2+ package main import { "fmt" "nutanix/prism-apis-go-client/v4/api" "nutanix/prism-apis-go-client/v4/client" } var ( ApiClientInstance *client.ApiClient StorageContainerApiInstance *api.StorageContainerApi ) func main() { ApiClientInstance = client.NewApiClient() ApiClientInstance.Host = "localhost" ApiClientInstance.Port = 9440 ApiClientInstance.RetryInterval = 100 ApiClientInstance.MaxRetryAttempts = 2 ApiClientInstance.AllowVersionNegotiation = true ApiClientInstance.Username = "username" ApiClientInstance.Password = "password" StorageContainerApiInstance = api.StorageContainerApi(ApiClientInstance) $filter := "string_sample_data" response, _ := StorageContainerApiInstance.GetDataStores($filter) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/datastores?$filter=string_sample_data" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://{pc-ip}:9440/api/storage/v4.0.a3/config/storage-containers/datastores?$filter=string_sample_data" /storage/v4.0.a3/config/volume-groups/{extId}: get: tags: - VolumeGroup summary: "Get a Volume Group identified by {extId}." description: "Query the Volume Group identified by {extId}." operationId: getVolumeGroupById parameters: - name: extId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 158cd0fe-ac94-4b5d-883e-90035551fd03 responses: "200": description: Details of the queried Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetVolumeGroupApiResponse;\n\npublic class\ \ JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString extId = \"^9bcB1B58-AdeD-EBd7-447a-C47b88Ad6Cec$\";\n\t\tGetVolumeGroupApiResponse\ \ getVolumeGroupApiResponse = volumeGroupApi.getVolumeGroupById(extId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetVolumeGroupApiResponse from "../src/models/storage/v4/config/GetVolumeGroupApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let extId = "^36FDCcBe-bfC8-cbba-022e-eF5c43FcDcde$"; volumeGroupApi.getVolumeGroupById(extId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) extId = "^C6129FDE-D1b3-bFeA-f47d-9C24E6dd5BBb$" api_response = volumeGroupApi.get_volume_group_by_id(extId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true extId := "^b8B3afDB-b7Bc-FA30-b9A5-cd40E3CBC49E$" response, _ := VolumeGroupApiInstance.GetVolumeGroupById(extId) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^EFCcA97c-adf9-E7DC-0A3e-fF830BAEC3BF$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^be7dF924-Ec1f-AB0f-cCec-a93221aeFFbA$" delete: tags: - VolumeGroup summary: "Delete the Volume Group identified by {extId}." description: "Delete the Volume Group identified by {extId}." operationId: deleteVolumeGroupById parameters: - name: extId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 89c90d94-f765-4e6d-98af-3d022e170107 responses: "202": description: Task Id corresponding to the Volume Group delete operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeGroupApiResponse' default: description: Task Id corresponding to the Volume Group delete operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeGroupApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeGroupApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeGroupApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.DeleteVolumeGroupApiResponse;\n\npublic\ \ class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString extId = \"^A0D2b7f0-eFbE-1eaC-cee6-e82DD8BBE24b$\";\n\t\tDeleteVolumeGroupApiResponse\ \ deleteVolumeGroupApiResponse = volumeGroupApi.deleteVolumeGroupById(extId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import DeleteVolumeGroupApiResponse from "../src/models/storage/v4/config/DeleteVolumeGroupApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let extId = "^Fa8eDCFa-BE18-bEF4-Aeed-bCEEb8e8C2b0$"; volumeGroupApi.deleteVolumeGroupById(extId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) extId = "^E0400CDa-D3EC-eC5c-b0a4-Bbd3cdeaDaB2$" api_response = volumeGroupApi.delete_volume_group_by_id(extId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true extId := "^aa1b9fcb-fb1C-A83F-aAdb-0EeDeE75Dbde$" response, _ := VolumeGroupApiInstance.DeleteVolumeGroupById(extId) fmt.Println(response) } - lang: cURL source: |2 curl --request DELETE \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^aeE5FaFD-954D-ADFd-63AF-9fEBbBb42770$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method DELETE \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^Be3D9ed6-BAcd-FDDA-eeEd-f3f5dAbfBDbc$" patch: tags: - VolumeGroup summary: "Update details of a specified Volume Group identified by {extId}." description: "Update details of a specified Volume Group identified by {extId}." operationId: updateVolumeGroupById parameters: - name: extId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 17377353-5b7b-426a-bb3f-798af45688dd requestBody: description: A model that represents a Volume Group resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroup' required: true responses: "202": description: Task Id corresponding to the Volume Group update operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupApiResponse' default: description: Task Id corresponding to the Volume Group update operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VolumeGroup;\nimport dp1.sto.storage.v4.config.UpdateVolumeGroupApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVolumeGroup volumeGroup = new VolumeGroup();\n\n\t\t// VolumeGroup\ \ object initializations here...\n\n\t\tString extId = \"^0CB1dB1D-8d75-c18C-b4E1-2E9AEF9acE1F$\"\ ;\n\t\tUpdateVolumeGroupApiResponse updateVolumeGroupApiResponse = volumeGroupApi.updateVolumeGroupById(volumeGroup,\ \ extId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VolumeGroup from "../src/models/storage/v4/config/VolumeGroup"; import UpdateVolumeGroupApiResponse from "../src/models/storage/v4/config/UpdateVolumeGroupApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroup = new VolumeGroup(); // VolumeGroup object initializations here... let extId = "^d36eAbaf-aAbB-ccca-aD4F-FadCa7E155b2$"; volumeGroupApi.updateVolumeGroupById(volumeGroup, extId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroup = swagger_client.VolumeGroup() # VolumeGroup object initializations here... extId = "^cA1ca8fD-14d3-4ac0-AF5d-Ae43C591D2fa$" api_response = volumeGroupApi.update_volume_group_by_id(volumeGroup, extId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroup := import1.newVolumeGroup() // VolumeGroup object initializations here... extId := "^ECa9D2bb-4aCE-E1c7-adf9-Ef3caAFea5CC$" response, _ := VolumeGroupApiInstance.UpdateVolumeGroupById(volumeGroup, extId) fmt.Println(response) } - lang: cURL source: |2 curl --request PATCH \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^5BBCECF9-eeCb-aCAd-FcEE-50DaBE5a19b5$" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"name":"string","description":"string","loadBalanceVmAttachments":true,"sharingStatus":"$UNKNOWN","iscsiTargetPrefix":"string","iscsiTargetName":"string","targetSecret":"string","enabledAuthentications":"$UNKNOWN","createdBy":"string","clusterReference":"string","storageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.StorageFeatures"},"usageType":"$UNKNOWN","isHidden":true,"$objectType":"storage.v4.config.VolumeGroup"} \ - lang: Wget source: |2 wget --verbose \ --method PATCH \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"name":"string","description":"string","loadBalanceVmAttachments":true,"sharingStatus":"$UNKNOWN","iscsiTargetPrefix":"string","iscsiTargetName":"string","targetSecret":"string","enabledAuthentications":"$UNKNOWN","createdBy":"string","clusterReference":"string","storageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.StorageFeatures"},"usageType":"$UNKNOWN","isHidden":true,"$objectType":"storage.v4.config.VolumeGroup"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^BDC6ff9E-c02C-cEaf-d4C9-c04ebEdc5EBc$" /storage/v4.0.a3/config/volume-groups: get: tags: - VolumeGroup summary: Get a list of all the Volume Groups. description: Query the list of Volume Groups. operationId: getVolumeGroups parameters: - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 - name: $filter in: query description: | 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 URL conventions. The filter can be applied on the following fields: - name required: false style: form explode: true schema: type: string example: string - name: $orderby in: query description: | 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 desc order. The orderby can be applied to the following fields: - name required: false style: form explode: true schema: type: string example: string responses: "200": description: Paginated list of Volume Groups. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupsApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupsApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupsApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetVolumeGroupsApiResponse;\n\npublic class\ \ JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tString $filter = \"string_sample_data\"\ ;\n\t\tString $orderby = \"string_sample_data\";\n\t\tGetVolumeGroupsApiResponse\ \ getVolumeGroupsApiResponse = volumeGroupApi.getVolumeGroups($page, $limit,\ \ $filter, $orderby);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetVolumeGroupsApiResponse from "../src/models/storage/v4/config/GetVolumeGroupsApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let $page = 0; let $limit = 50; let $filter = "string_sample_data"; let $orderby = "string_sample_data"; volumeGroupApi.getVolumeGroups($page, $limit, $filter, $orderby).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) $page = 0 $limit = 50 $filter = "string_sample_data" $orderby = "string_sample_data" api_response = volumeGroupApi.get_volume_groups($page, $limit, $filter, $orderby) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true $page := 0 $limit := 50 $filter := "string_sample_data" $orderby := "string_sample_data" response, _ := VolumeGroupApiInstance.GetVolumeGroups($page, $limit, $filter, $orderby) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0" post: tags: - VolumeGroup summary: Create a new Volume Group. description: Create a new Volume Group. operationId: createVolumeGroup requestBody: description: A model that represents a Volume Group resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroup' required: true responses: "202": description: Task Id corresponding to the Volume Group create operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeGroupApiResponse' default: description: Task Id corresponding to the Volume Group create operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeGroupApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeGroupApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeGroupApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VolumeGroup;\nimport dp1.sto.storage.v4.config.CreateVolumeGroupApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVolumeGroup volumeGroup = new VolumeGroup();\n\n\t\t// VolumeGroup\ \ object initializations here...\n\n\t\tCreateVolumeGroupApiResponse createVolumeGroupApiResponse\ \ = volumeGroupApi.createVolumeGroup(volumeGroup);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VolumeGroup from "../src/models/storage/v4/config/VolumeGroup"; import CreateVolumeGroupApiResponse from "../src/models/storage/v4/config/CreateVolumeGroupApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroup = new VolumeGroup(); // VolumeGroup object initializations here... volumeGroupApi.createVolumeGroup(volumeGroup, ).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroup = swagger_client.VolumeGroup() # VolumeGroup object initializations here... api_response = volumeGroupApi.create_volume_group(volumeGroup) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroup := import1.newVolumeGroup() // VolumeGroup object initializations here... response, _ := VolumeGroupApiInstance.CreateVolumeGroup(volumeGroup) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"name":"string","description":"string","loadBalanceVmAttachments":true,"sharingStatus":"$UNKNOWN","iscsiTargetPrefix":"string","iscsiTargetName":"string","targetSecret":"string","enabledAuthentications":"$UNKNOWN","createdBy":"string","clusterReference":"string","storageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.StorageFeatures"},"usageType":"$UNKNOWN","isHidden":true,"$objectType":"storage.v4.config.VolumeGroup"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"name":"string","description":"string","loadBalanceVmAttachments":true,"sharingStatus":"$UNKNOWN","iscsiTargetPrefix":"string","iscsiTargetName":"string","targetSecret":"string","enabledAuthentications":"$UNKNOWN","createdBy":"string","clusterReference":"string","storageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.StorageFeatures"},"usageType":"$UNKNOWN","isHidden":true,"$objectType":"storage.v4.config.VolumeGroup"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks: get: tags: - VolumeGroup summary: Get a list of all the Volume Disks. description: "Query the list of disks corresponding to a Volume Group identified\ \ by {volumeGroupExtId}." operationId: getVolumeDisks parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 6c3e5633-f227-46a3-b108-67bcd1bafe73 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 responses: "200": description: "Paginated list of disks corresponding to a Volume Group identified\ \ by {volumeGroupExtId}." content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeDisksApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeDisksApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeDisksApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetVolumeDisksApiResponse;\n\npublic class\ \ JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^D3ACEc0a-12ca-4fDa-3d1B-cf7DeEBb8E7e$\"\ ;\n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tGetVolumeDisksApiResponse\ \ getVolumeDisksApiResponse = volumeGroupApi.getVolumeDisks(volumeGroupExtId,\ \ $page, $limit);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetVolumeDisksApiResponse from "../src/models/storage/v4/config/GetVolumeDisksApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^B8C4fcFE-C95f-FBA6-7cFA-472C87D39089$"; let $page = 0; let $limit = 50; volumeGroupApi.getVolumeDisks(volumeGroupExtId, $page, $limit).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^90b22Aff-DfFA-BbCB-bcD3-138FD7eb514D$" $page = 0 $limit = 50 api_response = volumeGroupApi.get_volume_disks(volumeGroupExtId, $page, $limit) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^F661b14a-B2Ae-b2f0-561f-7ebA0eacA0eA$" $page := 0 $limit := 50 response, _ := VolumeGroupApiInstance.GetVolumeDisks(volumeGroupExtId, $page, $limit) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^b2bf8Da5-FcF7-95a6-7Fb4-2EEeF8B1DADc$/disks?$limit=50&$page=0" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^FE6bEfCc-ecEc-F9b9-b5Fa-061b4CabfDE7$/disks?$limit=50&$page=0" post: tags: - VolumeGroup summary: Create a new Volume Disk. description: Create a new Volume Disk. operationId: createVolumeDisk parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: cfe9ebea-a129-4e89-81d1-9dcc1069b94c requestBody: description: "A model that represents a Volume Disk associated with a Volume\ \ Group, and is supported by backing file on DSF." content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeDisk' required: true responses: "202": description: Task Id corresponding to the Volume Disk create operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeDiskApiResponse' default: description: Task Id corresponding to the Volume Disk create operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeDiskApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeDiskApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CreateVolumeDiskApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VolumeDisk;\nimport dp1.sto.storage.v4.config.CreateVolumeDiskApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVolumeDisk volumeDisk = new VolumeDisk();\n\n\t\t// VolumeDisk object\ \ initializations here...\n\n\t\tString volumeGroupExtId = \"^eaE818db-EAb1-A7bc-DbbF-Aca7eaA72ACE$\"\ ;\n\t\tCreateVolumeDiskApiResponse createVolumeDiskApiResponse = volumeGroupApi.createVolumeDisk(volumeDisk,\ \ volumeGroupExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VolumeDisk from "../src/models/storage/v4/config/VolumeDisk"; import CreateVolumeDiskApiResponse from "../src/models/storage/v4/config/CreateVolumeDiskApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeDisk = new VolumeDisk(); // VolumeDisk object initializations here... let volumeGroupExtId = "^dA8d30Aa-3CeF-1BDb-Cc8b-3fD3e9bfBeA7$"; volumeGroupApi.createVolumeDisk(volumeDisk, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeDisk = swagger_client.VolumeDisk() # VolumeDisk object initializations here... volumeGroupExtId = "^CAb5F5FB-CFCD-b58C-85B8-dCABa44ecA7B$" api_response = volumeGroupApi.create_volume_disk(volumeDisk, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeDisk := import1.newVolumeDisk() // VolumeDisk object initializations here... volumeGroupExtId := "^474DdDaB-ecaF-7E06-4Bab-EFAb7cb58cd7$" response, _ := VolumeGroupApiInstance.CreateVolumeDisk(volumeDisk, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^D8Bec2CD-ab5F-Fcec-5Bd6-158DADfa6Eae$/disks" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"index":0,"diskSizeBytes":0,"storageContainerId":"string","description":"string","diskDataSourceReference":{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"},"diskStorageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.DiskStorageFeatures"},"$objectType":"storage.v4.config.VolumeDisk"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"index":0,"diskSizeBytes":0,"storageContainerId":"string","description":"string","diskDataSourceReference":{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"},"diskStorageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.DiskStorageFeatures"},"$objectType":"storage.v4.config.VolumeDisk"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^6ace470E-3EDe-7fbB-b3Ba-DdaFc445CBFd$/disks" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks/{diskExtId}: get: tags: - VolumeGroup summary: "Get a Volume Disk identified by {diskExtId}." description: "Query the Volume Disk identified by {diskExtId}." operationId: getVolumeDiskById parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 4906fda5-8784-4123-8a94-1fa7f7a26120 - name: diskExtId in: path description: The external identifier of the Volume Disk. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 590c1a26-fb75-4a77-a32b-ee74ebdf0ac5 responses: "200": description: Details of the queried Volume Disk. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeDiskApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeDiskApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeDiskApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetVolumeDiskApiResponse;\n\npublic class\ \ JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^7cAeADfA-855E-e1f3-BFfB-fd8CFa21FbFe$\"\ ;\n\t\tString diskExtId = \"^fBAD8Aee-7BEA-C51d-847e-41a7ceF78beF$\";\n\t\ \tGetVolumeDiskApiResponse getVolumeDiskApiResponse = volumeGroupApi.getVolumeDiskById(volumeGroupExtId,\ \ diskExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetVolumeDiskApiResponse from "../src/models/storage/v4/config/GetVolumeDiskApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^E3aA8b71-2ecd-C18B-9DEb-6DaECc8E0bFD$"; let diskExtId = "^9e9CFdDE-bfb3-4260-Af3A-3Bd13B9Beee7$"; volumeGroupApi.getVolumeDiskById(volumeGroupExtId, diskExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^2CF3be9f-DFeB-da1D-647B-fafbaD31DbDD$" diskExtId = "^cCfcBe39-1CeA-efe2-f929-AfbeDBDBCF1c$" api_response = volumeGroupApi.get_volume_disk_by_id(volumeGroupExtId, diskExtId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^faCdc6a3-fddc-7a9F-aCeb-Bca5BFeea9ea$" diskExtId := "^aA5CAa5D-ACbA-8fcC-bEFC-D9ceAC2Bcc51$" response, _ := VolumeGroupApiInstance.GetVolumeDiskById(volumeGroupExtId, diskExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^4d5bbf46-eCFA-dA52-FF9e-EcC9C08DEDce$/disks/^2bf2EB4b-04dA-6CAC-4dBc-4EED3B2aeAc7$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^abCaaFFf-Acbf-F7CC-cDd4-d5ffe0fcec19$/disks/^dfc12D1b-Febe-FeEB-c16c-FCCAECb3f32c$" delete: tags: - VolumeGroup summary: "Delete a Volume Disk identified by {diskExtId}." description: "Delete a Volume Disk identified by {diskExtId}." operationId: deleteVolumeDisk parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: ad686357-0019-4825-ba83-aa9c34c89f3f - name: diskExtId in: path description: The external identifier of the Volume Disk. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b8ae03b8-fda2-458b-88f5-d449881b7204 responses: "202": description: Task Id corresponding to the Volume Disk delete operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeDiskApiResponse' default: description: Task Id corresponding to the Volume Disk delete operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeDiskApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeDiskApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DeleteVolumeDiskApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.DeleteVolumeDiskApiResponse;\n\npublic\ \ class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^EB7bC83D-2afB-1Ac1-a71b-a9aeDFFFbaa3$\"\ ;\n\t\tString diskExtId = \"^aF6edEd7-e8fc-fbEF-efFf-c8f4Ccb01dd8$\";\n\t\ \tDeleteVolumeDiskApiResponse deleteVolumeDiskApiResponse = volumeGroupApi.deleteVolumeDisk(volumeGroupExtId,\ \ diskExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import DeleteVolumeDiskApiResponse from "../src/models/storage/v4/config/DeleteVolumeDiskApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^EBe5415B-c5Be-Ea9C-f4FA-F3BeBCDb3748$"; let diskExtId = "^75046Fc3-Aab1-CF9b-eA60-a77e4c9E4dFF$"; volumeGroupApi.deleteVolumeDisk(volumeGroupExtId, diskExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^8b1dd366-A785-0dE5-c5C4-eB98f3fCcA5d$" diskExtId = "^f58Eb2eE-DAcD-c8aa-D133-cBb6A3fadbaE$" api_response = volumeGroupApi.delete_volume_disk(volumeGroupExtId, diskExtId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^F5AbBD36-39b6-9Cac-deA4-DAcaEF5cA36b$" diskExtId := "^dCEE8BCD-FF0d-8FBF-feEf-DC9b7514A68A$" response, _ := VolumeGroupApiInstance.DeleteVolumeDisk(volumeGroupExtId, diskExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request DELETE \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^c8EdD31C-aF3F-fB21-CBeB-dcdE46C83175$/disks/^82BaEc0F-Ae6B-3A87-0BE4-30aceBf6ff7B$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method DELETE \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^cE61eafe-Ebee-5cA9-6cdd-d8FBecda1cED$/disks/^8fA4d95C-Daeb-Aaeb-61CB-E2E945ebbEbF$" patch: tags: - VolumeGroup summary: "Update a specified Volume Disk identified by {diskExtId}." description: "Update a specified Volume Disk identified by {diskExtId}." operationId: updateVolumeDisk parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 9fb74e4f-5021-4cb3-b886-2a3dc026d10d - name: diskExtId in: path description: The external identifier of the Volume Disk. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: f352ba1b-207a-4d38-b6fb-ea434b2b5469 requestBody: description: "A model that represents a Volume Disk associated with a Volume\ \ Group, and is supported by backing file on DSF." content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeDisk' required: true responses: "202": description: Task Id corresponding to the Volume Disk update operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeDiskApiResponse' default: description: Task Id corresponding to the Volume Disk update operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeDiskApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeDiskApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeDiskApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VolumeDisk;\nimport dp1.sto.storage.v4.config.UpdateVolumeDiskApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVolumeDisk volumeDisk = new VolumeDisk();\n\n\t\t// VolumeDisk object\ \ initializations here...\n\n\t\tString volumeGroupExtId = \"^E0A5BDAd-23Fa-f5C5-CFc6-Cd27DA69af48$\"\ ;\n\t\tString diskExtId = \"^096EaD9D-2E7F-AEE5-ebBe-3bd1e32F71bC$\";\n\t\ \tUpdateVolumeDiskApiResponse updateVolumeDiskApiResponse = volumeGroupApi.updateVolumeDisk(volumeDisk,\ \ volumeGroupExtId, diskExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VolumeDisk from "../src/models/storage/v4/config/VolumeDisk"; import UpdateVolumeDiskApiResponse from "../src/models/storage/v4/config/UpdateVolumeDiskApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeDisk = new VolumeDisk(); // VolumeDisk object initializations here... let volumeGroupExtId = "^05E2A1b7-AECb-d7ef-7852-Fa9BeFee1ed1$"; let diskExtId = "^458aDb5a-75E3-a0EB-1AFa-2bbbDECec9C5$"; volumeGroupApi.updateVolumeDisk(volumeDisk, volumeGroupExtId, diskExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeDisk = swagger_client.VolumeDisk() # VolumeDisk object initializations here... volumeGroupExtId = "^60D3c5c1-A10E-b8bC-EAb0-a9e0e2C52EDc$" diskExtId = "^fecafbbE-AacF-0eB4-CAFc-e49C5fa1bEff$" api_response = volumeGroupApi.update_volume_disk(volumeDisk, volumeGroupExtId, diskExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeDisk := import1.newVolumeDisk() // VolumeDisk object initializations here... volumeGroupExtId := "^d67b90c6-fedE-E5a0-Fd9e-D6F9deFAFCFA$" diskExtId := "^FFCFC5C4-7EDE-d7AC-DFEe-fb7DD8cfBdb4$" response, _ := VolumeGroupApiInstance.UpdateVolumeDisk(volumeDisk, volumeGroupExtId, diskExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request PATCH \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^7B5fCffd-b510-FA3D-CEe6-cCA48bdcF2b8$/disks/^1acAa5CB-Ead7-dDDF-2EFF-f9807292Cb2f$" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"index":0,"diskSizeBytes":0,"storageContainerId":"string","description":"string","diskDataSourceReference":{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"},"diskStorageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.DiskStorageFeatures"},"$objectType":"storage.v4.config.VolumeDisk"} \ - lang: Wget source: |2 wget --verbose \ --method PATCH \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"index":0,"diskSizeBytes":0,"storageContainerId":"string","description":"string","diskDataSourceReference":{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"},"diskStorageFeatures":{"flashMode":{"isEnabled":true,"$objectType":"storage.v4.config.FlashMode"},"$objectType":"storage.v4.config.DiskStorageFeatures"},"$objectType":"storage.v4.config.VolumeDisk"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^7Fcd35B6-bcc2-C668-Ac4e-aC905adcfCfd$/disks/^2Bf5DAfB-eBeA-F3eb-ad76-EF469caCaCC8$" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/iscsi-client-attachments: get: tags: - VolumeGroup summary: "Get a list of all the external attachments associated with the given\ \ Volume Group identified by {volumeGroupExtId}." description: "Query the list of external attachments for a Volume Group identified\ \ by {volumeGroupExtId}." operationId: getExternalAttachments parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: a9d14180-b616-4054-a5ad-e195f956830e - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 - name: $filter in: query description: | 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 URL conventions. The filter can be applied on the following fields: - extId required: false style: form explode: true schema: type: string example: string - name: $orderby in: query description: | 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 desc order. The orderby can be applied to the following fields: - extId required: false style: form explode: true schema: type: string example: string responses: "200": description: Paginated list of external attachments. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetExternalAttachmentsApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetExternalAttachmentsApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetExternalAttachmentsApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetExternalAttachmentsApiResponse;\n\n\ public class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^2d9dB684-C2EE-C0A9-dEd7-c2cbdFfAc40A$\"\ ;\n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tString $filter = \"string_sample_data\"\ ;\n\t\tString $orderby = \"string_sample_data\";\n\t\tGetExternalAttachmentsApiResponse\ \ getExternalAttachmentsApiResponse = volumeGroupApi.getExternalAttachments(volumeGroupExtId,\ \ $page, $limit, $filter, $orderby);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetExternalAttachmentsApiResponse from "../src/models/storage/v4/config/GetExternalAttachmentsApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^e48f53Be-2dbC-9Ec1-2d88-7E17AeAC9BDa$"; let $page = 0; let $limit = 50; let $filter = "string_sample_data"; let $orderby = "string_sample_data"; volumeGroupApi.getExternalAttachments(volumeGroupExtId, $page, $limit, $filter, $orderby).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^CaDbAbff-Ccaf-c1BA-5C76-dAD516DB545e$" $page = 0 $limit = 50 $filter = "string_sample_data" $orderby = "string_sample_data" api_response = volumeGroupApi.get_external_attachments(volumeGroupExtId, $page, $limit, $filter, $orderby) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^EBe1a4ee-E98a-8C83-7CcA-d2b1f0CBD2eA$" $page := 0 $limit := 50 $filter := "string_sample_data" $orderby := "string_sample_data" response, _ := VolumeGroupApiInstance.GetExternalAttachments(volumeGroupExtId, $page, $limit, $filter, $orderby) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^a8bb30B2-ce68-cC0F-eFc8-aEFcB2c4CaCB$/iscsi-client-attachments?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^aCcbd5cF-BD6b-dc7F-Ef0C-568cF7eDE7E5$/iscsi-client-attachments?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/attach-iscsi-client: post: tags: - VolumeGroup summary: "Attach an iSCSI client to the given Volume Group identified by {volumeGroupExtId}." description: "Attach iSCSI initiator to a Volume Group identified by {volumeGroupExtId}." operationId: attachIscsiClient parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 9e914b76-f0df-4fed-940e-898eedf77e07 requestBody: description: A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.IscsiClient' required: true responses: "202": description: Status of the iSCSI client attachment operation on the Volume Group. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachIscsiClientApiResponse' default: description: Status of the iSCSI client attachment operation on the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachIscsiClientApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachIscsiClientApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachIscsiClientApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.IscsiClient;\nimport dp1.sto.storage.v4.config.AttachIscsiClientApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tIscsiClient iscsiClient = new IscsiClient();\n\n\t\t// IscsiClient\ \ object initializations here...\n\n\t\tString volumeGroupExtId = \"^aE2e46ED-3f2e-2d5E-2345-BCe26e8dfCbF$\"\ ;\n\t\tAttachIscsiClientApiResponse attachIscsiClientApiResponse = volumeGroupApi.attachIscsiClient(iscsiClient,\ \ volumeGroupExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import IscsiClient from "../src/models/storage/v4/config/IscsiClient"; import AttachIscsiClientApiResponse from "../src/models/storage/v4/config/AttachIscsiClientApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let iscsiClient = new IscsiClient(); // IscsiClient object initializations here... let volumeGroupExtId = "^4cAECaAF-3Ea1-cBB1-Ff38-4c282BaCA21f$"; volumeGroupApi.attachIscsiClient(iscsiClient, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) iscsiClient = swagger_client.IscsiClient() # IscsiClient object initializations here... volumeGroupExtId = "^BBbe55Ec-dCFA-3f4a-addF-0C9ABaDCEc0b$" api_response = volumeGroupApi.attach_iscsi_client(iscsiClient, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true iscsiClient := import1.newIscsiClient() // IscsiClient object initializations here... volumeGroupExtId := "^4a72CADb-BA0B-a05c-EB1e-862F0eF13A2F$" response, _ := VolumeGroupApiInstance.AttachIscsiClient(iscsiClient, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^df3d4Eed-7AeC-6EEe-2dcb-1Ee101Abad9C$/$actions/attach-iscsi-client" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"iscsiInitiatorName":"string","iscsiInitiatorNetworkId":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"},"clientSecret":"string","enabledAuthentications":"$UNKNOWN","targetParams":[{"numVirtualTargets":0,"$objectType":"storage.v4.config.TargetParam"}],"clusterReference":"string","attachmentSite":"$UNKNOWN","iscsiTargetNames":["string"],"$objectType":"storage.v4.config.IscsiClient"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"iscsiInitiatorName":"string","iscsiInitiatorNetworkId":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"fqdn":{"value":"string","$objectType":"common.v1.config.FQDN"},"$objectType":"common.v1.config.IPAddressOrFQDN"},"clientSecret":"string","enabledAuthentications":"$UNKNOWN","targetParams":[{"numVirtualTargets":0,"$objectType":"storage.v4.config.TargetParam"}],"clusterReference":"string","attachmentSite":"$UNKNOWN","iscsiTargetNames":["string"],"$objectType":"storage.v4.config.IscsiClient"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^bE46FBFa-d5fa-D7Db-E0E4-EebFAcD9dabe$/$actions/attach-iscsi-client" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/detach-iscsi-client/{clientId}: post: tags: - VolumeGroup summary: "Detach an iSCSi client from the given Volume Group identified by {volumeGroupExtId}." description: "Detach iSCSI initiator identified by {clientId} from a Volume\ \ Group {volumeGroupExtId}." operationId: detachIscsiClient parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 3a19af7a-76f2-4a01-a77a-ae3fc600141c - name: clientId in: path description: The external identifier of the iSCSI client. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 531867b2-7575-43b3-8b4b-d85666078e15 responses: "202": description: Status of the iSCSI client detachment operation on the Volume Group. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachIscsiClientApiResponse' default: description: Status of the iSCSI client detachment operation on the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachIscsiClientApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachIscsiClientApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachIscsiClientApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.DetachIscsiClientApiResponse;\n\npublic\ \ class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^5DaEdb36-a2f2-EcC0-7E25-Ebb0a0cd8dcb$\"\ ;\n\t\tString clientId = \"^ecca3CDA-ccd5-6A1E-EC1C-18BF2Bd05ed4$\";\n\t\ \tDetachIscsiClientApiResponse detachIscsiClientApiResponse = volumeGroupApi.detachIscsiClient(volumeGroupExtId,\ \ clientId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import DetachIscsiClientApiResponse from "../src/models/storage/v4/config/DetachIscsiClientApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^8aec7EAC-0adA-5ecf-aa69-f30dC17AdCeD$"; let clientId = "^caCBFaAc-dE1F-Cbce-F9bE-28c31efDeEEB$"; volumeGroupApi.detachIscsiClient(volumeGroupExtId, clientId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^7bea94Ba-6486-dB0e-2B5D-D5daDEdD7C3A$" clientId = "^dDFd2aF2-8E2A-D28D-Ed8a-F77CB3FBeDcA$" api_response = volumeGroupApi.detach_iscsi_client(volumeGroupExtId, clientId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^7DC394CF-D8E9-31eF-2ccF-AB0ffA2dFCE4$" clientId := "^5BBDe218-cC06-BF7a-cAa9-b6dCE2bFD6eE$" response, _ := VolumeGroupApiInstance.DetachIscsiClient(volumeGroupExtId, clientId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^ccf4ECCD-2Dc5-F5bA-3a8C-cFF84FeffC8d$/$actions/detach-iscsi-client/^eD41bB3c-dEDd-Ed37-7d07-a6adcC403aFc$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^8CadeDFE-cF8A-f0E5-6D5A-cFcfddfA135d$/$actions/detach-iscsi-client/^DeaEc9D2-A8DC-fdAb-D7C4-E6A5ebeb0FD6$" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/vm-attachments: get: tags: - VolumeGroup summary: "Get a list of all the VM attachments for a Volume Group identified\ \ by {volumeGroupExtId}." description: "Query the list of VM attachments for a Volume Group identified\ \ by {volumeGroupExtId}." operationId: getVmAttachments parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b6f1cb18-846e-48d8-983b-72a37332524d - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 responses: "200": description: Paginated list of VM attachments. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVmAttachmentsApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVmAttachmentsApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVmAttachmentsApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetVmAttachmentsApiResponse;\n\npublic\ \ class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^BB6cBcB2-0e9a-f7E6-EffE-DB773782C1EB$\"\ ;\n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tGetVmAttachmentsApiResponse\ \ getVmAttachmentsApiResponse = volumeGroupApi.getVmAttachments(volumeGroupExtId,\ \ $page, $limit);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetVmAttachmentsApiResponse from "../src/models/storage/v4/config/GetVmAttachmentsApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^bCA2b3ce-d374-aD56-42ee-Ab3D153fDbEB$"; let $page = 0; let $limit = 50; volumeGroupApi.getVmAttachments(volumeGroupExtId, $page, $limit).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^DF9E224D-d2DE-0025-e6cc-C55f2CDBD2bc$" $page = 0 $limit = 50 api_response = volumeGroupApi.get_vm_attachments(volumeGroupExtId, $page, $limit) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^fDbAdE2A-19dF-eBfF-F9DA-Ea75A5bd0293$" $page := 0 $limit := 50 response, _ := VolumeGroupApiInstance.GetVmAttachments(volumeGroupExtId, $page, $limit) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^d7E5CbDD-a5f3-9dec-9D09-AFd1DDCD83aB$/vm-attachments?$limit=50&$page=0" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^FbffABFd-6Edd-AAEA-E9Fd-0bcbDf5329fF$/vm-attachments?$limit=50&$page=0" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/attach-vm: post: tags: - VolumeGroup summary: "Attach a Vm to the given Volume Group identified by {volumeGroupExtId}." description: "Attach VM to a Volume Group identified by {volumeGroupExtId}." operationId: attachVm parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 683fef7d-9cc4-473c-b84c-3e66090d64d6 requestBody: description: A model that represents a VM reference that can be associated with a Volume Group as a hypervisor attachment. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VmAttachment' required: true responses: "202": description: Status of the VM attach operation on the Volume Group. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachVmApiResponse' default: description: Status of the VM attach operation on the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachVmApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachVmApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AttachVmApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VmAttachment;\nimport dp1.sto.storage.v4.config.AttachVmApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVmAttachment vmAttachment = new VmAttachment();\n\n\t\t// VmAttachment\ \ object initializations here...\n vmAttachment.setExtId(\"\ ^b60AFCCD-ecDB-6eCC-B3cF-9C3eEdc5fdba$\"); // required field\n\n\t\tString\ \ volumeGroupExtId = \"^CCEd3e99-83EE-Ae34-cEB6-E5b7FE6b6a7b$\";\n\t\tAttachVmApiResponse\ \ attachVmApiResponse = volumeGroupApi.attachVm(vmAttachment, volumeGroupExtId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VmAttachment from "../src/models/storage/v4/config/VmAttachment"; import AttachVmApiResponse from "../src/models/storage/v4/config/AttachVmApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let vmAttachment = new VmAttachment(); // VmAttachment object initializations here... vmAttachment.setExtId("^b6F4e879-ca4c-E33E-BD1a-1FfEEAa63f3F$"); // required field let volumeGroupExtId = "^BEfBA5ce-eDeE-eAAd-C7BE-ef7fDEF6DAFc$"; volumeGroupApi.attachVm(vmAttachment, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) vmAttachment = swagger_client.VmAttachment() # VmAttachment object initializations here... vmAttachment.extId = "^Ae5dAfA5-B7CD-EB8a-afed-9FAaf94DaEfe$" # required field volumeGroupExtId = "^ba21B3Ef-4A5C-9eD1-1FaD-D6C0eAcA9e3A$" api_response = volumeGroupApi.attach_vm(vmAttachment, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true vmAttachment := import1.newVmAttachment() // VmAttachment object initializations here... volumeGroupExtId := "^aA3bEE6a-75A5-10Dd-dBA3-4D6af0fe4EcF$" response, _ := VolumeGroupApiInstance.AttachVm(vmAttachment, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^87FDF1C5-61fc-473B-27Ef-efb9d88CEd4a$/$actions/attach-vm" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"extId":"string","index":0,"$objectType":"storage.v4.config.VmAttachment"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"extId":"string","index":0,"$objectType":"storage.v4.config.VmAttachment"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^EF0C0FE3-e2Ee-A93C-66ed-5BEa114B364C$/$actions/attach-vm" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/detach-vm/{vmExtId}: post: tags: - VolumeGroup summary: "Detach a Vm from the given Volume Group identified by {volumeGroupExtId}." description: "Detach VM identified by {vmExtId} from a Volume Group {volumeGroupExtId}." operationId: detachVm parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: f9bb3685-00b7-4f61-9e9f-8787f7e5a186 - name: vmExtId in: path description: The external identifier of the VM. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: d86a93f7-b374-4241-b06d-0d3b63190be5 responses: "202": description: Status of the VM detach operation on the Volume Group. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachVmApiResponse' default: description: Status of the VM detach operation on the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachVmApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachVmApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DetachVmApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.DetachVmApiResponse;\n\npublic class JavaSdkSample\ \ {\n\tprivate static final VolumeGroupApi volumeGroupApi = new VolumeGroupApi();\n\ \n\tpublic static void main(String[] args) {\n\t\tvolumeGroupApi.getApiClient().setBasePath(\"\ https://api.nutanix.com\");\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\ \t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\n\t\tString\ \ volumeGroupExtId = \"^d18ef25e-EbEF-366C-deba-4FeB0ec4bCF7$\";\n\t\tString\ \ vmExtId = \"^BBbc3C4f-f3De-621d-3EcB-FeB6E80bFe7f$\";\n\t\tDetachVmApiResponse\ \ detachVmApiResponse = volumeGroupApi.detachVm(volumeGroupExtId, vmExtId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import DetachVmApiResponse from "../src/models/storage/v4/config/DetachVmApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^E1C4fdbd-197A-bAdc-FfeA-31DeeBbb4Cdf$"; let vmExtId = "^1cfe90bD-5Dfa-AFB9-b5E1-0Da33FF2ecca$"; volumeGroupApi.detachVm(volumeGroupExtId, vmExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^9ddfFF7B-AcA6-CeeD-4f1E-e6C1F7ACc4b2$" vmExtId = "^7eAf8B4D-2c3A-acCE-CF68-FC8CebFeCccA$" api_response = volumeGroupApi.detach_vm(volumeGroupExtId, vmExtId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^BbF0C2De-9CDf-dead-8ccd-f7AfCf0cf81c$" vmExtId := "^B839F4F6-EB4f-ECB0-D3Ef-8D73bDd6B3C6$" response, _ := VolumeGroupApiInstance.DetachVm(volumeGroupExtId, vmExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^3E06A6fF-B8bF-680B-aAb5-BdeaaCEAC488$/$actions/detach-vm/^feEE2EFf-f1D6-f77B-EdB2-F60Bbb4DCA1A$" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^aB3bBfAD-3beA-Ad4b-57cb-FdeE1DafAf7f$/$actions/detach-vm/^dfF00A8A-10Ea-e2f2-dbaD-3aA5FcFf3FAD$" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/category-associations: get: tags: - VolumeGroup summary: "Get a list of all category details that are associated with the Volume\ \ Group identified by {volumeGroupExtId}." description: "Query the category details that are associated with the Volume\ \ Group identified by {volumeGroupExtId}." operationId: getCategoryAssociations parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 183040b6-2e77-4067-9e71-d82198eb50fd - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. required: false style: form explode: false schema: minimum: 0 type: integer description: | A URL query parameter that specifies the page number of the result set. 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 will be set to its nearest bound. In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page. format: int32 default: 0 - name: $limit in: query description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. required: false style: form explode: false schema: maximum: 100 type: integer description: | A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100. format: int32 default: 50 responses: "200": description: Paginated list of category details associated with the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetCategoryAssociationsApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetCategoryAssociationsApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetCategoryAssociationsApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetCategoryAssociationsApiResponse;\n\n\ public class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^B6FEdBE9-b003-DEAb-DCAb-B1BcDE7F9c62$\"\ ;\n\t\tint $page = 0;\n\t\tint $limit = 50;\n\t\tGetCategoryAssociationsApiResponse\ \ getCategoryAssociationsApiResponse = volumeGroupApi.getCategoryAssociations(volumeGroupExtId,\ \ $page, $limit);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetCategoryAssociationsApiResponse from "../src/models/storage/v4/config/GetCategoryAssociationsApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^C4EEabFf-5dc2-B46e-d8Fd-dAdBe64cC9ef$"; let $page = 0; let $limit = 50; volumeGroupApi.getCategoryAssociations(volumeGroupExtId, $page, $limit).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^BeFDBF5f-Bbc6-c3D6-Fc7E-8A89edb7A2fC$" $page = 0 $limit = 50 api_response = volumeGroupApi.get_category_associations(volumeGroupExtId, $page, $limit) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^1cC71dAF-04fc-C09A-fFF5-CeCFf2DDa4bf$" $page := 0 $limit := 50 response, _ := VolumeGroupApiInstance.GetCategoryAssociations(volumeGroupExtId, $page, $limit) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^b5bbAB59-FCBD-eCB5-0f8C-d2DeAB23AbcE$/category-associations?$limit=50&$page=0" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^5dfAbedb-3850-57A2-F13f-cdD057cCC5aE$/category-associations?$limit=50&$page=0" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/associate-category: post: tags: - VolumeGroup summary: "Associate category to a Volume Group identified by {volumeGroupExtId}." description: "Associate category to a Volume Group identified by {volumeGroupExtId}." operationId: associateCategory parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 7469cdce-d545-4fdd-a883-a18e2bebfecd requestBody: description: The list of categories to be associated/disassociated with the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CategoryEntityReferences' required: true responses: "204": description: Associate category operation on the Volume Group is successful. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AssociateCategoryApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AssociateCategoryApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.AssociateCategoryApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.CategoryEntityReferences;\nimport dp1.sto.storage.v4.config.AssociateCategoryApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tCategoryEntityReferences categoryEntityReferences = new CategoryEntityReferences();\n\ \n\t\t// CategoryEntityReferences object initializations here...\n\n\t\t\ String volumeGroupExtId = \"^CEe752fe-facC-aA90-Ccde-2A8C13B5cCE7$\";\n\t\ \tAssociateCategoryApiResponse associateCategoryApiResponse = volumeGroupApi.associateCategory(categoryEntityReferences,\ \ volumeGroupExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import CategoryEntityReferences from "../src/models/storage/v4/config/CategoryEntityReferences"; import AssociateCategoryApiResponse from "../src/models/storage/v4/config/AssociateCategoryApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let categoryEntityReferences = new CategoryEntityReferences(); // CategoryEntityReferences object initializations here... let volumeGroupExtId = "^c3cFaa2D-D81e-1e15-BD4a-deA0EE336D2B$"; volumeGroupApi.associateCategory(categoryEntityReferences, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) categoryEntityReferences = swagger_client.CategoryEntityReferences() # CategoryEntityReferences object initializations here... volumeGroupExtId = "^6ddBAFF8-2ADf-44A6-Edc4-aA2B7f29Dc35$" api_response = volumeGroupApi.associate_category(categoryEntityReferences, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true categoryEntityReferences := import1.newCategoryEntityReferences() // CategoryEntityReferences object initializations here... volumeGroupExtId := "^fF0a6C2D-bdfb-D7dF-d6b4-c2EF1eFF133B$" response, _ := VolumeGroupApiInstance.AssociateCategory(categoryEntityReferences, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^cda485ca-FB4E-def0-A6EE-B3b3BC2Faca3$/$actions/associate-category" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"categories":[{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"}],"$objectType":"storage.v4.config.CategoryEntityReferences"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"categories":[{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"}],"$objectType":"storage.v4.config.CategoryEntityReferences"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^fc68cbB8-Bfa8-FfbA-5ddD-BFCdB8C5dEe1$/$actions/associate-category" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/disassociate-category: post: tags: - VolumeGroup summary: "Disassociate category from a Volume Group identified by {volumeGroupExtId}." description: "Disassociate category from a Volume Group identified by {volumeGroupExtId}." operationId: disassociateCategory parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 31b27351-18ed-481b-bd12-4e0e6ee3d0dc requestBody: description: The list of categories to be associated/disassociated with the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.CategoryEntityReferences' required: true responses: "204": description: Disassociate category operation on the Volume Group is successful. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DisassociateCategoryApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DisassociateCategoryApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.DisassociateCategoryApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.CategoryEntityReferences;\nimport dp1.sto.storage.v4.config.DisassociateCategoryApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tCategoryEntityReferences categoryEntityReferences = new CategoryEntityReferences();\n\ \n\t\t// CategoryEntityReferences object initializations here...\n\n\t\t\ String volumeGroupExtId = \"^a4c2baa6-4Fc6-EBF9-Cc4D-1C7daD2dfc2e$\";\n\t\ \tDisassociateCategoryApiResponse disassociateCategoryApiResponse = volumeGroupApi.disassociateCategory(categoryEntityReferences,\ \ volumeGroupExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import CategoryEntityReferences from "../src/models/storage/v4/config/CategoryEntityReferences"; import DisassociateCategoryApiResponse from "../src/models/storage/v4/config/DisassociateCategoryApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let categoryEntityReferences = new CategoryEntityReferences(); // CategoryEntityReferences object initializations here... let volumeGroupExtId = "^BD76F10c-3e0A-3EeF-BEc7-FDeaCd36AdDA$"; volumeGroupApi.disassociateCategory(categoryEntityReferences, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) categoryEntityReferences = swagger_client.CategoryEntityReferences() # CategoryEntityReferences object initializations here... volumeGroupExtId = "^7d59DbcF-BC5D-Dc1E-0ad8-5B6B0dfeE6DC$" api_response = volumeGroupApi.disassociate_category(categoryEntityReferences, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true categoryEntityReferences := import1.newCategoryEntityReferences() // CategoryEntityReferences object initializations here... volumeGroupExtId := "^f00EFc20-35aF-C620-afCc-EBe1cD207ACB$" response, _ := VolumeGroupApiInstance.DisassociateCategory(categoryEntityReferences, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^29FecD76-B5B3-EA6D-acFA-82beDCB8e71a$/$actions/disassociate-category" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"categories":[{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"}],"$objectType":"storage.v4.config.CategoryEntityReferences"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"categories":[{"extId":"string","name":"string","uris":["string"],"entityType":"$UNKNOWN","$objectType":"common.v1.config.EntityReference"}],"$objectType":"storage.v4.config.CategoryEntityReferences"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^F7C44CaF-FfEE-Fd7b-Ac9E-7EbE5BAe658d$/$actions/disassociate-category" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/migrate: post: tags: - VolumeGroup summary: "Migrate Volume Group identified by {volumeGroupExtId}." description: "Migrate Volume Group identified by {volumeGroupExtId}." operationId: migrateVolumeGroup parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 3e39cd15-1c36-40f6-9c9a-397c3cb136ed requestBody: description: Specification for the migrate action on the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroupMigrationSpec' required: true responses: "202": description: Task Id to monitor the progress of Volume Group migrate operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.MigrateVolumeGroupApiResponse' default: description: Task Id to monitor the progress of Volume Group migrate operation. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.MigrateVolumeGroupApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.MigrateVolumeGroupApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.MigrateVolumeGroupApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VolumeGroupMigrationSpec;\nimport dp1.sto.storage.v4.config.MigrateVolumeGroupApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVolumeGroupMigrationSpec volumeGroupMigrationSpec = new VolumeGroupMigrationSpec();\n\ \n\t\t// VolumeGroupMigrationSpec object initializations here...\n \ \ volumeGroupMigrationSpec.setTargetAvailabilityZoneId(\"^7CfaE8dB-bFaB-9ACf-E7AE-b0DaEE2Aac3e$\"\ ); // required field\n\n\t\tString volumeGroupExtId = \"^bfCaDfD8-3c42-7d5d-91Db-8feAa01DAa18$\"\ ;\n\t\tMigrateVolumeGroupApiResponse migrateVolumeGroupApiResponse = volumeGroupApi.migrateVolumeGroup(volumeGroupMigrationSpec,\ \ volumeGroupExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VolumeGroupMigrationSpec from "../src/models/storage/v4/config/VolumeGroupMigrationSpec"; import MigrateVolumeGroupApiResponse from "../src/models/storage/v4/config/MigrateVolumeGroupApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupMigrationSpec = new VolumeGroupMigrationSpec(); // VolumeGroupMigrationSpec object initializations here... volumeGroupMigrationSpec.setTargetAvailabilityZoneId("^EBB73Fca-24ae-ECdD-d2e3-fb89bDAcEDE3$"); // required field let volumeGroupExtId = "^eDb9b5d1-ACbf-a834-aadf-DD0Dc2bC0623$"; volumeGroupApi.migrateVolumeGroup(volumeGroupMigrationSpec, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupMigrationSpec = swagger_client.VolumeGroupMigrationSpec() # VolumeGroupMigrationSpec object initializations here... volumeGroupMigrationSpec.targetAvailabilityZoneId = "^f1C5EbFd-1CDf-6Cf8-ddB2-dAdefEd539bD$" # required field volumeGroupExtId = "^8Fc122Bd-9DeD-dCc3-eA7A-C0AfF5E4F2D6$" api_response = volumeGroupApi.migrate_volume_group(volumeGroupMigrationSpec, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupMigrationSpec := import1.newVolumeGroupMigrationSpec() // VolumeGroupMigrationSpec object initializations here... volumeGroupExtId := "^dECa9dEe-eCeD-BD46-CBFa-BbFaCfBe55Cd$" response, _ := VolumeGroupApiInstance.MigrateVolumeGroup(volumeGroupMigrationSpec, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^bfFCb8DE-87A5-Da9D-BCEd-C4BD5Dac502F$/$actions/migrate" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"targetAvailabilityZoneId":"string","targetClusterId":"string","$objectType":"storage.v4.config.VolumeGroupMigrationSpec"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"targetAvailabilityZoneId":"string","targetClusterId":"string","$objectType":"storage.v4.config.VolumeGroupMigrationSpec"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^C124a6f4-2e7a-c6Fe-80f2-eCFa8Ae99DBB$/$actions/migrate" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/revert: post: tags: - VolumeGroup summary: "Revert a Volume Group identified by {volumeGroupExtId}." description: "Revert a Volume Group identified by {volumeGroupExtId}. This API\ \ will perform an in-place restore from a specified Volume Group recovery\ \ point." operationId: revertVolumeGroup parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b6ed7070-9c02-434e-990c-703b8b1c3c97 requestBody: description: Specify the Volume Group recovery point Id to which the Volume Group would be reverted to. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroupRevertSpec' required: true responses: "202": description: Task Id to monitor the progress of Volume Group revert operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.RevertVolumeGroupApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.RevertVolumeGroupApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.RevertVolumeGroupApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.VolumeGroupRevertSpec;\nimport dp1.sto.storage.v4.config.RevertVolumeGroupApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tVolumeGroupRevertSpec volumeGroupRevertSpec = new VolumeGroupRevertSpec();\n\ \n\t\t// VolumeGroupRevertSpec object initializations here...\n \ \ volumeGroupRevertSpec.setVolumeGroupRecoveryPointExtId(\"^eCcaBdFD-4a65-bDe6-95e6-fe8fED846cBB$\"\ ); // required field\n\n\t\tString volumeGroupExtId = \"^40eAAaA0-dBDC-E01c-ec7d-82f839AFd9Ba$\"\ ;\n\t\tRevertVolumeGroupApiResponse revertVolumeGroupApiResponse = volumeGroupApi.revertVolumeGroup(volumeGroupRevertSpec,\ \ volumeGroupExtId);\n\t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import VolumeGroupRevertSpec from "../src/models/storage/v4/config/VolumeGroupRevertSpec"; import RevertVolumeGroupApiResponse from "../src/models/storage/v4/config/RevertVolumeGroupApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupRevertSpec = new VolumeGroupRevertSpec(); // VolumeGroupRevertSpec object initializations here... volumeGroupRevertSpec.setVolumeGroupRecoveryPointExtId("^A09b48fe-cAd7-C9D7-5a5c-3DbE9a3BFBDe$"); // required field let volumeGroupExtId = "^BBdbBfb3-fCbB-0dA1-DB0C-bEf3fec6Fde1$"; volumeGroupApi.revertVolumeGroup(volumeGroupRevertSpec, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupRevertSpec = swagger_client.VolumeGroupRevertSpec() # VolumeGroupRevertSpec object initializations here... volumeGroupRevertSpec.volumeGroupRecoveryPointExtId = "^e80bC8BE-6EfF-aDd1-fEee-842E6CbfeF6d$" # required field volumeGroupExtId = "^3baf37aD-A65e-Cca8-e460-0B9eb1FDcA15$" api_response = volumeGroupApi.revert_volume_group(volumeGroupRevertSpec, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupRevertSpec := import1.newVolumeGroupRevertSpec() // VolumeGroupRevertSpec object initializations here... volumeGroupExtId := "^Cb78Bc1b-aCAe-BD9B-Ca45-d4aBBfF7CfB7$" response, _ := VolumeGroupApiInstance.RevertVolumeGroup(volumeGroupRevertSpec, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^CfDc046d-BE5d-Ffe5-ce61-ad8caB4e2bBb$/$actions/revert" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"volumeGroupRecoveryPointExtId":"string","$objectType":"storage.v4.config.VolumeGroupRevertSpec"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"volumeGroupRecoveryPointExtId":"string","$objectType":"storage.v4.config.VolumeGroupRevertSpec"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^6daC4dec-7DBC-860b-c1D9-8c0BCABca2BC$/$actions/revert" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/pause-synchronous-replication: post: tags: - VolumeGroup summary: "Pauses replication for a given protected Volume Group identified by\ \ {volumeGroupExtId}." description: "Pauses replication for a given protected Volume Group identified\ \ by {volumeGroupExtId} using protection policy with synchronous replication\ \ RPO." operationId: pauseVolumeGroupSynchronousReplication parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 18d45830-9b20-4e39-8986-841fad7a0d7a responses: "202": description: Task Id to monitor the progress of Volume Group pause synchronous replication operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?):\\/)?\\/?([^:\\/\\s]+)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.PauseVolumeGroupSynchronousReplicationApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.PauseVolumeGroupSynchronousReplicationApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.PauseVolumeGroupSynchronousReplicationApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.PauseVolumeGroupSynchronousReplicationApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^B5D245BB-cBed-eF52-3cFc-ba2a6fA450fb$\"\ ;\n\t\tPauseVolumeGroupSynchronousReplicationApiResponse pauseVolumeGroupSynchronousReplicationApiResponse\ \ = volumeGroupApi.pauseVolumeGroupSynchronousReplication(volumeGroupExtId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import PauseVolumeGroupSynchronousReplicationApiResponse from "../src/models/storage/v4/config/PauseVolumeGroupSynchronousReplicationApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^8b8E9cED-EDdE-C5D6-cBfC-Fd6AD0DB72BD$"; volumeGroupApi.pauseVolumeGroupSynchronousReplication(volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^87FCfe20-bBB4-942c-B5fD-72C85EfCfDB5$" api_response = volumeGroupApi.pause_volume_group_synchronous_replication(volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^433b00B6-AE2F-83CC-F9D1-eC3e7CDC65ba$" response, _ := VolumeGroupApiInstance.PauseVolumeGroupSynchronousReplication(volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^3315bBC6-A299-4Faf-FCEB-dEaAbBCAd2dE$/$actions/pause-synchronous-replication" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^fAF9051c-9BBe-97c5-c26F-9d26CaeAFAA8$/$actions/pause-synchronous-replication" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/resume-synchronous-replication: post: tags: - VolumeGroup summary: "Resumes replication for a given protected Volume Group identified\ \ by {volumeGroupExtId}." description: "Resumes replication for a given protected Volume Group identified\ \ by {volumeGroupExtId} using protection policy with synchronous replication\ \ RPO." operationId: resumeVolumeGroupSynchronousReplication parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: cbe97aaf-28b3-49d0-9cde-706aa2f6664d responses: "204": description: Volume Group resume of synchronous replication operation has been initiated. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.ResumeVolumeGroupSynchronousReplicationApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.ResumeVolumeGroupSynchronousReplicationApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.ResumeVolumeGroupSynchronousReplicationApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.ResumeVolumeGroupSynchronousReplicationApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^3eaef9ce-E857-Fced-EfDe-FacaCa9B0A6A$\"\ ;\n\t\tResumeVolumeGroupSynchronousReplicationApiResponse resumeVolumeGroupSynchronousReplicationApiResponse\ \ = volumeGroupApi.resumeVolumeGroupSynchronousReplication(volumeGroupExtId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import ResumeVolumeGroupSynchronousReplicationApiResponse from "../src/models/storage/v4/config/ResumeVolumeGroupSynchronousReplicationApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^f6b7cdd7-9f16-C351-b8f8-EAcEF914Fe5E$"; volumeGroupApi.resumeVolumeGroupSynchronousReplication(volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^450FbfeF-aaAe-D2dB-5B1d-BF0cCe84edE9$" api_response = volumeGroupApi.resume_volume_group_synchronous_replication(volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^2acac7bE-7FAe-1caa-Cb1A-4094A1f5cda0$" response, _ := VolumeGroupApiInstance.ResumeVolumeGroupSynchronousReplication(volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^Bf97aE75-dc28-737B-fADD-28BEB9dC1817$/$actions/resume-synchronous-replication" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^C83Be1eC-cE5b-B0f2-EBfA-f2DcecAE0dB3$/$actions/resume-synchronous-replication" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/metadata-info: get: tags: - VolumeGroup summary: Fetches metadata information associated with a Volume Group. description: "Query for metadata information which is associated with the Volume\ \ Group identified by {volumeGroupExtId}." operationId: getVolumeGroupMetadataInfo parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 2e9f41ff-0169-410b-bee6-b0c8cf25b1f5 responses: "200": description: Metadata information associated with the Volume Group. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupMetadataInfoApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupMetadataInfoApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.GetVolumeGroupMetadataInfoApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.storage.v4.config.GetVolumeGroupMetadataInfoApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tString volumeGroupExtId = \"^a7E1e3A5-AFaD-3CE3-deF2-9D657507b6fA$\"\ ;\n\t\tGetVolumeGroupMetadataInfoApiResponse getVolumeGroupMetadataInfoApiResponse\ \ = volumeGroupApi.getVolumeGroupMetadataInfo(volumeGroupExtId);\n\t}\n\ }\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import GetVolumeGroupMetadataInfoApiResponse from "../src/models/storage/v4/config/GetVolumeGroupMetadataInfoApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let volumeGroupExtId = "^aDf7C6d2-3Ac7-4c8D-54b5-d4D596Da5F67$"; volumeGroupApi.getVolumeGroupMetadataInfo(volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) volumeGroupExtId = "^5cD3Ffdb-EDaC-f14D-D1EC-39CAA3C98C8C$" api_response = volumeGroupApi.get_volume_group_metadata_info(volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true volumeGroupExtId := "^CD574Efc-CaFF-Be8B-E5ED-8fC8acf32fbc$" response, _ := VolumeGroupApiInstance.GetVolumeGroupMetadataInfo(volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request GET \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^b47ebDdF-Bc1A-E820-FD7A-e9Bc33bfB5E6$/metadata-info" \ --header 'Accept: application/json' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^3c400adf-0eeF-7AcD-BbB9-6baeDAFEAF8f$/metadata-info" /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/update-metadata-info: post: tags: - VolumeGroup summary: Updates metadata information associated with a Volume Group. description: "Update the metadata information associated with the Volume Group\ \ identified by {volumeGroupExtId}." operationId: updateVolumeGroupMetadataInfo parameters: - name: volumeGroupExtId in: path description: The external identifier of the Volume Group. required: true style: simple explode: false schema: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b78adad8-fd00-4e2f-a8f4-d5eaecac31b8 requestBody: description: The list of metadata information associated with the Volume Group to be updated. content: application/json: schema: $ref: '#/components/schemas/common.v1.r0.a3.config.Metadata' required: true responses: "204": description: Metadata Information update on the Volume Group is successful. content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupMetadataInfoApiResponse' "4XX": description: Client error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupMetadataInfoApiResponse' "5XX": description: Server error response content: application/json: schema: $ref: '#/components/schemas/storage.v4.r0.a3.config.UpdateVolumeGroupMetadataInfoApiResponse' x-code-samples: - lang: Java source: "\npackage sample;\n\nimport sto.java.client.api.VolumeGroupApi;\n\ import dp1.sto.common.v1.config.Metadata;\nimport dp1.sto.storage.v4.config.UpdateVolumeGroupMetadataInfoApiResponse;\n\ \npublic class JavaSdkSample {\n\tprivate static final VolumeGroupApi volumeGroupApi\ \ = new VolumeGroupApi();\n\n\tpublic static void main(String[] args) {\n\ \t\tvolumeGroupApi.getApiClient().setBasePath(\"https://api.nutanix.com\"\ );\n\t\tvolumeGroupApi.getApiClient().setBackOffPeriod(100);\n\t\tvolumeGroupApi.getApiClient().setMaxRetryAttempts(2);\n\ \n\t\tMetadata metadata = new Metadata();\n\n\t\t// Metadata object initializations\ \ here...\n\n\t\tString volumeGroupExtId = \"^AEF9B6BB-6cb9-fa4d-e8FC-1EafaEffdBA4$\"\ ;\n\t\tUpdateVolumeGroupMetadataInfoApiResponse updateVolumeGroupMetadataInfoApiResponse\ \ = volumeGroupApi.updateVolumeGroupMetadataInfo(metadata, volumeGroupExtId);\n\ \t}\n}\n" - lang: JavaScript source: |2 import {ApiClient} from "../src/ApiClient"; import {VolumeGroupApi} from "../src/apis/VolumeGroup-endpoints"; import Metadata from "../src/models/common/v1/config/Metadata"; import UpdateVolumeGroupMetadataInfoApiResponse from "../src/models/storage/v4/config/UpdateVolumeGroupMetadataInfoApiResponse"; var apiClientInstance = new ApiClient(); apiClientInstance.maxRetryAttempts = 2; apiClientInstance.backOffPeriod = 500; apiClientInstance.basePath = "https://api.nutanix.com"; var volumeGroupApi = new VolumeGroupApi(apiClientInstance); function sample() { let metadata = new Metadata(); // Metadata object initializations here... let volumeGroupExtId = "^6f0AdBdF-5F1B-70Cd-5cff-CA836FcfAfEb$"; volumeGroupApi.updateVolumeGroupMetadataInfo(metadata, volumeGroupExtId).then(({data, response}) => console.log(response.status); console.log(data.getData()); done(); }).catch((error) => { console.log(error); done(error); }); } - lang: Python source: |2 import swagger_client if __name__ == "__main__": configuration = swagger_client.configuration.Configuration() configuration.host = "http://api.nutanix.com" api_client = swagger_client.ApiClient(configuration, max_retry_attempts=1, retry_backoff_period=100) volumeGroupApi = swagger_client.VolumeGroupApi(api_client) metadata = swagger_client.Metadata() # Metadata object initializations here... volumeGroupExtId = "^5eEa9D99-AaAF-5a02-FdB3-ec72b2b7F37B$" api_response = volumeGroupApi.update_volume_group_metadata_info(metadata, volumeGroupExtId) - lang: Go source: |2+ package main import { "fmt" import1 "storage_go_sdk/models/storage/v1/defaultapi" "storage_go_sdk/api" "storage_go_sdk/client" } func main() { var VolumeGroupApiInstance *api.VolumeGroupApi VolumeGroupApiInstance = api.NewVolumeGroupApi() VolumeGroupApiInstance.ApiClient.BasePath = "http://localhost:8080" VolumeGroupApiInstance.ApiClient.AllowVersionNegotiation = true metadata := import1.newMetadata() // Metadata object initializations here... volumeGroupExtId := "^5F7CDd46-fAFE-88eF-BeE1-eeCCBCFfdfaB$" response, _ := VolumeGroupApiInstance.UpdateVolumeGroupMetadataInfo(metadata, volumeGroupExtId) fmt.Println(response) } - lang: cURL source: |2 curl --request POST \ --url "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^eFA7adDf-5cDF-c7Cc-5A3F-4Eaf627a9ECC$/$actions/update-metadata-info" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data {"ownerReferenceId":"string","ownerUserName":"string","projectReferenceId":"string","projectName":"string","categoryIds":["string"],"$objectType":"common.v1.config.Metadata"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --body-data {"ownerReferenceId":"string","ownerUserName":"string","projectReferenceId":"string","projectName":"string","categoryIds":["string"],"$objectType":"common.v1.config.Metadata"} \ - "https://api.nutanix.com/storage/v4.0.a3/config/volume-groups/^cAe389EE-F343-E239-B483-EA8ca5ee3D6a$/$actions/update-metadata-info" components: schemas: storage.v4.r0.a3.config.StorageContainersResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainer' - type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Message' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in api path /storage/v4.0.a3/config/storage-containers Get operation storage.v4.r0.a3.config.StorageContainer: allOf: - $ref: '#/components/schemas/common.v1.r0.a3.response.ExternalizableAbstractModel' - type: object properties: containerId: type: string description: Storage container instance Id. example: string containerExtId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: Uuid of the Storage container. example: a3fb4acf-9a14-4e4a-bfcd-77b7015da37b ownerUuid: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: Id of the owner. example: bde4bc6e-f0a8-420a-b7a8-86f2a6259ac5 name: maxLength: 75 type: string description: Name of the Storage container. example: string clusterExtId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: Owning cluster uuid of ctorage Container. readOnly: true example: b6930d37-03e0-4bb1-ac2b-a63b91a96e83 storagePoolUuid: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: Owning storage pool uuid of the Storage container instance. readOnly: true example: ae483931-7f0f-4544-ac3e-ba654d59c5a9 markedForRemoval: type: boolean description: Indicates whether the Storage container is marked for removal. readOnly: true example: true maxCapacity: type: integer description: Maximum capacity of the Storage container. format: int64 readOnly: true example: 72 totalExplicitReservedCapacity: type: integer description: Total explicit reserved capacity of the Storage container. format: int64 example: 75 totalImplicitReservedCapacity: type: integer description: Total implicit reserved capacity of the Storage container. format: int64 readOnly: true example: 99 advertisedCapacity: type: integer description: Total advertised capacity of the Storage container. format: int64 example: 5 replicationFactor: type: integer description: Replication factor of the Storage container. format: int32 example: 22 oplogReplicationFactor: type: integer description: Oplog replication factor of the Storage container. format: int32 readOnly: true example: 26 nfsWhitelistAddress: type: array description: List of NFS addresses which needs to be whitelisted. items: $ref: '#/components/schemas/common.v1.r0.a3.config.IPAddressOrFQDN' isNfsWhitelistInherited: type: boolean description: Indicates whether the NFS whitelist is inherited from global config. readOnly: true example: false randomIoPreference: type: array description: List of random IO preference tier. items: type: string example: string seqIoPreference: type: array description: List of sequential IO preference tier. items: type: string example: string downMigrateTimesInSecs: type: object additionalProperties: type: integer format: int32 description: Migrate down time in seconds for random IO preference tier. erasureCode: $ref: '#/components/schemas/storage.v4.r0.a3.config.ErasureCodeStatus' inlineEcEnabled: type: boolean description: Indicates whether the inline erasure coding is enabled. example: false preferHigherECFaultDomain: type: boolean description: Indicates whether to prefer a higher erasure code fault domain. example: true erasureCodeDelaySecs: type: integer description: Erasure code delay in seconds. format: int32 example: 17 fingerPrintOnWrite: $ref: '#/components/schemas/storage.v4.r0.a3.config.FingerPrintOnWrite' onDiskDedup: $ref: '#/components/schemas/storage.v4.r0.a3.config.OnDiskDedup' compressionEnabled: type: boolean description: Indicates whether the compression is enabled. example: true compressionDelayInSecs: type: integer description: The compression delay in seconds. format: int32 example: 92 isNutanixManaged: type: boolean description: Indicates whether the Storage container is managed by Nutanix. example: false enableSoftwareEncryption: type: boolean description: Indicates whether the Storage container has enabled software encryption. nullable: true example: false vstoreNameList: type: array description: List of volume stores in the Storage container. readOnly: true items: type: string example: string mappedRemoteContainers: type: object additionalProperties: type: string description: Map of remote Storage containers. readOnly: true encrypted: type: boolean description: Indicates whether the Storage container is encrypted or not. readOnly: true example: false affinityHostUuid: type: string description: Affinity host Id for RF 1 Storage container. example: string additionalProperties: false storage.v4.r0.a3.config.StorageContainerTaskResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Message' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/mount\ \ Post operation" storage.v4.r0.a3.config.ErasureCodeStatus: type: string description: Indicates the possible values for the erasure code. enum: - NONE - "OFF" - "ON" - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.FingerPrintOnWrite: type: string description: Indicates the possible values that can be set to finger print on write. enum: - NONE - "OFF" - "ON" - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.OnDiskDedup: type: string description: Indicates the possible values for on disk deduplication. enum: - NONE - "OFF" - POST_PROCESS - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.StorageContainerResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageContainer' - type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Message' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/storage-containers/{containerExtId}\ \ Get operation" storage.v4.r0.a3.config.DataStoreMount: title: Mount Storage container. type: object properties: datastoreName: maxLength: 255 type: string description: Name of the Data Store. example: string containerName: maxLength: 255 type: string description: Name of the Storage container. example: string nodeIds: type: array description: The Zeus config Ids of the nodes where the NFS Data Store has to be created. items: type: string example: string nodeExtIds: type: array description: The uuids of the nodes where the NFS Data Store have to be created. items: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: b18eafdd-f185-4e15-95f2-0c6d53d16bcb readOnly: type: boolean description: Indicates if the host system has only the read-only access to the NFS share. example: true targetPath: type: string description: The target path on which to mount the NFS Data Store. example: string additionalProperties: false description: create NFS Data Stores on the ESX hosts. storage.v4.r0.a3.config.DataStoreUnmount: title: Mount Storage container. type: object properties: datastoreName: maxLength: 255 type: string description: Name of the Data Store. example: string nodeIds: type: array description: The Zeus config Ids of the nodes where the NFS Data Store has to be created. items: type: string example: string nodeExtIds: type: array description: The uuids of the nodes where the NFS Data Store have to be created. items: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: cd642c30-efee-4723-ba8b-c193fa6695eb additionalProperties: false description: create NFS Data Stores on the ESX hosts. storage.v4.r0.a3.config.DataStoreTaskResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Message' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/storage-containers/{containerExtId}/$actions/unmount\ \ Post operation" storage.v4.r0.a3.config.DataStoreResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.DataStore' - type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Message' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in api path /storage/v4.0.a3/config/storage-containers/datastores Get operation storage.v4.r0.a3.config.DataStore: allOf: - $ref: '#/components/schemas/common.v1.r0.a3.response.ExternalizableAbstractModel' - title: Data Store entity. type: object properties: datastoreName: maxLength: 255 type: string description: Name of the Data Store. example: string containerId: type: string description: Storage container instance Id. example: string containerExtId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: Uuid of the Storage container. example: bee55ed6-5cee-4017-aa48-9689d7bd9709 containerName: maxLength: 255 type: string description: Name of the Storage container. example: string hostId: type: string description: Uuid of the host for Data Store. example: string hostExtId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: ExtId of the host for Data Store. example: 1900ec81-da61-46b3-a3ba-2e0a68ca760b hostIpAddress: pattern: '#/components/schemas/common.v1.r0.a3.config.IPAddressOrFQDN' type: string description: Host IP for Data Store. example: string capacity: type: integer description: Maximum capacity of the Storage container. format: int64 example: 25 freeSpace: type: integer description: The free space in the Data Store. format: int64 example: 19 vmNames: type: array description: List of VMs name in the Data Store. items: type: string example: string additionalProperties: false description: Entity describing all the attributes related to a Data Store instance. common.v1.r0.a3.response.ExternalizableAbstractModel: description: | A model that represents an object instance that is accessible through an API endpoint. Instances of this type get an extId field that contains the globally unique identifier for that instance. Externally accessible instances are always tenant aware and therefore extend the TenantAwareModel allOf: - $ref: '#/components/schemas/common.v1.r0.a3.config.TenantAwareModel' - type: object properties: extId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: | A globally unique identifier of an instance that is suitable for external consumption. nullable: true example: ac7be6a0-e497-4e10-8744-ab55a2f96402 links: type: array description: | A HATEOAS style link for the response. Each link contains a user friendly name identifying the link and an address for retrieving the particular resource. items: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiLink' additionalProperties: false common.v1.r0.a3.config.IPAddressOrFQDN: type: object properties: ipv4: $ref: '#/components/schemas/common.v1.r0.a3.config.IPv4Address' ipv6: $ref: '#/components/schemas/common.v1.r0.a3.config.IPv6Address' fqdn: $ref: '#/components/schemas/common.v1.r0.a3.config.FQDN' additionalProperties: false description: An unique address that identifies a device on the internet or a local network in IPv4/IPv6 format or a Fully Qualified Domain Name. common.v1.r0.a3.config.TenantAwareModel: type: object properties: tenantId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: | A globally unique identifier that represents the tenant that owns this entity. It is automatically assigned by the system and is immutable from an API consumer perspective (some use cases may cause this Id to change - for instance a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server). readOnly: true example: 69d77424-8db5-4a6a-878a-c2ef281783df additionalProperties: false description: | A model base class whose instances are bound to a specific tenant. This model adds a tenantId to the base model class that it extends and is automatically set by the server. common.v1.r0.a3.response.ApiLink: type: object properties: href: type: string description: | The URL at which the entity described by this link can be accessed. example: string rel: type: string description: | A name that identifies the relationship of this link to the object that is returned by the URL. The special value of "self" identifies the URL for the object. example: string additionalProperties: false description: | A HATEOAS style link for the response. Each link contains a user friendly name identifying the link and an address for retrieving the particular resource. common.v1.r0.a3.config.IPv4Address: type: object properties: value: pattern: "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" type: string example: 180.178.15.134 prefixLength: maximum: 32 minimum: 0 type: integer description: | The prefix length of the network to which this host IPv4 address belongs. format: int32 default: 32 additionalProperties: false common.v1.r0.a3.config.IPv6Address: type: object properties: value: pattern: "^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\\\ .){3}[0-9]{1,3}$)(([0-9a-fA-F]{1,4}:){0,5}|:)((:[0-9a-fA-F]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\\ .){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}$)(([0-9a-fA-F]{1,4}:){1,7}|:)((:[0-9a-fA-F]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})$" type: string example: d9a6:4df8:ddfd:839c:6c4e:ae35:c0ba:4eae prefixLength: maximum: 128 minimum: 0 type: integer description: | The prefix length of the network to which this host IPv6 address belongs. format: int32 default: 128 additionalProperties: false common.v1.r0.a3.config.FQDN: type: object properties: value: pattern: "^(?:[a-z0-9][\\w\\-]*[a-z0-9]*\\.)*(?:(?:(?:[a-z0-9][\\w\\-]*[a-z0-9]*)(?:\\\ .[a-z0-9]+)?))$" type: string example: string additionalProperties: false description: | A fully qualified domain name specifying its exact location in the tree hierarchy of the Domain Name System. storage.v4.r0.a3.error.ErrorResponse: type: object properties: error: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.error.AppMessage' - $ref: '#/components/schemas/storage.v4.r0.a3.error.SchemaValidationError' additionalProperties: false description: This schema is auto-generated by the Open API Dev Platform as REST response for 4xx and 5xx error responses. storage.v4.r0.a3.error.AppMessage: type: object properties: message: type: string example: string severity: $ref: '#/components/schemas/common.v1.r0.a3.config.MessageSeverity' code: type: string example: string locale: type: string description: The locale for the message description. default: en_US errorGroup: type: string example: string argumentsMap: type: object additionalProperties: type: string additionalProperties: false description: This schema is generated from AppMessage.java storage.v4.r0.a3.error.MessageSeverity: type: string description: Enum schema MessageSeverity enum: - INFO - WARNING - ERROR - $UNKNOWN - $REDACTED x-codegen-hint: $any: - type: entity-identifier properties: identifiers: - value: $UNKNOWN index: 201 - value: $REDACTED index: 202 - value: INFO index: 203 - value: WARNING index: 204 - value: ERROR index: 205 storage.v4.r0.a3.error.SchemaValidationError: type: object properties: timestamp: type: string example: string statusCode: type: integer example: 25 error: type: string example: string path: type: string example: string validationErrorMessages: type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.error.SchemaValidationErrorMessage' additionalProperties: false description: This schema is generated from SchemaValidationError.java storage.v4.r0.a3.error.SchemaValidationErrorMessage: type: object properties: location: type: string example: string message: type: string example: string attributePath: type: string example: string additionalProperties: false description: This schema is generated from SchemaValidationErrorMessage.java common.v1.r0.a3.response.ApiResponseMetadata: type: object properties: flags: type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Flag' links: type: array items: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiLink' totalAvailableResults: type: integer format: int32 example: 50 messages: type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.Message' extraInfo: type: array description: An array of entity specific metadata items: $ref: '#/components/schemas/common.v1.r0.a3.config.KVPair' additionalProperties: false description: | The metadata associated with an API response. Always present and minimally contains the self link for the API request that produced this response. Also contains pagination data for paginated requests. common.v1.r0.a3.config.Message: type: object properties: code: type: string description: | A code that uniquely identifies a message. example: string message: type: string example: string locale: type: string description: | The locale for the message description. default: en_US severity: $ref: '#/components/schemas/common.v1.r0.a3.config.MessageSeverity' additionalProperties: false common.v1.r0.a3.config.Flag: type: object properties: name: type: string example: string value: type: boolean default: false additionalProperties: false description: | Many entities in the Nutanix APIs carry flags. This object captures all the flags associated with that entity through this object. The field that hosts this type of an object must have an attribute called x-bounded-map-keys that tells which flags are actually present for that entity. common.v1.r0.a3.config.KVPair: type: object properties: name: type: string description: The key of this key value pair example: string value: description: The value associated with the key for this key-value pair oneOf: - type: string example: string - type: integer example: 6 additionalProperties: false description: | A map describing a set of keys and their corresponding values. common.v1.r0.a3.config.MessageSeverity: type: string description: | The message severity. enum: - INFO - WARNING - ERROR - $UNKNOWN - $REDACTED prism.v4.r0.a1.config.TaskReference: type: object properties: extId: pattern: "^[a-zA-Z0-9/+]*={0,2}:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" type: string description: Globally unique identifier of a task. example: QmFzZTY0RW5jb2RlZA==:e783b480-4d55-4fd7-b760-10291f7ba4ca additionalProperties: false description: Reference to a task tracking the async operation. storage.v4.r0.a3.config.GetIscsiClientApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.IscsiClient' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/iscsi-clients/{clientId}\ \ Get operation" storage.v4.r0.a3.config.IscsiClient: title: iSCSI client object description: A model that represents an iSCSI client that can be associated with a Volume Group as an external attachment. allOf: - $ref: '#/components/schemas/common.v1.r0.a3.response.ExternalizableAbstractModel' - type: object properties: iscsiInitiatorName: maxLength: 64 type: string description: iSCSI initiator name. example: string iscsiInitiatorNetworkId: $ref: '#/components/schemas/common.v1.r0.a3.config.IPAddressOrFQDN' clientSecret: maxLength: 16 minLength: 12 type: string description: iSCSI initiator client secret in case of CHAP authentication. This field should not be provided in case the authentication type is not set to CHAP. format: password writeOnly: true example: '***************' enabledAuthentications: $ref: '#/components/schemas/storage.v4.r0.a3.config.AuthenticationType' targetParams: type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.TargetParam' clusterReference: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The UUID of the cluster that will host the iSCSI client. example: f9308d30-85cf-4137-900c-2e805b82af6e attachmentSite: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroupAttachmentSite' iscsiTargetNames: type: array description: List of iSCSI targets that will be visible and accessible to the iSCSI client. readOnly: true items: type: string example: string additionalProperties: false storage.v4.r0.a3.config.UpdateIscsiClientApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/iscsi-clients/{clientId}\ \ Patch operation" storage.v4.r0.a3.config.AuthenticationType: title: Supported types of authentication type: string description: "The authentication type enabled for the Volume Group. If this\ \ is set to CHAP, the target/client secret must be provided." enum: - CHAP - NONE - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.TargetParam: title: Parameters associated with each iSCSI target corresponding to the iSSCI client type: object properties: numVirtualTargets: maximum: 32 minimum: 1 type: integer description: Number of virtual targets generated for the iSCSI target. format: int32 example: 20 additionalProperties: false description: List of iSCSI target parameters that will be visible and accessible to the iSCSI client. storage.v4.r0.a3.config.VolumeGroupAttachmentSite: title: Supported Volume Group attachment sites type: string description: The site where the Volume Group attach operation should be processed. enum: - PRIMARY - SECONDARY - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.Task: title: Task object type: object properties: extId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The external identifier of the task. example: f4ef6b76-9e80-4ce5-ac90-fda128b72f4c additionalProperties: false description: An object encapsulating Task Id return value. storage.v4.r0.a3.config.GetIscsiClientsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.IscsiClient' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in api path /storage/v4.0.a3/config/iscsi-clients Get operation storage.v4.r0.a3.config.GetVolumeGroupApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroup' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{extId}\ \ Get operation" storage.v4.r0.a3.config.DeleteVolumeGroupApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{extId}\ \ Delete operation" storage.v4.r0.a3.config.VolumeGroup: title: Volume Group object description: A model that represents a Volume Group resource. allOf: - $ref: '#/components/schemas/common.v1.r0.a3.response.ExternalizableAbstractModel' - type: object properties: name: maxLength: 256 type: string description: Volume Group name. example: string description: maxLength: 1000 type: string description: Volume Group description. example: string loadBalanceVmAttachments: type: boolean description: "Indicates whether to enable Volume Group load balancing\ \ for VM attachments. This cannot be enabled if there are iSCSI client\ \ attachments already associated with the Volume Group, and vice-versa." example: true sharingStatus: $ref: '#/components/schemas/storage.v4.r0.a3.config.SharingStatus' iscsiTargetPrefix: maxLength: 512 pattern: "^[\\da-zA-Z:\\.\\-]+$" type: string description: The specifications can either contain the iSCSI target prefix or the iSCSI target name as the value. This is an optional field. writeOnly: true example: string iscsiTargetName: type: string description: The specifications can either contain the iSCSI target prefix or the iSCSI target name as the value. This is an optional field. example: string targetSecret: maxLength: 16 minLength: 12 type: string description: Target secret in case of a CHAP authentication. This field should not be provided in case the authentication type is not set to CHAP. format: password writeOnly: true example: '***************' enabledAuthentications: $ref: '#/components/schemas/storage.v4.r0.a3.config.AuthenticationType' createdBy: maxLength: 512 type: string description: Service/user who created this Volume Group. example: string clusterReference: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central. example: 8a9f3a73-3b43-45c7-9edf-129c9dbcf076 storageFeatures: $ref: '#/components/schemas/storage.v4.r0.a3.config.StorageFeatures' usageType: $ref: '#/components/schemas/storage.v4.r0.a3.config.UsageType' isHidden: type: boolean description: Indicates whether the Volume Group is meant to be hidden or not. example: true additionalProperties: false storage.v4.r0.a3.config.UpdateVolumeGroupApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{extId}\ \ Patch operation" storage.v4.r0.a3.config.SharingStatus: title: The supported sharing status types type: string description: "Indicates whether the Volume Group can be shared across multiple\ \ iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on\ \ a Volume Group with multiple attachments. Similarly, a Volume Group cannot\ \ be associated with more than one attachment as long as it is in exclusive\ \ mode." enum: - SHARED - NOT_SHARED - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.StorageFeatures: type: object properties: flashMode: $ref: '#/components/schemas/storage.v4.r0.a3.config.FlashMode' additionalProperties: false description: Storage features for the Volume Groups. storage.v4.r0.a3.config.UsageType: title: Supported Volume Group Usage types type: string description: Expected usage type for the Volume Group. enum: - USER - INTERNAL - TEMPORARY - BACKUP_TARGET - $UNKNOWN - $REDACTED storage.v4.r0.a3.config.FlashMode: type: object properties: isEnabled: type: boolean example: false additionalProperties: false description: "Once configured, this field will avoid down migration of data\ \ from the hot tier unless the overrides field is specified for the virtual\ \ disks." storage.v4.r0.a3.config.GetVolumeGroupsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeGroup' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups Get operation storage.v4.r0.a3.config.CreateVolumeGroupApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups Post operation storage.v4.r0.a3.config.GetVolumeDisksApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeDisk' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks\ \ Get operation" storage.v4.r0.a3.config.VolumeDisk: title: Volume Disk object description: "A model that represents a Volume Disk associated with a Volume\ \ Group, and is supported by backing file on DSF." allOf: - $ref: '#/components/schemas/common.v1.r0.a3.response.ExternalizableAbstractModel' - type: object properties: index: maximum: 16383 minimum: 0 type: integer description: Index of the disk in a Volume Group. This field is immutable. example: 75 diskSizeBytes: minimum: 524288 type: integer description: Size of the disk in bytes. format: int64 example: 5966731838967097344 storageContainerId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: Storage container on which the disk must be created. readOnly: true example: 51863b26-e30a-4485-ba4b-a10d7419a068 description: maxLength: 1000 type: string description: Volume Disk description. example: string diskDataSourceReference: $ref: '#/components/schemas/common.v1.r0.a3.config.EntityReference' diskStorageFeatures: $ref: '#/components/schemas/storage.v4.r0.a3.config.DiskStorageFeatures' additionalProperties: false storage.v4.r0.a3.config.CreateVolumeDiskApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks\ \ Post operation" storage.v4.r0.a3.config.DiskStorageFeatures: type: object properties: flashMode: $ref: '#/components/schemas/storage.v4.r0.a3.config.FlashMode' additionalProperties: false description: Storage features for the Volume Disks. storage.v4.r0.a3.config.GetVolumeDiskApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.VolumeDisk' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks/{diskExtId}\ \ Get operation" storage.v4.r0.a3.config.DeleteVolumeDiskApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks/{diskExtId}\ \ Delete operation" storage.v4.r0.a3.config.UpdateVolumeDiskApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/disks/{diskExtId}\ \ Patch operation" storage.v4.r0.a3.config.GetExternalAttachmentsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.IscsiClient' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/iscsi-client-attachments\ \ Get operation" storage.v4.r0.a3.config.AttachIscsiClientApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/attach-iscsi-client\ \ Post operation" storage.v4.r0.a3.config.DetachIscsiClientApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/detach-iscsi-client/{clientId}\ \ Post operation" storage.v4.r0.a3.config.GetVmAttachmentsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.VmAttachment' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/vm-attachments\ \ Get operation" storage.v4.r0.a3.config.VmAttachment: required: - extId type: object properties: extId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The external identifier of the VM. example: d63067ab-e44d-40b9-9e46-11e282245f96 index: type: integer description: The index on the SCSI bus to attach the VM to the Volume Group. writeOnly: true example: 26 additionalProperties: false description: A model that represents a VM reference that can be associated with a Volume Group as a hypervisor attachment. storage.v4.r0.a3.config.AttachVmApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/attach-vm\ \ Post operation" storage.v4.r0.a3.config.DetachVmApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/detach-vm/{vmExtId}\ \ Post operation" storage.v4.r0.a3.config.GetCategoryAssociationsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/storage.v4.r0.a3.config.CategoryDetails' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/category-associations\ \ Get operation" storage.v4.r0.a3.config.CategoryDetails: description: An existing category detail associated with the Volume Group. allOf: - $ref: '#/components/schemas/common.v1.r0.a3.config.EntityReference' storage.v4.r0.a3.config.CategoryEntityReferences: type: object properties: categories: type: array items: $ref: '#/components/schemas/common.v1.r0.a3.config.EntityReference' additionalProperties: false description: The list of categories to be associated/disassociated with the Volume Group. storage.v4.r0.a3.config.AssociateCategoryApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/associate-category\ \ Post operation" storage.v4.r0.a3.config.DisassociateCategoryApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/disassociate-category\ \ Post operation" storage.v4.r0.a3.config.VolumeGroupMigrationSpec: title: Volume Group migration specification required: - targetAvailabilityZoneId type: object properties: targetAvailabilityZoneId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The target availability zone where the Volume Group must be migrated. example: bde9840a-7be2-4fb5-839b-a9cdb71bbea0 targetClusterId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The cluster in the target availability zone where the Volume Group must be migrated. example: bc14a930-d0c3-411a-9430-3c583eedadb9 additionalProperties: false description: Specification for the migrate action on the Volume Group. storage.v4.r0.a3.config.MigrateVolumeGroupApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.config.Task' - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/migrate\ \ Post operation" storage.v4.r0.a3.config.VolumeGroupRevertSpec: title: Volume Group revert specification required: - volumeGroupRecoveryPointExtId type: object properties: volumeGroupRecoveryPointExtId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: The external identifier of the Volume Group recovery point. example: 27f14196-682c-40a9-844b-093f172bb5af additionalProperties: false description: Specify the Volume Group recovery point Id to which the Volume Group would be reverted to. storage.v4.r0.a3.config.RevertVolumeGroupApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/revert\ \ Post operation" storage.v4.r0.a3.config.PauseVolumeGroupSynchronousReplicationApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/prism.v4.r0.a1.config.TaskReference' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/pause-synchronous-replication\ \ Post operation" storage.v4.r0.a3.config.ResumeVolumeGroupSynchronousReplicationApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/resume-synchronous-replication\ \ Post operation" storage.v4.r0.a3.config.GetVolumeGroupMetadataInfoApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/common.v1.r0.a3.config.Metadata' - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/metadata-info\ \ Get operation" storage.v4.r0.a3.config.UpdateVolumeGroupMetadataInfoApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.r0.a3.response.ApiResponseMetadata' data: oneOf: - $ref: '#/components/schemas/storage.v4.r0.a3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in api path /storage/v4.0.a3/config/volume-groups/{volumeGroupExtId}/$actions/update-metadata-info\ \ Post operation" common.v1.r0.a3.config.Metadata: type: object properties: ownerReferenceId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: | A globally unique identifier that represents the owner of this resource. example: 6acd5cae-802a-4a65-ad9c-d2ace464da96 ownerUserName: maxLength: 128 type: string description: | The userName of the owner of this resource. example: string projectReferenceId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string description: | A globally unique identifier that represents the project this resource belongs to. example: 322eed11-7ef3-49d5-b423-acfdf50d7cb9 projectName: maxLength: 128 type: string description: | The name of the project this resource belongs to. example: string categoryIds: type: array description: | A list of globally unique identifiers that represent all the categories the resource is associated with. items: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 2f980f93-df50-4ef7-bba0-774354fe39a8 additionalProperties: false description: | Metadata associated with this resource. common.v1.r0.a3.config.EntityReference: type: object properties: extId: pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" type: string example: 748b06b3-b3a0-45c1-8c81-6b5b019cecde name: type: string example: string uris: type: array items: type: string example: string entityType: $ref: '#/components/schemas/common.v1.r0.a3.config.EntityType' additionalProperties: false common.v1.r0.a3.config.EntityType: type: string enum: - CLUSTER - VM - STORAGE_CONTAINER - VOLUME_GROUP - TASK - IMAGE - CATEGORY - NODE - VPC - SUBNET - ROUTING_POLICY - FLOATING_IP - VPN_GATEWAY - VPN_CONNECTION - DIRECT_CONNECT - DIRECT_CONNECT_VIF - VIRTUAL_NIC - VIRTUAL_SWITCH - VM_DISK - VOLUME_DISK - DISK_RECOVERY_POINT - VTEP_GATEWAY - $UNKNOWN - $REDACTED securitySchemes: basicAuthScheme: type: http scheme: basic apiKeyAuthScheme: type: apiKey name: X-ntnx-api-key in: header