Get Group VM Members
Get Virtual machines that belong to this Group. This API is applicable for Groups containing VirtualMachine,member type. For Groups containing other member types,an empty list is returned.
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/members/virtual-machines
COPY
Path Parameters
string
domain-id
Required
Domain id
string
group-id
Required
Group Id
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
sort_ascending
string
sort_by
Optional
Field by which records are sorted
Responses
200
OK
Returns RealizedVirtualMachineListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineRealizedVirtualMachineListResult1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"alarms": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"error_details": {
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
},
"message": "string",
"source_reference": "string"
}
],
"intent_reference": [
"string"
],
"realization_api": "string",
"realization_specific_identifier": "string",
"runtime_error": "string",
"runtime_status": "string",
"state": "string",
"compute_ids": [
"string"
],
"host_id": "string",
"local_id_on_host": "string",
"power_state": "string"
}
]
}
400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
404
Not Found
Operation doesn't return any data structure
412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
On This Page
Domains Operations
PUT
Create Or Replace Port Mirroring Instance
DELETE
Delete Dns Security Profile Binding
DELETE
Delete Group
DELETE
Delete Group Monitoring Binding
DELETE
Delete Policy Firewall Flood Protection Binding
DELETE
Delete Policy Firewall Session Timer Binding
DELETE
Delete Port Mirroring Instance
GET
Get Dns Security Profile Binding
GET
Get Group IP Members
GET
Get Group LP Members
GET
Get Group LS Members
GET
Get Group Monitoring Binding
GET
Get Group Segment Members
GET
Get Group Segment Port Members
GET
Get Group Tags
GET
Get Group VM Members
GET
Get Group VM Statistics
GET
Get Policy Firewall Flood Protection Binding
GET
Get Policy Firewall Session Timer Binding
GET
List Dns Security Profile Bindings
GET
List Group For Domain
GET
List Group Monitoring Bindings
GET
List Policy Firewall Flood Protection Bindings
GET
List Policy Firewall Session Timer Bindings
GET
List Port Mirroring Instances
PATCH
Patch Dns Security Profile Binding
PATCH
Patch Group For Domain
PATCH
Patch Group Monitoring Binding
PATCH
Patch Policy Firewall Flood Protection Profile Binding Map
PATCH
Patch Policy Firewall Session Timer Profile Binding Map
PATCH
Patch Port Mirroring Instance
GET
Read Group For Domain
GET
Read Port Mirroring Instance
PUT
Update Dns Security Profile Binding
PUT
Update Group For Domain
PUT
Update Group Monitoring Binding
PUT
Update Policy Firewall Flood Protection Binding
PUT
Update Policy Firewall Session Timer Binding