NSX-T Data Center REST API

Lists all the system virtual machines.

Lists all the system virtual machines (example -Partner and Edge VMs etc)
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/realized-state/system-virtual-machines
Request Headers:
n/a
Query Parameters:
SystemVMListRequestParameter+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VirtualMachineListResult+

Example Response:

{ "results": [ { "host_id": "f8aeaa94-3e3b-48dd-bbd4-595676b87aaa", "source": { "target_id": "f8aeaa94-3e3b-48dd-bbd4-595676b87aaa", "target_display_name": "TN-1", "target_type": "HostNode", "is_valid": true }, "external_id": "6ab92268-3ae3-443f-b073-c8020fe783a5", "power_state": "VM_RUNNING", "local_id_on_host": "2", "compute_ids": [ "moIdOnHost:2", "hostLocalId:2", "locationId:564dc3dc-7e69-5e4f-102a-c29b5dddba49", "instanceUuid:6ab92268-3ae3-443f-b073-c8020fe783a5", "externalId:6ab92268-3ae3-443f-b073-c8020fe783a5", "biosUuid:564dc3dc-7e69-5e4f-102a-c29b5dddba49" ], "type": "INTELLIGENCE", "resource_type": "VirtualMachine", "display_name": "vsphere_vm_2", "_last_sync_time": 1589890824000 } ] }

Required Permissions:

read

Feature:

infra_admin

Additional Errors: