VM_Summary

VM_Summary
VM_Summary

The VM.Summary structure contains commonly used information about a virtual machine.

JSON Example
{
    "vm": "string",
    "name": "string",
    "power_state": "string",
    "cpu_count": 0,
    "memory_size_MiB": 0
}
string
vm
Required

Identifier of the virtual machine. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.

string
name
Required

Name of the Virtual machine.

power_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.

integer As int64
cpu_count
Optional

Number of CPU cores. This field will be unset if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

integer As int64
memory_size_MiB
Optional

Memory size in mebibytes. This field will be unset if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.