GET /v1/getNextIP4Address - BlueCat Address Manager - 9.1.0

Address Manager API Guide
prodname
BlueCat Address Manager
version_custom
9.1.0

Description

Returns the next available IP addresses in octet notation under specified circumstances.

Parameters

Name Description
parentId

Location: query

Type: integer (int64)

The network or configuration Id.
properties

Location: query

Type: string

The property string contains three properties; skip, offset and excludeDHCPRange. The values for skip and offset must be IPv4 addresses and must appear in dotted octet notation.
  • skip - This is optional. It is used to specify the IP address ranges or IP addresses to skip, separated by comma. A hyphen (-), not a dash is used to separate the start and end addresses.
    Note: Do not use the skip property if the parentId is a configuration Id. If you do, an error message appears, ‘Skip is not allowed for configuration level’.
  • offset - This is optional. This is to specify from which address to start to assign IPv4 Address.
  • excludeDHCPRange - This specifies whether IP addresses in DHCP ranges should be excluded from assignment. The value is either true or false, default value is false. 
    skip=10.10.10.128-10.10.11.200,10.10.11.210|
offset=10.10.10.100|excludeDHCPRange=true|

Responses

Code Description
200

Type: string

Returns the IPv4 address in octet notation.