NSX-T Data Center Global Manager REST API
Associated URIs:
| API Description | API Path |
|---|---|
Get groups for which the given Cloud Native Service Instance is a memberGet policy groups for which the given Cloud Native Service Instance is a member. |
GET /global-manager/api/v1/global-infra/cloud-native-service-group-associations
|
Get member types for a given GroupIt retrieves member types for a given group. In case of nested groups, it calculates member types of child groups as well. Considers member type for members added via static members and dynamic membership criteria. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/member-types
|
Get Effective Cloud Native Service Instances that belong to this group.Returns Effective Cloud Native Service Instances that belong to this group. This API is applicable only for Groups containing CloudNativeServiceInstance member type. For Groups containing other member types,it returns an empty list. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/cloud-native-service-instances
|
Get consolidated effective IPAddress translated from this group across siteReturns the consolidated effective IP address members of the specified Group. This is applicable in the case of a federated/NSX+ environment. The response includes a site-wise list of static and dynamically translated effective IP address members. If the group evaluation on a site is empty, the response will contain the site-id with empty list. If a group is a reference group on a site, then its consolidated effective IP response will contain the effective IPs from other sites, and the response will contain an empty list of IPs for the sites where is it a reference group. This API is applicable only for Global and NSX+ Groups that contain (either directly or via nesting) VirtualMachine, VIF, Segment, SegmentPort, or IPSet member types. Please use the cursor value in the response to fetch the next page. If there is no cursor value in the response, it indicates that it is the last page of results for the query. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/consolidated-effective-ip-addresses
|
Get Discovered Port Groups that belong to this GroupGet Discovered Port Groups that belong to this Group |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/dvpg
|
Get discovered ports that belong to this GroupGet discovered ports that belong to this Group |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/dvports
|
Get Effective Identity Groups that belong to this group.Returns Effective Identiy Groups that belong to this group. This API is applicable only for Groups containing IdentityGroup member type. For Groups containing other member types,it returns an empty list. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/identity-groups
|
Get IP addresses that belong to this GroupGet IP addresses that belong to this Group. This API is applicable for Groups containing either VirtualMachine, VIF, Segment ,Segment Port or IP Address member type.For Groups containing other member types,an empty list is returned |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/ip-addresses
|
Get Effective IPGroups that belong to this group.Returns effective IPGroups that belong to this group. This API is applicable only for Groups containing IPSet member type. For Groups containing other member types,it returns an empty list. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/ip-groups
|
Get logical ports that belong to this GroupGet logical ports that belong to this Group This API is applicable for Groups containing either VirtualMachine, VIF, Segment or Segment Port member type.For Groups containing other member types,an empty list is returned. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/logical-ports
|
Get logical switches that belong to this GroupGet logical switches that belong to this Group. This API is applicable for Groups containing Segment member type. For Groups containing other member types, an empty list is returned. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/logical-switches
|
Get Effective Physical Server Members that belong to this group.Returns Effective Physical Server Members that belong to this group. This API is applicable only for Groups containing Physical Server member type. For Groups containing other member types,it returns an empty list. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/physical-servers
|
Get pods that belong to this GroupGet pods that belong to this Group. This API is applicable for Groups containing either Pod, Cluster, Namespace, Service member type. For Groups containing other member types an empty list is returned |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/pods
|
Get segment ports that belong to this GroupGet segment ports that belong to this Group |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/segment-ports
|
Get segments that belong to this GroupGet segments that belong to this Group |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/segments
|
Get effective transport node members that belong to this groupGet effective transport node members that belong to this Group. This API is applicable only for Groups containing TransportNode member type. For Groups containing other member types,an empty list is returned. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/transport-nodes
|
Get Virtual Network Interface instances that belong to this GroupGet Virtual Network Interface instances that belong to this Group. This API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types. For Groups containing other member types,an empty list is returned.target_id in response is external_id of VirtualNetworkInterface or VirtualMachine. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/vifs
|
Get Virtual machines that belong to this GroupGet 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. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/virtual-machines
|
Get tags used to define conditions inside a GroupGet tags used to define conditions inside a Group. Also includes tags inside nested groups. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/tags
|
Get groups for which the given object is a memberGet policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list. |
GET /global-manager/api/v1/global-infra/group-associations
|
Get groups for which the given Identity Group is a memberGet policy groups for which the given Identity Group is a member. |
GET /global-manager/api/v1/global-infra/identity-group-associations
|
Get groups for which the given IP address is a memberGet policy groups for which the given IP address is a member. |
GET /global-manager/api/v1/global-infra/ip-address-group-associations
|
Get groups for which the given Physical Server is a memberGet policy groups for which the given Physical Server is a member. |
GET /global-manager/api/v1/global-infra/physical-server-group-associations
|
Get groups for which the given pod is a memberGet policy groups for which the given pod is a member. |
GET /global-manager/api/v1/global-infra/pod-group-associations
|
Get groups for which the given VM is a memberGet policy groups for which the given VM is a member. |
GET /global-manager/api/v1/global-infra/virtual-machine-group-associations
|
Get groups for which the given VIF is a memberGet policy groups for which the given VIF is a member. |
GET /global-manager/api/v1/global-infra/virtual-network-interface-group-associations
|