Esx.Settings.Depots.Offline.ConnectionSpec

Esx.Settings.Depots.Offline.ConnectionSpec
Esx.Settings.Depots.Offline.ConnectionSpec

The Esx.Settings.Depots.Offline.ConnectionSpec schema contains properties that describe the specification to be used for connecting to the host during the POST /esx/settings/depots/offline?action=createFromHost operation.

This schema was added in vSphere API 7.0.2.0.

JSON Example
{
    "auth_type": "string",
    "host_credential": {
        "host_name": "string",
        "user_name": "string",
        "password": "string",
        "port": 0,
        "ssl_thumb_print": "string",
        "ssl_certificate": "string"
    },
    "host": "string"
}
string
auth_type
Required

Specifies what type of authentication (AuthenticationType) is to be used when connecting with the host. USERNAME_PASSWORD is intended to be used when connecting to a host that is not currently part of the vCenter inventory. EXISTING is intended for hosts that are in vCenter inventory, in which case, HostServiceTicket will be used to connect to the host.

Possible values:

  • USERNAME_PASSWORD: Connect to host using host's credentials Esx.Settings.Depots.Offline.HostCredentials schema.
  • EXISTING: Connect to the host using service ticket. Note: This is supported only for hosts present in the VC inventory.

For more information see: Esx.Settings.Depots.Offline.ConnectionSpec.AuthenticationType.

This property was added in vSphere API 7.0.2.0.

host_credential
Optional

Specifies the host details to be used during the POST /esx/settings/depots/offline?action=createFromHost operation.

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of auth_type is Esx.Settings.Depots.Offline.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD.

string
host
Optional

Specifies the host Managed Object ID to be used during the POST /esx/settings/depots/offline?action=createFromHost operation.

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of auth_type is Esx.Settings.Depots.Offline.ConnectionSpec.AuthenticationType.EXISTING.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.