Test-CsMcxP2PIM

 

Topic Last Modified: 2013-05-28

Tests the ability of a pair of users to exchange instant messages by using the Microsoft Lync Server 2010 Mobility Service. The Mobility Service enables users of mobile phones such as iPhones and Windows Phones to do such things as exchange instant messages and presence information; store and retrieve voice mail internally instead of with their wireless provider; and take advantage of Microsoft Lync Server 2010 capabilities such as Call via Work and dial-out conferencing.

Syntax

Test-CsMcxP2PIM -TargetFqdn <String> -ReceiverCredential <PSCredential> -ReceiverSipAddress <String> -SenderCredential <PSCredential> -SenderSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>]

Detailed Description

Microsoft Lync Server 2010 Mobility Service extends many of the capabilities of Microsoft Lync 2010 to mobile devices such as Apple iPhones, Windows Phone, Android phones, and Nokia phones. Among other things, users can use these phones to exchange instant message and presence information, and to receive notifications of new voice mails. Thanks to the push notification service (Apple Push Notification Service and Microsoft Lync Server 2010 Push Notification Service), users with iPhones or Windows Phones can receive these notifications even if Lync 2010 is running in the background. The Mobility Service also provides the opportunity for organizations to enable Call via Work. With Call via Work, users can make a call from their mobile phone and make it appear as though the call originated from their work phone; for example, Caller ID systems will display the user's work number instead of his or her mobile phone number.

The Test-CsMcxP2PIM cmdlet is used to determine whether or not a pair of users is able to exchange instant messages by using the Mobility Service. Note that running this cmdlet does not require the use of mobile phones nor does it actually send any instant messages. Instead, the cmdlet verifies that the two users are able to log on to Lync Server 2010 and that the Mobility Service is able to make the connections required to exchange instant messages between the two users.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Test-CsMcxP2PIM cmdlet locally: RTCUniversalServerAdmins.

Parameters

Parameter	Required	Type	Description
TargetFqdn	Required	String	Fully qualified domain name (FQDN) of the pool to be tested.
ReceiverCredential	Required	PSCredential	User credentials object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: $y = Get-Credential "litwareinc\pilar" You need to supply the user password when running this command.
ReceiverSipAddress	Required	String	SIP address for the first of the two user accounts to be tested. For example: -ReceiverSipAddress "sip:pilar@litwareinc.com" The ReceiverSIPAddress parameter must reference the same user account as the ReceiverCredential parameter.
SenderCredential	Required	PSCredential	User credentials object for the second of the two user accounts to be tested. The value passed to SenderCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: $x = Get-Credential "litwareinc\kenmyer" You need to supply the user password when running this command.
SenderSipAddress	Required	String	SIP address for the second of the two user accounts to be tested. For example: -SenderSipAddress "sip:kenmyer@litwareinc.com" The SenderSipAddress parameter must reference the same user account as the SenderCredential parameter.
OutVerboseVariable	Optional	String	When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: -OutVerboseVariable TestOutput Do not use prepend a $ character when specifying the variable name.
RegistrarPort	Optional	Integer	SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.
Verbose	Optional	SwitchParameter	Reports detailed activity to the screen as the cmdlet runs.

Input Types

None. Test-CsMcxP2PIM does not accept pipelined input.

Return Types

Test-CsMcxP2PIM returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.

Example

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

$credential1 = Get-Credential "litwareinc\kenmyer"
$credential2 = Get-Credential "litwareinc\pilar"

Test-CsMcxP2PIM -TargetFqdn "atl-cs-001.litwareinc.com" -Authentication Negotiate -SenderSipAddres "sip:kenmyer@litwareinc.com" -SenderCredential $credential1 -ReceiverSipAddress "sip:packerman@litwareinc.com" -ReceiverCredential $credential2

The commands shown in Example 1 test to see whether or not a pair of users – Ken Myer and Pilar Ackerman – is able to exchange instant messages by using the Mobility Service. To do this, the first two commands in the example use the Get-Credential cmdlet to create credentials objects for the two users; the credentials for Ken Myer are stored in a variable named $credential1 and the credentials for Pilar Ackerman are stored in a variable named $credential2.

After the credential objects have been created, the final command calls the Test-CsMcxP2PIM cmdlet, making sure to specify the target Registrar pool (atl-cs-001.litwareinc,com), the authentication type (Negotiate), and the SIP addresses and credentials of the two users.