Edit

Share via

Test-CsWatcherNodeConfiguration

Module:
Skype for Business Server PowerShell

Verifies the watcher node configuration settings in use in your organization. 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

Default (Default) 

Test-CsWatcherNodeConfiguration
    [-FileName <String>]
    [-ReadCredentialsFromCurrentUserStore]
    [<CommonParameters>]

Description

If you are using Microsoft System Center Operations Manager to monitor Skype for Business Server then you have the option of setting up "watcher nodes": computers that periodically, and automatically, run synthetic transactions in order to verify that Skype for Business Server is working as expected. Watcher nodes are assigned to pools, and are managed using the CsWatcherNodeConfiguration cmdlets. Note that you do not need to install watcher nodes if you are using System Center Operations Manager. You can still monitor your system without using watcher nodes; the only difference is that any synthetic transactions you want to run will need to be invoked manually rather than automatically invoked by Operations Manager.

The Test-CsWatcherNodeConfiguration cmdlet provides a way for you to verify that a watcher node has been correctly configured and is assigned to a valid Skype for Business Server pool. Note that the Test-CsWatcherNodeConfiguration cmdlet must be run on the watcher node itself; the cmdlet cannot be run against remote computers.

Skype for Business Server Control Panel: The functions carried out by the Test-CsWatcherNodeConfiguration cmdlet are not available in the Skype for Business Server Control Panel.

Examples

Example 1

Test-CsWatcherNodeConfiguration

The command shown in Example 1 verifies the configuration settings for each watcher node in use in the organization.

Parameters

-FileName

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Enables you to specify a file path for the log file created when the cmdlet runs. For example:

-Report "C:\Logs\WatcherNode.html"

Parameter properties

Type:String
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

-ReadCredentialsFromCurrentUserStore

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When present, instructs the Test-CsWatcherNodeConfiguration cmdlet to retrieve the user credentials from the user's credentials store. By default, the Test-CsWatcherNodeConfiguration cmdlet looks for credentials in the network service account's credentials store.

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

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

The Test-CsWatcherNodeConfiguration cmdlet does not accept pipelined input.

Outputs

Microsoft.Rtc.SyntheticTransactions.TaskOutput

The Test-CsWatcherNodeConfiguration cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.