superhostchild : Super Host Child object.

The superhostchild object is a read-only synthetic object used to retrieve records assigned to superhost.

Since this is a synthetic object, it supports reading only by specifying search parameters, not by reference.

Object Reference

References to superhostchild are object references. The name part of an superhostchild object reference has the following components:

  • The name of the record contained in the superhostchild object.

Example: superhostchild/Li5zdXBlcl9ob3N0fZGVmYXV:SUPERHOST1/arecord/1.1.1.1

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Permissions
  • Read by object reference
  • 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): comment, data, name, network_view, parent, record_parent, type, view.

associated_object

associated_object

The record object, if supported by the WAPI. Otherwise, the value is “None”.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The associated_object cannot be updated.

associated_object cannot be written.

comment

comment

The record comment.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

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

Notes

The comment is part of the base object.

The comment cannot be updated.

comment cannot be written.

creation_timestamp

creation_timestamp

Time at which DNS RR was created.

Type

Timestamp.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The creation_timestamp cannot be updated.

creation_timestamp cannot be written.

data

data

Specific data of DNS/DHCP records.

Type

String.

Search

The field is available for search via

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

Notes

The data is part of the base object.

The data cannot be updated.

data cannot be written.

disabled

disabled

True if the child DNS/DHCP object is disabled.

Type

Bool.

Search

The field is not available for search.

Notes

The disabled cannot be updated.

disabled cannot be written.

name

name

Name of the associated DNS/DHCP object.

Type

String.

Search

The field is available for search via

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

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

network_view

network_view

The name of the network view in which this network record resides.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view is part of the base object.

The network_view cannot be updated.

network_view cannot be written.

parent

parent

Name of the Super Host object in which record resides.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The parent is part of the base object.

The parent cannot be updated.

parent cannot be written.

record_parent

record_parent

Name of a parent zone/network.

Type

String.

Search

The field is available for search via

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

Notes

The record_parent is part of the base object.

The record_parent cannot be updated.

record_parent cannot be written.

type

type

The record type. When searching for an unspecified record type, the search is performed for all records.

Type

String.

Valid values are:
  • ARecord
  • AaaaRecord
  • FixedAddress
  • HostRecord
  • IPv6FixedAddress
  • PtrRecord

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type is part of the base object.

The type cannot be updated.

type cannot be written.

view

view

Name of the DNS View in which the record resides.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The view is part of the base object.

The view cannot be updated.

view cannot be written.

Fields List

Field Type Req R/O Base Search
associated_object String N Y N N/A
comment String N Y Y : = ~
creation_timestamp Timestamp N Y N < = >
data String N Y Y : = ~
disabled Bool N Y N N/A
name String N Y Y : = ~
network_view String N Y Y =
parent String N Y Y =
record_parent String N Y Y : = ~
type String N Y Y =
view String N Y Y =