Set-CsWatcherNodeConfiguration

Set-CsWatcherNodeConfiguration
    [[-Identity] <XdsGlobalRelativeIdentity>]
    [-Confirm]
    [-Enabled <Boolean>]
    [-ExtendedTests <PSListModifier>]
    [-Force]
    [-PortNumber <UInt16>]
    [-Tests <PSListModifier>]
    [-TestUsers <PSListModifier>]
    [-UseInternalWebUrls <Boolean>]
    [-WhatIf]
    [-XmppTestReceiverMailAddress <String>]
    [-UseAutoDiscovery <Boolean>]
    [<CommonParameters>]

Set-CsWatcherNodeConfiguration
    [-Confirm]
    [-Enabled <Boolean>]
    [-ExtendedTests <PSListModifier>]
    [-Force]
    [-Instance <PSObject>]
    [-PortNumber <UInt16>]
    [-Tests <PSListModifier>]
    [-TestUsers <PSListModifier>]
    [-UseInternalWebUrls <Boolean>]
    [-WhatIf]
    [-XmppTestReceiverMailAddress <String>]
    [-UseAutoDiscovery <Boolean>]
    [<CommonParameters>]

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.

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

$x = New-CsExtendedTest -TestUsers "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com" -Name "Audio Conferencing Test" -TestType "AudioConferencingProvider"

Set-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" -ExtendedTests @{Add=$x}

The commands shown in Example 1 add a new audio conferencing provider test to the watcher node configuration settings applied to the pool atl-cs-001.litwareinc.com. To do this, the first command in the example uses the New-CsExtendedTest cmdlet to create the new test; this in-memory-only test is stored in a variable $x. In the second command, the Set-CsWatcherNodeConfiguration cmdlet adds the new test to the watcher node configuration settings; this is done by using the ExtendedTests parameter and the syntax @{Add=$x}.

$x = Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com"

$x.ExtendedTests.RemoveAt(0)

Set-CsWatcherNodeConfiguration -Instance $x

The commands in Example 2 show how you can remove an extended test from a collection of watcher node configuration settings. To carry out this task, the first command in the example uses the Get-CsWatcherNodeConfiguration cmdlet to return an object reference to the watcher node settings for the pool atl-cs-001.litwareinc.com; this object reference is stored in a variable named $x.

In the second command, the RemoveAt() method is used to remove the first extended test in the object reference $x. Extended tests are stored as items in an array, with the first item being given the index number 0, the second item being given the index number 1, and so on. The syntax RemoveAt(0) removes the item with the index number 0: the first item in the set of extended tests. To remove the second extended test, use the syntax RemoveAt(1).

After the object reference has been updated, the final command uses the Set-CsWatcherNodeConfiguration cmdlet and the Instance parameter to write the changes made to the object reference back to the actual watcher node settings for the pool atl-cs-001.litwareinc.com.

Set-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" -ExtendedTests $Null

In Example 3, all the extended tests configured for the atl-cs-001.litwareinc.com watcher node are removed. This task is performed by including the ExtendedTests parameter and the parameter value $Null.

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.

The Set-CsWatcherNodeConfiguration cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object.

Instead, the Set-CsWatcherNodeConfiguration cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object.