Read IP Set

Read IP Set

Returns information about the specified IPSet.

This API is deprecated. Please use policy API /infra/domains//groups/ to fetch group with IPAddress.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/ip-sets/{ip-set-id}

COPY

Path Parameters

string

ip-set-id

Required

IPSet Id

Authentication

This operation uses the following authentication methods.

Responses

200

OK

Returns IPSet of type(s) application/json

This response body class contains all of the following: InlineIPSet1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "_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"
        }
    ],
    "ip_addresses": [
        "string"
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure

500

Returns InternalServerError of type(s) application/json

Operation doesn't return any data structure

503

Returns ServiceUnavailable of type(s) application/json

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/ip-sets/{ip-set-id}

Deprecated

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Management Plane Api Operations

Add Remove IP Address

Get IP Addresses

Get MAC Addresses

Add MAC Address

Remove MAC Address

Create NS Group

Get Unassociated Virtual Machines

Delete NS Group

Add Or Remove NS Group Expression

Update NS Group

Get Consolidated Effective IP Address Members

Get Effective Cloud Native Service Instances

Get Effective Active Directory Groups

Get Effective IP Address Members

Get Effective IP Set Members

Get Effective Logical Port Members

Get Effective Logical Switch Members

Get Effective Physical Server Members

Get Effective Transport Node Members

Get Effective VIF Members

Get Effective Virtual Machine Members

Get Member Types

Get Service Associations

List NS Profiles

Create NS Profile

List NS Supported Attributes Types

List NS Supported Attributes

Delete NS Profile

Read NS Profile

Update NS Profile

List NS Service Groups

Create NS Service Group

Delete NS Service Group

Read NS Service Group

Update NS Service Group

List NS Services

Create NS Service

Delete NS Service

Read NS Service

Update NS Service

Node: apidepo-liferay-dxp-v1-be-w-0:8080: