Set-​Dns​Client​Server​Address

Sets DNS server addresses associated with the TCP/IP properties on an interface.

Syntax

Set-DnsClientServerAddress
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   -InputObject <CimInstance[]>
   [-PassThru]
   [-ResetServerAddresses]
   [-ServerAddresses <String[]>]
   [-ThrottleLimit <Int32>]
   [-Validate]
   [-WhatIf]
   [<CommonParameters>]
Set-DnsClientServerAddress
   [-InterfaceAlias] <String[]>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-PassThru]
   [-ResetServerAddresses]
   [-ServerAddresses <String[]>]
   [-ThrottleLimit <Int32>]
   [-Validate]
   [-WhatIf]
   [<CommonParameters>]
Set-DnsClientServerAddress
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   -InterfaceIndex <UInt32[]>
   [-PassThru]
   [-ResetServerAddresses]
   [-ServerAddresses <String[]>]
   [-ThrottleLimit <Int32>]
   [-Validate]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-DnsClientServerAddress cmdlet sets one or more IP addresses for DNS servers associated with an interface. This cmdlet statically adds DNS server addresses to the interface. If this cmdlet is used to add DNS servers to the interface, then the DNS servers will override any DHCP configuration for that interface.

Examples

Example 1: Set the DNS server addresses on an interface with a specified index value

PS C:\> Set-DnsClientServerAddress -InterfaceIndex 12 -ServerAddresses ("10.0.0.1","10.0.0.2")

This example sets the DNS server addresses on a specified interface with the index value of 12.

Example 2: Reset a DNS client to use the default DNS server addresses

PS C:\> Set-DnsClientServerAddress -InterfaceIndex 12 -ResetServerAddresses

This example resets the DNS client to use the default DNS server addresses specified by DHCP on the interface with an index value of 12.

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-InterfaceAlias

Specifies the friendly name of the interface.

Type:String[]
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InterfaceIndex

Specifies the index number of the interface.

Type:UInt32[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResetServerAddresses

Resets the DNS server IP addresses to the default value.

Type:SwitchParameter
Aliases:ResetAddresses
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerAddresses

Specifies a list of DNS server IP addresses to set for the interface.

Type:String[]
Aliases:Addresses
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Validate

Validates that one or more IP addresses are responsive DNS servers before the IP addresses are set to the interface. This parameter must be used with the ServerAddress parameter.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Inputs

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddresses

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Inputs

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Inputs

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddress

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

The MSFT_DNSClientServerAddress class has the various DNS server IP addresses configured on a given interface. If no interface is specified, then all interfaces are configured.