The Extensible Attribute Definition object is used to retrieve the definition of an extensible attribute.
Defined attributes can be associated with other Infoblox objects: DHCP Fixed Address, DHCP Fixed Address Template, DHCP Network, DHCP Network Template, DHCP Range, DHCP Range Template, DNS Host, DHCP Failover and DNS Zone objects that support extensible attributes
References to extensibleattributedef are object references.
The object does not support the following operations:
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, default_value, name, type.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| type |
The object types this extensible attribute is allowed to associate with.
Type
String array.
Create
The default value is undefined.
Search
The field is not available for search.
Comment for the Extensible Attribute Definition; maximum 256 characters.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
Notes
The comment is part of the base object.
Default value used to pre-populate the attribute value in the GUI. For email, URL, and string types, the value is a string with a maximum of 256 characters. For an integer, the value is an integer from -2147483648 through 2147483647. For a date, the value is the number of seconds that have elapsed since January 1st, 1970 UTC.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The default_value is part of the base object.
This option describes the action that must be taken on the extensible attribute by its descendant in case the ‘Inheritable’ flag is set.
Type
A/An Descendants struct.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
descendants_action is not readable.
This field contains extensible attribute flags. Possible values: (A)udited, (C)loud API, Cloud (G)master, (I)nheritable, (L)isted, (M)andatory value, MGM (P)rivate, (R)ead Only, (S)ort enum values, Multiple (V)alues If there are two or more flags in the field, you must list them according to the order they are listed above.
For example, ‘CR’ is a valid value for the ‘flags’ field because C = Cloud API is listed before R = Read only. However, the value ‘RC’ is invalid because the order for the ‘flags’ field is broken.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
List of Values. Applicable if the extensible attribute type is ENUM.
Type
A/An List of values struct array.
Create
The default value is undefined.
Search
The field is not available for search.
Maximum allowed value of extensible attribute. Applicable if the extensible attribute type is INTEGER.
Type
Unsigned integer.
Create
The default value is undefined.
Search
The field is not available for search.
Minimum allowed value of extensible attribute. Applicable if the extensible attribute type is INTEGER.
Type
Unsigned integer.
Create
The default value is undefined.
Search
The field is not available for search.
The name of the Extensible Attribute Definition.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| allowed_object_types | [String] | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| default_value | String | N | N | Y | N/A |
| descendants_action | struct | N | N | N | N/A |
| flags | String | N | N | N | N/A |
| list_values | [struct] | N | N | N | N/A |
| max | Unsigned int | N | N | N | N/A |
| min | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| namespace | String | N | Y | N | = |
| type | String | Y | N | Y | = |
