Returns the object ID for the next available (unused) block or network within a
configuration or block.
Output / Response
Returns the object ID for the existing next available
IPv4 range or, if the next available IP range does not exist and
autoCreate was set to true, the newly created IPv4
APIEntity getNextAvailableIPRange ( long parentId, long
size, String type, String properties
||The object ID of the parent object under which the next available
range resides (Configuration or Block).
||The size of the range, expressed as a power of 2.
||The type of the range object to be fetched. Currently IPv4 block and
network are supported.
||The string containing the following properties and values:
- reuseExisting—True or False. This Boolean
value indicates whether to search existing empty networks to
find the available IP range of specified size.
- isLargerAllowed—True or False. This Boolean
value indicates whether to return larger networks than those
specified with the sizeparameter.
- autoCreate—True or False. This Boolean
value indicates whether the next available IP range should be
created in the parent object if it does not exist.
- traversalMethod—This parameter identifies the appropriate
search algorithm to find the suitable object. The possible
- NO_TRAVERSAL—will attempt to find the next range
directly under the specified parent object. It will not
search through to the lower level objects.
- DEPTH_FIRST—will attempt to find the next range
under the specified object by iteratively through its
children one by one. After exploring the object
recursively for its child ranges, it will move to the
next child object.
- BREADTH_FIRST—will attempt to find the next range
under the specified object by iterative levels. It will
first find the range immediately below the specified
parent object. If not found, then it will attempt to
find the range under all the first child objects.