Cluster Compute Resource Add Host Task

Adds a host to the cluster.

The hostname must be either an IP address, such as 192.168.0.1, or a DNS resolvable name. DNS names may be fully qualified names, such as host1.domain1.com, or a short name such as host1, providing host1 resolves to host1.domain1.com. The system uses DNS to resolve short names to fully qualified names. If the cluster supports nested resource pools and the user specifies the optional ResourcePool argument, then the host's root resource pool becomes the specified resource pool. The stand-alone host resource hierarchy is imported into the new nested resource pool.

If the cluster does not support nested resource pools, then the stand-alone host resource hierarchy is discarded and all virtual machines on the host are put under the cluster's root resource pool.

In addition to the Host.Inventory.AddHostToCluster and Resource.AssignVMToPool privileges, it requires System.View privilege on the VM folder that the VMs of the host will be placed on.

Required privileges: Host.Inventory.AddHostToCluster

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/AddHost_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 ClusterComputeResource/{moId}.

string

release

Required

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

Request Body

AddHostRequestType of type(s) application/json

Required

{
    "spec": {
        "hostName": "string",
        "port": 0,
        "sslThumbprint": "string",
        "userName": "string",
        "password": "string",
        "vmFolder": {
            "type": "string",
            "value": "string"
        },
        "force": false,
        "vimAccountName": "string",
        "vimAccountPassword": "string",
        "managementIp": "string",
        "lockdownMode": "string",
        "hostGateway": {
            "gatewayType": "string",
            "gatewayId": "string",
            "trustVerificationToken": "string",
            "hostAuthParams": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    },
    "asConnected": false,
    "resourcePool": {
        "type": "string",
        "value": "string"
    },
    "license": "string"
}

HostConnectSpec

spec

Required

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

boolean

asConnected

Required

Flag to specify whether or not the host should be connected immediately after it is added. The host will not be added if a connection attempt is made and fails.

MoRefResourcePool

resourcePool

Optional

Reference to an instance of the ResourcePool managed object.

string

license

Optional

Provide a licenseKey or licenseKeyType. See LicenseManager

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly added HostSystem upon success.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidLogin: if "asConnected" is specified but authentication with the new host fails.

HostConnectFault: if an error occurred when connecting to a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown.

AlreadyBeingManaged: if the host is already being managed by a VirtualCenter server.

NotEnoughLicenses: if no licenses are available to add this host.

NoHost: if the host cannot be contacted.

NotSupportedHost: if the host is running a software version that does not support clustering features. It may still be possible to add the host as a stand-alone host.

TooManyHosts: if no additional hosts can be added to the cluster.

AgentInstallFailed: if there is an error installing the VirtualCenter agent on the host.

AlreadyConnected: if asConnected is true and the host is already connected to VirtualCenter.

SSLVerifyFault: if the host certificate could not be authenticated

DuplicateName: if another host in the same cluster has the name.

NoPermission: if there are crypto keys to be sent to the host, but the user does not have Cryptographer.RegisterHost privilege on the Cluster.

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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Cluster Compute Resource Operations

POST

Cluster Compute Resource Abandon Hci Workflow