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

Removes the specified 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.


Remove-CsUserReplicatorConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Xds Identity

Unique identifier of the user replicator configuration settings to be removed. To remove settings at the service scope, use syntax similar to this: -Identity "service:Registrar:atl-cs-001.litwareinc.com". To reset the global settings, use this syntax: -Identity global. You cannot use wildcards when specifying an Identity.



Switch Parameter

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



Switch Parameter

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



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.

If your needs change later on, you can use the Remove-CsUserReplicatorConfiguration cmdlet to remove the custom settings created at the service scope. Note that you can also run this cmdlet against the global configuration settings. In that case, however, the global settings will not be removed; instead, all the properties within the global collection will be reset to their default values. In the case of the user replicator, that means erasing the list of domains that must be synchronized with to the local domain, and setting the replication interval cycle to 5 minutes.

Return Types

Removes-CsUserReplicatorConfiguration deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.UserReplicator.UserReplicatorConfiguration object.


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

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

The preceding command deletes the user replicator configuration settings that have the Identity "service:Redmond-Registrar-1".

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

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

The command shown in Example 2 deletes all the user replicator configuration settings that have been applied at the service scope. To do this, the command first uses Get-CsUserReplicatorConfiguration and the –Filter parameter to return all the settings configured at the service scope; the filter value "service:*" ensures that only items that have an Identity that begins with the string value "service:" will be returned. This filtered collection is then piped to Remove-CsUserReplicatorConfiguration, which deletes each item in the collection.