MSFT_SIPLoggingToolSetting

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.

Configures Office Communications Server 2007 R2 Logging Tool session settings.

The properties in the MSFT_SIPLoggingToolSetting class do not map directly to the Office Communications Server 2007 R2 Administration Tool.

MSFT_SIPLoggingToolSetting

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_SIPLoggingToolSetting
{
  [key] string Backend;
  string ConfigFilePath;
  string DebugSessionOwner;
  [key] string InstanceID;
  string LogFilesPath;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPLoggingToolSetting class has the following properties.

• Backend
  Data type: [key] string

  Access type: Read-only

  Required: When accessing data from any role that belongs to a pool. This property must be empty when accessing data from the Edge Server or Proxy Server role.

  This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.

  The value for this property depends on the topology of Office Communications Server.

  Topology	Value
  Standard Edition	(local)\rtc
  Enterprise Edition (consolidated or expanded configuration)	computername\instancename or computername

  For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.

• ConfigFilePath
  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.

• DebugSessionOwner
  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.

• InstanceID
  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}".

• LogFilesPath
  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.

Remarks

This class gets and sets information at the following levels: WMI and 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 flags:

  • WBEM_FLAG_CREATE_ONLY

  • WBEM_FLAG_UPDATE_ONLY

  • WBEM_FLAG_CREATE_OR_UPDATE

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, Proxy Server, Web Components Server, and Web Conferencing Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference