dhcpoptiondefinition : DHCP option definition object.

An option definition defines a DHCP option within a specific option space. A custom option can be defined in the predefined DHCP option space or in the user-defined vendor option space. To define an option, add the option definition to the required option space.

Object Reference

References to dhcpoptiondefinition are object references.

The name part of the dhcpoptiondefinition object reference has the following components:

  • The name of the DHCP option definition object.

Example:

dhcpoptiondefinition/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:first

Restrictions

The object does not support the following operations:

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): code, name, type.

The following fields are required to create this object:

Field

Notes

code

name

type

code

code

The code of a DHCP option definition object. An option code number is used to identify the DHCP option.

Type

Unsigned integer.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The code is part of the base object.

name

name

The name of a DHCP option definition object.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘~=’ (regular expression)

  • ‘=’ (exact equality)

  • ‘:=’ (case insensitive search)

Notes

The name is part of the base object.

space

space

The space of a DHCP option definition object.

Type

String.

Create

The default value is DHCP.

Search

The field is available for search via

  • ‘=’ (exact equality)

type

type

The data type of the Grid DHCP option.

Type

String.

Valid values are:

  • 16-bit signed integer

  • 16-bit unsigned integer

  • 32-bit signed integer

  • 32-bit unsigned integer

  • 64-bit unsigned integer

  • 8-bit signed integer

  • 8-bit unsigned integer

  • 8-bit unsigned integer (1,2,4,8)

  • array of 16-bit integer

  • array of 16-bit unsigned integer

  • array of 32-bit integer

  • array of 32-bit unsigned integer

  • array of 64-bit unsigned integer

  • array of 8-bit integer

  • array of 8-bit unsigned integer

  • array of ip-address

  • array of ip-address pair

  • array of string

  • binary

  • boolean

  • boolean array of ip-address

  • boolean-text

  • domain-list

  • domain-name

  • encapsulated

  • ip-address

  • string

  • text

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type is part of the base object.

Fields List

Field

Type

Req

R/O

Base

Search

code

Unsigned int

Y

N

Y

=

name

String

Y

N

Y

: = ~

space

String

N

N

N

=

type

String

Y

N

Y

=