< Back

Set-ADReplicationConnection

Tue Jan 29, 2019 9:23 pm

NAME Set-ADReplicationConnection



SYNOPSIS

Sets properties on Active Directory replication connections.





SYNTAX

Set-ADReplicationConnection [-Identity] <ADReplicationConnection> [-Add <Hashtable>] [-AuthType {Negotiate |

Basic}] [-Clear <String[]>] [-Credential <PSCredential>] [-PassThru] [-Remove <Hashtable>] [-Replace <Hashtable>]

[-ReplicateFromDirectoryServer <ADDirectoryServer>] [-ReplicationSchedule <ActiveDirectorySchedule>] [-Server

<String>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-ADReplicationConnection [-AuthType {Negotiate | Basic}] [-Clear <String[]>] [-Credential <PSCredential>]

[-PassThru] [-Server <String>] -Instance <ADReplicationConnection> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-ADReplicationConnection cmdlet sets properties on Active Directory replication connections. Connections

are used to enable domain controllers to replicate with each other. A connection defines a one-way, inbound route

from one domain controller, the source, to another domain controller, the destination. The Kerberos consistency

checker (KCC) reuses existing connections where it can, deletes unused connections, and creates new connections if

none exist that meet the current need.





PARAMETERS

-Add <Hashtable>

Specifies values to add to an object property. Use this parameter to add one or more values to a property that

cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name.

You can specify multiple values to a property by specifying a comma-separated list of values and more than one

property by separating them using a semicolon.. The format for this parameter is



-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...;

AttributeNLDAPDisplayName=value1, value2, ...}



For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and

"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value

"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as

follows.



-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove

@{otherTelephone='555-222-2222'}



When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the

following order:



..Remove



..Add



..Replace



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AuthType <ADAuthType>

Specifies the authentication method to use. Possible values for this parameter include:



Negotiate or 0



Basic or 1



The default authentication method is Negotiate.



A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.



The following example shows how to set this parameter to Basic.



-AuthType Basic



Required? false

Position? named

Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate

Accept pipeline input? false

Accept wildcard characters? false



-Clear <String[]>

Specifies an array of object properties that will be cleared in the directory. Use this parameter to clear one

or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property,

you must use the LDAP display name. You can modify more than one property by specifying a comma-separated

list. The format for this parameter is



-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName



For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name

'otherTelephone') set the Clear parameter as follows.



-Clear otherTelephone



When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the

following order:



..Remove



..Add



..Replace



..Clear



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

Specifies a user account that has permission to perform this action. The default is the current user.



Type a user name, such as "User01" or "Domain01\\User01", or enter a PSCredential object, such as one generated

by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.



This parameter is not supported by any providers installed with Windows PowerShell.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Identity <ADReplicationConnection>

Specifies an Active Directory object by providing one of the following property values. The identifier in

parentheses is the LDAP display name for the attribute.



Distinguished Name



Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com



GUID (objectGUID)



Example: 599c3d2e-f72d-4d20-8a88-030d99495f20



The cmdlet searches the default naming context or partition to find the object. If two or more objects are

found, the cmdlet returns a non-terminating error.



This parameter can also get this object through the pipeline or you can set this parameter to an object

instance.



Derived types, such as the following are also accepted:



Microsoft.ActiveDirectory.Management.ADGroup



Microsoft.ActiveDirectory.Management.ADUser



Microsoft.ActiveDirectory.Management.ADComputer



Microsoft.ActiveDirectory.Management.ADServiceAccount



Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy



Microsoft.ActiveDirectory.Management.ADDomain



This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance".



-Identity $ADObjectInstance



Required? true

Position? 1

Default value

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Instance <ADReplicationConnection>

Specifies an instance of an Active Directory object to use as a template for a new Active Directory object.



You can use an instance of an existing Active Directory object as a template or you can construct a new Active

Directory object by using the Windows PowerShell command line or by using a script. The following examples

show how to use these two methods to create a new Active Directory object.



Method 1: Use an existing Active Directory object as a template for a new object. To retrieve an instance of

an existing Active Directory object, use a cmdlet such as Get-ADObject. Then provide this object to the

Instance parameter of the New-ADObject cmdlet to create a new Active Directory object. You can override

property values of the new object by setting the appropriate parameters.



$objectInstance = Get-ADObject -Identity saraDavisDesktop



New-ADObject -Name "ellenAdamsDesktop" -Instance $ObjectInstance -Type "computer"



