NSX-T Data Center REST API
ALBControllerNodeVMDeploymentRequest (schema)
Info for Advanced Load Balancer controller node deployment request
Contains the deployment information for a Advanced Load Balancer controller node VM.
| 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 |
| clustering_id | Unique Id for NSX Advanced Load Balancer Controller Cluster used in VCF managed NSX. Unique Id for NSX Advanced Load Balancer Controller Cluster used in VCF managed NSX. |
string | 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: "LARGE" |
| id | Unique identifier of this resource | string | Sortable |
| resource_type | Must be set to the value ALBControllerNodeVMDeploymentRequest | string | |
| sddc_manager | FQDN or IP of SDDC Manager for VCF workflow. FQDN or IP of SDDC Manager for VCF workflow |
HostnameOrIPv4Address | |
| 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 |