Host System Reconnect Host Task
Reconnects to a host.
This process reinstalls agents and reconfigures the host, if it has gotten out of date with VirtualCenter. The reconnection process goes through many of the same steps as addHost: ensuring the correct set of licenses for the number of CPUs on the host, ensuring the correct set of agents is installed, and ensuring that networks and datastores are discovered and registered with VirtualCenter.
The client can change the IP address and port of the host when doing a reconnect operation. This can be useful if the client wants to preserve existing metadata, even though the host is changing its IP address. For example, clients could preserve existing statistics, alarms, and privileges.
This method can also be used to change the SSL thumbprint of a connected host without disconnecting it.
Any changes made to the resource hierarchy on the host when the host was disconnected are overriden by VirtualCenter settings on reconnect.
This method is only supported through VirtualCenter.
Required privileges: Host.Config.Connection
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case HostSystem/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"cnxSpec": {
"_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"
}
]
}
},
"reconnectSpec": {
"_typeName": "string",
"syncState": false
}
}
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).
Specifies the parameters needed to merge vCenter Server settings and host settings on reconnect.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
NotSupported: if no host can be added to this group. This is the case if the ComputeResource is a standalone type.
InvalidLogin: if the method fails to authenticate with the host.
AlreadyBeingManaged: if host is already being managed by another VirtualCenter server
NotEnoughLicenses: if there are not enough licenses to add this host.
NoHost: if the method is unable to contact the server.
NotSupportedHost: if the host is running a software version that is not supported.
InvalidState: if the host is not disconnected.
InvalidName: if the host name is invalid.
HostConnectFault: if an error occurred when attempting to reconnect to a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown.
SSLVerifyFault: if the host certificate could not be authenticated.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}