3.1.5.9 macPools
macPools resource specifies one or more ranges of MAC addresses, which are used internally by the Network Controller. The MAC addresses are used for both overlay and underlay needs. If more than one MAC pool is created, the MAC address space management component in the Network Controller MUST determine which pool to allocate the MAC from. After a MAC pool has been created, the pool cannot be extended or shrunk. MACs from the pool will not be reassigned.
It is invoked through the following URI.
-
https://<url>/networking/v1/macPools/{resourceId}
url: The address or name of the REST server of the Network Controller.
resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v1 or later, in the URI.
The Network Controller MUST be installed and configured prior to using this resource.
In addition, the admin MUST create a dedicated range of MACs, and make non-overlapping subset of those MACs available to the Network Controller for internal use as defined with this resource.
A macPools resource SHOULD be created prior to the creation of any server or networkInterfaces resources.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
PUT |
Create a new macPools resource or update an existing macPools resource. |
|
|
GET |
Get one macPools resource. |
|
|
GET ALL |
List all macPools resources in the Network Controller. |
|
|
DELETE |
Deletes a macPools 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. |
|
startMacAddress |
Required Read/write |
This is a string in the form of AA-BB-CC-DD-EE-FF. |
|
endMacAddress |
Required Read/write |
This is a string in the form of UU-VV-WW-XX-YY-ZZ. |
|
usage |
Read-only |
Usage statistics of the MAC address pool. |
|
usage.numberOfMacAddresses |
Read-only |
Number of MAC addresses in the address pool. |
|
usage.numberOfMACAddressesAllocated |
Read-only |
Number of allocated MAC addresses in the address pool. |