Get Nsx Ip Address Pool

Retrieve an NSX IP Address Pool by its name

Request

URI

GET

https://{api_host}/v1/nsxt-clusters/{nsxt-cluster-id}/ip-address-pools/{name}

COPY

Path Parameters

string

nsxt-cluster-id

Required

NSX cluster ID

string

name

Required

IP address pool name

Responses

200

Returns NsxtIpAddressPool of type(s) application/json

{
    "name": "string",
    "description": "string",
    "availableIpAddresses": 0,
    "totalIpAddresses": 0,
    "blockSubnets": [
        {
            "size": 0,
            "gatewayAssigned": false,
            "cidr": "string"
        }
    ],
    "staticSubnets": [
        {
            "ipAddressPoolRanges": [
                {
                    "start": "string",
                    "end": "string"
                }
            ],
            "gateway": "string",
            "cidr": "string"
        }
    ]
}

string

name

Optional

Name of the IP address pool

string

description

Optional

Description of the IP address pool

integer As int32 As int32

availableIpAddresses

Optional

The number of IP addresses available in the IP address pool

integer As int32 As int32

totalIpAddresses

Optional

The total number of IP addresses in the IP address pool

array of NsxtIpAddressPoolBlockSubnet

blockSubnets

Optional

The list of IP address pool block subnets

array of NsxtIpAddressPoolStaticSubnet

staticSubnets

Optional

The list of IP address pool static subnets

404

IP address pool not found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.