ipv6dhcpoptiondefinition : DHCP IPv6 option definition object.¶
An IPv6 option definition defines a DHCP IPv6 option within a specific IPv6 option space. A custom IPv6 option can be defined in the predefined DHCP IPv6 option space or in the user-defined vendor IPv6 option space. To define an IPv6 option, add the IPv6 option definition to the required IPv6 option space.
Object Reference¶
References to ipv6dhcpoptiondefinition are object references.
The name part of the ipv6dhcpoptiondefinition object reference has the following components:
The name of the DHCP IPv6 option definition object.
- Example:
ipv6dhcpoptiondefinition/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:first
Restrictions¶
The object does not support the following operations:
Global search (searches via the search object)
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): code, name, type.
The following fields are required to create this object:
Field |
Notes |
---|---|
code |
|
name |
|
type |
code¶
- code¶
The code of a DHCP IPv6 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 IPv6 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 DHCPv6.
Search
The field is available for search via
‘=’ (exact equality)
type¶
- type¶
The data type of the Grid DHCP IPv6 option.
Type
String.
- Valid values are:
16-bit signed integer
16-bit unsigned integer
32-bit signed integer
32-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 8-bit integer
array of 8-bit unsigned integer
array of ip-address
boolean
boolean array of ip-address
boolean-text
domain-list
domain-name
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 |
= |