Topic Last Modified: 2014-02-19

Verifies whether or not a pair of users can participate in a Lync Server 2013 web conference that includes activities such as sharing or viewing PowerPoint slides, whiteboards, or polls. The cmdlet also verifies that the Lync Server web conferencing service can discover Office Web Apps Server and that a client can upload a PowerPoint file for broadcast by Office Web Apps Server.

This cmdlet was introduced in Lync Server 2013.

Syntax

Test-CsDataConference -TargetFqdn <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-ReceiverSipAddress <String>] [-RegistrarPort <Int32>] [-SenderSipAddress <String>] <COMMON PARAMETERS>
Test-CsDataConference -ReceiverCredential <PSCredential> -ReceiverSipAddress <String> -SenderCredential <PSCredential> -SenderSipAddress <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-RegistrarPort <Int32>] [-TargetFqdn <String>] <COMMON PARAMETERS>
Test-CsDataConference [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Force <SwitchParameter>] [-IPVersion <String>] [-OutLoggerVariable <String>] [-OutVerboseVariable <String>] [-TestJoinLauncher <SwitchParameter>]

Examples

Example 1

The command shown in Example 1 verifies that a data conference can be conducted on the pool atl-cs-001.litwareinc.com. This command assumes that you have configured a pair of test users for the specified pool. If no such test users exist, the command will fail.

Copy Code 
Test-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com"

Example 2

The commands shown in Example 2 test the ability of a pair of users (litwareinc\pilar and litwareinc\kenmyer) to log on to Lync Server 2013 and then conduct an data conference. To do this, the first command in the example uses the Get-Credential cmdlet to create a Windows PowerShell command-line interface credential object containing the name and password of the user Pilar Ackerman. (Because the logon name, litwareinc\pilar, has been included as a parameter, the Windows PowerShell Credential Request dialog box only requires the administrator to enter the password for the Pilar Ackerman account.) The resulting credential object is then stored in a variable named $cred1. The second command does the same thing, this time returning a credential object for the Ken Myer account.

With the credential objects in hand, the third command determines whether or not these two users can log on to Lync Server 2013 and conduct a data conference. To carry out this task, the Test-CsDataConference cmdlet is called, along with the following parameters: TargetFqdn (the FQDN of the Registrar pool); SenderSipAddress (the SIP address for the first test user); SenderCredential (the Windows PowerShell object containing the credentials for this same user); ReceiverSipAddress (the SIP address for the other test user); and ReceiverCredential (the Windows PowerShell object containing the credentials for the other test user).

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

Test-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" -SenderSipAddress "sip:pilar@litwareinc.com" -SenderCredential $credential1 -ReceiverSipAddress "sip:kenmyer@litwareinc.com" -ReceiverCredential $credential2

Detailed Description

In Lync Server 2013, a data conference is any conference where collaborative activities such as whiteboarding or annotations are used. The Test-CsDataConference cmdlet enables you to verify that a pair of users are able to take part in a data conference.

The ability to conduct a data conference depends on the conferencing policy that has been assigned to the user who organized the conference (in the case of the Test-CsDataConference cmdlet, that is the "sender"). If the organizer is not allowed to include collaborative activities in his or her meeting (for example, if his or her conferencing policy has the EnableDataCollaboration property set to False) then the Test-CsDataConference cmdlet will fail.

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 "Test-CsDataConference"}

Lync Server Control Panel: The functions carried out by the Test-CsDataConference cmdlet are not available in the Lync Server Control Panel.

Parameters

Parameter Required Type Description

ReceiverCredential

Required

System.Management.Automation.PSCredential

User credential 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.

The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool.

SenderCredential

Required

System.Management.Automation.PSCredential

User credential 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.

The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool.

TargetFqdn

Required

System.String

Fully qualified domain name (FQDN) of the Persistent Chat pool to be tested.

Authentication

Optional

Microsoft.Rtc.Management.SyntheticTransactions.SipSyntheticTransaction+AuthenticationMechanism

Type of authentication used when running the test. Allowed values are:

* TrustedServer

* Negotiate

* ClientCertificate

* LiveID

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might arise when running the command.

IPVersion

Optional

System.String

PARAMVALUE: String

OutLoggerVariable

Optional

System.String

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 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

OutVerboseVariable

Optional

System.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 prepend a $ character when specifying the variable name.

ReceiverSipAddress

Optional

System.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 ReceiverCredential.

The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool.

RegistrarPort

Optional

System.Int32

SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.

SenderSipAddress

Optional

System.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 SenderCredential.

The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool.

TestJoinLauncher

Optional

System.Management.Automation.SwitchParameter

When present, tests the ability of the Join Launcher to participate in a conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences.

Input Types

None. The Test-CsDataConference cmdlet does not accept pipelined input.

Return Types

The Test-CsDataConference cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.

See Also