MSFT_SIPLoggingToolSetting class

Communications Server 2007 Server SDK Documentation


Specifies the configuration file path, the log file path, and the debug session owner for a Office Communications Server 2007 Logging Tool session.

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.

class MSFT_SIPLoggingToolSetting
  [key] string Backend;
  string ConfigFilePath;
  string DebugSessionOwner;
  [key] string InstanceID;
  string LogFilesPath;


This class does not define any methods.


The MSFT_SIPLoggingToolSetting class has the following properties.

Data type: [key] string

Access type: Read-only

Must be empty when accessing data from Edge Server or Proxy Server roles. Required when accessing data from any role that belongs to a pool.

The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Office Communications Server 2007, back-end database (configuration data is stored in the same SQL instance as user data, but in a different database). Indicates where this class is stored, which varies depending on the server role.

Server RoleAcceptable Values
Enterprise EditionSQL_Instance_Name
Standard Edition(local)\rtc
Access Edge Server and Forwarding ProxyEmpty string
Data type: string

Access type: Read/Write

Optional. The absolute local path to the OCSLogger.config file.

The maximum length of the string is 260 characters.

Data type: string

Access type: Read/Write

Optional. The name of the current debug session owner.

The maximum length of the string is 272 characters.

Data type: [key] string

Access type: Read-only A GUID value that uniquely identifies an instance of this class.

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

Data type: string

Access type: Read/Write

Optional. The absolute local path to the directory in which the logging tool creates and saves log files.

The maximum length of the string is 260 characters.

The default value is %windir%\Tracing.


This class gets and sets information at the following level(s): WMI, SQL.

If this class is installed on a server whose role has "Pool" scope, the scope of this class is "Pool" and settings are stored in SQL. In this case, only one instance of this class can be present in the pool. For a list of server roles and their corresponding WMI class scopes, see WMI Class Management Scopes and Roles.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();
  • Provider::GetObject();
  • Provider::PutInstance();

    Where PutInstance() supports the following flag(s):



Server: Installed on computers serving the following role(s): Administrative Tools Server, Archiving and Call Detail Records Server, Audio/Video Conferencing Server, all types of Edge Server, Front End Server, Proxy Server, Web Components Server, Web Conferencing Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference

  What did you think of this topic?
  © 2007 Microsoft Corporation. All rights reserved.


Community Additions