DnsServerCNameRecords.adoc

DSC Resource 'DnsServerCNameRecords'

DnsServerCNameRecords manages CNAME DNS records against a specific zone on a Domain Name System (DNS) server.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DnsServerCNameRecords
DSC Resource	DnsServerDsc
Documentation	DnsRecordCname

Table 1. Attributes of category 'DnsServerCNameRecords'

Parameter	Attribute	DataType	Description	Allowed Values
Records	Mandatory	Hashtable[]	List of A DNS records

Table 2. Attributes of category 'DnsServerCNameRecords/Records'

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	Specifies the name of a DNS server resource record object.
ZoneName	Key	String	Specifies the name of a DNS zone.
HostNameAlias	Key	String	Specifies a a canonical name target for a CNAME record. This must be a fully qualified domain name (FQDN).
TimeToLive		String	Specifies the TimeToLive value of the SRV record. Value must be in valid TimeSpan string format (i.e.: Days.Hours:Minutes:Seconds.Miliseconds or 30.23:59:59.999).
Ensure		String	Whether the host record should be present or removed	Present (default) Absent

Example

DnsServerCNameRecords:
  Records:
    - Name:          mailserver1
      ZoneName:      contoso.com
      HostNameAlias: mail.contoso.com
      Ensure:        Present

Recommended Lookup Options in Datum.yml (Excerpt)

default_lookup_options: MostSpecific

lookup_options:

  DnsServerCNameRecords:
    merge_hash: deep
  DnsServerCNameRecords\Records:
    merge_hash_array: UniqueKeyValTuples
    merge_options:
      tuple_keys:
        - Name
        - ZoneName
        - HostNameAlias