Add-DnsServerResourceRecordCName

Add-DnsServerResourceRecordCName

Adds a type CNAME resource record to a DNS zone.

Syntax

Parameter Set: Add0
Add-DnsServerResourceRecordCName [-ZoneName] <String> [-Name] <String> [-HostNameAlias] <String> [-AgeRecord] [-AllowUpdateAny] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-TimeToLive <TimeSpan> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-DnsServerResourceRecordCName cmdlet adds a canonical name (CNAME) resource record to a specified Domain Name System (DNS) zone. A CNAME record allows you to use more than one resource record to refer to a single host.

You can use CNAME records for the following scenarios.

-- Host more than one kind of server on the same system. For instance, you might host an FTP server and a Web server on the same system with the names ftp.contoso.com and www.contoso.com.
-- Rename a computer with an existing host (A) resource record in the same DNS zone. You can use an CNAME resource record temporarily to allow a grace period for users and programs to switch from the old computer name to the new one.
-- Resolve a generic name for a well-known server, like www, to a group of servers, such as redundant Web servers.

Parameters

-AgeRecord

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

-AllowUpdateAny

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

-AsJob

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-ComputerName<String>

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.

-HostNameAlias<String>

Specifies the FQDN of the host that gets the alias. This is the canonical name of the host..

-Name<String>

Specifies the alias for the CNAME record.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

-TimeToLive<TimeSpan>

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.

-ZoneName<String>

Specifies the name of a DNS zone.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord

Examples

Example 1: Add a CNAME resource record

This command adds a CNAME resource record with the alias labsrv1 to the contoso.com domain for a system named srv1 in the zone named lab.contoso.com.

PS C:\> Add-DnsServerResourceRecordCName -Name "labsrv1" -HostNameAlias "srv1.lab.contoso.com" -ZoneName "contoso.com"