VirtualMachine

Properties

integer
_last_sync_time Optional

Timestamp of last modification


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


array of string
compute_ids Optional

List of external compute ids of the virtual machine in the format ‘id-type-key:value’ , list of external compute ids [‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, ‘instanceUuid:xxxx-xxxx-xxxx-xxxx’]


string
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


string
external_id Optional

Current external id of this virtual machine in the system.


guest_info Optional

Guest virtual machine details include OS name, computer name of guest VM. Currently this is supported for guests on ESXi that have VMware Tools installed.


string
host_id Optional

Id of the host in which this virtual machine exists.


string
local_id_on_host Optional

Id of the vm unique within the host.


string
power_state Optional

Current power state of this virtual machine in the system.

Possible values are: VM_RUNNINGVM_STOPPEDVM_SUSPENDEDUNKNOWN


string
resource_type Optional

The type of this resource.


source Optional

Reference of the Host or Public Cloud Gateway that reported the VM


array of Tag
tags Optional

Opaque identifiers meaningful to the API user


string
type Optional

Virtual Machine type; Edge, Service VM or other.

Possible values are: EDGESERVICEREGULAR

JSON Example

{
    "_last_sync_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "compute_ids": [
        "string"
    ],
    "description": "string",
    "display_name": "string",
    "external_id": "string",
    "guest_info": {
        "computer_name": "string",
        "os_name": "string"
    },
    "host_id": "string",
    "local_id_on_host": "string",
    "power_state": "string",
    "resource_type": "string",
    "source": {
        "is_valid": false,
        "target_display_name": "string",
        "target_id": "string",
        "target_type": "string"
    },
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "type": "string"
}
Feedback

Was this page helpful?