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

List Virtual Machines On Enforcement Point

Description

This API filters objects of type virtual machines from the specified NSX Manager. This API has been deprecated. Please use the new API GET /infra/realized-state/virtual-machines

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/virtual-machines
Copy

Path Parameters

Path Parameters

string
enforcement-point-name Required

Query Parameters

Query Parameters

string
cursor Optional

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


string
dsl Optional

Search DSL (domain specific language) query


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)


string
query Optional

Search query


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 SearchResponse of type(s) application/json
This response body class contains all of the following: ListResult, InlineSearchResponse1
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-ListVirtualMachinesOnEnforcementPoint -enforcementPointName -cursor -dsl -includedFields -pageSize -query -sortAscending -sortBy

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/virtual-machines
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated: null
x-vmw-doc-operation: list-virtual-machines-on-enforcement-point
x-vmw-nsx-module: PolicyRealizedState


Feedback

Was this page helpful?