Test-CsWebScheduler
Verifies whether or not a user can employ the Skype for Business Web scheduler to schedule an online meeting. This cmdlet was introduced in Lync Server 2013.
Syntax
Test-CsWebScheduler
[-TargetFqdn] <String>
[-Authentication <AuthenticationMechanism>]
[-External]
[-Force]
[-OutLoggerVariable <String>]
[-OutVerboseVariable <String>]
[-RegistrarPort <Int32>]
[-UserSipAddress <String>]
[<CommonParameters>] Test-CsWebScheduler
[[-TargetFqdn] <String>]
-UserCredential <PSCredential>
[-Authentication <AuthenticationMechanism>]
[-External]
[-Force]
[-OutLoggerVariable <String>]
[-OutVerboseVariable <String>]
[-RegistrarPort <Int32>]
-UserSipAddress <String>
[<CommonParameters>] Test-CsWebScheduler
-TargetUri <String>
[-Authentication <AuthenticationMechanism>]
[-Force]
[-OutLoggerVariable <String>]
[-OutVerboseVariable <String>]
-UserSipAddress <String>
[-WebCredential <PSCredential>]
[<CommonParameters>] 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.
Skype for Business Server Control Panel: The functions carried out by the Test-CsWebScheduler cmdlet are not available in the Skype for Business Server Control Panel.
Examples
-------------------------- Example 1 --------------------------
Test-CsWebScheduler -TargetFqdn "atl-cs-001.litwareinc.com"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.
-------------------------- Example 2 --------------------------
$credential = Get-Credential "litwareinc\kenmyer"
Test-CsWebScheduler -TargetFqdn "atl-cs-001.litwareinc.com" -UserSipAddress "sip:[email protected]" -UserCredential $credentialThe 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).
Parameters
-Authentication
Allowed values are:
- TrustedServer
- Negotiate
- ClientCertificate
- LiveID
| Type: | AuthenticationMechanism |
| Aliases: | Ath |
| 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 |
-External
Enables you to verify that external users can use the web scheduler/
| 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 |
-Force
Suppresses the display of any non-fatal error message that might arise 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 |
-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 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, Skype for Business Server 2019 |
-TargetUri
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.
| Type: | String |
| Aliases: | twsu |
| 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 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.
| Type: | PSCredential |
| Aliases: | uc |
| 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 user account to be tested; for example:
-UserSipAddress "sip:[email protected]"
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.
| Type: | String |
| Aliases: | ua |
| 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 |
-WebCredential
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.
| Type: | PSCredential |
| 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 |
Inputs
None.
The Test-CsWebScheduler cmdlet does not accept pipelined input.
Outputs
The Test-CsWebScheduler cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object.