/
optioncodes
Document toolboxDocument toolbox

optioncodes

Owned by Sri Raghu
Last updated: Jan 31, 2025 by Alex Mandel
1 min read

Mandatory parameters are denoted by an * (asterisk).

header

type

description

required

encoding

sample

object_headers

header

type

description

required

encoding

sample

object_headers

HEADER-ipamdhcp-v2-optioncode*

string

The primary identifier of the header stating the type of object.

TRUE

string

 

 

key*

string

The primary identifier of an individual object.
For option codes, the option space and option code name are used as the key.
Example: optSpaceName,time_server

TRUE

string

 

 

comment

string

The description of the option code. May contain 0 to 1024 characters.

FALSE

string

 

 

name*

string

The name of the option code. May contain 1 to 256 characters.

TRUE

string

 

 

option_space*

string

The reference to the option space to which the option code belongs.

TRUE

string

 

 

code*

integer

The option code.

TRUE

string

 

 

type*

string

The option type for the option code.

Valid values are:

  • address4

  • address6

  • boolean

  • empty

  • fqdn

  • int8

  • int16

  • int32

  • text

  • uint8

  • uint16

  • uint32

TRUE

string

 

 

array

boolean

An indication of whether the option value is an array of the type.

FALSE

string