PowerShell Commands

Set-DnsClientServerAddress

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

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.

Parameters

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

-InterfaceAlias <String[]>

  • This value is required

Specifies the friendly name of the interface.

-InterfaceIndex <UInt32[]>

  • This value is required
  • Accepts pipeline input ByValue

Specifies the index number of the interface.

-PassThru [<SwitchParameter>]

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

-ResetServerAddresses [<SwitchParameter>]

Resets the DNS server IP addresses to the default value.

-ServerAddresses [<String[]>]

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

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

-Validate [<SwitchParameter>]

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.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

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

  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.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands