Remove-CsTestUserCredential
Removes the specified user from the set of users configured as watcher node test users. Watcher nodes are computers that periodically use Microsoft System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. This cmdlet was introduced in Lync Server 2013.
Syntax
Remove-CsTestUserCredential
[-SipAddress] <String>
[-Confirm]
[-Force]
[-WhatIf]
[<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.
Skype for Business Server Control Panel: The functions carried out by the Remove-CsTestUserCredential cmdlet are not available in the Skype for Business Server Control Panel.
Examples
-------------------------- Example 1 --------------------------
Remove-CsTestUserCredential "sip:kenmyer@litwareinc.com"The command shown in Example 1 removes the user with the SIP address sip:kenmyer@litwareinc.com from the collection of users configured as watcher node test users.
-------------------------- Example 2 --------------------------
$ErrorActionPreference = "SilentlyContinue"
Get-CsUser | ForEach-Object {Remove-CsTestUserCredential -SipAddress $_.SipAddress}
$ErrorActionPreference = "Continue"The commands shown in Example 2 remove all the users who have configured as watcher node test users.
(Note that this does not delete the user accounts; it merely deletes their status as watcher node test users.) To do this, the first command in the example sets the value of the Windows PowerShell $ErrorActionPreference variable to "SilentlyContinue"; this suppresses the display of an error message that would otherwise appear any time the Remove-CsTestUserCredential cmdlet tried to remove test credentials from user who has not been configured as a watcher node test user.
With 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 Remove-CsTestUserCredential cmdlet against each account in order to remove that user as a watcher node test user.
The final command in the example resets the value of $ErrorActionPreference to "Continue".
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| 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 occur 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 |
-SipAddress
SIP address of the account whose test user credentials are being removed. For example:
-SipAddress "sip:kenmyer@litwareinc.com"
| 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 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| 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 Remove-CsTestUserCredential cmdlet does not accept pipelined input.
Outputs
None.
Instead, the Remove-CsTestUserCredential cmdlet deletes existing instances of the System.Management.Automation.PSCredential object.