Export (0) Print
Expand All
Expand Minimize

Move-CsLegacyUser

 

Topic Last Modified: 2012-05-21

Migrates one or more user accounts from Microsoft Office Communications Server 2007 R2 or Microsoft Office Communications Server 2007 to Microsoft Lync Server 2010.

Move-CsLegacyUser -Identity <UserIdParameter> -Target <Fqdn> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExcludeArchivingPolicy <SwitchParameter>] [-ExcludeConferencingPolicy <SwitchParameter>] [-ExcludeDialPlan <SwitchParameter>] [-ExcludeExternalAccessPolicy <SwitchParameter>] [-ExcludePresencePolicy <SwitchParameter>] [-ExcludeVoicePolicy <SwitchParameter>] [-Force <SwitchParameter>] [-PassThru <SwitchParameter>] [-ProxyPool <Fqdn>] [-WhatIf [<SwitchParameter>]]

Many organizations that install Lync Server 2010 are also running an earlier version of the software (either Office Communications Server 2007 R2 or Office Communications Server 2007). Fortunately, this does not present a problem: you can run both the latest version of the software and an earlier version of the software simultaneously. Over time, you can then begin to migrate your configuration settings, your policies, and, finally, your user accounts to Lync Server 2010.

The Move-CsLegacyUser cmdlet not only enables you to migrate users to Lync Server 2010, but also gives you considerable control over the migration process. For example, in its simplest form you can give Move-CsLegacyUser the identity of the user to be migrated and the fully qualified domain name (FQDN) of the Lync Server 2010 Registrar pool where that user account will be homed; in turn, Move-CsLegacyUser will move the user account and will maintain any existing policies and settings that have been applied to the account. For example, suppose Ken Myer was assigned a dial plan in Office Communications Server. By default, when you migrate Ken’s account the dial plan will be migrated as well: that means that Move-CsLegacyUser will automatically assign Ken Myer the Lync Server 2010-equivalent of the dial plan he was assigned in Communications Server 2007 R2.

Of course, that will occur only if you have migrated dial plans and if there is a Lync Server 2010-equivalent of the dial plan that Ken Myer was assigned in Communications Server 2007 R2. Alternatively, you might have chosen to install Lync Server 2010 without migrating dial plans. In that case, you can call Move-CsLegacyUser along with the ExcludeDialPlan parameter. When you use this parameter, dial plans are not migrated along with the user account: that means that Ken Myer’s user account will be moved to Lync Server 2010 but he will not be assigned a dial plan. (This will be also be the case even if you did migrate dial plans; the ExcludeDialPlan parameters prevents the migrated user account from being assigned a dial plan.) Other parameters allow you to exclude voice policies, conferencing policies, archiving policies, external access policies, and/or presence policies when migrating user accounts.

Before you can run Merge-CsLegacyTopology, you must first install the Windows Management Instrumentation (WMI) Backward Compatibility interfaces package; this application is installed by running OCSWMIBC.msi. (OCSWMIBC.msi can be found on the installation DVD in the Setup folder.) After installing the Compatibility interfaces package, Merge-CsLegacyUser can then be called in order to move one or more user accounts from Communications Server 2007 R2 or Communications Server 2007 to Lync Server 2010.

If you need to move a user from Lync Server back to Office Communications Server do not use the Move-CsLegacyUser cmdlet. Instead, use the Move-CsUser cmdlet, and use the FQDN of the legacy Office Communications Server pool as the parameter value for Move-CsUser’s Target parameter. For example:

Move-CsUser –Identity "Ken Myer" –Target "ocs13.litwareinc.com"

Who can run this cmdlet? By default, members of the following groups are authorized to run the Move-CsLegacyUser cmdlet locally: RTCUniversalUserAdmins. 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 "Move-CsLegacyUser"}

 

Parameter Required Type Description

Identity

Required

Indicates the Identity of the user account to be migrated. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). User Identities can also be reference by using the user’s Active Directory distinguished name.

You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith".

Target

Required

String

FQDN of the Registrar pool where the user account should be homed. For example: -Target atl-cs-001.litwareinc.com.

DomainController

Optional

String

Enables you to connect to the specified domain controller in order to move a user account. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com).

ExcludeArchivingPolicy

Optional

Switch Parameter

When present, any archiving policies assigned to the user account are not retained when the account is migrated.

ExcludeConferencingPolicy

Optional

Switch Parameter

When present, any conferencing policies assigned to the user account are not retained when the account is migrated.

ExcludeDialPlan

Optional

Switch Parameter

When present, any dial plans assigned to the user account are not retained when the account is migrated.

ExcludeExternalAccessPolicy

Optional

Switch Parameter

When present, any external access policies assigned to the user account are not retained when the account is migrated.

ExcludePresencePolicy

Optional

Switch Parameter

When present, any presence policies assigned to the user account are not retained when the account is migrated.

ExcludeVoicePolicy

Optional

Switch Parameter

When present, any voice policies assigned to the user account are not retained when the account is migrated.

ProxyPool

Optional

String

This parameter is used only with Microsoft Lync Online 2010. It should not be used with an on-premises implementation of Lync Server.

Force

Optional

Switch Parameter

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

PassThru

Optional

Switch Parameter

Enables you to pass a user object through the pipeline that represents the user account being moved. By default, the Move-CsLegacyUser cmdlet does not pass objects through the pipeline.

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.

None. Move-CsLegacyUser does not accept pipelined input.

Move-CsLegacyUser does not return any values or objects. Instead, the cmdlet moves instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object.

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

Move-CsLegacyUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com"

In the preceding example, Move-CsLegacyUser is used to migrate the user account with the Identity Pilar Ackerman to the Registrar pool atl-cs-001.litwareinc. Because no additional parameters are included, any policies or settings previously assigned to this account will be migrated as well. That means that, if a legacy policy (such as a dial plan) was assigned to Pilar Ackerman, she will be assigned the Lync Server 2010-equivalent when her account is moved.

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

Move-CsLegacyUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" -ExcludeDialPlan 

The command shown in Example 2 migrates Pilar Ackerman’s user account, but does not migrate any dial plans previously assigned to her account. After the account is migrated, Pilar will not have an assigned dial plan.

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

Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Move-CsLegacyUser -Target "atl-cs-001.litwareinc.com"

In Example 3, all the user accounts in the Finance OU are moved to the Lync Server Registrar pool atl-cs-001.litwareinc.com. To carry out this task, the command first uses Get-CsUser and the OU parameter to retrieve a collection of all the user accounts in the Finance OU. After the accounts have been retrieved, the collection is piped to Move-CsLegacyUser, which moves each account to the new Registrar pool. This command assumes that all the users in the Finance OU are legacy users.

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

Get-CsUser -UnassignedUser | Move-CsLegacyUser -Target "atl-cs-001.litwareinc.com"

In the preceding example, Move-CsLegacyUser is used to assign a Registrar pool to all of the users that have enabled for Lync Server but are not currently assigned to a Registrar pool. In this command, the Get-CsUser cmdlet is first called, along with the UnassignedUser parameter, to return a collection of all the users not currently assigned to a Registrar pool. This collection is then piped to Move-CsLegacyUser, which assigns each user to the pool atl-cs-001.litwareinc.com. This example assumes that all of the unassigned users are legacy users.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft