EnterMaintenanceModeRequestType

EnterMaintenanceModeRequestType
EnterMaintenanceModeRequestType

The parameters of EnterMaintenanceMode_Task.

JSON Example
{
    "timeout": 0,
    "evacuatePoweredOffVms": false,
    "maintenanceSpec": {
        "_typeName": "string",
        "vsanMode": {
            "_typeName": "string",
            "objectAction": "string"
        },
        "purpose": "string"
    }
}
integer As int32 As int32
timeout
Required

The task completes when the host successfully enters maintenance mode or the timeout expires, and in the latter case the task contains a Timeout fault. If the timeout is less than or equal to zero, there is no timeout. The timeout is specified in seconds.

boolean
evacuatePoweredOffVms
Optional

This is a parameter only supported by VirtualCenter. If set to true, for a DRS disabled cluster, the task will not succeed unless all powered-off virtual machines have been manually reregistered; for a DRS enabled cluster, VirtualCenter will automatically reregister powered-off virtual machines and a powered-off virtual machine may remain at the host only for two reasons: (a) no compatible host found for reregistration, (b) DRS is disabled for the virtual machine. If set to false, powered-off virtual machines do not need to be moved.

maintenanceSpec
Optional

The HostMaintenanceSpec data object may be used to specify actions to be taken by a host upon entering maintenance mode.

If the HostMaintenanceSpec or any of its fields are omitted in a call to EnterMaintenanceMode_Task, default actions will be chosen as documented for each field's type.

See also EnterMaintenanceMode_Task, VsanHostDecommissionMode.