POST /v1/applyIP4NetworkTemplate - BlueCat Address Manager - 9.1.0

Address Manager API Guide

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

Description

Applies IPv4 network templates.

Parameters

Name Description
networkId

Location: query

Type: integer (int64)

The object ID of the IPv4 network. This value cannot be empty or null. If the value is zero, the template is applied to all networks.
properties

Location: query

Type: string

A string containing the following properties and values:
  • applyToNonConflictedNetworksOnly - Boolean value: true or false. If set to true, the template is applied to a non-conflicted network. The default value is false.
  • applyDeploymentOptions - Boolean value: true or false. If set to true, applies deployment options defined from the template to the linked network. The default value is false.
  • applyReservedAddresses - Boolean value: true or false. If set to true, applies the reserved IPv4 addresses defined from the template to the linked network. The default value is false.
  • applyGateway - Boolean value: true or false. If set to true, applies the gateway to the linked network. The default value is false.
  • applyDHCPRanges - Boolean value: true or false. If set to true, applies the DHCP ranges defined from the template to the linked network. The default value is false.
  • applyIPGroups - Boolean value: true or false. If set to true, applies the IP groups defined from the template to the linked network. The default value is false.
  • conflictResolutionOption - ObjectProperties.networkSettings or ObjectProperties.templateSettings. Available only if applyDeploymentOptions is true and applyToNonConflictedNetworksOnly is false. The default value is networkSettings.
  • convertOrphanedIPAddressesTo - ObjectProperties.convertOrphanedIPAddressesTo.

    The possible values are:

    • STATIC
    • DHCP RESERVED Default value
    • UNASSIGNED
      Note:
      • If the option value is incorrect, the default value is applied.
      • If the option name is incorrect, the option will be ignored. Therefore, orphaned IP addresses will be updated to the default value.
Refer to Reference: network template properties.
templateId

Location: query

Type: integer (int64)

The object ID of the IPv4 template. This value cannot be empty or null.

Responses

Code Description
201

Type: string

Returns the task ID of the network template apply task as a string.