GetVMState

Will retrieve the current state of the virtual machine.

Syntax

Method ID

#define WAAPI_MID_GET_VM_STATE 1020

JSON Input Structure

{
  "input": {
    "method": 1020,
    "signature": number,
    "vm_id": string
  }
}

Input Properties

Parameter	Type	Description
`vm_id`	string	An identification string that was recieved from the GetAvailableVMs call.

JSON Output Structure

{
  "result": {
    "method": 1020,
    "code": number,
    "timing": number,
    "timestamp": string,
    "state": string
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.state`	string	The state of a virtual machine. Possible values: 'running', 'suspended', 'shut_down'.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​