dtc:allrecords : DTC AllRecords object.

The DTC AllRecords object is a read-only synthetic object used to retrieve records that belong to a particular DTC server.

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

Object Reference

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

• The name of the DTC Server object with which the record is associated

In addition, corresponding NAPTR allrecord object reference contains following components:

• The order parameter of the record

• The preference of the record

• The replacement field of the record

Example: dtc:allrecords/ZG5zLmJpbmRfY25h:dtcserver/111/222/replacement

A (AAAA) allrecord object references contain following components:

• The IPv4 (IPv6) address of the host

Example: dtc:allrecords/ZG5zLmJpbmRfY25h:dtcserver/10.0.0.1

dtc:allrecords/ZG5zLmJpbmRfY25h:dtcserver/2001:db8::1

CNAME allrecord object reference contains following components:

• The canonical name of the host

Example: dtc:allrecords/ZG5zLmJpbmRfY25h:dtcserver/canonical.localdomain

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, dtc_server, type.

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

• ‘~=’ (regular expression)

• ‘=’ (exact equality)

• ‘:=’ (case insensitive search)

Notes

The comment is part of the base object.

The comment cannot be updated.

comment cannot be written.

disable

disable

The disable value determines if the record is disabled or not. “False” means the record is enabled.

Type

Bool.

Search

The field is not available for search.

Notes

The disable cannot be updated.

disable cannot be written.

dtc_server

dtc_server

The name of the DTC Server object with which the record is associated.

Type

String.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The dtc_server is part of the base object.

The dtc_server cannot be updated.

dtc_server cannot be written.

record

record

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 record cannot be updated.

record cannot be written.

ttl

ttl

The TTL value of the record associated with the DTC AllRecords object.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

type

type

The record type. When searching for an unspecified record type, the search is performed for all records. On retrieval, the appliance returns “UNSUPPORTED” for unsupported records.

Type

String.

Valid values are:

• ALL

• dtc:record:a

• dtc:record:aaaa

• dtc:record:cname

• dtc:record:naptr

• dtc:record:srv

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.

Fields List

Field	Type	Req	R/O	Base	Search
comment	String	N	Y	Y	: = ~
disable	Bool	N	Y	N	N/A
dtc_server	String	N	Y	Y	=
record	String	N	Y	N	N/A
ttl	Unsigned int	N	N	N	N/A
type	String	N	Y	Y	=