sharedrecord:txt : DNS Shared TXT record object.

A shared TXT (text) record is similar to a regular TXT record. It contains supplemental information for a host. SPF (Sender Policy Framework) records are specialized TXT records that identify the servers that send mail from a domain. The difference is that a shared TXT record should be added to a shared record group. If the shared record group is associated with other zones, the shared TXT record is shared among these zones.

Object Reference

References to sharedrecord:txt are object references. The name part of an shared TXT record object reference has the following components:

  • Name of the shared record
  • Name of the shared record group

Example: sharedrecord:txt/ZG5zLmJpbmRfdHh0U2Ig:some.name/sharedgroup

Restrictions

The object does not support the following operations:

  • 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): name, shared_record_group, text.

The following fields are required to create this object:

Field Notes
name  
shared_record_group  
text  

comment

comment

Comment for this shared record; maximum 256 characters.

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

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

disable

disable

Determines if this shared record is disabled or not. False means that the record is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

dns_name

dns_name

The name for this shared record in punycode format.

Type

String.

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

Search

The field is not available for search.

Notes

The dns_name cannot be updated.

dns_name cannot be written.

extattrs

extattrs

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

name

Name for this shared record. This value can be in unicode format.

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

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

Notes

The name is part of the base object.

shared_record_group

shared_record_group

The name of the shared record group in which the record resides.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The shared_record_group is part of the base object.

text

text

Text associated with the shared record. It can contain up to 255 bytes per substring and up a total of 512 bytes. To enter leading, trailing or embedded spaces in the text, add quotes (” ”) around the text to preserve the spaces.

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The text is part of the base object.

ttl

ttl

The Time To Live (TTL) value for this shared record. A 32-bit unsigned integer that represents the duration, in seconds, for which the shared record is valid (cached). Zero indicates that the shared record should not be cached.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

ttl is associated with the field use_ttl (see use flag).

use_ttl

use_ttl

Use flag for: ttl

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
comment String N N N : = ~
disable Bool N N N N/A
dns_name String N Y N N/A
extattrs Extattr N N N ext
name String Y N Y : = ~
shared_record_group String Y N Y N/A
text String Y N Y = ~
ttl Unsigned int N N N N/A
use_ttl Bool N N N N/A