record:dname : DNS DNAME record object.¶
A DNAME record maps all the names in one domain to those in another domain, essentially substituting one domain name suffix with the other.
Object Reference¶
References to record:dname are object references. The name part of a DNS DNAME object reference has the following components:
The name of the record.
The name of the view.
Example: record:dname/ZG5zLmJpsaG9zdA:us.example.com/default.external
Restrictions¶
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, target, view.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
|
target |
cloud_info¶
- cloud_info¶
The structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
comment¶
- comment¶
The comment for the record.
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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
creation_time¶
- creation_time¶
The time of the record creation in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The creation_time cannot be updated.
creation_time cannot be written.
creator¶
- creator¶
The record creator.
Type
String.
- Valid values are:
DYNAMIC
STATIC
SYSTEM
Create
The default value is STATIC.
Search
The field is available for search via
‘=’ (exact equality)
ddns_principal¶
- ddns_principal¶
The GSS-TSIG principal that owns this record.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
ddns_protected¶
- ddns_protected¶
Determines if the DDNS updates for this record are allowed.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
disable¶
- disable¶
Determines if the record is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
dns_name¶
- dns_name¶
Name of a DNS DNAME 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.
dns_target¶
- dns_target¶
The target domain name of the DNS DNAME 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_target cannot be updated.
dns_target 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.
forbid_reclamation¶
- forbid_reclamation¶
Determines if reclamation is allowed for the record.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
last_queried¶
- last_queried¶
The time of the last DNS query in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_queried cannot be updated.
last_queried cannot be written.
name¶
- name¶
The name of the DNS DNAME record in FQDN 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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
reclaimable¶
- reclaimable¶
Determines if the record is reclaimable.
Type
Bool.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The reclaimable cannot be updated.
reclaimable cannot be written.
target¶
- target¶
The target domain name of the DNS DNAME record in FQDN 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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The target is part of the base object.
ttl¶
- ttl¶
Time To Live (TTL) value for the record. A 32-bit unsigned integer that represents the duration, in seconds, that the record is valid (cached). Zero indicates that the record should not be cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
use_ttl¶
- use_ttl¶
Use flag for: ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
view¶
- view¶
The name of the DNS View in which the record resides, for example “external”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default DNS view.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The view is part of the base object.
The view cannot be updated.
zone¶
- zone¶
The name of the zone in which the record resides. For example: “zone.com”. If a view is not specified when searching by zone, the default view is used.
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 zone cannot be updated.
zone cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
cloud_info |
struct |
N |
Y |
N |
N/A |
comment |
String |
N |
N |
N |
: = ~ |
creation_time |
Timestamp |
N |
Y |
N |
N/A |
creator |
String |
N |
N |
N |
= |
ddns_principal |
String |
N |
N |
N |
: = ~ |
ddns_protected |
Bool |
N |
N |
N |
N/A |
disable |
Bool |
N |
N |
N |
N/A |
dns_name |
String |
N |
Y |
N |
N/A |
dns_target |
String |
N |
Y |
N |
N/A |
extattrs |
Extattr |
N |
N |
N |
ext |
forbid_reclamation |
Bool |
N |
N |
N |
N/A |
last_queried |
Timestamp |
N |
Y |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
reclaimable |
Bool |
N |
Y |
N |
= |
shared_record_group |
String |
N |
Y |
N |
N/A |
target |
String |
Y |
N |
Y |
: = ~ |
ttl |
Unsigned int |
N |
N |
N |
N/A |
use_ttl |
Bool |
N |
N |
N |
N/A |
view |
String |
N |
N |
Y |
= |
zone |
String |
N |
Y |
N |
= |
