Data Object Description

Properties

Name	Type	Description
force	xsd:boolean	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.
hostGateway*	HostGatewaySpec	Deprecated. Not supported since vSphere 6.5 Setting for a gateway for communication to the host. If set all trafic to the host will pass through this gateway. *Since* vSphere API 6.0
hostName*	xsd:string	The DNS name or IP address of the host. (Required for adding a host.)
lockdownMode*	HostLockdownMode	If this is set then the host will be put in the specified lockdown mode when the host is added and connected. It is used only when calling the APIs AddStandaloneHost_Task with parameter 'addConnected' set to true, or AddHost_Task with parameter 'asConnected' set to true. If the operation to add the host specifies that the host should only be added but not connected, then the host won't be put in lockdown mode. This is equivalent to invoking ChangeLockdownMode immediately after addition and connection to the host succeeds. If equal to vim.host.HostAccessManager.LockdownMode#lockdownDisabled then it is ignored. *Since* vSphere API 6.0
managementIp*	xsd:string	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. *Since* vSphere API 4.0
password*	xsd:string	The password for the administration account. (Required for adding a host.)
port*	xsd:int	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.
sslThumbprint*	xsd:string	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 *Since* VI API 2.5
userName*	xsd:string	The administration account on the host. (Required for adding a host.)
vimAccountName*	xsd:string	The username to be used for accessing the virtual machine files on the disk.
vimAccountPassword*	xsd:string	The password to be used with the vimAccountName property for accessing the virtual machine files on the disk.
vmFolder*	ManagedObjectReference to a Folder	The folder in which to store the existing virtual machines on the host. If this folder is not specified, a default folder is chosen (and possibly created) by the VirtualCenter. This folder exists (or is possibly created) on the VirtualCenter server and is called "Discovered VM".
Properties inherited from DynamicData
None

Name

Type

Description

force

xsd:boolean

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.

hostGateway*

HostGatewaySpec

Deprecated. Not supported since vSphere 6.5

Setting for a gateway for communication to the host. If set all trafic to the host will pass through this gateway.

Since vSphere API 6.0

hostName*

xsd:string

The DNS name or IP address of the host. (Required for adding a host.)

lockdownMode*

HostLockdownMode

If this is set then the host will be put in the specified lockdown mode when the host is added and connected.

It is used only when calling the APIs AddStandaloneHost_Task with parameter 'addConnected' set to true, or AddHost_Task with parameter 'asConnected' set to true. If the operation to add the host specifies that the host should only be added but not connected, then the host won't be put in lockdown mode.

This is equivalent to invoking ChangeLockdownMode immediately after addition and connection to the host succeeds.

If equal to vim.host.HostAccessManager.LockdownMode#lockdownDisabled then it is ignored.

Since vSphere API 6.0

managementIp*

xsd:string

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.

Since vSphere API 4.0

password*

xsd:string

The password for the administration account. (Required for adding a host.)

port*

xsd:int

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.

sslThumbprint*

xsd:string

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

Since VI API 2.5

userName*

xsd:string

The administration account on the host. (Required for adding a host.)

vimAccountName*

xsd:string

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

vimAccountPassword*

xsd:string

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

vmFolder*

ManagedObjectReference
to a Folder

The folder in which to store the existing virtual machines on the host. If this folder is not specified, a default folder is chosen (and possibly created) by the VirtualCenter. This folder exists (or is possibly created) on the VirtualCenter server and is called "Discovered VM".

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostConnectSpec">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="hostName" type="xsd:string" minOccurs="0"/>
                     <element name="port" type="xsd:int" minOccurs="0"/>
                     <element name="sslThumbprint" type="xsd:string" minOccurs="0"/>
                     <element name="userName" type="xsd:string" minOccurs="0"/>
                     <element name="password" type="xsd:string" minOccurs="0"/>
                     <element name="vmFolder" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="force" type="xsd:boolean"/>
                     <element name="vimAccountName" type="xsd:string" minOccurs="0"/>
                     <element name="vimAccountPassword" type="xsd:string" minOccurs="0"/>
                     <element name="managementIp" type="xsd:string" minOccurs="0"/>
                     <element name="lockdownMode" type="vim25:HostLockdownMode" minOccurs="0"/>
                     <element name="hostGateway" type="vim25:HostGatewaySpec" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - HostConnectSpec(vim.host.ConnectSpec)

Data Object Description