NSX-T Data Center REST API

Get consolidated effective IPAddress translated from this group across site

Returns consolidated effective ip address members of the specified Group.
Applicable in case of federated environment only. 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 dynamically 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. 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 Global Groups containing (directly or via nesting)
either VirtualMachine, VIF, Segment, SegmentPort or IPSet member type.
To fetch the next page, use the cursor value in the response. If there is no cursor value for a response,
it implies that it is the last page in the results for the query.
This API is only available when using VMware NSX.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/members/consolidated-effective-ip-addresses
/policy/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/consolidated-effective-ip-addresses
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/members/consolidated-effective-ip-addresses

Request Headers:

n/a

Query Parameters:

ConsolidatedEffectiveIPListRequestParameters+

ConsolidatedEffectiveIPListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point on which the API needs to be executed. Forward slashes must be escaped using %2F.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
ip_filter	An IPAddress or subnet for filtering the results. This filter can be used to verify an ip membership in the effective results	IPElement
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
site_id	UUID of the site from which the effective IP addresses are to be fetched	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://{{site2}}/policy/api/v1/global-infra/domains/default/groups/demo1/members/consolidated-effective-ip-addresses

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ConsolidatedEffectiveIPAddressMemberListResult+

ConsolidatedEffectiveIPAddressMemberListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of site wise consolidated effective ip addresses for the given NSGroup	array of EffectiveIPInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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:

policy_grouping

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable