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

Returns information about the user replicator configuration settings currently employed in your organization. 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.


Get-CsUserReplicatorConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsUserReplicatorConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description



Xds Identity

Unique identifier of the user replicator configuration settings to be returned. To return settings at the service scope, use syntax similar to this: -Identity "service:Registrar:atl-cs-001.litwareinc.com". To return the global settings, use this syntax: -Identity global. If this parameter is not specified then all the user replicator configurations settings currently in use in your organization will be returned.




Enables you to use wildcards when specifying the collection (or collections) of user replicator configuration settings to be returned. For example, this command returns all the settings configured at the service scope: -Filter "service:*".



Switch Parameter

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 Get-CsUserReplicatorConfiguration cmdlet enables administrators to return information about all the user replicator settings currently employed in their organization.

Return Types

Get-CsUserReplicatorConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.UserReplicator.UserReplicatorConfiguration object.


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

Copy Code

The command shown in Example 1 returns information about all the user replicator configuration settings currently in use in your organization.

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

Copy Code
Get-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com"

The preceding command returns a single collection of user replicator configuration settings: those settings applied to the service Registrar:atl-cs-001.litwareinc.com.

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

Copy Code
Get-CsUserReplicatorConfiguration -Filter "service:*"

Example 3 returns information about all the user replicator configuration settings applied at the service scope. To do this, the command uses the –Filter parameter and the filter value "service:*". That filter value ensures that only settings that have an Identity that begins with the string value "service:" will be returned.