Move-CsApplicationEndpoint
Topic Last Modified: 2012-03-23
Moves an endpoint to a different Registrar pool.
Syntax
Move-CsApplicationEndpoint -Identity <UserIdParameter> -TargetApplicationPool <Fqdn> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-PassThru <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
This cmdlet moves an existing endpoint contact object in Active Directory Domain Services (AD DS) from a Microsoft Office Communications Server 2007 R2 application pool to a Microsoft Lync Server 2010 application pool, or from one Lync Server 2010 application pool to another. The application associated with the given endpoint must exist on the target pool. To determine which application is associated with the endpoint, run the Get-CsTrustedApplicationEndpoint or Get-CsDialInConferencingAccessNumber cmdlet.
This cmdlet is also used to upgrade the Active Directory contact object properties when an application deployed against Office Communications Server 2007 R2 is retargeted against Lync Server 2010. Note that the source and target application pool will be the same in that case. Also, if an application originally designed to work against Office Communications Server 2007 R2 is directly deployed against Lync Server 2010, then this cmdlet must be used with the Force flag to upgrade the Active Directory contact object properties.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Move-CsApplicationEndpoint 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-CsApplicationEndpoint"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
PrimaryUriParameter |
The SIP address or distinguished name (DN) of the endpoint contact you want to move. |
TargetApplicationPool |
Required |
Fqdn |
The fully qualified domain name (FQDN) of the pool to which the endpoint is moving. The target pool must have a Registrar service dependency. |
DomainController |
Optional |
Fqdn |
Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. |
Force |
Optional |
SwitchParameter |
This flag is required if you are moving a Microsoft Unified Communications Managed API (UCMA) 2.0 contact object to the same pool but on a Lync Server 2010 deployment. This will force routing to occur through the Lync Server 2010 Registrar. |
PassThru |
Optional |
SwitchParameter |
Specifying this parameter will return the application endpoint object after the object has been moved. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
String. Accepts a pipelined string value representing the Identity of an application endpoint.
Return Types
When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.
Example
-------------------------- Example 1 ------------------------
Move-CsApplicationEndpoint -Identity sip:endpoint1@litwareinc.com -TargetApplicationPool TrustPoolA.litwareinc.com
This example moves the application endpoint contact object with the SIP address endpoint1@litwareinc.com to the trusted Registrar pool TrustPoolA.litwareinc.com. Use this command to upgrade a UCMA 2.0 application to a Microsoft Unified Communications Managed API (UCMA) 3.0 application after coexistence.
-------------------------- Example 2 ------------------------
Move-CsApplicationEndpoint -Identity sip:endpoint2@litwareinc.com -TargetApplicationPool TrustPoolA.litwareinc.com -Force
This example moves the application endpoint contact object with the SIP address endpoint2@litwareinc.com to the trusted Registrar pool TrustPoolA.litwareinc.com. This example differs from Example 1 in that this command includes the Force parameter. Use this command for an in-place migration of a UCMA 2.0 application or for direct deployment of a UCMA 2.0 application against a pure Lync Server 2010 deployment. This will update an existing object in Active Directory with the necessary attributes so that routing can occur through the Lync Server 2010 Registrar.