REST API - appliance_name

vcenter lcm validation: appliance name request

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:

JSON

{
    "destination_location" : {
        "vcenter" : {
            "connection" : {
                "hostname" : "string",
                "password" : "secret string",
                "https_port" : 1,
                "ssl_verify" : true,
                "ssl_thumbprint" : "string",
                "username" : "string"
            },
            "inventory" : {
                "host_path" : "string",
                "vm_folder_path" : "string",
                "cluster_path" : "string",
                "resource_pool_path" : "string"
            }
        },
        "esx" : {
            "connection" : {
                "hostname" : "string",
                "password" : "secret string",
                "https_port" : 1,
                "ssl_verify" : true,
                "ssl_thumbprint" : "string",
                "username" : "string"
            }
        }
    },
    "destination_appliance" : {
        "appliance_name" : "string"
    }
}

Attributes:

Name	Type	Description
Required
destination_location	appliance_name_destination_location	This subsection describes the ESX or VC on which to deploy the 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.
destination_location.esx.connection	connection	The configuration to connect to an ESX/VC. 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.
destination_location.esx.connection.hostname	string	The IP address or DNS resolvable name of the ESX/VC host. If a DNS resolvable name is provided, it must be resolvable from the machine that is running the 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.
destination_location.esx.connection.username	string	A username with administrative privileges on the ESX/VC host. 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.
destination_location.esx.connection.password	secret	The password of the 'username' on the ESX/VC host. 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.
destination_location.vcenter.connection	connection	The configuration to connect to an ESX/VC. 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.
destination_location.vcenter.connection.hostname	string	The IP address or DNS resolvable name of the ESX/VC host. If a DNS resolvable name is provided, it must be resolvable from the machine that is running the 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.
destination_location.vcenter.connection.username	string	A username with administrative privileges on the ESX/VC host. 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.
destination_location.vcenter.connection.password	secret	The password of the 'username' on the ESX/VC host. 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.
destination_location.vcenter.inventory	appliance_name_vc_inventory	All names are case-sensitive. you can install the appliance to one of the following destinations: 1. A resource pool in a cluster, use 'cluster_path'. 2. A specific ESX host in a cluster, use 'host_path'. 3. A resource pool in a specific ESX host being managed by the current vCenter, use 'resource_pool_path'. You must always provide the 'network_name' key. To install a new appliance to a specific ESX host in a cluster, provide the 'host_path' key, and the 'datastore_name', e.g. 'host_path': '/MyDataCenter/host/MyCluster/10.20.30.40', 'datastore_name': 'Your Datastore'. To install a new appliance to a specific resource pool, provide the 'resource_pool_path', and the 'datastore_name', e.g. 'resource_pool_path': '/Your Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource Pool', 'datastore_name': 'Your Datastore'. To place a new appliance to a virtual machine Folder, provide the 'vm_folder_path', e.g. 'vm_folder_path': 'VM Folder 0/VM Folder1'. 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.
destination_appliance	appliance_name_destination_appliance	Spec to describe the new 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.
destination_appliance.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.
Optional
destination_location.esx	appliance_name_esx	This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host. 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. Mutual exclusive between `esx` and `vcenter`.
destination_location.esx.connection.https_port	long	The port number for the ESX/VC. 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.
destination_location.esx.connection.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.
destination_location.esx.connection.ssl_thumbprint	string	Thumbprint for SSL 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` if false, this field is not required.
destination_location.vcenter	appliance_name_vc	This subsection describes the vCenter on which to deploy the 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. Mutual exclusive between `esx` and `vcenter`.
destination_location.vcenter.connection.https_port	long	The port number for the ESX/VC. 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.
destination_location.vcenter.connection.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.
destination_location.vcenter.connection.ssl_thumbprint	string	Thumbprint for SSL 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` if false, this field is not required.
destination_location.vcenter.inventory.vm_folder_path	string	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.
destination_location.vcenter.inventory.resource_pool_path	string	Full path to resource pool. Format: /{datacenter folder}/{datacenter name}/host/{host name}/{cluster_name}/Resources/{resource pool}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource Pool. 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 `#resource_pool_path`, `#cluster_path`, and `#host_path`.
destination_location.vcenter.inventory.cluster_path	string	Full path to the cluster. Format: /{datacenter folder}/{datacenter name}/host/{cluster_name}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Cluster. 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 `#resource_pool_path`, `#cluster_path`, and `#host_path`.
destination_location.vcenter.inventory.host_path	string	Full path to an ESX host. Format: /{datacenter folder}/{datacenter name}/host/{host name}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Host. 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 `#resource_pool_path`, `#cluster_path`, and `#host_path`.