Set-DnsServerResourceRecord

Set-DnsServerResourceRecord

Changes a resource record in a DNS zone.

Syntax

Parameter Set: Set1
Set-DnsServerResourceRecord [-ZoneName] <String> [-OldInputObject] <CimInstance> [-NewInputObject] <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DnsServerResourceRecord cmdlet changes a resource record object located in a Domain Name System (DNS) zone. You can use the OldInputObject parameter to specify a resource record object that you want to change and NewInputObject to specify a new resource record. This cmdlet cannot change the Name or Type of a DNS server resource record object.

Parameters

-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.

-NewInputObject<CimInstance>

Specifies a DNS server resource record object to overwrite the OldInputObject parameter value.

-OldInputObject<CimInstance>

Specifies a DNS server resource record object.

-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.

-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.

• Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord

Outputs

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

• Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord

Examples

Example 1: Change the settings of a resource record

In this example, the time to live (TTL) value of the resource record named Host01 in the zone named contoso.com is changed to 2 hours.

The first command assigns a resource record named Host01 in the zone named contoso.com to the variables $NewObj and $OldObj.

The second command sets the TTL time span for $NewObj to 2 hours.

The third command changes the properties of $OldObj to the settings specified for $NewObj in the previous command.

PS C:\> $NewObj = $OldObj = Get-DnsServerResourceRecord -Name "Host01" -ZoneName "contoso.com" -RRType "A"

PS C:\> $NewObj.TimeToLive = [System.TimeSpan]::FromHours(2)

PS C:\> Set-DnsServerResourceRecord -NewInputObject $NewObj -OldInputObject $OldObj -ZoneName "contoso.com" -PassThru

Related topics

Get-DnsServerResourceRecord

Add-DnsServerResourceRecord

Remove-DnsServerResourceRecord