[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Get Group VM List
DescriptionGet Virtual machines that belong to this Tier-0 Group. This API is applicable for Groups containing VirtualMachine member type. For Groups containing other member types,an empty list is returned.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/groups/{group-id}/members/virtual-machines
Path Parameters
Path Parameters
string
tier-0-id
Required
Tier-0 id
string
group-id
Required
Group Id
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
RealizedVirtualMachineListResult
of type(s) application/json
This response body class contains all of the following:
ListResult, InlineRealizedVirtualMachineListResult1
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
Invoke-GetProviderGroupVMMembers -tier0Id "Mytier0Id" -groupId "MygroupId" -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/tier-0s/{tier-0-id}/groups/{group-id}/members/virtual-machines
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-group-vm-list
x-vmw-nsx-module: PolicyGroupRealization
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
put
delete
get
get
patch
