This documentation is archived and is not being maintained.

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_SIPLogServiceSetting

Defines an instance of the Archiving service, which logs SIP messages sent to it by the archiving agent running 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_SIPLogServiceSetting
{
  string ArchivingDBPath;
  uint32 ConcurrentThreads;
  uint32 DaysOfArchiving;
  [key] string InstanceID;
  string LogFilePath;
  uint32 MaxLogFileSize;
  uint32 PurgeTime;
  string QueueName;
  string SQLDBName;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPLogServiceSetting class has the following properties.

ArchivingDBPath

Data type: string

Access type: Read/Write

Required. The full SQL Server instance path for the archiving server.

The value of this property is not case-sensitive.

The default value is the local directory.

ConcurrentThreads

Data type: uint32

Access type: Read/Write

Required. The number of threads that can simultaneously service the message queue for the archive service.

The minimum value for this property is 1 and the maximum value is 64.

The default value is 16.

DaysOfArchiving

Data type: uint32

Access type: Read/Write

Required. The number of days that content is archived before the previously archived data is overwritten.

The minimum value for this property is 0 and the maximum value is 2562, where 0 means that archived data is never overwritten.

The default value is 0.

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

LogFilePath

Data type: string

Access type: Read/Write

Required. The absolute local path to the location of the log file.

The maximum length of the string is 160 characters.

The default value is C:\.

MaxLogFileSize

Data type: uint32

Access type: Read/Write

Required. The maximum size of the log file in megabytes.

The minimum value for this property is 1 and the maximum value is 64.

The default value is 64.

PurgeTime

Data type: uint32

Access type: Read/Write

Required. The time of day at which log files are purged.

The value is based on a 24-hour clock. The minimum value for this property is 0 and the maximum value is 23.

The default value is 4.

QueueName

Data type: string

Access type: Read-only

Required. The name of the MSMQ queue by which SIP messages are sent to the IM Archiving Service from the Archiving Agent on the Office Communications server.

The maximum length of the string is 115 characters. The value of this property is not case-sensitive.

SQLDBName

Data type: string

Access type: Read-only

Required. The name of the SQL database where the log messages will be stored.

The maximum length of the string is 128 characters. The value of this property is not case-sensitive.

Remarks

This class gets and sets information at the following level(s): 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(s):

WBEM_FLAG_CREATE_ONLY WBEM_FLAG_UPDATE_ONLY WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Archiving and Call Detail Records Server.Namespace: Defined in \root\cimv2.


Reference

MSFT_SIPLogSetting
[<LinkCreatedDuringXmlConversion>]

Concepts

Show: