The collection of correlated IPAM records which is related to single device.
References to superhost are object references. The name part of a SuperHost object reference has the following components:
- Name of SuperHost
Example: superhost/ZG5zLm5ldHdvcmtfdmlldyQxMTk:SupeHost1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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 |
The comment for Super Host.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
True if we have to delete all DNS/DHCP associated objects with Super Host, false by default.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
delete_associated_objects is not readable.
A list of DHCP objects refs which are associated with Super Host.
Type
An array of the following objects: fixedaddress, ipv6fixedaddress, record:host.
This field supports nested return fields as described here.
Create
The default value is empty.
Search
The field is not available for search.
Disable all DNS/DHCP associated objects with Super Host if True, False by default.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
A list of object refs of the DNS resource records which are associated with Super Host.
Type
An array of the following objects: record:a, record:aaaa, record:ptr, record:host.
This field supports nested return fields as described here.
Create
The default value is empty.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
Name of the Superhost.
Type
String.
Values with leading or trailing white space are not valid for this field.
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 |
|---|---|---|---|---|---|
| comment | String | N | N | Y | : = ~ |
| delete_associated_objects | Bool | N | N | N | N/A |
| dhcp_associated_objects | obj | N | N | N | N/A |
| disabled | Bool | N | N | N | = |
| dns_associated_objects | obj | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| name | String | Y | N | Y | : = ~ |
