Set-DnsClient

Set-DnsClient

Sets the interface specific DNS client configurations on the computer.

Syntax

Parameter Set: ByAlias
Set-DnsClient [-InterfaceAlias] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionSpecificSuffix <String> ] [-PassThru] [-RegisterThisConnectionsAddress <Boolean> ] [-ResetConnectionSpecificSuffix] [-ThrottleLimit <Int32> ] [-UseSuffixWhenRegistering <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: __cmdletization_InputObject
Set-DnsClient -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionSpecificSuffix <String> ] [-PassThru] [-RegisterThisConnectionsAddress <Boolean> ] [-ResetConnectionSpecificSuffix] [-ThrottleLimit <Int32> ] [-UseSuffixWhenRegistering <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByName
Set-DnsClient -InterfaceIndex <UInt32[]> [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionSpecificSuffix <String> ] [-PassThru] [-RegisterThisConnectionsAddress <Boolean> ] [-ResetConnectionSpecificSuffix] [-ThrottleLimit <Int32> ] [-UseSuffixWhenRegistering <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DnsClient cmdlet sets the interface specific DNS client configurations on the computer.

Parameters

-AsJob

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	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ConnectionSpecificSuffix<String>

Specifies the connection-specific suffixes that are to be appended. This parameter is a per-connection DNS suffix which will be appended to the computer name to construct a Fully Qualified Domain Name (FQDN). This FQDN will be used as the host name for name resolution by the DNS client.

Aliases	Suffix
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?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RegisterThisConnectionsAddress<Boolean>

Specifies that the IP address for this connection is to be registered. The default value is True.

Aliases	none
Required?	false
Position?	named
Default Value	True
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ResetConnectionSpecificSuffix

Resets the connection-specific suffix to the default value.

Aliases	ResetSuffix
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

-UseSuffixWhenRegistering<Boolean>

Specifies that this host name and the connection specific suffix for this connection are to be registered.

Aliases	none
Required?	false
Position?	named
Default Value	False
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

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.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

• 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

The output type is the type of the objects that the cmdlet emits.

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

Examples

EXAMPLE 1

This example sets the connection-specific suffix on an interface with index 12.

PS C:\> Set-DnsClient -InterfaceIndex 12 -ConnectionSpecificSuffix "corp.contoso.com"

Related topics

Get-DnsClient

Register-DnsClient