Test-CsMcxConference
Tests the ability of three users to participate in a Skype for Business Server Mobility Service conference. 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 Skype for Business Server capabilities such as Call via Work and dial-out conferencing. This cmdlet was introduced in the cumulative update for Lync Server 2010: November 2011.
Syntax
Test-CsMcxConference
[-TargetFqdn] <String>
-Authentication <AuthenticationMechanism>
-OrganizerCredential <PSCredential>
-OrganizerSipAddress <String>
-User2Credential <PSCredential>
-User2SipAddress <String>
-UserCredential <PSCredential>
-UserSipAddress <String>
[-Force]
[-OutLoggerVariable <String>]
[-OutVerboseVariable <String>]
[-RegistrarPort <Int32>]
[<CommonParameters>] Description
The Mobility Service extends many of the capabilities of Skype for Business Server 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 Push Notification Service, users who have iPhones or Windows Phones can receive these notifications even if Skype for Business 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 see the user's work number instead of his or her mobile phone number.
The Test-CsMcxConference cmdlet is used to determine whether or not a set of three users are able to participate in a conference by using the Mobility Service.
Note that running this cmdlet does not require the use of mobile phones nor does it actually create a real conference.
Instead, the cmdlet verifies that the three users are able to log on to Skype for Business Server and that the Mobility Service is able to make the connections required to conduct and conference.
The cmdlet also verifies that the conference organizer is able to send an instant message to the other two conference participants.
Examples
-------------------------- Exmple 1 --------------------------
$organizerCred = Get-Credential "litwareinc\kenmyer"
$user1Cred = Get-Credential "litwareinc\packerman"
$user2Cred = Get-Credential "litwareinc\adelaney"
Test-CsMcxConference -TargetFqdn "atl-cs-001.litwareinc.com" -Authentication Negotiate -OrganizerSipAddress "sip:kenmyer@litwareinc.com" -OrganizerCredential $organizerCred -UserSipAddress "sip:pilar@litwareinc.com" -UserCredential $user1Cred -User2SipAddress "sip:adelaney@litwareinc.com" -User2Credential $user2CredThe commands shown in Example 1 verify whether a Mobility Service conference can be conducted using three user accounts: Ken Myer (the meeting organizer), Pilar Ackerman, and Aidan Delaney. In order to run this test, the first thing that must be done is to create credentials objects for each user account. Those objects are created in the first three lines of code, and stored in the variables $organizerCred (Ken Myer), $user1Cred (Pilar Ackerman), and $user2Cred (Aidan Delaney).
After the credentials objects have been created, you can then call the Test-CsMcxConference 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 three user accounts acting as conference participants.
Parameters
-Authentication
Allowed values are: TrustedServer; Negotiate; ClientCertificate; and LiveID.
| Type: | AuthenticationMechanism |
| Aliases: | Ath |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-OrganizerCredential
User credential object for the user account acting as the meeting organizer.
The value passed to OrganizerCredential should be an object reference obtained by using the Get-Credential cmdlet.
For example, this code returns a credentials object for the user litwareinc\adelaney and stores that object in a variable named $z:
$z = Get-Credential "litwareinc\adelaney"
You need to supply the user password when running this command.
| Type: | PSCredential |
| Aliases: | oc |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-OrganizerSipAddress
SIP address for the user account acting as the meeting organizer. For example:
-OrganizerSipAddress "sip:adelaney@litwareinc.com"
The OrganizerSipAddress parameter must reference the same user account as the OrganizerCredential parameter.
| Type: | String |
| Aliases: | oa |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-OutLoggerVariable
When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file.
To store output in a logger variable named $TestOutput use the following syntax:
-OutLoggerVariable TestOutput
Note: Do not use prepend a $ character when specifying the variable name.
To save the information stored in the logger variable to an HTML file, use a command similar to this:
$TestOutput.ToHTML() \> C:\Logs\TestOutput.html
To save the information stored in the logger variable to an XML file, use a command similar to this:
$TestOutput.ToXML() \> C:\Logs\TestOutput.xml
| Type: | String |
| Aliases: | olv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-OutVerboseVariable
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.
| Type: | String |
| Aliases: | ovv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-RegistrarPort
SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.
| Type: | Int32 |
| Aliases: | rp |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-TargetFqdn
Fully qualified domain name (FQDN) of the pool to be tested.
| Type: | String |
| Aliases: | t |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-User2Credential
User credential object for the second of the two user accounts to be tested.
The value passed to Use2rCredential should be an object reference obtained by using theGet-Credential cmdlet.
For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y:
$y = Get-Credential "litwareinc\kenmyer"
You need to supply the user password when running this command.
| Type: | PSCredential |
| Aliases: | spc |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-User2SipAddress
SIP address for the second of the two user accounts to be tested. For example:
-User2SipAddress "sip:pilar@litwareinc.com"
The User2SipAddress parameter must reference the same user account as the User2Credential parameter.
| Type: | String |
| Aliases: | spa |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-UserCredential
User credentials object for the first of the two user accounts to be tested.
The value passed to UserCredential 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 $x:
$x = Get-Credential "litwareinc\pilar"
You need to supply the user password when running this command.
| Type: | PSCredential |
| Aliases: | fpc |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-UserSipAddress
SIP address for the first of the two user accounts to be tested. For example:
-UserSipAddress "sip:kenmyer@litwareinc.com"
The UserSipAddress parameter must reference the same user account as the UserCredential parameter.
| Type: | String |
| Aliases: | fpa |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
None.
The Test-CsMcxConference cmdlet does not accept pipelined input.
Outputs
The Test-CsMcxConference cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.