Remove-CsDiagnosticConfiguration
Removes one or more of the diagnostic configuration settings collections currently in use in your organization. Diagnostic configuration settings are used to determine whether traffic to or from a given domain or Uniform Resource Identifier (URI) is recorded in your Skype for Business Server log files. This cmdlet was introduced in Lync Server 2010.
Syntax
Remove-CsDiagnosticConfiguration
[-Identity] <XdsIdentity>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
If you enable logging for Skype for Business Server, 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 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 configuration settings make it possible for you to specify the domains or URIs that will be recorded in the log files; if a diagnostic filter is enabled then only traffic to or from the specified domains will be logged. Skype for Business Server enables you to create diagnostic configuration settings and apply diagnostic filters, at the site scope. In turn, this enables you to apply filtering to, say, the Redmond site while leaving filtering disabled on your other sites.
You can use the Remove-CsDiagnosticConfiguration cmdlet to remove any of the diagnostic configuration settings you have created at the site scope.
The Remove-CsDiagnosticConfiguration cmdlet can also be run against the global diagnostic configuration settings.
In that case, however, the collection will not be deleted; that's because Skype for Business 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 all the filters added to that collection will be removed.
Examples
-------------------------- Example 1 ------------------------
Remove-CsDiagnosticConfiguration -Identity site:RedmondExample 1 deletes the diagnostic configuration settings that have the Identity site:Redmond.
-------------------------- Example 2 ------------------------
Get-CsDiagnosticConfiguration -Filter site:* | Remove-CsDiagnosticConfigurationThe command shown in Example 2 deletes all the diagnostic configuration settings that have been configured at the site scope.
To do this, the command calls the Get-CsDiagnosticConfiguration cmdlet along with the Filter parameter; the filter value "site:*" limits the returned data to settings where the Identity begins with the characters "site:".
The filtered collection is then piped to the Remove-CsDiagnosticConfiguration cmdlet, which removes each item in that collection.
-------------------------- Example 3 ------------------------
Get-CsDiagnosticConfiguration | Remove-CsDiagnosticConfigurationIn Example 3, the command deletes all the diagnostic configuration settings currently in use in the organization.
To perform this task, the Get-CsDiagnosticConfiguration cmdlet is first called without any parameters in order to return a collection of all the diagnostic configuration settings currently in use in the organization.
These items are then piped to the Remove-CsDiagnosticConfiguration cmdlet, which removes each item in the collection.
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
Unique identifier for the diagnostic configuration settings to be removed.
To remove settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond".
The Remove-CsDiagnosticConfiguration cmdlet can also be run against the global configuration settings; in that case, use this 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.
| Type: | XdsIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object.
The Remove-CsDiagnosticConfiguration cmdlet accepts pipelined instances of the diagnostic filter settings object.
Outputs
None.
Instead, the Remove-CsDiagnosticConfiguration cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object.