AddByCName method of the PS_DnsServerResourceRecord class

Adds a type CNAME resource record to a DNS server.


uint32 AddByCName(
  [in]  string                  HostNameAlias,
  [in]  string                  ZoneName,
  [in]  datetime                TimeToLive,
  [in]  boolean                 AllowUpdateAny,
  [in]  string                  Name,
  [in]  string                  ComputerName,
  [in]  boolean                 AgeRecord,
  [in]  boolean                 CName,
  [in]  boolean                 PassThru,
  [in]  string                  ZoneScope,
  [in]  string                  VirtualizationInstance,
  [out] DnsServerResourceRecord cmdletOutput


HostNameAlias [in]

Specifies the FQDN of the host to be aliased. This is the canonical name of the host.

ZoneName [in]

Specifies the name of a DNS zone.

TimeToLive [in]

Specifies the Time to Live (TTL) value, in seconds, for a resource record. Other DNS servers use this length of time to determine how long to cache a record.

AllowUpdateAny [in]

Indicates that any authenticated user can update a resource record that has the same owner name.

Name [in]

Specifies the alias for the CNAME record.

ComputerName [in]

Specifies a DNS server. If you do not specify this parameter, the command runs on the local system. You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

AgeRecord [in]

Indicates that the DNS server uses a time stamp for the resource record that this method adds. A DNS server can scavenge resource records that have become stale based on a time stamp.

CName [in]

If specified, creates a DNS Server Resource Record CNAME.

PassThru [in]

true to return the object that was modified by the method. By default, this method does not generate any output.

ZoneScope [in]

Name of the zone scope.

Windows Server 2012: Not supported.

VirtualizationInstance [in]

Unique identifier of the virtualization instance.

Windows Server 2012 R2 and Windows Server 2012: This parameter is unavailable prior to Windows Server 2016.

cmdletOutput [out]

Receives an embedded instance of the DnsServerResourceRecord class.


Minimum supported client
None supported
Minimum supported server
Windows Server 2012

See also