Host System Power Up Host From Stand By Task

Takes the host out of standby mode.

If the command is successful, the host wakes up and starts sending heartbeats. This method may be called automatically by a dynamic recommendation generation module to add capacity to a cluster, if the host is not in maintenance mode.

Note that, depending on the implementation of the wakeup method, the client may never receive an indicator of success in the returned task. In some cases, it is not even possible to ensure that the wakeup request has made it to the host.

The task is cancellable.

Required privileges: Host.Config.Maintenance

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/PowerUpHostFromStandBy_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.3.0 APIs.

Request Body

PowerUpHostFromStandByRequestType of type(s) application/json

Required

{
    "timeoutSec": 0
}

integer As int32 As int32

timeoutSec

Required

The task completes when the host successfully exits standby state and sends a heartbeat signal. If nothing is received from the host for timeoutSec seconds, the host is declared timedout, and the task is assumed failed.

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

HostPowerOpFailed: if the standby operation fails.

InvalidState: if the host is in a state from which it cannot be woken up (e.g., disconnected, poweredOff)

NotSupported: if the host does not support standby mode.

Timedout: if the host did not exit standby mode in the given time

RequestCanceled: if the operation is canceled.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters