GET /v1/getNextAvailableIPRanges - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0

Description

Returns an array of APIEntity objects representing the next available (unused) blocks or networks within a configuration or block.

Parameters

Name Description
count

Location: query

Type: integer (int32)

The number of networks to be found.
Note: If the number of networks count is greater than 1:
  • isLargerAllowed and traversalMethod properties will not be applicable.
  • The DEPTH_FIRST methodology will be used to search objects.
parentId

Location: query

Type: integer (int64)

The object ID of the parent object under which the next available range resides.
properties

Location: query

Type: string

The string containing the following properties and values:
  • reuseExistingTrue or False. This Boolean value indicates whether to search existing empty networks to find the available IP range of specified size.
  • isLargerAllowedTrue or False. This Boolean value indicates whether to return larger networks than those specified with the sizeparameter.
  • autoCreateTrue 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 values are:
    • TraversalMethodology.DEPTH_FIRST 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.
Note: If a value is not provided for the following parameters: reuseExisting and autoCreate, the default values will be as follows: reuseExisting = false and autoCreate = true.
size

Location: query

Type: integer (int64)

The size of the range, expressed as a power of 2 (integer exponent).
type

Location: query

Type: string

The type of range object to be fetched. This must be one of the constants listed in Object types (Currently supported: IP4Network).

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of APIEntity objects representing the existing next available IPv4 ranges, or, if the next available IP ranges do not exist and autoCreate was set to true, the newly created IPv4 ranges.