Share via

  • Article

Get-CsUserReplicatorConfiguration

 

Topic Last Modified: 2012-03-23

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 Lync Server 2010.

Syntax

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

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

Detailed Description

Although Lync Server 2010 maintains its own database of user accounts and user account data, Lync Server still relies 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 (such as the Active Directory display name). When a user is enabled for Lync Server, however, you do not need to specify a new display name for that user. That’s because Lync Server uses the display name already stored in Active Directory Domain Services (AD DS).

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 Lync Server database and Active Directory remain in synch, Lync 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 Lync Server is carried out by the User Replicator.

When you install Lync Server 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 Lync Server needs to synch with as well as indicating how often the User Replicator checks Active Directory for user account updates. By default, the User Replicator discovers and synchs with all available domains. However, by using the AdDomainNamingContextList property you can restrict synchronization to a specific set of domains: the domains that appear in the AdDomainNamingContextList property.

If you are working with Lync Online 2010 you can also use the CsUserReplicatorConfiguration cmdlets to create and manage configuration settings at the service scope. However, with the on-premises version of Lync Server 2010 you are limited to a single collection of configuration settings assigned to the global scope.

The Get-CsUserReplicatorConfiguration cmdlet enables administrators to return information about all the User Replicator settings currently employed in their organization.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsUserReplicatorConfiguration cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself) run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsUserReplicatorConfiguration"}

Parameters

Parameter Required Type Description

Identity

Optional

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". (Note that service scope settings are available only if you are running Lync Online 2010). 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.

Filter

Optional

String

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:*".

LocalStore

Optional

Switch Parameter

Retrieves the User Replicator configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsUserReplicatorConfiguration does not accept pipelined input.

Return Types

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

Example

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

Get-CsUserReplicatorConfiguration

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