System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments

Deploy and register a cluster node VM

Deploys a cluster node VM as specified by the deployment config.
Once the VM is deployed and powered on, it will automatically join the
existing cluster.

Request:

Method:
POST
URI Path(s):
/api/v1/cluster/nodes/deployments
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AddClusterNodeVMInfo+

Example Request:

POST https://<nsx-mgr>/api/v1/cluster/nodes/deployments { "deployment_requests": [ { "roles": ["CONTROLLER", "MANAGER"], "form_factor": "MEDIUM", "user_settings": { "cli_password": "CLIp4$$w4rd", "root_password": "ROOTp4$$w4rd" }, "deployment_config": { "placement_type": "VsphereClusterNodeVMDeploymentConfig", "vc_id": "69874c95-51ed-4775-bba8-e0d13bdb4fed", "management_network_id": "network-13", "hostname": "node-0", "compute_id": "domain-s9", "storage_id": "datastore-12", "default_gateway_addresses":[ "10.33.79.253" ], "management_port_subnets":[ { "ip_addresses":[ "10.33.79.64" ], "prefix_length": 22 } ], "dns_servers": [ "10.33.38.2" ] } }, { "roles": ["CONTROLLER", "MANAGER"], "form_factor": "MEDIUM", "user_settings": { "cli_password": "CLIp4$$w4rd", "root_password": "ROOTp4$$w4rd", }, "deployment_config": { "placement_type": "VsphereClusterNodeVMDeploymentConfig", "vc_id": "69874c95-51ed-4775-bba8-e0d13bdb4fed", "management_network_id": "network-13", "hostname": "node-1", "compute_id": "domain-s9", "storage_id": "datastore-12", "default_gateway_addresses":[ "10.33.79.253" ], "management_port_subnets":[ { "ip_addresses":[ "10.33.79.65" ], "prefix_length": 22 } ], "dns_servers": [ "10.33.38.2" ] } } ] }

Successful Response:

Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeVMDeploymentRequestList+

Example Response:

{ "result_count": 2, "results": [ { "vm_id": "71f02260-644f-4482-aa9a-ab8570bb49a3", "roles": [ "CONTROLLER", "MANAGER" ], "deployment_config": { "placement_type": "VsphereClusterNodeVMDeploymentConfig", "vc_id": "69874c95-51ed-4775-bba8-e0d13bdb4fed", "management_network_id": "network-13", "default_gateway_addresses": [ "10.33.79.253" ], "hostname": "node-0", "compute_id": "domain-s9", "storage_id": "datastore-12", "management_port_subnets": [ { "ip_addresses": [ "10.33.79.64" ], "prefix_length": 22 } ], "dns_servers": [ "10.33.38.2" ] }, "form_factor": "MEDIUM" }, { "vm_id": "38029a2b-b9bc-467f-8138-aef784e802cc", "roles": [ "CONTROLLER", "MANAGER" ], "deployment_config": { "placement_type": "VsphereClusterNodeVMDeploymentConfig", "vc_id": "69874c95-51ed-4775-bba8-e0d13bdb4fed", "management_network_id": "network-13", "default_gateway_addresses":[ "10.33.79.253" ], "hostname": "node-1", "compute_id": "domain-s9", "storage_id": "datastore-12", "management_port_subnets":[ { "ip_addresses":[ "10.33.79.65" ], "prefix_length": 22 } ], "dns_servers": [ "10.33.38.2" ] }, "form_factor": "MEDIUM" } ] }

Required Permissions:

crud

Feature:

deployment_nodes_cluster

Additional Errors: