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

Set-DnsClient

msft_dnsclient.cdxml

Synopsis

Sets the interface specific DNS client configurations on the computer.

Syntax

Set-DnsClient [-InterfaceAlias] [-AsJob] [-CimSession] [-ConnectionSpecificSuffix] [-PassThru] [-RegisterThisConnectionsAddress] [-ResetConnectionSpecificSuffix] [-ThrottleLimit] [-UseSuffixWhenRegistering] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DnsClient [-AsJob] [-CimSession] [-ConnectionSpecificSuffix] [-PassThru] [-RegisterThisConnectionsAddress] [-ResetConnectionSpecificSuffix] [-ThrottleLimit] [-UseSuffixWhenRegistering] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DnsClient [-AsJob] [-CimSession] [-ConnectionSpecificSuffix] [-PassThru] [-RegisterThisConnectionsAddress] [-ResetConnectionSpecificSuffix] [-ThrottleLimit] [-UseSuffixWhenRegistering] [-InterfaceIndex] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

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

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

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

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

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

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 <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_DNSClientServerAddress
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_DNSClient

Notes

None

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"

Online Version
Get-DnsClient
Register-DnsClient