Returns info for a Intelligence cluster node VM auto-deployment attempt

Returns deployment request information for a specific attempted
deployment of a cluster node VM.

Request:

Method:

GET

URI Path(s):

/api/v1/intelligence/nodes/deployments/<node-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/intelligence/nodes/deployments/12f563af-af9f-48f3-848e-e9257c8740b0

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IntelligenceClusterNodeVMDeploymentRequest+

Name	Description	Type	Notes
deployment_config	Deployment config for NSX-Intelligence cluster node VM Info needed to configure a NSX-Intelligence cluster node VM at deployment for a specific platform.	IntelligenceClusterNodeVMDeploymentConfig (Abstract type: pass one of the following concrete types) IntelligenceVsphereClusterNodeVMDeploymentConfig	Required
form_factor	Form factor for NSX-Intelligence VMs Specifies the desired "size" of the VM	IntelligenceClusterNodeVMFormFactor	Default: "SMALL"
user_settings	User settings for the VM Username and password settings for the NSX-Intelligence node VM. Passwords must be at least 12 characters in length and contain at least one lowercase, one uppercase, one numerical, and one special character. Note: These settings will be honored only during VM deployment. Post-deployment, CLI must be used for changing the user settings and changes to these parameters will not have any effect.	NodeUserSettings	Required
vm_id	ID of VM used to recognize it ID of the VM maintained internally. Note: This is automatically generated and cannot be modified.	string	Readonly

Example Response:

{ "vm_id": "12f563af-af9f-48f3-848e-e9257c8740b0", "deployment_config": { "placement_type": "IntelligenceVsphereClusterNodeVMDeploymentConfig", "vc_id": "15145422-47a1-4c55-81da-01d953151d1f", "management_network_id": "network-158", "default_gateway_addresses": [ "10.33.79.253" ], "hostname": "node-0", "display_name": "Intelligence-vm", "compute_id": "domain-c154", "storage_id": "datastore-157", "management_port_subnets": [ { "ip_addresses": [ "10.33.79.64" ], "prefix_length": 22 } ], "dns_servers": [ "10.33.38.2" ] }, "form_factor": "SMALL" }

Returns info for a Intelligence cluster node VM auto-deployment attempt

Request:

Example Request:

Successful Response:

IntelligenceClusterNodeVMDeploymentRequest (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: