Create Ip Pool
Creates a new IPv4 or IPv6 address pool. Required parameters are allocation_ranges and cidr. Optional parameters are display_name, description, dns_nameservers, dns_suffix, and gateway_ip.
Request
URI
POST
https://nsxmanager.your.domain/api/v1/pools/ip-pools
COPY
Request Body
IpPool of type(s) application/json
Optional
{
"_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",
"subnets": [
{
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"dns_nameservers": [
"string"
],
"cidr": "string",
"gateway_ip": "string",
"allocation_ranges": [
{
"_self": {
"action": "string",
"href": "string",
"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
}
}
Responses
201
Created
Returns IpPool of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineIpPool1
{
"_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",
"subnets": [
{
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"dns_nameservers": [
"string"
],
"cidr": "string",
"gateway_ip": "string",
"allocation_ranges": [
{
"_self": {
"action": "string",
"href": "string",
"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
}
}
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"
}
]
}
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