GetAvailableVMs

Will retrieve all available virtual machines for the product.

Syntax

Method ID

#define WAAPI_MID_GET_AVAILABLE_VMS 1017

JSON Input Structure

{
  "input": {
    "method": 1017,
    "signature": number
  }
}

Input Properties

This method does not require any additional parameters beyond the method ID.

JSON Output Structure

{
  "result": {
    "method": 1017,
    "code": number,
    "timing": number,
    "timestamp": string,
    "virtual_machines": [
      {
        "vm_id": string,
        "vm_name": string,
        "vm_path": string
      },
      ...
    ],
    "hypervisor_type": number
  }
}

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.virtual_machines`	array<object>	An array of avaible virtual machines for the product.
`result.virtual_machines.vm_id`	string	The identification string that is required to pass to other Virtual Machine invoke calls.
`result.virtual_machines.vm_name`	string	The name of the virtual machine.
`result.virtual_machines.vm_path`	string	The path to the virtual machine.
`result.hypervisor_type`	number	The type of the hypervisor. 1 = Type 1 (native, bare metal), 2 = Type 2 (hosted)

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​