allrecords : AllRecords object.

The allrecords object is a read-only synthetic object used to retrieve records that belong to a particular zone.

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

Object Reference

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

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

Example: allrecords/ZG5zLmJpbmRfY25h:12.0.10.0/12.0.30.0/arec1

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

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, name, type, view, zone.

address

address

The record address.

Type

String.

Search

The field is not available for search.

Notes

The address cannot be updated.

address 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.

creator

creator

The record creator.

Type

String.

Valid values are:

• DYNAMIC
• STATIC
• SYSTEM

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The creator cannot be updated.

creator cannot be written.

ddns_principal

ddns_principal

The GSS-TSIG principal that owns this record.

Type

String.

Search

The field is available for search via

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

Notes

The ddns_principal cannot be updated.

ddns_principal cannot be written.

ddns_protected

ddns_protected

Determines if the DDNS updates for this record are allowed or not.

Type

Bool.

Search

The field is not available for search.

Notes

The ddns_protected cannot be updated.

ddns_protected 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_obscured

dtc_obscured

The specific LBDN record.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The dtc_obscured cannot be updated.

dtc_obscured cannot be written.

name

name

The name of the record.

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.

reclaimable

reclaimable

Determines if the record is reclaimable or not.

Type

Bool.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The reclaimable cannot be updated.

reclaimable 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 Time To Live (TTL) value for which the record is valid or being cached. The 32-bit unsigned integer represents the duration in seconds. Zero indicates that the record should not be cached.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The ttl cannot be updated.

ttl cannot be written.

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
• record:a
• record:aaaa
• record:cname
• record:dname
• record:host
• record:host_ipv4addr
• record:host_ipv6addr
• record:mx
• record:naptr
• record:ptr
• record:srv
• record:txt
• record:unknown
• sharedrecord:a
• sharedrecord:aaaa
• sharedrecord:mx
• sharedrecord:srv
• sharedrecord:txt

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.

zone

zone

Name of the zone in which the record resides.

Type

String.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The zone is part of the base object.

The zone cannot be updated.

zone cannot be written.

Fields List

Field	Type	Req	R/O	Base	Search
address	String	N	Y	N	N/A
comment	String	N	Y	Y	: = ~
creator	String	N	Y	N	=
ddns_principal	String	N	Y	N	: = ~
ddns_protected	Bool	N	Y	N	N/A
disable	Bool	N	Y	N	N/A
dtc_obscured	String	N	Y	N	N/A
name	String	N	Y	Y	: = ~
reclaimable	Bool	N	Y	N	=
record	String	N	Y	N	N/A
ttl	Unsigned int	N	Y	N	N/A
type	String	N	Y	Y	=
view	String	N	Y	Y	=
zone	String	N	Y	Y	=