MSFT_SIPLogOptions
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.
Defines the options available to the Office Communications Server 2007 R2 Archiving service.
The properties in the MSFT_SIPLogOptions class do not map directly to the Office Communications Server 2007 R2 Administration Tool.
MSFT_SIPLogOptions
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_SIPLogOptions
{
string ArchAdrAckQueueName;
string ArchivingBEToken;
string CDRBEToken;
[key] string InstanceID;
string MonitoringQueuePath;
string QoEAckQueueName;
boolean QoEReportLoggingEnabled;
string QoEReportLoggingAcceptedDir;
string QoEReportLoggingRejectedDir;
uint32 QoEReportLoggingMinFreeDisk;
string QueuePath;
};
Methods
This class does not define any methods.
Properties
The MSFT_SIPLogOptions class has the following properties.
ArchAdrAckQueueName
Data type: stringAccess type: Read/Write
Optional. The path to the private queue used to store acknowledgments for logged messages using by Archiving agent.
The maximum length of the string is 380 characters. The value of this property is not case-sensitive.
ArchivingBEToken
Data type: stringAccess type: Read/Write
Required. If present, indicates that a message has already been logged by an associated Archiving agent.
The default value is backend_token to archive all messages in instant messaging (IM) conversations between users in different Office Communications Server pools to the pool of the user who sent the first message in the conversation.
Set this token to a different value than the default (and to a different value than it is set for any other Office Communications Server pool) to cause all messages in cross-pool conversations to be archived in both pools separately.
The maximum length of the string is 250 characters. The value of this property is not case-sensitive.
CDRBEToken
Data type: stringAccess type: Read/Write
Required. The Archiving and Call Detail Records (CDR) Server backend token.
The default value is backend_token. The default setting causes a Call Detail Record (CDR) for a call between users in different Office Communications Server 2007 R2 pools to be written in only one of the pools.
To cause cross-pool calls to be archived separately in each pool (create duplicate records for cross-pool calls), set this token to a different value from the default (and a different value from its value on any other Office Communications Server pool).
The maximum length of the string is 250 characters. The value of this property is not case-sensitive.
InstanceID
Data type: [key] stringAccess 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}".
MonitoringQueuePath;
Data type: stringAccess type: Read/Write
Optional. The path to the MSMQ (Microsoft Message Queuing) server used by CDR and QoE services running on the Monitoring server.
The string consists of a maximum of 380 characters: 115 for the queue, 255 for the fully qualified domain name (FQDN) of the MSMQ server, and 10 for "\private$\".
The value of this property is not case-sensitive.
The default value is NULL.
QoEAckQueueName
Data type: stringAccess type: Read/Write
Optional. The path to the private queue used to store acknowledgments for logged messages used by the QoE agent.
The maximum length of the string is 380 characters. The value of this property is not case-sensitive.
QoEReportLoggingEnabled
Data type: booleanAccess type: Read/Write
Required. Specifies whether all accepted and rejected QoE metrics reports are stored at the locations specified by QoEReportLoggingAcceptedDir and QoEReportLoggingRejectedDir.
The default value for this property is False.
QoEReportLoggingAcceptedDir
Data type: stringAccess type: Read/Write
Optional. The full path for the location to store accepted QoE metrics reports.
The default value is NULL.
The maximum length of the string is 260 characters. The value of this property is not case-sensitive.
QoEReportLoggingRejectedDir
Data type: stringAccess type: Read/Write
Optional. The full path for the location to store rejected QoE metrics reports.
The default value is NULL.
The maximum length of the string is 260 characters. The value of this property is not case-sensitive.
QoEReportLoggingMinFreeDisk
Data type: uint32Access type: Read/Write
Required. The minimum free disk size required for QoE report logging as a percentage of the total disk size.
If free disk size drops below this value, the logging stops.
The default value for this property is 5 (for 5% of the total disk size).
The minimum value for this property is 0 and the maximum value is 99.
QueuePath
Data type: stringAccess type: Read/Write
Optional. The path to the MSMQ (Microsoft Message Queuing) server used by the Archiving agent.
The string consists of a maximum of 380 characters: 115 for the queue, 255 for the fully qualified domain name (FQDN) of the MSMQ server, and 10 for "\private$\".
The value of this property is not case-sensitive.
The default value is NULL.
Remarks
This class gets and sets information at the following level: 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 flags:
WBEM_FLAG_CREATE_ONLY
WBEM_FLAG_UPDATE_ONLY
WBEM_FLAG_CREATE_OR_UPDATE
Requirements
Server: Installed on computers serving the following role: Front End Server.
Namespace: Defined in \root\cimv2.