VmPowerInfo

The Power.Info structure contains information about the power state of a virtual machine.

Properties

VmPowerState Enum

state Required

The Power.State enumerated type defines the valid power states for a virtual machine.
POWERED_OFF : The virtual machine is powered off.
POWERED_ON : The virtual machine is powered on.
SUSPENDED : The virtual machine is suspended.

Possible values are: POWERED_OFF , POWERED_ON , SUSPENDED

boolean

clean_power_off Optional

Flag indicating whether the virtual machine was powered off cleanly. This field may be used to detect that the virtual machine crashed unexpectedly and should be restarted. This field is optional and it is only relevant when the value of Power.Info.state is POWERED_OFF.

JSON Example

Show optional properties

{
	"state": "POWERED_OFF"
}

{
	"clean_power_off": false,
	"state": "POWERED_OFF"
}

Returned By

Get Power

VmPowerInfo

Properties

JSON Example

Returned By

Was this page helpful?