List Ip Blocks

List Ip Blocks

Returns information about configured IP address blocks. Information includes the id, display name, description & CIDR of IP address blocks

Request
URI
GET
https://nsxmanager.your.domain/api/v1/pools/ip-blocks
COPY
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

integer
page_size
Optional

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

boolean
sort_ascending
Optional

sort_ascending

string
sort_by
Optional

Field by which records are sorted

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns IpBlockListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineIpBlockListResult1 
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_create_user": "string",
            "_protection": "string",
            "_create_time": 0,
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "cidr": "string"
        }
    ]
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Pool Management Operations
POST
Allocate Or Release From Ip Block Subnet
POST
Allocate Or Release From Ip Pool
POST
Create Ip Block
POST
Create Ip Block Subnet
POST
Create Ip Pool
DELETE
Delete Ip Block
DELETE
Delete Ip Block Subnet
DELETE
Delete Ip Pool
GET
List Ip Blocks
GET
List Ip Block Subnets
GET
List Ip Pool Allocations
GET
List Ip Pools
GET
List Mac Pools
GET
List VNI Pools
GET
List Vtep Label Pools
GET
Read Ip Block
GET
Read Ip Block Subnet
GET
Read Ip Pool
GET
Read Mac Pool
GET
Read VNI Pool
GET
Read Vtep Label Pool
PUT
Update Ip Block
PUT
Update Ip Pool
PUT
Update VNI Pool