Remove-CsHealthMonitoringConfiguration -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

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 Remove-CsHealthMonitoringConfiguration cmdlet provides a way for you to remove any of the health monitoring registrars that have been configured for use in your organization.

Remove-CsHealthMonitoringConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object.

-------------------------- Example 1 ------------------------

	Copy Code
Remove-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com

The command shown in Example 1 deletes the collection of health monitoring configuration settings with the Identity atl-cs-001.litwareinc.com. Because identities must be unique, this command will delete, at most, a single collection of settings.

-------------------------- Example 1 ------------------------

	Copy Code
Get-CsHealthMonitoringConfiguration | Remove-CsHealthMonitoringConfiguration

Example 2 deletes all the health monitoring configuration settings currently in use. To do this, the command first calls Get-CsHealthMonitoringConfiguration without any parameters; this returns a collection of all the health monitoring configuration settings in the organization. This collection is then piped to Remove-CsHealthMonitoringConfiguration, which deletes each item in the collection.

-------------------------- Example 3 ------------------------

	Copy Code
Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com | Remove-CsHealthMonitoringConfiguration

The preceding command deletes 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 (i.e., a fully qualified domain name) that ends with the string value ".litwareinc.com" will be returned. The filtered collection is then piped to Remove-CsHealthMonitoringConfiguration, which deletes each item in the collection.

-------------------------- Example 4 ------------------------

	Copy Code
(Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:kenmyer@litwareinc.com" -or $_.SecondTestUserSipUri -eq " sip:kenmyer@litware.com"}) | Remove-CsHealthMonitoringConfiguration

The command shown in Example 4 deletes 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 perform this task, the command starts off by calling Get-CsHealthMonitoringConfiguration without additional parameters; doing this returns a collection of all the health monitoring configuration settings currently in use in the organization. This complete 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". In turn, those settings are piped to, and removed by, Remove-CsHealthMonitoringConfiguration.