Vm_Power_Info

Vm_Power_Info
Vm_Power_Info

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

JSON Example
{
    "state": "string",
    "clean_power_off": false
}
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.

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.

Returned By