Deployment config on the Vsphere platform
The Vsphere deployment configuration determines where to deploy the
cluster node VM through a vCenter server. It contains settings that are
applied during install time.
If using DHCP, the following fields must be left unset - dns_servers,
management_port_subnets, and default_gateway_addresses
Name | Description | Type | Notes |
---|---|---|---|
allow_ssh_root_login | Allow root SSH logins If true, the root user will be allowed to log into the VM. Allowing root SSH logins is not recommended for security reasons. |
boolean | Default: "False" |
compute_id | Cluster identifier or resourcepool identifier The cluster node VM will be deployed on the specified cluster or resourcepool for specified VC server. |
string | Required |
default_gateway_addresses | Default IPv4 gateway for the VM The default IPv4 gateway for the VM to be deployed must be specified if all the other VMs it communicates with are not in the same subnet. Do not specify this field and management_port_subnets to use only IPv6. Note: only single IPv4 default gateway address is supported and it must belong to management network. IMPORTANT: VMs deployed using DHCP are currently not supported, so this parameter should be specified in case of IPv4. |
array of IPv4Address | Minimum items: 1 Maximum items: 1 |
default_ipv6_gateway_addresses | Default IPv6 gateway for the VM The default IPv6 gateway for the VM to be deployed must be specified if all the other VMs it communicates with are not in the same subnet. Do not specify this field and management_port_ipv6_subnets to use only IPv4. Note: only single IPv6 default gateway address is supported and it must belong to management network. IMPORTANT: VMs deployed using DHCP are currently not supported, so this parameter should be specified in case of IPv6. |
array of IPv6Address | Minimum items: 1 Maximum items: 1 |
disk_provisioning | Disk provitioning type Specifies the disk provisioning type of the VM. |
DiskProvisioning | Default: "THIN" |
dns_servers | DNS servers List of DNS servers. If DHCP is used, the default DNS servers associated with the DHCP server will be used instead. Required if using static IP. |
array of IPAddress | Minimum items: 1 |
enable_ssh | Enable SSH If true, the SSH service will automatically be started on the VM. Enabling SSH service is not recommended for security reasons. |
boolean | Default: "False" |
folder_id | Folder identifier Specifies the folder in which the VM should be placed. |
string | |
host_id | Host identifier The cluster node VM 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 VM Desired host name/FQDN for the VM to be deployed |
string | Required Pattern: "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*?$" |
management_network_id | Portgroup identifier for management network connectivity Distributed portgroup identifier to which the management vnic of cluster node VM will be connected. |
string | Required |
management_port_ipv6_subnets | IPv6 port subnets for management port IPv6 Address and subnet configuration for the management port. Do not specify this field and default_ipv6_gateway_addresses to use only IPv4. Note: only one IPv6 address is supported for the management port. IMPORTANT: VMs deployed using DHCP are currently not supported, so this parameter should be specified in case of IPv6. |
array of IPSubnet | Minimum items: 1 Maximum items: 1 |
management_port_subnets | IPv4 port subnets for management port IPv4 Address and subnet configuration for the management port. Do not specify this field and default_gateway_addresses to use only IPv6. Note: only one IPv4 address is supported for the management port. IMPORTANT: VMs deployed using DHCP are currently not supported, so this parameter should be specified in case of IPv4. |
array of IPSubnet | Minimum items: 1 Maximum items: 1 |
ntp_servers | NTP servers List of NTP servers. To use hostnames, a DNS server must be defined. If not using DHCP, a DNS server should be specified under dns_servers. |
array of HostnameOrIPAddress | |
placement_type | Must be set to the value VsphereClusterNodeVMDeploymentConfig | string | Required Enum: VsphereClusterNodeVMDeploymentConfig |
search_domains | DNS search domain names List of domain names that are used to complete unqualified host names. |
array of string | |
storage_id | Storage/datastore identifier The cluster node VM 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 |
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 |