Topic Last Modified: 2013-03-25

Verifies whether or not a user can employ the Lync Server 2013 Web scheduler to schedule an online meeting. This cmdlet was introduced in Lync Server 2013.

Syntax

Test-CsWebScheduler -UserCredential <PSCredential> -UserSipAddress <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-External <SwitchParameter>] [-RegistrarPort <Int32>] [-TargetFqdn <String>] <COMMON PARAMETERS>
Test-CsWebScheduler -TargetUri <String> -UserSipAddress <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-WebCredential <PSCredential>] <COMMON PARAMETERS>
Test-CsWebScheduler -TargetFqdn <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-External <SwitchParameter>] [-RegistrarPort <Int32>] [-UserSipAddress <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Force <SwitchParameter>] [-OutLoggerVariable <String>] [-OutVerboseVariable <String>]

Examples

Example 1

The preceding example verifies the Web Scheduler for the pool atl-cs-001.litwareinc.com. This command will work only if test users have been defined for the pool atl-cs-001.litwareinc.com. If they have, then the command will determine whether or not the first test user is able to schedule an online meeting using the Web Scheduler.

If test users have not been defined, then the command will fail because it will not know which user to log on as. If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on.

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

Example 2

The commands shown in Example 2 test the ability of a specific user (litwareinc\pilar) to schedule an online meeting using the Web scheduler. 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 then checks to see if this user can log on to the pool atl-cs-001.litwareinc.com and schedule an online meeting. To carry out this task, the Test-CsWebScheduler cmdlet is called, along with three parameters: TargetFqdn (the FQDN of the Registrar pool); UserCredential (the Windows PowerShell object containing Pilar Ackerman’s user credentials); and UserSipAddress (the SIP address corresponding to the supplied user credentials).

Copy Code 
$credential = Get-Credential "litwareinc\kenmyer"

Test-CsWebScheduler -TargetFqdn "atl-cs-001.litwareinc.com" -UserSipAddress "sip:kenmyer@litwareinc.com" -UserCredential $credential

Detailed Description

The Web Scheduler provides a way for users who are not running Microsoft Outlook to schedule online meetings. Among other things, this new feature (which incorporates the functionality found in the Web Scheduler tool that shipped with the Microsoft Lync Server 2010 resource kit) enables users to:

  • Schedule a new online meeting.

  • List all meetings that he or she has scheduled.

  • View/modify an existing meeting.

  • Delete an existing meeting.

  • Send an email invitation to meeting participants by using a preconfigured SMTP mail server.

  • Join an existing conference.

The Test-CsWebScheduler cmdlet enables you to verify whether or not a specific user can schedule a meeting using the Web Scheduler.

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-CsWebScheduler"}

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

Parameters

Parameter Required Type Description

TargetFqdn

Required

String

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

TargetUri

Required

String

Uniform Resource Identifier (URI) of the Web scheduler.Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command.

UserCredential

Required

PSCredential

User credential object for the account to be tested. The value passed to UserCredential must be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named

$x = Get-Credential "litwareinc\kenmyer"

You need to supply the user password when running this command. This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool.

Authentication

Optional

SipSyntheticTransaction AuthenticationMechanism

Allowed values are:

* TrustedServer

* Negotiate

* ClientCertificate

* LiveID

External

Optional

SwitchParameter

Enables you to verify that external users can use the web scheduler/

Force

Optional

SwitchParameter

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

OutLoggerVariable

Optional

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

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

RegistrarPort

Optional

Int32

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

UserSipAddress

Optional

String

SIP address for user account to be tested; for example:

-UserSipAddress "sip:kenmyer@litwareinc.com"

The UserSipAddress parameter must reference the same user account as UserCredential. This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool.

WebCredential

Optional

PSCredential

User credential object for the user account to be used in the test. 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\kenmyer and stores that object in a variable named $x:

$x = Get-Credential "litwareinc\kenmyer"

This parameter is required if the TargetUri parameter or the UserSipAddress parameter are specified and the computer on which the command is run does not have a server certificate.

Input Types

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

Return Types

The Test-CsWebScheduler cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object.

See Also