Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-DnsServerResourceRecord

Set-DnsServerResourceRecord

ps_dnsserverresourcerecord_v1.0.0.cdxml

Synopsis

Changes a resource record in a DNS zone.

Syntax

Set-DnsServerResourceRecord [-ZoneName] [-OldInputObject] [-NewInputObject] [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-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 <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Cn,ForwardLookupPrimaryServer

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NewInputObject <CimInstance>

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

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-OldInputObject <CimInstance>

Specifies a DNS server resource record object.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ZoneName <String>

Specifies the name of a DNS zone.

Aliases

ForwardLookupZone

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord

Return Type

Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord

Notes

None

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
HostName                  RecordType Timestamp            TimeToLive      RecordData

--------                  ---------- ---------            ----------      ----------

Host01                       A          0                    02:00:00        2.2.2.2

Online Version
Get-DnsServerResourceRecord
Add-DnsServerResourceRecord
Remove-DnsServerResourceRecord