[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

List All Virtual Machines

Description

This API filters objects of type virtual machine. This API also gives some VM details such as VM name, IDs and the current state of the VMs.

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/virtual-machines
Copy

Query Parameters

Query Parameters

string
cursor Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)


string
enforcement_point_path Optional

String Path of the enforcement point


boolean
include_mark_for_delete_objects Optional

Include objects that are marked for deletion in results


string
included_fields Optional

Comma separated list of fields that should be included in query result


integer
page_size Optional

Maximum number of results to return in this page (server may return fewer)


boolean
sort_ascending Optional

string
sort_by Optional

Field by which records are sorted


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VirtualMachineListResult of type(s) application/json
This response body class contains all of the following: ListResult, InlineVirtualMachineListResult1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-ListAllVirtualMachines -cursor "Mycursor" -enforcementPointPath "MyenforcementPointPath" -includeMarkForDeleteObjects $true -includedFields "MyincludedFields" -pageSize 789 -sortAscending $true -sortBy "MysortBy"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/virtual-machines
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list-all-virtual-machines
x-vmw-nsx-module: PolicyRealizedState


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Feedback

Was this page helpful?