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) or VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/realized-state/system-virtual-machines

Request Headers:

n/a

Query Parameters:

SystemVMListRequestParameter+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
query	Search query Search query	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/realized-state/system-virtual-machines

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

VirtualMachineListResult+

Name	Description	Type	Notes
_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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	VirtualMachine list results	array of VirtualMachine	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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 } ] }

Lists all the system virtual machines.

Request:

SystemVMListRequestParameter (schema)

Example Request:

Successful Response:

VirtualMachineListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: