HostConnectSpec

HostConnectSpec
HostConnectSpec

Specifies the parameters needed to add a single host.

This includes a small set of optional information about the host configuration. This allows the network and datastore configuration of the host to be synchronized with the naming conventions of the datacenter, as well as the configuration of a vim account (the username/password for the virtual machine files that is created on disk).

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "hostName": "string",
    "port": 0,
    "sslThumbprint": "string",
    "userName": "string",
    "password": "string",
    "vmFolder": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "force": false,
    "vimAccountName": "string",
    "vimAccountPassword": "string",
    "managementIp": "string",
    "lockdownMode": "string",
    "hostGateway": {
        "_typeName": "string",
        "gatewayType": "string",
        "gatewayId": "string",
        "trustVerificationToken": "string",
        "hostAuthParams": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ]
    }
}
string
hostName
Optional

The DNS name or IP address of the host.

(Required for adding a host.)

integer As int32 As int32
port
Optional

The port number for the connection.

If this is not specified, the default port number is used. For ESX 2.x hosts this is the authd port (902 by default). For ESX 3.x and above and VMware Server hosts this is the https port (443 by default). If this is a reconnect, the port number is unchanged.

string
sslThumbprint
Optional

The thumbprint of the SSL certificate, which the host is expected to have.

If this value is set and matches the certificate thumbprint presented by the host, then the host is authenticated. If this value is not set or does not match the certificate thumbprint presented by the host, then the host's certificate is verified by checking whether it was signed by a recognized CA.

The thumbprint is always computed using the SHA1 hash and is the string representation of that hash in the format: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where, 'x' represents a hexadecimal digit

string
userName
Optional

The administration account on the host.

(Required for adding a host.)

string As password As password
password
Optional

The password for the administration account.

(Required for adding a host.)

MoRefFolder
vmFolder
Optional

Reference to an instance of the Folder managed object.

boolean
force
Required

If this flag is set to "true", then the connection succeeds even if the host is already being managed by another VirtualCenter server.

The original VirtualCenter server loses connection to the host.

string
vimAccountName
Optional

The username to be used for accessing the virtual machine files on the disk.

string As password As password
vimAccountPassword
Optional

The password to be used with the vimAccountName property for accessing the virtual machine files on the disk.

string
managementIp
Optional

The IP address of the VirtualCenter server that will manage this host.

This field can be used to control which IP address the VirtualCenter agent will send heartbeats to. If it is not set, VirtualCenter will use the local IP address used when communicating with the host. Setting this field is useful when the VirtualCenter server is behind a NAT in which case the external NAT address must be used.

HostLockdownMode_enum
lockdownMode
Optional

Defines the possible states of lockdown mode.

Possible values:

  • lockdownDisabled: Indicates that lockdown mode is disabled.

  • lockdownNormal: Indicates that lockdown mode is enabled with service DCUI (Direct Console User Interface) running.

  • lockdownStrict: Indicates that lockdown mode is enabled with service DCUI stopped.

    If the host is in "strict" lockdown mode then no one will be able to exit lockdown mode through DCUI in emergency situations, i.e. when the connection to vCenter server is permanently lost.

Possible values are : lockdownDisabled, lockdownNormal, lockdownStrict,
HostGatewaySpec
hostGateway
Optional

Deprecated not supported since vSphere 6.5.

Settings for a gateway used to communicate with a host.

Property Of