NSX-T Data Center REST API
VirtualMachine (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| _last_sync_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| compute_ids | 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'] | array of string | Required |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| external_id | Current external id of this virtual machine in the system. | string | Required |
| guest_info | Guest virtual machine details 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. |
GuestInfo | |
| host_id | Id of the host in which this virtual machine exists. | string | |
| local_id_on_host | Id of the vm unique within the host. | string | Required |
| power_state | Current power state of this virtual machine in the system. | string | Required Enum: VM_RUNNING, VM_STOPPED, VM_SUSPENDED, UNKNOWN |
| resource_type | Must be set to the value VirtualMachine | string | Required |
| runtime_info | Runtime of virtual machine Specifies runtime details of virtual machine. |
VirtualMachineRuntimeInfo | Readonly |
| scope | List of scopes for discovered resource 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. |
array of DiscoveredResourceScope | |
| source | Reference of the Host or Public Cloud Gateway that reported the VM | ResourceReference | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| type | Virtual Machine type; Edge, Service VM or other. | string | Required Readonly Enum: EDGE, SERVICE, REGULAR, MP, INTELLIGENCE, VC_SYSTEM, UNKNOWN |
| uptv2_enabled | Flag to indicate if UPT is enabled If UPT enabled is true for any virtual network interface of the virtual machine, then this property is true for the virtual machine. |
boolean | Readonly |