NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
AlbControllerVsphereClusterNodeVmDeploymentConfig (schema)
Deployment config on the vSphere platform
The vSphere deployment configuration determines where to deploy the
Avi Load Balancer Controller node through a vCenter server. It contains settings that are
applied during install time.
If using DHCP, the following fields must be left unset -
management_port_subnets, and default_gateway_addresses
| Name | Description | Type | Notes |
|---|---|---|---|
| compute_id | Cluster identifier or resourcepool identifier The Avi Load Balancer Controller node will be deployed on the specified cluster or resourcepool for specified VC server. |
string | Required |
| default_gateway_addresses | Default gateway for the Avi Load Balancer Controller node The default gateway for the Avi Load Balancer Controller node to be deployed must be specified if all the other nodes it communicates with are not in the same subnet. Do not specify this field and management_port_subnets to use DHCP. Note: only single IPv4 default gateway address is supported and it must belong to management network. |
array of IPAddress | Minimum items: 1 Maximum items: 1 |
| disk_provisioning | Disk provitioning type Specifies the disk provisioning type of the Avi Load Balancer Controller node. |
DiskProvisioning | Default: "THIN" |
| display_name | Avi Load Balancer Controller node display name Desired display name for Avi Load Balancer Controller node to be deployed. |
string | |
| dns_servers | DNS servers List of DNS servers. |
array of IPv4Address | |
| host_id | Host identifier The Avi Load Balancer Controller node will be deployed on the specified host in the specified VC server within the cluster if host_id is specified. Note: User must ensure that storage and specified networks are accessible by this host. |
string | |
| hostname | Host name or FQDN for the Avi Load Balancer Controller node Desired host name/FQDN for the Avi Load Balancer Controller node to be deployed. |
string | Required Format: hostname-or-ip |
| management_network_id | Portgroup identifier for management network connectivity Distributed portgroup identifier to which the management vnic of Avi Load Balancer Controller node will be connected. |
string | Required |
| management_port_subnets | Port subnets for management port IP Address and subnet configuration for the management port. Do not specify this field and default_gateway_addresses to use DHCP. Note: only one IPv4 address is supported for the management port. |
array of IPSubnet | Minimum items: 1 Maximum items: 1 |
| ntp_servers | NTP servers List of NTP servers. |
array of HostnameOrIPv4Address | |
| placement_type | Must be set to the value AlbControllerVsphereClusterNodeVmDeploymentConfig | string | Required Enum: AlbControllerVsphereClusterNodeVmDeploymentConfig |
| storage_id | Storage/datastore identifier The Avi Load Balancer Controller node will be deployed on the specified datastore in the specified VC server. User must ensure that storage is accessible by the specified cluster/host. |
string | Required |
| storage_policy_id | Storage policy uuid The Avi Controller cluster node will be deployed with the specified storage policy on the specified datastore in the specified VC server. User must ensure that the storage policy is applicable on the given datastore. |
string | |
| vc_id | vSphere compute identifier for identifying VC server The VC-specific identifiers will be resolved on this VC, so all other identifiers specified in the config must belong to this vCenter server. |
string | Required |