1. Types
  2. vcenter
  3. lcm

vcenter lcm: destination appliance

Spec to describe the new appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "ovftool_arguments" : {
        "<string>" : "string"
    },
    "appliance_size" : "TINY",
    "ova_location_ssl_verify" : true,
    "ova_location_ssl_thumbprint" : "string",
    "ova_location" : "string",
    "root_password" : "secret string",
    "vcsa_embedded" : {
        "ceip_enabled" : true,
        "standalone" : {
            "sso_admin_password" : "secret string",
            "sso_domain_name" : "string"
        },
        "replicated" : {
            "sso_admin_password" : "secret string",
            "https_port" : 1,
            "sso_domain_name" : "string",
            "ssl_verify" : true,
            "ssl_thumbprint" : "string",
            "partner_hostname" : "string"
        }
    },
    "services" : {
        "ssh" : {
            "enabled" : true
        },
        "rhttpproxy" : {
            "https_port" : 1,
            "http_port" : 1
        }
    },
    "ovftool_location_ssl_verify" : true,
    "vmc" : {
        "sso_admin_password" : "secret string",
        "https_port" : 1,
        "psc_hostname" : "string",
        "sso_domain_name" : "string",
        "ssl_verify" : true,
        "ssl_thumbprint" : "string"
    },
    "ovftool_location_ssl_thumbprint" : "string",
    "network" : {
        "mode" : "DHCP",
        "ip_family" : "IPV4",
        "hostname" : "string",
        "prefix" : 1,
        "ip" : "string",
        "gateway" : "string",
        "dns_servers" : [
            "string",
            "string"
        ]
    },
    "appliance_name" : "string",
    "appliance_disk_size" : "LARGE",
    "thin_disk_mode" : true,
    "time" : {
        "ntp_servers" : [
            "string",
            "string"
        ]
    },
    "ovftool_location" : "string",
    "appliance_type" : "VCSA_EXTERNAL"
}
{
    "ovftool_arguments" : [
        {
            "value" : "string",
            "key" : "string"
        }
    ],
    "appliance_size" : "TINY",
    "ova_location_ssl_verify" : true,
    "ova_location_ssl_thumbprint" : "string",
    "ova_location" : "string",
    "root_password" : "secret string",
    "vcsa_embedded" : {
        "ceip_enabled" : true,
        "standalone" : {
            "sso_admin_password" : "secret string",
            "sso_domain_name" : "string"
        },
        "replicated" : {
            "sso_admin_password" : "secret string",
            "https_port" : 1,
            "sso_domain_name" : "string",
            "ssl_verify" : true,
            "ssl_thumbprint" : "string",
            "partner_hostname" : "string"
        }
    },
    "services" : {
        "ssh" : {
            "enabled" : true
        },
        "rhttpproxy" : {
            "https_port" : 1,
            "http_port" : 1
        }
    },
    "ovftool_location_ssl_verify" : true,
    "vmc" : {
        "sso_admin_password" : "secret string",
        "https_port" : 1,
        "psc_hostname" : "string",
        "sso_domain_name" : "string",
        "ssl_verify" : true,
        "ssl_thumbprint" : "string"
    },
    "ovftool_location_ssl_thumbprint" : "string",
    "network" : {
        "mode" : "DHCP",
        "ip_family" : "IPV4",
        "hostname" : "string",
        "prefix" : 1,
        "ip" : "string",
        "gateway" : "string",
        "dns_servers" : [
            "string",
            "string"
        ]
    },
    "appliance_name" : "string",
    "appliance_disk_size" : "LARGE",
    "thin_disk_mode" : true,
    "time" : {
        "ntp_servers" : [
            "string",
            "string"
        ]
    },
    "ovftool_location" : "string",
    "appliance_type" : "VCSA_EXTERNAL"
}

Attributes:

Name Type Description
Required
-.appliance_name string The name of the appliance to deploy. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance_type string The type of appliance to deploy. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

The type of appliance to be deployed. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
VCSA_EXTERNAL: Management node. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
VCSA_EMBEDDED: Embedded node. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PSC: Infrastructure node. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
VMC: VMC node. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.root_password secret Password must conform to the following requirements: 1. At least 8 characters. 2. No more than 20 characters. 3. At least 1 uppercase character. 4. At least 1 lowercase character. 5. At least 1 number. 6. At least 1 special character (e.g., '!', '(', '@', etc.). 7. Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.thin_disk_mode boolean Whether to deploy the appliance with thin mode virtual disks. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.ova_location string The location of the OVA file. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.ovftool_location string The location of the OVF Tool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.services destination_appliance_service The configuration of vCenter services. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.services.ssh ssh Whether to enable SSH on the vCenter Appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Default value is used when SSH configuration is not provided.

-.network network The network settings of the appliance to be deployed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.network.mode string Network mode. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Network mode. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
DHCP: DHCP mode. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
STATIC: Static IP mode. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.time time Configuration of the vCSA time synchronization. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vcsa_embedded.standalone.sso_admin_password secret Password must conform to the following requirements: 1. At least 8 characters. 2. No more than 20 characters. 3. At least 1 uppercase character. 4. At least 1 lowercase character. 5. At least 1 number. 6. At least 1 special character (e.g., '!', '(', '@', etc.). 7. Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vcsa_embedded.standalone.sso_domain_name string The Single Sign-On domain name to be used to configure this vCenter Server Appliance. For example, 'vsphere.local'. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vcsa_embedded.replicated.sso_admin_password secret Administrator password of the existing Single Sign-On to be replicated. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vcsa_embedded.replicated.sso_domain_name string Domain name for the remote appliance which is being replicated. For example, 'vsphere.local'. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vcsa_embedded.replicated.partner_hostname string The IP address or DNS resolvable name for the remote appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vcsa_embedded.ceip_enabled boolean This key describes the enabling option for the VMware's Customer Experience Improvement Program (CEIP). By default we have ceip_enabled: true, which indicates that you are joining CEIP. If you prefer not to participate in the VMware's CEIP for this product, you must disable CEIP by setting ceip_enabled: false. You may join or leave VMware's CEIP for this product at any time. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If unset, defaults to True.

