Test-CsWebApp
Verifies that authenticated users can use Skype for Business Web App to join a Skype for Business Server conference. This cmdlet was introduced in Lync Server 2010.
Syntax
ServerPlatform
Test-CsWebApp
[-TargetFqdn] <String>
[-External]
[-Force]
[-OutVerboseVariable <String>]
[-RegistrarPort <Int32>]
[-UserSipAddress <String>]
[-Authentication <AuthenticationMechanism>]
[-OutLoggerVariable <String>]
[<CommonParameters>]
ClientPlatform
Test-CsWebApp
[[-TargetFqdn] <String>]
-User2Credential <PSCredential>
-User2SipAddress <String>
-UserCredential <PSCredential>
-UserSipAddress <String>
[-External]
[-Force]
[-OutVerboseVariable <String>]
[-RegistrarPort <Int32>]
[-Authentication <AuthenticationMechanism>]
[-OutLoggerVariable <String>]
[<CommonParameters>]
TargetUri
Test-CsWebApp
-TargetUri <String>
-UserSipAddress <String>
[-Force]
[-OutVerboseVariable <String>]
[-WebCredential <PSCredential>]
[-Authentication <AuthenticationMechanism>]
[-OutLoggerVariable <String>]
[<CommonParameters>]
Description
The Test-CsWebApp cmdlet enables administrators to verify that authenticated users can employ Skype for Business Web App in order to join conferences.
When you run the Test-CsWebApp cmdlet, the cmdlet attempts to obtain web tickets for a pair of test users by using the Web Ticket service.
If the tickets can be obtained, and the test users authenticated, the Test-CsWebApp cmdlet will then try to connect to Skype for Business Server by using Skype for Business Web App.
If the connection is made, the cmdlet will then attempt to establish separate conferences for instant messaging, application sharing, and data collaboration.
Many administrators will use the CsHealthMonitoringConfiguration cmdlets to set up test users for each of their Registrar pools.
These test users represent a pair of user accounts that have been preconfigured for use with synthetic transactions.
(Typically these are test accounts and not accounts that belong to actual users.) If test users are configured for a pool, administrators can run the Test-CsWebApp cmdlet against that pool without having to specify the identity of (and supply the credentials for) the user account involved in the test.
Alternatively, administrators can run the Test-CsWebApp cmdlet using actual user accounts.
If you decide to conduct the test using actual user accounts you will need to supply the logon name and password for each account.
Examples
Example 1
Test-CsWebApp -TargetFqdn atl-cs-001.litwareinc.com
Example 1 verifies whether or not a pair of test users configured for the pool atl-cs-001.litwareinc.com can use Skype for Business Web App to join a conference.
This command will only succeed if you have configured test users for the pool by using the CsHealthMonitoringConfiguration cmdlets.
Example 2
$cred1 = Get-Credential "litwareinc\kenmyer"
$cred2 = Get-Credential "litwareinc\pilar"
Test-CsWebApp -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress "sip:kenmyer@litwareinc.com" -UserCredential $cred1 -User2SipAddress "sip:pilar@litwareinc.com" -User2Credential $cred2
The commands shown in Example 2 verify whether or not the users Ken Myer and Pilar Ackerman can use Skype for Business Web App to join a conference.
To use actual user accounts, the first two commands in the example use the Get-Credential cmdlet to create a Windows PowerShell command-line interface credentials objects for the two users (litwareinc\kenmyer and litwareinc\pilar).
Those credentials objects (stored in the variables $cred1 and $cred2) are then used as parameter values for the UserCredential and User2Credential parameters in the final command in the example.
In addition to the user credential parameters, the UserSipAddress and User2SipAddress parameters are included, along with the SIP addresses of the two user accounts being employed in the test.
Parameters
-Authentication
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Type of authentication used when running the test. Allowed values are:
TrustedServer
Negotiate
ClientCertificate
LiveID
Parameter properties
| Type: | AuthenticationMechanism |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Ath |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-External
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
When present, causes the Test-CsWebApp cmdlet to test the Reach server's external web relay.
If this parameter is not present, the cmdlet will test the internal web relay.
The web relay serves as an intermediary between the internal network and the Internet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ServerPlatform
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ClientPlatform
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutLoggerVariable
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | olv |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutVerboseVariable
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ovv |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RegistrarPort
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | rp |
Parameter sets
ServerPlatform
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ClientPlatform
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetFqdn
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Fully qualified domain name (FQDN) of the pool to be tested. For example:
-TargetFqdn atl-cs-001.litwareinc.com
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | t |
Parameter sets
ServerPlatform
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ClientPlatform
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetUri
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Uniform Resource Identifier (URI) of the Reach server. For example:
-TargetUri "https://atl-cs-001.litwareinc.com/reach"
You cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | twsu |
Parameter sets
TargetUri
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-User2Credential
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
User credential object for the second of the two user accounts to be tested.
The value passed to User2Credential 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 $y:
$y = Get-Credential "litwareinc\kenmyer"
You need to supply the user password when running this command.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | sc |
Parameter sets
ClientPlatform
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-User2SipAddress
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
SIP address for the second of the two user accounts to be tested. For example:
-User2SipAddress "sip:pilar@litwareinc.com"
This parameter is not required if you are running the test by using test users configured via the CsHealthMonitoringConfiguration cmdlets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | sa |
Parameter sets
ClientPlatform
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserCredential
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | uc |
Parameter sets
ClientPlatform
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserSipAddress
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
SIP address for the first of the two user accounts to be tested. For example:
-UserSipAddress "sip:kenmyer@litwareinc.com"
This parameter is not required if you are running the test by using test users configured via the CsHealthMonitoringConfiguration cmdlets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ua |
Parameter sets
ServerPlatform
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ClientPlatform
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
TargetUri
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WebCredential
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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 either the TargetUri parameter or the UserSipAddress/User2SipAddress parameters are specified and the computer on which the command is run does not have a server certificate.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TargetUri
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Microsoft.Rtc.SyntheticTransactions.TaskOutput
The Test-CsWebApp cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.