Description
Adds a custom deployment option definition.
Parameters
Name | Description |
---|---|
allowMultiple |
Location: query Type: boolean This parameter determines whether or not the custom option will allow multiple values. The default value is false;
In Perl script, only an empty string and zero (0) 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 => ''}) Note: Starting in Address Manager API v9.2.0, this parameter is now required.
|
configurationId |
Location: query Type: integer (int64) The object ID of the parent configuration.Note: Starting in Address Manager API v9.2.0, this parameter is now required.
|
name |
Location: query Type: string The name of the custom deployment option. |
optionId |
Location: query Type: integer (int64) 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.Note: Starting in Address Manager API v9.2.0, this parameter is now required.
|
optionType |
Location: query Type: string The type of custom deployment option. This value must be one of the items listed in DHCP custom option types. |
properties |
Location: query Type: string Adds object properties, including a description for the option (optionDescription), a display name (displayName), and user-defined fields. If the option description and display name are not provided, the properties will be populated by the value of the name parameter. |
Responses
Code | Description |
---|---|
201 |
Type: number Returns the object ID of the new option defined. |