vcenter nsx ip pools: list
Returns the list of the NSX IP pools. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
GET https://{server}/api/vcenter/nsx/ip-pools
Response:
HTTP Status Code: 200
Response Body Structure:
[
{
"vlan" : 1,
"ip_pool" : "obj-103"
},
{
"vlan" : 1,
"ip_pool" : "obj-103"
}
]
{
"vlan" : 1,
"ip_pool" : "obj-103"
},
{
"vlan" : 1,
"ip_pool" : "obj-103"
}
]
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | summary[] | vcenter.nsx.ip_pools.summary Summary of NSX IP pools created. |
| -[].ip_pool | string | Identifier of the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.nsx.pools.ip_pool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.nsx.pools.ip_pool. |
| -[].vlan | long | The VLAN ID associated with the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |