Removes one or more of the diagnostic filter configuration settings collections currently in use in your organization. Diagnostic filter configuration settings are used to determine whether traffic to or from a given domain or Uniform Resource Identifier (URI) is recorded in your Microsoft Communications Server 2010 log files.
Syntax
Remove-CsDiagnosticFilterConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
Unique identifier for the diagnostic filter configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To remove settings configured at the service scope, use syntax like this: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com". Remove-CsDiagnosticFilterConfiguration can also be run against the global configuration settings; in that case, you use the syntax –Identity global. However, the global settings will not actually be removed; instead, the properties found in the global settings will be reset to their default values. That means setting the Enabled property to False, and deleting all the configured filters. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
If you enable logging for Communications Server 2010, then by default traffic traveling to or from any domain or URI is included in those log files. This ensures that as much information as possible is recorded in the log files.
However, this can occasionally result in too much information. For example, if you are experiencing connectivity problems with a particular domain, you might want to limit logging to traffic between your network and that specific domain; that makes it easier for you to identify the relevant records and, in turn, might make it easier for you to diagnose and correct the problem.
Diagnostic filter configuration settings make it possible for you to specify the domains or URIs that will be recorded in the log files; if diagnostic filtering is enabled, then the only traffic to or from the specified domains will be logged. Communications Server enables you to create diagnostic filter settings at the site scope or the service scope (for either the Edge Server or the Registrar service). In turn, this enables you to apply filtering to, say, the Redmond site while leaving filtering disabled on your other sites.
After diagnostic filtering has been applied to a site or service, you can use the Set-CsDiagnosticFilterConfiguration cmdlet to enable or disable filtering. Alternatively, you can use the Remove-CsDiagnosticFilterConfiguration cmdlet to remove any of the custom collections you have created at the site or service scope. The Remove-CsDiagnosticFilterConfiguration cmdlet can also be run against the global diagnostic filter collection. In that case, however, the collection will not be deleted; that’s because Communications Server does not allow you to delete global collections. Instead, removing a global collection causes the properties in that collection to be reset to their default values. That means that filtering will be disabled, and all the filters added to that collection will be removed.
Return Types
Remove-CsDiagnosticFilterConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsDiagnosticFilterConfiguration -Identity site:Redmond |
|
The preceding command deletes the diagnostic filter configuration settings that have the Identity site:Redmond.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsDiagnosticFilterConfiguration -Filter service:* | Remove-CsDiagnosticFilterConfiguration |
|
The command shown in Example 2 deletes all the diagnostic filter configuration settings that have been configured at the service scope. To do this, the command calls Get-CsDiagnosticFilterConfiguration along with the Filter parameter. The filter value "service:*" limits the returned data to settings where the Identity begins with the characters "service:". The filtered collection is then piped to Remove-CsDiagnosticFilterConfiguration, which removes each item in that filtered collection.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsDiagnosticFilterConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsDiagnosticFilterConfiguration
|
|
In Example 3, the command deletes all the diagnostic filter configuration settings that are currently disabled. To perform this task, Get-CsDiagnosticFilterConfiguration is first called, without any parameters, in order to return a collection of all the diagnostic filter settings currently in use in the organization. These items are then piped to the Where-Object cmdlet, which picks out only those settings where the Enabled property is equal to (-eq) False ($False). These filtered settings are then piped to Remove-CsDiagnosticFilterConfiguration, which, in turn, removes each collection of settings.