POST /v1/addDHCP6RangeBySize - BlueCat Address Manager - 9.2.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.2.0

Description

Adds IPv6 DHCP ranges by size.

Parameters

Name Description
networkId

Location: query

Type: integer (int64)

The object ID for the network in which the DHCP range is located.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
properties

Location: query

Type: string

Optional object properties that can contain the object name, the value of defineRangeBy, and user-defined fields. The possible values for defineRangeBy are AUTOCREATE_BY_SIZE, OFFSET_AND_SIZE, and START_ADDRESS_AND_SIZE.
Note: If you do not specify the defineRangeBy value, the DHCP range will be created using AUTOCREATE_BY_SIZE by default.
size

Location: query

Type: string

The size of the range. Currently, you can only specify the range size in a relative size proportional to the parent network size.
start

Location: query

Type: string

An integer value or IPv6 address specifying the point where the range should begin. The positive values indicate that the starting IP address of the range will be counted from the Network ID first IP address and forward in the range. The IPv6 address value indicates the starting address of the range.
Note:
  • If you set defineRangeBy with the AUTOCREATE_BY_SIZE value in the property field, the start field must contain an empty string ("").
  • If you set defineRangeBy with the OFFSET_AND_SIZE value in the property field, the start field must contain a positive integer value.
  • If you set defineRangeBy with the START_ADDRESS_AND_SIZE value in the property field, the start field must contain a valid IPv6 address that will be used as the starting address of the DHCP range.

Responses

Code Description
201

Type: number

Returns the object ID for the new DHCPv6 range.