New-CsDiagnosticsFilter
Topic Last Modified: 2012-03-23
Creates a new diagnostic filter to be used with diagnostic configuration settings. Diagnostic configuration settings are used to determine whether traffic to or from a given domain or Uniform Resource Identifier (URI) is recorded in your Microsoft Lync Server 2010 log files.
Syntax
New-CsDiagnosticsFilter [-Enabled <$true | $false>] [-ExcludeConferenceMessages <$true | $false>] [-ExcludePresenceNotifications <$true | $false>] [-ExcludeRegisterMessages <$true | $false>] [-ExcludeSubscribeMessages <$true | $false>] [-Fqdn <PSListModifier>] [-Uri <PSListModifier>]
Detailed Description
If you enable logging for Lync 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.
On the other hand, this can also result in cases of 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; for example, you might want to log only the traffic to or from specified domains. In addition to the global settings, Lync Server enables you to create diagnostic 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 different settings to the Redmond site than are applied to your other sites.
The New-CsDiagnosticsFilter enables you to add a filter to a collection of diagnostic settings. This collection contains the domains and URIs that will have their traffic recorded in the log files. When a filter is added, only information pertaining to the domains and URIs in the filter will be logged; for logging purposes, traffic from other domains and URIs will be ignored.
Note that the New-CsDiagnosticsFilter cmdlet creates in-memory-only instances of a diagnostic filter. After creating one of these virtual filters, you will then need to use either New-CsDiagnosticConfiguration or Set-CsDiagnosticConfiguration to add the filter to a collection.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsDiagnosticsFilter cmdlet locally: RTCUniversalServerAdmins. 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 prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDiagnosticsFilter"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Enabled |
Required |
Boolean |
Indicates whether or not the filter should be employed. The default value is True ($True). |
ExcludeConferenceMessages |
Optional |
Boolean |
If set to True, information about conference messages (that is, any message with a conference URI in its To or From header) will not be recorded in the log files. The default value is False. |
ExcludePresenceNotifications |
Optional |
Boolean |
If set to True, information about presence notifications (that is, any message that uses the NOTIFY or BENOTIFY method) will not be recorded in the log files. The default value is False. |
ExcludeRegisterMessages |
Optional |
Boolean |
If set to True, information about client registrations (that is, any message that uses the REGISTER method) will not be recorded in the log files. The default value is False. |
ExcludeSubscribeMessages |
Optional |
Boolean |
If set to True, information about client subscriptions (that is, any message that uses the SUBSCRIBE method) will not be recorded in the log files. The default value is False. |
Fqdn |
Optional |
PS List Modifier |
Collection of domains to be included in the filter. (More technically, these domains represent the host portion of a SIP address.) For the FQDN property you can use a fully qualified domain name (FQDN) like this: fabrikam.com. Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. You can have more than one domain in a single filter. |
Uri |
Optional |
PS List Modifier |
Collection of URIs to be included in the filter. (The URI is the user@host portion of a SIP address.) A URI can consist of any of the following patterns: user@fabrikam.com user@* *@fabrikam.com You can include multiple URIs in a single filter. |
Input Types
None. New-CsDiagnosticsFilter does not accept pipelined input.
Return Types
New-CsDiagnosticsFilter creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.Filter object.
Example
-------------------------- Example 1 ------------------------
$x = New-CsDiagnosticsFilter -Fqdn "fabrikam.com" -Enabled $False
Set-CsDiagnosticConfiguration -Identity global -Filter $x
The commands shown in Example 1 use New-CsDiagnosticsFilter to create a new diagnostic filter and then assign that filter to the global diagnostic configuration settings. To carry out this task, the first command calls New-CsDiagnosticsFilter to create an in-memory-only diagnostic filter. This filter adds the FQDN fabrikam.com and the URI user@fabrikam.com to the filter. The command also sets the Enabled property to True ($True) in order to activate the filter. The resulting virtual filter is then stored in the variable $x.
In the second command, Set-CsDiagnosticConfiguration is used to assign the new filter to the global diagnostic configuration settings. In this case, any existing values in the Filter property will be replaced by the newly-created filter stored in $x.
-------------------------- Example 2 ------------------------
$x = New-CsDiagnosticsFilter -Fqdn "fabrikam.com","contoso.com" -Enabled $False
Set-CsDiagnosticConfiguration -Identity global -Filter $x
The commands shown in Example 2 are a variation of the commands shown in Example 1; in Example 2, however, two FQDNs (fabrikam.com and contoso.com) are added to the filter’s Fqdn property. To do this, both names (separated by a comma) are used as parameter values for the Fqdn parameter.