Creates a new 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
New-CsUserReplicatorConfiguration -Identity <XdsIdentity> [-ADDomainNamingContextList <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-ReplicationCycleInterval <TimeSpan>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier of the user replicator configuration settings to be created. Settings can only be created at the service scope, and only for the Registrar service. That means that new settings must have an Identity similar to this: -Identity "service:Registrar:atl-cs-001.litwareinc.com". |
|
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"} You can add more than one domain name when calling New-CsUserReplicatorConfiguration; simply separate the domain names by using a comma: -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com",”dc=contoso,dc=com”} 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. |
|
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
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. (Service-scoped settings can only be applied to the Registrar service.)
New user replicator configurations settings are created using the New-CsUserReplicatorConfiguration cmdlet. Note that these settings can only be created at the service scope; you cannot create new settings at the global scope. In addition, your command will fail if the specified service already hosts a collection of user replicator configuration settings. For example, if the service Registrar:atl-cs-001.litwareinc.com already hosts user replicator settings any attempt to create a new collection at the service location will fail.
Return Types
New-CsUserReplicatorConfiguration creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.UserReplicator.UserReplicatorConfiguration object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
New-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" |
|
The command shown in Example 1 creates a new collection of user replicator configuration settings for the service Registrar:atl-cs-001.litwareinc.com. Because no additional parameters are specified, the new collection will use the default user replicator values.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
New-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" -AdDomaiNamingContextList @{Add="dc=fabrikam,dc=com","dc=contoso.com"}
|
|
Example 2 also creates a new collection of user replicator configuration settings for the service Registrar:atl-cs-001.litwareinc.com. In this case, however, the –AdDomainNamingContextList is added, along with the distinguished names of the two domains to synchronize with: fabrikam.com (dc=fabrikam,dc=com) and contoso.com (dc=contoso,dc=com). Note the syntax used to add items to the domain naming context list @{Add=} and note, too that the individual domain names are separated using a comma.