See Also
Topic Last Modified: 2013-02-21
Moves one or more Exchange Unified Messaging (UM) contacts to a new Registrar pool. This cmdlet was introduced in Lync Server 2010.
Syntax
Move-CsExUmContact -Identity <UserIdParameter>
-Target <Fqdn> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-Force <SwitchParameter>]
[-IgnoreBackendStoreException <SwitchParameter>] [-PassThru
<SwitchParameter>] [-ProxyPool <Fqdn>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
Example 1 moves the Exchange UM contact object with the SIP address exum1@fabrikam.com to the Registrar pool with the FQDN atl-cs-001.litwareinc.com. Note that a confirmation prompt will be displayed when you run this command, even though we didn’t include the Confirm parameter. This prompt will appear even if you include the Force parameter.
 Copy Code |
|
|---|---|
Move-CsExUmContact -Identity "sip:exum1@fabrikam.com" -Target atl-cs-001.litwareinc.com |
|
EXAMPLE 2
This example moves all Exchange UM contact objects that are Auto Attendants to the Registrar pool with the FQDN atl-cs-001.litwareinc.com. The example begins with a call to the Get-CsExUmContact cmdlet, which retrieves all Exchange UM contacts that have been defined. This collection of contacts is then piped to the Where-Object cmdlet, which finds all the contacts in the collection that have an AutoAttendant property value of True ($True), meaning the contact is an Auto Attendant.
Finally, the collection of contacts where AutoAttendant is True is piped to the Move-CsExUmContact cmdlet, which moves those contacts to the Registrar pool specified in the Target parameter.
As in Example 1, you will be prompted for confirmation when running this command.
| Copy Code |
|
|---|---|
Get-CsExUmContact | Where-Object {$_.AutoAttendant -eq $True} | Move-CsExUmContact -Target atl-cs-001.litwareinc.com
|
|
Detailed Description
Lync Server works with Exchange UM to provide several voice-related capabilities, including Auto Attendant and Subscriber Access. The Move-CsExUmContact cmdlet provides a way for you to move an existing Exchange UM contact object to a new Registrar pool.
When an Exchange UM contact object is moved, the AutoAttendant and IsSubscriberAccess properties will be set appropriately based on the value of the OtherIpPhone property of the object.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Move-CsExUmContact 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-CsExUmContact"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Rtc.Management.AD.UserIdParameter |
The unique identifier of the contact object you want to move. Contact identities can be specified by using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). |
|
Target |
Required |
Microsoft.Rtc.Management.Deploy.Fqdn |
The fully qualified domain name (FQDN) of the Registrar pool to which the contact is being moved. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
DomainController |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
Enables you to connect to the specified domain controller. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its FQDN (for example, atl-mcs-001.litwareinc.com). |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
IgnoreBackendStoreException |
Optional |
System.Management.Automation.SwitchParameter |
When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the contact despite those errors. |
|
PassThru |
Optional |
System.Management.Automation.SwitchParameter |
Enables you to pass a contact object through the pipeline that represents the contact account being moved. By default, the Move-CsExUmContact cmdlet does not pass objects through the pipeline. |
|
ProxyPool |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
This parameter is used only for hosted instances of Lync Server. It should not be used with an on-premises implementation of Lync Server. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
String. Accepts a pipelined string value representing the Identity of an Exchange UM object to be moved.
Return Types
When called with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact.
