[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies an existing collection of user replicator configuration settings. The user replicator periodically retrieves up-to-date user account information from Active Directory and then synchronizes the new information with the current user data stored by Microsoft Communications Server 2010.

Syntax

Set-CsUserReplicatorConfiguration [-Identity <XdsIdentity>] [-ADDomainNamingContextList <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-ReplicationCycleInterval <TimeSpan>] [-WhatIf [<SwitchParameter>]]

Set-CsUserReplicatorConfiguration [-ADDomainNamingContextList <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-ReplicationCycleInterval <TimeSpan>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Optional

Xds Identity

Unique identifier of the user replicator configuration settings to be modified. To modify settings at the service scope, use syntax similar to this: -Identity "service:Redmond-Registrar-1". To modify the global settings, use this syntax: -Identity global.

Instance

Optional

UserReplicatorConfiguration object

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

ADDomainNamingContextList

Optional

PS List Modifier

Distinguished names of the Active Directory domains that the user replicator must synchronize with. For example, to add a domain to the list use syntax similar to this: -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"}

The ADDomainNamingContextList property can include more than one domain name. If you set this property to a null value ($Null) the user replicator will only synchronize with the local domain.

ReplicationCycleInterval

Optional

TimeSpan

Represents the amount of time that the user replicator waits before checking for user account updates in Active Directory. The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes, and 59 seconds; the default value is 5 minutes. The interval must be expressed using the format hours:minutes:seconds. For example, this syntax sets to time interval to one hour and 15 minutes: -ReplicationCycleInterval 01:15:00.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.

WhatIf

Optional

Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Although Microsoft Communications Server maintains its own database of user accounts and user account data, the software still relies strongly on Active Directory as the ultimate source for user information. For example, when a new Active Directory user account is created, you must supply basic information about the user account (for example, the Active Directory display name). Communications Server also makes use of the Active Directory display name; however, when a user is enabled for Communications Server you do not need to specify a new display name. Instead, Communications Server simply copies – and makes use of – the display name already stored in Active Directory.

Of course, user account information (including the Active Directory display name) is subject to change over time; for example, a user who gets married might change her last name and, in turn, need to change her display name as well. In order to ensure that the Communications Server database and Active Directory remain in synch, Communications Server must periodically check in with Active Directory, retrieve the latest user account updates, and then modify its own user database accordingly. This synchronization between Active Directory and Communications Server is carried out by the user replicator.

When you install Microsoft Communications Server 2010 a global set of user replicator configuration settings is created for you; by default, these settings are used to manage the user replicator on an organization-wide basis. (Management of the user replicator consists of identifying the domains that Communications Server needs to synch with as well as indicating how often the user replicator checks Active Directory for user account updates.) If this single collection of configuration settings does not sufficiently meet your needs, Communications Server also enables you to create additional collections at the service scope. Note that service-scoped settings can only be applied to the Registrar service.

The Set-CsUserReplicatorConfiguration cmdlet enables you to modify any of the user replicator settings currently in use in your organization. You can use this cmdlet to add or remove domains from the list of domains the user replicator must synchronize with, as well as modify the time interval between replication cycles.

Return Types

Set-CsUserReplicatorConfiguration does not return and objects or values. Instead, the cmdlet modifies the global instance (the only such instance) of the Microsoft.Rtc.Management.WriteableConfig.Settings.UserReplicator.UserReplicatorConfiguration object.

Examples

-------------------------- Example 1 ------------------------

Copy Code 
Set-CsUserReplicatorConfiguration -Identity global -ReplicationCycleInterval "00:05:00"

The preceding command sets the value of the ReplicationCycleInterval of the global user replicator settings to 5 minutes (0 hours: 5 minutes: 0 seconds).

-------------------------- Example 2 ------------------------

Copy Code 
Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList $Null

The command shown in Example 2 clears the value of the ADDomainNamingContextList property. This task is carried out by including the -ADDomainNamingContextList parameter and setting the parameter value to null ($Null).

-------------------------- Example 3 ------------------------

Copy Code 
Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"}

In Example 3 an additional name is added to the ADDomainNamingContextList property of the global user replicator settings. To do this, the syntax @{Add=} is used, along with the distinguished name of the domain being added. When this command is executed, fabrikam.com will be added to the list of domain names. To configure the global settings so that only fabrikam.com is on the list use this syntax: -ADDomainNamingContextList @{Replace="dc=fabrikam,dc=com"}.

-------------------------- Example 4 ------------------------

Copy Code 
Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList @{Remove="dc=fabrikam,dc=com"}

Example 4 removes the domain fabrikam.com from the ADDomainNamingContextList property of the global user replicator configuration settings. To do this the syntax @{Remove=} is used, along with the distinguished name of the domain (dc=fabrikam,dc=com).