Host System Reconnect Host Task

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

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/ReconnectHost_Task
COPY
Path Parameters
string
moId
Required

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}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
ReconnectHostRequestType of type(s) application/json
Required
{
    "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
    }
}
cnxSpec
Optional

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).

reconnectSpec
Optional

Specifies the parameters needed to merge vCenter Server settings and host settings on reconnect.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

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.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Host System Operations
POST
Host System Acquire Cim Services Ticket
POST
Host System Configure Crypto Key
POST
Host System Destroy Task
POST
Host System Disconnect Host Task
POST
Host System Enable Crypto
POST
Host System Enter Lockdown Mode
POST
Host System Enter Maintenance Mode Task
POST
Host System Exit Lockdown Mode
POST
Host System Exit Maintenance Mode Task
GET
Host System Get Alarm Actions Enabled
GET
Host System Get Answer File Validation Result
GET
Host System Get Answer File Validation State
GET
Host System Get Available Field
GET
Host System Get Capability
GET
Host System Get Compliance Check Result
GET
Host System Get Compliance Check State
GET
Host System Get Config
GET
Host System Get Config Issue
GET
Host System Get Config Manager
GET
Host System Get Config Status
GET
Host System Get Custom Value
GET
Host System Get Datastore
GET
Host System Get Datastore Browser
GET
Host System Get Declared Alarm State
GET
Host System Get Disabled Method
GET
Host System Get Effective Role
GET
Host System Get Hardware
GET
Host System Get Licensable Resource
GET
Host System Get Name
GET
Host System Get Network
GET
Host System Get Overall Status
GET
Host System Get Parent
GET
Host System Get Permission
GET
Host System Get Precheck Remediation Result
GET
Host System Get Recent Task
GET
Host System Get Remediation Result
GET
Host System Get Remediation State
GET
Host System Get Runtime
GET
Host System Get Summary
GET
Host System Get System Resources
GET
Host System Get Tag
GET
Host System Get Triggered Alarm State
GET
Host System Get Value
GET
Host System Get Vm
POST
Host System Power Down Host To Stand By Task
POST
Host System Power Up Host From Stand By Task
POST
Host System Prepare Crypto
POST
Host System Query Host Connection Info
POST
Host System Query Memory Overhead
POST
Host System Query Memory Overhead Ex
POST
Host System Query Product Locker Location
POST
Host System Query Tpm Attestation Report
POST
Host System Reboot Host Task
POST
Host System Reconfigure Host For DAS Task
POST
Host System Reconnect Host Task
POST
Host System Reload
POST
Host System Rename Task
POST
Host System Retrieve Free Epc Memory
POST
Host System Retrieve Hardware Uptime
POST
Host System Set Custom Value
POST
Host System Shutdown Host Task
POST
Host System Update Flags
POST
Host System Update Ipmi
POST
Host System Update Product Locker Location Task
POST
Host System Update System Resources
POST
Host System Update System Swap Configuration