REST API - destination

vcenter lcm: destination location

Configuration of destination location. 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

{
    "vcenter" : {
        "connection" : {
            "hostname" : "string",
            "password" : "secret string",
            "https_port" : 1,
            "ssl_verify" : true,
            "ssl_thumbprint" : "string",
            "username" : "string"
        },
        "inventory" : {
            "host_path" : "string",
            "datastore_cluster_name" : "string",
            "vm_folder_path" : "string",
            "cluster_path" : "string",
            "network_name" : "string",
            "datastore_name" : "string",
            "resource_pool_path" : "string"
        }
    },
    "esx" : {
        "connection" : {
            "hostname" : "string",
            "password" : "secret string",
            "https_port" : 1,
            "ssl_verify" : true,
            "ssl_thumbprint" : "string",
            "username" : "string"
        },
        "inventory" : {
            "network_name" : "string",
            "datastore_name" : "string",
            "resource_pool_path" : "string"
        }
    }
}

Attributes:

Name	Type	Description
Required
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.
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.
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.
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.
esx.inventory	esx_inventory	The configuration of ESX inventory. 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.
esx.inventory.datastore_name	string	The datastore on which to store the files of the appliance. This value has to be either a specific datastore name, or a specific datastore in a datastore cluster. The datastore must be accessible from the ESX host and must have at least 25 GB of free space. Otherwise, the new appliance might not power on. 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.
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.
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.
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.
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.
vcenter.inventory	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.
vcenter.inventory.network_name	string	Name of the network. e.g. VM Network. 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
esx	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`.
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.
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.
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.
esx.inventory.network_name	string	The network of the ESX host to which the new appliance should connect. Omit this parameter if the ESX host has one network. 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 VM Network.
esx.inventory.resource_pool_path	string	The path to the resource pool on the ESX host in which the appliance will 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. Optional. Not applicable when not in resource pool.
vcenter	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`.
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.
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.
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.
vcenter.inventory.vm_folder_path	string	Path of the VM folder. VM folder must be visible by the Data Center of the compute resourceFormat:{vm_folder1}/{vm_folder2}e.g.:'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. Optional. Mutually exclusive between `#resource_pool_path`, `#cluster_path`, and `#host_path`.
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`.
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`.
vcenter.inventory.host_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.
vcenter.inventory.datastore_name	string	The datastore on which to store the files of the appliance. This value has to be either a specific datastore name, or a specific datastore in a datastore cluster. The datastore must be accessible from the ESX host and must have at least 25 GB of free space. Otherwise, the new appliance might not power on. 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 `#datastore_name` and `#datastore_cluster_name`.
vcenter.inventory.datastore_cluster_name	string	The datastore cluster on which to store the files of 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. Mutually exclusive between `#datastore_name` and `#datastore_cluster_name`.