PerformClusterPowerActionSpec

PerformClusterPowerActionSpec

This class describes the PerformClusterPowerActionSpec spec.

It can be used in PerformClusterPowerAction.

This structure may be used only with operations rendered under /vsan.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "targetPowerStatus": "string",
    "isOrchestration": false,
    "initialPowerStatus": "string",
    "powerOffReason": "string",
    "infraVMs": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "infraVMUuids": [
        "string"
    ]
}

string

targetPowerStatus

Required

Specify the target vim.cluster.ClusterPowerStatus.

If the spec is applied on VC, only clusterPoweredOn and clusterPoweredOff are allowed. If the spec is applied on host with isOrchestration set to true, only clusterPoweredOn and clusterPoweredOff are allowed and initialPowerStatus must be set. If the spec is applied on host with isOrchestration set to false, only host level status are allowed as following: vsanMemberShipUpdateDisabled, vsanDOMPauseAllCCPsSet, hostsInMM, hostsPoweredOff, hostsOutOfMM, vsanMemberShipUpdateEnabled, vsanDOMPauseAllCCPsUnset.

See also ClusterPowerStatusEnum.

boolean

isOrchestration

Optional

Note this only works in a host level API call to indicate whether this call applies the orchestration host logic or not.

If isOrchestration is True, the host coordinates all other hosts in the cluster to take power action. Otherwise, it executes each step on the host itself.

string

initialPowerStatus

Optional

Note this only works in an orchestration host level API call to indicate which power action item step is to begin with.

See also ClusterPowerStatusEnum.

string

powerOffReason

Optional

Provide the power off reason.

It should be less than 512 characters in length.

array of MoRefVirtualMachine

infraVMs

Optional

The infrastructure VMs that will be force to power off during the power off workflow and will be automatically powered on.

This only works in a vc level API call and is ignored in the host level API call.

array of string

infraVMUuids

Optional

The uuid of infrastructure VMs that will be force to power off during the power off workflow and will be automatically powered on.

This only works in a host level API call and is ignored in the vc level API call.

Property Of

ArrayOfPerformClusterPowerActionSpec