Export (0) Print
Expand All
Expand Minimize

New-CsWatcherNodeConfiguration

Lync Server 2013
 

Topic Last Modified: 2014-06-04

Assigns a new collection of watcher node configuration settings to a pool. 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. This cmdlet was introduced in Lync Server 2013.

New-CsWatcherNodeConfiguration -Identity <XdsGlobalRelativeIdentity> <COMMON PARAMETERS>

New-CsWatcherNodeConfiguration -TargetFqdn <String> <COMMON PARAMETERS>

COMMON PARAMETERS: -PortNumber <UInt16> [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-ExtendedTests <PSListModifier>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Tests <PSListModifier>] [-TestUsers <PSListModifier>] [-UseInternalWebUrls <$true | $false>] [-WhatIf [<SwitchParameter>]] [-XmppTestReceiverMailAddress <String>]

The commands shown in Example 1 create a new collection of watcher node configuration settings for the pool atl-cs-001.litwareinc.com. To do this, the first two commands in the example create a pair watcher node test users (sip:kenmyer@litwareinc.com and sip:pilar@litwareinc.com). After the test users have been created, the third command in the example creates a new extended PSTN test using the two newly-created users. This new test (which, at this point in time, exists only in memory) is stored in a variable named $x.

Finally, the fourth command in the example creates the watcher node configuration settings for atl-cs-001.litwareinc.com. These new settings use port 5061; the two new test users; and the extended test stored in the variable $x.

Set-CsTestUserCredential -SipAddress "sip:kenmyer@litwareinc.com" -UserName "litwareinc\kenmyer" -Password "07Apples"

Set-CsTestUserCredential -SipAddress "sip:pilar@litwareinc.com" -UserName "litwareinc\pilar" -Password "07Apples"

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

New-CsWatcherNodeConfiguration -TargetFqdn "atl-cs-001.litwareinc.com" -PortNumber 5061 -TestUsers "sip:kenmyer@litwareinc.com","sip:pilar@litwareinc.com"} -ExtendedTests @{Add=$x}

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.

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 "New-CsWatcherNodeConfiguration"}

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

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity

Fully qualified domain name of the pool being associated with the watcher node configuration settings. You can use either the Identity parameter or the TargetFqdn parameter to specify the pool; however, you cannot use both these parameters in the same command.

PortNumber

Required

System.UInt16

SIP port used by the Registrar service.

TargetFqdn

Required

System.String

Fully qualified domain name of the pool being associated with the watcher node configuration settings. You can use either the TargetFqdn parameter or the Identity parameter to specify the pool; however, you cannot use both these parameters in the same command.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Enabled

Optional

System.Boolean

Enables or disables the watcher node. The default value is True ($True).

ExtendedTests

Optional

System.Management.Automation.PSListModifier

PSTN or Audio Conferencing Provider tests that can be assigned to a watcher node configuration. These tests must be created using the New-CsExtendedTest cmdlet and stored in a variable (for example, $x). The test can then be assigned to a watcher node by using syntax similar to this:

–ExtendedTests @{Add=$x}

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

InMemory

Optional

System.Management.Automation.SwitchParameter

Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.

Tests

Optional

System.Management.Automation.PSListModifier

Synthetic transactions to be run by the watcher node. Allowed values are:

* Registration

* IM

* GroupIM

* P2PAV

* AvConference

* Presence

* ABS

* ABWQ

* MCXP2PIM

* ExumConnectivity

* JoinLauncher

* PersistentChatMessage

* DataConference

* XmppIM

* UnifiedContactStore

* AVEdgeConnectivity

To configure tests at the time you create a new watcher node, use the following syntax, separating the individual tests by using commas:

-Tests "ABS","ABWQ","IM","GroupIM","XmppIM"

TestUsers

Optional

System.Management.Automation.PSListModifier

SIP addresses of the test users to be assigned to the watcher node; these user accounts must have previously been configured by using the Set-CsTestUserCredential cmdlet. To add test users, use syntax similar to this, separating user addresses by using commas:

–TestUsers "sip:kenmyer@litwareinc.com","sip:pilar@litwareinc.com"

UseInternalWebUrls

Optional

System.Boolean

When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. This provides a way to way to verify URL validity for users located behind the organization's firewall.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

XmppTestReceiverMailAddress

Optional

System.String

XMPP email address to be used when testing the XMPP gateway.

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

The New-CsWatcherNodeConfiguration cmdlet creates new 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