Deploy and register a Advanced Load Balancer controller node VM

Deploys a Advanced Load Balancer controller node VM as specified by the deployment config.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/alb/controller-nodes/deployments

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

AddALBControllerNodeVMInfo+

Name	Description	Type	Notes
deployment_requests	List of deployment requests Advanced Load Balancer Controller deployment requests to be deployed by NSX.	array of ALBControllerNodeVMDeploymentRequest	Required Minimum items: 1

Example Request:

POST https://<policy-mgr>/policy/api/v1/alb/controller-nodes/deployments { "deployment_requests": [ { "form_factor": "SMALL", "clustering_id": "e8abab64-774e-48fa-bd5c-41df7aefdb88", "deployment_config": { "user_settings": { "admin_password": "Pass@1234!", }, "placement_type": AlbControllerVsphereClusterNodeVmDeploymentConfig", "vc_id": "69874c95-51ed-4775-bba8-e0d13bdb4fed", "management_network_id": "network-13", "hostname": "node-0", "display_name": "avi-controller-vm", "compute_id": "domain-s9", "storage_id": "datastore-12", "storage_policy_id": 96124c95-54zd-8775-xba8-z0d13bdb9swq", "default_gateway_addresses":[ "10.33.79.253" ], "management_port_subnets":[ { "ip_addresses":[ "10.33.79.64" ], "prefix_length": 22 } ] } } ] }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ALBControllerNodeVMDeploymentRequestList+

ALBControllerNodeVMDeploymentRequestList (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
clustering_id	Unique Id for NSX Advanced Load Balancer Controller Cluster used in VCF managed NSX. Id to filter NSX Advanced Load Balancer Controllers, if not provided NSX ALB Controllers without clustering Id will be returned.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Results Array of existing Advanced Load Balancer Controller Deployment Requests.	array of ALBControllerNodeVMDeploymentRequest	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 1, "results": [ { "vm_id": "71f02260-644f-4482-aa9a-ab8570bb49a3", "deployment_config": { "placement_type": "AlbControllerVsphereClusterNodeVmDeploymentConfig", "vc_id": "69874c95-51ed-4775-bba8-e0d13bdb4fed", "management_network_id": "network-13", "default_gateway_addresses": [ "10.33.79.253" ], "hostname": "node-0", "display_name": "ALB-controller-vm", "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": "SMALL", "clustering_id": "e8abab64-774e-48fa-bd5c-41df7aefdb88" } ] }

Deploy and register a Advanced Load Balancer controller node VM

Request:

AddALBControllerNodeVMInfo (schema)

Example Request:

Successful Response:

ALBControllerNodeVMDeploymentRequestList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: