Get-CsTestUserCredential
Returns information that tells you whether or not a user has been configured as a watcher node test user. Watcher nodes are computers that periodically use Microsoft System Center Operations Manager and Skype for Business Server 2015 synthetic transactions to verify that Skype for Business Server components are working as expected. This cmdlet was introduced in Lync Server 2013.
Syntax
Get-CsTestUserCredential
[-SipAddress] <String>
[<CommonParameters>] Description
If you are using System Center Operations Manager in conjunction with Skype for Business Server, you have the option of configuring "watcher node" computers. Watcher nodes are computers that periodically (and automatically) run synthetic transactions. Synthetic transactions are cmdlets that test various features of Skype for Business Server; for example, there are synthetic transactions that verify that users can register with Skype for Business Server; that users can exchange instant messages and presence information using Skype for Business Server; that users can conduct data collaboration and application sharing conferences; and that users can make phone calls across the public switched telephone network. As noted, these synthetic transactions run periodically and, if they fail, issue alerts notifying administrators that the system might be experiencing difficulties.
Many synthetic transactions require test users; for example, you cannot test the ability of two users to exchange instant messages unless you have a pair of user accounts and you attempt to exchange instant messages using those accounts. When you configure a watcher node you must assign at least two test users to that node. These test users can be any valid Active Directory user accounts that have been enabled for Skype for Business Server and have been registered as test accounts. Accounts are registered as test accounts by using the Set-CsTestUserCredential cmdlet. If you later decide not to use an account as a test account you can unregister the by using the Remove-CsTestUserCredential cmdlet. This cmdlet simply prevents the account from being used as a watcher node test account; it does not delete, disable, or otherwise modify the account.
The functions carried out by the Get-CsTestUserCredential cmdlet are not available in the Skype for Business Server Control Panel.
Examples
-------------------------- Example 1 --------------------------
Get-CsTestUserCredential -SipAddress "sip:kenmyer@litewareinc.com"The command shown in Example 1 returns information for the user sip:kenmyer@litwareinc.com provided that the user has been configured as a watcher node test user. If the user has not been configured as a test user then the Get-CsTestUserCredential cmdlet will return an error.
-------------------------- Example 2 --------------------------
$ErrorActionPreference = "SilentlyContinue"
Get-CsUser | ForEach-Object {Get-CsTestUserCredential -SipAddress $_.SipAddress}
$ErrorActionPreference = "Continue"The commands shown in Example 2 return a list of all the users who have been configured as watcher node test users. To do this, the first command in the example sets the value of the Windows PowerShell command-line interface $ErrorActionPreference variable to "SilentlyContinue"; this suppresses the display of any error messages that would otherwise appear if the Get-CsTestUserCredential cmdlet tries to return test user information for a user who has not been configured as a watcher node test user.
With the error messages suppressed, the second command in the example uses the Get-CsUser cmdlet to return a collection of all the users who have been enabled for Skype for Business Server. This collection is then piped to the ForEach-Object cmdlet. The ForEach-Object cmdlet loops through each user account in the collection, running the Get-CsTestUserCredential cmdlet against each account to see if the user has been configured as a test user. If the user has been configured as a test user then information about that user will be displayed on screen. If the user has not been configured as a test user then nothing will be displayed on screen.
The final command in the example resets the value of $ErrorActionPreference to "Continue".
Parameters
-SipAddress
SIP address of the account being checked for test user credentials. For example:
-SipAddress "sip:kenmyer@litwareinc.com"
You must include the SipAddress parameter when calling the Get-CsTestUserCredential cmdlet. If you do not, you will be prompted to enter that address.
| Type: | String |
| 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 |
Inputs
None
Outputs
System.Management.Automation.PSCredential