Document toolboxDocument toolbox

CNAME Record


Note: IDN is supported for object types: fqdn and canonical_name. You can use punycode or IDNs while importing these objects.


Field NameData TypeRequired (Yes/No)Associated GUI FieldAssociated PAPI MethodUsage and Guidelines
Header-CnameRecordStringYes

Example: CnameRecord
fqdnFQDNYesAliaszoneThis field combines the CNAME record name and the zone name to form the FQDN. Example: c1.corp100.com
_new_fqdnFQDNNo

Add this field to overwrite the fqdn field when you select the overwrite or merge option.
viewStringNoDNS Viewviews

If no view is specified, the Default view is used. Example: Default

canonical_nameDomain nameYesCanonical Name canonicalExample: www.corp100.com
commentStringNoCommentcomment
disabledBooleanNoDisabledisabledExample: FALSE
ttl

Unsigned integer

NoTTLttl This is an inherited field. For information, see Data Specific Guidelines. Example: 28800
EA-SiteStringNoExtensible attribute Siteextensible_attributesEA-Site is an example of a predefined extensible attribute. You can add other predefined attributes to the data file. For information about data format and examples, see Data Specific Guidelines.
ADMGRP-JoeSmithStringNoPermissions
Admin
Group/Role
permissionADMGRP-JoeSmith is an example of an admin permission of a specific admin group. For information about data format and examples, see Data Specific Guidelines.

Examples

This section contains examples of how to create data files for CNAME records. All examples use comma as the separator. You can use other supported separators, such as semicolon, space, or tab.

Adding a CNAME Record

This example shows how to add a CNAME record, bind_cname.corp100.com, to the Default DNS view.

header-cnamerecord,fqdn*,canonical_name*,view cnamerecord,bind_cname.corp100.com,somewhere.corp100.com,default

Overwriting CNAME Record Data

This example shows how to override a canonical name from somewhere.corp100.com to somewhere2.corp100.com.

header-cnamerecord,fqdn*,canonical_name* cnamerecord,bind_cname.corp100.com,somewhere2.corp100.com

Merging CNAME Record Data

This example shows how to merge the following data: admin group DNS_Admins with RW permission and extensible attribute Site = New York.

header-cnamerecord,fqdn*,ADMGRPDNS_Admins,EA-Site cnamerecord,bind_cname.corp100.com,RW,New York

DNAME Record


Note: IDN is supported for object types: fqdn and target. You can use punycode or IDNs while importing these objects.


Field NameData TypeRequired (Yes/No)Associated GUI FieldAssociated PAPI MethodUsage and Guidelines
Header-DnameRecordStringYes

Example: DnameRecord
fqdnFQDNYesAliaszoneThis field combines the DNAME record name and the zone name to form the FQDN. Example: d1.corp100.com
_new_fqdnFQDNNo

Add this field to overwrite the fqdn field when you select the overwrite or merge option.
viewStringNoDNS Viewviews

If no view is specified, the Default view is used. Example: Default

target

Domain name

YesTargettargetExample: d1.foo.com
commentStringNoCommentcomment
disabledBooleanNoDisabledisabledExample: FALSE
ttl

Unsigned integer

NoTTLttlThis is an inherited field. For information, see Data Specific Guidelines. Example: 28800
EA-SiteStringNoExtensible attribute Siteextensible_attributesEA-Site is an example of a predefined extensible attribute. You can add other predefined attributes to the data file. For information about data format and examples, see Data Specific Guidelines.
ADMGRP-JoeSmithStringNoPermissions
Admin
Group/Role
permissionADMGRP-JoeSmith is an example of an admin permission of a specific admin group. For information about data format and examples, see Data Specific Guidelines.

Examples

This section contains examples of how to create data files for DNAME records. All examples use comma as the separator. You can use other supported separators, such as semicolon, space, or tab.

Adding a DNAME Record

This example shows how to add a DNAME record, bind_dname.corp100.com, with target = bind_dname.corp200.com, extensible attribute Site = HQ, and disabled = TRUE.

header-dnamerecord,fqdn*,target*,disabled,EA-Site dnamerecord,bind_dname.corp100.com,bind_dname.corp200.com,TRUE,HQ

Overwriting DNAME Record Data

This example shows how to enable the existing DNAME record, bind_dname.corp100.com, and add admin group DNS_Admins with RO permission.

header-dnamerecord,fqdn*,target*,disabled,ADMGRPDNS_Admins dnamerecord,bind_dname.corp100.com,bind_dname.corp200.com,FALSE,RO

Merging DNAME Record Data

This example shows how to add a comment to the existing DNAME record, bind_dname.corp100.com, and change the TTL to 3860.

header-dnamerecord,fqdn,target*,comment,ttl dnamerecord,bind_dname.corp100.com,bind_dname.corp200.com,Add by DNS admin,3860