POST /v1/addIP4Template - BlueCat Address Manager - 9.3.0

Address Manager API Guide

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

Description

Add an IPv4 template to the specified configuration.

Parameters

Name Description
configurationId

Location: query

Type: integer (int64)

The object ID of the configuration where you wish to add the IPv4 template.
name

Location: query

Type: string

The name of the IPv4 template.
properties

Location: query

Type: string

A string containing the offset for the gateway address and reservedAddresses property (both optional). The gateway offset is used to set the IPv4 gateway address assignment, counted up from the network address. If there is a negative sign in front of the gateway offset, the gateway offset will be counted backwards from the broadcast address. For example, a value of 1 will assign the gateway to the address immediately following the network address, and a value of -1 will assign the gateway to the address immediately preceding the broadcast address. If not provided, the gateway address will be set to the default value of 1. The reservedAddresses property is used to set reserved addresses, DHCP ranges, and IP groups. Refer to Reference: reservedAddresses parameters for IPv4 templates for the reservedAddresses parameters.
Example properties string:
gateway=1|reservedAddresses={RESERVED_DHCP_RANGE,OFFSET_AND_SIZE,12,34,FROM_START,dhcpsplitrange,true}

Responses

Code Description
201

Type: integer (int64)

Returns the object ID of the new IPv4 template.