MSFT_SIPLogSetting

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

Allows you to enable call detail recording or Quality of Experience (QoE) monitoring for servers in this pool.

The property values for the MSFT_SIPLogSetting class map to the settings found on the Monitoring tab of the Front End Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, and then clicking Front End Properties. In the Front End Properties dialog box, click the Monitoring tab. Note that these settings apply only to the specified pool or server.

MSFT_SIPLogSetting

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;
  boolean EnableQMS;
  [key] string InstanceID;
  uint32 QoETimeToBeReceived;
  uint32 QoETimeToReachQueue;
  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

    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.

    The Backend property does not map to the Front End Server Properties dialog box.

  • Critical
    Data type: boolean

    Access type: Read/Write

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

    If True, Office Communications Server shuts down if this extension module (the IM Archiving Agent) fails. If False, Office Communications Server continues running despite extension module failure.

    The default value is False.

    The Critical property does not map to the Front End Server Properties dialog box.

  • EnableCDR
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether CDR is enabled in the pool.

    The default value is False.

    The EnableCDR property maps to the Enable call detail recording (CDR) checkbox in the Front End Properties dialog box.

  • 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 Office Communications Server; if False, it is not.

    The default value is False.

    The Enabled property does not map to the Front End Server Properties dialog box.

  • EnableQMS
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether QoE is enabled in the pool.

    The default value is False.

    The EnableQMS property maps to the Enable QoE monitoring checkbox in the Front End Properties dialog box.

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

    The InstanceID property does not map to the Front End Server Properties dialog box.

  • QoETimeToBeReceived
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of minutes before throwing an error event that the QoE agent waits for a message to be sent after it reaches the destination queue.

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

    The default value is 45.

    The QoETimeToBeReceived property does not map to the Front End Server Properties dialog box.

  • QoETimeToReachQueue
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of minutes before throwing an error event that the QoE agent waits for a message to reach the destination.

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

    The default value is 30.

    The QoETimeToReachQueue property does not map to the Front End Server Properties dialog box.

  • TimeToBeReceived
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of minutes for the Archiving agent to wait for a message to be archived after reaching the destination queue before stopping the Office 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.

    The TimeToBeReceived property does not map to the Front End Server Properties dialog box.

  • TimeToReachQueue
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of minutes for the Archiving agent to wait for a message to reach the destination queue before stopping the Office 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.

    The TimeToReachQueue property does not map to the Front End Server Properties dialog box.

Remarks

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

Changes to the value of TimeToBeReceived or TimeToReachQueue does 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 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 and Front End Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference