Moves one or more user accounts enabled for Communications Server to a new home registrar pool. This cmdlet can also be used to reconnect users whose accounts were disconnected from the system using Disconnect-CsUser.
Syntax
Move-CsUser -Identity <UserIdParameter> -Target <Fqdn> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-PassThru <SwitchParameter>] [-ProxyPool <Fqdn>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
UserIdParameter |
Indicates the Identity of the user account to be moved. User Identities can be specified using one of four formats: 1) The user's SIP address; 2) the user's Universal Principal Name; 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). Note that the SAMAccountName cannot be used as an identity because it is not necessarily unique in a forest. You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" would return all the users with the last name Smith. |
|
Target |
Required |
FQDN |
The fully qualified domain name (for example, atl-mcs-001.litwareinc.com) of the registrar pool where the user account should be homed. |
|
Force |
Optional |
Switch Parameter |
If present, moves the user account but deletes any associated data (such as policies that were assigned to the account). If not present, the account is moved along with any associated data. |
|
DomainController |
Optional |
String |
|
|
ProxyPool |
Optional |
String |
|
|
PassThru |
Optional |
Switch Parameter |
|
|
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
The Move-CsUser cmdlet serves at least two functions. First it enables you to move a user account enabled for Communications Server from one registrar pool to another. This affects only the account location with Communications Server; it does not move the user's Active Directory account to a new organizational unit (OU) or a new location.
Second, Move-CsUser enables you to assign a registrar pool to users not currently assigned to a pool. When you disconnect a user by using the Disconnect-CsUser cmdlet, that user retains a valid account enabled for Communications Server. However, because Disconnect-CsUser erases the value of the RegistrarPool attribute, the user will no longer be able to log on to Communications Server. With Move-CsUser you can restore the user's account by moving the account to a valid registrar pool. This can be either the same pool as the account was originally homed on, or a different pool. The syntax used with Move-CsUser is identical regardless of whether you are actually moving a user (that is, transferring a user from one pool to another) or simply assigning an unassigned user to a pool.
Return Types
Move-CsUser does not return a value or object. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Move-CsUser -Identity "Pilar Ackerman" -Target "atl-mcs-001.litwareinc.com" |
|
In the preceding example, Move-CsUser is used to move a single account (in this case, the user account with the Identity Pilar Ackerman) to the registrar pool atl-mcs-001.litwareinc.com.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Move-CsUser -Target "atl-mcs-001.litwareinc.com" |
|
In Example 2 all the user accounts in the Finance OU are moved to the registrar pool atl-mcs-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 data has been retrieved, the information is piped to Move-CsUser, which then moves each account in the collection to the registrar pool atl-mcs-001.litwareinc.com.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsUser -UnassignedUser | Move-CsUser -Target "atl-mcs-001.litwareinc.com" |
|
Example 3 shows how you can use Move-CsUser to assign a registrar pool to all of the user accounts enabled for Communications Server-enabled and not currently homed on a registrar pool. In this command, the Get-CsUser cmdlet is used, along with the UnassignedUser parameter, to return a collection of all the users not currently assigned to a registrar pool. (Typically these are users who have had their accounts disconnected using Disconnect-CsUser.) This collection is then piped to Move-CsUser which, in turn, assigns each user to the registrar pool atl-mcs-001.litwareinc.com
-------------------------- Example 4 --------------------------
| Copy Code |
|
|---|---|
Move-CsUser -Identity "Pilar Ackerman" -Target "atl-mcs-001.litwareinc.com" -Force |
|
In the preceding example, Move-CsUser is used to move a single account (in this case, the user account with the Identity Pilar Ackerman) to the registrar pool atl-mcs-001.litwareinc.com. In addition, the Force parameter is used to ensure that only the account itself is moved; data associated with that account (such as information about policies assigned to Pilar) will not be moved but will, instead, be discarded. This parameter is useful in situations where a user account is moved to a new registrar pool that does not use the same policies that are used in the user's previous pool.