Export (0) Print
Expand All
Expand Minimize

Get-CsWatcherNodeConfiguration

Lync Server 2013
 

Topic Last Modified: 2013-02-22

Returns information about the watcher node configuration settings in use in your organization. Watcher nodes are computers that periodically use Microsoft System Center Operations Manager and Lync Server 2013 synthetic transactions to verify that Lync Server components are working as expected. The watcher node configuration settings let you know which pools have been associated with a watcher node. This cmdlet was introduced in Lync Server 2013.

Get-CsWatcherNodeConfiguration [-Identity <XdsGlobalRelativeIdentity>] <COMMON PARAMETERS>
Get-CsWatcherNodeConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

The command shown in Example 1 returns information about all the watcher nodes currently configured for use in the organization.

Get-CsWatcherNodeConfiguration

In Example 2, information is returned for the watcher node associated with the pool.

Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com"

The command shown in Example 3 returns information about all the watcher nodes where the test users include the user with the SIP address sip:kenmyer@litwareinc.com. To do this, the command first uses the Get-CsWatcherNodeConfiguration cmdlet to return a collection of all the watcher nodes in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those nodes where the TestUsers property contains the SIP address sip:kenmyer@litwareinc.com.

Get-CsWatcherNodeConfiguration | Where-Object {$_.TestUsers -contains "sip:kenmyer@litwareinc.com"}

In Example 4, information is returned for all the watcher nodes that include the PSTN test type. To carry out this task, the command first calls the Get-CsWatcherNodeConfiguration cmdlet in order to return a collection of all the watcher nodes in the organization. That collection is then piped to the Where-Object cmdlet, which selects only those watcher nodes where the ExtendedTests property includes (-matches) the string value "TestType=PSTN".

Get-CsWatcherNodeConfiguration | Where-Object {$_.ExtendedTests -match "TestType=PSTN"}

If you are using Microsoft System Center Operations Manager to monitor Lync Server 2013 then you have the option of setting up "watcher nodes": computers that periodically, and automatically, run synthetic transactions in order to verify that Lync 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 Get-CsWatcherNodeConfiguration cmdlet returns information about all the watcher nodes that have been configured for use in your organization.

To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsWatcherNodeConfiguration"}

Lync Server Control Panel: The functions carried out by the Get-CsWatcherNodeConfiguration cmdlet are not available in the Lync Server Control Panel.

 

Parameter Required Type Description

Filter

Optional

System.String

Enables you to use wildcard characters in order to return one or more watcher nodes. For example, to return all of the watcher nodes for the domain litwareinc.com use this syntax:

-Filter "*.litwareinc.com"

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity

Fully qualified domain name of the pool that the watcher node has been assigned to. For example:

-Identity "atl-cs-001.litwareinc.com"

If this parameter is not specified then the Get-CsWatcherNodeConfiguration cmdlet will return information about all the watcher nodes configured for use in your organization.

LocalStore

Optional

System.Management.Automation.SwitchParameter

Retrieves the watcher node configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

None. The Get-CsWatcherNodeConfiguration cmdlet does not accept pipelined input.

The Get-CsWatcherNodeConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft