dhcpoptionspace : DHCP option space object.

An Option Space defines a namespace in which vendor options can be defined. To define a specific vendor option space, add an option space to DHCP.

Object Reference

References to dhcpoptionspace are object references.

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

  • The name of the DHCP option space.
Example:
dhcpoptionspace/ZG5zLm9wdGlvbl9zcGFjZSRibG94Li5mYWxzZQ:blox

Restrictions

The object does not support the following operations:

  • Scheduling
  • CSV export

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): comment, name.

The following fields are required to create this object:

Field Notes
name  

comment

comment

A descriptive comment of a DHCP option space object.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The comment is part of the base object.

name

name

The name of a DHCP option space object.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

option_definitions

option_definitions

The list of DHCP option definition objects.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

space_type

space_type

The type of a DHCP option space object.

Type

String.

Valid values are:
  • PREDEFINED_DHCP
  • VENDOR_SPACE

Search

The field is not available for search.

Notes

The space_type cannot be updated.

space_type cannot be written.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
name String Y N Y : = ~
option_definitions [String] N N N N/A
space_type String N Y N N/A