Esx.Settings.Hosts.Internal.DesiredState.ConnectionSpec

The Esx.Settings.Hosts.Internal.DesiredState.ConnectionSpec schema contains properties that describe the specification to be used for connecting to the host during the com.vmware.esx.hosts.internal.DesiredState#set operation

This schema was added in vSphere API 8.0.0.1.

Note: this schema is restricted for VMware internal use only.

JSON Example

{
    "authentication": "string",
    "username_password_credential": {
        "host_name": "string",
        "user_name": "string",
        "password": "string",
        "port": 0,
        "ssl_thumb_print": "string",
        "ssl_certificate": "string"
    }
}

string

authentication

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.

Possible values:

USERNAME_PASSWORD: Connect to host using host's credentials HostCredentials schema.

For more information see: Esx.Settings.Hosts.Internal.DesiredState.ConnectionSpec.AuthenticationType.

This property was added in vSphere API 8.0.0.1.

username_password_credential

Optional

Specifies the host details to be used during the com.vmware.esx.hosts.internal.DesiredState#set operation

This property was added in vSphere API 8.0.0.1.

This property is optional and it is only relevant when the value of authentication is Esx.Settings.Hosts.Internal.DesiredState.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD.