Read Ip Pool
Returns information about the specified IP address pool.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/pools/ip-pools/{pool-id}
COPY
Path Parameters
string
pool-id
Required
IP pool ID
Responses
200
Success
Returns IpPool of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineIpPool1
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"subnets": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"dns_nameservers": [
"string"
],
"cidr": "string",
"gateway_ip": "string",
"allocation_ranges": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"start": "string",
"end": "string"
}
],
"dns_suffix": "string"
}
],
"pool_usage": {
"total_ids": 0,
"allocated_ids": 0,
"free_ids": 0
}
}
default
Unexpected error
Returns ApiError of type(s) application/json
{
"module_name": "string",
"error_message": "string",
"error_code": 0
}string
module_name
Optional
module_name
string
error_message
Optional
error_message
integer As int64 As int64
error_code
Optional
error_code