ScriptingStandardConsumerSetting class

The singleton ScriptingStandardConsumerSetting class provides registration data that is common to all instances of the ActiveScriptEventConsumer standard consumer class. An ActiveScriptEventConsumer instance uses the MaximumScripts and Timeout properties. For more information, see Monitoring and Responding to Events with Standard Consumers.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of its inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

[Singleton, AMENDMENT]
class ScriptingStandardConsumerSetting : CIM_Setting
{
  string Caption = "Scripting Standard Consumer Setting";
  string Description = "Registration data common to all instances of the Scripting Standard Consumer";
  uint32 MaximumScripts = 300;
  string SettingID = "ScriptingStandardConsumerSetting";
  uint32 Timeout = 0;
};

Members

The ScriptingStandardConsumerSetting class has these types of members:

• Properties

Properties

The ScriptingStandardConsumerSetting class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short description of an object a one line string. Contains the string ScriptingStandardConsumerSetting because this is a singleton class.

Description

Data type: string

Access type: Read-only

A text description of an object.

MaximumScripts

Data type: uint32

Access type: Read/write

Maximum number of scripts that are run before a consumer starts a new instance. To clear out memory leaks from scripts, shut down the consumer regularly. The default value is 300.

SettingID

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

Identifier for the setting object.

Timeout

Data type: uint32

Access type: Read/write

Qualifiers: units ("Minutes")

Maximum number of minutes before a consumer starts a new instance. If 0 (zero), the MaximumScripts property controls the consumer lifetime. The valid range for Timeout is 0 through 71,000 and the default value is 0 (zero).

Remarks

The single instance of the ScriptingStandardConsumerSetting class resides in the root\cimv2 namespace.

Requirements

See also

CIM_Setting

Standard Consumer Classes

Running a Script Based on an Event

Creating a Logical Consumer

Receiving Events At All Times

__EventConsumer