Returns information about the health monitoring configuration settings currently in use in your organization. These settings enable administrators to run quality assurance tests without having to supply the user names and passwords for the required test accounts.
Syntax
Get-CsHealthMonitoringConfiguration [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsHealthMonitoringConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Fully qualified domain name of the pool where the health monitoring configuration settings have been assigned. For example: -Identity atl-cs-001.litwareinc.com. If this parameter is not included then Get-CsHealthMonitoringConfiguration will return information about all the health monitoring registrars currently in use. |
|
Filter |
Optional |
String |
Enables you to use wildcard characters when specifying the health monitoring configuration settings to be retrieved. For example, this syntax returns all the settings configured for the litwareinc.com domain: -Filter *.litwareinc.com. |
|
LocalStore |
Optional |
Switch Parameter |
Detailed Description
Synthetic transactions are used in Microsoft Communications Server to verify that users are able to successfully complete common tasks such as logging on to the system, exchanging instant messages, or making calls to a phone located on the Public Switched Telephone Network (PSTN). These tests can be conducted "manually" by an administrator, or they can be automatically run by an application such as Microsoft System Center Operations Manager.
Synthetic transactions can be conducted in two different ways. Many administrators will use the CsHealthMonitoringConfiguration cmdlets to set up a "health monitoring registrar" for each of their registrar pools. A health monitoring registrar is nothing more than a pair of users that have been preconfigured for use with synthetic transactions. (Typically these are test accounts and not accounts belonging to actual users.) When a health monitoring registrar is configured for a pool, administrators can run a synthetic transaction against that pool without having to specify the identities of (and supply the credentials for) the user accounts involved in the test. Instead, the synthetic transaction will automatically use the preconfigured test accounts when performing its checks.
Alternatively, administrators can run a synthetic transaction using actual user accounts. For example, if two users are unable to exchange instant messages, an administrator can run a synthetic transaction using the two user accounts in question (as opposed to a pair of test accounts). If you decide to conduct a synthetic transaction using actual user accounts keep in mind that you will have to supply the logon names and passwords for each user.
The Get-CsHealthMonitoringConfiguration cmdlet provides a way for you to retrieve information about the health monitoring registrars currently in use in your organization.
Return Types
Get-CsHealthMonitoringConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsHealthMonitoringConfiguration |
|
The preceding command returns all the health monitoring configuration settings currently in use in your organization.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com |
|
The command shown in Example 2 returns a single collection of health monitoring configuration settings: the settings that have the Identity atl-cs-001.litwareinc.com.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com |
|
Example 3 returns all the health monitoring configuration settings that have been created for the domain litwareinc.com. To do this, Get-CsHealthMonitoringConfiguration is called along with the –Filter parameter; the filter value "*.litwareinc.com" ensures that only those settings that have an Identity that ends with the string value ".litwareinc.com" will be returned.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:kenmyer@litwareinc.com" -or $_.SecondTestUserSipUri -eq " sip:kenmyer@litwareinc.com"}
|
|
The command shown in Example 4 returns all the health monitoring configuration settings that include the user with the SIP address sip:kenmyer@litwareinc.com as one of the test users. To carry out this task, the command first calls Get-CsHealthMonitoringConfiguration without any additional parameters; this returns a collection of all the health monitoring configuration settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the FirstTestUserSipUri property is equal to (-eq) to "sip:kenmyer@litwareinc.com" or (-or) where SecondTestUserSipUri property is equal to "sip:kenmyer@litwareinc.com". The net effect? Any collection of settings where Ken Myer’s SIP address is used for either the first or the second test user will be returned.