Get Consolidated Effective IP Address Members

Returns the consolidated effective IP address members of the specified NSGroup. This is applicable in the case of a federated environment. The response includes a site-wise list of static and dynamically translated effective IP address members. If the ns-group evaluation on a site is empty, the response will contain the site-id with empty list. If an ns-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 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.

This API is deprecated. Please use below policy API /global-infra/domains/<domain-id>/groups/<group-id>/members/consolidated-effective-ip-addresses to fetch effective IP address members for a group.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/ns-groups/{ns-group-id}/consolidated-effective-ip-address-members

COPY

Path Parameters

string

ns-group-id

Required

NSGroup Id

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

ip_filter

Optional

IP address, range, or subnet

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

string

site_id

Optional

UUID of the site from which the effective IP addresses are to be fetched

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns ConsolidatedEffectiveIPAddressMemberListResult of type(s) application/json

This response body class contains all of the following: InlineConsolidatedEffectiveIPAddressMemberListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "effective_ips": [
                "string"
            ],
            "site_id": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json