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

Set-DnsClientServerAddress

msft_dnsclientserveraddress.cdxml

Synopsis

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

Syntax

Set-DnsClientServerAddress [-InterfaceAlias] [-AsJob] [-CimSession] [-PassThru] [-ResetServerAddresses] [-ServerAddresses] [-ThrottleLimit] [-Validate] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DnsClientServerAddress [-AsJob] [-CimSession] [-PassThru] [-ResetServerAddresses] [-ServerAddresses] [-ThrottleLimit] [-Validate] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DnsClientServerAddress [-AsJob] [-CimSession] [-PassThru] [-ResetServerAddresses] [-ServerAddresses] [-ThrottleLimit] [-Validate] [-InterfaceIndex] [-Confirm] [-WhatIf] [<CommonParameters>]

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

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

-InputObject <CimInstance[]>

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-InterfaceAlias <String[]>

Specifies the friendly name of the interface.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InterfaceIndex <UInt32[]>

Specifies the index number of the interface.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue, 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

-ResetServerAddresses <SwitchParameter>

Resets the DNS server IP addresses to the default value.

Aliases

ResetAddresses

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerAddresses <String[]>

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

Aliases

Addresses

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

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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#root\StandardCimv2\MSFT_DNSClient
Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddresses
Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter
Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface

Return Type

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

Notes

None

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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.

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

Online Version
Get-DnsClientServerAddress