Add DHCP Service Option - BlueCat Address Manager - 9.0.0

Address Manager API Guide

BlueCat Address Manager

Adds DHCP service options.

Output / Response

Returns the object ID for the new DHCPv4 service option.

API call:

long addDHCPServiceDeploymentOption ( long entityId, String name, String value, String properties )
Parameter Description
entityId The object ID for the entity to which the deployment option is being added.
name The name of the DHCPv4 service option being added. This name must be one of the constants listed in DHCP Service Options.
Note: If you do not configure the DDNS_UPDATE_STYLE service option, the default value is interim.
value The value being assigned to the option.
Note: When adding the DDNS hostname option, you need to specify the value in the following format: [Type],[Position],[Data] for IP and MAC type, and [Type],[Data] for FIXED type. Where:
  • Type—type of DDNS hostname. The possible values are DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_IP, DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_MAC, or DHCPServiceOptionConstants.DDNS_HOSTNAME_TYPE_FIXED.
  • Position—specify where you wish to add the data value to the IP or MAC address. The possible values are DHCPServiceOptionConstants.DDNS_HOSTNAME_POSITION_PREPEND, or DHCPServiceOptionConstants.DDNS_HOSTNAME_POSITION_APPEND. This is only required for IP or MAC type with Data.
  • Data—For IP and MAC address, this value is used to be prepended or appended to the IP address or MAC address. For FIXED type, this value must be specified and will be used for the DDNS hostname. This is optional for IP and MAC type.
When adding the DDNS update style, you must specify the value in the following format:
Note: Depending on the type of deployment option being added, the format of the value input might differ. For more information, refer to Reference: Deployment Option value formats.
properties Adds object properties, including user-defined fields.