ManageVM

Will perform the requested operation on a virtual machine.

Syntax

Method ID

#define WAAPI_MID_MANAGE_VM 1019

JSON Input Structure

{
  "input": {
    "method": 1019,
    "signature": number,
    "vm_id": string,
    "action": string,
    "attempt_synchronize": boolean,
    "password": string
  }
}

Input Properties

Parameter	Type	Description
`vm_id`	string	An identification string that was recieved from the GetAvailableVMs call.
`action`	string	The action to be performed. Possible values: 'run', 'shut_down', 'suspend'.
`attempt_synchronize`	boolean	Tells the API to attempt to synchronize the call, i.e. wait for the operation to complete. This is not possible for all products.
`password`	string	(optional) The password required by the virtual machine to perform the requested action.

JSON Output Structure

{
  "result": {
    "method": 1019,
    "code": number,
    "timing": number,
    "timestamp": 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 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​