NSX-T Data Center REST API

Get consolidated Effective IPAddress translated from the NSGroup

Returns consolidated effective ip address members of the specified NSGroup.
Applicable in case of federated environment. The response contains site-wise list of
consolidated effective IP address members. In the response, for the local-site, the
list will contain static and dynamicaly translated IPs. For the remote sites,
the list will contain only the dynamically translated IPs. The static IPs will not be
seen in the response of this API. Hence, user can refer to the local-site Ip response
in the API results or the group definition to see the static IP membership of the Group.
This API is applicable only for NSGroups containing either
VirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type.
For NSGroups containing other member types,it returns an empty list.
Use the cursor value in the response to fetch the next page.
If there is no cursor value for a response, it implies the last page in the results
for the query.

Request:

Method:
GET
URI Path(s):
/api/v1/ns-groups/<ns-group-id>/consolidated-effective-ip-address-members
Request Headers:
n/a
Query Parameters:
ConsolidatedAPIListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/ns-groups/0c963c9d-eea8-4180-b6f3-93385fa497ca/consolidated-effective-ip-address-members

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ConsolidatedEffectiveIPAddressMemberListResult+

Example Response:

{ "results": [ { "site_id": "e977e929-255e-41c0-a938-a35d12f860ee", "effective_ips": [ "10.160.8.45", "10.160.16.77" ] }, { "site_id": "210d7017-5dca-4901-bfcc-c63928215160", "effective_ips": [ "10.160.10.118", "10.160.27.172" ] }, { "site_id": "fa8be70f-b592-4cb1-add9-b89ccdfd3ee3", "effective_ips": [ "25.1.1.1", "25.1.1.2/31", "25.1.1.10", "10.160.15.134", "fd34:fe56:7891:2f3a:0:0:0:0/64", "25.1.1.8/31", "10.160.26.223", "fd01:0:101:2600:20c:29ff:fe23:eef3", "25.1.1.4/30", "20.1.1.1/28", "10.112.10.1" ] } ], "cursor": "7806177147493" }

Required Permissions:

read

Feature:

groups_groups

Additional Errors: