Windows PowerShell command on Get-command Set-DnsClientServerAddress
NAME
Set-DnsClientServerAddress
SYNOPSIS
Sets DNS server addresses associated with the TCP/IP properties on an interface.
SYNTAX
Set-DnsClientServerAddress [-InterfaceAlias] [-CimSession ] [-PassThru]
[-ResetServerAddresses] [-ServerAddresses ] [-ThrottleLimit ] [-Validate] [-Confirm] [-WhatIf]
[]
Set-DnsClientServerAddress [-CimSession ] [-PassThru] [-ResetServerAddresses] [-ServerAddresses
] [-ThrottleLimit ] [-Validate] [-Confirm] [-WhatIf] []
Set-DnsClientServerAddress [-CimSession ] [-PassThru] [-ResetServerAddresses] [-ServerAddresses
] [-ThrottleLimit ] [-Validate] -InterfaceIndex [-Confirm] [-WhatIf]
[]
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
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceAlias
Specifies the friendly name of the interface.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceIndex
Specifies the index number of the interface.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByValue, ByPropertyName)
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ResetServerAddresses []
Resets the DNS server IP addresses to the default value.
Required? false
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.
Required? false
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 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.
Required? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm []
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf []
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.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Online Version:
Get-DnsClientServerAddress