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

Set-DAEntryPointDC

ps_daentrypointdc_v1.0.0.cdxml

Synopsis

Modifies domain controller (DC) settings for the entry point.

Syntax

Set-DAEntryPointDC [-AsJob] [-CimSession] [-ComputerName] [-Force] [-NewDC] [-PassThru] [-ThrottleLimit] [-ExistingDC] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DAEntryPointDC [-AsJob] [-CimSession] [-ComputerName] [-Force] [-NewDC] [-PassThru] [-ThrottleLimit] [-EntryPointName] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-DAEntryPointDC cmdlet modifies domain controller (DC) settings for entry points, and can be used to the following: -- Assigns a DC to all entry points previously assigned to the DC specified in the ExistingDC parameter. This is useful when a DC is no longer reachable and entry points settings must be updated. -- Assigns a DC to a specific entry point. This is useful for optimization, such as improving the Group Policy propagation time by specifying a DC that is located within the same Active Directory site as the other servers in an entry point.

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

-ComputerName <String>

Specifies theIPv4 or IPv6 address, or host name, of a server included in the entry point.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EntryPointName <String>

Specifies the name of the entry point for which the DC is be updated.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ExistingDC <String>

Specifies the fully qualified domain name (FQDN) of the existing DC that will be updated.

Aliases

DomainControllerName

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NewDC <String>

Specifies the FQDN of the new DC.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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

-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

-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

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#DADomainController[]

Notes

None

Examples

EXAMPLE 1

This example associates Entry Point 1 with the DC named dc3.domain1.corp.contoso.com.

PS C:\>Set-DAEntryPointDC –EntryPointName "Entry Point 1" –NewDC "DC3.Domain1.corp.company.com" –Force –PassThru
EntryPointName       : Entry Point 1 
DomainControllerName : dc3.domain1.corp.contoso.com 

EXAMPLE 2

This example automatically picks the DC named dc3.domain1.corp.contoso.com is the closest to the server named da1.domain1.corp.contoso.com and associate the DC with Entry Point 1, because the NewDC parameter is not specified.

PS C:\>Set-DAEntryPointDC –EntryPointName "Entry Point 1" -ComputerName "da1.domain1.corp.contoso.com" –Force -PassThru
EntryPointName       : Entry Point 1 
DomainControllerName : dc3.domain1.corp.contoso.com 

EXAMPLE 3

This example associates all of the entry points which were previously associated with the DC named dc1.domain1.corp.contoso.com with the DC named dc3.domain1.corp.contoso.com.

PS C:\>Set-DAEntryPointDC –ExistingDC "dc1.domain1.corp.contoso.com" -NewDC "dc3.domain1.corp.contoso.com" –Force -PassThru
EntryPointName       : Entry Point 1 
DomainControllerName : dc3.domain1.corp.contoso.com 

Online Version
Add-DAEntryPoint
Get-DAEntryPoint
Get-DAEntryPointDC
Remove-DAEntryPoint
Set-DAEntryPoint