Method 2: Create a new ADObject and set the property values by using the Windows PowerShell command line

interface. Then pass this object to the Instance parameter of the New-ADObject cmdlet to create the new Active

Directory object.



$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADObject $objectInstance.Description =

"Ellen Adams New Computer" New-ADObject -Name ellenAdamsDesktop -Instance $ObjectInstance -Type computer



Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be

set will raise an error.



Required? true

Position? named

Default value

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not

generate any output.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Remove <Hashtable>

Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or more values

of a property that cannot be modified using a cmdlet parameter. To remove an object property, you must use the

LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format

for this parameter is



-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}



For example, if you want to add the values blue and green and remove the value pink from a property with a

LDAP display name of FavColors, set the Add and Remove parameters as follows.



-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}



When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the

following sequence:



..Remove



..Add



..Replace



..Clear



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Replace <Hashtable>

Specifies values for an object property that will replace the current values. Use this parameter to replace

one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object

property, you must use the LDAP display name. You can modify more than one property by specifying a

comma-separated list. The format for this parameter is



-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}



For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for

Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.



-Replace @{otherTelephone='555-222-2222', '555-222-1111'}



When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the

following order:



..Remove



..Add



..Replace



..Clear



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReplicateFromDirectoryServer <ADDirectoryServer>

Specifies the domain controller to use as a source for this replication connection.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReplicationSchedule <ActiveDirectorySchedule>

Specifies the schedule on which the source server is available for replication.



Replication occurs at intervals that administrators can schedule so that use of expensive WAN links is

managed. Use this parameter to specify the replication intervals. For more information on how replication

topology works, go to http://go.microsoft.com/fwlink/?LinkId=223932.



To specify the replication schedule,



1. Create a new Active Directory schedule object.



Example:



$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule;



2. Edit the schedule on the Active Directory schedule object.



Example:



$schedule.ResetSchedule();



$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty");



3. Using the Active Directory schedule object, set the replication schedule of the connection



Set-ADReplicationConnection "5f98e288-19e0-47a0-9677-57f05ed54f6b" -ReplicationSchedule $schedule



For more information on the ActiveDirectorySchedule class, go to http://go.microsoft.com/fwlink/?LinkId=223933.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Server <String>

Specifies the Active Directory Domain Services instance to connect to, by providing one of the following

values for a corresponding domain name or directory server. The service may be any of the following: Active

Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.



Domain name values:



Fully qualified domain name



Examples: corp.contoso.com



NetBIOS name



Example: CORP



Directory server values:



Fully qualified directory server name



Example: corp-DC12.corp.contoso.com



NetBIOS name



Example: corp-DC12



Fully qualified directory server name and port



Example: corp-DC12.corp.contoso.com:3268



The default value for the Server parameter is determined by one of the following methods in the order that

they are listed:



-By using Server value from objects passed through the pipeline.



-By using the server information associated with the Active Directory PowerShell provider drive, when running

under that drive.



-By using the domain of the computer running Powershell.



The following example shows how to specify a full qualified domain name as the parameter value.



-Server "corp.contoso.com"



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



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.



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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None or Microsoft.ActiveDirectory.Management.ADReplicationConnection



A connection object is received by the Identity parameter.



A connection object that was retrieved by using the Get-ADReplicationConnection cmdlet and then modified is

received by the Instance parameter.





OUTPUTS

None or Microsoft.ActiveDirectory.Management.ADReplicationConnection







-------------------------- EXAMPLE 1 --------------------------



C:\\PS>Set-ADReplicationConnection "5f98e288-19e0-47a0-9677-57f05ed54f6b" -ReplicateFromDirectoryServer corp-DC01



Description



-----------



Set the replication connection with name '5f98e288-19e0-47a0-9677-57f05ed54f6b' to replicate from corp-DC01.

-------------------------- EXAMPLE 2 --------------------------



C:\\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule;

$schedule.ResetSchedule();

$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty");

Get-ADReplicationConnection -Filter {ReplicateFromDirectoryServer -eq "corp-DC01"} -Properties ReplicationSchedule

| % {Set-ADReplicationConnection $_ - ReplicationSchedule $schedule}



Description



-----------



Get all the replication connections in the directory that replicate from corp-DC01. Set the daily replication

schedule on these connection objects.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/p/?linkid=291124

Get-ADReplicationConnection