vm.status

Get the status of id VM.

Returns a dict: - state, RUNNING / STOPPED / SUSPENDED - pid, process id if RUNNING

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the virtual machine to get status for.

VMStatus

Type: object

Current status and runtime information for the virtual machine.

 No Additional Properties

State

Type: string Default: "127.0.0.1"

Current state of the virtual machine.

Must be at least 1 characters long


Examples:

"RUNNING"

"STOPPED"

"SUSPENDED"

Pid


Process ID of the running VM. null if not running.

Type: integer
Type: null

Domain State

Type: string

Hypervisor-specific domain state.

Must be at least 1 characters long



Required roles: VM_READ