3.1.5.8.2.2 ipPools
The ipPools resource represents the range of IP addresses from which IP addresses will be allocated for nodes within a subnet. The subnet is a logical or physical subnet inside a logical network. The pools can be either IPv4 or IPv6. A logical subnet can reference pools of one single type: IPV4 or IPV6. The address family of the logical subnet MUST match the address family of the IP pool.
The ipPools for a virtual subnet are implicit. The start and end IP addresses of the pool of the virtual subnet is based on the IP prefix of the virtual subnet.
It is invoked through the following URI.
-
https://<url>/networking/v1/logicalNetworks/{grandParentResourceId}/subnets/{parentResourceId}/ipPools/{resourceId}
url: The address or name of the REST server of the Network Controller.
grandParentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.1 for more details.
parentResourceId: the identifier for the specific resource that is the descendant of the grandParentResource and the ancestor of the ipPools resource. See section 2.2.3.3 for more details.
resourceId: the identifier for the specific resource within the resource type that is the descendant of the parentResource. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v1 or later, in the URI.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
PUT |
Create a new ipPools resource or update an existing ipPools resource. |
|
|
GET |
Get one ipPools resource. |
|
|
GET ALL |
List all ipPools resources in the Network Controller. |
|
|
DELETE |
Deletes an ipPools resource. |
The following property elements are valid.
|
Element name |
Type |
Description |
|---|---|---|
|
etag |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
provisioningState |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
startIpAddress |
Read/write |
Start IP address of the pool. Note This is an inclusive value so it is a valid IP address from this pool. |
|
endIpAddress |
Read/write |
End IP address of the pool. Note This is an inclusive value so it is a valid IP address from this pool. |
|
usage |
Read-only |
Statistics of the usage of the IP pool |
|
usage.numberOfIPAddresses |
Read-only |
Total number of IP Addresses in the IP pool |
|
usage.numberOfIPAddresses Allocated |
Read-only |
Number of allocated IP addresses in the IP pool |
|
usage.numberOfIPAddresses InTransition |
Read-only |
Number of IP addresses which are in transition state. These IP addresses are freed but are not yet available for allocation because of a hold-off period. |