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.

MSFT_SIPLogSetting

MSFT_SIPLogSetting

Defines the settings for the loaded instance of the logging-specific extension module on the Office Communications Server.

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_SIPLogSetting
{
  [key] string Backend;
  boolean Critical;
  boolean EnableCDR;
  boolean Enabled;
  [key] string InstanceID;
  boolean StopOnEncryptionInitFailures;
  uint32 TimeToBeReceived;
  uint32 TimeToReachQueue;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPLogSetting class has the following properties.

  • Backend
    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 Role

    Acceptable Values

    Enterprise Edition

    SQL_Instance_Name

    Standard Edition

    (local)\rtc

    Access Edge Server and Forwarding Proxy

    Empty string

  • Critical
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether the server shuts down if an instant message cannot be archived.

    If true, the Office Communications Server will shut down if this extension module (the IM Archiving Agent) fails. If false, the Office Communications Server will continue running despite extension module failure.

    The default value is false.

  • EnableCDR
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether call detail recording is enabled on the server.

    The default value is false.

  • Enabled
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether the IM Archiving Agent is enabled.

    If true, the IM Archiving Agent is enabled on the Office Communications Server; if false, it is not.

    The default value is false.

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

  • StopOnEncryptionInitFailures
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether the server shuts down if Message Queuing encryption fails.

    If true, when encryption fails to initialize on the MSMQ, Office Communications Server 2007 stops.

    The default value is false.

  • TimeToBeReceived
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of minutes to wait for a message to be archived after reaching the destination queue before stopping Communications Server service when Critical is set to true.

    The minimum value for this property is 0 and the maximum value is 1440.

    The default value is 45.

  • TimeToReachQueue
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of minutes to wait for a message to reach the destination queue before stopping Communications Server service when Critical is set to true.

    The minimum value for this property is 0 and the maximum value is 1440.

    The default value is 30.

Remarks

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

Changes to the value of either TimeToBeReceived or TimeToReachQueue will not take effect until the Office Communications Server Front End service is restarted.

Only one instance of this class can be present in the pool.

Instances of this class support the following interface methods:

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

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

WBEM_FLAG_CREATE_ONLY WBEM_FLAG_UPDATE_ONLY WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Administrative Tools Server, Front End Server.Namespace: Defined in \root\cimv2.

Reference

MSFT_SIPLogServiceSetting

[<LinkCreatedDuringXmlConversion>]

Concepts

Office Communications Server WMI Reference