InlineVsphereClusterNodeVMDeploymentConfig1

InlineVsphereClusterNodeVMDeploymentConfig1
InlineVsphereClusterNodeVMDeploymentConfig1
JSON Example
{
    "allow_ssh_root_login": false,
    "compute_id": "string",
    "default_gateway_addresses": [
        "string"
    ],
    "default_ipv6_gateway_addresses": [
        "string"
    ],
    "disk_provisioning": "string",
    "dns_servers": [
        "string"
    ],
    "enable_ssh": false,
    "folder_id": "string",
    "host_id": "string",
    "hostname": "string",
    "management_network_id": "string",
    "management_port_ipv6_subnets": [
        {
            "ip_addresses": [
                "string"
            ],
            "prefix_length": 0
        }
    ],
    "management_port_subnets": [
        "IPSubnet Object"
    ],
    "ntp_servers": [
        "string"
    ],
    "search_domains": [
        "string"
    ],
    "storage_id": "string",
    "vc_id": "string"
}
boolean
allow_ssh_root_login
Optional

If true, the root user will be allowed to log into the VM. Allowing root SSH logins is not recommended for security reasons.

string
compute_id
Required

The cluster node VM will be deployed on the specified cluster or resourcepool for specified VC server.

array of string
default_gateway_addresses
Optional
Constraints: minItems: 1 maxItems: 1

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 string
default_ipv6_gateway_addresses
Optional
Constraints: minItems: 1 maxItems: 1

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.

string
disk_provisioning
Optional
Constraints: default: THIN

Specifies the disk provisioning type of the VM.

Possible values are : THIN, LAZY_ZEROED_THICK, EAGER_ZEROED_THICK,
array of string
dns_servers
Optional
Constraints: minItems: 1

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.

boolean
enable_ssh
Optional

If true, the SSH service will automatically be started on the VM. Enabling SSH service is not recommended for security reasons.

string
folder_id
Optional

Specifies the folder in which the VM should be placed.

string
host_id
Optional

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 As /^(?=.{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])?)*?$/
hostname
Required

Desired host name/FQDN for the VM to be deployed

string
management_network_id
Required

Distributed portgroup identifier to which the management vnic of cluster node VM will be connected.

array of IPSubnet
management_port_ipv6_subnets
Optional
Constraints: minItems: 1 maxItems: 1

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
management_port_subnets
Optional
Constraints: minItems: 1 maxItems: 1

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 string
ntp_servers
Optional

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 string
search_domains
Optional

List of domain names that are used to complete unqualified host names.

string
storage_id
Required

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
vc_id
Required

The VC-specific identifiers will be resolved on this VC, so all other identifiers specified in the config must belong to this vCenter server.

Used By