dtc:record:cname : DTC CNAME Record object.¶
A DTC CNAME object represents a DNS Traffic Control Canonical name (DTC CNAME) resource record. DTC CNAME record maps domain name alias to its canonical domain name.
Note¶
Parameter dtc_server is required for object searches.
Object Reference¶
References to dtc:record:cname are object references.
The name part of the DTC CNAME Record object reference has the following components:
The name of the DTC Server object with which the record is associated
The canonical name of the DTC CNAME record
Example: dtc:record:cname/ZG5zLmJpbmRfY25h:dtcserver/dtc.localdomain
Restrictions¶
The object does not support the following operations:
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): canonical, dtc_server.
The following fields are required to create this object:
Field |
Notes |
|---|---|
canonical |
|
dtc_server |
auto_created¶
- auto_created¶
Flag that indicates whether this record was automatically created by NIOS.
Type
String.
Search
The field is not available for search.
Notes
The auto_created cannot be updated.
auto_created cannot be written.
canonical¶
- canonical¶
The canonical name of the host.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The canonical is part of the base object.
comment¶
- comment¶
Comment for the 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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
disable¶
- disable¶
Determines if the 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_canonical¶
- dns_canonical¶
The canonical name as server by DNS protocol.
Type
String.
Search
The field is not available for search.
Notes
The dns_canonical cannot be updated.
dns_canonical cannot be written.
dtc_server¶
- dtc_server¶
The name of the DTC Server object with which the DTC record is associated.
Type
String.
Create
The field is required on creation.
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.
ttl¶
- ttl¶
The Time to Live (TTL) value.
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.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
auto_created |
String |
N |
Y |
N |
N/A |
canonical |
String |
Y |
N |
Y |
: = ~ |
comment |
String |
N |
N |
N |
: = ~ |
disable |
Bool |
N |
N |
N |
N/A |
dns_canonical |
String |
N |
Y |
N |
N/A |
dtc_server |
String |
Y |
N |
Y |
= |
ttl |
Unsigned int |
N |
N |
N |
N/A |
use_ttl |
Bool |
N |
N |
N |
N/A |
