Cluster Compute Resource Move Into Task

Moves an existing host into a cluster.

The host must be part of the same datacenter, and if the host is part of a cluster, the host must be in maintenance mode.

If the host is part of a stand-alone ComputeResource, then the stand-alone ComputeResource is removed as part of this operation.

All virtual machines associated with a host, regardless of whether or not they are running, are moved with the host into the cluster. If there are virtual machines that should not be moved, then migrate those virtual machines off the host before initiating this operation.

For stand-alone hosts, the host resource pool hierarchy is discarded in this call. To preserve a host resource pools from a stand-alone host, call moveHostInt, specifying an optional resource pool. This operation is transactional only with respect to each individual host. Hosts in the set are moved sequentially and are committed, one at a time. If a failure is detected, then the method terminates with an exception. Since hosts are moved one at a time, if this operation fails while in the process of moving multiple hosts, some hosts are left unmoved.

In addition to the privileges mentioned, the user must also hold Host.Inventory.EditCluster on the host's source ComputeResource object.

Required privileges: Host.Inventory.EditCluster

Request

URI

POST

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

MoveIntoRequestType of type(s) application/json

Required

{
    "host": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ]
}

array of MoRefHostSystem

host

Required

The list of hosts to move into the cluster.

Required privileges: Host.Inventory.MoveHost

Authentication

This operation uses the following authentication methods.

Session

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

NotSupportedHost: if the host is running a software version that does not support clustering features.

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

InvalidArgument: if one of the hosts is not part of the same datacenter as the cluster.

InvalidState: if a host is already part of a cluster and is not in maintenance mode.

DuplicateName: if the host is already in the cluster

DisallowedOperationOnFailoverHost: if the host is being moved from a cluster and was configured as a failover host in that cluster. See ClusterFailoverHostAdmissionControlPolicy.

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