-.vmc.sso_admin_password secret Administrator password of the external PSC to register with. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vmc.sso_domain_name string Domain name of the external PSC. For example, 'vsphere.local'. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vmc.psc_hostname string The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Optional
-.appliance_size string A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when appliance_type has value [VCSA_EMBEDDED]. This field is optional and it is only relevant when the value of appliance_type is VCSA_EMBEDDED.
-.appliance_disk_size string The disk size of the new vCenter appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when appliance_type has value [VCSA_EMBEDDED]. This field is optional and it is only relevant when the value of appliance_type is VCSA_EMBEDDED.
-.ova_location_ssl_verify boolean A flag to indicate whether the ssl verification is required. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If ova_location_ssl_thumbprint is provided, this field can be omitted If unset, defaults to True.

-.ova_location_ssl_thumbprint string SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If ova_location_ssl_verify is False, this field can be omitted.

-.ovftool_location_ssl_verify boolean Flag to indicate whether or not to verify the SSL thumbprint of OVF Tool location. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. if unset, Default to be True.
-.ovftool_location_ssl_thumbprint string SSL thumbprint of OVF Tool location to be verified. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. When ovftoolLocationSslVerify is set to False, this field can be omitted.
-.services.rhttpproxy reverse_proxy Port numbers on which the vCenter Server Appliance communicates with the other vSphere components. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Default value used reverse proxy not provided.

-.services.rhttpproxy.http_port long Reverse proxy http port. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, defaults to 8080.

-.services.rhttpproxy.https_port long Reverse proxy https port. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, defaults to 8443.

-.services.ssh.enabled boolean Whether to enable SSH. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, defaults to False.

-.network.hostname string Primary network identity. Can be either an IP address or a fully qualified domain name(FQDN). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value STATIC. host name may not be applicable.

-.network.ip_family string Network IP address family. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

-.network.ip string Network IP address. Required for static mode only. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value STATIC. This field is optional and it is only relevant when the value of mode is STATIC.
-.network.dns_servers string[] A comma-separated list of IP addresses of DNS servers. A JSON array such as ["1.2.3.4", "127.0.0.1"]. Required for static mode only. DNS servers must be reachable from the machine that runs CLI installer. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value STATIC. This field is optional and it is only relevant when the value of mode is STATIC.
-.network.prefix long Network prefix length. Required for static mode only. Remove if the mode is "dhcp". This is the number of bits set in the subnet mask; for instance, if the subnet mask is 255.255.255.0, there are 24 bits in the binary version of the subnet mask, so the prefix length is 24. If used, the values must be in the inclusive range of 0 to 32 for IPv4 and 0 to 128 for IPv6. Required for static mode only. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value STATIC. This field is optional and it is only relevant when the value of mode is STATIC.
-.network.gateway string Gateway of the network. Required for static mode only. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value STATIC. This field is optional and it is only relevant when the value of mode is STATIC.
-.time.ntp_servers string[] To configure NTP time synchronization for the appliance, set the value to a comma - separated list of host names or IP addresses of Network Time Protocol(NTP) servers. If "ntp_servers" is not provided, the appliance clock will be synced to the ESX. For example: ["time.nist.gov"]. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Times tool sync will be enabled when ntp server is not provided. If unset, defaults to [].

-.ovftool_arguments object The OVF Tool arguments to be included. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Not required when no OVF Tool argument to pass through.

-.vcsa_embedded vcsa_embedded Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when appliance_type has value [VCSA_EMBEDDED]. This field is optional and it is only relevant when the value of appliance_type is VCSA_EMBEDDED.
-.vcsa_embedded.standalone embedded_standalone_vcsa Spec used to configure a standalone embedded vCenter Server. This field describes how the standalone vCenter Server appliance should be configured. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Mutually exclusive between standalone and replicated.

-.vcsa_embedded.replicated embedded_replicated_vcsa Spec used to configure a replicated embedded vCenter Server. This field describes how the replicated vCenter Server appliance should be configured. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Mutually exclusive between standalone and replicated.

-.vcsa_embedded.replicated.ssl_verify boolean A flag to indicate whether the ssl verification is required. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If ssl_thumbprint is provided, this field can be omitted If unset, defaults to True.

-.vcsa_embedded.replicated.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate which will be used for verification. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If sslVerify is set to False, this field can be omitted.

-.vcsa_embedded.replicated.https_port long The HTTPS port of the external PSC appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, defaults to 443.

-.vmc external_vcsa Spec used to configure a vCenter Server registered with an external PSC. If unset, either vcsa_embedded or psc must be provided. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when appliance_type has value [VMC]. This field is optional and it is only relevant when the value of appliance_type is VMC.
-.vmc.ssl_verify boolean A flag to indicate whether the SSL verification is required. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If ssl_thumbprint is provided, this field can be omitted If unset, defaults to False.

-.vmc.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate which will be used for verification. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If ssl_verify is set to False, this field can be omitted.
-.vmc.https_port long The HTTPS port of the external PSC appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, defaults to 443.