Docs.bmc.com will undergo a brief maintenance outage 27 March 2025. The site will be unavailable for ten minutes starting at 6:30 AM CDT/5 PM IST.

Parameter properties


The following table describes the default parameter properties available in PATROL Console and ProactiveNet.

Information

Collector and text parameters do not display the TrueSight and Central Monitoring Administration properties.

Terminology note

Attributes in the TrueSight console and Central Monitoring Administration are known as parameters in the PATROL consoles.


PATROL parameter properties

Property

Default value

Application class

The application class under which this parameter is displayed.

Command type

Language used to create the command this parameter executes.

Example: PATROL Script Language (PSL)

Icon style

Specifies whether the parameter is represented as a graph, text box, stop light (signal), or boolean state.

Unit

Specifies the unit of measure in which the parameter output is expressed, such as a percentage, a number, or bytes.

Border range

Indicates the normal operating range for the parameter.  The Border range must be larger than the Alarm1 and Alarm2 ranges combined.

Values are described as less than and greater than, for example <0 or >100.

If the Border range is undefined, it means it is inactive and any values that appear are not intended as recommendations.

Alarm1 range

Specifies the thresholds for the first-level alarm; this is not applicable to collector parameters.

Specifies the thresholds for the lower numerical values deemed unacceptable for this parameter. Values must be lower than values for Alarm2; cannot overlap Alarm2 range or fall outside the Border range. Values falling inside this range trigger warnings, alarms, or recovery actions.

If undefined, Alarm1 is inactive, and any values that appear are not intended as recommendations.

Alarm2 range

Specifies the thresholds for the second-level alarm; this is not applicable to collector parameters.

Specifies the thresholds for the higher numerical values deemed unacceptable for this parameter. Values must be higher than the values for Alarm1; cannot overlap Alarm1 range, or fall outside the Border range. Values falling inside this range trigger warnings, alarms, or recovery actions.

If undefined, Alarm2 is inactive, and any values that appear are not intended as recommendations.

Scheduling (poll time)

Specifies how frequently the parameter will run and collect data (polling cycle); this is not applicable to consumer parameters.

Active at installation

Specifies whether a parameter is active by default; reflected in the words yes or no.

Parameter type

Indicates the parameter type:

  • Standard parameters that gather and display a single data value. Some standard parameters have collector properties.
  • Collector parameters that gather multiple data values but has no display capabilities.

    A PATROL collector parameter executes commands and gathers data for a consumer parameter to display, often collecting many values. It does not display any values itself. As such, it does not have alarms or run any recovery actions. Collector parameters are defined in the collector's application class rather than in the applications for which they collect data. This avoids the situation in which a separate collector would execute for each application instance and negate the efficiency of the collector or consumer parameter. 
  • Consumer parameters that display values gathered by collector or standard parameters.

    A consumer parameter only displays a value that is collected by a collector parameter. A consumer parameter never issues commands; it is not scheduled for execution, but it has alarms and can run recovery actions. A consumer parameter cannot be updated directly by selecting an option on its display. To update a consumer parameter, you must execute the collector that gathers its data. For additional information about parameters and defining your own parameters, see the PATROL Console Help or the PATROL user guide for your console. 

Value set by

 Lists the collector parameter that sets the values for the consumer parameter described.