Edit

Set-DAEntryPointDC

  • Reference
Module:
RemoteAccess

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

Syntax

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

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.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

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.

EXAMPLE 3

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

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.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

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

Type:String
Aliases:Cn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EntryPointName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ExistingDC

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

Type:String
Aliases:DomainControllerName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NewDC

Specifies the FQDN of the new DC.

Type:String
Position:Named
Default value:None
Required:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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 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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

CimInstance[]

CimInstance

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 array of DADomainController objects that contains the following properties:

-- ChangeByDCName: Provides a list of entry points for which the associated DCs have been changed, and the name of the new DC. The ExistingDC parameter has a specified value. The EntryPointName parameter does not have a specified value.

-- ChangeByEntryPoint: Provides information about the specified entry point and its updated DC. The ExistingDC parameter does not have a specified value. The EntryPointName parameter has a specified value.