VirtualMachine (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VirtualMachine", 
  "module_id": "Inventory", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "compute_ids": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "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']", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": true, 
      "title": "Current external id of this virtual machine in the system.", 
      "type": "string"
    }, 
    "guest_info": {
      "$ref": "GuestInfo, 
      "description": "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.", 
      "required": false, 
      "title": "Guest virtual machine details"
    }, 
    "host_id": {
      "required": false, 
      "title": "Id of the host in which this virtual machine exists.", 
      "type": "string"
    }, 
    "local_id_on_host": {
      "required": true, 
      "title": "Id of the vm unique within the host.", 
      "type": "string"
    }, 
    "power_state": {
      "enum": [
        "VM_RUNNING", 
        "VM_STOPPED", 
        "VM_SUSPENDED", 
        "UNKNOWN"
      ], 
      "required": true, 
      "title": "Current power state of this virtual machine in the system.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "source": {
      "$ref": "ResourceReference, 
      "required": false, 
      "title": "Reference of the Host or Public Cloud Gateway that reported the VM"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "enum": [
        "EDGE", 
        "SERVICE", 
        "REGULAR", 
        "MP", 
        "INTELLIGENCE", 
        "VC_SYSTEM", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Machine type; Edge, Service VM or other.", 
      "type": "string"
    }
  }, 
  "type": "object"
}