openapi: 3.0.1 info: title: Nutanix Prism APIs description: "Manage Tasks, Category Associations and Submit Batch Operations." version: 1.0.0 x-logo: altText: Prism Logo url: https://developers.nutanix.com/api/v1/namespaces/prism/images/prism-logo-img.svg x-repo-name: prism x-minimum-negotiation-version: v4.2 servers: - url: "https://{host}:{port}/api" security: - basicAuthScheme: [] - apiKeyAuthScheme: [] tags: - name: Categories description: "Categories are key-value pair constructs used to tag entities and\ \ policies.\nKeys are used to group functionally similar categories.\nPolicy engines\ \ use categories to get all entities tagged to a category and apply policies on\ \ them.\nSome examples are marking VMs for restoration and backup, protecting\ \ \nvolume groups based on categories, narrowing or denying authorization to a\ \ user,\nto entities marked by a category, logically grouping entities in the\ \ UI for convenience, and so on.\n" - name: DomainManager description: | The domain manager represents the multi-cluster manager, responsible for managing (registering/viewing) multiple Nutanix clusters to provide a single, centralized management interface. It has support for backup and restore of domain manager on clusters as well as s3-compatible object stores. It also exposes the ability manage the lifecycle of multiple opt-in products such as Intelligent Ops, Leap, and Flow networking, and so on. x-displayName: Domain Manager(Prism Central) - name: Tasks description: "Tasks are primarily a way of asynchronously executing operations.\ \ Tasks persistently record the intent, progress, and other relevant information\ \ about the long-running operations. Users can interact with tasks in the system\ \ using these APIs." - name: Batches description: Provides an ability to submit batches of operations that can be performed asynchronously. Status of submitted batches can be checked by querying the task returned as a result of the submission. Additionally history of all submitted batches in the past 90 days can be listed through a list operation. A Limit of 500 elements is enforced during submission of the batch. - name: DomainManager description: | The domain manager represents the multi-cluster manager, responsible for managing (registering/viewing) multiple Nutanix clusters and providing a single, centralized management interface. It supports backup and restoration of the domain manager on clusters as well as s3-compatible object stores. Additionally, it allows users to view the current state of multiple opt-in products such as Disaster Recovery, Intelligent Operations, Flow and more. It also manages the lifecycle of products like Disaster Recovery. x-displayName: Domain Manager(Prism Central) paths: /prism/v4.3/operations/$actions/batch: post: tags: - Batches summary: Submit a batch operation. description: Submit a homogenous batch operation. operationId: submitBatch parameters: - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 7c721ef2-dc59-4c73-b1e6-9dd0dcc495ff requestBody: description: The request payload for the batch operation. content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.operations.BatchSpec' required: true responses: "202": description: The batch request has been accepted by the server for processing. Please check the task reference in the response on how to query for status of the batch operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/$actions/batch Post operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/$actions/batch Post operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/$actions/batch Post operation x-permissions: operationName: Submit Batch deploymentList: - ON_PREM roleList: - name: Internal Super Admin - name: Prism Admin - name: Super Admin - name: Prism User - name: Monitoring Admin x-rate-limit: - type: small count: 6 timeUnit: minutes x-supported-versions: - product: PC version: "2024.1" x-code-samples: - lang: Java source: |2 package sample; import com.nutanix.batch.java.client.ApiClient; import com.nutanix.batch.java.client.api.BatchesApi; import com.nutanix.dp1.batch.prism.v4.request.Batches.SubmitBatchRequest; import com.nutanix.dp1.batch.prism.v4.operations.BatchSpec; import com.nutanix.dp1.batch.prism.v4.operations.SubmitBatchApiResponse; import org.springframework.web.client.RestClientException; public class JavaSdkSample { public static void main(String[] args) { // Configure the client ApiClient apiClient = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClient.setHost("localhost"); // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClient.setPort(9440); // Interval in ms to use during retry attempts apiClient.setRetryInterval(5000); // Max retry attempts while reconnecting on a loss of connection apiClient.setMaxRetryAttempts(5); // UserName to connect to the cluster String username = "username"; // Password to connect to the cluster String password = "password"; apiClient.setUsername(username); apiClient.setPassword(password); // Please add authorization information here if needed. BatchesApi batchesApi = new BatchesApi(apiClient); BatchSpec batchSpec = new BatchSpec(); // BatchSpec object initializations here... try { // Pass in parameters using the request builder object associated with the operation. SubmitBatchApiResponse submitBatchApiResponse = batchesApi.submitBatch(SubmitBatchRequest.builder() .build(), batchSpec); System.out.println(submitBatchApiResponse.toString()); } catch (RestClientException ex) { System.out.println(ex.getMessage()); } } } - lang: JavaScript source: |2 import { ApiClient, BatchesApi, BatchSpec } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let batchesApi = new BatchesApi(apiClientInstance); function sample() { let batchSpec = new BatchSpec(); // BatchSpec object initializations here... batchSpec = JSON.stringify(batchSpec); batchesApi.submitBatch(batchSpec).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: |2+ import ntnx_prism_py_client if __name__ == "__main__": # Configure the client config = ntnx_prism_py_client.Configuration() # IPv4/IPv6 address or FQDN of the cluster config.host = "localhost" # Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. config.port = 9440 # Max retry attempts while reconnecting on a loss of connection config.max_retry_attempts = 3 # Backoff factor to use during retry attempts config.backoff_factor = 3 # UserName to connect to the cluster config.username = "username" # Password to connect to the cluster config.password = "password" # Please add authorization information here if needed. client = ntnx_prism_py_client.ApiClient(configuration=config) batches_api = ntnx_prism_py_client.BatchesApi(api_client=client) batchSpec = ntnx_prism_py_client.BatchSpec() # BatchSpec object initializations here... try: api_response = batches_api.submit_batch(body=batchSpec) print(api_response) except ntnx_prism_py_client.rest.ApiException as e: print(e) - lang: Go source: |2+ package main import ( "fmt" "time" "context" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/batches" import1 "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/operations" import2 "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config" ) var ( ApiClientInstance *client.ApiClient BatchesServiceApiInstance *api.BatchesServiceApi ) func main() { ApiClientInstance = client.NewApiClient() // IPv4/IPv6 address or FQDN of the cluster ApiClientInstance.Host = "localhost" // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. ApiClientInstance.Port = 9440 // Interval in ms to use during retry attempts ApiClientInstance.RetryInterval = 5 * time.Second // Max retry attempts while reconnecting on a loss of connection ApiClientInstance.MaxRetryAttempts = 5 // UserName to connect to the cluster ApiClientInstance.Username = "username" // Password to connect to the cluster ApiClientInstance.Password = "password" // Please add authorization information here if needed. BatchesServiceApiInstance = api.NewBatchesServiceApi(ApiClientInstance) ctx := context.Background() batchSpec := import1.NewBatchSpec() // BatchSpec object initializations here... request := batches.SubmitBatchRequest{ Body: batchSpec } response, error := BatchesServiceApiInstance.SubmitBatch(ctx, &request) if error != nil { fmt.Println(error) return } data, _ := response.GetData().(import2.TaskReference) fmt.Println(data) } - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/operations/$actions/batch" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"metadata":{"action":"$UNKNOWN","name":"BatchVMCreation","uri":"/api/vmm/v4.0/ahv/config/vms","shouldStopOnError":false,"chunkSize":0,"$objectType":"prism.v4.operations.BatchSpecMetadata"},"payload":[{"metadata":{"headers":[{"name":"If-Match","value":"YXBwbGljYXRpb24vanNvbg==:MA==","$objectType":"prism.v4.operations.BatchSpecPayloadMetadataHeader"}],"path":[{"name":"extId","value":"00061aa0-4fb1-aba6-0000-000000014af5","$objectType":"prism.v4.operations.BatchSpecPayloadMetadataPath"}],"$objectType":"prism.v4.operations.BatchSpecPayloadMetadata"},"data":{},"$objectType":"prism.v4.operations.BatchSpecPayload"}],"$objectType":"prism.v4.operations.BatchSpec"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"metadata":{"action":"$UNKNOWN","name":"BatchVMCreation","uri":"/api/vmm/v4.0/ahv/config/vms","shouldStopOnError":false,"chunkSize":0,"$objectType":"prism.v4.operations.BatchSpecMetadata"},"payload":[{"metadata":{"headers":[{"name":"If-Match","value":"YXBwbGljYXRpb24vanNvbg==:MA==","$objectType":"prism.v4.operations.BatchSpecPayloadMetadataHeader"}],"path":[{"name":"extId","value":"00061aa0-4fb1-aba6-0000-000000014af5","$objectType":"prism.v4.operations.BatchSpecPayloadMetadataPath"}],"$objectType":"prism.v4.operations.BatchSpecPayloadMetadata"},"data":{},"$objectType":"prism.v4.operations.BatchSpecPayload"}],"$objectType":"prism.v4.operations.BatchSpec"} \ - "https://host:port/api/prism/v4.3/operations/$actions/batch" - lang: Csharp source: "\n\nusing Nutanix.BatchSDK.Client;\nusing Nutanix.BatchSDK.Api;\n\ using Nutanix.BatchSDK.Model.Prism.V4.Operations;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ BatchesApi batchesApi = new BatchesApi(client);\n\n BatchSpec\ \ batchSpec = new BatchSpec();\n\n // BatchSpec object initializations\ \ here...\n\n\n // Create request object with parameters\n \ \ var request = new SubmitBatchRequest {\n Body = batchSpec\n\ \ };\n try {\n SubmitBatchApiResponse submitBatchApiResponse\ \ = batchesApi.SubmitBatch(request);\n } catch (ApiException ex)\ \ {\n Console.WriteLine(ex.Message);\n }\n }\n }\n\ }\n" /prism/v4.3/operations/batches: get: tags: - Batches summary: Get a list of all the Batches. description: Query the list of Batches. operationId: listBatches parameters: - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: name example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$filter=name\ \ eq '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 descending order." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: endTime example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$orderby=endTime" - name: name example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$orderby=name" - name: startTime example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$orderby=startTime" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: completionStatus example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=completionStatus" - name: endTime example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=endTime" - name: executionStatus example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=executionStatus" - name: extId example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=extId" - name: failedCount example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=failedCount" - name: links example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=links" - name: name example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=name" - name: shouldStopOnError example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=shouldStopOnError" - name: size example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=size" - name: startTime example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=startTime" - name: successCount example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=successCount" - name: tenantId example: "https://{host}:{port}/api/prism/v4.3/operations/batches?$select=tenantId" responses: "200": description: Paginated list of Batches. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.operations.Batch' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/batches Get operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/batches Get operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/batches Get operation x-permissions: operationName: Read Batches deploymentList: - ON_PREM roleList: - name: Internal Super Admin - name: Prism Admin - name: Super Admin - name: Prism Viewer - name: Prism User - name: Monitoring Admin x-rate-limit: - type: small count: 40 timeUnit: seconds x-supported-versions: - product: PC version: "2024.1" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.batch.java.client.ApiClient;\n\ import com.nutanix.batch.java.client.api.BatchesApi;\nimport com.nutanix.dp1.batch.prism.v4.request.Batches.ListBatchesRequest;\n\ import com.nutanix.dp1.batch.prism.v4.operations.ListBatchesApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ BatchesApi batchesApi = new BatchesApi(apiClient);\n\n \n \ \ int page = 0;\n \n int limit = 50;\n\n try {\n\ \ // Pass in parameters using the request builder object associated\ \ with the operation.\n ListBatchesApiResponse listBatchesApiResponse\ \ = batchesApi.listBatches(ListBatchesRequest.builder()\n \ \ .$page(page)\n .$limit(limit)\n .$filter(null)\n\ \ .$orderby(null)\n .$select(null)\n \ \ .build());\n\n System.out.println(listBatchesApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: |2 import { ApiClient, BatchesApi } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let batchesApi = new BatchesApi(apiClientInstance); function sample() { // Construct Optional Parameters var opts = {}; opts["$page"] = 0; opts["$limit"] = 50; opts["$filter"] = "string_sample_data"; opts["$orderby"] = "string_sample_data"; opts["$select"] = "string_sample_data"; batchesApi.listBatches(opts).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ batches_api = ntnx_prism_py_client.BatchesApi(api_client=client)\n \ \ \n page = 0\n \n limit = 50\n\n\n try:\n api_response\ \ = batches_api.list_batches(_page=page, _limit=limit)\n print(api_response)\n\ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/batches\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/operations\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n BatchesServiceApiInstance\ \ *api.BatchesServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ BatchesServiceApiInstance = api.NewBatchesServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n page_ := 0\n \n limit_\ \ := 50\n\n\n request := batches.ListBatchesRequest{ Page_: &page_, Limit_:\ \ &limit_, Filter_: nil, Orderby_: nil, Select_: nil }\n response, error\ \ := BatchesServiceApiInstance.ListBatches(ctx, &request)\n if error\ \ != nil {\n fmt.Println(error)\n return\n }\n data,\ \ _ := response.GetData().([]import1.Batch)\n fmt.Println(data)\n\n}\n\ \n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/operations/batches?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/operations/batches?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.BatchSDK.Client;\nusing Nutanix.BatchSDK.Api;\n\ using Nutanix.BatchSDK.Model.Prism.V4.Operations;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ BatchesApi batchesApi = new BatchesApi(client);\n\n int page =\ \ 0;\n int limit = 50;\n String filter = \"string_sample_data\"\ ;\n String orderby = \"string_sample_data\";\n String select =\ \ \"string_sample_data\";\n\n // Create request object with parameters\n\ \ var request = new ListBatchesRequest {\n Page = page,\n\ \ Limit = limit,\n Filter = filter,\n Orderby\ \ = orderby,\n Select = select\n };\n try {\n \ \ ListBatchesApiResponse listBatchesApiResponse = batchesApi.ListBatches(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/operations/batches/{extId}: get: tags: - Batches summary: "Get a Batch identified by {extId}." description: "Query the Batch identified by {extId}." operationId: getBatchById parameters: - name: extId in: path description: The external identifier of the Batch. 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: e1ce9cf5-59f1-4548-a4d2-07318e267e0e responses: "200": description: Details of the queried Batch. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.operations.Batch' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/operations/batches/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/operations/batches/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/operations/batches/{extId}\ \ Get operation" x-permissions: operationName: Read Batches deploymentList: - ON_PREM roleList: - name: Internal Super Admin - name: Prism Admin - name: Super Admin - name: Prism Viewer - name: Prism User - name: Monitoring Admin x-rate-limit: - type: small count: 40 timeUnit: seconds x-supported-versions: - product: PC version: "2024.1" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.batch.java.client.ApiClient;\n\ import com.nutanix.batch.java.client.api.BatchesApi;\nimport com.nutanix.dp1.batch.prism.v4.request.Batches.GetBatchByIdRequest;\n\ import com.nutanix.dp1.batch.prism.v4.operations.GetBatchApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ BatchesApi batchesApi = new BatchesApi(apiClient);\n\n \n \ \ String extId = \"2791DBB4-E1dD-BCBC-10E7-17b1D25E8A1A\";\n\n \ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n GetBatchApiResponse\ \ getBatchApiResponse = batchesApi.getBatchById(GetBatchByIdRequest.builder()\n\ \ .extId(extId)\n .build());\n\n \ \ System.out.println(getBatchApiResponse.toString());\n\n } catch\ \ (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, BatchesApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let batchesApi = new BatchesApi(apiClientInstance);\n\nfunction sample()\ \ {\n\n \n let extId = \"7daC40b7-c21b-CcBE-e3BA-CaABbcf33CAC\";\n\ \n\n\n\n\n batchesApi.getBatchById(extId).then(({data, response}) =>\ \ {\n console.log(`API returned the following status code: ${response.status}`);\n\ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ batches_api = ntnx_prism_py_client.BatchesApi(api_client=client)\n \ \ \n ext_id = \"22dEe6e4-6696-BdaE-f98d-7ACfBb6BcE5D\"\n\n\n try:\n\ \ api_response = batches_api.get_batch_by_id(extId=ext_id)\n \ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/batches\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/operations\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n BatchesServiceApiInstance\ \ *api.BatchesServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ BatchesServiceApiInstance = api.NewBatchesServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n extId := \"d7FedE00-C1fe-D8EF-bb74-aeE36fAAAbBf\"\ \n\n\n request := batches.GetBatchByIdRequest{ ExtId: &extId }\n response,\ \ error := BatchesServiceApiInstance.GetBatchById(ctx, &request)\n if\ \ error != nil {\n fmt.Println(error)\n return\n }\n \ \ data, _ := response.GetData().(import1.Batch)\n fmt.Println(data)\n\ \n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/operations/batches/ee68d1De-E3bF-fdDa-FcA3-AD2b2dEee2c9" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/operations/batches/E79ECEaF-E2A8-F359-b0bB-edAE36Bc5ecb" - lang: Csharp source: "\n\nusing Nutanix.BatchSDK.Client;\nusing Nutanix.BatchSDK.Api;\n\ using Nutanix.BatchSDK.Model.Prism.V4.Operations;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ BatchesApi batchesApi = new BatchesApi(client);\n\n String extId\ \ = \"C77f2cE0-4fB5-24cD-b91b-7e2Bd4Aeeb6d\";\n\n // Create request\ \ object with parameters\n var request = new GetBatchByIdRequest\ \ {\n ExtId = extId\n };\n try {\n GetBatchApiResponse\ \ getBatchApiResponse = batchesApi.GetBatchById(request);\n } catch\ \ (ApiException ex) {\n Console.WriteLine(ex.Message);\n \ \ }\n }\n }\n}\n" /prism/v4.3/config/categories: get: tags: - Categories summary: | List categories description: | Fetches a list of categories with pagination, filtering, sorting, selection, and optional expansion of associated entity counts. operationId: listCategories parameters: - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/categories?$filter=extId\ \ eq '09534c07-4acc-4028-b749-e503f8a9ce6c'" - name: key example: "https://{host}:{port}/api/prism/v4.3/config/categories?$filter=key\ \ eq 'AvailabilityZone'" - name: ownerUuid example: "https://{host}:{port}/api/prism/v4.3/config/categories?$filter=ownerUuid\ \ eq '10f43eeb-90a9-4e15-a6d0-272d3898e20f'" - name: type example: "https://{host}:{port}/api/prism/v4.3/config/categories?$filter=type\ \ eq Prism.Config.CategoryType'USER'" - name: value example: "https://{host}:{port}/api/prism/v4.3/config/categories?$filter=value\ \ eq 'APAC'" - 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 descending order." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: key example: "https://{host}:{port}/api/prism/v4.3/config/categories?$orderby=key" - name: value example: "https://{host}:{port}/api/prism/v4.3/config/categories?$orderby=value" - name: $expand in: query description: "A URL query parameter that allows clients to request related\ \ resources when a resource that satisfies a particular request is retrieved.\ \ Each expanded item is evaluated relative to the entity containing the\ \ property being expanded. Other query options can be applied to an expanded\ \ property by appending a semicolon-separated list of query options, enclosed\ \ in parentheses, to the property name. Permissible system query options\ \ are $filter, $select and $orderby." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: associations example: "https://{host}:{port}/api/prism/v4.3/config/categories?$expand=associations" - name: detailedAssociations example: "https://{host}:{port}/api/prism/v4.3/config/categories?$expand=detailedAssociations" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: description example: "https://{host}:{port}/api/prism/v4.3/config/categories?$select=description" - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/categories?$select=extId" - name: key example: "https://{host}:{port}/api/prism/v4.3/config/categories?$select=key" - name: ownerUuid example: "https://{host}:{port}/api/prism/v4.3/config/categories?$select=ownerUuid" - name: type example: "https://{host}:{port}/api/prism/v4.3/config/categories?$select=type" - name: value example: "https://{host}:{port}/api/prism/v4.3/config/categories?$select=value" responses: "200": description: | Returns a list of categories. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.config.Category' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Get operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Get operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Get operation x-permissions: operationName: View Category roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Project Manager - name: Prism Viewer - name: Developer - name: Project Admin - name: Super Admin - name: Storage Admin - name: Flow Admin - name: Flow Viewer - name: Category Viewer - name: Category Admin - name: Disaster Recovery Admin - name: Disaster Recovery Viewer - name: CSI System - name: Kubernetes Data Services System - name: Kubernetes Infrastructure Provision - name: Kubernetes Admin - name: Virtual Machine Admin - name: Virtual Machine Operator - name: Virtual Machine Viewer - name: Cluster Admin - name: Cluster Viewer - name: Backup admin - name: NCM Connector x-rate-limit: - type: xsmall count: 20 timeUnit: seconds - type: small count: 20 timeUnit: seconds - type: large count: 20 timeUnit: seconds - type: xlarge count: 20 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.ctgrs.java.client.ApiClient;\n\ import com.nutanix.ctgrs.java.client.api.CategoriesApi;\nimport com.nutanix.dp1.ctgrs.prism.v4.request.Categories.ListCategoriesRequest;\n\ import com.nutanix.dp1.ctgrs.prism.v4.config.ListCategoriesApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ CategoriesApi categoriesApi = new CategoriesApi(apiClient);\n\n \ \ \n int page = 0;\n \n int limit = 50;\n\n \ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n ListCategoriesApiResponse\ \ listCategoriesApiResponse = categoriesApi.listCategories(ListCategoriesRequest.builder()\n\ \ .$page(page)\n .$limit(limit)\n \ \ .$filter(null)\n .$orderby(null)\n \ \ .$expand(null)\n .$select(null)\n .build());\n\ \n System.out.println(listCategoriesApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: |2 import { ApiClient, CategoriesApi } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let categoriesApi = new CategoriesApi(apiClientInstance); function sample() { // Construct Optional Parameters var opts = {}; opts["$page"] = 0; opts["$limit"] = 50; opts["$filter"] = "string_sample_data"; opts["$orderby"] = "string_sample_data"; opts["$expand"] = "string_sample_data"; opts["$select"] = "string_sample_data"; categoriesApi.listCategories(opts).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ categories_api = ntnx_prism_py_client.CategoriesApi(api_client=client)\n\ \ \n page = 0\n \n limit = 50\n\n\n try:\n api_response\ \ = categories_api.list_categories(_page=page, _limit=limit)\n print(api_response)\n\ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/categories\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n CategoriesServiceApiInstance\ \ *api.CategoriesServiceApi\n)\n\nfunc main() {\n ApiClientInstance =\ \ client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ CategoriesServiceApiInstance = api.NewCategoriesServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n page_ := 0\n \n limit_\ \ := 50\n\n\n request := categories.ListCategoriesRequest{ Page_: &page_,\ \ Limit_: &limit_, Filter_: nil, Orderby_: nil, Expand_: nil, Select_: nil\ \ }\n response, error := CategoriesServiceApiInstance.ListCategories(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.Category)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/categories?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$expand=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/categories?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$expand=string_sample_data&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.CtgrsSDK.Client;\nusing Nutanix.CtgrsSDK.Api;\n\ using Nutanix.CtgrsSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ CategoriesApi categoriesApi = new CategoriesApi(client);\n\n int\ \ page = 0;\n int limit = 50;\n String filter = \"string_sample_data\"\ ;\n String orderby = \"string_sample_data\";\n String expand =\ \ \"string_sample_data\";\n String select = \"string_sample_data\"\ ;\n\n // Create request object with parameters\n var request\ \ = new ListCategoriesRequest {\n Page = page,\n Limit\ \ = limit,\n Filter = filter,\n Orderby = orderby,\n\ \ Expand = expand,\n Select = select\n };\n\ \ try {\n ListCategoriesApiResponse listCategoriesApiResponse\ \ = categoriesApi.ListCategories(request);\n } catch (ApiException\ \ ex) {\n Console.WriteLine(ex.Message);\n }\n }\n\ \ }\n}\n" post: tags: - Categories summary: | Create a category description: | Creates a category with a given key and value pair. operationId: createCategory requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.config.Category' required: true responses: "201": description: | The requested category is created. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.Category' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Post operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Post operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Post operation x-permissions: operationName: Create Category roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Project Manager - name: Super Admin - name: Storage Admin - name: Category Admin - name: CSI System - name: Kubernetes Data Services System - name: Kubernetes Infrastructure Provision - name: Kubernetes Admin - name: NCM Connector x-rate-limit: - type: xsmall count: 10 timeUnit: seconds - type: small count: 10 timeUnit: seconds - type: large count: 10 timeUnit: seconds - type: xlarge count: 10 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: |2 package sample; import com.nutanix.ctgrs.java.client.ApiClient; import com.nutanix.ctgrs.java.client.api.CategoriesApi; import com.nutanix.dp1.ctgrs.prism.v4.request.Categories.CreateCategoryRequest; import com.nutanix.dp1.ctgrs.prism.v4.config.Category; import com.nutanix.dp1.ctgrs.prism.v4.config.CreateCategoryApiResponse; import org.springframework.web.client.RestClientException; public class JavaSdkSample { public static void main(String[] args) { // Configure the client ApiClient apiClient = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClient.setHost("localhost"); // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClient.setPort(9440); // Interval in ms to use during retry attempts apiClient.setRetryInterval(5000); // Max retry attempts while reconnecting on a loss of connection apiClient.setMaxRetryAttempts(5); // UserName to connect to the cluster String username = "username"; // Password to connect to the cluster String password = "password"; apiClient.setUsername(username); apiClient.setPassword(password); // Please add authorization information here if needed. CategoriesApi categoriesApi = new CategoriesApi(apiClient); Category category = new Category(); // Category object initializations here... category.setKey("AvailabilityZone"); // required field category.setValue("APAC"); // required field try { // Pass in parameters using the request builder object associated with the operation. CreateCategoryApiResponse createCategoryApiResponse = categoriesApi.createCategory(CreateCategoryRequest.builder() .build(), category); System.out.println(createCategoryApiResponse.toString()); } catch (RestClientException ex) { System.out.println(ex.getMessage()); } } } - lang: JavaScript source: |2 import { ApiClient, CategoriesApi, Category } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let categoriesApi = new CategoriesApi(apiClientInstance); function sample() { let category = new Category(); // Category object initializations here... category.setKey("AvailabilityZone"); // required field category.setValue("APAC"); // required field category = JSON.stringify(category); categoriesApi.createCategory(category).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: |2+ import ntnx_prism_py_client if __name__ == "__main__": # Configure the client config = ntnx_prism_py_client.Configuration() # IPv4/IPv6 address or FQDN of the cluster config.host = "localhost" # Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. config.port = 9440 # Max retry attempts while reconnecting on a loss of connection config.max_retry_attempts = 3 # Backoff factor to use during retry attempts config.backoff_factor = 3 # UserName to connect to the cluster config.username = "username" # Password to connect to the cluster config.password = "password" # Please add authorization information here if needed. client = ntnx_prism_py_client.ApiClient(configuration=config) categories_api = ntnx_prism_py_client.CategoriesApi(api_client=client) category = ntnx_prism_py_client.Category() # Category object initializations here... category.key = "AvailabilityZone" # required field category.value = "APAC" # required field try: api_response = categories_api.create_category(body=category) print(api_response) except ntnx_prism_py_client.rest.ApiException as e: print(e) - lang: Go source: |2+ package main import ( "fmt" "time" "context" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/categories" import1 "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config" ) var ( ApiClientInstance *client.ApiClient CategoriesServiceApiInstance *api.CategoriesServiceApi ) func main() { ApiClientInstance = client.NewApiClient() // IPv4/IPv6 address or FQDN of the cluster ApiClientInstance.Host = "localhost" // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. ApiClientInstance.Port = 9440 // Interval in ms to use during retry attempts ApiClientInstance.RetryInterval = 5 * time.Second // Max retry attempts while reconnecting on a loss of connection ApiClientInstance.MaxRetryAttempts = 5 // UserName to connect to the cluster ApiClientInstance.Username = "username" // Password to connect to the cluster ApiClientInstance.Password = "password" // Please add authorization information here if needed. CategoriesServiceApiInstance = api.NewCategoriesServiceApi(ApiClientInstance) ctx := context.Background() category := import1.NewCategory() // Category object initializations here... request := categories.CreateCategoryRequest{ Body: category } response, error := CategoriesServiceApiInstance.CreateCategory(ctx, &request) if error != nil { fmt.Println(error) return } data, _ := response.GetData().(import1.Category) fmt.Println(data) } - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/config/categories" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"key":"AvailabilityZone","value":"APAC","type":"$UNKNOWN","description":"Thiscategoryismeanttobeusedtoenforcepoliciesspecifictoavailabilityzones.","ownerUuid":"string","associations":[{"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","count":0,"$objectType":"prism.v4.config.AssociationSummary"}],"detailedAssociations":[{"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","resourceId":"b8f5e88d-32e2-44c6-aa37-a37ffdb557ef","$objectType":"prism.v4.config.AssociationDetail"}],"$objectType":"prism.v4.config.Category"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"key":"AvailabilityZone","value":"APAC","type":"$UNKNOWN","description":"Thiscategoryismeanttobeusedtoenforcepoliciesspecifictoavailabilityzones.","ownerUuid":"string","associations":[{"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","count":0,"$objectType":"prism.v4.config.AssociationSummary"}],"detailedAssociations":[{"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","resourceId":"b8f5e88d-32e2-44c6-aa37-a37ffdb557ef","$objectType":"prism.v4.config.AssociationDetail"}],"$objectType":"prism.v4.config.Category"} \ - "https://host:port/api/prism/v4.3/config/categories" - lang: Csharp source: "\n\nusing Nutanix.CtgrsSDK.Client;\nusing Nutanix.CtgrsSDK.Api;\n\ using Nutanix.CtgrsSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ CategoriesApi categoriesApi = new CategoriesApi(client);\n\n Category\ \ category = new Category();\n\n // Category object initializations\ \ here...\n category.Key = \"AvailabilityZone\"; // required field\n\ \ category.Value = \"APAC\"; // required field\n\n\n // Create\ \ request object with parameters\n var request = new CreateCategoryRequest\ \ {\n Body = category\n };\n try {\n \ \ CreateCategoryApiResponse createCategoryApiResponse = categoriesApi.CreateCategory(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/config/categories/{extId}: get: tags: - Categories summary: | Fetch a category description: | Fetches the details of a category with the given external identifier. operationId: getCategoryById parameters: - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 4218b4e4-48f7-4451-9bf8-ee2af1b85205 - name: $expand in: query description: | A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby.- associations - detailedAssociations required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: associations - name: detailedAssociations responses: "200": description: | The requested category is returned. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.Category' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Get operation" x-permissions: operationName: View Category roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Project Manager - name: Prism Viewer - name: Developer - name: Project Admin - name: Super Admin - name: Storage Admin - name: Flow Admin - name: Flow Viewer - name: Category Viewer - name: Category Admin - name: Disaster Recovery Admin - name: Disaster Recovery Viewer - name: CSI System - name: Kubernetes Data Services System - name: Kubernetes Infrastructure Provision - name: Kubernetes Admin - name: Virtual Machine Admin - name: Virtual Machine Operator - name: Virtual Machine Viewer - name: Cluster Admin - name: Cluster Viewer - name: Backup Admin - name: NCM Connector x-rate-limit: - type: xsmall count: 20 timeUnit: seconds - type: small count: 20 timeUnit: seconds - type: large count: 20 timeUnit: seconds - type: xlarge count: 20 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.ctgrs.java.client.ApiClient;\n\ import com.nutanix.ctgrs.java.client.api.CategoriesApi;\nimport com.nutanix.dp1.ctgrs.prism.v4.request.Categories.GetCategoryByIdRequest;\n\ import com.nutanix.dp1.ctgrs.prism.v4.config.GetCategoryApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ CategoriesApi categoriesApi = new CategoriesApi(apiClient);\n\n \ \ \n String extId = \"cA5AeABe-cF19-dEca-EC08-1Ad7FCF2027c\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetCategoryApiResponse\ \ getCategoryApiResponse = categoriesApi.getCategoryById(GetCategoryByIdRequest.builder()\n\ \ .extId(extId)\n .$expand(null)\n \ \ .build());\n\n System.out.println(getCategoryApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, CategoriesApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let categoriesApi = new CategoriesApi(apiClientInstance);\n\nfunction sample()\ \ {\n\n \n let extId = \"6BEAfE1E-Fd8f-Afdf-b3BA-bbffdD5cC34f\";\n\ \n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $expand\"] = \"string_sample_data\";\n\n\n\n\n categoriesApi.getCategoryById(extId,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ categories_api = ntnx_prism_py_client.CategoriesApi(api_client=client)\n\ \ \n ext_id = \"dDA4c4bD-e1C8-0e34-F8Bc-3bfA4d8c48dF\"\n\n\n try:\n\ \ api_response = categories_api.get_category_by_id(extId=ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/categories\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n CategoriesServiceApiInstance\ \ *api.CategoriesServiceApi\n)\n\nfunc main() {\n ApiClientInstance =\ \ client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ CategoriesServiceApiInstance = api.NewCategoriesServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n extId := \"ba9f5c6a-BFB6-9a45-AB0A-8AF676d26FEa\"\ \n\n\n request := categories.GetCategoryByIdRequest{ ExtId: &extId, Expand_:\ \ nil }\n response, error := CategoriesServiceApiInstance.GetCategoryById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.Category)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/categories/1EBaD9ec-5c01-fDDB-B3Ac-fDEEDFdc0fbE?$expand=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/categories/2C61Eb65-DaaC-7dAB-C4E7-aC8Fc3e3Dd4E?$expand=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.CtgrsSDK.Client;\nusing Nutanix.CtgrsSDK.Api;\n\ using Nutanix.CtgrsSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ CategoriesApi categoriesApi = new CategoriesApi(client);\n\n String\ \ extId = \"ccbAa2Ac-e15F-0508-6cDF-0dd3cE3057aD\";\n String expand\ \ = \"string_sample_data\";\n\n // Create request object with parameters\n\ \ var request = new GetCategoryByIdRequest {\n ExtId =\ \ extId,\n Expand = expand\n };\n try {\n \ \ GetCategoryApiResponse getCategoryApiResponse = categoriesApi.GetCategoryById(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" put: tags: - Categories summary: | Update a category description: | Updates the description, value, and owner properties of a category. operationId: updateCategoryById parameters: - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 453f8c5b-465f-42f7-bae5-8b5433dc9e58 - name: If-Match in: header description: "The If-Match request header makes the request conditional. When\ \ not provided, the server will respond with an HTTP-428 (Precondition\ \ Required) response code indicating that the server requires the request\ \ to be conditional. The server will allow the successful completion of\ \ PUT and PATCH operations, if the resource matches the ETag value returned\ \ to the response of a GET operation. If the conditional does not match,\ \ then an HTTP-412 (Precondition Failed) response will be returned." required: true style: simple explode: false schema: type: string example: string requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.config.Category' required: true responses: "200": description: | The requested category is updated. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Put operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Put operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Put operation" x-permissions: operationName: Update Category roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Project Manager - name: Super Admin - name: Storage Admin - name: Category Admin - name: CSI System - name: Kubernetes Data Services System - name: Kubernetes Infrastructure Provision - name: Kubernetes Admin x-rate-limit: - type: xsmall count: 10 timeUnit: seconds - type: small count: 10 timeUnit: seconds - type: large count: 10 timeUnit: seconds - type: xlarge count: 10 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.ctgrs.java.client.ApiClient;\n\ import com.nutanix.ctgrs.java.client.api.CategoriesApi;\nimport com.nutanix.dp1.ctgrs.prism.v4.request.Categories.UpdateCategoryByIdRequest;\n\ import com.nutanix.dp1.ctgrs.prism.v4.request.Categories.GetCategoryByIdRequest;\n\ import java.util.HashMap;\nimport org.apache.http.HttpHeaders;\nimport com.nutanix.dp1.ctgrs.prism.v4.config.Category;\n\ import com.nutanix.dp1.ctgrs.prism.v4.config.GetCategoryApiResponse;\nimport\ \ com.nutanix.dp1.ctgrs.prism.v4.config.UpdateCategoryApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ CategoriesApi categoriesApi = new CategoriesApi(apiClient);\n\n \ \ Category category = new Category();\n\n // Category object\ \ initializations here...\n category.setKey(\"AvailabilityZone\"\ ); // required field\n category.setValue(\"APAC\"); // required\ \ field\n \n String extId = \"EbDB1b3a-db5C-eeAa-D42C-e7fea3c55f23\"\ ;\n\n // perform GET call\n GetCategoryApiResponse getResponse\ \ = null;\n try {\n getResponse = categoriesApi.getCategoryById(GetCategoryByIdRequest.builder()\n\ \ .extId(extId)\n .build());\n } catch(RestClientException\ \ ex) {\n System.out.println(ex.getMessage());\n }\n \ \ // Extract E-Tag Header\n String eTag = ApiClient.getEtag(getResponse);\n\ \ // initialize/change parameters for update\n HashMap opts = new HashMap<>();\n opts.put(HttpHeaders.IF_MATCH,\ \ eTag);\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n UpdateCategoryApiResponse\ \ updateCategoryApiResponse = categoriesApi.updateCategoryById(UpdateCategoryByIdRequest.builder()\n\ \ .extId(extId)\n .build(), category, opts);\n\ \n System.out.println(updateCategoryApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, CategoriesApi, Category, GetCategoryApiResponse\ \ } from \"@nutanix-api/prism-js-client\";\n\n// Configure the client\n\ let apiClientInstance = new ApiClient();\n// IPv4/IPv6 address or FQDN of\ \ the cluster\napiClientInstance.host = 'localhost';\n// Port used for the\ \ connection. PC products typically use port 9440, while NC products typically\ \ use port 443. See the product-specific documentation for accurate configuration.\n\ apiClientInstance.port = '9440';\n// Max retry attempts while reconnecting\ \ on a loss of connection\napiClientInstance.maxRetryAttempts = 5;\n// Interval\ \ in ms to use during retry attempts\napiClientInstance.retryInterval =\ \ 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let categoriesApi = new CategoriesApi(apiClientInstance);\n\nfunction sample()\ \ {\n let category = new Category();\n\n // Category object initializations\ \ here...\n category.setKey(\"AvailabilityZone\"); // required field\n\ \ category.setValue(\"APAC\"); // required field\n category = JSON.stringify(category);\n\ \n \n let extId = \"FB8e7FE6-CC85-c93b-6CBb-AecdbB7Edb8e\";\n\n\n\ \ // Perform Get call\n categoriesApi.getCategoryById(extId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n // Extract E-Tag Header\n \ \ let etagValue = ApiClient.getEtag(data);\n let args = {\"If-Match\"\ \ : etagValue};\n\n categoriesApi.updateCategoryById(extId, category,\ \ args).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ categories_api = ntnx_prism_py_client.CategoriesApi(api_client=client)\n\ \ category = ntnx_prism_py_client.Category()\n\n # Category object\ \ initializations here...\n category.key = \"AvailabilityZone\" # required\ \ field\n category.value = \"APAC\" # required field\n \n ext_id\ \ = \"25AAFA60-eEaB-13fd-ECEa-B9670cC6bF14\"\n\n try:\n api_response\ \ = categories_api.get_category_by_id(extId=ext_id)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n # Extract E-Tag Header\n etag_value =\ \ ntnx_prism_py_client.ApiClient.get_etag(api_response)\n\n try:\n \ \ api_response = categories_api.update_category_by_id(extId=ext_id,\ \ body=category, if_match=etag_value)\n print(api_response)\n \ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/categories\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/error\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n CategoriesServiceApiInstance\ \ *api.CategoriesServiceApi\n)\n\nfunc main() {\n ApiClientInstance =\ \ client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ CategoriesServiceApiInstance = api.NewCategoriesServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n category := import1.NewCategory()\n\ \n // Category object initializations here...\n\n \n extId := \"\ BCda8AE0-FaF4-2dcd-EEF7-9Dde88e94EAf\"\n\n getRequest := categories.GetCategoryByIdRequest{\ \ extId: &extId }\n getResponse, err := CategoriesServiceApiInstance.GetCategoryById(ctx,\ \ &getRequest)\n if err != nil {\n fmt.Println(err)\n return\n\ \ }\n\n // Extract E-Tag Header\n etagValue := ApiClientInstance.GetEtag(getResponse)\n\ \n args := make(map[string] interface{})\n args[\"If-Match\"] = etagValue\n\ \n request := categories.UpdateCategoryByIdRequest{ ExtId: &extId, Body:\ \ category }\n response, error := CategoriesServiceApiInstance.UpdateCategoryById(ctx,\ \ &request, args)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import2.AppMessage)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request PUT \ --url "https://host:port/api/prism/v4.3/config/categories/cda8C3c9-C26d-5277-4Aa2-01BDc04FDAbE" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'If-Match: string_sample_data' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"key":"AvailabilityZone","value":"APAC","type":"$UNKNOWN","description":"Thiscategoryismeanttobeusedtoenforcepoliciesspecifictoavailabilityzones.","ownerUuid":"string","associations":[{"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","count":0,"$objectType":"prism.v4.config.AssociationSummary"}],"detailedAssociations":[{"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","resourceId":"b8f5e88d-32e2-44c6-aa37-a37ffdb557ef","$objectType":"prism.v4.config.AssociationDetail"}],"$objectType":"prism.v4.config.Category"} \ - lang: Wget source: |2 wget --verbose \ --method PUT \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'If-Match: string_sample_data' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"key":"AvailabilityZone","value":"APAC","type":"$UNKNOWN","description":"Thiscategoryismeanttobeusedtoenforcepoliciesspecifictoavailabilityzones.","ownerUuid":"string","associations":[{"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","count":0,"$objectType":"prism.v4.config.AssociationSummary"}],"detailedAssociations":[{"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"categoryId":"0a817535-bca1-4e50-9395-f1970ebaa2db","resourceType":"$UNKNOWN","resourceGroup":"$UNKNOWN","resourceId":"b8f5e88d-32e2-44c6-aa37-a37ffdb557ef","$objectType":"prism.v4.config.AssociationDetail"}],"$objectType":"prism.v4.config.Category"} \ - "https://host:port/api/prism/v4.3/config/categories/fdE800dc-Ebd5-Ef3E-fFC5-c1D53F7DcAE9" - lang: Csharp source: "\n\nusing Nutanix.CtgrsSDK.Client;\nusing Nutanix.CtgrsSDK.Api;\n\ using Nutanix.CtgrsSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ CategoriesApi categoriesApi = new CategoriesApi(client);\n\n Category\ \ category = new Category();\n\n // Category object initializations\ \ here...\n category.Key = \"AvailabilityZone\"; // required field\n\ \ category.Value = \"APAC\"; // required field\n\n String extId\ \ = \"ADBE7BdA-b4Ff-9FDC-dE35-EEEc6dDee1F0\";\n\n // perform GET\ \ call\n var getRequest = new GetCategoryByIdRequest {\n \ \ ExtId = extId\n };\n try {\n GetCategoryApiResponse\ \ getResponse = categoriesApi.GetCategoryById(getRequest);\n } catch(ApiException\ \ ex) {\n Console.WriteLine(ex.Message);\n }\n \ \ // Extract E-Tag Header\n string eTag = ApiClient.GetEtag(getResponse);\n\ \ // initialize/change parameters for update\n Dictionary opts = new Dictionary();\n opts[\"If-Match\"\ ] = eTag;\n // Create request object with parameters\n var\ \ request = new UpdateCategoryByIdRequest {\n ExtId = extId,\n\ \ Body = category,\n \n \n };\n\ \ try {\n UpdateCategoryApiResponse updateCategoryApiResponse\ \ = categoriesApi.UpdateCategoryById(request, opts);\n } catch (ApiException\ \ ex) {\n Console.WriteLine(ex.Message);\n }\n }\n\ \ }\n}\n" delete: tags: - Categories summary: | Delete a category description: | Deletes a category with the given external identifier. operationId: deleteCategoryById parameters: - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: bbc089f1-a781-42da-81aa-9b4d759f6d8e responses: "204": description: | Deleted the requested category. content: application/json: {} "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Delete operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Delete operation" x-permissions: operationName: Delete Category roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Project Manager - name: Super Admin - name: Storage Admin - name: Category Admin - name: CSI System - name: Kubernetes Data Services System - name: Kubernetes Infrastructure Provision - name: Kubernetes Admin - name: NCM Connector x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers: get: tags: - DomainManager summary: | List restorable domain managers description: | Lists all the domain managers backed up at the object store/cluster. operationId: listRestorableDomainManagers parameters: - name: restoreSourceExtId in: path description: "A unique identifier obtained from the restore source API that\ \ corresponds to the details provided for the \nrestore source.\n" 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: d7f79b26-80e9-444e-a9d1-22a642fdd305 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: extId example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers?$filter=extId\ \ eq '09534c07-4acc-4028-b749-e503f8a9ce6c'" responses: "200": description: | Returns a list of restorable domain mangers. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.management.RestorableDomainManager' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers\ \ Get operation" x-permissions: operationName: View Restorable Domain Manager deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Prism Viewer - name: Domain Manager Admin - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.ListRestorableDomainManagersRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ListRestorableDomainManagersApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String restoreSourceExtId = \"dE28Df92-Ef0F-ecE6-85aB-cA7FbfFFE5fe\"\ ;\n \n int page = 0;\n \n int limit = 50;\n\n\ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n ListRestorableDomainManagersApiResponse\ \ listRestorableDomainManagersApiResponse = domainManagerBackupsApi.listRestorableDomainManagers(ListRestorableDomainManagersRequest.builder()\n\ \ .restoreSourceExtId(restoreSourceExtId)\n \ \ .$page(page)\n .$limit(limit)\n .$filter(null)\n\ \ .build());\n\n System.out.println(listRestorableDomainManagersApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let restoreSourceExtId = \"ebfae48A-2A50-D068-b74F-b3FaAfedEC7D\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $page\"] = 0;\n opts[\"$limit\"] = 50;\n opts[\"$filter\"] = \"string_sample_data\"\ ;\n\n\n\n\n domainManagerBackupsApi.listRestorableDomainManagers(restoreSourceExtId,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n restore_source_ext_id = \"cCad7d22-fEA0-cFb5-dB92-aFA72BBeaDfe\"\ \n \n page = 0\n \n limit = 50\n\n\n try:\n api_response\ \ = domain_manager_backups_api.list_restorable_domain_managers(restoreSourceExtId=restore_source_ext_id,\ \ _page=page, _limit=limit)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n restoreSourceExtId := \"8F9fE1DE-5edC-E0BE-c4b0-d4E36f2DE7cF\"\ \n \n page_ := 0\n \n limit_ := 50\n\n\n request := domainmanagerbackups.ListRestorableDomainManagersRequest{\ \ RestoreSourceExtId: &restoreSourceExtId, Page_: &page_, Limit_: &limit_,\ \ Filter_: nil }\n response, error := DomainManagerBackupsServiceApiInstance.ListRestorableDomainManagers(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.RestorableDomainManager)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/restore-sources/ec8Beee7-E4c7-2852-0C7b-F8Bff4ad1dEb/restorable-domain-managers?$filter=string_sample_data&$limit=50&$page=0" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/restore-sources/6B5EabAd-fFA6-c6D6-FaDd-Abd01C3EaEAa/restorable-domain-managers?$filter=string_sample_data&$limit=50&$page=0" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String restoreSourceExtId = \"DB5Fb48C-FDE7-3Fbb-34aD-BAc7db3aedb2\"\ ;\n int page = 0;\n int limit = 50;\n String filter = \"\ string_sample_data\";\n\n // Create request object with parameters\n\ \ var request = new ListRestorableDomainManagersRequest {\n \ \ RestoreSourceExtId = restoreSourceExtId,\n Page = page,\n\ \ Limit = limit,\n Filter = filter\n };\n \ \ try {\n ListRestorableDomainManagersApiResponse listRestorableDomainManagersApiResponse\ \ = domainManagerBackupsApi.ListRestorableDomainManagers(request);\n \ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" ? /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points : get: tags: - DomainManager summary: | List restore points description: "The list restore points API allows you to retrieve a list of available\ \ restore points, \nwhich are snapshots of the domain manager taken at different\ \ times.\nThese restore points can be used to revert the domain manager to\ \ a previous state.\nThe list response includes the creation time and identifier\ \ ID for the configuration data.
\n1. For cluster-based backups, only\ \ the most recent restore point is available, as backups are continuous.
\n\ 2. For object store-based backups, multiple restore points may be available,\ \ depending on the configured \nRecovery Point Objective (RPO) and the retention\ \ period set on the bucket.\n" operationId: listRestorePoints parameters: - name: restoreSourceExtId in: path description: "A unique identifier obtained from the restore source API that\ \ corresponds to the details provided for the \nrestore source.\n" 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: eb7cfc74-9086-42c2-a9e1-b4c305bd6f34 - name: restorableDomainManagerExtId in: path description: | A unique identifier for the domain manager. 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: ad77c335-cfc8-4023-a748-f47054879791 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: creationTime example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$filter=creationTime\ \ eq '2009-09-23T14:30:00-07:00'" - 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 descending order." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: creationTime example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$orderby=creationTime" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: creationTime example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$select=creationTime" - name: domainManager example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$select=domainManager" - name: extId example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$select=extId" - name: links example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$select=links" - name: tenantId example: "https://{host}:{port}/api/prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points?$select=tenantId" responses: "200": description: | Returns a list of paginated restore points. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.management.RestorePoint' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points\ \ Get operation" x-permissions: operationName: View Restorable Domain Manager Restore Point deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Prism Viewer - name: Domain Manager Admin - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.ListRestorePointsRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ListRestorePointsApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String restoreSourceExtId = \"f9A9eAB3-BdEB-C08C-Cd9c-b9660E733adE\"\ ;\n \n String restorableDomainManagerExtId = \"748Ffc82-9bA8-DdaE-BcfD-Acea5eCFe3bb\"\ ;\n \n int page = 0;\n \n int limit = 50;\n\n\ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n ListRestorePointsApiResponse\ \ listRestorePointsApiResponse = domainManagerBackupsApi.listRestorePoints(ListRestorePointsRequest.builder()\n\ \ .restoreSourceExtId(restoreSourceExtId)\n \ \ .restorableDomainManagerExtId(restorableDomainManagerExtId)\n \ \ .$page(page)\n .$limit(limit)\n \ \ .$filter(null)\n .$orderby(null)\n .$select(null)\n\ \ .build());\n\n System.out.println(listRestorePointsApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let restoreSourceExtId = \"1cCbE53c-28CF-f7Bd-0aD6-5EddeBc4bBAF\"\ ;\n \n let restorableDomainManagerExtId = \"FDfccAbA-eAad-fdBf-C6D7-D17CCDeAD37e\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $page\"] = 0;\n opts[\"$limit\"] = 50;\n opts[\"$filter\"] = \"string_sample_data\"\ ;\n opts[\"$orderby\"] = \"string_sample_data\";\n opts[\"$select\"\ ] = \"string_sample_data\";\n\n\n\n\n domainManagerBackupsApi.listRestorePoints(restoreSourceExtId,\ \ restorableDomainManagerExtId, opts).then(({data, response}) => {\n \ \ console.log(`API returned the following status code: ${response.status}`);\n\ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n restore_source_ext_id = \"CAA0C3CE-EB2D-dBD1-2800-6B653e9ef16A\"\ \n \n restorable_domain_manager_ext_id = \"4f1adDD1-bb3b-2DdF-94DB-dBf2f635EBC7\"\ \n \n page = 0\n \n limit = 50\n\n\n try:\n api_response\ \ = domain_manager_backups_api.list_restore_points(restoreSourceExtId=restore_source_ext_id,\ \ restorableDomainManagerExtId=restorable_domain_manager_ext_id, _page=page,\ \ _limit=limit)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n restoreSourceExtId := \"d1ad543c-ED0b-38f2-A7Ba-be0CE50Da261\"\ \n \n restorableDomainManagerExtId := \"bBE88F89-Da8b-84CA-Eace-F43e6FF8dd86\"\ \n \n page_ := 0\n \n limit_ := 50\n\n\n request := domainmanagerbackups.ListRestorePointsRequest{\ \ RestoreSourceExtId: &restoreSourceExtId, RestorableDomainManagerExtId:\ \ &restorableDomainManagerExtId, Page_: &page_, Limit_: &limit_, Filter_:\ \ nil, Orderby_: nil, Select_: nil }\n response, error := DomainManagerBackupsServiceApiInstance.ListRestorePoints(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.RestorePoint)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/restore-sources/934c9BAd-0Fd2-8e57-Bee0-EAaa0DF13e7d/restorable-domain-managers/a6b9BF5F-Ab65-ffaB-2ACE-ebb7Cb6D9bF9/restore-points?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/restore-sources/aDAeEBf3-b3d6-cB8D-83Ac-4Ba1C1AeFEE4/restorable-domain-managers/a67D61f7-Dd3A-acFF-daeD-FA5eCdBABc38/restore-points?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String restoreSourceExtId = \"ad2FDaBD-eD9c-DBdE-8bBF-bDF7aeBE8FfC\"\ ;\n String restorableDomainManagerExtId = \"cC2BadfC-BAbA-A8de-5d0d-FcDAb5FCfEea\"\ ;\n int page = 0;\n int limit = 50;\n String filter = \"\ string_sample_data\";\n String orderby = \"string_sample_data\";\n\ \ String select = \"string_sample_data\";\n\n // Create request\ \ object with parameters\n var request = new ListRestorePointsRequest\ \ {\n RestoreSourceExtId = restoreSourceExtId,\n RestorableDomainManagerExtId\ \ = restorableDomainManagerExtId,\n Page = page,\n \ \ Limit = limit,\n Filter = filter,\n Orderby = orderby,\n\ \ Select = select\n };\n try {\n ListRestorePointsApiResponse\ \ listRestorePointsApiResponse = domainManagerBackupsApi.ListRestorePoints(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" ? /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId} : get: tags: - DomainManager summary: | Get restore point details description: | Retrieves detailed information about a specific recovery point and provides essential domain manager information stored in the backup, which is required for the restoration process. operationId: getRestorePointById parameters: - name: restoreSourceExtId in: path description: "A unique identifier obtained from the restore source API that\ \ corresponds to the details provided for the \nrestore source.\n" 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: 14823590-5695-4c0c-a993-a2cdbe6112aa - name: restorableDomainManagerExtId in: path description: | A unique identifier for the domain manager. 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: 3a24c3fd-2778-4898-a5ce-5c618897f9a1 - name: extId in: path description: | Restore point ID for the backup created in cluster/object store. 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: b44c0ff4-55c4-423f-ad5d-35d11ff6bea3 responses: "200": description: | Returns the requested restore point details. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.management.RestorePoint' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}\ \ Get operation" x-permissions: operationName: View Restorable Domain Manager Restore Point deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Prism Viewer - name: Domain Manager Admin - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.GetRestorePointByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.GetRestorePointApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String restoreSourceExtId = \"CB09B1e8-Ae1B-e6c3-BF2F-4cBc76a7C7aC\"\ ;\n \n String restorableDomainManagerExtId = \"d233d2F9-ff5B-a4F8-Ec02-8db55F5555ac\"\ ;\n \n String extId = \"02Fe9c3B-2cB3-82Bf-8C1B-BFf3Cff7eaFb\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetRestorePointApiResponse\ \ getRestorePointApiResponse = domainManagerBackupsApi.getRestorePointById(GetRestorePointByIdRequest.builder()\n\ \ .restoreSourceExtId(restoreSourceExtId)\n \ \ .restorableDomainManagerExtId(restorableDomainManagerExtId)\n \ \ .extId(extId)\n .build());\n\n System.out.println(getRestorePointApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let restoreSourceExtId = \"aC8fDa17-b64f-EE7d-dade-37AfdC0Ce3Bc\"\ ;\n \n let restorableDomainManagerExtId = \"B8e67CB9-dbfe-2abD-eddF-26FBeAd8A4a6\"\ ;\n \n let extId = \"bd76D9Ef-4801-B5fC-14Ce-EDFcBEef2AE7\";\n\n\n\ \n\n\n domainManagerBackupsApi.getRestorePointById(restoreSourceExtId,\ \ restorableDomainManagerExtId, extId).then(({data, response}) => {\n \ \ console.log(`API returned the following status code: ${response.status}`);\n\ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n restore_source_ext_id = \"3933C24c-DcfB-0fCa-9B9B-BeaCedC91f4A\"\ \n \n restorable_domain_manager_ext_id = \"aDF35FeC-BCFb-Ef3A-bbE9-0dCae9aFbCCA\"\ \n \n ext_id = \"0fECfafc-06e0-db0d-343D-37eEcA5a90Fa\"\n\n\n try:\n\ \ api_response = domain_manager_backups_api.get_restore_point_by_id(restoreSourceExtId=restore_source_ext_id,\ \ restorableDomainManagerExtId=restorable_domain_manager_ext_id, extId=ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n restoreSourceExtId := \"BB6AB8dE-aD4C-CC46-D72D-24Dffc4AceBb\"\ \n \n restorableDomainManagerExtId := \"9B8AAEBf-3d3d-A12B-ec5D-f8aFa6CC4Bdd\"\ \n \n extId := \"e64D02A1-899b-1f85-8DeD-Dad17bACCEE5\"\n\n\n request\ \ := domainmanagerbackups.GetRestorePointByIdRequest{ RestoreSourceExtId:\ \ &restoreSourceExtId, RestorableDomainManagerExtId: &restorableDomainManagerExtId,\ \ ExtId: &extId }\n response, error := DomainManagerBackupsServiceApiInstance.GetRestorePointById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.RestorePoint)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/restore-sources/5DebfCa1-1B6f-c1Ec-e5Ab-bbbFDbBEcC9f/restorable-domain-managers/eB4bfED0-9aFf-efC8-AeeA-f9Ef9dFa5Da0/restore-points/a4Bd7ae4-eCFd-d6db-8bfE-F9cCE91DBC11" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/restore-sources/590fF4fb-aa9D-c63a-A48B-5BafEc6A32cE/restorable-domain-managers/eFBBb6E0-26C0-AccC-cF09-94F26D54cdfd/restore-points/ab2EA7ee-cec1-A7BC-bd2a-aeebC7b0CBe5" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String restoreSourceExtId = \"D210cED4-fBf8-Aa9f-aFee-A9aDEbcAC3E4\"\ ;\n String restorableDomainManagerExtId = \"E2DaD194-1BA6-A1bF-bdEf-eCAdC77a15dD\"\ ;\n String extId = \"2AFDedec-BEB1-AdDe-4fc8-c132fF5Aed6E\";\n\n \ \ // Create request object with parameters\n var request = new\ \ GetRestorePointByIdRequest {\n RestoreSourceExtId = restoreSourceExtId,\n\ \ RestorableDomainManagerExtId = restorableDomainManagerExtId,\n\ \ ExtId = extId\n };\n try {\n GetRestorePointApiResponse\ \ getRestorePointApiResponse = domainManagerBackupsApi.GetRestorePointById(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets: get: tags: - DomainManager summary: | List backup targets description: | Lists backup targets (cluster or object store) configured for a given domain manager. operationId: listBackupTargets parameters: - name: domainManagerExtId in: path description: | A unique identifier for the domain manager. 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: 79986922-4215-4240-a9be-8282cc289f2a responses: "200": description: | Returns a list of backup clusters/object store backing up the domain manager. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: maxItems: 4 type: array items: $ref: '#/components/schemas/prism.v4.3.management.BackupTarget' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Get operation" x-permissions: operationName: View Domain Manager Backup Target deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Prism Viewer - name: Domain Manager Admin - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.ListBackupTargetsRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ListBackupTargetsApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String domainManagerExtId = \"d73fCafE-6cF4-7fD4-75E1-dAd781afab75\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n ListBackupTargetsApiResponse\ \ listBackupTargetsApiResponse = domainManagerBackupsApi.listBackupTargets(ListBackupTargetsRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .build());\n\n System.out.println(listBackupTargetsApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let domainManagerExtId = \"7CceeF3f-80fC-b7FD-87AF-efaecFE9AFd2\"\ ;\n\n\n\n\n\n domainManagerBackupsApi.listBackupTargets(domainManagerExtId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"eacEC19C-DF3F-Bb9D-c5d5-e2FEb0Df350A\"\ \n\n\n try:\n api_response = domain_manager_backups_api.list_backup_targets(domainManagerExtId=domain_manager_ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"0E3ba7f3-c80b-2Fdd-2BEF-4efbcB627De5\"\ \n\n\n request := domainmanagerbackups.ListBackupTargetsRequest{ DomainManagerExtId:\ \ &domainManagerExtId }\n response, error := DomainManagerBackupsServiceApiInstance.ListBackupTargets(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.BackupTarget)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/domain-managers/B0c0C62B-eCBF-5eD6-AF0B-9BcCcAeDD1dD/backup-targets" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/1b88Cd2D-Bd6f-eb3C-CedB-EdECFcB9f63E/backup-targets" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String domainManagerExtId = \"b1E6c906-7d5e-a95c-EDbE-8EF42e5b33A9\"\ ;\n\n // Create request object with parameters\n var request\ \ = new ListBackupTargetsRequest {\n DomainManagerExtId = domainManagerExtId\n\ \ };\n try {\n ListBackupTargetsApiResponse listBackupTargetsApiResponse\ \ = domainManagerBackupsApi.ListBackupTargets(request);\n } catch\ \ (ApiException ex) {\n Console.WriteLine(ex.Message);\n \ \ }\n }\n }\n}\n" post: tags: - DomainManager summary: | Create backup target description: "Creates a cluster or object store as the backup target. For a\ \ given Prism Central,\nthere can be up to 3 clusters as backup targets \n\ and 1 object store as backup target. If any cluster or object store is not\ \ eligible for backup or \nlacks appropriate permissions, the API request\ \ will fail. \nFor object store backup targets, specifying backup policy is\ \ mandatory along \nwith the location of the object store.\n" operationId: createBackupTarget parameters: - name: domainManagerExtId in: path description: | A unique identifier for the domain manager. 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: 2c68cea3-0be1-4e2a-9f13-05ccb615b0fe - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 0cf1c52d-05ce-4e5e-9ff5-b325f7d1cd12 requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.BackupTarget' required: true responses: "202": description: | Returns the task ID corresponding to the create backup target request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Post operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Post operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Post operation" x-permissions: operationName: Create Domain Manager Backup Target deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.CreateBackupTargetRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.BackupTarget;\nimport com.nutanix.dp1.pri.prism.v4.management.CreateBackupTargetApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n BackupTarget backupTarget = new BackupTarget();\n\n //\ \ BackupTarget object initializations here...\n \n String\ \ domainManagerExtId = \"6ecAF1D9-fFCc-3F3E-78FA-Eaa31EAae0cA\";\n\n \ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n CreateBackupTargetApiResponse\ \ createBackupTargetApiResponse = domainManagerBackupsApi.createBackupTarget(CreateBackupTargetRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .build(), backupTarget);\n\n System.out.println(createBackupTargetApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi, BackupTarget } from\ \ \"@nutanix-api/prism-js-client\";\n\n// Configure the client\nlet apiClientInstance\ \ = new ApiClient();\n// IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host\ \ = 'localhost';\n// Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\napiClientInstance.port = '9440';\n\ // Max retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n let backupTarget = new BackupTarget();\n\n \ \ // BackupTarget object initializations here...\n backupTarget = JSON.stringify(backupTarget);\n\ \n \n let domainManagerExtId = \"296DF9EC-1033-E58E-e6Fb-E2C4fcaC9beF\"\ ;\n\n\n\n\n\n domainManagerBackupsApi.createBackupTarget(domainManagerExtId,\ \ backupTarget).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ backupTarget = ntnx_prism_py_client.BackupTarget()\n\n # BackupTarget\ \ object initializations here...\n \n domain_manager_ext_id = \"aBcaA046-Defe-c16a-9Efb-DC8bC96bca66\"\ \n\n\n try:\n api_response = domain_manager_backups_api.create_backup_target(domainManagerExtId=domain_manager_ext_id,\ \ body=backupTarget)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n backupTarget := import1.NewBackupTarget()\n\ \n // BackupTarget object initializations here...\n\n \n domainManagerExtId\ \ := \"b2B7BbCc-4DD0-aAce-BDc3-9Dbecda0dCdE\"\n\n\n request := domainmanagerbackups.CreateBackupTargetRequest{\ \ DomainManagerExtId: &domainManagerExtId, Body: backupTarget }\n response,\ \ error := DomainManagerBackupsServiceApiInstance.CreateBackupTarget(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import2.TaskReference)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/management/domain-managers/cFBBCf9e-eb08-Ea7d-56a0-d1ab2F0ebF3B/backup-targets" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"location":{"config":{"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"},"$objectType":"prism.v4.management.ClusterLocation"},"lastSyncTime":"2015-07-20T15:49:04-07:00","isBackupPaused":true,"backupPauseReason":"Thebackupispausedduetoanupgradeinprogress.Itwillbeautomaticallyresumedwhentheupgradeiscomplete.","$objectType":"prism.v4.management.BackupTarget"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"location":{"config":{"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"},"$objectType":"prism.v4.management.ClusterLocation"},"lastSyncTime":"2015-07-20T15:49:04-07:00","isBackupPaused":true,"backupPauseReason":"Thebackupispausedduetoanupgradeinprogress.Itwillbeautomaticallyresumedwhentheupgradeiscomplete.","$objectType":"prism.v4.management.BackupTarget"} \ - "https://host:port/api/prism/v4.3/management/domain-managers/8bB94bc7-346b-daAB-AaDD-Db43DBFbCdE7/backup-targets" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n BackupTarget backupTarget = new BackupTarget();\n\n // BackupTarget\ \ object initializations here...\n\n String domainManagerExtId = \"\ fF6a06Bf-e1cf-7F01-DdcC-F1CBa8bc53ca\";\n\n // Create request object\ \ with parameters\n var request = new CreateBackupTargetRequest {\n\ \ DomainManagerExtId = domainManagerExtId,\n Body\ \ = backupTarget\n };\n try {\n CreateBackupTargetApiResponse\ \ createBackupTargetApiResponse = domainManagerBackupsApi.CreateBackupTarget(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}: get: tags: - DomainManager summary: | Fetch backup target description: | Retrieves the backup targets (cluster or object store) from a domain manager and returns the backup configuration and lastSyncTimestamp parameter to the user. operationId: getBackupTargetById parameters: - name: domainManagerExtId in: path description: | A unique identifier for the domain manager. 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: b6ee55a8-f0e0-4903-b68f-4613289be78a - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 45d21c92-a387-4e86-870e-9e3d772ef768 responses: "200": description: | Returns the backup target details corresponding to the cluster/object store configuration. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.management.BackupTarget' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Get operation" x-permissions: operationName: View Domain Manager Backup Target deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Prism Viewer - name: Domain Manager Admin - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.GetBackupTargetByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.GetBackupTargetApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String domainManagerExtId = \"ea2CF05a-A50b-4F6E-9f9b-0d3bBffEd2a8\"\ ;\n \n String extId = \"1ABfDEFf-830F-A66A-EC6E-A9B0Fe94fFab\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetBackupTargetApiResponse\ \ getBackupTargetApiResponse = domainManagerBackupsApi.getBackupTargetById(GetBackupTargetByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build());\n\n System.out.println(getBackupTargetApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let domainManagerExtId = \"cBcbdcda-EF7c-dFBa-8aBC-a4BaC81Ae672\"\ ;\n \n let extId = \"B41d7FaB-8dD2-2dd2-CB66-CebfDbbB7Fef\";\n\n\n\ \n\n\n domainManagerBackupsApi.getBackupTargetById(domainManagerExtId,\ \ extId).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"d7F82cEb-CdAf-f01b-F97E-7Fe630D3a2bc\"\ \n \n ext_id = \"d1cCE3df-b0f6-8AD1-2B47-C1dC1d6eebF1\"\n\n\n try:\n\ \ api_response = domain_manager_backups_api.get_backup_target_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"CFeB6BBA-2A21-5548-EAac-1F4a0c4Cb8E5\"\ \n \n extId := \"fbDeaAbe-ba6A-EDCC-b95a-393aCcAf05FE\"\n\n\n request\ \ := domainmanagerbackups.GetBackupTargetByIdRequest{ DomainManagerExtId:\ \ &domainManagerExtId, ExtId: &extId }\n response, error := DomainManagerBackupsServiceApiInstance.GetBackupTargetById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.BackupTarget)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/domain-managers/feE8C2bA-Aa3d-6eBe-CAA5-4fb15db93DD8/backup-targets/FFECFf80-d0f4-40d2-c93d-FaA2dEdDAaE3" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/EdDACDd9-CEAF-2D7E-4608-b5fFEBDDd61C/backup-targets/4F18EEBF-B9DA-e2CE-E0f8-4CddfDeeCd76" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String domainManagerExtId = \"dFdBECfC-bDD7-a7fb-5CaE-b07AdAfeC18f\"\ ;\n String extId = \"003Dd3F2-Ed4a-AAb3-AD68-db75dC0ebaBF\";\n\n \ \ // Create request object with parameters\n var request = new\ \ GetBackupTargetByIdRequest {\n DomainManagerExtId = domainManagerExtId,\n\ \ ExtId = extId\n };\n try {\n GetBackupTargetApiResponse\ \ getBackupTargetApiResponse = domainManagerBackupsApi.GetBackupTargetById(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" put: tags: - DomainManager summary: | Update backup target description: "Updates the credentials, RP0, or certificates (for Nutanix Objects\ \ only) of the given object store based on the user requirements. \nRPO is\ \ mandatory to be passed in payload. Credentials and certificates are optional\ \ to pass in update backup target api.\nIf credentials or certificates are\ \ not passed then these will not be updated for a backup target.\n" operationId: updateBackupTargetById parameters: - name: domainManagerExtId in: path description: | A unique identifier for the domain manager. 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: 7a64c03e-8776-4302-9bd3-f5ec17551eae - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 984870d9-fc3c-4261-8a40-d1bc4249062f - name: If-Match in: header description: "The If-Match request header makes the request conditional. When\ \ not provided, the server will respond with an HTTP-428 (Precondition\ \ Required) response code indicating that the server requires the request\ \ to be conditional. The server will allow the successful completion of\ \ PUT and PATCH operations, if the resource matches the ETag value returned\ \ to the response of a GET operation. If the conditional does not match,\ \ then an HTTP-412 (Precondition Failed) response will be returned." required: true style: simple explode: false schema: type: string example: string - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 9b5bf681-beed-45b8-8f23-be85362c1b63 requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.BackupTarget' required: true responses: "202": description: | Returns the task ID corresponding to the update backup target request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Put operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Put operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Put operation" x-permissions: operationName: Update Domain Manager Backup Target deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.UpdateBackupTargetByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.GetBackupTargetByIdRequest;\n\ import java.util.HashMap;\nimport org.apache.http.HttpHeaders;\nimport com.nutanix.dp1.pri.prism.v4.management.BackupTarget;\n\ import com.nutanix.dp1.pri.prism.v4.management.GetBackupTargetApiResponse;\n\ import com.nutanix.dp1.pri.prism.v4.management.UpdateBackupTargetApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n BackupTarget backupTarget = new BackupTarget();\n\n //\ \ BackupTarget object initializations here...\n \n String\ \ domainManagerExtId = \"D7Dbc7E7-EDa0-c9CD-F30E-31C91C9aDBf8\";\n \ \ \n String extId = \"2E2edAEA-E4a9-CAcf-C1bD-bFAe6BdaDE53\";\n\ \n // perform GET call\n GetBackupTargetApiResponse getResponse\ \ = null;\n try {\n getResponse = domainManagerBackupsApi.getBackupTargetById(GetBackupTargetByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build());\n } catch(RestClientException\ \ ex) {\n System.out.println(ex.getMessage());\n }\n \ \ // Extract E-Tag Header\n String eTag = ApiClient.getEtag(getResponse);\n\ \ // initialize/change parameters for update\n HashMap opts = new HashMap<>();\n opts.put(HttpHeaders.IF_MATCH,\ \ eTag);\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n UpdateBackupTargetApiResponse\ \ updateBackupTargetApiResponse = domainManagerBackupsApi.updateBackupTargetById(UpdateBackupTargetByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build(), backupTarget, opts);\n\n \ \ System.out.println(updateBackupTargetApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi, BackupTarget, GetBackupTargetApiResponse\ \ } from \"@nutanix-api/prism-js-client\";\n\n// Configure the client\n\ let apiClientInstance = new ApiClient();\n// IPv4/IPv6 address or FQDN of\ \ the cluster\napiClientInstance.host = 'localhost';\n// Port used for the\ \ connection. PC products typically use port 9440, while NC products typically\ \ use port 443. See the product-specific documentation for accurate configuration.\n\ apiClientInstance.port = '9440';\n// Max retry attempts while reconnecting\ \ on a loss of connection\napiClientInstance.maxRetryAttempts = 5;\n// Interval\ \ in ms to use during retry attempts\napiClientInstance.retryInterval =\ \ 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n let backupTarget = new BackupTarget();\n\n \ \ // BackupTarget object initializations here...\n backupTarget = JSON.stringify(backupTarget);\n\ \n \n let domainManagerExtId = \"ccDc580b-AEDb-Ba2E-9bdb-dAeEecCFDDcc\"\ ;\n \n let extId = \"Ea6C2f35-CDE2-89c8-d0Ba-af4CDeBea73C\";\n\n\n\ \ // Perform Get call\n domainManagerBackupsApi.getBackupTargetById(domainManagerExtId,\ \ extId).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n // Extract E-Tag\ \ Header\n let etagValue = ApiClient.getEtag(data);\n let\ \ args = {\"If-Match\" : etagValue};\n\n domainManagerBackupsApi.updateBackupTargetById(domainManagerExtId,\ \ extId, backupTarget, args).then(({data, response}) => {\n console.log(`API\ \ returned the following status code: ${response.status}`);\n \ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ backupTarget = ntnx_prism_py_client.BackupTarget()\n\n # BackupTarget\ \ object initializations here...\n \n domain_manager_ext_id = \"19FE5FaC-8E6d-BbFe-cf0D-BfFBaA2FFFd3\"\ \n \n ext_id = \"Fdcf6ADb-F0cb-CE0B-cfFd-FfCBdCd03fA6\"\n\n try:\n\ \ api_response = domain_manager_backups_api.get_backup_target_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id)\n except ntnx_prism_py_client.rest.ApiException as e:\n\ \ print(e)\n # Extract E-Tag Header\n etag_value = ntnx_prism_py_client.ApiClient.get_etag(api_response)\n\ \n try:\n api_response = domain_manager_backups_api.update_backup_target_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id, body=backupTarget, if_match=etag_value)\n print(api_response)\n\ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n backupTarget := import1.NewBackupTarget()\n\ \n // BackupTarget object initializations here...\n\n \n domainManagerExtId\ \ := \"f0A2abc5-717c-ac4e-CA98-BDfBABB5dDEA\"\n \n extId := \"AEd2Df7C-A9Dd-d4e1-0a4F-Ec60CED7EA0D\"\ \n\n getRequest := domainmanagerbackups.GetBackupTargetByIdRequest{ domainManagerExtId:\ \ &domainManagerExtId, extId: &extId }\n getResponse, err := DomainManagerBackupsServiceApiInstance.GetBackupTargetById(ctx,\ \ &getRequest)\n if err != nil {\n fmt.Println(err)\n return\n\ \ }\n\n // Extract E-Tag Header\n etagValue := ApiClientInstance.GetEtag(getResponse)\n\ \n args := make(map[string] interface{})\n args[\"If-Match\"] = etagValue\n\ \n request := domainmanagerbackups.UpdateBackupTargetByIdRequest{ DomainManagerExtId:\ \ &domainManagerExtId, ExtId: &extId, Body: backupTarget }\n response,\ \ error := DomainManagerBackupsServiceApiInstance.UpdateBackupTargetById(ctx,\ \ &request, args)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import2.TaskReference)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request PUT \ --url "https://host:port/api/prism/v4.3/management/domain-managers/9Ef6A2e6-de3D-bEE4-3ceC-cDb64c1CC62A/backup-targets/BfeCE0aB-A0D4-BD1d-d488-2ecBFfFaF8Ec" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'If-Match: string_sample_data' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"location":{"config":{"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"},"$objectType":"prism.v4.management.ClusterLocation"},"lastSyncTime":"2015-07-20T15:49:04-07:00","isBackupPaused":true,"backupPauseReason":"Thebackupispausedduetoanupgradeinprogress.Itwillbeautomaticallyresumedwhentheupgradeiscomplete.","$objectType":"prism.v4.management.BackupTarget"} \ - lang: Wget source: |2 wget --verbose \ --method PUT \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'If-Match: string_sample_data' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"location":{"config":{"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"},"$objectType":"prism.v4.management.ClusterLocation"},"lastSyncTime":"2015-07-20T15:49:04-07:00","isBackupPaused":true,"backupPauseReason":"Thebackupispausedduetoanupgradeinprogress.Itwillbeautomaticallyresumedwhentheupgradeiscomplete.","$objectType":"prism.v4.management.BackupTarget"} \ - "https://host:port/api/prism/v4.3/management/domain-managers/b45822de-dfE2-6CBD-BF0D-e41ea058ECcc/backup-targets/ACb07bc4-F3f1-af98-DfBF-5feCBADDbaC3" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n BackupTarget backupTarget = new BackupTarget();\n\n // BackupTarget\ \ object initializations here...\n\n String domainManagerExtId = \"\ aBbFd2dC-Dec1-10Bd-7a03-33DEB32FCdEA\";\n String extId = \"CFEDBdCB-60aa-3Cfe-eB9a-3ccf26aE0DaD\"\ ;\n\n // perform GET call\n var getRequest = new GetBackupTargetByIdRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n ExtId\ \ = extId,\n };\n var getRequest = new GetBackupTargetByIdRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n ExtId\ \ = extId\n };\n try {\n GetBackupTargetApiResponse\ \ getResponse = domainManagerBackupsApi.GetBackupTargetById(getRequestgetRequest);\n\ \ } catch(ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n // Extract E-Tag Header\n string eTag = ApiClient.GetEtag(getResponse);\n\ \ // initialize/change parameters for update\n Dictionary opts = new Dictionary();\n opts[\"If-Match\"\ ] = eTag;\n // Create request object with parameters\n var\ \ request = new UpdateBackupTargetByIdRequest {\n DomainManagerExtId\ \ = domainManagerExtId,\n ExtId = extId,\n Body =\ \ backupTarget,\n \n \n };\n try {\n\ \ UpdateBackupTargetApiResponse updateBackupTargetApiResponse\ \ = domainManagerBackupsApi.UpdateBackupTargetById(request, opts);\n \ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" delete: tags: - DomainManager summary: | Delete backup target description: "Removes cluster/object store from the backup targets. This will\ \ stop the cluster/object store \nfrom backing up Prism Central data.\n" operationId: deleteBackupTargetById parameters: - name: domainManagerExtId in: path description: | A unique identifier for the domain manager. 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: de86105e-ae69-48a9-a1fa-c58ec76c9690 - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 8df17179-effc-4d4b-a660-94d0717e2f4a - name: If-Match in: header description: | The If-Match request header makes the request conditional. When not provided the server will respond with an HTTP 428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP 412 (Precondition Failed) response required: true style: simple explode: false schema: type: string example: string - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: dc381bf2-9f97-4d99-b162-34ea6b0847cd responses: "202": description: | Returns the task ID corresponding to the delete backup target request. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Delete operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Delete operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Delete operation" x-permissions: operationName: Delete Domain Manager Backup Target deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.DeleteBackupTargetByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.GetBackupTargetByIdRequest;\n\ import java.util.HashMap;\nimport org.apache.http.HttpHeaders;\nimport com.nutanix.dp1.pri.prism.v4.management.GetBackupTargetApiResponse;\n\ import com.nutanix.dp1.pri.prism.v4.management.DeleteBackupTargetApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String domainManagerExtId = \"E0C43DDB-Eabe-CF5A-5DFF-766C3A2DaCEB\"\ ;\n \n String extId = \"E3fcCBde-DF7a-F7AE-cE6d-F5C92BB29CfA\"\ ;\n\n // perform GET call\n GetBackupTargetApiResponse getResponse\ \ = null;\n try {\n getResponse = domainManagerBackupsApi.getBackupTargetById(GetBackupTargetByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build());\n } catch(RestClientException\ \ ex) {\n System.out.println(ex.getMessage());\n }\n \ \ // Extract E-Tag Header\n String eTag = ApiClient.getEtag(getResponse);\n\ \ // initialize/change parameters for update\n HashMap opts = new HashMap<>();\n opts.put(HttpHeaders.IF_MATCH,\ \ eTag);\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n DeleteBackupTargetApiResponse\ \ deleteBackupTargetApiResponse = domainManagerBackupsApi.deleteBackupTargetById(DeleteBackupTargetByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build(), opts);\n\n System.out.println(deleteBackupTargetApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi, GetBackupTargetApiResponse\ \ } from \"@nutanix-api/prism-js-client\";\n\n// Configure the client\n\ let apiClientInstance = new ApiClient();\n// IPv4/IPv6 address or FQDN of\ \ the cluster\napiClientInstance.host = 'localhost';\n// Port used for the\ \ connection. PC products typically use port 9440, while NC products typically\ \ use port 443. See the product-specific documentation for accurate configuration.\n\ apiClientInstance.port = '9440';\n// Max retry attempts while reconnecting\ \ on a loss of connection\napiClientInstance.maxRetryAttempts = 5;\n// Interval\ \ in ms to use during retry attempts\napiClientInstance.retryInterval =\ \ 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let domainManagerExtId = \"d8AD5bA5-AFf8-fea7-Ac9E-5E3BFfFAb9CD\"\ ;\n \n let extId = \"EEB4DFfB-AFdA-2ceE-7ee7-62de5a09A3eC\";\n\n\n\ \ // Perform Get call\n domainManagerBackupsApi.getBackupTargetById(domainManagerExtId,\ \ extId).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n // Extract E-Tag\ \ Header\n let etagValue = ApiClient.getEtag(data);\n let\ \ args = {\"If-Match\" : etagValue};\n\n domainManagerBackupsApi.deleteBackupTargetById(domainManagerExtId,\ \ extId, args).then(({data, response}) => {\n console.log(`API\ \ returned the following status code: ${response.status}`);\n \ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"Fe6aA2Ef-Dacf-dcF4-dFB0-b9cf15CeBDcD\"\ \n \n ext_id = \"eaCfbfe5-7c4A-e1e0-dfEA-bb5Cbf5C6A0B\"\n\n try:\n\ \ api_response = domain_manager_backups_api.get_backup_target_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id)\n except ntnx_prism_py_client.rest.ApiException as e:\n\ \ print(e)\n # Extract E-Tag Header\n etag_value = ntnx_prism_py_client.ApiClient.get_etag(api_response)\n\ \n try:\n api_response = domain_manager_backups_api.delete_backup_target_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id, if_match=etag_value)\n print(api_response)\n except\ \ ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"FFB5bFBA-E1AF-f3dC-C6a9-81bCcB2dE3A8\"\ \n \n extId := \"C142d5Ad-d50a-0EDC-AaB8-c3ACFaf4a4AD\"\n\n getRequest\ \ := domainmanagerbackups.GetBackupTargetByIdRequest{ domainManagerExtId:\ \ &domainManagerExtId, extId: &extId }\n getResponse, err := DomainManagerBackupsServiceApiInstance.GetBackupTargetById(ctx,\ \ &getRequest)\n if err != nil {\n fmt.Println(err)\n return\n\ \ }\n\n // Extract E-Tag Header\n etagValue := ApiClientInstance.GetEtag(getResponse)\n\ \n args := make(map[string] interface{})\n args[\"If-Match\"] = etagValue\n\ \n request := domainmanagerbackups.DeleteBackupTargetByIdRequest{ DomainManagerExtId:\ \ &domainManagerExtId, ExtId: &extId }\n response, error := DomainManagerBackupsServiceApiInstance.DeleteBackupTargetById(ctx,\ \ &request, args)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.TaskReference)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request DELETE \ --url "https://host:port/api/prism/v4.3/management/domain-managers/6aFab3Bf-DAec-DBEB-bf9d-a4BBBEfeBEcD/backup-targets/bDD3bdCF-F817-16ee-CD30-a9bCCABcd5cB" \ --header 'Accept: application/json' \ --header 'If-Match: string_sample_data' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method DELETE \ --header 'Accept: application/json' \ --header 'If-Match: string_sample_data' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/fA4fAbBa-4Bd1-32Ef-BcfB-bFAFe598AEAa/backup-targets/02d1f4DC-18Dc-4abE-dB69-4dA792D7A7D4" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String domainManagerExtId = \"E5Ee4eF5-bc07-C2EB-CC73-b1AB8b9fEFd8\"\ ;\n String extId = \"cc7D8A92-EE4C-9A46-baB5-EFE84B9aE9F0\";\n\n \ \ // perform GET call\n var getRequest = new GetBackupTargetByIdRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n ExtId\ \ = extId,\n };\n var getRequest = new GetBackupTargetByIdRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n ExtId\ \ = extId\n };\n try {\n GetBackupTargetApiResponse\ \ getResponse = domainManagerBackupsApi.GetBackupTargetById(getRequestgetRequest);\n\ \ } catch(ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n // Extract E-Tag Header\n string eTag = ApiClient.GetEtag(getResponse);\n\ \ // initialize/change parameters for update\n Dictionary opts = new Dictionary();\n opts[\"If-Match\"\ ] = eTag;\n // Create request object with parameters\n var\ \ request = new DeleteBackupTargetByIdRequest {\n DomainManagerExtId\ \ = domainManagerExtId,\n ExtId = extId,\n \n \ \ \n };\n try {\n DeleteBackupTargetApiResponse\ \ deleteBackupTargetApiResponse = domainManagerBackupsApi.DeleteBackupTargetById(request,\ \ opts);\n } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" ? /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}/$actions/restore : post: tags: - DomainManager summary: | Restore domain manager description: "The restore domain manager is a task-driven operation to restore\ \ a domain manager from a cluster or object store \nbackup location based\ \ on the selected restore point.\n" operationId: restore parameters: - name: restoreSourceExtId in: path description: "A unique identifier obtained from the restore source API that\ \ corresponds to the details provided for the \nrestore source.\n" 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: 6d8918e3-ef97-448d-bbea-ce1d1b9a5eae - name: restorableDomainManagerExtId in: path description: | A unique identifier for the domain manager. 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: 8b0437a9-6566-4df9-8142-13cf5c261d99 - name: extId in: path description: | Restore point ID for the backup created in cluster/object store. 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: 0daa9607-47f8-46b0-8fe3-f5ead75051be requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.RestoreSpec' required: true responses: "202": description: | Returns a task reference object specifying a unique task ID corresponding to the restore operation. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}/$actions/restore\ \ Post operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}/$actions/restore\ \ Post operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}/$actions/restore\ \ Post operation" x-permissions: operationName: Restore Domain Manager Restore Point deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.RestoreRequest;\n\ import com.nutanix.dp1.pri.prism.v4.config.DomainManager;\nimport com.nutanix.dp1.pri.prism.v4.management.RestoreSpec;\n\ import com.nutanix.dp1.pri.prism.v4.management.RestoreApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n RestoreSpec restoreSpec = new RestoreSpec();\n\n // RestoreSpec\ \ object initializations here...\n restoreSpec.setDomainManager(new\ \ DomainManager()); // required field\n \n String restoreSourceExtId\ \ = \"fF1E2B4f-2D0d-aBaf-EEFa-cEFCdb8E53FC\";\n \n String\ \ restorableDomainManagerExtId = \"b2cCedDE-dCD9-AB5f-cf8b-0D41d8Eb5dae\"\ ;\n \n String extId = \"36F4fECe-62CB-b2AA-eC9d-78917ff9dF4B\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n RestoreApiResponse\ \ restoreApiResponse = domainManagerBackupsApi.restore(RestoreRequest.builder()\n\ \ .restoreSourceExtId(restoreSourceExtId)\n \ \ .restorableDomainManagerExtId(restorableDomainManagerExtId)\n \ \ .extId(extId)\n .build(), restoreSpec);\n\n \ \ System.out.println(restoreApiResponse.toString());\n\n \ \ } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi, DomainManager, RestoreSpec\ \ } from \"@nutanix-api/prism-js-client\";\n\n// Configure the client\n\ let apiClientInstance = new ApiClient();\n// IPv4/IPv6 address or FQDN of\ \ the cluster\napiClientInstance.host = 'localhost';\n// Port used for the\ \ connection. PC products typically use port 9440, while NC products typically\ \ use port 443. See the product-specific documentation for accurate configuration.\n\ apiClientInstance.port = '9440';\n// Max retry attempts while reconnecting\ \ on a loss of connection\napiClientInstance.maxRetryAttempts = 5;\n// Interval\ \ in ms to use during retry attempts\napiClientInstance.retryInterval =\ \ 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n let restoreSpec = new RestoreSpec();\n\n //\ \ RestoreSpec object initializations here...\n restoreSpec.setDomainManager(new\ \ DomainManager()); // required field\n restoreSpec = JSON.stringify(restoreSpec);\n\ \n \n let restoreSourceExtId = \"DdBfBD5F-14D1-FcCa-EDAE-bCbbCE8ea350\"\ ;\n \n let restorableDomainManagerExtId = \"b8f895fd-3eD0-A8FE-96Bb-0b879dbdDCbd\"\ ;\n \n let extId = \"BdCFefEB-48D4-DeDA-a8C9-10bADAfcAa6E\";\n\n\n\ \n\n\n domainManagerBackupsApi.restore(restoreSourceExtId, restorableDomainManagerExtId,\ \ extId, restoreSpec).then(({data, response}) => {\n console.log(`API\ \ returned the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ restoreSpec = ntnx_prism_py_client.RestoreSpec()\n\n # RestoreSpec\ \ object initializations here...\n restoreSpec.domain_manager = ntnx_prism_py_client.DomainManager()\ \ # required field\n \n restore_source_ext_id = \"D42aEe5E-aEA0-baAb-B1Fd-0e85Ea90E9c9\"\ \n \n restorable_domain_manager_ext_id = \"Ef6C6B6b-CE23-d4Cb-5247-511a1ceabfcB\"\ \n \n ext_id = \"ed71aA08-5eFf-Ec7d-dbFB-bbDf6A75DDDb\"\n\n\n try:\n\ \ api_response = domain_manager_backups_api.restore(restoreSourceExtId=restore_source_ext_id,\ \ restorableDomainManagerExtId=restorable_domain_manager_ext_id, extId=ext_id,\ \ body=restoreSpec)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n restoreSpec := import1.NewRestoreSpec()\n\ \n // RestoreSpec object initializations here...\n\n \n restoreSourceExtId\ \ := \"2FBEecca-E16b-A02e-dc19-0dDCD9A04fef\"\n \n restorableDomainManagerExtId\ \ := \"fc215D3F-D5FE-Aea9-bCfb-A4c3A19E5df1\"\n \n extId := \"b1c2D7A2-5eA2-64BC-b17f-efF92CCdAEFe\"\ \n\n\n request := domainmanagerbackups.RestoreRequest{ RestoreSourceExtId:\ \ &restoreSourceExtId, RestorableDomainManagerExtId: &restorableDomainManagerExtId,\ \ ExtId: &extId, Body: restoreSpec }\n response, error := DomainManagerBackupsServiceApiInstance.Restore(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import2.TaskReference)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/management/restore-sources/C2eCbbbA-F91f-Cc2a-e5AB-5AFCF88e71ce/restorable-domain-managers/42a2cbCC-BCC1-0447-2ebE-eDbbBC0cedf8/restore-points/DefBcFf2-CDc5-7cfc-dB0b-B3DAc0DfBee7/$actions/restore" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"domainManager":{"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"config":{"shouldEnableLockdownMode":true,"buildInfo":{"version":"string","$objectType":"clustermgmt.v4.config.BuildInfo"},"name":"pc_nutanix_01","size":"$UNKNOWN","bootstrapConfig":{"cloudInitConfig":[{"datasourceType":"$UNKNOWN","metadata":"string","cloudInitScript":{"value":"string","$objectType":"vmm.v4.ahv.config.Userdata"},"$objectType":"vmm.v4.ahv.config.CloudInit"}],"environmentInfo":{"type":"$UNKNOWN","providerType":"$UNKNOWN","provisioningType":"$UNKNOWN","$objectType":"prism.v4.config.EnvironmentInfo"},"$objectType":"prism.v4.config.BootstrapConfig"},"credentials":[{"username":"test-user","password":"string","$objectType":"common.v1.config.BasicAuth"}],"resourceConfig":{"numVcpus":0,"memorySizeBytes":0,"dataDiskSizeBytes":0,"containerExtIds":["string"],"$objectType":"prism.v4.config.DomainManagerResourceConfig"},"$objectType":"prism.v4.config.DomainManagerClusterConfig"},"isRegisteredWithHostingCluster":true,"network":{"externalAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"nameServers":[{"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"}],"ntpServers":[{"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"}],"fqdn":"string","httpProxyConfig":[{"ipAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"port":0,"username":"string","password":"string","name":"string","proxyTypes":["$UNKNOWN"],"$objectType":"clustermgmt.v4.config.HttpProxyConfig"}],"httpProxyWhiteListConfig":[{"targetType":"$UNKNOWN","target":"string","$objectType":"clustermgmt.v4.config.HttpProxyWhiteListConfig"}],"internalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"$objectType":"prism.v4.config.BaseNetwork"}],"externalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"networkExtId":"string","$objectType":"prism.v4.config.ExternalNetwork"}],"capability":"$UNKNOWN","$objectType":"prism.v4.config.DomainManagerNetwork"},"hostingClusterExtId":"string","shouldEnableHighAvailability":false,"nodeExtIds":["string"],"createdTime":"2015-07-20T15:49:04-07:00","$objectType":"prism.v4.config.DomainManager"},"$objectType":"prism.v4.management.RestoreSpec"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"domainManager":{"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"config":{"shouldEnableLockdownMode":true,"buildInfo":{"version":"string","$objectType":"clustermgmt.v4.config.BuildInfo"},"name":"pc_nutanix_01","size":"$UNKNOWN","bootstrapConfig":{"cloudInitConfig":[{"datasourceType":"$UNKNOWN","metadata":"string","cloudInitScript":{"value":"string","$objectType":"vmm.v4.ahv.config.Userdata"},"$objectType":"vmm.v4.ahv.config.CloudInit"}],"environmentInfo":{"type":"$UNKNOWN","providerType":"$UNKNOWN","provisioningType":"$UNKNOWN","$objectType":"prism.v4.config.EnvironmentInfo"},"$objectType":"prism.v4.config.BootstrapConfig"},"credentials":[{"username":"test-user","password":"string","$objectType":"common.v1.config.BasicAuth"}],"resourceConfig":{"numVcpus":0,"memorySizeBytes":0,"dataDiskSizeBytes":0,"containerExtIds":["string"],"$objectType":"prism.v4.config.DomainManagerResourceConfig"},"$objectType":"prism.v4.config.DomainManagerClusterConfig"},"isRegisteredWithHostingCluster":true,"network":{"externalAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"nameServers":[{"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"}],"ntpServers":[{"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"}],"fqdn":"string","httpProxyConfig":[{"ipAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"port":0,"username":"string","password":"string","name":"string","proxyTypes":["$UNKNOWN"],"$objectType":"clustermgmt.v4.config.HttpProxyConfig"}],"httpProxyWhiteListConfig":[{"targetType":"$UNKNOWN","target":"string","$objectType":"clustermgmt.v4.config.HttpProxyWhiteListConfig"}],"internalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"$objectType":"prism.v4.config.BaseNetwork"}],"externalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"networkExtId":"string","$objectType":"prism.v4.config.ExternalNetwork"}],"capability":"$UNKNOWN","$objectType":"prism.v4.config.DomainManagerNetwork"},"hostingClusterExtId":"string","shouldEnableHighAvailability":false,"nodeExtIds":["string"],"createdTime":"2015-07-20T15:49:04-07:00","$objectType":"prism.v4.config.DomainManager"},"$objectType":"prism.v4.management.RestoreSpec"} \ - "https://host:port/api/prism/v4.3/management/restore-sources/fFcDf31a-2c4D-99aF-ccCa-ab7Fe36AD6C7/restorable-domain-managers/3DFd8eAc-5cbe-6aCc-cAeC-Ed5ADb25cabd/restore-points/ECeca09E-E72d-Cd98-Ecd7-eDff2Ffd490d/$actions/restore" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Config;\nusing Nutanix.PriSDK.Model.Prism.V4.Management;\n\ \nnamespace CsharpSdkSample\n{\n class Program\n {\n static void Main(string[]\ \ args) {\n // Configure the client\n Configuration _config =\ \ new Configuration\n {\n // UserName to connect to the cluster\n\ \ Username = \"username\",\n // Password(SecureString) to\ \ connect to the cluster \n Password = Configuration.CreateSecurePassword(\"\ password\"),\n // IPv4/IPv6 address or FQDN of the cluster\n \ \ Host = \"localhost\",\n // Port used for the connection. \n\ \ Port = 9440,\n // Backoff period in seconds (exponential\ \ backoff: 2, 4, 8... seconds)\n BackOffPeriod = 2,\n // Max\ \ retry attempts while reconnecting on a loss of connection\n MaxRetryAttempts\ \ = 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n\ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n RestoreSpec restoreSpec = new RestoreSpec();\n\n // RestoreSpec\ \ object initializations here...\n restoreSpec.DomainManager = new\ \ DomainManager(); // required field\n\n String restoreSourceExtId\ \ = \"dACE38da-cEc2-A2ea-bdca-2CEA02cefCF9\";\n String restorableDomainManagerExtId\ \ = \"dcB84665-ACaB-fe59-Fb3F-deDDd7AdDfca\";\n String extId = \"CfFaae3B-8ACe-44Ff-aCF1-A94DAE9132b0\"\ ;\n\n // Create request object with parameters\n var request\ \ = new RestoreRequest {\n RestoreSourceExtId = restoreSourceExtId,\n\ \ RestorableDomainManagerExtId = restorableDomainManagerExtId,\n\ \ ExtId = extId,\n Body = restoreSpec\n };\n\ \ try {\n RestoreApiResponse restoreApiResponse = domainManagerBackupsApi.Restore(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/management/restore-sources: post: tags: - DomainManager summary: | Create restore source description: "Creates a restore source pointing to a cluster or object store\ \ to restore the domain manager. The created \nrestore source is intended\ \ to be deleted after use. If the restore source is\nnot deleted using the\ \ deleteRestoreSource API, then it is auto-deleted after sometime. Also note\ \ that a restore \nsource will not contain a backup policy. It is only used\ \ to access the backup data at the location from where \nthe Prism Central\ \ may be restored. Credentials used to access the restore source are not validated\ \ at the time \nof creation of the restore source. They are validated when\ \ the restore source is used to fetch data.\n" operationId: createRestoreSource requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.RestoreSource' required: true responses: "201": description: | Restore source response for cluster identified by the external identifier. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.management.RestoreSource' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/management/restore-sources Post operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/management/restore-sources Post operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/management/restore-sources Post operation x-permissions: operationName: Create Restore Source deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - name: Super Admin x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" x-code-samples: - lang: Java source: |2 package sample; import com.nutanix.pri.java.client.ApiClient; import com.nutanix.pri.java.client.api.DomainManagerBackupsApi; import com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.CreateRestoreSourceRequest; import com.nutanix.dp1.pri.prism.v4.management.RestoreSource; import com.nutanix.dp1.pri.prism.v4.management.CreateRestoreSourceApiResponse; import org.springframework.web.client.RestClientException; public class JavaSdkSample { public static void main(String[] args) { // Configure the client ApiClient apiClient = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClient.setHost("localhost"); // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClient.setPort(9440); // Interval in ms to use during retry attempts apiClient.setRetryInterval(5000); // Max retry attempts while reconnecting on a loss of connection apiClient.setMaxRetryAttempts(5); // UserName to connect to the cluster String username = "username"; // Password to connect to the cluster String password = "password"; apiClient.setUsername(username); apiClient.setPassword(password); // Please add authorization information here if needed. DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient); RestoreSource restoreSource = new RestoreSource(); // RestoreSource object initializations here... try { // Pass in parameters using the request builder object associated with the operation. CreateRestoreSourceApiResponse createRestoreSourceApiResponse = domainManagerBackupsApi.createRestoreSource(CreateRestoreSourceRequest.builder() .build(), restoreSource); System.out.println(createRestoreSourceApiResponse.toString()); } catch (RestClientException ex) { System.out.println(ex.getMessage()); } } } - lang: JavaScript source: |2 import { ApiClient, DomainManagerBackupsApi, RestoreSource } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance); function sample() { let restoreSource = new RestoreSource(); // RestoreSource object initializations here... restoreSource = JSON.stringify(restoreSource); domainManagerBackupsApi.createRestoreSource(restoreSource).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: |2+ import ntnx_prism_py_client if __name__ == "__main__": # Configure the client config = ntnx_prism_py_client.Configuration() # IPv4/IPv6 address or FQDN of the cluster config.host = "localhost" # Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. config.port = 9440 # Max retry attempts while reconnecting on a loss of connection config.max_retry_attempts = 3 # Backoff factor to use during retry attempts config.backoff_factor = 3 # UserName to connect to the cluster config.username = "username" # Password to connect to the cluster config.password = "password" # Please add authorization information here if needed. client = ntnx_prism_py_client.ApiClient(configuration=config) domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client) restoreSource = ntnx_prism_py_client.RestoreSource() # RestoreSource object initializations here... try: api_response = domain_manager_backups_api.create_restore_source(body=restoreSource) print(api_response) except ntnx_prism_py_client.rest.ApiException as e: print(e) - lang: Go source: |2+ package main import ( "fmt" "time" "context" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups" import1 "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management" ) var ( ApiClientInstance *client.ApiClient DomainManagerBackupsServiceApiInstance *api.DomainManagerBackupsServiceApi ) func main() { ApiClientInstance = client.NewApiClient() // IPv4/IPv6 address or FQDN of the cluster ApiClientInstance.Host = "localhost" // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. ApiClientInstance.Port = 9440 // Interval in ms to use during retry attempts ApiClientInstance.RetryInterval = 5 * time.Second // Max retry attempts while reconnecting on a loss of connection ApiClientInstance.MaxRetryAttempts = 5 // UserName to connect to the cluster ApiClientInstance.Username = "username" // Password to connect to the cluster ApiClientInstance.Password = "password" // Please add authorization information here if needed. DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance) ctx := context.Background() restoreSource := import1.NewRestoreSource() // RestoreSource object initializations here... request := domainmanagerbackups.CreateRestoreSourceRequest{ Body: restoreSource } response, error := DomainManagerBackupsServiceApiInstance.CreateRestoreSource(ctx, &request) if error != nil { fmt.Println(error) return } data, _ := response.GetData().(import1.RestoreSource) fmt.Println(data) } - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/management/restore-sources" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"location":{"config":{"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"},"$objectType":"prism.v4.management.ClusterLocation"},"$objectType":"prism.v4.management.RestoreSource"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"location":{"config":{"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"},"$objectType":"prism.v4.management.ClusterLocation"},"$objectType":"prism.v4.management.RestoreSource"} \ - "https://host:port/api/prism/v4.3/management/restore-sources" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n RestoreSource restoreSource = new RestoreSource();\n\n // RestoreSource\ \ object initializations here...\n\n\n // Create request object with\ \ parameters\n var request = new CreateRestoreSourceRequest {\n \ \ Body = restoreSource\n };\n try {\n \ \ CreateRestoreSourceApiResponse createRestoreSourceApiResponse = domainManagerBackupsApi.CreateRestoreSource(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/management/restore-sources/{extId}: get: tags: - DomainManager summary: | Fetch restore source description: | Retrieves the restore source from the PE cache store and returns the restore source configuration and external identifier to the user. operationId: getRestoreSourceById parameters: - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 0349dd00-72ee-446d-abd0-4d01a589beb1 responses: "200": description: | Returns the restore source configuration and external Identifier to the user. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.management.RestoreSource' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Get operation" x-permissions: operationName: View Restore Source deploymentList: - ON_PREM - CLOUD roleList: - name: Super Admin - name: Prism Admin - name: Prism Viewer - name: Domain Manager Admin - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: small count: 5 timeUnit: seconds - type: large count: 5 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerBackupsApi;\nimport\ \ com.nutanix.dp1.pri.prism.v4.request.DomainManagerBackups.GetRestoreSourceByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.GetRestoreSourceApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(apiClient);\n\ \n \n String extId = \"C8D6e3ab-afEa-ebCf-E9A3-ACC4F46DFefd\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetRestoreSourceApiResponse\ \ getRestoreSourceApiResponse = domainManagerBackupsApi.getRestoreSourceById(GetRestoreSourceByIdRequest.builder()\n\ \ .extId(extId)\n .build());\n\n \ \ System.out.println(getRestoreSourceApiResponse.toString());\n\n \ \ } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerBackupsApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerBackupsApi = new DomainManagerBackupsApi(apiClientInstance);\n\ \nfunction sample() {\n\n \n let extId = \"ffd21b8a-4DFE-C5Cd-DffF-EB60EA6EDFBE\"\ ;\n\n\n\n\n\n domainManagerBackupsApi.getRestoreSourceById(extId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_backups_api = ntnx_prism_py_client.DomainManagerBackupsApi(api_client=client)\n\ \ \n ext_id = \"E1fbf3Fa-c7Ad-992C-fFbd-F19DC2Fdceeb\"\n\n\n try:\n\ \ api_response = domain_manager_backups_api.get_restore_source_by_id(extId=ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanagerbackups\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerBackupsServiceApiInstance\ \ *api.DomainManagerBackupsServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerBackupsServiceApiInstance = api.NewDomainManagerBackupsServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n extId := \"ED9FaFa2-2f90-D10f-DF3C-fE3BedeAD8cF\"\ \n\n\n request := domainmanagerbackups.GetRestoreSourceByIdRequest{ ExtId:\ \ &extId }\n response, error := DomainManagerBackupsServiceApiInstance.GetRestoreSourceById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.RestoreSource)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/restore-sources/5DB1DFfB-AecE-7Fee-eD5B-a05CEaf4d1af" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/restore-sources/46afC0cd-8EA0-95Ad-bFb4-C4Ca0bDa2b8c" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerBackupsApi domainManagerBackupsApi = new DomainManagerBackupsApi(client);\n\ \n String extId = \"aF835Dc5-EFAc-d15a-Dac4-f34F7cA2f6Ac\";\n\n \ \ // Create request object with parameters\n var request = new\ \ GetRestoreSourceByIdRequest {\n ExtId = extId\n };\n\ \ try {\n GetRestoreSourceApiResponse getRestoreSourceApiResponse\ \ = domainManagerBackupsApi.GetRestoreSourceById(request);\n } catch\ \ (ApiException ex) {\n Console.WriteLine(ex.Message);\n \ \ }\n }\n }\n}\n" delete: tags: - DomainManager summary: | Delete restore source description: | Deletes a restore source on a cluster/object store. operationId: deleteRestoreSourceById parameters: - name: extId in: path description: | A globally unique identifier of an instance that is suitable for external consumption. 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: 6c5c45c1-67ca-466e-b2c4-e2273f0b008b - name: If-Match in: header description: | The If-Match request header makes the request conditional. When not provided the server will respond with an HTTP 428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP 412 (Precondition Failed) response required: true style: simple explode: false schema: type: string example: string responses: "204": description: | The delete restore source request is accepted. content: application/json: {} "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Delete operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Delete operation" x-permissions: operationName: Delete Restore Source deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - name: Super Admin x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PE version: "7.0" /prism/v4.3/config/domain-managers: get: tags: - DomainManager summary: List domain manager (Prism Central) configuration details description: Returns a list of elements representing the domain manager (Prism Central) instance. operationId: listDomainManagers parameters: - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: config example: "https://{host}:{port}/api/prism/v4.3/config/domain-managers?$select=config" - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/domain-managers?$select=extId" responses: "200": description: Returns a list of domain manager (Prism Central) entities. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: maxItems: 1 minItems: 1 type: array items: $ref: '#/components/schemas/prism.v4.3.config.DomainManager' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Get operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Get operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Get operation x-permissions: operationName: View Domain Manager roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin - name: Prism Viewer - name: Cluster Viewer - name: Domain Manager Viewer - name: NCM Connector x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: |2 package sample; import com.nutanix.pri.java.client.ApiClient; import com.nutanix.pri.java.client.api.DomainManagerApi; import com.nutanix.dp1.pri.prism.v4.request.DomainManager.ListDomainManagersRequest; import com.nutanix.dp1.pri.prism.v4.config.ListDomainManagerApiResponse; import org.springframework.web.client.RestClientException; public class JavaSdkSample { public static void main(String[] args) { // Configure the client ApiClient apiClient = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClient.setHost("localhost"); // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClient.setPort(9440); // Interval in ms to use during retry attempts apiClient.setRetryInterval(5000); // Max retry attempts while reconnecting on a loss of connection apiClient.setMaxRetryAttempts(5); // UserName to connect to the cluster String username = "username"; // Password to connect to the cluster String password = "password"; apiClient.setUsername(username); apiClient.setPassword(password); // Please add authorization information here if needed. DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient); try { // Pass in parameters using the request builder object associated with the operation. ListDomainManagerApiResponse listDomainManagerApiResponse = domainManagerApi.listDomainManagers(ListDomainManagersRequest.builder() .$select(null) .build()); System.out.println(listDomainManagerApiResponse.toString()); } catch (RestClientException ex) { System.out.println(ex.getMessage()); } } } - lang: JavaScript source: |2 import { ApiClient, DomainManagerApi } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let domainManagerApi = new DomainManagerApi(apiClientInstance); function sample() { // Construct Optional Parameters var opts = {}; opts["$select"] = "string_sample_data"; domainManagerApi.listDomainManagers(opts).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: |2+ import ntnx_prism_py_client if __name__ == "__main__": # Configure the client config = ntnx_prism_py_client.Configuration() # IPv4/IPv6 address or FQDN of the cluster config.host = "localhost" # Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. config.port = 9440 # Max retry attempts while reconnecting on a loss of connection config.max_retry_attempts = 3 # Backoff factor to use during retry attempts config.backoff_factor = 3 # UserName to connect to the cluster config.username = "username" # Password to connect to the cluster config.password = "password" # Please add authorization information here if needed. client = ntnx_prism_py_client.ApiClient(configuration=config) domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client) try: api_response = domain_manager_api.list_domain_managers() print(api_response) except ntnx_prism_py_client.rest.ApiException as e: print(e) - lang: Go source: |2+ package main import ( "fmt" "time" "context" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager" import1 "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config" ) var ( ApiClientInstance *client.ApiClient DomainManagerServiceApiInstance *api.DomainManagerServiceApi ) func main() { ApiClientInstance = client.NewApiClient() // IPv4/IPv6 address or FQDN of the cluster ApiClientInstance.Host = "localhost" // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. ApiClientInstance.Port = 9440 // Interval in ms to use during retry attempts ApiClientInstance.RetryInterval = 5 * time.Second // Max retry attempts while reconnecting on a loss of connection ApiClientInstance.MaxRetryAttempts = 5 // UserName to connect to the cluster ApiClientInstance.Username = "username" // Password to connect to the cluster ApiClientInstance.Password = "password" // Please add authorization information here if needed. DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance) ctx := context.Background() request := domainmanager.ListDomainManagersRequest{ Select_: nil } response, error := DomainManagerServiceApiInstance.ListDomainManagers(ctx, &request) if error != nil { fmt.Println(error) return } data, _ := response.GetData().([]import1.DomainManager) fmt.Println(data) } - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/domain-managers?$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/domain-managers?$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n{\n\ \ class Program\n {\n static void Main(string[] args) {\n // Configure\ \ the client\n Configuration _config = new Configuration\n {\n\ \ // UserName to connect to the cluster\n Username = \"username\"\ ,\n // Password(SecureString) to connect to the cluster \n \ \ Password = Configuration.CreateSecurePassword(\"password\"),\n \ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"localhost\"\ ,\n // Port used for the connection. \n Port = 9440,\n \ \ // Backoff period in seconds (exponential backoff: 2, 4, 8... seconds)\n\ \ BackOffPeriod = 2,\n // Max retry attempts while reconnecting\ \ on a loss of connection\n MaxRetryAttempts = 5\n };\n\n \ \ ApiClient client = new ApiClient(_config);\n\n DomainManagerApi\ \ domainManagerApi = new DomainManagerApi(client);\n\n String select\ \ = \"string_sample_data\";\n\n // Create request object with parameters\n\ \ var request = new ListDomainManagersRequest {\n Select\ \ = select\n };\n try {\n ListDomainManagerApiResponse\ \ listDomainManagerApiResponse = domainManagerApi.ListDomainManagers(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" post: tags: - DomainManager summary: Deploy a Prism Central description: "Deploys a Prism Central using the provided details. Prism Central\ \ Size, Network Config are mandatory fields to deploy Prism Central. The response\ \ from this endpoint contains the URL in the task object location header that\ \ can be used to track the request status." operationId: createDomainManager parameters: - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 1a6f8c09-a65d-4b91-af5c-648eb4a2b670 requestBody: description: Request body to deploy a Prism Central. content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.config.DomainManager' 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]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Post operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Post operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Post operation x-permissions: operationName: Create Domain Manager roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 1 timeUnit: seconds - type: small count: 1 timeUnit: seconds - type: large count: 1 timeUnit: seconds - type: xlarge count: 1 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" - product: PE version: "7.0" x-code-samples: - lang: Java source: |2 package sample; import com.nutanix.pri.java.client.ApiClient; import com.nutanix.pri.java.client.api.DomainManagerApi; import com.nutanix.dp1.pri.prism.v4.request.DomainManager.CreateDomainManagerRequest; import com.nutanix.dp1.pri.prism.v4.config.DomainManagerClusterConfig; import com.nutanix.dp1.pri.prism.v4.config.DomainManagerNetwork; import com.nutanix.dp1.pri.prism.v4.config.DomainManager; import com.nutanix.dp1.pri.prism.v4.config.CreateDomainManagerApiResponse; import org.springframework.web.client.RestClientException; public class JavaSdkSample { public static void main(String[] args) { // Configure the client ApiClient apiClient = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClient.setHost("localhost"); // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClient.setPort(9440); // Interval in ms to use during retry attempts apiClient.setRetryInterval(5000); // Max retry attempts while reconnecting on a loss of connection apiClient.setMaxRetryAttempts(5); // UserName to connect to the cluster String username = "username"; // Password to connect to the cluster String password = "password"; apiClient.setUsername(username); apiClient.setPassword(password); // Please add authorization information here if needed. DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient); DomainManager domainManager = new DomainManager(); // DomainManager object initializations here... domainManager.setConfig(new DomainManagerClusterConfig()); // required field domainManager.setNetwork(new DomainManagerNetwork()); // required field try { // Pass in parameters using the request builder object associated with the operation. CreateDomainManagerApiResponse createDomainManagerApiResponse = domainManagerApi.createDomainManager(CreateDomainManagerRequest.builder() .build(), domainManager); System.out.println(createDomainManagerApiResponse.toString()); } catch (RestClientException ex) { System.out.println(ex.getMessage()); } } } - lang: JavaScript source: |2 import { ApiClient, DomainManagerApi, DomainManagerClusterConfig, DomainManagerNetwork, DomainManager } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let domainManagerApi = new DomainManagerApi(apiClientInstance); function sample() { let domainManager = new DomainManager(); // DomainManager object initializations here... domainManager.setConfig(new DomainManagerClusterConfig()); // required field domainManager.setNetwork(new DomainManagerNetwork()); // required field domainManager = JSON.stringify(domainManager); domainManagerApi.createDomainManager(domainManager).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: |2+ import ntnx_prism_py_client if __name__ == "__main__": # Configure the client config = ntnx_prism_py_client.Configuration() # IPv4/IPv6 address or FQDN of the cluster config.host = "localhost" # Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. config.port = 9440 # Max retry attempts while reconnecting on a loss of connection config.max_retry_attempts = 3 # Backoff factor to use during retry attempts config.backoff_factor = 3 # UserName to connect to the cluster config.username = "username" # Password to connect to the cluster config.password = "password" # Please add authorization information here if needed. client = ntnx_prism_py_client.ApiClient(configuration=config) domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client) domainManager = ntnx_prism_py_client.DomainManager() # DomainManager object initializations here... domainManager.config = ntnx_prism_py_client.DomainManagerClusterConfig() # required field domainManager.network = ntnx_prism_py_client.DomainManagerNetwork() # required field try: api_response = domain_manager_api.create_domain_manager(body=domainManager) print(api_response) except ntnx_prism_py_client.rest.ApiException as e: print(e) - lang: Go source: |2+ package main import ( "fmt" "time" "context" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client" "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager" import1 "github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config" ) var ( ApiClientInstance *client.ApiClient DomainManagerServiceApiInstance *api.DomainManagerServiceApi ) func main() { ApiClientInstance = client.NewApiClient() // IPv4/IPv6 address or FQDN of the cluster ApiClientInstance.Host = "localhost" // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. ApiClientInstance.Port = 9440 // Interval in ms to use during retry attempts ApiClientInstance.RetryInterval = 5 * time.Second // Max retry attempts while reconnecting on a loss of connection ApiClientInstance.MaxRetryAttempts = 5 // UserName to connect to the cluster ApiClientInstance.Username = "username" // Password to connect to the cluster ApiClientInstance.Password = "password" // Please add authorization information here if needed. DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance) ctx := context.Background() domainManager := import1.NewDomainManager() // DomainManager object initializations here... request := domainmanager.CreateDomainManagerRequest{ Body: domainManager } response, error := DomainManagerServiceApiInstance.CreateDomainManager(ctx, &request) if error != nil { fmt.Println(error) return } data, _ := response.GetData().(import1.TaskReference) fmt.Println(data) } - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/config/domain-managers" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"config":{"shouldEnableLockdownMode":true,"buildInfo":{"version":"string","$objectType":"clustermgmt.v4.config.BuildInfo"},"name":"pc_nutanix_01","size":"$UNKNOWN","bootstrapConfig":{"cloudInitConfig":[{"datasourceType":"$UNKNOWN","metadata":"string","cloudInitScript":{"value":"string","$objectType":"vmm.v4.ahv.config.Userdata"},"$objectType":"vmm.v4.ahv.config.CloudInit"}],"environmentInfo":{"type":"$UNKNOWN","providerType":"$UNKNOWN","provisioningType":"$UNKNOWN","$objectType":"prism.v4.config.EnvironmentInfo"},"$objectType":"prism.v4.config.BootstrapConfig"},"credentials":[{"username":"test-user","password":"string","$objectType":"common.v1.config.BasicAuth"}],"resourceConfig":{"numVcpus":0,"memorySizeBytes":0,"dataDiskSizeBytes":0,"containerExtIds":["string"],"$objectType":"prism.v4.config.DomainManagerResourceConfig"},"$objectType":"prism.v4.config.DomainManagerClusterConfig"},"isRegisteredWithHostingCluster":true,"network":{"externalAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"nameServers":[{"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"}],"ntpServers":[{"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"}],"fqdn":"string","httpProxyConfig":[{"ipAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"port":0,"username":"string","password":"string","name":"string","proxyTypes":["$UNKNOWN"],"$objectType":"clustermgmt.v4.config.HttpProxyConfig"}],"httpProxyWhiteListConfig":[{"targetType":"$UNKNOWN","target":"string","$objectType":"clustermgmt.v4.config.HttpProxyWhiteListConfig"}],"internalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"$objectType":"prism.v4.config.BaseNetwork"}],"externalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"networkExtId":"string","$objectType":"prism.v4.config.ExternalNetwork"}],"capability":"$UNKNOWN","$objectType":"prism.v4.config.DomainManagerNetwork"},"hostingClusterExtId":"string","shouldEnableHighAvailability":false,"nodeExtIds":["string"],"createdTime":"2015-07-20T15:49:04-07:00","$objectType":"prism.v4.config.DomainManager"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"config":{"shouldEnableLockdownMode":true,"buildInfo":{"version":"string","$objectType":"clustermgmt.v4.config.BuildInfo"},"name":"pc_nutanix_01","size":"$UNKNOWN","bootstrapConfig":{"cloudInitConfig":[{"datasourceType":"$UNKNOWN","metadata":"string","cloudInitScript":{"value":"string","$objectType":"vmm.v4.ahv.config.Userdata"},"$objectType":"vmm.v4.ahv.config.CloudInit"}],"environmentInfo":{"type":"$UNKNOWN","providerType":"$UNKNOWN","provisioningType":"$UNKNOWN","$objectType":"prism.v4.config.EnvironmentInfo"},"$objectType":"prism.v4.config.BootstrapConfig"},"credentials":[{"username":"test-user","password":"string","$objectType":"common.v1.config.BasicAuth"}],"resourceConfig":{"numVcpus":0,"memorySizeBytes":0,"dataDiskSizeBytes":0,"containerExtIds":["string"],"$objectType":"prism.v4.config.DomainManagerResourceConfig"},"$objectType":"prism.v4.config.DomainManagerClusterConfig"},"isRegisteredWithHostingCluster":true,"network":{"externalAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"nameServers":[{"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"}],"ntpServers":[{"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"}],"fqdn":"string","httpProxyConfig":[{"ipAddress":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"port":0,"username":"string","password":"string","name":"string","proxyTypes":["$UNKNOWN"],"$objectType":"clustermgmt.v4.config.HttpProxyConfig"}],"httpProxyWhiteListConfig":[{"targetType":"$UNKNOWN","target":"string","$objectType":"clustermgmt.v4.config.HttpProxyWhiteListConfig"}],"internalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"$objectType":"prism.v4.config.BaseNetwork"}],"externalNetworks":[{"defaultGateway":{"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"},"subnetMask":{"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"},"ipRanges":[{"begin":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"end":{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"},"$objectType":"common.v1.config.IpRange"}],"ipAddresses":[{"ipv4":{"value":"string","prefixLength":32,"$objectType":"common.v1.config.IPv4Address"},"ipv6":{"value":"string","prefixLength":128,"$objectType":"common.v1.config.IPv6Address"},"$objectType":"common.v1.config.IPAddress"}],"networkExtId":"string","$objectType":"prism.v4.config.ExternalNetwork"}],"capability":"$UNKNOWN","$objectType":"prism.v4.config.DomainManagerNetwork"},"hostingClusterExtId":"string","shouldEnableHighAvailability":false,"nodeExtIds":["string"],"createdTime":"2015-07-20T15:49:04-07:00","$objectType":"prism.v4.config.DomainManager"} \ - "https://host:port/api/prism/v4.3/config/domain-managers" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n{\n\ \ class Program\n {\n static void Main(string[] args) {\n // Configure\ \ the client\n Configuration _config = new Configuration\n {\n\ \ // UserName to connect to the cluster\n Username = \"username\"\ ,\n // Password(SecureString) to connect to the cluster \n \ \ Password = Configuration.CreateSecurePassword(\"password\"),\n \ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"localhost\"\ ,\n // Port used for the connection. \n Port = 9440,\n \ \ // Backoff period in seconds (exponential backoff: 2, 4, 8... seconds)\n\ \ BackOffPeriod = 2,\n // Max retry attempts while reconnecting\ \ on a loss of connection\n MaxRetryAttempts = 5\n };\n\n \ \ ApiClient client = new ApiClient(_config);\n\n DomainManagerApi\ \ domainManagerApi = new DomainManagerApi(client);\n\n DomainManager\ \ domainManager = new DomainManager();\n\n // DomainManager object\ \ initializations here...\n domainManager.Config = new DomainManagerClusterConfig();\ \ // required field\n domainManager.Network = new DomainManagerNetwork();\ \ // required field\n\n\n // Create request object with parameters\n\ \ var request = new CreateDomainManagerRequest {\n Body\ \ = domainManager\n };\n try {\n CreateDomainManagerApiResponse\ \ createDomainManagerApiResponse = domainManagerApi.CreateDomainManager(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/config/domain-managers/{extId}: get: tags: - DomainManager summary: Get the requested domain manager (Prism Central) entity description: "Fetches the attributes associated with the domain manager (Prism\ \ Central) resource based on the provided external identifier. It includes\ \ attributes like config, network, node and other information such as size,\ \ environment and resource specifications." operationId: getDomainManagerById parameters: - name: extId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: 2f636d23-635a-4dc0-9cb9-55b27648e974 responses: "200": description: Returns the requested domain manager (Prism Central) entity. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.DomainManager' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/domain-managers/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/domain-managers/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/domain-managers/{extId}\ \ Get operation" x-permissions: operationName: View Domain Manager roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin - name: Prism Viewer - name: Cluster Viewer - name: Domain Manager Viewer - name: NCM Connector x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerApi;\nimport com.nutanix.dp1.pri.prism.v4.request.DomainManager.GetDomainManagerByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.config.GetDomainManagerApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient);\n\ \n \n String extId = \"B463dfA6-DA6d-cb3F-56cD-FEEADacEBEc5\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetDomainManagerApiResponse\ \ getDomainManagerApiResponse = domainManagerApi.getDomainManagerById(GetDomainManagerByIdRequest.builder()\n\ \ .extId(extId)\n .build());\n\n \ \ System.out.println(getDomainManagerApiResponse.toString());\n\n \ \ } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerApi = new DomainManagerApi(apiClientInstance);\n\nfunction\ \ sample() {\n\n \n let extId = \"b80A5Ca3-afda-C150-FCfd-da4405f77b9E\"\ ;\n\n\n\n\n\n domainManagerApi.getDomainManagerById(extId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client)\n\ \ \n ext_id = \"1E3FAeee-C7eE-Ecd6-a8d5-CfB37E9CAedb\"\n\n\n try:\n\ \ api_response = domain_manager_api.get_domain_manager_by_id(extId=ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerServiceApiInstance\ \ *api.DomainManagerServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n extId := \"ae6Ef1f1-04ce-A6a4-F7ED-bC0CbcF7F56e\"\ \n\n\n request := domainmanager.GetDomainManagerByIdRequest{ ExtId: &extId\ \ }\n response, error := DomainManagerServiceApiInstance.GetDomainManagerById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.DomainManager)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/domain-managers/0addF4cf-Ca83-eeef-0DbD-Ac6fCbeAC0F2" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/domain-managers/cCEeB5b5-dDBc-B9f7-CCBa-ba7cdBA3B1ca" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n{\n\ \ class Program\n {\n static void Main(string[] args) {\n // Configure\ \ the client\n Configuration _config = new Configuration\n {\n\ \ // UserName to connect to the cluster\n Username = \"username\"\ ,\n // Password(SecureString) to connect to the cluster \n \ \ Password = Configuration.CreateSecurePassword(\"password\"),\n \ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"localhost\"\ ,\n // Port used for the connection. \n Port = 9440,\n \ \ // Backoff period in seconds (exponential backoff: 2, 4, 8... seconds)\n\ \ BackOffPeriod = 2,\n // Max retry attempts while reconnecting\ \ on a loss of connection\n MaxRetryAttempts = 5\n };\n\n \ \ ApiClient client = new ApiClient(_config);\n\n DomainManagerApi\ \ domainManagerApi = new DomainManagerApi(client);\n\n String extId\ \ = \"5e1EbfE7-BB3f-B8EF-9fE1-fBe4ffc2A78A\";\n\n // Create request\ \ object with parameters\n var request = new GetDomainManagerByIdRequest\ \ {\n ExtId = extId\n };\n try {\n GetDomainManagerApiResponse\ \ getDomainManagerApiResponse = domainManagerApi.GetDomainManagerById(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/management/domain-managers/{domainManagerExtId}/products: get: tags: - DomainManager summary: List products description: Retrieves a list of all products along with their current enablement and resize status. operationId: listProducts parameters: - name: domainManagerExtId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: c2ca22cb-bad5-46f1-ba98-a3c2ddaf73f0 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: enablementState example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$filter=enablementState\ \ eq Prism.Management.EnablementState'DISABLED'" - name: extId example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$filter=extId\ \ eq '09534c07-4acc-4028-b749-e503f8a9ce6c'" - name: name example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$filter=name\ \ eq Prism.Management.ProductName'FLOW_VIRTUAL_NETWORKING'" - name: resourceSpec/cpuCount example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$filter=resourceSpec/cpuCount\ \ eq 96" - name: resourceSpec/memorySizeBytes example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$filter=resourceSpec/memorySizeBytes\ \ eq 79" - 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 descending order." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: lastModifiedTime example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$orderby=lastModifiedTime" - name: name example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$orderby=name" - name: resizeTime example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$orderby=resizeTime" - name: resourceSpec/cpuCount example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$orderby=resourceSpec/cpuCount" - name: resourceSpec/memorySizeBytes example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$orderby=resourceSpec/memorySizeBytes" - name: serviceEnablementTime example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$orderby=serviceEnablementTime" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: enablementState example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=enablementState" - name: extId example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=extId" - name: lastModifiedTime example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=lastModifiedTime" - name: links example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=links" - name: metadata example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=metadata" - name: name example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=name" - name: resizeTime example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=resizeTime" - name: resourceSpec/cpuCount example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=resourceSpec/cpuCount" - name: resourceSpec/memorySizeBytes example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=resourceSpec/memorySizeBytes" - name: serviceEnablementTime example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=serviceEnablementTime" - name: tenantId example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=tenantId" - name: version example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/products?$select=version" responses: "200": description: Returns a list of products. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.management.Product' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products\ \ Get operation" x-permissions: operationName: View Domain Manager Product deploymentList: - ON_PREM roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin - name: Prism Viewer - name: Cluster Viewer - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 1 timeUnit: seconds - type: small count: 2 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerApi;\nimport com.nutanix.dp1.pri.prism.v4.request.DomainManager.ListProductsRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ListProductsApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient);\n\ \n \n String domainManagerExtId = \"16beDCEB-BF98-f69e-9EED-FBb9CFC9D59a\"\ ;\n \n int page = 0;\n \n int limit = 50;\n\n\ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n ListProductsApiResponse\ \ listProductsApiResponse = domainManagerApi.listProducts(ListProductsRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .$page(page)\n .$limit(limit)\n .$filter(null)\n\ \ .$orderby(null)\n .$select(null)\n \ \ .build());\n\n System.out.println(listProductsApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerApi = new DomainManagerApi(apiClientInstance);\n\nfunction\ \ sample() {\n\n \n let domainManagerExtId = \"Fc808dd7-eeaA-0CB0-f2DF-bB5d6f9fD1dF\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $page\"] = 0;\n opts[\"$limit\"] = 50;\n opts[\"$filter\"] = \"string_sample_data\"\ ;\n opts[\"$orderby\"] = \"string_sample_data\";\n opts[\"$select\"\ ] = \"string_sample_data\";\n\n\n\n\n domainManagerApi.listProducts(domainManagerExtId,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"baeFfaB7-7cda-F561-cFc8-BD1E9BaCFDCE\"\ \n \n page = 0\n \n limit = 50\n\n\n try:\n api_response\ \ = domain_manager_api.list_products(domainManagerExtId=domain_manager_ext_id,\ \ _page=page, _limit=limit)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerServiceApiInstance\ \ *api.DomainManagerServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"Cbc8f8DD-3ac6-EbFE-9fD7-fafB2FCedFEa\"\ \n \n page_ := 0\n \n limit_ := 50\n\n\n request := domainmanager.ListProductsRequest{\ \ DomainManagerExtId: &domainManagerExtId, Page_: &page_, Limit_: &limit_,\ \ Filter_: nil, Orderby_: nil, Select_: nil }\n response, error := DomainManagerServiceApiInstance.ListProducts(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.Product)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/domain-managers/f3cA7A42-cBbf-A8d2-E2df-f59e6Ba09AFE/products?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/3D0bfdDe-abBC-8E35-d94f-67018a0F2CbC/products?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(client);\n\ \n String domainManagerExtId = \"e383A849-cafD-6c35-E023-0cAbdcD2Ff64\"\ ;\n int page = 0;\n int limit = 50;\n String filter = \"\ string_sample_data\";\n String orderby = \"string_sample_data\";\n\ \ String select = \"string_sample_data\";\n\n // Create request\ \ object with parameters\n var request = new ListProductsRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n Page\ \ = page,\n Limit = limit,\n Filter = filter,\n \ \ Orderby = orderby,\n Select = select\n };\n\ \ try {\n ListProductsApiResponse listProductsApiResponse\ \ = domainManagerApi.ListProducts(request);\n } catch (ApiException\ \ ex) {\n Console.WriteLine(ex.Message);\n }\n }\n\ \ }\n}\n" /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}: get: tags: - DomainManager summary: Get product details description: Retrieves the product details along with it's current enablement and resize status. operationId: getProductById parameters: - name: domainManagerExtId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: 5453e4ee-f6e5-4bb7-8a13-fb720b64e39d - name: extId in: path description: The product ID for a given product. It can be retrieved using the list 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: c0a25c1c-5ab2-46e1-9318-f7330dd9b35b responses: "200": description: Returns the requested product details. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.management.Product' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Get operation" x-permissions: operationName: View Domain Manager Product deploymentList: - ON_PREM roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin - name: Prism Viewer - name: Cluster Viewer - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 1 timeUnit: seconds - type: small count: 2 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerApi;\nimport com.nutanix.dp1.pri.prism.v4.request.DomainManager.GetProductByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.GetProductApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient);\n\ \n \n String domainManagerExtId = \"7C1Ac8A6-0f9c-DAD9-ccE1-A39ea6194FA8\"\ ;\n \n String extId = \"4FEcBA26-c0BD-FDfe-AF17-BE6fCeFEcbE0\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetProductApiResponse\ \ getProductApiResponse = domainManagerApi.getProductById(GetProductByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build());\n\n System.out.println(getProductApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerApi = new DomainManagerApi(apiClientInstance);\n\nfunction\ \ sample() {\n\n \n let domainManagerExtId = \"2cB9EceD-eCA5-7Dd1-834E-aEACAF5b0e0c\"\ ;\n \n let extId = \"30EBE7c5-dbcC-96A4-a7fe-e07d11abf70F\";\n\n\n\ \n\n\n domainManagerApi.getProductById(domainManagerExtId, extId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"EAdFDcCf-cc4f-DfB5-92d7-2f6e3D8fF1Af\"\ \n \n ext_id = \"f073Eda1-4ABf-fb1B-bBB2-dBbfDbfDB72b\"\n\n\n try:\n\ \ api_response = domain_manager_api.get_product_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerServiceApiInstance\ \ *api.DomainManagerServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"d03ebefD-34FD-d3BF-500F-b8bAdACCbcfE\"\ \n \n extId := \"ddAaaaDE-F1AC-894D-a59e-D6aDeCDf45aF\"\n\n\n request\ \ := domainmanager.GetProductByIdRequest{ DomainManagerExtId: &domainManagerExtId,\ \ ExtId: &extId }\n response, error := DomainManagerServiceApiInstance.GetProductById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.Product)\n \ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/domain-managers/5dBFeBDc-Fef9-DE6F-B742-2DF66F9C6ec1/products/cb0faA3A-fccb-aB2C-BaAb-1aFDdAE4A1cc" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/eDfac27A-ba5E-BC91-a6c0-289Febbcb8aD/products/eAFaeEc7-cDF3-5eae-AAB8-e85b5FDd61eb" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(client);\n\ \n String domainManagerExtId = \"aDdFDC11-D5Af-6B6D-3deE-bfA225ADBC7A\"\ ;\n String extId = \"bc6bbC27-Eb5F-aFe2-efBc-a9a0Ddb1ACCc\";\n\n \ \ // Create request object with parameters\n var request = new\ \ GetProductByIdRequest {\n DomainManagerExtId = domainManagerExtId,\n\ \ ExtId = extId\n };\n try {\n GetProductApiResponse\ \ getProductApiResponse = domainManagerApi.GetProductById(request);\n \ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" put: tags: - DomainManager summary: Update the status of a product description: Updates the status of a given product with the current support focused on updating the enablement state. operationId: updateProductById parameters: - name: domainManagerExtId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: d3b55e64-a357-4bbc-9a6b-80198f537fd3 - name: extId in: path description: The product ID for a given product. It can be retrieved using the list 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: 5e3757ee-891c-4aa7-a882-a626b4367c55 - name: If-Match in: header description: "The If-Match request header makes the request conditional. When\ \ not provided, the server will respond with an HTTP-428 (Precondition\ \ Required) response code indicating that the server requires the request\ \ to be conditional. The server will allow the successful completion of\ \ PUT and PATCH operations, if the resource matches the ETag value returned\ \ to the response of a GET operation. If the conditional does not match,\ \ then an HTTP-412 (Precondition Failed) response will be returned." required: true style: simple explode: false schema: type: string example: string - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 612ed55f-e4e9-4036-a26e-8811e995bd80 - name: $dryrun in: query description: | A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. required: false style: form explode: false schema: type: boolean description: | A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. example: false requestBody: content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.Product' required: true responses: "202": description: The request to update the product is accepted. headers: Location: style: simple explode: false schema: pattern: "^((http[s]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Put operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Put operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Put operation" x-permissions: operationName: Update Domain Manager Product deploymentList: - ON_PREM roleList: - name: Prism Admin - name: Internal Super Admin - name: Super Admin - name: Cluster Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 1 timeUnit: seconds - type: small count: 1 timeUnit: seconds - type: large count: 1 timeUnit: seconds - type: xlarge count: 1 timeUnit: seconds x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerApi;\nimport com.nutanix.dp1.pri.prism.v4.request.DomainManager.UpdateProductByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.request.DomainManager.GetProductByIdRequest;\n\ import java.util.HashMap;\nimport org.apache.http.HttpHeaders;\nimport com.nutanix.dp1.pri.prism.v4.management.EnablementState;\n\ import com.nutanix.dp1.pri.prism.v4.management.Product;\nimport com.nutanix.dp1.pri.prism.v4.management.GetProductApiResponse;\n\ import com.nutanix.dp1.pri.prism.v4.management.UpdateProductApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient);\n\ \n Product product = new Product();\n\n // Product object\ \ initializations here...\n product.setEnablementState(EnablementState.UNKNOWN);\ \ // required field\n \n String domainManagerExtId = \"f1Aa9507-67Aa-AAE9-8Cc5-13cbCbcf0DDc\"\ ;\n \n String extId = \"F4A6aFfb-aDf6-dD5e-DD22-5dAAc7debBBa\"\ ;\n \n boolean dryrun = true;\n\n // perform GET call\n\ \ GetProductApiResponse getResponse = null;\n try {\n \ \ getResponse = domainManagerApi.getProductById(GetProductByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build());\n } catch(RestClientException\ \ ex) {\n System.out.println(ex.getMessage());\n }\n \ \ // Extract E-Tag Header\n String eTag = ApiClient.getEtag(getResponse);\n\ \ // initialize/change parameters for update\n HashMap opts = new HashMap<>();\n opts.put(HttpHeaders.IF_MATCH,\ \ eTag);\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n UpdateProductApiResponse\ \ updateProductApiResponse = domainManagerApi.updateProductById(UpdateProductByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .$dryrun(dryrun)\n .build(),\ \ product, opts);\n\n System.out.println(updateProductApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerApi, EnablementState, Product,\ \ GetProductApiResponse } from \"@nutanix-api/prism-js-client\";\n\n// Configure\ \ the client\nlet apiClientInstance = new ApiClient();\n// IPv4/IPv6 address\ \ or FQDN of the cluster\napiClientInstance.host = 'localhost';\n// Port\ \ used for the connection. PC products typically use port 9440, while NC\ \ products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerApi = new DomainManagerApi(apiClientInstance);\n\nfunction\ \ sample() {\n let product = new Product();\n\n // Product object\ \ initializations here...\n product.setEnablementState(EnablementState.UNKNOWN);\ \ // required field\n product = JSON.stringify(product);\n\n \n \ \ let domainManagerExtId = \"95f0Cc56-bAAa-59be-C2FC-C96Adb14ee9c\";\n\ \ \n let extId = \"dB0Fd79E-ecce-eE1E-fafE-a4cc4bb4cd9f\";\n\n \ \ // Construct Optional Parameters\n var opts = {};\n opts[\"$dryrun\"\ ] = true;\n\n // Perform Get call\n domainManagerApi.getProductById(domainManagerExtId,\ \ extId).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n // Extract E-Tag\ \ Header\n let etagValue = ApiClient.getEtag(data);\n let\ \ args = {\"If-Match\" : etagValue};\n\n domainManagerApi.updateProductById(domainManagerExtId,\ \ extId, product, opts, args).then(({data, response}) => {\n \ \ console.log(`API returned the following status code: ${response.status}`);\n\ \ console.log(data.getData());\n }).catch((error) => {\n\ \ console.log(`Error is: ${error}`);\n });\n });\n\n\ }\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client)\n\ \ product = ntnx_prism_py_client.Product()\n\n # Product object initializations\ \ here...\n product.enablement_state = ntnx_prism_py_client.EnablementState._UNKNOWN\ \ # required field\n \n domain_manager_ext_id = \"AD3F3Ac8-9d0F-3FE5-B0f2-ed819EACCABB\"\ \n \n ext_id = \"A2B9a3ee-d64c-ffEA-1AAd-Bbe68FAB3ADA\"\n \n \ \ dryrun = True\n\n try:\n api_response = domain_manager_api.get_product_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id)\n except ntnx_prism_py_client.rest.ApiException as e:\n\ \ print(e)\n # Extract E-Tag Header\n etag_value = ntnx_prism_py_client.ApiClient.get_etag(api_response)\n\ \n try:\n api_response = domain_manager_api.update_product_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id, body=product, _dryrun=dryrun, if_match=etag_value)\n \ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerServiceApiInstance\ \ *api.DomainManagerServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n product := import1.NewProduct()\n\ \n // Product object initializations here...\n\n \n domainManagerExtId\ \ := \"06Ec42B9-FDef-3AdD-Db7e-254248BC5dB0\"\n \n extId := \"bADffDb8-dBFc-e6B0-beF4-0a203bDbbDCF\"\ \n \n dryrun_ := true\n\n getRequest := domainmanager.GetProductByIdRequest{\ \ domainManagerExtId: &domainManagerExtId, extId: &extId }\n getResponse,\ \ err := DomainManagerServiceApiInstance.GetProductById(ctx, &getRequest)\n\ \ if err != nil {\n fmt.Println(err)\n return\n }\n\n\ \ // Extract E-Tag Header\n etagValue := ApiClientInstance.GetEtag(getResponse)\n\ \n args := make(map[string] interface{})\n args[\"If-Match\"] = etagValue\n\ \n request := domainmanager.UpdateProductByIdRequest{ DomainManagerExtId:\ \ &domainManagerExtId, ExtId: &extId, Body: product, Dryrun_: &dryrun_ }\n\ \ response, error := DomainManagerServiceApiInstance.UpdateProductById(ctx,\ \ &request, args)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import2.TaskReference)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request PUT \ --url "https://host:port/api/prism/v4.3/management/domain-managers/A8fbAaC9-dc9d-CF43-6fBF-5F5A7bCeDc27/products/f7Bcb3D8-1Ba2-c1d6-C11f-aaBDDa51d04c?$dryrun=true" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'If-Match: string_sample_data' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"name":"$UNKNOWN","version":"string","enablementState":"$UNKNOWN","serviceEnablementTime":"2015-07-20T15:49:04-07:00","resizeTime":"2015-07-20T15:49:04-07:00","lastModifiedTime":"2015-07-20T15:49:04-07:00","resourceSpec":{"cpuCount":0,"memorySizeBytes":0,"$objectType":"prism.v4.management.ResourceSpec"},"metadata":{"attributes":[{"name":"string","value":"string","$objectType":"common.v1.config.KVPair"}],"$objectType":"prism.v4.management.GenericMetadata"},"$objectType":"prism.v4.management.Product"} \ - lang: Wget source: |2 wget --verbose \ --method PUT \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'If-Match: string_sample_data' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"tenantId":"string","extId":"string","links":[{"href":"string","rel":"string","$objectType":"common.v1.response.ApiLink"}],"name":"$UNKNOWN","version":"string","enablementState":"$UNKNOWN","serviceEnablementTime":"2015-07-20T15:49:04-07:00","resizeTime":"2015-07-20T15:49:04-07:00","lastModifiedTime":"2015-07-20T15:49:04-07:00","resourceSpec":{"cpuCount":0,"memorySizeBytes":0,"$objectType":"prism.v4.management.ResourceSpec"},"metadata":{"attributes":[{"name":"string","value":"string","$objectType":"common.v1.config.KVPair"}],"$objectType":"prism.v4.management.GenericMetadata"},"$objectType":"prism.v4.management.Product"} \ - "https://host:port/api/prism/v4.3/management/domain-managers/edbdFBEe-B4F3-FEaD-1BCd-F30F56aeE1bf/products/5Bd99bcd-5F29-aEbC-AFbB-DaD0F4bDcFa9?$dryrun=true" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(client);\n\ \n Product product = new Product();\n\n // Product object initializations\ \ here...\n product.EnablementState = EnablementState.UNKNOWN; //\ \ required field\n\n String domainManagerExtId = \"1DEcD3a7-Feee-9ab5-D0D4-a8CEC407f0b6\"\ ;\n String extId = \"Ae2AE2fb-EdaC-eeE2-EC0d-9Ce4Bdeb89E7\";\n \ \ boolean dryrun = true;\n\n // perform GET call\n var getRequest\ \ = new GetProductByIdRequest {\n DomainManagerExtId = domainManagerExtId,\n\ \ ExtId = extId,\n };\n var getRequest = new GetProductByIdRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n ExtId\ \ = extId\n };\n try {\n GetProductApiResponse\ \ getResponse = domainManagerApi.GetProductById(getRequestgetRequest);\n\ \ } catch(ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n // Extract E-Tag Header\n string eTag = ApiClient.GetEtag(getResponse);\n\ \ // initialize/change parameters for update\n Dictionary opts = new Dictionary();\n opts[\"If-Match\"\ ] = eTag;\n // Create request object with parameters\n var\ \ request = new UpdateProductByIdRequest {\n DomainManagerExtId\ \ = domainManagerExtId,\n ExtId = extId,\n Body =\ \ product,\n Dryrun = dryrun,\n \n \n \ \ };\n try {\n UpdateProductApiResponse updateProductApiResponse\ \ = domainManagerApi.UpdateProductById(request, opts);\n } catch\ \ (ApiException ex) {\n Console.WriteLine(ex.Message);\n \ \ }\n }\n }\n}\n" /prism/v4.3/management/domain-managers/{extId}/$actions/register: post: tags: - DomainManager summary: Register a domain manager (Prism Central) to a cluster description: "Registers a domain manager (Prism Central) instance to other entities\ \ like PE and PC. This process is asynchronous, creating a registration task\ \ and returning its UUID." operationId: register parameters: - name: extId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: 101c96d8-b34c-4403-a10e-178fbceaec67 - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 50dd34f2-1248-47f3-b9fe-2e1aff25cffc - name: $dryrun in: query description: | A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. required: false style: form explode: false schema: type: boolean description: | A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. example: false requestBody: description: The registration request consists of the remote cluster details. Credentials must be of domain manager (Prism Central) role. content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.ClusterRegistrationSpec' 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]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/register\ \ Post operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/register\ \ Post operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/register\ \ Post operation" x-permissions: operationName: Register Domain Manager roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 1 timeUnit: seconds - type: small count: 2 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerApi;\nimport com.nutanix.dp1.pri.prism.v4.request.DomainManager.RegisterRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ClusterRegistrationSpec;\n\ import com.nutanix.dp1.pri.prism.v4.management.RegisterApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient);\n\ \n ClusterRegistrationSpec clusterRegistrationSpec = new ClusterRegistrationSpec();\n\ \n // ClusterRegistrationSpec object initializations here...\n \ \ clusterRegistrationSpec.setRemoteCluster(SOME_RAW_DATA); // required\ \ field\n \n String extId = \"B9eDfCe2-cbe7-D91F-a6fa-E4eC5BAeaF8C\"\ ;\n \n boolean dryrun = true;\n\n try {\n \ \ // Pass in parameters using the request builder object associated with\ \ the operation.\n RegisterApiResponse registerApiResponse =\ \ domainManagerApi.register(RegisterRequest.builder()\n .extId(extId)\n\ \ .$dryrun(dryrun)\n .build(), clusterRegistrationSpec);\n\ \n System.out.println(registerApiResponse.toString());\n\n \ \ } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerApi, ClusterRegistrationSpec }\ \ from \"@nutanix-api/prism-js-client\";\n\n// Configure the client\nlet\ \ apiClientInstance = new ApiClient();\n// IPv4/IPv6 address or FQDN of\ \ the cluster\napiClientInstance.host = 'localhost';\n// Port used for the\ \ connection. PC products typically use port 9440, while NC products typically\ \ use port 443. See the product-specific documentation for accurate configuration.\n\ apiClientInstance.port = '9440';\n// Max retry attempts while reconnecting\ \ on a loss of connection\napiClientInstance.maxRetryAttempts = 5;\n// Interval\ \ in ms to use during retry attempts\napiClientInstance.retryInterval =\ \ 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerApi = new DomainManagerApi(apiClientInstance);\n\nfunction\ \ sample() {\n let clusterRegistrationSpec = new ClusterRegistrationSpec();\n\ \n // ClusterRegistrationSpec object initializations here...\n clusterRegistrationSpec.setRemoteCluster(SOME_RAW_DATA);\ \ // required field\n clusterRegistrationSpec = JSON.stringify(clusterRegistrationSpec);\n\ \n \n let extId = \"Cd2FECee-f7c7-d9fC-17Ae-Cd2A6b24D6CF\";\n\n \ \ // Construct Optional Parameters\n var opts = {};\n opts[\"$dryrun\"\ ] = true;\n\n\n\n\n domainManagerApi.register(extId, clusterRegistrationSpec,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client)\n\ \ clusterRegistrationSpec = ntnx_prism_py_client.ClusterRegistrationSpec()\n\ \n # ClusterRegistrationSpec object initializations here...\n clusterRegistrationSpec.remote_cluster\ \ = SOME_RAW_DATA # required field\n \n ext_id = \"Cbc43d48-AAdc-FCdc-A9A5-df9bcDcAfabA\"\ \n \n dryrun = True\n\n\n try:\n api_response = domain_manager_api.register(extId=ext_id,\ \ body=clusterRegistrationSpec, _dryrun=dryrun)\n print(api_response)\n\ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerServiceApiInstance\ \ *api.DomainManagerServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n clusterRegistrationSpec := import1.NewClusterRegistrationSpec()\n\ \n // ClusterRegistrationSpec object initializations here...\n\n \n\ \ extId := \"4D193040-Cbed-a5B7-9bc7-Ac0d4Bc25F3A\"\n \n dryrun_\ \ := true\n\n\n request := domainmanager.RegisterRequest{ ExtId: &extId,\ \ Body: clusterRegistrationSpec, Dryrun_: &dryrun_ }\n response, error\ \ := DomainManagerServiceApiInstance.Register(ctx, &request)\n if error\ \ != nil {\n fmt.Println(error)\n return\n }\n data,\ \ _ := response.GetData().(import2.TaskReference)\n fmt.Println(data)\n\ \n}\n\n" - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/management/domain-managers/C6d3fAE0-dfcc-5BaF-AfA7-dA49654E0a87/$actions/register?$dryrun=true" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"remoteCluster":{"remoteCluster":{"address":{"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"},"credentials":{"authentication":{"username":"test-user","password":"string","$objectType":"common.v1.config.BasicAuth"},"$objectType":"prism.v4.management.Credentials"},"$objectType":"prism.v4.management.RemoteClusterSpec"},"cloudType":"$UNKNOWN","$objectType":"prism.v4.management.DomainManagerRemoteClusterSpec"},"$objectType":"prism.v4.management.ClusterRegistrationSpec"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"remoteCluster":{"remoteCluster":{"address":{"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"},"credentials":{"authentication":{"username":"test-user","password":"string","$objectType":"common.v1.config.BasicAuth"},"$objectType":"prism.v4.management.Credentials"},"$objectType":"prism.v4.management.RemoteClusterSpec"},"cloudType":"$UNKNOWN","$objectType":"prism.v4.management.DomainManagerRemoteClusterSpec"},"$objectType":"prism.v4.management.ClusterRegistrationSpec"} \ - "https://host:port/api/prism/v4.3/management/domain-managers/5Bd7d3eB-9EF1-Fcba-ecFe-ccAaAAccFaeC/$actions/register?$dryrun=true" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(client);\n\ \n ClusterRegistrationSpec clusterRegistrationSpec = new ClusterRegistrationSpec();\n\ \n // ClusterRegistrationSpec object initializations here...\n \ \ clusterRegistrationSpec.RemoteCluster = SOME_RAW_DATA; // required field\n\ \n String extId = \"956bd9Ea-CdEF-bCB0-A34C-baeaEFF6Ea3D\";\n \ \ boolean dryrun = true;\n\n // Create request object with parameters\n\ \ var request = new RegisterRequest {\n ExtId = extId,\n\ \ Body = clusterRegistrationSpec,\n Dryrun = dryrun\n\ \ };\n try {\n RegisterApiResponse registerApiResponse\ \ = domainManagerApi.Register(request);\n } catch (ApiException ex)\ \ {\n Console.WriteLine(ex.Message);\n }\n }\n }\n\ }\n" /prism/v4.3/management/domain-managers/{extId}/$actions/unregister: post: tags: - DomainManager summary: Unregister a registered remote cluster from the local cluster description: "Unregister a registered remote cluster from the local cluster.\ \ This process is asynchronous, creating an unregisteration task and returning\ \ its UUID." operationId: unregister parameters: - name: extId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: f95af212-36e9-4d68-b54c-f6833d0e55dd - name: NTNX-Request-Id in: header description: | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. required: true style: simple explode: false schema: type: string format: uuid example: 22014cea-08b4-4940-8b2d-11b557ae9930 - name: $dryrun in: query description: | A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. required: false style: form explode: false schema: type: boolean description: | A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. example: true requestBody: description: Payload for unregistering a cluster content: application/json: schema: $ref: '#/components/schemas/prism.v4.3.management.ClusterUnregistrationSpec' 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]?|nfs):\\/)?\\/?(([a-zA-Z0-9\\-\\.]+)|(\\d{1,3}(\\\ .\\d{1,3}){3})|(\\[[0-9a-fA-F:]+\\]))(:\\d+)?(\\/[^\\s?#]*)?(\\\ ?[^#\\s]*)?(#[^\\s]*)?$" type: string description: Indicates the target of a redirection or the URL of a newly created resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/unregister\ \ Post operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/unregister\ \ Post operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/unregister\ \ Post operation" x-permissions: operationName: Unregister Domain Manager roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin x-rate-limit: - type: xsmall count: 1 timeUnit: seconds - type: small count: 2 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 5 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.DomainManagerApi;\nimport com.nutanix.dp1.pri.prism.v4.request.DomainManager.UnregisterRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ClusterUnregistrationSpec;\n\ import com.nutanix.dp1.pri.prism.v4.management.UnregisterApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(apiClient);\n\ \n ClusterUnregistrationSpec clusterUnregistrationSpec = new ClusterUnregistrationSpec();\n\ \n // ClusterUnregistrationSpec object initializations here...\n\ \ \n String extId = \"FBAcBbdd-35CC-05ee-cd1B-84DCFbAcDBEa\"\ ;\n \n boolean dryrun = true;\n\n try {\n \ \ // Pass in parameters using the request builder object associated with\ \ the operation.\n UnregisterApiResponse unregisterApiResponse\ \ = domainManagerApi.unregister(UnregisterRequest.builder()\n \ \ .extId(extId)\n .$dryrun(dryrun)\n \ \ .build(), clusterUnregistrationSpec);\n\n System.out.println(unregisterApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, DomainManagerApi, ClusterUnregistrationSpec\ \ } from \"@nutanix-api/prism-js-client\";\n\n// Configure the client\n\ let apiClientInstance = new ApiClient();\n// IPv4/IPv6 address or FQDN of\ \ the cluster\napiClientInstance.host = 'localhost';\n// Port used for the\ \ connection. PC products typically use port 9440, while NC products typically\ \ use port 443. See the product-specific documentation for accurate configuration.\n\ apiClientInstance.port = '9440';\n// Max retry attempts while reconnecting\ \ on a loss of connection\napiClientInstance.maxRetryAttempts = 5;\n// Interval\ \ in ms to use during retry attempts\napiClientInstance.retryInterval =\ \ 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let domainManagerApi = new DomainManagerApi(apiClientInstance);\n\nfunction\ \ sample() {\n let clusterUnregistrationSpec = new ClusterUnregistrationSpec();\n\ \n // ClusterUnregistrationSpec object initializations here...\n clusterUnregistrationSpec\ \ = JSON.stringify(clusterUnregistrationSpec);\n\n \n let extId =\ \ \"5947a1fa-cfc1-C00E-ac5F-eCB4A13CeBf2\";\n\n // Construct Optional\ \ Parameters\n var opts = {};\n opts[\"$dryrun\"] = true;\n\n\n\n\n\ \ domainManagerApi.unregister(extId, clusterUnregistrationSpec, opts).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ domain_manager_api = ntnx_prism_py_client.DomainManagerApi(api_client=client)\n\ \ clusterUnregistrationSpec = ntnx_prism_py_client.ClusterUnregistrationSpec()\n\ \n # ClusterUnregistrationSpec object initializations here...\n \n\ \ ext_id = \"34bFeaed-CDA2-dbE5-0DA7-ace0abFf822B\"\n \n dryrun\ \ = True\n\n\n try:\n api_response = domain_manager_api.unregister(extId=ext_id,\ \ body=clusterUnregistrationSpec, _dryrun=dryrun)\n print(api_response)\n\ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/domainmanager\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n import2 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n DomainManagerServiceApiInstance\ \ *api.DomainManagerServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ DomainManagerServiceApiInstance = api.NewDomainManagerServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n clusterUnregistrationSpec := import1.NewClusterUnregistrationSpec()\n\ \n // ClusterUnregistrationSpec object initializations here...\n\n \ \ \n extId := \"C8d279cd-4EFa-D6aa-dBEb-C66CADE4A9CC\"\n \n dryrun_\ \ := true\n\n\n request := domainmanager.UnregisterRequest{ ExtId: &extId,\ \ Body: clusterUnregistrationSpec, Dryrun_: &dryrun_ }\n response, error\ \ := DomainManagerServiceApiInstance.Unregister(ctx, &request)\n if error\ \ != nil {\n fmt.Println(error)\n return\n }\n data,\ \ _ := response.GetData().(import2.TaskReference)\n fmt.Println(data)\n\ \n}\n\n" - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/management/domain-managers/8aFffA5f-BBBc-4b03-cBbE-DaFC32acCE5B/$actions/unregister?$dryrun=true" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --data {"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"} \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'NTNX-Request-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ --body-data {"extId":"string","name":"string","$objectType":"prism.v4.management.ClusterReference"} \ - "https://host:port/api/prism/v4.3/management/domain-managers/956BE1Cc-deff-d5E7-AE8F-fFd2eb4B3DA2/$actions/unregister?$dryrun=true" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ DomainManagerApi domainManagerApi = new DomainManagerApi(client);\n\ \n ClusterUnregistrationSpec clusterUnregistrationSpec = new ClusterUnregistrationSpec();\n\ \n // ClusterUnregistrationSpec object initializations here...\n\n\ \ String extId = \"aDdAaB2d-Ab3c-6Bc7-aFAc-CbD4dF623bE9\";\n boolean\ \ dryrun = true;\n\n // Create request object with parameters\n \ \ var request = new UnregisterRequest {\n ExtId = extId,\n\ \ Body = clusterUnregistrationSpec,\n Dryrun = dryrun\n\ \ };\n try {\n UnregisterApiResponse unregisterApiResponse\ \ = domainManagerApi.Unregister(request);\n } catch (ApiException\ \ ex) {\n Console.WriteLine(ex.Message);\n }\n }\n\ \ }\n}\n" /prism/v4.3/config/external-storages/{extId}: get: tags: - ExternalStorages summary: Get external storage by ID description: Retrieves details of a specific external storage resource by its unique identifier. operationId: getExternalStorageById parameters: - name: extId in: path description: The unique identifier (UUID) of the external storage resource. 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: d55b8fa2-dad7-4822-9b78-e9d1d5ff4728 responses: "200": description: The response contains detailed information about the requested external storage resource. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.ExternalStorage' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/external-storages/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/external-storages/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/external-storages/{extId}\ \ Get operation" x-permissions: operationName: View External Storage deploymentList: - ON_PREM roleList: - name: Internal Super Admin - name: Prism Admin - name: Prism Viewer - name: Super Admin - name: Storage Admin - name: Storage Viewer x-rate-limit: - type: xsmall count: 5 timeUnit: seconds - type: Small count: 5 timeUnit: seconds - type: Large count: 5 timeUnit: seconds - type: XLarge count: 5 timeUnit: seconds x-supported-versions: - product: PC version: "7.5" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.ExternalStoragesApi;\nimport com.nutanix.dp1.pri.prism.v4.request.ExternalStorages.GetExternalStorageByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.config.GetExternalStorageApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ ExternalStoragesApi externalStoragesApi = new ExternalStoragesApi(apiClient);\n\ \n \n String extId = \"C9B134D8-A7aA-EdDC-8a3d-acDBCBfFEbFf\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetExternalStorageApiResponse\ \ getExternalStorageApiResponse = externalStoragesApi.getExternalStorageById(GetExternalStorageByIdRequest.builder()\n\ \ .extId(extId)\n .build());\n\n \ \ System.out.println(getExternalStorageApiResponse.toString());\n\n \ \ } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, ExternalStoragesApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let externalStoragesApi = new ExternalStoragesApi(apiClientInstance);\n\n\ function sample() {\n\n \n let extId = \"F0FFFabA-C7a7-f8c4-Df6F-EcCAC3ebdcAe\"\ ;\n\n\n\n\n\n externalStoragesApi.getExternalStorageById(extId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ external_storages_api = ntnx_prism_py_client.ExternalStoragesApi(api_client=client)\n\ \ \n ext_id = \"A2ce1aDF-122F-12ef-E8f5-8FDaBFaFcaDf\"\n\n\n try:\n\ \ api_response = external_storages_api.get_external_storage_by_id(extId=ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/externalstorages\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n ExternalStoragesServiceApiInstance\ \ *api.ExternalStoragesServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ ExternalStoragesServiceApiInstance = api.NewExternalStoragesServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n extId := \"fA03eCeB-ADb4-Ef0C-8512-BB05EF1f3A0B\"\ \n\n\n request := externalstorages.GetExternalStorageByIdRequest{ ExtId:\ \ &extId }\n response, error := ExternalStoragesServiceApiInstance.GetExternalStorageById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.ExternalStorage)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/external-storages/fEC6EAef-bAfd-aD0d-D438-DDc5AEde858a" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/external-storages/41B7aEB9-DC1c-DCfB-cca7-FccFFbCa9d14" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n{\n\ \ class Program\n {\n static void Main(string[] args) {\n // Configure\ \ the client\n Configuration _config = new Configuration\n {\n\ \ // UserName to connect to the cluster\n Username = \"username\"\ ,\n // Password(SecureString) to connect to the cluster \n \ \ Password = Configuration.CreateSecurePassword(\"password\"),\n \ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"localhost\"\ ,\n // Port used for the connection. \n Port = 9440,\n \ \ // Backoff period in seconds (exponential backoff: 2, 4, 8... seconds)\n\ \ BackOffPeriod = 2,\n // Max retry attempts while reconnecting\ \ on a loss of connection\n MaxRetryAttempts = 5\n };\n\n \ \ ApiClient client = new ApiClient(_config);\n\n ExternalStoragesApi\ \ externalStoragesApi = new ExternalStoragesApi(client);\n\n String\ \ extId = \"b4DFDCc7-e2E4-DFa7-5AbD-2caccF11Bbc1\";\n\n // Create\ \ request object with parameters\n var request = new GetExternalStorageByIdRequest\ \ {\n ExtId = extId\n };\n try {\n GetExternalStorageApiResponse\ \ getExternalStorageApiResponse = externalStoragesApi.GetExternalStorageById(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations: get: tags: - Registration summary: List of registered clusters description: "This endpoint returns the list of registered clusters to the domain\ \ manager. It could be the other domain managers, PEs, WitnessVMs, etc." operationId: listRegistrations parameters: - name: domainManagerExtId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: 3c33dda0-afd6-4b39-9331-4a8e92f8f494 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: remoteClusterDetails/clusterType example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$filter=remoteClusterDetails/clusterType\ \ eq Prism.Management.ClusterType'DOMAIN_MANAGER'" - name: remoteClusterExtId example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$filter=remoteClusterExtId\ \ eq '29d0d470-bf93-4b06-a27c-c76e28a4529b'" - 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 descending order." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: remoteClusterDetails/clusterType example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$orderby=remoteClusterDetails/clusterType" - name: remoteClusterDetails/clusterVersion example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$orderby=remoteClusterDetails/clusterVersion" - name: remoteClusterDetails/name example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$orderby=remoteClusterDetails/name" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: connectivityStatus example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=connectivityStatus" - name: metadata example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=metadata" - name: remoteClusterDetails example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails" - name: remoteClusterDetails/clusterType example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/clusterType" - name: remoteClusterDetails/clusterVersion example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/clusterVersion" - name: remoteClusterDetails/externalAddress/fqdn/value example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/externalAddress/fqdn/value" - name: remoteClusterDetails/externalAddress/ipv4/value example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/externalAddress/ipv4/value" - name: remoteClusterDetails/externalAddress/ipv6/value example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/externalAddress/ipv6/value" - name: remoteClusterDetails/name example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/name" - name: remoteClusterDetails/nodeIpAddresses/ipv4/value example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/nodeIpAddresses/ipv4/value" - name: remoteClusterDetails/nodeIpAddresses/ipv6/value example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterDetails/nodeIpAddresses/ipv6/value" - name: remoteClusterExtId example: "https://{host}:{port}/api/prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations?$select=remoteClusterExtId" responses: "200": description: Response model of the list endpoint. An array of registered clusters. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: maxItems: 500 minItems: 1 type: array items: $ref: '#/components/schemas/prism.v4.3.management.Registration' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations\ \ Get operation" x-permissions: operationName: View Domain Manager Registration roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin - name: Prism Viewer - name: Cluster Viewer - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "7.5" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.RegistrationApi;\nimport com.nutanix.dp1.pri.prism.v4.request.Registration.ListRegistrationsRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.ListRegistrationApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ RegistrationApi registrationApi = new RegistrationApi(apiClient);\n\ \n \n String domainManagerExtId = \"1BDebf76-Fe5A-CCf1-BaE4-dA7Cbee9df1d\"\ ;\n \n int page = 0;\n \n int limit = 50;\n\n\ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n ListRegistrationApiResponse\ \ listRegistrationApiResponse = registrationApi.listRegistrations(ListRegistrationsRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .$page(page)\n .$limit(limit)\n .$filter(null)\n\ \ .$orderby(null)\n .$select(null)\n \ \ .build());\n\n System.out.println(listRegistrationApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, RegistrationApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let registrationApi = new RegistrationApi(apiClientInstance);\n\nfunction\ \ sample() {\n\n \n let domainManagerExtId = \"8cAaE2fe-b1Ab-7EaA-64F2-FDD9Df33E5eF\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $page\"] = 0;\n opts[\"$limit\"] = 50;\n opts[\"$filter\"] = \"string_sample_data\"\ ;\n opts[\"$orderby\"] = \"string_sample_data\";\n opts[\"$select\"\ ] = \"string_sample_data\";\n\n\n\n\n registrationApi.listRegistrations(domainManagerExtId,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ registration_api = ntnx_prism_py_client.RegistrationApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"Ee3D4b9d-9AFA-CabF-bDC6-CBFDa0FAc6b9\"\ \n \n page = 0\n \n limit = 50\n\n\n try:\n api_response\ \ = registration_api.list_registrations(domainManagerExtId=domain_manager_ext_id,\ \ _page=page, _limit=limit)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/registration\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n RegistrationServiceApiInstance\ \ *api.RegistrationServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ RegistrationServiceApiInstance = api.NewRegistrationServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"c6dc2bbE-Eb7e-7FB2-ea2B-6c973B657e3c\"\ \n \n page_ := 0\n \n limit_ := 50\n\n\n request := registration.ListRegistrationsRequest{\ \ DomainManagerExtId: &domainManagerExtId, Page_: &page_, Limit_: &limit_,\ \ Filter_: nil, Orderby_: nil, Select_: nil }\n response, error := RegistrationServiceApiInstance.ListRegistrations(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.Registration)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/domain-managers/abfeECf0-B6C2-4fbb-fBE5-65Bbb081cEAe/registrations?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/eCd66bFe-a8fA-08ed-Ac2b-aAbaECC2fA3A/registrations?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ RegistrationApi registrationApi = new RegistrationApi(client);\n\n\ \ String domainManagerExtId = \"E0aaCDc3-CAaC-Bd8e-BfF9-9dB678FE5180\"\ ;\n int page = 0;\n int limit = 50;\n String filter = \"\ string_sample_data\";\n String orderby = \"string_sample_data\";\n\ \ String select = \"string_sample_data\";\n\n // Create request\ \ object with parameters\n var request = new ListRegistrationsRequest\ \ {\n DomainManagerExtId = domainManagerExtId,\n Page\ \ = page,\n Limit = limit,\n Filter = filter,\n \ \ Orderby = orderby,\n Select = select\n };\n\ \ try {\n ListRegistrationApiResponse listRegistrationApiResponse\ \ = registrationApi.ListRegistrations(request);\n } catch (ApiException\ \ ex) {\n Console.WriteLine(ex.Message);\n }\n }\n\ \ }\n}\n" /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations/{extId}: get: tags: - Registration summary: Specifications for the specified registration description: Returns the specifications for the specified registration. operationId: getRegistrationById parameters: - name: domainManagerExtId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: ab3b13d8-d430-4a49-b4bb-b6335a9905f9 - name: extId in: path description: The external identifier of the domain manager (Prism Central) resource. 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: 2c7632bf-a38f-4486-9054-e3a4dc218520 responses: "200": description: Response model of the get endpoint. Specifications of the registered cluster. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.management.Registration' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations/{extId}\ \ Get operation" x-permissions: operationName: View Domain Manager Registration roleList: - name: Super Admin - name: Internal Super Admin - name: Prism Admin - name: Cluster Admin - name: Domain Manager Admin - name: Prism Viewer - name: Cluster Viewer - name: Domain Manager Viewer x-rate-limit: - type: xsmall count: 3 timeUnit: seconds - type: small count: 3 timeUnit: seconds - type: large count: 3 timeUnit: seconds - type: xlarge count: 3 timeUnit: seconds x-supported-versions: - product: PC version: "7.5" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.pri.java.client.ApiClient;\n\ import com.nutanix.pri.java.client.api.RegistrationApi;\nimport com.nutanix.dp1.pri.prism.v4.request.Registration.GetRegistrationByIdRequest;\n\ import com.nutanix.dp1.pri.prism.v4.management.GetRegistrationApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ RegistrationApi registrationApi = new RegistrationApi(apiClient);\n\ \n \n String domainManagerExtId = \"72Cc6Efa-DBFd-56fE-3fA9-fe4E608EB5CE\"\ ;\n \n String extId = \"afa9aDB5-fDCe-fAfD-B23E-db9EE6eFdA9E\"\ ;\n\n try {\n // Pass in parameters using the request\ \ builder object associated with the operation.\n GetRegistrationApiResponse\ \ getRegistrationApiResponse = registrationApi.getRegistrationById(GetRegistrationByIdRequest.builder()\n\ \ .domainManagerExtId(domainManagerExtId)\n \ \ .extId(extId)\n .build());\n\n System.out.println(getRegistrationApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, RegistrationApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let registrationApi = new RegistrationApi(apiClientInstance);\n\nfunction\ \ sample() {\n\n \n let domainManagerExtId = \"B9D5c3E5-Dc7b-Cfa3-AC3e-9C0E2CD1B82a\"\ ;\n \n let extId = \"bFaDc14C-6bAe-aEdF-1AfD-FAFAdc0dFFD1\";\n\n\n\ \n\n\n registrationApi.getRegistrationById(domainManagerExtId, extId).then(({data,\ \ response}) => {\n console.log(`API returned the following status\ \ code: ${response.status}`);\n console.log(data.getData());\n \ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n \ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ registration_api = ntnx_prism_py_client.RegistrationApi(api_client=client)\n\ \ \n domain_manager_ext_id = \"26ca0204-bbe5-1aEa-4E52-7AfBFe9DDEAC\"\ \n \n ext_id = \"fb4dB3f3-bE4e-AA29-E9eE-c7EBDFD3C47f\"\n\n\n try:\n\ \ api_response = registration_api.get_registration_by_id(domainManagerExtId=domain_manager_ext_id,\ \ extId=ext_id)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/registration\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/management\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n RegistrationServiceApiInstance\ \ *api.RegistrationServiceApi\n)\n\nfunc main() {\n ApiClientInstance\ \ = client.NewApiClient()\n // IPv4/IPv6 address or FQDN of the cluster\n\ \ ApiClientInstance.Host = \"localhost\"\n // Port used for the connection.\ \ PC products typically use port 9440, while NC products typically use port\ \ 443. See the product-specific documentation for accurate configuration.\n\ \ ApiClientInstance.Port = 9440\n // Interval in ms to use during\ \ retry attempts\n ApiClientInstance.RetryInterval = 5 * time.Second\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ ApiClientInstance.MaxRetryAttempts = 5\n // UserName to connect\ \ to the cluster\n ApiClientInstance.Username = \"username\"\n //\ \ Password to connect to the cluster\n ApiClientInstance.Password = \"\ password\"\n // Please add authorization information here if needed.\n\ \ RegistrationServiceApiInstance = api.NewRegistrationServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n domainManagerExtId := \"40Eabf07-cdEf-CdE8-d53C-bA3B9aefaDfe\"\ \n \n extId := \"d3DcD8cC-Cacb-DdB0-2F10-6b0f2FB1C96f\"\n\n\n request\ \ := registration.GetRegistrationByIdRequest{ DomainManagerExtId: &domainManagerExtId,\ \ ExtId: &extId }\n response, error := RegistrationServiceApiInstance.GetRegistrationById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.Registration)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/management/domain-managers/aDeBc20E-FBFf-eF2C-ddb1-a0707716CCDb/registrations/B99a0B13-CcAC-C48e-f7f4-b25C0B1cfCfA" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/management/domain-managers/Bd8acF2B-F204-DdAa-0a5c-be48Ba0b9f3A/registrations/ac3f6DBE-9bBf-aEDd-863E-0bCfBEB239eA" - lang: Csharp source: "\n\nusing Nutanix.PriSDK.Client;\nusing Nutanix.PriSDK.Api;\nusing\ \ Nutanix.PriSDK.Model.Prism.V4.Management;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ RegistrationApi registrationApi = new RegistrationApi(client);\n\n\ \ String domainManagerExtId = \"BdaEaDF9-cCa2-8BD4-ccC3-3ebBBefB2d55\"\ ;\n String extId = \"eEd3Ef63-DdFE-CdDa-7CEc-Edeaf01fdde1\";\n\n \ \ // Create request object with parameters\n var request = new\ \ GetRegistrationByIdRequest {\n DomainManagerExtId = domainManagerExtId,\n\ \ ExtId = extId\n };\n try {\n GetRegistrationApiResponse\ \ getRegistrationApiResponse = registrationApi.GetRegistrationById(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/config/tasks/{extId}: get: tags: - Tasks summary: Fetch a task description: Fetches an asynchronous operation called a task for the provided external identifier. operationId: getTaskById parameters: - name: extId in: path description: A globally unique identifier for a task. It consists of a prefix and a UUID separated by ':'. The 'legacy' prefix can be used with a task UUID provided by previous API families. required: true style: simple explode: false schema: 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 example: QmFzZTY0RW5jb2RlZA==:9315aa0a-43e3-4697-91fe-2a062aab666e - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: appName - name: batchSummary - name: clusterExtIds - name: completedTime - name: completionDetails - name: createdTime - name: entitiesAffected - name: errorMessages - name: extId - name: isBackgroundTask - name: isCancelable - name: lastUpdatedTime - name: numberOfEntitiesAffected - name: numberOfSubtasks - name: operation - name: operationDescription - name: ownedBy/extId - name: ownedBy/name - name: parentTask - name: progressPercentage - name: resourceLinks - name: rootTask - name: startedTime - name: status - name: subTasks - name: warnings responses: "200": description: Returns the task object. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.Task' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{extId}\ \ Get operation" x-permissions: operationName: View Task deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Super Admin - name: Prism Viewer - name: CSI System - name: Kubernetes Data Services System - name: Administrator - name: Account Owner - name: Monitoring Admin - name: Backup Admin - name: NCM Connector - name: NCM Admin - name: Intelligent Ops Admin - name: NCM Viewer x-rate-limit: - type: xsmall count: 27 timeUnit: seconds - type: Small count: 36 timeUnit: seconds - type: Large count: 54 timeUnit: seconds - type: XLarge count: 72 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.tsks.java.client.ApiClient;\n\ import com.nutanix.tsks.java.client.api.TasksApi;\nimport com.nutanix.dp1.tsks.prism.v4.request.Tasks.GetTaskByIdRequest;\n\ import com.nutanix.dp1.tsks.prism.v4.config.GetTaskApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ TasksApi tasksApi = new TasksApi(apiClient);\n\n \n String\ \ extId = \"^:AACeDEe9-eC6D-3aee-cCDd-da1aecfEFfeA\";\n\n try {\n\ \ // Pass in parameters using the request builder object associated\ \ with the operation.\n GetTaskApiResponse getTaskApiResponse\ \ = tasksApi.getTaskById(GetTaskByIdRequest.builder()\n .extId(extId)\n\ \ .$select(null)\n .build());\n\n \ \ System.out.println(getTaskApiResponse.toString());\n\n } catch\ \ (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, TasksApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let tasksApi = new TasksApi(apiClientInstance);\n\nfunction sample() {\n\ \n \n let extId = \"^pbvA==:edA8c8D4-bD8b-6b3E-B0dC-abfb7BAc2Db2\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $select\"] = \"string_sample_data\";\n\n\n\n\n tasksApi.getTaskById(extId,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ tasks_api = ntnx_prism_py_client.TasksApi(api_client=client)\n \n \ \ ext_id = \"^:41fd4FfC-5e48-DFaD-6B85-9C1A9fdce1DC\"\n\n\n try:\n\ \ api_response = tasks_api.get_task_by_id(extId=ext_id)\n \ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/tasks\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n TasksServiceApiInstance\ \ *api.TasksServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ TasksServiceApiInstance = api.NewTasksServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n extId := \"^/:E0CE4dcE-EdbB-44C6-5Def-A136FeDFAddb\"\ \n\n\n request := tasks.GetTaskByIdRequest{ ExtId: &extId, Select_: nil\ \ }\n response, error := TasksServiceApiInstance.GetTaskById(ctx, &request)\n\ \ if error != nil {\n fmt.Println(error)\n return\n \ \ }\n data, _ := response.GetData().(import1.Task)\n fmt.Println(data)\n\ \n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/tasks/^=:91A5eaaF-96d0-BC30-AEf0-1D111FcabBCC?$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/tasks/^89V/F+H6mP:ECf2bABf-A50B-453D-65E0-af621BdBAcAd?$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.TsksSDK.Client;\nusing Nutanix.TsksSDK.Api;\nusing\ \ Nutanix.TsksSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ TasksApi tasksApi = new TasksApi(client);\n\n String extId = \"\ ^:9d7Be86b-D6CB-D2D7-21dD-6168611deABa\";\n String select = \"string_sample_data\"\ ;\n\n // Create request object with parameters\n var request\ \ = new GetTaskByIdRequest {\n ExtId = extId,\n Select\ \ = select\n };\n try {\n GetTaskApiResponse getTaskApiResponse\ \ = tasksApi.GetTaskById(request);\n } catch (ApiException ex) {\n\ \ Console.WriteLine(ex.Message);\n }\n }\n }\n}\n" /prism/v4.3/config/tasks/{taskExtId}/$actions/cancel: post: tags: - Tasks summary: Cancel an ongoing task description: "Cancel an ongoing task for the provided taskExtId. This action\ \ is supported only if 'isCancelable' is set as True for the task. The task\ \ may continue to run for some time after the request has been made, until\ \ the backend server deems it is safe to cancel the task. Cancellation requests\ \ are idempotent and multiple such requests for the same ongoing task are\ \ supported." operationId: cancelTask parameters: - name: taskExtId in: path description: A globally unique identifier for a task. It consists of a prefix and a UUID separated by ':'. The 'legacy' prefix can be used with a task UUID provided by previous API families. required: true style: simple explode: false schema: 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 example: QmFzZTY0RW5jb2RlZA==:8ecd6cc7-22c5-4511-b9db-1eb1f446e249 responses: "200": description: Successful submission message is returned in response. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/$actions/cancel\ \ Post operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/$actions/cancel\ \ Post operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/$actions/cancel\ \ Post operation" x-permissions: operationName: Cancel Task deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Super Admin - name: NCM Admin - name: Intelligent Ops Admin x-rate-limit: - type: xsmall count: 10 timeUnit: seconds - type: Small count: 20 timeUnit: seconds - type: Large count: 20 timeUnit: seconds - type: XLarge count: 20 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.tsks.java.client.ApiClient;\n\ import com.nutanix.tsks.java.client.api.TasksApi;\nimport com.nutanix.dp1.tsks.prism.v4.request.Tasks.CancelTaskRequest;\n\ import com.nutanix.dp1.tsks.prism.v4.config.CancelTaskApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ TasksApi tasksApi = new TasksApi(apiClient);\n\n \n String\ \ taskExtId = \"^5:Fe85a33e-9E0B-abBF-7fAd-f7DDA2B4F9e4\";\n\n try\ \ {\n // Pass in parameters using the request builder object\ \ associated with the operation.\n CancelTaskApiResponse cancelTaskApiResponse\ \ = tasksApi.cancelTask(CancelTaskRequest.builder()\n .taskExtId(taskExtId)\n\ \ .build());\n\n System.out.println(cancelTaskApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, TasksApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let tasksApi = new TasksApi(apiClientInstance);\n\nfunction sample() {\n\ \n \n let taskExtId = \"^+q+:ADbEEFA5-b8c9-CC7B-f2d3-5F6BbB9f2CCd\"\ ;\n\n\n\n\n\n tasksApi.cancelTask(taskExtId).then(({data, response})\ \ => {\n console.log(`API returned the following status code: ${response.status}`);\n\ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ tasks_api = ntnx_prism_py_client.TasksApi(api_client=client)\n \n \ \ task_ext_id = \"^11:e4EEB8cD-BAAc-dfFE-dEB8-BbAcb39B69fc\"\n\n\n \ \ try:\n api_response = tasks_api.cancel_task(taskExtId=task_ext_id)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/tasks\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/error\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n TasksServiceApiInstance\ \ *api.TasksServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ TasksServiceApiInstance = api.NewTasksServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n taskExtId := \"^=:B44eA7e7-cafd-c47E-295d-cedf386FAAFa\"\ \n\n\n request := tasks.CancelTaskRequest{ TaskExtId: &taskExtId }\n\ \ response, error := TasksServiceApiInstance.CancelTask(ctx, &request)\n\ \ if error != nil {\n fmt.Println(error)\n return\n \ \ }\n data, _ := response.GetData().(import1.AppMessage)\n fmt.Println(data)\n\ \n}\n\n" - lang: cURL source: |2+ curl --request POST \ --url "https://host:port/api/prism/v4.3/config/tasks/^b:f7EE79d5-fc4B-edA5-f1f3-A3cf46c8DfcC/$actions/cancel" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method POST \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/tasks/^+:aEeBF63B-3ABd-ddCB-A9cA-deaeFfc94Ebc/$actions/cancel" - lang: Csharp source: "\n\nusing Nutanix.TsksSDK.Client;\nusing Nutanix.TsksSDK.Api;\nusing\ \ Nutanix.TsksSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ TasksApi tasksApi = new TasksApi(client);\n\n String taskExtId\ \ = \"^X:e5AD64Ce-275F-aCDD-CB3B-dcFfeBEABd01\";\n\n // Create request\ \ object with parameters\n var request = new CancelTaskRequest {\n\ \ TaskExtId = taskExtId\n };\n try {\n \ \ CancelTaskApiResponse cancelTaskApiResponse = tasksApi.CancelTask(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/config/tasks: get: tags: - Tasks summary: List tasks description: "List of tasks in the system. The response can be further filtered/sorted\ \ using the filter and sort options provided. By default, the response would\ \ be sorted by 'createdTime' in descending order." operationId: listTasks parameters: - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: appName example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=appName\ \ eq 'NCM'" - name: clusterExtIds example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=clusterExtIds/any(a:a\ \ eq 'bcc21153-d671-47dc-998b-61baff02a6c5')" - name: completedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=completedTime\ \ eq '2009-09-23T14:30:00-07:00'" - name: createdTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=createdTime\ \ eq '2009-09-23T14:30:00-07:00'" - name: entitiesAffected/extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=entitiesAffected/any(a:a/extId\ \ eq '7ccae44f-d067-4d49-a4d0-7409e2455894')" - name: entitiesAffected/name example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=entitiesAffected/any(a:a/name\ \ eq 'Test VM')" - name: entitiesAffected/rel example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=entitiesAffected/any(a:a/rel\ \ eq 'vmm:ahv:config:vm')" - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=extId\ \ eq 'QmFzZTY0RW5jb2RlZA==:3b39d500-bbc7-426f-9ef8-34b1cabd5aa0'" - name: isBackgroundTask example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=isBackgroundTask\ \ eq false" - name: lastUpdatedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=lastUpdatedTime\ \ eq '2009-09-23T14:30:00-07:00'" - name: operation example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=operation\ \ eq 'kVmCreate'" - name: operationDescription example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=operationDescription\ \ eq 'Create VM'" - name: ownedBy/extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=ownedBy/extId\ \ eq 'fa426143-7313-4697-bcea-b2172c3750bb'" - name: ownedBy/name example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=ownedBy/name\ \ eq 'Test User'" - name: parentTask/extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=parentTask/extId\ \ eq 'QmFzZTY0RW5jb2RlZA==:fdee78d4-590c-4c89-be4f-c8ba53c4509c'" - name: progressPercentage example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=progressPercentage\ \ eq 57" - name: rootTask/extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=rootTask/extId\ \ eq 'QmFzZTY0RW5jb2RlZA==:fdee78d4-590c-4c89-be4f-c8ba53c4509c'" - name: startedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=startedTime\ \ eq '2009-09-23T14:30:00-07:00'" - name: status example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$filter=status\ \ eq Prism.Config.TaskStatus'QUEUED'" - 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 descending order." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: appName example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=appName" - name: completedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=completedTime" - name: createdTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=createdTime" - name: lastUpdatedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=lastUpdatedTime" - name: operation example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=operation" - name: operationDescription example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=operationDescription" - name: ownedBy/extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=ownedBy/extId" - name: ownedBy/name example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=ownedBy/name" - name: progressPercentage example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=progressPercentage" - name: startedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=startedTime" - name: status example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$orderby=status" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: appName example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=appName" - name: batchSummary example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=batchSummary" - name: clusterExtIds example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=clusterExtIds" - name: completedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=completedTime" - name: completionDetails example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=completionDetails" - name: createdTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=createdTime" - name: entitiesAffected example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=entitiesAffected" - name: errorMessages example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=errorMessages" - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=extId" - name: isBackgroundTask example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=isBackgroundTask" - name: isCancelable example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=isCancelable" - name: lastUpdatedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=lastUpdatedTime" - name: numberOfEntitiesAffected example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=numberOfEntitiesAffected" - name: numberOfSubtasks example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=numberOfSubtasks" - name: operation example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=operation" - name: operationDescription example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=operationDescription" - name: ownedBy/extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=ownedBy/extId" - name: ownedBy/name example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=ownedBy/name" - name: parentTask example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=parentTask" - name: progressPercentage example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=progressPercentage" - name: resourceLinks example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=resourceLinks" - name: rootTask example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=rootTask" - name: startedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=startedTime" - name: status example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=status" - name: subTasks example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=subTasks" - name: warnings example: "https://{host}:{port}/api/prism/v4.3/config/tasks?$select=warnings" responses: "200": description: Returns a list of task objects. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.config.Task' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/tasks Get operation "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/tasks Get operation "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/tasks Get operation x-permissions: operationName: View Task deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Super Admin - name: Prism Viewer - name: CSI System - name: Kubernetes Data Services System - name: Administrator - name: Account Owner - name: Monitoring Admin - name: Backup Admin - name: NCM Connector - name: NCM Admin - name: Intelligent Ops Admin - name: NCM Viewer x-rate-limit: - type: xsmall count: 6 timeUnit: seconds - type: Small count: 6 timeUnit: seconds - type: Large count: 6 timeUnit: seconds - type: XLarge count: 6 timeUnit: seconds x-supported-versions: - product: PC version: "2024.3" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.tsks.java.client.ApiClient;\n\ import com.nutanix.tsks.java.client.api.TasksApi;\nimport com.nutanix.dp1.tsks.prism.v4.request.Tasks.ListTasksRequest;\n\ import com.nutanix.dp1.tsks.prism.v4.config.ListTasksApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ TasksApi tasksApi = new TasksApi(apiClient);\n\n \n int\ \ page = 0;\n \n int limit = 50;\n\n try {\n \ \ // Pass in parameters using the request builder object associated\ \ with the operation.\n ListTasksApiResponse listTasksApiResponse\ \ = tasksApi.listTasks(ListTasksRequest.builder()\n .$page(page)\n\ \ .$limit(limit)\n .$filter(null)\n \ \ .$orderby(null)\n .$select(null)\n \ \ .build());\n\n System.out.println(listTasksApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: |2 import { ApiClient, TasksApi } from "@nutanix-api/prism-js-client"; // Configure the client let apiClientInstance = new ApiClient(); // IPv4/IPv6 address or FQDN of the cluster apiClientInstance.host = 'localhost'; // Port used for the connection. PC products typically use port 9440, while NC products typically use port 443. See the product-specific documentation for accurate configuration. apiClientInstance.port = '9440'; // Max retry attempts while reconnecting on a loss of connection apiClientInstance.maxRetryAttempts = 5; // Interval in ms to use during retry attempts apiClientInstance.retryInterval = 5000; // UserName to connect to the cluster apiClientInstance.username = 'username'; // Password to connect to the cluster apiClientInstance.password = 'password'; // Please add authorization information here if needed. let tasksApi = new TasksApi(apiClientInstance); function sample() { // Construct Optional Parameters var opts = {}; opts["$page"] = 0; opts["$limit"] = 50; opts["$filter"] = "string_sample_data"; opts["$orderby"] = "string_sample_data"; opts["$select"] = "string_sample_data"; tasksApi.listTasks(opts).then(({data, response}) => { console.log(`API returned the following status code: ${response.status}`); console.log(data.getData()); }).catch((error) => { console.log(`Error is: ${error}`); }); } sample() - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ tasks_api = ntnx_prism_py_client.TasksApi(api_client=client)\n \n \ \ page = 0\n \n limit = 50\n\n\n try:\n api_response =\ \ tasks_api.list_tasks(_page=page, _limit=limit)\n print(api_response)\n\ \ except ntnx_prism_py_client.rest.ApiException as e:\n print(e)\n\ \n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/tasks\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n TasksServiceApiInstance\ \ *api.TasksServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ TasksServiceApiInstance = api.NewTasksServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n page_ := 0\n \n limit_\ \ := 50\n\n\n request := tasks.ListTasksRequest{ Page_: &page_, Limit_:\ \ &limit_, Filter_: nil, Orderby_: nil, Select_: nil }\n response, error\ \ := TasksServiceApiInstance.ListTasks(ctx, &request)\n if error != nil\ \ {\n fmt.Println(error)\n return\n }\n data, _ := response.GetData().([]import1.Task)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/tasks?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/tasks?$filter=string_sample_data&$limit=50&$orderby=string_sample_data&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.TsksSDK.Client;\nusing Nutanix.TsksSDK.Api;\nusing\ \ Nutanix.TsksSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ TasksApi tasksApi = new TasksApi(client);\n\n int page = 0;\n\ \ int limit = 50;\n String filter = \"string_sample_data\";\n\ \ String orderby = \"string_sample_data\";\n String select = \"\ string_sample_data\";\n\n // Create request object with parameters\n\ \ var request = new ListTasksRequest {\n Page = page,\n\ \ Limit = limit,\n Filter = filter,\n Orderby\ \ = orderby,\n Select = select\n };\n try {\n \ \ ListTasksApiResponse listTasksApiResponse = tasksApi.ListTasks(request);\n\ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" /prism/v4.3/config/tasks/{taskExtId}/jobs/{extId}: get: tags: - Tasks summary: Fetch a job associated with a task description: "Fetches details of an individual job associated with a task. When\ \ a task is a batch task, it includes multiple actions, each represented as\ \ a separate job." operationId: getTaskJobById parameters: - name: taskExtId in: path description: A globally unique identifier for a task. It consists of a prefix and a UUID separated by ':'. The 'legacy' prefix can be used with a task UUID provided by previous API families. required: true style: simple explode: false schema: 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 example: QmFzZTY0RW5jb2RlZA==:163706d2-89c2-45af-ab80-e101e8ae834f - name: extId in: path description: A globally unique identifier for a job within a task. The identifier is a UUID. 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: af94a660-8931-4d6e-9c48-6ae496a01a1e - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: clusterExtIds - name: completedTime - name: completionDetails - name: createdTime - name: entitiesAffected - name: errorMessages - name: extId - name: links - name: name - name: status - name: tenantId - name: warnings responses: "200": description: Returns a job object belonging to a task. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.config.TaskJob' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs/{extId}\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs/{extId}\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs/{extId}\ \ Get operation" x-permissions: operationName: View Task deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Super Admin - name: Prism Viewer - name: CSI System - name: Kubernetes Data Services System - name: Administrator - name: Account Owner - name: Monitoring Admin - name: Backup Admin - name: NCM Connector - name: NCM Admin - name: Intelligent Ops Admin - name: NCM Viewer x-rate-limit: - type: xsmall count: 27 timeUnit: seconds - type: Small count: 36 timeUnit: seconds - type: Large count: 54 timeUnit: seconds - type: XLarge count: 72 timeUnit: seconds x-supported-versions: - product: PC version: "7.5" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.tsks.java.client.ApiClient;\n\ import com.nutanix.tsks.java.client.api.TasksApi;\nimport com.nutanix.dp1.tsks.prism.v4.request.Tasks.GetTaskJobByIdRequest;\n\ import com.nutanix.dp1.tsks.prism.v4.config.GetTaskJobApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ TasksApi tasksApi = new TasksApi(apiClient);\n\n \n String\ \ taskExtId = \"^:F6dd27Fd-1bfd-1BAa-Ac9d-cfBc086cEad1\";\n \n \ \ String extId = \"bFfCe26D-dDcE-79dE-BAaD-18fdDE9C7006\";\n\n \ \ try {\n // Pass in parameters using the request builder\ \ object associated with the operation.\n GetTaskJobApiResponse\ \ getTaskJobApiResponse = tasksApi.getTaskJobById(GetTaskJobByIdRequest.builder()\n\ \ .taskExtId(taskExtId)\n .extId(extId)\n\ \ .$select(null)\n .build());\n\n \ \ System.out.println(getTaskJobApiResponse.toString());\n\n }\ \ catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, TasksApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let tasksApi = new TasksApi(apiClientInstance);\n\nfunction sample() {\n\ \n \n let taskExtId = \"^:caeBb5C9-fb91-cfEC-dBCb-5A3Ab0de2d0D\";\n\ \ \n let extId = \"69FdFcD7-E2E8-fcA5-2bE0-e4aceF08E8B0\";\n\n \ \ // Construct Optional Parameters\n var opts = {};\n opts[\"$select\"\ ] = \"string_sample_data\";\n\n\n\n\n tasksApi.getTaskJobById(taskExtId,\ \ extId, opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ tasks_api = ntnx_prism_py_client.TasksApi(api_client=client)\n \n \ \ task_ext_id = \"^B:cdDaDef1-BcAf-d31e-EA6d-1AFbcFDE6EA2\"\n \n \ \ ext_id = \"4dc8Bb8C-FaCf-dDbA-2098-B77fE92a5Ed2\"\n\n\n try:\n \ \ api_response = tasks_api.get_task_job_by_id(taskExtId=task_ext_id,\ \ extId=ext_id)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/tasks\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n TasksServiceApiInstance\ \ *api.TasksServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ TasksServiceApiInstance = api.NewTasksServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n taskExtId := \"^++/A=:aCB7b920-C83a-f5eC-Eb70-4f446cdb56A4\"\ \n \n extId := \"BaCEccA5-Cce8-CfBF-A85E-fcE0A9dc96a4\"\n\n\n request\ \ := tasks.GetTaskJobByIdRequest{ TaskExtId: &taskExtId, ExtId: &extId,\ \ Select_: nil }\n response, error := TasksServiceApiInstance.GetTaskJobById(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().(import1.TaskJob)\n \ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/tasks/^Ypm8==:ab8fAcfE-5ee1-ed24-5e2E-BEDB808b41B0/jobs/bEA2abe5-aaf1-BA4d-71ed-E6DDc8ecBdF5?$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/tasks/^=:7fE91Bd0-cC6B-ABc2-acB2-A810Ef7dA8fb/jobs/436caCb3-1dcb-3d3f-ae8f-d75EBD23aEFE?$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.TsksSDK.Client;\nusing Nutanix.TsksSDK.Api;\nusing\ \ Nutanix.TsksSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ TasksApi tasksApi = new TasksApi(client);\n\n String taskExtId\ \ = \"^lN1EG==:47aFdFD6-eCD9-bCcF-981D-c549ad1003ac\";\n String extId\ \ = \"8FeE651d-B93D-77Ad-7bAE-2deAadAddAeF\";\n String select = \"\ string_sample_data\";\n\n // Create request object with parameters\n\ \ var request = new GetTaskJobByIdRequest {\n TaskExtId\ \ = taskExtId,\n ExtId = extId,\n Select = select\n\ \ };\n try {\n GetTaskJobApiResponse getTaskJobApiResponse\ \ = tasksApi.GetTaskJobById(request);\n } catch (ApiException ex)\ \ {\n Console.WriteLine(ex.Message);\n }\n }\n }\n\ }\n" /prism/v4.3/config/tasks/{taskExtId}/jobs: get: tags: - Tasks summary: List jobs associated with a task description: "Lists jobs associated with a task. When a task is a batch task,\ \ it includes multiple actions, each represented as a separate job." operationId: listTaskJobs parameters: - name: taskExtId in: path description: A globally unique identifier for a task. It consists of a prefix and a UUID separated by ':'. The 'legacy' prefix can be used with a task UUID provided by previous API families. required: true style: simple explode: false schema: 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 example: QmFzZTY0RW5jb2RlZA==:7a1fdc0f-55e4-4c68-89b7-b2ff51115424 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. format: int32 default: 50 - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: clusterExtIds example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=clusterExtIds" - name: completedTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=completedTime" - name: completionDetails example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=completionDetails" - name: createdTime example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=createdTime" - name: entitiesAffected example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=entitiesAffected" - name: errorMessages example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=errorMessages" - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=extId" - name: links example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=links" - name: name example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=name" - name: status example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=status" - name: tenantId example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=tenantId" - name: warnings example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/jobs?$select=warnings" responses: "200": description: Returns a list of job objects belonging to a task. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.config.TaskJob' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs\ \ Get operation" x-permissions: operationName: View Task deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Super Admin - name: Prism Viewer - name: CSI System - name: Kubernetes Data Services System - name: Administrator - name: Account Owner - name: Monitoring Admin - name: Backup Admin - name: NCM Connector - name: NCM Admin - name: Intelligent Ops Admin - name: NCM Viewer x-rate-limit: - type: xsmall count: 27 timeUnit: seconds - type: Small count: 36 timeUnit: seconds - type: Large count: 54 timeUnit: seconds - type: XLarge count: 72 timeUnit: seconds x-supported-versions: - product: PC version: "7.5" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.tsks.java.client.ApiClient;\n\ import com.nutanix.tsks.java.client.api.TasksApi;\nimport com.nutanix.dp1.tsks.prism.v4.request.Tasks.ListTaskJobsRequest;\n\ import com.nutanix.dp1.tsks.prism.v4.config.ListTaskJobsApiResponse;\nimport\ \ org.springframework.web.client.RestClientException;\n\npublic class JavaSdkSample\ \ {\n public static void main(String[] args) {\n // Configure\ \ the client\n ApiClient apiClient = new ApiClient();\n //\ \ IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ TasksApi tasksApi = new TasksApi(apiClient);\n\n \n String\ \ taskExtId = \"^5K++:EfEECead-AEc4-E5B3-EEaB-69eec6dc2da4\";\n \n\ \ int page = 0;\n \n int limit = 50;\n\n try\ \ {\n // Pass in parameters using the request builder object\ \ associated with the operation.\n ListTaskJobsApiResponse listTaskJobsApiResponse\ \ = tasksApi.listTaskJobs(ListTaskJobsRequest.builder()\n \ \ .taskExtId(taskExtId)\n .$page(page)\n \ \ .$limit(limit)\n .$select(null)\n .build());\n\ \n System.out.println(listTaskJobsApiResponse.toString());\n\n\ \ } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, TasksApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let tasksApi = new TasksApi(apiClientInstance);\n\nfunction sample() {\n\ \n \n let taskExtId = \"^4+4ur+==:0FB0acD8-1b22-7519-1aA4-Bad48fcA3DdC\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $page\"] = 0;\n opts[\"$limit\"] = 50;\n opts[\"$select\"] = \"string_sample_data\"\ ;\n\n\n\n\n tasksApi.listTaskJobs(taskExtId, opts).then(({data, response})\ \ => {\n console.log(`API returned the following status code: ${response.status}`);\n\ \ console.log(data.getData());\n }).catch((error) => {\n \ \ console.log(`Error is: ${error}`);\n });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ tasks_api = ntnx_prism_py_client.TasksApi(api_client=client)\n \n \ \ task_ext_id = \"^:Fdcf5E1F-FfBd-6BaD-C1E0-f4B4DAEe65DD\"\n \n \ \ page = 0\n \n limit = 50\n\n\n try:\n api_response = tasks_api.list_task_jobs(taskExtId=task_ext_id,\ \ _page=page, _limit=limit)\n print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/tasks\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n TasksServiceApiInstance\ \ *api.TasksServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ TasksServiceApiInstance = api.NewTasksServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n taskExtId := \"^:7B1DA00F-aDa0-Eed3-Eb9E-7153a1ea7Ae5\"\ \n \n page_ := 0\n \n limit_ := 50\n\n\n request := tasks.ListTaskJobsRequest{\ \ TaskExtId: &taskExtId, Page_: &page_, Limit_: &limit_, Select_: nil }\n\ \ response, error := TasksServiceApiInstance.ListTaskJobs(ctx, &request)\n\ \ if error != nil {\n fmt.Println(error)\n return\n \ \ }\n data, _ := response.GetData().([]import1.TaskJob)\n fmt.Println(data)\n\ \n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/tasks/^=:7FBC5abc-2CAa-63da-ccFA-d0bAe8Cccdb5/jobs?$limit=50&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/tasks/^N++hW:cFDF55AC-545B-9Ab0-59bf-fFbCD12FaF77/jobs?$limit=50&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.TsksSDK.Client;\nusing Nutanix.TsksSDK.Api;\nusing\ \ Nutanix.TsksSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ TasksApi tasksApi = new TasksApi(client);\n\n String taskExtId\ \ = \"^+==:19ecedE8-2DEF-5eaD-bBDe-d4cdCbAEF3Ab\";\n int page = 0;\n\ \ int limit = 50;\n String select = \"string_sample_data\";\n\n\ \ // Create request object with parameters\n var request =\ \ new ListTaskJobsRequest {\n TaskExtId = taskExtId,\n \ \ Page = page,\n Limit = limit,\n Select = select\n\ \ };\n try {\n ListTaskJobsApiResponse listTaskJobsApiResponse\ \ = tasksApi.ListTaskJobs(request);\n } catch (ApiException ex) {\n\ \ Console.WriteLine(ex.Message);\n }\n }\n }\n}\n" /prism/v4.3/config/tasks/{taskExtId}/affected-entities: get: tags: - Tasks summary: List entities associated with a task description: Lists entities associated with a task. operationId: listTaskEntities parameters: - name: taskExtId in: path description: A globally unique identifier for a task. It consists of a prefix and a UUID separated by ':'. The 'legacy' prefix can be used with a task UUID provided by previous API families. required: true style: simple explode: false schema: 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 example: QmFzZTY0RW5jb2RlZA==:8c7a7eb7-e2a6-4fd7-9120-9d8411f42326 - name: $page in: query description: | A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. required: false style: form explode: false schema: maximum: 100 minimum: 1 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 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/affected-entities?$filter=extId\ \ eq '7ccae44f-d067-4d49-a4d0-7409e2455894'" - name: name example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/affected-entities?$filter=name\ \ eq 'Test VM'" - name: rel example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/affected-entities?$filter=rel\ \ eq 'vmm:ahv:config:vm'" - 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html)\ \ URL conventions. If a $select expression consists of a single select item\ \ that is an asterisk (i.e., *), then all properties on the matching resource\ \ will be returned." required: false style: form explode: true schema: type: string example: string x-odata-fields: - name: extId example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/affected-entities?$select=extId" - name: name example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/affected-entities?$select=name" - name: rel example: "https://{host}:{port}/api/prism/v4.3/config/tasks/{taskExtId}/affected-entities?$select=rel" responses: "200": description: Returns a list of entities affected by the task. content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: type: array items: $ref: '#/components/schemas/prism.v4.3.config.EntityReference' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/affected-entities\ \ Get operation" "4XX": description: Client error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/affected-entities\ \ Get operation" "5XX": description: Server error response content: application/json: schema: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/affected-entities\ \ Get operation" x-permissions: operationName: View Task deploymentList: - ON_PREM - CLOUD roleList: - name: Prism Admin - deprecated: true name: Self-Service Admin - name: Super Admin - name: Prism Viewer - name: CSI System - name: Kubernetes Data Services System - name: Administrator - name: Account Owner - name: Monitoring Admin - name: Backup Admin - name: NCM Connector - name: NCM Admin - name: Intelligent Ops Admin - name: NCM Viewer x-rate-limit: - type: xsmall count: 27 timeUnit: seconds - type: Small count: 36 timeUnit: seconds - type: Large count: 54 timeUnit: seconds - type: XLarge count: 72 timeUnit: seconds x-supported-versions: - product: PC version: "7.5" x-code-samples: - lang: Java source: "\npackage sample;\n\nimport com.nutanix.tsks.java.client.ApiClient;\n\ import com.nutanix.tsks.java.client.api.TasksApi;\nimport com.nutanix.dp1.tsks.prism.v4.request.Tasks.ListTaskEntitiesRequest;\n\ import com.nutanix.dp1.tsks.prism.v4.config.ListTaskEntitiesApiResponse;\n\ import org.springframework.web.client.RestClientException;\n\npublic class\ \ JavaSdkSample {\n public static void main(String[] args) {\n \ \ // Configure the client\n ApiClient apiClient = new ApiClient();\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n apiClient.setHost(\"\ localhost\");\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n apiClient.setPort(9440);\n\ \ // Interval in ms to use during retry attempts\n apiClient.setRetryInterval(5000);\n\ \ // Max retry attempts while reconnecting on a loss of connection\n\ \ apiClient.setMaxRetryAttempts(5);\n // UserName to connect\ \ to the cluster\n String username = \"username\";\n // Password\ \ to connect to the cluster\n String password = \"password\";\n \ \ apiClient.setUsername(username);\n apiClient.setPassword(password);\n\ \n // Please add authorization information here if needed.\n \ \ TasksApi tasksApi = new TasksApi(apiClient);\n\n \n String\ \ taskExtId = \"^:5CfDED53-fE74-753c-BbD4-6ea49B6f5D6d\";\n \n \ \ int page = 0;\n \n int limit = 50;\n\n try {\n\ \ // Pass in parameters using the request builder object associated\ \ with the operation.\n ListTaskEntitiesApiResponse listTaskEntitiesApiResponse\ \ = tasksApi.listTaskEntities(ListTaskEntitiesRequest.builder()\n \ \ .taskExtId(taskExtId)\n .$page(page)\n \ \ .$limit(limit)\n .$filter(null)\n \ \ .$select(null)\n .build());\n\n System.out.println(listTaskEntitiesApiResponse.toString());\n\ \n } catch (RestClientException ex) {\n System.out.println(ex.getMessage());\n\ \ }\n }\n}\n" - lang: JavaScript source: "\nimport { ApiClient, TasksApi } from \"@nutanix-api/prism-js-client\"\ ;\n\n// Configure the client\nlet apiClientInstance = new ApiClient();\n\ // IPv4/IPv6 address or FQDN of the cluster\napiClientInstance.host = 'localhost';\n\ // Port used for the connection. PC products typically use port 9440, while\ \ NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\napiClientInstance.port = '9440';\n// Max\ \ retry attempts while reconnecting on a loss of connection\napiClientInstance.maxRetryAttempts\ \ = 5;\n// Interval in ms to use during retry attempts\napiClientInstance.retryInterval\ \ = 5000;\n// UserName to connect to the cluster\napiClientInstance.username\ \ = 'username';\n// Password to connect to the cluster\napiClientInstance.password\ \ = 'password';\n// Please add authorization information here if needed.\n\ let tasksApi = new TasksApi(apiClientInstance);\n\nfunction sample() {\n\ \n \n let taskExtId = \"^98Z:b5ffBff3-bA93-4Fc0-D57c-41dd702cEF31\"\ ;\n\n // Construct Optional Parameters\n var opts = {};\n opts[\"\ $page\"] = 0;\n opts[\"$limit\"] = 50;\n opts[\"$filter\"] = \"string_sample_data\"\ ;\n opts[\"$select\"] = \"string_sample_data\";\n\n\n\n\n tasksApi.listTaskEntities(taskExtId,\ \ opts).then(({data, response}) => {\n console.log(`API returned\ \ the following status code: ${response.status}`);\n console.log(data.getData());\n\ \ }).catch((error) => {\n console.log(`Error is: ${error}`);\n\ \ });\n\n}\nsample()\n" - lang: Python source: "\nimport ntnx_prism_py_client\n\nif __name__ == \"__main__\":\n \ \ # Configure the client\n config = ntnx_prism_py_client.Configuration()\n\ \ # IPv4/IPv6 address or FQDN of the cluster\n config.host = \"localhost\"\ \n # Port used for the connection. PC products typically use port 9440,\ \ while NC products typically use port 443. See the product-specific documentation\ \ for accurate configuration.\n config.port = 9440\n # Max retry attempts\ \ while reconnecting on a loss of connection\n config.max_retry_attempts\ \ = 3\n # Backoff factor to use during retry attempts\n config.backoff_factor\ \ = 3\n # UserName to connect to the cluster\n config.username = \"\ username\"\n # Password to connect to the cluster\n config.password\ \ = \"password\"\n # Please add authorization information here if needed.\n\ \ client = ntnx_prism_py_client.ApiClient(configuration=config)\n \ \ tasks_api = ntnx_prism_py_client.TasksApi(api_client=client)\n \n \ \ task_ext_id = \"^r+:6a8e5Ed5-9d1A-e7D3-83dC-D6CaDaD6DF0b\"\n \n \ \ page = 0\n \n limit = 50\n\n\n try:\n api_response =\ \ tasks_api.list_task_entities(taskExtId=task_ext_id, _page=page, _limit=limit)\n\ \ print(api_response)\n except ntnx_prism_py_client.rest.ApiException\ \ as e:\n print(e)\n\n" - lang: Go source: "\npackage main\n\nimport (\n \"fmt\"\n \"time\"\n \"context\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/api\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/client\"\ \n \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/request/tasks\"\ \n import1 \"github.com/nutanix/ntnx-api-golang-clients/prism-go-client/v4/models/prism/v4/config\"\ \n)\n\nvar (\n ApiClientInstance *client.ApiClient\n TasksServiceApiInstance\ \ *api.TasksServiceApi\n)\n\nfunc main() {\n ApiClientInstance = client.NewApiClient()\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n ApiClientInstance.Host\ \ = \"localhost\"\n // Port used for the connection. PC products typically\ \ use port 9440, while NC products typically use port 443. See the product-specific\ \ documentation for accurate configuration.\n ApiClientInstance.Port\ \ = 9440\n // Interval in ms to use during retry attempts\n ApiClientInstance.RetryInterval\ \ = 5 * time.Second\n // Max retry attempts while reconnecting on a loss\ \ of connection\n ApiClientInstance.MaxRetryAttempts = 5\n // UserName\ \ to connect to the cluster\n ApiClientInstance.Username = \"username\"\ \n // Password to connect to the cluster\n ApiClientInstance.Password\ \ = \"password\"\n // Please add authorization information here if needed.\n\ \ TasksServiceApiInstance = api.NewTasksServiceApi(ApiClientInstance)\n\ \ ctx := context.Background()\n\n \n taskExtId := \"^m1=:C0Cade9e-5ee2-9376-B2Cd-aA37c3a44b3a\"\ \n \n page_ := 0\n \n limit_ := 50\n\n\n request := tasks.ListTaskEntitiesRequest{\ \ TaskExtId: &taskExtId, Page_: &page_, Limit_: &limit_, Filter_: nil, Select_:\ \ nil }\n response, error := TasksServiceApiInstance.ListTaskEntities(ctx,\ \ &request)\n if error != nil {\n fmt.Println(error)\n \ \ return\n }\n data, _ := response.GetData().([]import1.EntityReference)\n\ \ fmt.Println(data)\n\n}\n\n" - lang: cURL source: |2+ curl --request GET \ --url "https://host:port/api/prism/v4.3/config/tasks/^pf+=:3E45B5AC-f4fF-b9Cd-C9FB-a2d0BfeFCfCC/affected-entities?$filter=string_sample_data&$limit=50&$page=0&$select=string_sample_data" \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - lang: Wget source: |2 wget --verbose \ --method GET \ --header 'Accept: application/json' \ --header 'Authorization:Basic $APP_ACCESS_TOKEN' \ - "https://host:port/api/prism/v4.3/config/tasks/^/aJq:3b3bdAFc-dAc8-AEaa-DCA1-BEE6c1dFcb2C/affected-entities?$filter=string_sample_data&$limit=50&$page=0&$select=string_sample_data" - lang: Csharp source: "\n\nusing Nutanix.TsksSDK.Client;\nusing Nutanix.TsksSDK.Api;\nusing\ \ Nutanix.TsksSDK.Model.Prism.V4.Config;\n\nnamespace CsharpSdkSample\n\ {\n class Program\n {\n static void Main(string[] args) {\n //\ \ Configure the client\n Configuration _config = new Configuration\n\ \ {\n // UserName to connect to the cluster\n Username\ \ = \"username\",\n // Password(SecureString) to connect to the cluster\ \ \n Password = Configuration.CreateSecurePassword(\"password\"),\n\ \ // IPv4/IPv6 address or FQDN of the cluster\n Host = \"\ localhost\",\n // Port used for the connection. \n Port =\ \ 9440,\n // Backoff period in seconds (exponential backoff: 2, 4,\ \ 8... seconds)\n BackOffPeriod = 2,\n // Max retry attempts\ \ while reconnecting on a loss of connection\n MaxRetryAttempts =\ \ 5\n };\n\n ApiClient client = new ApiClient(_config);\n\n \ \ TasksApi tasksApi = new TasksApi(client);\n\n String taskExtId\ \ = \"^:c6fE8e14-19df-d3D6-EbB8-5Ce64E855C7a\";\n int page = 0;\n \ \ int limit = 50;\n String filter = \"string_sample_data\";\n \ \ String select = \"string_sample_data\";\n\n // Create request\ \ object with parameters\n var request = new ListTaskEntitiesRequest\ \ {\n TaskExtId = taskExtId,\n Page = page,\n \ \ Limit = limit,\n Filter = filter,\n Select\ \ = select\n };\n try {\n ListTaskEntitiesApiResponse\ \ listTaskEntitiesApiResponse = tasksApi.ListTaskEntities(request);\n \ \ } catch (ApiException ex) {\n Console.WriteLine(ex.Message);\n\ \ }\n }\n }\n}\n" components: schemas: prism.v4.3.config.ListCategoriesApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.config.Category' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Get operation prism.v4.3.config.CategoryOld: description: | Denotes the type of a category.
There are three types of categories: SYSTEM, INTERNAL, and USER.
This field is immutable. allOf: - $ref: '#/components/schemas/prism.v4.3.config.CategorySummaryOld' - type: object properties: metadata: maxItems: 100 minItems: 0 type: array description: | Opaque metadata which can be associated to a category.
It is a list of key-value pairs.
For example, for a category 'California/SanJose' we can associate a geographical coordinate based metadata like: {'latitude': '37.3382° N', 'longitude': '121.8863° W'}. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field. items: $ref: '#/components/schemas/common.v1.0.config.KVPair' additionalProperties: false prism.v4.3.config.Category: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - required: - key - value type: object properties: key: maxLength: 64 pattern: "^[^$/,!\"#%'()*+:;=?\\\\|\\[\\]^&][^/,!\"#%'()*+:;=?\\\\|\\\ [\\]^&]{0,63}$" type: string description: | The key of a category when it is represented in `key:value` format. Constraints applicable when field is given in the payload during create and update: * A string of maxlength of 64 * First character must NOT be any of: `$` `/` `,` `!` `"` `#` `%` `'` `(` `)` `*` `+` `:` `;` `=` `?` `\` `|` `[` `]` `^` `&` * Remaining characters (0–63) must NOT include: `/` `,` `!` `"` `#` `%` `'` `(` `)` `*` `+` `:` `;` `=` `?` `\` `|` `[` `]` `^` `&` * Note: `$` is allowed after the first character It is a mandatory field in the payload of `createCategory` and `updateCategoryById` APIs.
This field can't be updated through `updateCategoryById` API. example: AvailabilityZone value: maxLength: 64 pattern: "^[^$/,!\"#%'()*+:;=?\\\\|\\[\\]^&][^/,!\"#%'()*+:;=?\\\\|\\\ [\\]^&]{0,63}$" type: string description: | The value of a category when it is represented in `key:value` format. Constraints applicable when the field is given in the payload during create and update: * A string of max length 64 * First character must NOT be any of: `$` `/` `,` `!` `"` `#` `%` `'` `(` `)` `*` `+` `:` `;` `=` `?` `\` `|` `[` `]` `^` `&` * Remaining characters (0–63) must NOT include: `/` `,` `!` `"` `#` `%` `'` `(` `)` `*` `+` `:` `;` `=` `?` `\` `|` `[` `]` `^` `&` * Note: `$` is allowed after the first character It is a mandatory input field in the payload of `createCategory` and `updateCategoryById` APIs.
This field can be updated through `updateCategoryById` API.
Updating the value will not change the extId of the category. example: APAC type: $ref: '#/components/schemas/prism.v4.3.config.CategoryType' description: pattern: "^.{0,512}$" type: string description: | A string consisting of the description of the category as defined by the user.
Description can be optionally provided in the payload of `createCategory` and `updateCategoryById` APIs.
Description field can be updated through `updateCategoryById` API.
The server does not validate this value nor does it enforce the uniqueness or any other constraints.
It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field. example: This category is meant to be used to enforce policies specific to availability zones. 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: | This field contains the UUID of a user who owns the category.
This field will be ignored if given in the payload of `createCategory` API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category.
This field can be updated through `updateCategoryById` API, in which case, should be provided, UUID of a valid user is present in the system.
Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace.
It is used for enabling RBAC access to self-owned categories. example: 10f43eeb-90a9-4e15-a6d0-272d3898e20f associations: maxItems: 100 minItems: 0 type: array description: | This field gives basic information about resources that are associated with the category.
The results present under this field summarize the counts of various kinds of resources associated with the category.
For more detailed information about the UUIDs of the resources, please look into the field `detailedAssociations`.
This field will be ignored, if given in the payload of `updateCategoryById` or `createCategory` APIs.
This field will not be present by default in `listCategories` API, unless the parameter $expand=associations is present in the URL. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.AssociationSummary' detailedAssociations: maxItems: 100 minItems: 0 type: array description: | This field gives detailed information about the resources which are associated with the category.
The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category.
This field will be ignored, if given in the payload of `updateCategoryById` or `createCategory` APIs.
This field will not be present by default in `listCategories` or `getCategoryById` APIs, unless the parameter $expand=detailedAssociations is present in the URL. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.AssociationDetail' additionalProperties: false prism.v4.3.config.CreateCategoryApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.Category oneOf: - $ref: '#/components/schemas/prism.v4.3.config.Category' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/categories Post operation prism.v4.3.config.CategoryType: type: string description: | Denotes the type of a category.
There are three types of categories: SYSTEM, INTERNAL, and USER.
This field is immutable. enum: - USER - SYSTEM - INTERNAL - $UNKNOWN - $REDACTED x-enumDescriptions: SYSTEM: | Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC bootup time. System-defined categories can't be updated or deleted. INTERNAL: | Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of `listCategories` and `getCategoryById` APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC bootup time. Internal categories can't be updated or deleted. USER: | These categories get created by users through the invocation of `createCategory` API. User-defined categories can be updated or deleted after creation. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.AssociationSummary: type: object properties: categoryId: type: string description: | External identifier for the given category that is used across all v4 apis/entities/resources where categories are referenced.
The field is in UUID format.
A type 4 UUID is generated during category creation. example: 0a817535-bca1-4e50-9395-f1970ebaa2db resourceType: $ref: '#/components/schemas/prism.v4.3.config.ResourceType' resourceGroup: $ref: '#/components/schemas/prism.v4.3.config.ResourceGroup' count: type: integer description: | Count of associations of a particular type of entity or policy example: 44 additionalProperties: false description: | This attribute contains a list of entities and policies that have been assigned the given category.
These entities are grouped by entity types (like VM or HOST) or policy types (like PROTECTION_POLICY or NGT_POLICY).
Each associated object contains the total entities belonging to the given entity type, count, category extId, and references (for example, for VM it will be VM UUID). prism.v4.3.config.AssociationDetail: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: categoryId: type: string description: | External identifier for the given category that is used across all v4 apis/entities/resources where categories are referenced.
The field is in UUID format.
A type 4 UUID is generated during category creation. example: 0a817535-bca1-4e50-9395-f1970ebaa2db resourceType: $ref: '#/components/schemas/prism.v4.3.config.ResourceType' resourceGroup: $ref: '#/components/schemas/prism.v4.3.config.ResourceGroup' resourceId: type: string description: | The UUID of the entity or policy associated with the particular category. example: b8f5e88d-32e2-44c6-aa37-a37ffdb557ef additionalProperties: false description: | This attribute contains a list of entities and policies that have been assigned the given category.
These entities are grouped by entity types (like VM or HOST) or policy types (like PROTECTION_POLICY or NGT_POLICY).
Each associated object contains the total entities belonging to the given entity type, count, category extId, and references (for example, for VM it will be VM UUID). prism.v4.3.config.ResourceType: type: string description: | An enum denoting the associated resource types.
Resource types are further grouped into two types: entity or policy. enum: - VM - MH_VM - IMAGE - SUBNET - CLUSTER - HOST - REPORT - MARKETPLACE_ITEM - BLUEPRINT - APP - VOLUMEGROUP - IMAGE_PLACEMENT_POLICY - NETWORK_SECURITY_POLICY - NETWORK_SECURITY_RULE - VM_HOST_AFFINITY_POLICY - VM_VM_ANTI_AFFINITY_POLICY - VM_DEPENDENCY_POLICY - TEMPLATE_PLACEMENT_POLICY - QOS_POLICY - NGT_POLICY - PROTECTION_RULE - ACCESS_CONTROL_POLICY - STORAGE_POLICY - IMAGE_RATE_LIMIT - RECOVERY_PLAN - BUNDLE - POLICY_SCHEMA - HOST_NIC - ACTION_RULE - VIRTUAL_NIC - VM_TEMPLATE - NETWORK_ENTITY_GROUP - VIRTUAL_NETWORK - $UNKNOWN - $REDACTED x-enumDescriptions: APP: A resource of type application. PROTECTION_RULE: A policy or rule of type protection rule. IMAGE_RATE_LIMIT: A resource of type rate limit. MH_VM: A resource of type Virtual Machine. BLUEPRINT: A resource of type blueprint. HOST: "A resource representing the underlying host, the machine hosting the\ \ hypervisors and VMs." IMAGE: A resource of type image. VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts. VM_DEPENDENCY_POLICY: "The VM Startup policies can be used to configure dependencies\ \ between groups of VMs. During an HA event, these policies would be honoured\ \ to start the VMs in the order as specified by the dependencies." ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API. VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts NGT_POLICY: A policy or rule of type NGT policy. RECOVERY_PLAN: A policy or rule of type recovery plan. MARKETPLACE_ITEM: A resource of type marketplace item. CLUSTER: "A resource of type cluster, usually refers to a PE cluster." NETWORK_SECURITY_RULE: A rule of type network security. HOST_NIC: A resource of type Physical NIC. ACTION_RULE: A policy of type Playbook. VIRTUAL_NIC: A resource of type Virtual NIC VIRTUAL_NETWORK: A resource of type Atlas Virtual Network. TEMPLATE_PLACEMENT_POLICY: A policy of type Template Placement Policy. VOLUMEGROUP: A resource of type volume group. NETWORK_ENTITY_GROUP: A resource of type Network Entity Group. REPORT: A resource of type report. STORAGE_POLICY: A policy or rule of type storage policy. $REDACTED: | Redacted value. BUNDLE: A resource of type bundle. QOS_POLICY: A policy or rule of type QoS policy. SUBNET: A resource of type network subnets. VM_TEMPLATE: A resource of type VM Template. VM: A resource of type Virtual Machine. $UNKNOWN: | Unknown value. NETWORK_SECURITY_POLICY: A policy of type network security. POLICY_SCHEMA: Policies like user-defined-alerts. IMAGE_PLACEMENT_POLICY: A policy of type image placement. prism.v4.3.config.ResourceGroup: type: string description: | An enum denoting the resource group.
Resources can be organised into either an entity or a policy. Hence, it supports two possible values: * ENTITY * POLICY enum: - ENTITY - POLICY - $UNKNOWN - $REDACTED x-enumDescriptions: POLICY: | A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on.
A category is generally associated with many entities.
The policy which is associated with this category, is then applied to those entities which are also associated with the same category. ENTITY: | A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on.
A category is generally associated with many entities.
A policy is then applied to these entities through the category. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.CategorySummaryOld: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - required: - name type: object properties: fqName: maxLength: 64 pattern: "^(?=.{1,260}$)[a-zA-Z]+([a-zA-Z0-9_.-]+)*(\\/([a-zA-Z]+([a-zA-Z0-9_.-]+)*))*$" type: string description: | The fully qualified name of this category. It is unique for each category.
It is a read-only field. The service constructs it from the name-parentExtId combination. An example of a fqName would be `Location/Bangalore`, where `Location` is the parent category's name and `Bangalore` is the category name.
This field is immutable.
example: string name: maxLength: 64 pattern: "^(?=.{1,64}$)[a-zA-Z]+([a-zA-Z0-9_.-]+)*$" type: string description: "The short name of this category. It may not be unique for\ \ each category.
\nIt is a mandatory field that must be specified\ \ inside the post/put request \nbody.
\nThis field is immutable.\n" example: string parentExtId: 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 parent category of this category (may be null if this category is not part of a hierarchy).
Each category can have at most one parent.
A parent cannot be deleted until all the children categories are deleted first.
Must be specified inside the post/put request body for child categories (if not specified, the service assumes the category to be a parent category).
This field is immutable. example: 052f9648-99be-4625-b22e-02fcad0d55ea userSpecifiedName: maxLength: 64 pattern: "^(?=.{1,64}$)[a-zA-Z]+([a-zA-Z0-9_.-]+)*$" type: string description: | The user-specified name is a string that the user can specify; with syntax and semantics controlled by the user. The server does not validate this value nor does it enforce the uniqueness or any other constraints.
It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field. Unlike the name of the categories, which are immutable, the user name can be changed by the user to meet their needs. example: string type: $ref: '#/components/schemas/prism.v4.3.config.CategoryType' description: maxLength: 512 pattern: "^.{0,512}$" type: string description: | A string consisting of the description of the category as defined by the user. The server does not validate this value nor does it enforce the uniqueness or any other constraints.
It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field. example: string associations: maxItems: 500 minItems: 0 type: array readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.CategoryAssociationSummaryOld' childCategories: maxItems: 50 minItems: 0 type: array description: | This attribute contains the list of all the categories for which this category is the parent.
The parentExtId attributes of each child category is set as the extId of this category.
Note that this list only contains the Summary view of each child category. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.CategorySummaryOld' 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: |- It is a read-only field inserted into category entity at the time of category creation, and which contains the UUID of the user who created this category. It is used for enabling authorization of a particular kind where the user has no access to view/create/update/delete any categories other than the category created by oneself. example: 4e46b0bf-06ea-41b3-aa7a-7f77bfbf66b3 additionalProperties: false prism.v4.3.config.CategoryAssociationSummaryOld: type: object properties: categoryId: type: string description: | External identifier for the given category. example: string resourceType: $ref: '#/components/schemas/prism.v4.3.config.ResourceType' resourceGroup: $ref: '#/components/schemas/prism.v4.3.config.ResourceGroup' count: type: integer description: | Denotes the type of a category.
There are three types of categories: SYSTEM, INTERNAL, and USER.
This field is immutable. example: 87 additionalProperties: false description: | This attribute contains a list of entities that have been assigned the given category.
These entities are grouped by entity types (like VM or HOST).
Each associated object contains the total entities belonging to the given entity type, and category extId. prism.v4.3.config.GetCategoryApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.Category oneOf: - $ref: '#/components/schemas/prism.v4.3.config.Category' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Get operation" prism.v4.3.config.UpdateCategoryApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Put operation" prism.v4.3.config.DeleteCategoryApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.error.ErrorResponse oneOf: - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/categories/{extId}\ \ Delete operation" prism.v4.3.error.AppMessage: type: object properties: message: type: string description: The message string. example: string severity: $ref: '#/components/schemas/common.v1.0.config.MessageSeverity' code: type: string description: "The code associated with this message. This string is typically\ \ prefixed with the namespace to which the endpoint belongs. For example:\ \ VMM-40000" example: string locale: type: string description: Locale for this message. The default locale would be 'en-US'. default: en_US errorGroup: type: string description: The error group associated with this message of severity ERROR. example: string argumentsMap: type: object additionalProperties: type: string description: The map of argument name to value. additionalProperties: false description: Message with associated severity describing status of the current operation. x-platform-generated: true common.v1.0.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.0.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 readOnly: true example: 09534c07-4acc-4028-b749-e503f8a9ce6c links: maxItems: 20 minItems: 0 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. readOnly: true items: $ref: '#/components/schemas/common.v1.0.response.ApiLink' additionalProperties: false common.v1.0.config.KVPair: type: object properties: name: maxLength: 128 minLength: 3 type: string description: | The key of the key-value pair. example: string value: description: The value associated with the key for this key-value pair oneOf: - type: string description: | A string value in a key-value pair. example: string - type: integer description: | An integer value in a key-value pair. example: 3 - type: boolean description: | An boolean value in a key-value pair. example: false - maxItems: 100 minItems: 0 type: array description: | A value in a key-value pair that represents a list of strings. items: type: string example: string - type: object additionalProperties: type: string description: | A value in a key-value pair that represents a map of string keys and values. - maxItems: 20 minItems: 0 type: array description: | A value in a key-value pair that represents an array of maps of string keys and values. items: $ref: '#/components/schemas/common.v1.0.config.MapOfStringWrapper' - maxItems: 100 minItems: 0 type: array description: | A value in a key-value pair that represents a list of integers. items: type: integer example: 3 additionalProperties: false description: | A map describing a set of keys and their corresponding values. common.v1.0.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. The system automatically assigns it, and it 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: dc0724e7-47a1-492e-85df-cb503451bb53 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.0.response.ApiLink: type: object properties: href: type: string description: | The URL at which the entity described by the link can be accessed. example: string rel: type: string description: | A name that identifies the relationship of the link to the object that is returned by the URL. The unique 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.0.config.MapOfStringWrapper: type: object properties: map: type: object additionalProperties: type: string description: | A map with string keys and values. additionalProperties: false description: | A wrapper schema containing a map with string keys and values. prism.v4.3.config.Reference: type: object properties: resourceId: 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 resource which uniquely identifies it. example: 1d462eaa-a515-4557-9598-7ebef975c6d1 additionalProperties: false description: | Contains references for entities given in EntityAssociation. This contains the entity ID and a list of links to fetch the associated entities. prism.v4.3.config.AssociationDetailOld: description: | This attribute contains a list of entities which have been assigned the given category.
These entities are grouped by entity types (like VM or HOST) or policy types (like PROTECTION_POLICY or NGT_POLICY).
Each associated object contains the total entities belonging to the given entity type, category extId, and references (for example, for VM it will be VM UUID). allOf: - $ref: '#/components/schemas/prism.v4.3.config.CategoryAssociationSummaryOld' - type: object properties: resourceReferences: maxItems: 500 minItems: 0 type: array items: $ref: '#/components/schemas/prism.v4.3.config.Reference' additionalProperties: false prism.v4.3.error.ErrorResponse: type: object properties: error: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' - $ref: '#/components/schemas/prism.v4.3.error.SchemaValidationError' additionalProperties: false description: An error response indicates that the operation has failed either due to a client error(4XX) or server error(5XX). Please look at the HTTP status code and namespace specific error code and error message for further details. x-platform-generated: true prism.v4.3.error.MessageSeverity: type: string description: Enum schema MessageSeverity enum: - INFO - WARNING - ERROR - $UNKNOWN - $REDACTED x-platform-generated: true 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 prism.v4.3.error.SchemaValidationError: type: object properties: timestamp: type: string description: Timestamp of the response. format: date-time example: 2009-09-23T14:30:00-07:00 statusCode: type: integer description: The HTTP status code of the response. example: 36 error: type: string description: The generic error message for the response. example: string path: type: string description: API path on which the request was made. example: string validationErrorMessages: type: array description: List of validation error messages items: $ref: '#/components/schemas/prism.v4.3.error.SchemaValidationErrorMessage' additionalProperties: false description: This schema is generated from SchemaValidationError.java x-platform-generated: true prism.v4.3.error.SchemaValidationErrorMessage: type: object properties: location: type: string description: "The part of the request that failed validation. Validation\ \ can fail for path, query parameters, and request body." example: string message: type: string description: The detailed message for the validation error. example: string attributePath: type: string description: The path of the attribute that failed validation in the schema. example: string additionalProperties: false description: This schema is generated from SchemaValidationErrorMessage.java x-platform-generated: true common.v1.0.response.ApiResponseMetadata: type: object properties: flags: maxItems: 20 minItems: 0 type: array description: | An array of flags that may indicate the status of the response. For example, a flag with the name 'isPaginated' and value 'false', indicates that the response is not paginated. items: $ref: '#/components/schemas/common.v1.0.config.Flag' links: maxItems: 20 minItems: 0 type: array description: | An array of HATEOAS style links for the response that may also include pagination links for list operations. items: $ref: '#/components/schemas/common.v1.0.response.ApiLink' totalAvailableResults: type: integer description: | The total number of entities that are available on the server for this type. format: int32 example: 41 messages: maxItems: 20 minItems: 0 type: array description: | Information, Warning or Error messages that might provide additional contextual information related to the operation. items: $ref: '#/components/schemas/common.v1.0.config.Message' extraInfo: maxItems: 20 minItems: 0 type: array description: | An array of entity-specific metadata items: $ref: '#/components/schemas/common.v1.0.config.KVPair' additionalProperties: false description: | The metadata associated with an API response. This value is always present and minimally contains the self-link for the API request that produced this response. It also contains pagination data for the paginated requests. common.v1.0.config.Flag: type: object properties: name: maxLength: 128 minLength: 3 type: string description: | Name of the flag. example: string value: type: boolean description: | Value of the flag. 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 object must have an attribute called x-bounded-map-keys that tells which flags are actually present for that entity. common.v1.0.config.Message: type: object properties: code: type: string description: | A code that uniquely identifies a message. example: string message: type: string description: | The description of the message. example: string locale: type: string description: | The locale for the message description. default: en_US severity: $ref: '#/components/schemas/common.v1.0.config.MessageSeverity' additionalProperties: false common.v1.0.config.MessageSeverity: type: string description: | The message severity. enum: - INFO - WARNING - ERROR - $UNKNOWN - $REDACTED x-enumDescriptions: ERROR: | Error indicating failed completion. INFO: | Information about successful completion. $UNKNOWN: | Unknown value. WARNING: | Warning indicating future error. $REDACTED: | Redacted value. prism.v4.3.management.ListRestorableDomainManagersApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.management.RestorableDomainManager' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers\ \ Get operation" prism.v4.3.management.RestorableDomainManager: description: | The backup target for the domain manager, which can be either a cluster or an object store. allOf: - $ref: '#/components/schemas/prism.v4.3.config.DomainManager' - type: object additionalProperties: false prism.v4.3.management.ListRestorePointsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.management.RestorePoint' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points\ \ Get operation" prism.v4.3.management.RestorePoint: description: | The restore point represents the state of the domain manager at a specific time. In the event of a disaster, for example, it can be used to restore the domain manager to this state. Each restore point captures key details such as the time it was created and the domain manager configuration required to restore the system to a previous state. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: creationTime: type: string description: | The UTC date and time, in ISO 8601 format, at which the restore point was created. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 domainManager: $ref: '#/components/schemas/prism.v4.3.config.DomainManager' additionalProperties: false prism.v4.3.management.GetRestorePointApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.management.RestorePoint oneOf: - $ref: '#/components/schemas/prism.v4.3.management.RestorePoint' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}\ \ Get operation" prism.v4.3.management.ListBackupTargetsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - maxItems: 4 type: array items: $ref: '#/components/schemas/prism.v4.3.management.BackupTarget' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Get operation" prism.v4.3.management.BackupTarget: required: - location description: | The backup target for the domain manager, which can be either a cluster or an object store. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: location: required: - $objectType type: object properties: $objectType: type: string example: prism.v4.management.ClusterLocation description: | The location of the backup target. For example, a cluster or an object store endpoint such as AWS s3. oneOf: - $ref: '#/components/schemas/prism.v4.3.management.ClusterLocation' - $ref: '#/components/schemas/prism.v4.3.management.ObjectStoreLocation' lastSyncTime: type: string description: | The time when the domain manager last synchronised or copied its configuration data to the backup target. This field refreshes every 30 minutes. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 isBackupPaused: type: boolean description: | Whether or not the backup is paused on the specified cluster. readOnly: true example: false backupPauseReason: type: string description: | Specifies a reason why the backup might have paused. This is empty if the isBackupPaused field is false. readOnly: true example: The backup is paused due to an upgrade in progress. It will be automatically resumed when the upgrade is complete. additionalProperties: false prism.v4.3.management.CreateBackupTargetApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets\ \ Post operation" prism.v4.3.management.ClusterLocation: required: - config type: object properties: config: required: - $objectType type: object properties: $objectType: type: string example: prism.v4.management.ClusterReference description: "Cluster config for the backup target or recovery source. Cluster\ \ reference\nto be provided to recover Domain Manager from a registered\ \ cluster and remote \ncluster spec to be provided to recover Domain Manager\ \ from a non-registered\ncluster. Only Cluster reference to be supported\ \ while performing backup.\n" oneOf: - $ref: '#/components/schemas/prism.v4.3.management.ClusterReference' - $ref: '#/components/schemas/prism.v4.3.management.RemoteClusterSpec' additionalProperties: false description: | Model which contains the information about the backup cluster. prism.v4.3.management.ObjectStoreLocation: required: - providerConfig type: object properties: providerConfig: required: - $objectType properties: $objectType: type: string example: prism.v4.management.AWSS3Config description: | Object store provider represents the object store used to store backup and trigger recovery. oneOf: - $ref: '#/components/schemas/prism.v4.3.management.AWSS3Config' - $ref: '#/components/schemas/prism.v4.3.management.NutanixObjectsConfig' - $ref: '#/components/schemas/prism.v4.3.management.GenericS3Config' backupPolicy: $ref: '#/components/schemas/prism.v4.3.management.BackupPolicy' additionalProperties: false description: | Model which contains the information about the object store endpoint where the backup exists. It contains information like the object store endpoint address, endpoint flavour and last sync timestamp. prism.v4.3.management.AWSS3Config: description: | The base model of S3 object store endpoint where the domain manager is backed up. allOf: - $ref: '#/components/schemas/prism.v4.3.management.S3Config' - type: object properties: credentials: $ref: '#/components/schemas/prism.v4.3.management.AccessKeyCredentials' additionalProperties: false prism.v4.3.management.NutanixObjectsConfig: required: - connectionConfig description: | The base model of Nutanix Objects object store endpoint where the domain manager is backed up. allOf: - $ref: '#/components/schemas/prism.v4.3.management.S3Config' - type: object properties: connectionConfig: $ref: '#/components/schemas/prism.v4.3.management.ConnectionConfig' credentials: required: - $objectType properties: $objectType: type: string example: prism.v4.management.AccessKeyCredentials description: | This object is a container for credentials to access the object store. writeOnly: true oneOf: - $ref: '#/components/schemas/prism.v4.3.management.AccessKeyCredentials' additionalProperties: false prism.v4.3.management.GenericS3Config: required: - connectionConfig description: | S3 compliant bucket configuration to be used for backing up domain manager. allOf: - $ref: '#/components/schemas/prism.v4.3.management.S3Config' - type: object properties: connectionConfig: $ref: '#/components/schemas/prism.v4.3.management.ConnectionConfig' credentials: required: - $objectType properties: $objectType: type: string example: prism.v4.management.AccessKeyCredentials description: | This object is a container for credentials to access the object store. writeOnly: true oneOf: - $ref: '#/components/schemas/prism.v4.3.management.AccessKeyCredentials' additionalProperties: false prism.v4.3.management.BackupPolicy: required: - rpoInMinutes type: object properties: rpoInMinutes: maximum: 1440 minimum: 60 type: integer description: | RPO interval in minutes at which the backup is taken. format: int32 example: 74 additionalProperties: false description: Backup policy for the object store provided. prism.v4.3.management.S3Config: required: - bucketName type: object properties: bucketName: maxLength: 63 minLength: 3 type: string description: | The bucket name of the object store endpoint where the backup data of the domain manager is stored. example: pc-bucket-name region: maxLength: 63 type: string description: | The region name of the object store endpoint where the backup data of the domain manager is stored. default: us-east-1 additionalProperties: false description: | The endpoint of the object store s3 where the domain manager is backed up. prism.v4.3.management.AccessKeyCredentials: required: - accessKeyId - secretAccessKey type: object properties: accessKeyId: maxLength: 128 minLength: 16 type: string description: Access key ID of the object store provided for the backup target. example: AKIAZ26UIJS6DRKHPPF4 secretAccessKey: maxLength: 1024 type: string description: | Secret access key of the object store provided for the backup target. format: password example: L1feKeOuNErB0SCULU1XrGKS5gWAGb1RQp/Lxc3y additionalProperties: false description: Secret credentials model for the object store containing access key ID and secret access key. prism.v4.3.management.ConnectionConfig: required: - ipAddressOrHostname type: object properties: ipAddressOrHostname: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' port: maximum: 65535 minimum: 0 type: integer description: | The port of the object store endpoint where backup data of domain manager is stored. default: 443 shouldSkipCertificateValidation: type: boolean description: | Skips the verification of the certificate during communication with the object store endpoint. default: false certificate: maxLength: 42667 type: string description: | Certificate which will be used while validating the object store identity. example: string hasCustomCertificate: type: boolean description: Indicates whether a custom certificate were configured or not. nullable: true readOnly: true example: true additionalProperties: false description: | Connection configuration to be used when making a connection with the object store. prism.v4.3.management.GetBackupTargetApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.management.BackupTarget oneOf: - $ref: '#/components/schemas/prism.v4.3.management.BackupTarget' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Get operation" prism.v4.3.management.UpdateBackupTargetApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Put operation" prism.v4.3.management.DeleteBackupTargetApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/backup-targets/{extId}\ \ Delete operation" prism.v4.3.management.RestoreSpec: required: - domainManager type: object properties: domainManager: $ref: '#/components/schemas/prism.v4.3.config.DomainManager' additionalProperties: false description: | Restore specs of a domain manager to be deployed on the cluster during the restore operation. prism.v4.3.management.RestoreApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{restoreSourceExtId}/restorable-domain-managers/{restorableDomainManagerExtId}/restore-points/{extId}/$actions/restore\ \ Post operation" prism.v4.3.management.RestoreSource: required: - location description: | The backup target for the domain manager, which can be either a cluster or an object store. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: location: required: - $objectType type: object properties: $objectType: type: string example: prism.v4.management.ClusterLocation description: | The location of the backup target. For example, a cluster or an object store endpoint such as AWS s3. oneOf: - $ref: '#/components/schemas/prism.v4.3.management.ClusterLocation' - $ref: '#/components/schemas/prism.v4.3.management.ObjectStoreLocation' additionalProperties: false prism.v4.3.management.CreateRestoreSourceApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.management.RestoreSource oneOf: - $ref: '#/components/schemas/prism.v4.3.management.RestoreSource' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/management/restore-sources Post operation prism.v4.3.management.GetRestoreSourceApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.management.RestoreSource oneOf: - $ref: '#/components/schemas/prism.v4.3.management.RestoreSource' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Get operation" prism.v4.3.management.DeleteRestoreSourceApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.error.ErrorResponse oneOf: - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/restore-sources/{extId}\ \ Delete operation" prism.v4.3.protectpc.EligibleClusterList: type: object properties: eligibleClusterList: type: array items: $ref: '#/components/schemas/prism.v4.3.protectpc.EligibleCluster' additionalProperties: false description: | An object containing a list of eligible cluster object. These are the eligible cluster for which PC backup is possible. prism.v4.3.protectpc.ApiError: type: object properties: errorMessageList: type: array description: The error message field where the error response will be put. items: type: string example: string errorType: type: string description: "The type of error, like INVALID_INPUT, INTERNAL_SERVER_ERROR,\ \ etc." example: string additionalProperties: false description: | The error response that we want to return to the user. prism.v4.3.protectpc.EligibleCluster: type: object properties: clusterUuid: 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 eligible PE(cluster). example: dc272b3d-d7b6-4fc2-a15e-ecd31b618459 clusterName: type: string description: | Name of the eligible PE(cluster). example: string isHostingPe: type: boolean description: | Whether the candidate PE was hosting PC. example: false backedUpEntitiesCountSupported: type: integer description: | The amount of entities which can be backed up to the PE from PC. format: int64 example: 71 additionalProperties: false description: | Eligible cluster object for PC backup. Containing some basic properties like cluster_uuid, cluster_name, remainingStorage, totalStorage prism.v4.3.protectpc.BackupTargets: type: object properties: clusterUuidList: type: array description: | List of PE cluster uuid. 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: 4f333294-2a1d-4cf5-9a6c-4970a4b21275 objectStoreEndpointList: type: array items: $ref: '#/components/schemas/prism.v4.3.protectpc.PcObjectStoreEndpoint' additionalProperties: false description: | List of pe cluster uuid or object store endpoints which needs to be provided while making a post request, to add a PE or object store as a backup for the PC data. prism.v4.3.protectpc.PcObjectStoreEndpoint: type: object properties: endpointAddress: type: string description: | The endpoint address of the object store where backup data of Prism Central is present. nullable: true example: string endpointFlavour: $ref: '#/components/schemas/prism.v4.3.protectpc.PcEndpointFlavour' endpointCredentials: $ref: '#/components/schemas/prism.v4.3.protectpc.PcEndpointCredentials' rpoSeconds: type: integer description: | A RPO value in seconds to be configured. format: int32 nullable: true example: 26 ipAddressOrDomain: type: string description: | The ip address or domain of the object store endpoint where backup data of Prism Central is stored. nullable: true example: string port: type: string description: | The port of the object store endpoint where backup data of Prism Central is stored. nullable: true default: "443" bucket: type: string description: | The bucket name of the object store endpoint where backup data of Prism Central is stored. nullable: true example: string region: type: string description: | The region name of the object store endpoint where backup data of Prism Central is stored. nullable: true default: us-east-1 skipTLS: type: boolean description: | Skip the verification of TLS certificates during communication with object store endpoint. default: false backupRetentionDays: minimum: 1 type: integer description: "Retention days configured for backup in Object Store. \n" format: int32 default: 31 skipCertificateValidation: type: boolean description: | Skip the verification of certificate during communication with object store endpoint default: false hasCustomCertificate: type: boolean description: | Whether custom certificate provided or not. nullable: true readOnly: true example: false additionalProperties: false description: | The endpoint of the object store where backup data of Prism Central is present. nullable: true prism.v4.3.protectpc.PcEndpointFlavour: type: string enum: - kS3 - kOBJECTS - kGENERICS3 - $UNKNOWN prism.v4.3.protectpc.PcEndpointCredentials: type: object properties: accessKey: maxLength: 128 minLength: 16 type: string description: | AccessKey for the endpoint flavor nullable: true example: string secretAccessKey: maxLength: 1024 type: string description: | SecretAccessKey for the endpoint flavor. nullable: true example: string certificate: type: string description: | Certificate which will be used while validating the object store identity nullable: true example: string additionalProperties: false description: | This object consists of accessKey, secretAccessKey, certificate for a given entityId. nullable: true prism.v4.3.protectpc.ApiSuccess: type: object properties: message: type: string description: The success message field where the success response message will be put. example: string additionalProperties: false description: | The success response that we want to return to the user. prism.v4.3.protectpc.BackupTargetsInfo: type: object properties: peInfoList: type: array items: $ref: '#/components/schemas/prism.v4.3.protectpc.PEInfo' objectStoreEndpointInfoList: type: array items: $ref: '#/components/schemas/prism.v4.3.protectpc.ObjectStoreEndpointInfo' additionalProperties: false description: Model to contain information regarding PE's which are already added as replicas. It is a list of PEInfo model. prism.v4.3.protectpc.PEInfo: type: object properties: peClusterId: 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: PE cluster uuid. A unique id corresponding to the cluster. example: 308bfcc9-7f9e-4152-bd07-ce76c5b1b4e8 peName: type: string description: A human redable name of the PE cluster. example: string lastSyncTimestamp: type: integer description: The last sync time signifies the time at which the backup was last synced to PE. This time will be updated every 30min. format: int64 example: 5 isBackupPaused: type: boolean description: Tells whether the backup is paused on the given PE or not. example: true pauseBackupMessage: type: string description: Tells the reason why the backup might be paused. Will be empty if isBackupPaused field is false. example: string additionalProperties: false description: "Model to contain the information of the replica PE. It contains\ \ information like PE clusterUuid, PE name, and lastSyncTimestamp." prism.v4.3.protectpc.ObjectStoreEndpointInfo: type: object properties: objectStoreEndpoint: $ref: '#/components/schemas/prism.v4.3.protectpc.PcObjectStoreEndpoint' lastSyncTimestamp: type: integer description: The last sync time signifies the time at which the backup was last synced to PE. This time will be updated every 30min. format: int64 example: 25 isBackupPaused: type: boolean description: Tells whether the backup is paused on the given PE or not. example: true pauseBackupMessage: type: string description: Tells the reason why the backup might be paused. Will be empty if isBackupPaused field is false. example: string entityId: 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 unique id corresponding to the object store. example: 0675a649-38b4-4517-b540-8aa88acd6e52 additionalProperties: false description: "Model to contain the information of the replica ObjectStoreEndpoints.\ \ It contains information like ObjectStore endpointAddress, endpointFlavour,\ \ and lastSyncTimestamp." prism.v4.3.protectpc.RpoConfig: type: object properties: rpoSeconds: type: integer description: | A RPO value in seconds to be configured. format: int32 example: 23 additionalProperties: false description: | Object consisting of rpo value to be configured for the given entityId. prism.v4.3.protectpc.FailedRecoveryPointsStats: type: object properties: totalFailedRecoveryPoints: type: integer description: | Count of failed recovery points in last 30 days. format: int64 example: 40 failedRecoveryPoints: type: array items: $ref: '#/components/schemas/prism.v4.3.protectpc.FailedRecoveryPointDetails' additionalProperties: false description: | Contains the total failed recovery counts and stats details list. prism.v4.3.protectpc.FailedRecoveryPointDetails: type: object properties: recoveryPointTimestamp: type: integer description: | Timestamp at which backup failed for defined object store. format: int64 example: 7 rpoSeconds: type: integer description: | A RPO value in seconds to be configured. format: int32 example: 78 message: type: string description: | Failure reason because of which backup failed for that particular timestamp. example: string additionalProperties: false description: | Failed recovery stats details i.e timestamp, rpo and failure message. prism.v4.3.protectpc.ReplicaInfo: type: object properties: peClusterIpList: type: array nullable: true items: type: string description: | Ip of the PE3 from which the backup trust data is required to be restored. example: string peClusterId: type: string description: PE cluster uuid. A unique id corresponding to the cluster. nullable: true example: string backupUuid: type: string description: | BackupUuid for the particular backup for which recovery is triggered. nullable: true example: string objectStoreEndpoint: $ref: '#/components/schemas/prism.v4.3.protectpc.PcObjectStoreEndpoint' additionalProperties: false description: | Contains all the IPs of the Replica PEs and PE cluster uuid which is required to make request on the PE3. Recovered PC will try to call all of them sequentially if it does not work. prism.v4.3.protectpc.PcRestoreRootTask: type: object properties: taskUuid: 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: Task uuid of the root PC restore task. example: 5caa8dc4-b2e7-4d23-818b-1103eedf78ad additionalProperties: false description: Model to return the root task uuid created at PC for the recovery flow. As success this uuid will be returned telling that the task has been initiated and now the PE have to wait until the tasks finishes. prism.v4.3.protectpc.PcvmRestoreFiles: type: object properties: fileList: type: array items: $ref: '#/components/schemas/prism.v4.3.protectpc.PcvmRestoreFile' additionalProperties: false description: | List of files to be restored in new PC. prism.v4.3.protectpc.PcvmRestoreFile: type: object properties: filePath: type: string description: | Path of the file to be restored. example: string fileContent: type: string description: | Contents of the file to be restored. example: string isEncrypted: type: boolean description: | Whether the file is encrypted. example: true keyId: type: string example: string encryptionVersion: type: string example: string additionalProperties: false description: | File object containing file path and content. prism.v4.3.protectpc.RecoveryStatus: type: object properties: recoveryState: type: string description: | Recovery state of recovery task. Possible values could be IDFDataRestore, WaitForProcessesToReconcile. example: string recoveryStateTitle: type: string description: | Recovery state title, the message that appears to the user. example: string overallCompletionPercentage: type: int description: | Overall completion percentage of task. additionalProperties: false description: | An object containing Recovery state and overall completion percentage of recovery task. prism.v4.3.management.ClusterReference: 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: Cluster UUID of a remote cluster. example: 5789ffbc-1551-4d90-92ee-f858cba7db08 name: maxLength: 80 minLength: 1 type: string description: Name of the cluster. readOnly: true example: string additionalProperties: false description: Cluster reference of the remote cluster to be connected. prism.v4.3.management.RemoteClusterSpec: required: - address - credentials type: object properties: address: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' credentials: $ref: '#/components/schemas/prism.v4.3.management.Credentials' additionalProperties: false description: "Address configuration of a remote cluster. It requires the address\ \ of the remote, that is an IP or domain name along with the basic authentication\ \ credentials." common.v1.0.config.IPAddressOrFQDN: type: object properties: ipv4: $ref: '#/components/schemas/common.v1.0.config.IPv4Address' ipv6: $ref: '#/components/schemas/common.v1.0.config.IPv6Address' fqdn: $ref: '#/components/schemas/common.v1.0.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.0.config.BasicAuth: required: - password - username type: object properties: username: maxLength: 256 minLength: 3 type: string description: | Username required for the basic auth scheme. As per [RFC 2617](https://datatracker.ietf.org/doc/html/rfc2617) usernames might be case sensitive. example: test-user password: maxLength: 256 minLength: 3 type: string description: | Password required for the basic auth scheme. format: password example: '**************' additionalProperties: false description: | An authentication scheme that requires the client to present a username and password. The server will service the request only if it can validate the user-ID and password for the protection space of the Request-URI. common.v1.0.config.IPv4Address: required: - value 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 description: | The IPv4 address of the host. example: 248.218.207.162 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 description: | An unique address that identifies a device on the internet or a local network in IPv4 format. common.v1.0.config.IPv6Address: required: - value 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 description: | The IPv6 address of the host. example: df8d:dfd8:39c6:c4ea:e35c:0ba4:eaeb:6ec9 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 description: | An unique address that identifies a device on the internet or a local network in IPv6 format. common.v1.0.config.FQDN: type: object properties: value: pattern: "^([a-zA-Z0-9À-ÿ]+(?:-[a-zA-Z0-9À-ÿ]+)*\\.)+[a-zA-ZÀ-ÿ]{2,63}$" type: string description: | The fully qualified domain name of the host. example: string additionalProperties: false description: | A fully qualified domain name that specifies its exact location in the tree hierarchy of the Domain Name System. prism.v4.3.management.Credentials: required: - authentication type: object properties: authentication: $ref: '#/components/schemas/common.v1.0.config.BasicAuth' additionalProperties: false description: Credentials to connect to a remote cluster. prism.v4.3.config.DomainManager: description: Domain manager (Prism Central) details. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - required: - config - network type: object properties: config: $ref: '#/components/schemas/prism.v4.3.config.DomainManagerClusterConfig' isRegisteredWithHostingCluster: type: boolean description: "Boolean value indicating if the domain manager (Prism Central)\ \ is registered with the hosting cluster, that is, Prism Element." readOnly: true example: false network: $ref: '#/components/schemas/prism.v4.3.config.DomainManagerNetwork' hostingClusterExtId: 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 cluster hosting the domain manager (Prism Central) instance. example: 6a41a26a-7593-42c2-a462-15b65c7daa6d shouldEnableHighAvailability: type: boolean description: This configuration enables Prism Central to be deployed in scale-out mode. default: false nodeExtIds: maxItems: 3 minItems: 1 uniqueItems: true type: array description: Domain manager (Prism Central) nodes external identifier. readOnly: true 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: fd28bacb-7300-421e-958c-dfd70e783f9a createdTime: type: string description: The timestamp when the domain manager (Prism Central) was created. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 additionalProperties: false clustermgmt.v4.2.config.ClusterConfig: type: object properties: shouldEnableLockdownMode: type: boolean description: A boolean value indicating whether to enable lockdown mode for a cluster. example: true buildInfo: $ref: '#/components/schemas/clustermgmt.v4.2.config.BuildInfo' additionalProperties: false description: Cluster Configuration required for a cluster to function properly. clustermgmt.v4.2.config.ClusterNetwork: type: object properties: externalAddress: $ref: '#/components/schemas/common.v1.0.config.IPAddress' nameServers: maxItems: 1024 minItems: 0 uniqueItems: true type: array description: "List of name servers on a cluster. This is a part of payload\ \ for both clusters create and update operations. Currently, only IPv4\ \ address and FQDN (fully qualified domain name) values are supported\ \ for the create operation." items: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' ntpServers: maxItems: 1024 minItems: 0 uniqueItems: true type: array description: "List of NTP servers on a cluster. This is a part of payload\ \ for both cluster create and update operations. Currently, only IPv4\ \ address and FQDN (fully qualified domain name) values are supported\ \ for the create operation." items: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' fqdn: pattern: "^([a-zA-Z0-9À-ÿ]+(?:-[a-zA-Z0-9À-ÿ]+)*\\.)+[a-zA-ZÀ-ÿ]{2,63}$" type: string description: Cluster fully qualified domain name. This is part of payload for cluster update operation only. readOnly: true example: string httpProxyConfig: maxItems: 10 minItems: 0 type: array description: List of HTTP Proxy server configuration needed to access a cluster which is hosted behind a HTTP Proxy to not reveal its identity. items: $ref: '#/components/schemas/clustermgmt.v4.2.config.HttpProxyConfig' httpProxyWhiteListConfig: maxItems: 10 minItems: 0 type: array description: Targets HTTP traffic to which is exempted from going through the configured HTTP Proxy. items: $ref: '#/components/schemas/clustermgmt.v4.2.config.HttpProxyWhiteListConfig' additionalProperties: false description: Network details of a cluster. vmm.v4.2.ahv.config.CloudInit: type: object properties: datasourceType: $ref: '#/components/schemas/vmm.v4.2.ahv.config.CloudInitDataSourceType' metadata: maxLength: 32000 type: string description: The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded. example: string cloudInitScript: required: - $objectType properties: $objectType: type: string example: vmm.v4.ahv.config.Userdata description: The script to use for cloud-init. oneOf: - $ref: '#/components/schemas/vmm.v4.2.ahv.config.Userdata' - $ref: '#/components/schemas/vmm.v4.2.ahv.config.CustomKeyValues' additionalProperties: false description: "If this field is set, the guest will be customized using cloud-init.\ \ Either user_data or custom_key_values should be provided. If custom_key_ves\ \ are provided then the user data will be generated using these key-value\ \ pairs." common.v1.0.config.IpRange: type: object properties: begin: $ref: '#/components/schemas/common.v1.0.config.IPAddress' end: $ref: '#/components/schemas/common.v1.0.config.IPAddress' additionalProperties: false description: | Range of consecutive IP addresses that can be assigned to a specific Subnet.The size of the IP range is determined by the subnet mask. common.v1.0.config.IPAddress: type: object properties: ipv4: $ref: '#/components/schemas/common.v1.0.config.IPv4Address' ipv6: $ref: '#/components/schemas/common.v1.0.config.IPv6Address' additionalProperties: false description: | An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format. clustermgmt.v4.2.config.BuildInfo: type: object properties: version: type: string description: Software version. example: string additionalProperties: false description: Currently representing the build information to be used for the cluster creation. clustermgmt.v4.2.config.HttpProxyConfig: required: - name type: object properties: ipAddress: $ref: '#/components/schemas/common.v1.0.config.IPAddress' port: type: integer description: HTTP Proxy server port configuration needed to access a cluster which is hosted behind a HTTP Proxy to not reveal its identity. format: int32 example: 30 username: maxLength: 64 type: string description: HTTP Proxy server username needed to access a cluster which is hosted behind a HTTP Proxy to not reveal its identity. example: string password: type: string description: HTTP Proxy server password needed to access a cluster which is hosted behind a HTTP Proxy to not reveal its identity. example: string name: maxLength: 64 type: string description: HTTP Proxy server name configuration needed to access a cluster which is hosted behind a HTTP Proxy to not reveal its identity. example: string proxyTypes: maxItems: 3 minItems: 0 type: array description: List of HTTP proxy types. items: $ref: '#/components/schemas/clustermgmt.v4.2.config.HttpProxyType' additionalProperties: false description: HTTP Proxy server configuration needed to access a cluster which is hosted behind a HTTP Proxy to not reveal its identity. clustermgmt.v4.2.config.HttpProxyWhiteListConfig: required: - target - targetType type: object properties: targetType: $ref: '#/components/schemas/clustermgmt.v4.2.config.HttpProxyWhiteListTargetType' target: type: string description: Target's identifier which is exempted from going through the configured HTTP Proxy. example: string additionalProperties: false description: Targets HTTP traffic to which is exempted from going through the configured HTTP Proxy. clustermgmt.v4.2.config.HttpProxyType: type: string description: HTTP proxy type which is needed to access a cluster hosted behind a HTTP Proxy. enum: - HTTP - HTTPS - SOCKS - $UNKNOWN - $REDACTED x-enumDescriptions: HTTPS: HTTPS proxy protocol type. SOCKS: SOCKS proxy protocol type. HTTP: HTTP proxy protocol type. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. clustermgmt.v4.2.config.HttpProxyWhiteListTargetType: type: string description: Type of the target which is exempted from going through the configured HTTP Proxy. enum: - IPV4_ADDRESS - IPV6_ADDRESS - IPV4_NETWORK_MASK - DOMAIN_NAME_SUFFIX - HOST_NAME - $UNKNOWN - $REDACTED x-enumDescriptions: IPV6_ADDRESS: IPV6 address. HOST_NAME: Name of the host. DOMAIN_NAME_SUFFIX: Domain Name Suffix required for http proxy whitelist. IPV4_NETWORK_MASK: Network Mask of the IpV4 family. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. IPV4_ADDRESS: IPV4 address. vmm.v4.2.ahv.config.CloudInitDataSourceType: type: string description: "Type of datasource. Default: CONFIG_DRIVE_V2" enum: - CONFIG_DRIVE_V2 - $UNKNOWN - $REDACTED x-enumDescriptions: CONFIG_DRIVE_V2: The type of datasource for cloud-init is Config Drive V2. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. vmm.v4.2.ahv.config.Userdata: type: object properties: value: maxLength: 128000 type: string description: The value for the cloud-init user_data. example: string additionalProperties: false description: "The contents of the user_data configuration for cloud-init. This\ \ can be formatted as YAML, JSON, or could be a shell script. The value must\ \ be base64 encoded." vmm.v4.2.ahv.config.CustomKeyValues: type: object properties: keyValuePairs: maxItems: 32 minItems: 0 type: array description: The list of the individual KeyValuePair elements. items: $ref: '#/components/schemas/common.v1.0.config.KVPair' additionalProperties: false description: A collection of key/value pairs. prism.v4.3.config.DomainManagerClusterConfig: required: - buildInfo - name - size description: Domain manager (Prism Central) cluster configuration details. allOf: - $ref: '#/components/schemas/clustermgmt.v4.2.config.ClusterConfig' - type: object properties: name: maxLength: 80 minLength: 1 type: string description: Name of the domain manager (Prism Central). example: pc_nutanix_01 size: $ref: '#/components/schemas/prism.v4.3.config.Size' bootstrapConfig: $ref: '#/components/schemas/prism.v4.3.config.BootstrapConfig' credentials: maxItems: 5 minItems: 1 uniqueItems: true type: array description: The credentials consist of a username and password for a particular user like admin. Users can pass the credentials of admin users currently which will be configured in the create domain manager operation. writeOnly: true items: $ref: '#/components/schemas/common.v1.0.config.BasicAuth' resourceConfig: $ref: '#/components/schemas/prism.v4.3.config.DomainManagerResourceConfig' additionalProperties: false prism.v4.3.config.DomainManagerNetwork: required: - externalNetworks - nameServers - ntpServers description: Domain manager (Prism Central) network configuration details. allOf: - $ref: '#/components/schemas/clustermgmt.v4.2.config.ClusterNetwork' - type: object properties: internalNetworks: maxItems: 10 minItems: 1 uniqueItems: true type: array description: This configuration is used to internally manage Prism Central network. writeOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.BaseNetwork' externalNetworks: maxItems: 1 minItems: 1 uniqueItems: true type: array description: This configuration is used to manage Prism Central. items: $ref: '#/components/schemas/prism.v4.3.config.ExternalNetwork' capability: $ref: '#/components/schemas/prism.v4.3.config.NetworkCapability' additionalProperties: false prism.v4.3.config.Size: type: string description: "Domain manager (Prism Central) size is an enumeration of starter,\ \ small, large, or extra large starter values." enum: - STARTER - SMALL - LARGE - EXTRALARGE - $UNKNOWN - $REDACTED x-enumDescriptions: SMALL: Domain manager (Prism Central) of size small. LARGE: Domain manager (Prism Central) of size large. EXTRALARGE: Domain manager (Prism Central) of size extra large. STARTER: Domain manager (Prism Central) of size starter. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.BootstrapConfig: type: object properties: cloudInitConfig: maxItems: 50 minItems: 1 type: array description: List of cloud-init commands required to bootstrap the domain manager (Prism Central) cluster on a startup. writeOnly: true items: $ref: '#/components/schemas/vmm.v4.2.ahv.config.CloudInit' environmentInfo: $ref: '#/components/schemas/prism.v4.3.config.EnvironmentInfo' additionalProperties: false description: Bootstrap configuration details for the domain manager (Prism Central). prism.v4.3.config.DomainManagerResourceConfig: type: object properties: numVcpus: type: integer description: This property is used for readOnly purposes to display Prism Central number of VCPUs allocation. format: int32 readOnly: true example: 75 memorySizeBytes: type: integer description: This property is used for readOnly purposes to display Prism Central RAM allocation at the cluster level. format: int64 readOnly: true example: 64 dataDiskSizeBytes: type: integer description: This property is used for readOnly purposes to display Prism Central data disk size allocation at a cluster level. format: int64 readOnly: true example: 7 containerExtIds: maxItems: 3 minItems: 1 uniqueItems: true type: array description: The external identifier of the container that will be used to create the domain manager (Prism Central) cluster. 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: aba33a43-ed9f-4eba-a3f9-9cce1452104a additionalProperties: false description: "This configuration is used to provide the resource-related details\ \ like container external identifiers, number of VCPUs, memory size, data\ \ disk size of the domain manager (Prism Central). In the case of a multi-node\ \ setup, the sum of resources like number of VCPUs, memory size and data disk\ \ size are provided." prism.v4.3.config.EnvironmentInfo: type: object properties: type: $ref: '#/components/schemas/prism.v4.3.config.EnvironmentType' providerType: $ref: '#/components/schemas/prism.v4.3.config.ProviderType' provisioningType: $ref: '#/components/schemas/prism.v4.3.config.ProvisioningType' additionalProperties: false description: | An object denoting the environment information of the PC. It contains the following fields:
- type: Enums denoting the environment type of the PC.
- providerType: Enums denoting the provider of the cloud PC.
- instanceObj: Enums denoting the instance type of the cloud PC.
prism.v4.3.config.EnvironmentType: type: string description: | Enums denoting the environment type of the PC, that is, on-prem PC or cloud PC.
Following are the supported entity types: - ONPREM - NTNX_CLOUD enum: - ONPREM - NTNX_CLOUD - $UNKNOWN - $REDACTED x-enumDescriptions: NTNX_CLOUD: Nutanix cloud environment. ONPREM: On-prem environment. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.ProviderType: type: string description: | Enums denoting the provider of the cloud, in case of environment type a cloud PC.
The service currently supports the following providers: - NTNX - AZURE - AWS - GCP - VSPHERE enum: - NTNX - AZURE - AWS - GCP - VSPHERE - $UNKNOWN - $REDACTED x-enumDescriptions: VSPHERE: Vsphere cloud provider. AZURE: Azure cloud provider. NTNX: Nutanix cloud provider. GCP: GCP cloud provider. $UNKNOWN: | Unknown value. AWS: AWS cloud provider. $REDACTED: | Redacted value. prism.v4.3.config.ProvisioningType: type: string description: | Enums denoting the instance type of the cloud PC. It indicates whether the PC is created on bare-metal or on a cloud-provisioned VM. Hence, it supports two possible values: - NTNX - NATIVE enum: - NTNX - NATIVE - $UNKNOWN - $REDACTED x-enumDescriptions: NATIVE: Native instance. NTNX: Nutanix instance. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.BaseNetwork: required: - defaultGateway - subnetMask type: object properties: defaultGateway: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' subnetMask: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' ipRanges: maxItems: 15 minItems: 1 uniqueItems: true type: array description: Range of IPs used for Prism Central network setup. items: $ref: '#/components/schemas/common.v1.0.config.IpRange' ipAddresses: type: array description: List of Node (VM) IP addresses used for Prism Central network setup. readOnly: true items: $ref: '#/components/schemas/common.v1.0.config.IPAddress' additionalProperties: false description: This model would abstract away the common attributes as part of internal and external networks. prism.v4.3.config.ExternalNetwork: description: This configuration is used to manage Prism Central. allOf: - $ref: '#/components/schemas/prism.v4.3.config.BaseNetwork' - required: - networkExtId type: object properties: networkExtId: 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 network external identifier to which Domain Manager (Prism Central) is to be deployed or is already configured. example: 0b732c01-0635-48a3-a5a1-c633e3cdfea2 additionalProperties: false prism.v4.3.config.NetworkCapability: type: string description: "This property represents network capability of a domain manager\ \ which consists of - Ipv4 only, dual stack and ipv6 only networks." enum: - IPV4 - DUAL_STACK - IPV6 - $UNKNOWN - $REDACTED x-enumDescriptions: DUAL_STACK: The Domain manager (Prism Central) has both IPv4 and IPv6 network configured. IPV6: The Domain manager (Prism Central) has only IPv6 network configured. IPV4: The Domain manager (Prism Central) has only IPv4 network configured. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.protectpc.ApiResponseMetadata: type: object properties: links: type: array readOnly: true items: $ref: '#/components/schemas/prism.v4.3.protectpc.ApiLink' additionalProperties: false description: Metadata associated with API responses. prism.v4.3.protectpc.ApiLink: type: object properties: href: type: string description: The URL that points to the relationship. example: string rel: type: string description: The name of the relationship. example: string additionalProperties: false description: HATEOAS links for the request. For paginated requests includes prev/next/first and last links prism.v4.3.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: A globally unique identifier for a task. example: QmFzZTY0RW5jb2RlZA==:cb95d130-4658-4f14-a39b-63370a758a5f additionalProperties: false description: A reference to a task tracking an asynchronous operation. The status of the task can be queried by making a GET request to the task URI provided in the metadata section of the API response. prism.v4.3.resourceManager.Product: title: Product model. type: object properties: name: type: string description: Application name. example: string isEnabled: type: boolean description: Boolean flag representing if the application is enabled. example: false type: $ref: '#/components/schemas/prism.v4.3.resourceManager.ProductType' resourceModel: required: - $objectType properties: $objectType: type: string example: prism.v4.resourceManager.ResourceTypeSpec description: "Resource model to add, either resource type or resource spec." oneOf: - $ref: '#/components/schemas/prism.v4.3.resourceManager.ResourceTypeSpec' - $ref: '#/components/schemas/prism.v4.3.resourceManager.ResourceSpec' details: $ref: '#/components/schemas/prism.v4.3.resourceManager.Details' additionalProperties: false description: Portfolio product such as AIOps or Calm. prism.v4.3.resourceManager.ProductType: type: string description: Indicates the type of the of portfolio products. enum: - PRISM_OPS - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.resourceManager.ResourceTypeSpec: type: object properties: resourceType: $ref: '#/components/schemas/prism.v4.3.resourceManager.ResourceType' additionalProperties: false description: Indicates the type of resources allocated for this Product. prism.v4.3.resourceManager.ResourceSpec: title: Application Resource Specification. type: object properties: cpu: type: integer description: Indicates the number of virtual CPUs used by the application. example: 64 memory: type: string description: Indicates the memory allocated for the application. example: string additionalProperties: false description: Indicates the resource specification used by this application with attributes such as virtual CPUs and memory. prism.v4.3.resourceManager.Details: type: object properties: message: type: string description: Indicates the detailed message associated with the status message example: string status: $ref: '#/components/schemas/prism.v4.3.resourceManager.Status' additionalProperties: false prism.v4.3.resourceManager.ResourceType: type: string description: Kind of resources want to add. Such as kPrismOpsServiceResource. enum: - PRISM_OPS_REGULAR_RESOURCE - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.resourceManager.Status: type: string description: Indicates the status of the application. HEALTHY means that the application is up and running in good health while critical would mean that the application is starved of resources. enum: - HEALTHY - CRITICAL - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.resourceManager.Service: title: Service model type: object properties: name: type: string description: Application name. example: string isEnabled: type: boolean description: Boolean flag representing if the application is enabled. example: false additionalProperties: false description: Service representing a service inside product such as Playbooks in AIOps prism.v4.3.mgmt.EnvironmentInfo: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: environmentType: $ref: '#/components/schemas/prism.v4.3.mgmt.EnvironmentType' providerType: $ref: '#/components/schemas/prism.v4.3.mgmt.ProviderType' instanceType: $ref: '#/components/schemas/prism.v4.3.mgmt.InstanceType' cellFqdn: type: string description: | This signifies region/az info. There can be different billing units for different region. CFS service running in PC and PE (in XI DC) currently pass this info along with metrix and spec to metering and telemetry pipeline. example: string tenantUuid: 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 unique UUID provisioned to the tenant. example: 61039a3e-1536-4ef7-aff3-50d09543b099 pcExternalUrl: pattern: "^((http[s]?|nfs):\\/)?\\/?([^:\\/\\s]*)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: | This field signifies DNS mapped fully qualified domain name provided by MCM. example: string localAzName: type: string description: | This field signifies local availability zone name derived from tenant region. example: string cloudSiteName: type: string description: | This field signifies cloud site name for a given company. A company can have multiple povisioned sites. This will be provided by customers on MCM UI. example: string cloudRegionName: type: string description: | This field signifies tenant region, to be selected by customers on MCM UI. example: string myNutanixUrl: pattern: "^((http[s]?|nfs):\\/)?\\/?([^:\\/\\s]*)((\\/\\w+)*(:[0-9]+)*?\\\ /)([\\w\\-\\.]+[^#?\\s]+)(.*)?(#[\\w\\-]+)?$" type: string description: | This field signifies mynutanix URL. example: string xlbVirtualAddress: $ref: '#/components/schemas/prism.v4.3.mgmt.LbAddress' olbVirtualAddress: $ref: '#/components/schemas/prism.v4.3.mgmt.LbAddress' billingHost: type: string description: | This field signifies the billing UI hostname. example: string billingApiHost: type: string description: | This field signifies billing API hostname which serves billing apis. example: string additionalProperties: false prism.v4.3.mgmt.EnvironmentType: type: string description: | An enum denoting the environment type of the PC. Whether it is an OnPrem PC or a cloud PC.
Following are the supported entity types: - ONPREM - NTNX_CLOUD enum: - ONPREM - NTNX_CLOUD - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.mgmt.ProviderType: type: string description: | An enum denoting the provider of the cloud in case the environment type is a cloud PC.
The following providers are currently supported by the service: - NTNX - AZURE - AWS - GCP enum: - NTNX - AZURE - AWS - GCP - VSPHERE - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.mgmt.InstanceType: type: string description: |- An enum denoting the instance type of the cloud PC. Indicates whether PC is created on baremetal or on a cloud provisioned VM.. Hence it supports two possible values: - NTNX_PROVISIONED - NATIVE_PROVISIONED enum: - NTNX_PROVISIONED - NATIVE_PROVISIONED - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.mgmt.LbAddress: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: ip: type: string example: string ipv6: type: string example: string fqdn: type: string example: string port: type: integer example: 3 isBackup: type: boolean example: true additionalProperties: false prism.v4.3.trust.Trust: type: object properties: certificateSigningRequest: type: string description: | Public key of the client in Certificate Signing Request format encoded in PEM format. example: string authMetadata: $ref: '#/components/schemas/prism.v4.3.trust.AuthMetadata' additionalProperties: false description: | An Object representing a Trust Setup request. prism.v4.3.trust.AuthMetadata: type: object properties: authToken: type: string description: | An Auth token generated to be compatible with Component Registry. In request it will be auth token of client and likewise in reponse it will be of PC component. example: string additionalProperties: false description: | An Object capturing metadata related to authentication and authorization. prism.v4.3.trust.SignedCertDetails: type: object properties: certificateSigningRequest: type: string description: | Public key of the client in Certificate Signing Request format encoded in PEM format. example: string signedCertificate: type: string description: | Clients Public key signed by PC's intermedicate Certificate in PEM format. example: string caCertChain: type: string description: | PC Component's cert chain in PEM format. example: string error: type: string description: | An error string capturing any errors faced during trust setup, will be empty if operation is successful. example: string authMetadata: $ref: '#/components/schemas/prism.v4.3.trust.AuthMetadata' additionalProperties: false prism.v4.3.trust.ApiResponseMetadata: type: object properties: links: type: array items: $ref: '#/components/schemas/prism.v4.3.trust.ApiLink' additionalProperties: false description: | Metadata associated with API responses prism.v4.3.trust.ApiLink: type: object properties: href: type: string description: | The URL that points to the relationship example: string rel: type: string description: | The name of the relationship example: string additionalProperties: false description: | HATEOAS links for the request. For paginated requests includes prev/next/first and last links prism.v4.3.config.GetTaskApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.Task oneOf: - $ref: '#/components/schemas/prism.v4.3.config.Task' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{extId}\ \ Get operation" prism.v4.3.config.Task: 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: A globally unique identifier for a task. readOnly: true example: QmFzZTY0RW5jb2RlZA==:3b39d500-bbc7-426f-9ef8-34b1cabd5aa0 operation: type: string description: The name of the operation being tracked by the task. readOnly: true example: kVmCreate operationDescription: type: string description: Description of the operation tracked by the task. readOnly: true example: Create VM parentTask: $ref: '#/components/schemas/prism.v4.3.config.TaskReferenceInternal' createdTime: type: string description: UTC date and time in RFC-3339 format when the task was created. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 startedTime: type: string description: UTC date and time in RFC-3339 format when the task was started. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 completedTime: type: string description: UTC date and time in RFC-3339 format when the task was completed. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 status: $ref: '#/components/schemas/prism.v4.3.config.TaskStatus' progressPercentage: maximum: 100 minimum: 0 type: integer description: Task progress expressed as a percentage. format: int32 readOnly: true example: 57 entitiesAffected: maxItems: 300 minItems: 0 type: array description: Reference to entities associated with the task. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.EntityReference' subTasks: maxItems: 100 minItems: 0 type: array description: "Reference to tasks spawned as children of the current task.\ \ The Task Get API operation response would contain a limited number of\ \ subtask references. To retrieve the full list of subtasks for a task,\ \ use the parent task filter in the Task List API operation." readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.TaskReferenceInternal' subSteps: maxItems: 50 minItems: 0 type: array description: List of steps completed as part of the task. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.TaskStep' isCancelable: type: boolean description: Indicates whether the task can be canceled. readOnly: true example: false ownedBy: $ref: '#/components/schemas/prism.v4.3.config.OwnerReference' completionDetails: maxItems: 50 minItems: 0 type: array description: Additional details about the task to help the user take further action after the task is completed. readOnly: true items: $ref: '#/components/schemas/common.v1.0.config.KVPair' errorMessages: maxItems: 100 minItems: 0 type: array description: Error details that explain a task failure. These would only be populated if a task failed. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' legacyErrorMessage: type: string description: Provides an error message in the absence of a well-defined error message for tasks created by legacy APIs. readOnly: true example: Setting Credential Guard for a VM with a GPU is not supported warnings: maxItems: 50 minItems: 0 type: array description: Warning messages to alert the user of issues which did not directly cause the task to fail.. These can be populated for any task. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' lastUpdatedTime: type: string description: UTC date and time in RFC-3339 format when the task was last updated. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 clusterExtIds: maxItems: 500 minItems: 0 type: array description: List of globally unique identifiers for clusters associated with the task or any of its subtasks. readOnly: true 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: bcc21153-d671-47dc-998b-61baff02a6c5 rootTask: $ref: '#/components/schemas/prism.v4.3.config.TaskReferenceInternal' isBackgroundTask: type: boolean description: Indicates whether or not the task is a background task. readOnly: true example: false numberOfSubtasks: type: integer description: Number of tasks spawned as children of the current task. format: int32 readOnly: true example: 6 numberOfEntitiesAffected: type: integer description: Number of entities associated with the task. format: int32 readOnly: true example: 75 resourceLinks: maxItems: 10 minItems: 0 type: array description: Reference to resources associated with the task. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.ResourceLink' appName: maxLength: 128 type: string description: Name of the application to which the task belongs. readOnly: true example: NCM batchSummary: $ref: '#/components/schemas/prism.v4.3.config.TaskBatchSummary' additionalProperties: false description: The task object tracking an asynchronous operation. prism.v4.3.config.TaskReferenceInternal: description: Reference to the parent task associated with the current task. allOf: - $ref: '#/components/schemas/common.v1.0.response.ApiLink' - 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: A globally unique identifier of the task. readOnly: true example: QmFzZTY0RW5jb2RlZA==:fdee78d4-590c-4c89-be4f-c8ba53c4509c additionalProperties: false prism.v4.3.config.TaskStatus: type: string description: Status of the task. enum: - QUEUED - RUNNING - CANCELING - SUCCEEDED - FAILED - CANCELED - SUSPENDED - $UNKNOWN - $REDACTED x-enumDescriptions: FAILED: Status indicating that the task failed. QUEUED: Status indicating that the task is queued for execution. RUNNING: Status indicating that the task is being executed. SUSPENDED: Status indicating that the task is currently suspended. SUCCEEDED: Status indicating that the task was successfully executed. CANCELED: Status indicating that the task was cancelled. CANCELING: Status indicating that the task is marked for cancellation. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.EntityReference: type: object properties: extId: type: string description: A globally unique identifier of the entity. readOnly: true example: 7ccae44f-d067-4d49-a4d0-7409e2455894 rel: type: string description: "Entity type identified as 'namespace:module[:submodule]:entityType'.\ \ For example- vmm:ahv:vm, where vmm is the namespace, ahv is the module,\ \ and vm is the entity type." readOnly: true example: vmm:ahv:config:vm name: maxLength: 256 type: string description: Name of the entity. readOnly: true example: Test VM additionalProperties: false description: Details of the entity. prism.v4.3.config.TaskStep: type: object properties: name: maxLength: 512 type: string description: Message describing the completed steps for the task. readOnly: true example: Create underlying infrastructure additionalProperties: false description: A single step in the task. prism.v4.3.config.OwnerReference: 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 the task owner. readOnly: true example: fa426143-7313-4697-bcea-b2172c3750bb name: maxLength: 256 type: string description: Username of the task owner. readOnly: true example: Test User additionalProperties: false description: Reference to the owner of the task. prism.v4.3.config.ResourceLink: description: Details of the resource associated with the task. allOf: - $ref: '#/components/schemas/common.v1.0.response.ApiLink' - type: object properties: name: maxLength: 128 type: string description: Name of the resource. readOnly: true example: Log bundle additionalProperties: false prism.v4.3.config.TaskBatchSummary: type: object properties: numberOfJobs: type: integer description: Number of total jobs associated with the task. format: int32 readOnly: true example: 94 numberOfJobsSuccessful: type: integer description: Number of successful jobs associated with the task. format: int32 readOnly: true example: 90 numberOfJobsFailed: type: integer description: Number of failed jobs associated with the task. format: int32 readOnly: true example: 78 additionalProperties: false description: Summary of jobs associated with the task. prism.v4.3.config.CancelTaskApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.error.AppMessage oneOf: - $ref: '#/components/schemas/prism.v4.3.error.AppMessage' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/$actions/cancel\ \ Post operation" prism.v4.3.config.ListTasksApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.config.Task' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/tasks Get operation prism.v4.3.config.GetTaskJobApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskJob oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskJob' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs/{extId}\ \ Get operation" prism.v4.3.config.TaskJob: description: Job associated with a task. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: name: maxLength: 256 type: string description: Name of the job associated with the task. readOnly: true example: Create underlying infrastructure status: $ref: '#/components/schemas/prism.v4.3.config.TaskJobStatus' entitiesAffected: maxItems: 300 minItems: 0 type: array description: Entities affected by the job associated with the task. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.config.EntityReference' errorMessages: maxItems: 100 minItems: 0 type: array description: Error details that explain a job failure. These details are populated if a task fails. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' warnings: maxItems: 50 minItems: 0 type: array description: Warning messages to alert the user of issues that did not directly cause the job to fail. readOnly: true items: $ref: '#/components/schemas/prism.v4.3.error.AppMessage' clusterExtIds: maxItems: 500 minItems: 0 type: array description: List of globally unique identifiers for clusters associated with the job. readOnly: true 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: 80db4338-59a2-4837-a660-5d6b21e867f5 completionDetails: maxItems: 50 minItems: 0 type: array description: Additional job details that help the user take further action after the job is completed. readOnly: true items: $ref: '#/components/schemas/common.v1.0.config.KVPair' createdTime: type: string description: UTC date and time in RFC-3339 format when the job was created. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 completedTime: type: string description: UTC date and time in RFC-3339 format when the job was completed. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 additionalProperties: false prism.v4.3.config.TaskJobStatus: type: string description: Status of the job associated with the task. enum: - PENDING - SUCCEEDED - FAILED - $UNKNOWN - $REDACTED x-enumDescriptions: FAILED: Status indicating that the job has been executed and has failed. SUCCEEDED: Status indicating that the job has been executed and is successful. PENDING: Status indicating that the job is in pending state. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.config.ListTaskJobsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.config.TaskJob' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/jobs\ \ Get operation" prism.v4.3.config.ListTaskEntitiesApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.config.EntityReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/tasks/{taskExtId}/affected-entities\ \ Get operation" prism.v4.3.operations.BatchSpec: type: object properties: metadata: $ref: '#/components/schemas/prism.v4.3.operations.BatchSpecMetadata' payload: maxItems: 500 minItems: 0 type: array items: $ref: '#/components/schemas/prism.v4.3.operations.BatchSpecPayload' additionalProperties: false description: The input specification for performing the batch operation. prism.v4.3.operations.SubmitBatchApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/$actions/batch Post operation prism.v4.3.operations.BatchSpecMetadata: required: - action - name - uri type: object properties: action: $ref: '#/components/schemas/prism.v4.3.operations.ActionType' name: maxLength: 256 type: string description: An user friendly name of the batch. example: Batch VM Creation uri: pattern: "^/api/[a-z\\\\-]{2,16}/v[0-9]+.[0-9]+.[a-z,0-9]+/.*$" type: string description: The absolute URI of the API operation on which batching will be performed. example: /api/vmm/v4.0/ahv/config/vms shouldStopOnError: type: boolean description: A flag indicating whether the batch procession should halt or continue when an error response is received from the server during the execution of a batch chunk default: false chunkSize: minimum: 1 type: integer description: The chunk size to use during the batching operation. If not specified a minimum value of 1 would be chosen. default: 1 additionalProperties: false description: The metadata section on the input specification for performing the batch operation. prism.v4.3.operations.BatchSpecPayload: type: object properties: metadata: $ref: '#/components/schemas/prism.v4.3.operations.BatchSpecPayloadMetadata' data: type: object additionalProperties: true description: The data section of the payload provided to the batch operation. additionalProperties: false description: The specification corresponding to the actual payload provided as an input to the batch operation. prism.v4.3.operations.ActionType: type: string description: The batch request has been accepted for processing. enum: - CREATE - MODIFY - ACTION - DELETE - $UNKNOWN - $REDACTED x-enumDescriptions: DELETE: Batch delete entities. CREATE: Batch create entities. ACTION: Batch perform custom action. MODIFY: Batch update entities. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.operations.BatchSpecPayloadMetadata: type: object properties: headers: maxItems: 500 minItems: 0 type: array items: $ref: '#/components/schemas/prism.v4.3.operations.BatchSpecPayloadMetadataHeader' path: maxItems: 500 minItems: 0 type: array items: $ref: '#/components/schemas/prism.v4.3.operations.BatchSpecPayloadMetadataPath' additionalProperties: false description: The metadata section on the input specification for performing the batch operation. prism.v4.3.operations.BatchSpecPayloadMetadataHeader: required: - name - value type: object properties: name: maxLength: 256 type: string description: The name of the header parameter. example: If-Match value: type: string description: The value of the header parameter. example: YXBwbGljYXRpb24vanNvbg==:MA== additionalProperties: false description: The metadata section on the input specification for performing the batch operation. prism.v4.3.operations.BatchSpecPayloadMetadataPath: required: - name - value type: object properties: name: maxLength: 256 type: string description: The name of the path parameter. example: extId value: type: string description: The value of the path parameter. example: 00061aa0-4fb1-aba6-0000-000000014af5 additionalProperties: false description: The metadata section on the input specification for performing the batch operation. prism.v4.3.operations.ListBatchesApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.operations.Batch' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/operations/batches Get operation prism.v4.3.operations.Batch: description: A model that represents a Batch resource. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: name: maxLength: 256 type: string description: An user friendly name of the batch. example: string startTime: type: string description: | The execution start time of the batch. The value will be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would imply that the batch started execution at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 endTime: type: string description: | The completion time of the batch. The value will be in extended ISO-8601 format. For example, end time of 2022-04-23T01:23:45.678+09:00 would imply that the batch completed its execution at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 size: type: integer description: The total number of elements submitted for processing in the batch. format: int32 example: 79 successCount: type: integer description: The total number of elements successfully processed in the batch. format: int32 example: 4 failedCount: type: integer description: The total number of elements that failed to be processed in the batch. format: int32 example: 24 completionStatus: $ref: '#/components/schemas/prism.v4.3.operations.BatchCompletionStatus' executionStatus: $ref: '#/components/schemas/prism.v4.3.operations.BatchExecutionStatus' shouldStopOnError: type: boolean description: A flag indicating whether the batch procession should halt or continue when an error response is received from the server during the execution of a batch chunk example: false additionalProperties: false prism.v4.3.operations.BatchCompletionStatus: type: string description: The completion status of the batch. enum: - SUCCEEDED - FAILED - PARTIALLY_SUCCEEDED - CANCELLED - $UNKNOWN - $REDACTED x-enumDescriptions: CANCELLED: Batch Cancelled. FAILED: Batch Failed. SUCCEEDED: Batch Success. $UNKNOWN: | Unknown value. PARTIALLY_SUCCEEDED: Batch Partially Failed. $REDACTED: | Redacted value. prism.v4.3.operations.BatchExecutionStatus: type: string description: The completion status of the batch. enum: - IN_PROGRESS - COMPLETED - $UNKNOWN - $REDACTED x-enumDescriptions: IN_PROGRESS: Batch is executing. COMPLETED: Batch has completed. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.operations.GetBatchApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.operations.Batch oneOf: - $ref: '#/components/schemas/prism.v4.3.operations.Batch' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/operations/batches/{extId}\ \ Get operation" prism.v4.3.config.ListDomainManagerApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - maxItems: 1 minItems: 1 type: array items: $ref: '#/components/schemas/prism.v4.3.config.DomainManager' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Get operation prism.v4.3.config.CreateDomainManagerApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: REST response for all response codes in API path /prism/v4.3/config/domain-managers Post operation prism.v4.3.config.GetDomainManagerApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.DomainManager oneOf: - $ref: '#/components/schemas/prism.v4.3.config.DomainManager' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/domain-managers/{extId}\ \ Get operation" prism.v4.3.management.RootCertificateAddSpec: description: Payload for the add root certificate endpoint. It contains the root certificate of the remote cluster. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - required: - rootCertificate type: object properties: rootCertificate: maxLength: 10240 minLength: 1 type: string description: The root certificate of the cluster. example: string additionalProperties: false prism.v4.3.management.RootCertRemoveSpec: required: - clusterExtId type: object properties: 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: The external identifier of the domain manager (Prism Central) resource. example: 5fdf4fc7-e464-49dc-97d3-61ce059933fc additionalProperties: false description: Payload to delete root certificate. It contains the external identifier of the remote cluster. prism.v4.3.management.ConnectionConfigurationSpec: required: - remoteCluster type: object properties: remoteCluster: $ref: '#/components/schemas/prism.v4.3.management.RemoteCluster' additionalProperties: false description: Payload to configure connection endpoint. It contains the details of the remote cluster you are connecting to. prism.v4.3.management.RemoteCluster: description: "This includes the attributes of a remote cluster, such as the\ \ cluster name, cluster type, and address details. The address details comprise\ \ the external address (either a virtual IP or FQDN), the port for incoming\ \ connections, and the internal addresses (node IP addresses)." allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - required: - externalAddress type: object properties: name: maxLength: 80 minLength: 1 type: string description: Cluster name of a remote cluster. example: string externalAddress: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' nodeIpAddresses: maxItems: 3 minItems: 1 type: array description: Node IP addresses of a registered cluster. items: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' clusterType: $ref: '#/components/schemas/prism.v4.3.management.ClusterType' clusterVersion: type: string description: "Version of the cluster. This could be a version of AOS cluster,\ \ Domain Manager, or WitnessVM." example: string additionalProperties: false prism.v4.3.management.ClusterType: type: string description: | Type of cluster to be connected: - DOMAIN_MANAGER : Domain manager (Prism Central) instance - AOS : Prism Element cluster instance enum: - DOMAIN_MANAGER - AOS - $UNKNOWN - $REDACTED x-enumDescriptions: AOS: AOS (Prism Element) cluster instanc. DOMAIN_MANAGER: Domain manager (Prism Central) instance. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.management.ConnectionUnconfigurationSpec: required: - remoteCluster type: object properties: remoteCluster: $ref: '#/components/schemas/prism.v4.3.management.ClusterReference' additionalProperties: false description: Payload to unconfigure connection endpoint. It contains the details of the remote cluster to be disconnected. prism.v4.3.management.ListProductsApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - type: array items: $ref: '#/components/schemas/prism.v4.3.management.Product' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products\ \ Get operation" prism.v4.3.management.Product: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - title: Portfolio product required: - enablementState type: object properties: name: $ref: '#/components/schemas/prism.v4.3.management.ProductName' version: type: string description: Version of the product (if any). readOnly: true example: string enablementState: $ref: '#/components/schemas/prism.v4.3.management.EnablementState' serviceEnablementTime: type: string description: Timestamp at which the enablement was completed. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 resizeTime: type: string description: Timestamp of resize operation performed for a given product. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 lastModifiedTime: type: string description: Timestamp at which the last modification was done on enablement status or metadata. format: date-time readOnly: true example: 2009-09-23T14:30:00-07:00 resourceSpec: $ref: '#/components/schemas/prism.v4.3.management.ResourceSpec' metadata: required: - $objectType properties: $objectType: type: string example: prism.v4.management.GenericMetadata description: Metadata associated with the given entity. This field will be no-op for entities which do not require additional user inputs. oneOf: - $ref: '#/components/schemas/prism.v4.3.management.GenericMetadata' - $ref: '#/components/schemas/prism.v4.3.management.FlowControllerMetadata' additionalProperties: false description: Specifies whether products can be enabled or disabled. It also contains resource specification. prism.v4.3.management.ProductName: title: Product Name type: string description: Name of a product that is an enum string. enum: - FLOW_VIRTUAL_NETWORKING - FLOW_NETWORK_SECURITY - NUTANIX_DISASTER_RECOVERY - SELF_SERVICE - NUTANIX_MARKETPLACE - INTELLIGENT_OPERATIONS - NUTANIX_CLOUD_MANAGER - FLOW_CONTROLLER - $UNKNOWN - $REDACTED x-enumDescriptions: FLOW_VIRTUAL_NETWORKING: Nutanix Flow Virtual Networking NUTANIX_CLOUD_MANAGER: Nutanix Cloud Manager FLOW_NETWORK_SECURITY: Nutanix Flow Network Security FLOW_CONTROLLER: Flow Controller NUTANIX_MARKETPLACE: Nutanix Marketplace $UNKNOWN: | Unknown value. NUTANIX_DISASTER_RECOVERY: Nutanix Disaster Recovery SELF_SERVICE: Self Service (Calm) INTELLIGENT_OPERATIONS: Intelligent Operations $REDACTED: | Redacted value. prism.v4.3.management.EnablementState: type: string description: Represents the status of enablement. enum: - DISABLED - ENABLED - $UNKNOWN - $REDACTED x-enumDescriptions: DISABLED: Product state is disabled. ENABLED: Product state is enabled. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.management.ResourceSpec: title: Resource specification associated with a product which contains memory and vCPU values. type: object properties: cpuCount: type: integer description: Indicates the number of additional virtual CPUs to be added for a given portfolio product. format: int64 readOnly: true example: 96 memorySizeBytes: type: integer description: Indicates the memory to be added for a given portfolio product in bytes. format: int64 readOnly: true example: 79 additionalProperties: false description: Indicates the resource specification used by this application with attributes such as virtual CPUs and memory. prism.v4.3.management.GenericMetadata: title: Generic Metadata Model type: object properties: attributes: maxItems: 10 minItems: 0 type: array items: $ref: '#/components/schemas/common.v1.0.config.KVPair' additionalProperties: false description: Generic key-value pair metadata model for products enablement/disablement workflow. prism.v4.3.management.FlowControllerMetadata: title: Flow Controller Metadata Model type: object properties: cloudSubstrate: $ref: '#/components/schemas/prism.v4.3.management.CloudSubstrateType' 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: Reference to the cluster where flow controller will be deployed. example: 77bd7682-2dff-473a-a9fd-f5daf5369f82 subnetExtId: 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: Reference to the subnet where flow controller will be deployed. example: c76e1e17-14d1-4a4e-a520-8617195edc48 additionalProperties: false description: Metadata model for Flow Controller enablement/disablement workflow. prism.v4.3.management.CloudSubstrateType: type: string description: "Cloud substrate of the network controller, for e.g. Azure." enum: - AWS - AZURE - GCP - $UNKNOWN - $REDACTED x-enumDescriptions: AZURE: Network controller in AZURE substrate GCP: Network controller in GCP substrate $UNKNOWN: | Unknown value. AWS: Network controller in AWS substrate $REDACTED: | Redacted value. prism.v4.3.management.GetProductApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.management.Product oneOf: - $ref: '#/components/schemas/prism.v4.3.management.Product' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Get operation" prism.v4.3.management.UpdateProductApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/products/{extId}\ \ Put operation" prism.v4.3.management.ClusterRegistrationSpec: required: - remoteCluster type: object properties: remoteCluster: required: - $objectType properties: $objectType: type: string example: prism.v4.management.DomainManagerRemoteClusterSpec description: Description of a remote cluster. oneOf: - $ref: '#/components/schemas/prism.v4.3.management.DomainManagerRemoteClusterSpec' - $ref: '#/components/schemas/prism.v4.3.management.AOSRemoteClusterSpec' - $ref: '#/components/schemas/prism.v4.3.management.ClusterReference' additionalProperties: false description: Input specifications to perform the registration with a remote cluster entity. prism.v4.3.management.RegisterApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/register\ \ Post operation" prism.v4.3.management.DomainManagerRemoteClusterSpec: required: - cloudType - remoteCluster type: object properties: remoteCluster: $ref: '#/components/schemas/prism.v4.3.management.RemoteClusterSpec' cloudType: $ref: '#/components/schemas/prism.v4.3.management.DomainManagerCloudType' additionalProperties: false description: Remote cluster specification required for registering a domain manager (Prism Central). prism.v4.3.management.AOSRemoteClusterSpec: required: - remoteCluster type: object properties: remoteCluster: $ref: '#/components/schemas/prism.v4.3.management.RemoteClusterSpec' additionalProperties: false description: Remote cluster specification required for registering an AOS cluster (Prism Element). prism.v4.3.management.DomainManagerCloudType: type: string description: | Enum denoting whether the domain manager (Prism Central) instance is reachable with its physical address or reachable through the My Nutanix portal. Based on the above description, the allowed enum values are: - ONPREM: Domain manager (Prism Central) reachable on it's physical address. - NUTANIX_HOSTED_CLOUD: Domain manager (Prism Central) reachable through My Nutanix portal. enum: - ONPREM_CLOUD - NUTANIX_HOSTED_CLOUD - $UNKNOWN - $REDACTED x-enumDescriptions: NUTANIX_HOSTED_CLOUD: A domain manager (Prism Central) instance which is accessed through a My Nutanix credentials. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. ONPREM_CLOUD: A domain manager (Prism Central) instance which can be reached through a physical address. prism.v4.3.management.ClusterUnregistrationSpec: $ref: '#/components/schemas/prism.v4.3.management.ClusterReference' prism.v4.3.management.UnregisterApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.TaskReference oneOf: - $ref: '#/components/schemas/prism.v4.3.config.TaskReference' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{extId}/$actions/unregister\ \ Post operation" prism.v4.3.management.ListRegistrationApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: oneOf: - maxItems: 500 minItems: 1 type: array items: $ref: '#/components/schemas/prism.v4.3.management.Registration' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations\ \ Get operation" prism.v4.3.management.Registration: allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - title: Registered Cluster type: object properties: remoteClusterExtId: 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: External ID of the remote cluster. This is the UUID of the remote cluster. example: 29d0d470-bf93-4b06-a27c-c76e28a4529b connectivityStatus: $ref: '#/components/schemas/prism.v4.3.management.ConnectivityStatus' remoteClusterDetails: $ref: '#/components/schemas/prism.v4.3.management.RemoteCluster' metadata: required: - $objectType properties: $objectType: type: string example: prism.v4.management.GenericMetadata description: Metadata associated with the given entity. This field will be no-op for entities which do not require additional user inputs. oneOf: - $ref: '#/components/schemas/prism.v4.3.management.GenericMetadata' additionalProperties: false description: "The registration entity refers to all the connected remote clusters\ \ to the Domain Manager. These could be other Domain Managers, PEs, WitnessVMs,\ \ etc." prism.v4.3.management.ConnectivityStatus: type: string description: "The connectivity status of the registered remote cluster. It can\ \ be one of the following - CONNECTED, DISCONNECTED, or UNKNOWN." enum: - CONNECTED - DISCONNECTED - PENDING - $UNKNOWN - $REDACTED x-enumDescriptions: DISCONNECTED: Registered remote cluster is not reachable. CONNECTED: Registered remote cluster is reachable. PENDING: The connectivity status of the registered remote cluster is not known currently. Try again after some time. $UNKNOWN: | Unknown value. $REDACTED: | Redacted value. prism.v4.3.management.GetRegistrationApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.management.Registration oneOf: - $ref: '#/components/schemas/prism.v4.3.management.Registration' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/management/domain-managers/{domainManagerExtId}/registrations/{extId}\ \ Get operation" prism.v4.3.config.GetExternalStorageApiResponse: type: object properties: metadata: $ref: '#/components/schemas/common.v1.0.response.ApiResponseMetadata' data: required: - $objectType properties: $objectType: type: string example: prism.v4.config.ExternalStorage oneOf: - $ref: '#/components/schemas/prism.v4.3.config.ExternalStorage' - $ref: '#/components/schemas/prism.v4.3.error.ErrorResponse' additionalProperties: false description: "REST response for all response codes in API path /prism/v4.3/config/external-storages/{extId}\ \ Get operation" prism.v4.3.config.ExternalStorage: title: External Storage description: Configuration for an external storage resource. allOf: - $ref: '#/components/schemas/common.v1.0.response.ExternalizableAbstractModel' - type: object properties: name: maxLength: 256 type: string description: The name of the external storage resource. example: external-storage-1 providerType: $ref: '#/components/schemas/prism.v4.3.config.ExternalStorageProvider' config: required: - $objectType properties: $objectType: type: string example: prism.v4.config.DellPowerflexConfig description: Configuration details for the external storage. oneOf: - $ref: '#/components/schemas/prism.v4.3.config.DellPowerflexConfig' - $ref: '#/components/schemas/prism.v4.3.config.PureStorageFlashArrayConfig' totalCapacityBytes: type: integer description: Total capacity of the external storage in bytes. format: int64 readOnly: true example: 1000000000000 freeCapacityBytes: type: integer description: Free capacity of the external storage in bytes. format: int64 readOnly: true example: 500000000000 additionalProperties: false prism.v4.3.config.ExternalStorageProvider: title: External Storage Provider type: string description: The type of external storage provider. enum: - DELL_POWERFLEX - PURE_STORAGE_FLASHARRAY - $UNKNOWN - $REDACTED x-enumDescriptions: $UNKNOWN: | Unknown value. PURE_STORAGE_FLASHARRAY: Configuration details for a Pure Storage FlashArray external storage. DELL_POWERFLEX: Configuration details for a Dell PowerFlex external storage. $REDACTED: | Redacted value. prism.v4.3.config.DellPowerflexConfig: title: Dell PowerFlex Configuration type: object properties: address: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' systemId: maxLength: 256 type: string description: The systemId for the Dell PowerFlex system. example: 1cc5204c4d938e0f storagePool: $ref: '#/components/schemas/prism.v4.3.config.DellPowerflexStoragePool' additionalProperties: false description: Configuration details for a Dell PowerFlex external storage. prism.v4.3.config.PureStorageFlashArrayConfig: title: Pure Storage FlashArray Configuration type: object properties: address: $ref: '#/components/schemas/common.v1.0.config.IPAddressOrFQDN' id: 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: Unique identifier for the Pure Storage FlashArray. readOnly: true example: 6c760d77-4be7-4fd5-bc5f-81241b8bd225 pod: $ref: '#/components/schemas/prism.v4.3.config.PureStorageFlashArrayPod' additionalProperties: false description: Configuration details for a Pure Storage FlashArray external storage. prism.v4.3.config.DellPowerflexStoragePool: title: Dell PowerFlex Storage Pool type: object properties: name: maxLength: 256 type: string description: Name of the Dell PowerFlex storage pool. example: SP1 protectionDomainName: maxLength: 256 type: string description: Name of the protection domain for the storage pool. example: PD1 storagePoolId: maxLength: 256 type: string description: Unique identifier for the Dell PowerFlex storage pool. readOnly: true example: 1af487ae00000000 additionalProperties: false description: Details of a Dell PowerFlex storage pool. prism.v4.3.config.PureStorageFlashArrayPod: title: Pure Storage FlashArray Pod type: object properties: name: maxLength: 256 type: string description: Name of the Pure Storage FlashArray pod. example: pod1 realm: maxLength: 256 type: string description: Realm of the Pure Storage FlashArray pod. example: nutanix podId: 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: Unique identifier for the Pure Storage FlashArray pod. readOnly: true example: 755d1a1b-bd5b-67f1-8f72-0bbcffc7b037 additionalProperties: false description: Pod configuration for the Pure Storage FlashArray. securitySchemes: basicAuthScheme: type: http scheme: basic apiKeyAuthScheme: type: apiKey name: X-ntnx-api-key in: header