NSX-T Data Center REST API

Returns info for a Advanced Load Balancer controller deployment attempt

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

Request:

Method:

GET

URI Path(s):

/policy/api/v1/alb/controller-nodes/deployments/<node-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ALBControllerNodeVMDeploymentRequest+

ALBControllerNodeVMDeploymentRequest (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
deployment_config	Deployment config for Advanced Load Balancer controller node VM Deployment information and basic configuration for the Advanced Load Balancer controller.	ALBControllerNodeVMDeploymentConfig (Abstract type: pass one of the following concrete types) AlbControllerVsphereClusterNodeVmDeploymentConfig	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
form_factor	Form factor for Advanced Load Balancer controller VMs. Specifies the desired "size" of the VM	ALBControllerClusterNodeVMFormFactor	Default: "MEDIUM"
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ALBControllerNodeVMDeploymentRequest	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
user_settings	User settings for the VM SSH key and password for the Advanced Load Balancer controller node VM. Note: SSH key settings will be honored only during VM deployment.	ALBControllerNodeUserSettings	Required
vm_id	ID of Advanced Load Balancer controller 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": "AlbControllerVsphereClusterNodeVmDeploymentConfig", "vc_id": "15145422-47a1-4c55-81da-01d953151d1f", "management_network_id": "network-158", "default_gateway_addresses": [ "10.33.79.253" ], "hostname": "node-0", "display_name": "alb-controller-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" }

Required Permissions:

read

Feature:

policy_lb

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable