MSFT_SIPDiagnosticFilterSetting

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Specifies optional URI (Uniform Resource Identifier) and FQDN (fully qualified domain name) filters for logging components. These class properties filter logging so that only traffic to and from specified addresses are displayed. The class specifies URI addresses to only log traffic to and a specified SIP URI, and FQDN addresses to only log traffic to and from a specified computer.

MSFT_SIPDiagnosticFilterSetting

The property values for the MSFT_SIPDiagnosticFilterSetting map to the Real Time Options group of Global Options in the Office Communications Server 2007 R2 Logging Tool console. You can access these values in the Logging Tool console by right-clicking an Enterprise pool or a Standard Edition server name, pointing to Logging Tool, and then clicking New Debug Session or Existing Debug Session.

The mapping between the dialog box and the WMI properties is shown in the illustration below:

Dd185823.MSFT_SIPDiagnosticFilterSetting_RealOptions(en-us,office.13).jpg

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class MSFT_SIPDiagnosticFilterSetting
{
  boolean EnableFilters;
  string FQDNFilter1;
  string FQDNFilter2;
  [key] string InstanceID;
  string URIFilter1;
  string URIFilter2;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPDiagnosticFilterSetting class has the following properties.

  • EnableFilters
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether filters are enabled. Maps to the Real Time Monitoring check box in the Logging Tool console.

    If True, logging components log a diagnostic trace for any message that matches one of the filter values specified by FQDNFilter1, FQDNFilter2, URIFilter1, or URIFilter2. Both the To and From fields of messages are examined.

    The default value is False.

  • FQDNFilter1
    Data type: string

    Access type: Read/Write

    Optional. A filter value for the host portion of a SIP address. Maps to the first FDQN box in the Logging Tool console.

    The value can be either a fully qualified domain name (FQDN) or an IP address. The following patterns are supported by the matching functions: server.domain and *.domain.

    The domain name "*" is not valid, nor is the IP address "0.0.0.0". Multicast addresses in the ranges from 224.0.0.0 to 239.255.255.255 are also not valid.

  • FQDNFilter2
    Data type: string

    Access type: Read/Write

    Optional. A filter value for the host portion of a SIP address. Maps to the second FDQN box in the Logging Tool console.

    See the description for FQDNFilter1.

  • InstanceID
    Data type: [key] string

    Access type: Read-only. A GUID value that uniquely identifies an instance of this class. The InstanceID value does not map to the Administration Tool.

    The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

  • URIFilter1
    Data type: string

    Access type: Read/Write

    Optional. A filter value for the user@host portion of a SIP address. Maps to the first URI box in the Logging Tool console.

    The following patterns are supported by the matching functions: user@domain; *@domain; and user@*. The maximum length of the string is 454 characters.

  • URIFilter2
    Data type: string

    Access type: Read/Write

    Optional. A filter value for the user@host portion of a SIP address. Maps to the second URI box in the Logging Tool console.

    See the description for URIFilter1.

Remarks

This class gets and sets information at the following level: WMI.

Only one instance of this class can be present.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag:

    • WBEM_FLAG_UPDATE_ONLY

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Archiving and Call Detail Records Server, Audio/Video Conferencing Server, all types of Edge Server, Front End Server, Mediation Server, Proxy Server, Web Components Server, and Web Conferencing Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference

Other Resources

Specifying Global Options