Add Custom Deployment Option - BlueCat Address Manager - 8.2.0

Address Manager API Guide

BlueCat Address Manager

Adds a custom deployment option.

Output / Response

Returns the object ID of the new option defined.

API call:

long addCustomOptionDefinition ( long configurationId, String name, long optionId, String optionType, boolean allowMultiple, String properties )
Parameter Description
configurationId The object ID of the parent configuration.
name The name of the custom deployment option. This value cannot be empty.
optionId The option code for the custom deployment option. This value must be within the range of 151 to 174, 178 to 207, 212 to 219, 222 to 223, or 224 to 254.
optionType The type of custom deployment option. This value must be one of the items listed in DHCP Custom Option Types.
allowMultiple Determines whether or not the custom option requires multiple values. The default value is false. The value cannot be empty.
In Perl script, only an empty string and 0 (zero) are considered as false; other values are considered as true. Therefore, a string containing the word false is considered to be true because the string is not empty. In Perl, set the allowMultiple data type to string and set the value to either true or false:
SOAP::Data->type( 'string' )->
name( 'allowMultiple' )->
value( "false")->
attr({xmlns => ''})
Or, set the allowMultiple data type to boolean. Set the value to either 0 or an empty string to represent false. Set the value to any other text to represent true.
SOAP::Data->type( 'boolean' )
->name( 'allowMultiple' )
->value( 0 )
->attr({xmlns => ''})
properties Adds object properties, including user-defined fields