MSFT_SIPQMSExternalConsumer (New)

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.

Contains configuration settings for sending Quality of Experience (QoE) reports from the QoE Agent service process to a third-party consumer by using HTTP/HTTPS.

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

MSFT_SIPQMSExternalConsumer

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_SIPQMSExternalConsumer
{
  uint8[] ClientCertIssuer;
  uint8[] ClientCertSN;
  string ConsumerName;
  string ConsumerURL;
  boolean Enabled;
  boolean ErrorRetryEnabled;
  [key] string InstanceID;
  uint32 MaxPostBatchSize;
  uint32 MaxQueueSize;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPQMSExternalConsumer class has the following properties.

• ClientCertIssuer
  Data type: uint8[]

  Access type: Read/Write

  Optional. The certificate authority that issued the certificate as a byte array.

  The default value is NULL.

• ClientCertSN
  Data type: uint8[]

  Access type: Read/Write

  Optional. The serial number of the certificate as a byte array.

  The default value is NULL.

• ConsumerName
  Data type: string

  Access type: Read/Write

  Optional. The friendly name of the third-party monitor.

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

  The default value is NULL.

• ConsumerURL
  Data type: string

  Access type: Read/Write

  Optional. The URL to which to post metric reports. The URL must start with http:// for TCP connections and https:// for TLS/MTLS connections.

  The default value is NULL.

• Enabled
  Data type: boolean

  Access type: Read/Write

  Required. Specifies whether the Metrics Receiver is enabled to receive reports.

  The default value is False.

• ErrorRetryEnabled
  Data type: boolean

  Access type: Read/Write

  Required. Specifies whether the Monitoring Server should retry when transient errors occur.

  The default value is True.

• InstanceID
  Data type: [key] string

  Access type: Read-only

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

• MaxPostBatchSize
  Data type: uint32

  Access type: Read/Write

  Required. The maximum number of reports to send in one HTTP POST request.

  The default value is 50.

  The minimum value for this property is 5 and the maximum value is 100.

• MaxQueueSize
  Data type: uint32

  Access type: Read/Write

  Required. The maximum size (kb) of the in-memory queue.

  The default value is 50000. The queue size is unlimited when this is set to 0.

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

Remarks

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

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

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.

See Also

Concepts

Office Communications Server WMI Reference