Threshold Value Monitoring

thrsh-job observable-classes

Display the list of all currently observable classes of objects for which you can create threshold monitoring jobs.

thrsh-job observable-objects [class=objectClass] [domain=objectDomain]

Display the list of all currently observable objects for which you can create threshold monitoring jobs. By default all objects of all observable classes and in every domain will be listed. The list of objects is sorted by their class name.

class=objectClass

Specifying the optional objectClass will restrict the output to observable objects of that specific class. The objectClass must be one of the classes listed by the thrsh-job observable-classes subcommand.

domain=objectDomain

Specifying the optional objectDomain will restrict the output to observable objects in that domain. The domain of an object is the string preceding the colon (“:”) character in the object's name.

thrsh-job observable-attributes class=objectClass

Display the list of all observable attributes in the specified objectClass. Attributes are displayed with their name and type. The objectClass must be one of the classes listed by the thrsh-job observable-classes subcommand.

thrsh-job list

Displays the list of all currently defined threshold monitoring jobs. Jobs are listed for each object having a defined threshold job, and objects are sorted by their class name. The information displayed for each job is the same as displayed by the thrsh-job info subcommand.

Security: For other users than the one who launched the Common Agent Container, no jobs will be displayed.

thrsh-job info jobName

Display verbose information about a threshold monitoring job named jobName. The jobName must be one displayed by the thrsh-job list subcommand. This subcommand displays the following information:

• The name of the threshold monitoring job.

• The multiplicity of the threshold monitoring job. In this release, only simple threshold jobs that monitor one attribute on one object are possible.

• The state of the threshold monitoring job: active on-duty, active off-duty, or suspended. An active on-duty job is currently scheduled to run and is collecting data. An active off-duty job is running but not collecting data because the current time is out of its working schedule. A suspended job is not running nor collecting any data. Use the thrsh-job suspend and thrsh-job resume subcommands to change the running state of a threshold monitoring job.

• The granularity in seconds of the threshold monitoring job. This is the interval for data collection by this job.

• The schedule of the threshold monitoring job. The schedule specifies what days and times the job is active on-duty or active off-duty (collecting data or not, respectively).

• The alarm configuration of the threshold monitoring job. This is the alarm that will be triggered when the observed value of the monitored attribute crosses the defined threshold value. The display includes the alarm's type and severity.

• The observed object of the threshold monitoring job.

• The attribute name to which the threshold is applied.

• The value of the threshold that will trigger an alarm.

• The direction of the value's progress that will trigger an alarm at the threshold, either RISING or FALLING.

• The tolerance offset of the threshold. When the direction is RISING, an alarm will not be triggered again until the observed attribute is less than the thresholdValue-offsetValue. When the direction is FALLING, an alarm will not be triggered again until the observed attribute is more than the thresholdValue+offsetValue. This behavior holds true even when the offset is zero.

Security: For users other than the one who launched the Common Agent Container, no information will be displayed.

thrsh-job create jobName object=objectName granularity=integerValue attributeName=attributeName attributeType=attributeType thresholdValue=thresholdValue thresholdOffset=offsetValue thresholdDirection=[RISING|FALLING]

Creates a new threshold monitoring job that monitors one attribute on a single object. When creating threshold jobs, the following parameters can be set:

jobName

A string uniquely identifying the threshold monitoring job. The jobName cannot be already in use by any other threshold monitoring job.

object=objectName

The observable object on which the threshold monitoring job will collect the attribute values to compare against the threshold. The objectName must be one displayed by the thrsh-job list or thrsh-job observable-objects subcommands.

granularity=integerValue

The time specified in seconds between the initiation of two successive observations of the attribute value, while the job is active on-duty.

attributeName=attributeName

The name of the attribute for which the threshold monitoring job gathers values and compares compare them to the threshold. The attributeName must be listed by the thrsh-job info or thrsh-job observable-attributes subcommands.

attributeType=attributeType

The type of the observable attribute to be monitored. The attributeType must be listed by the thrsh-job info or thrsh-job observable-attributes subcommands.

thresholdValue=thresholdValue

The value of the monitored attribute that will cause this threshold job to trigger an alarm when crossed in the direction specified by thresholdDirection.

thresholdOffset=offsetValue

The offsetValue determines the tolerance of the threshold job in triggering successive alarms. The offsetValue must be zero or a positive value. After an alarm event is triggered, no new alarm event will be triggered until the value of the monitored attribute exceeds the range defined by the offsetValue and the thresholdDirection.

thresholdDirection=[RISING|FALLING]

When the direction is RISING, an alarm event will not be triggered again until the observed attribute value is less than thresholdValue-offsetValue. When the direction is FALLING, an alarm event will not be triggered again until the observed attribute value is more than thresholdValue+offsetValue. This behavior holds true even when the offsetValue is zero.

Security: This subcommand can be run only by the user who launched the Common Agent Container.

thrsh-job delete jobName

Delete a threshold monitoring job named jobName. The jobName must be one displayed by the thrsh-job list subcommand.

Security: This subcommand can be run only by the user who launched the Common Agent Container.

thrsh-job suspend jobName

Suspend a threshold monitoring job named jobName. A suspended job is not active and will no longer collect data, regardless of its schedule. However, the job remains defined and can be made active again with the thrsh-job resume subcommand. The jobName must be one displayed by the thrsh-job list subcommand.

Security: This subcommand can be run only by the user who launched the Common Agent Container.

thrsh-job resume jobName

Resume a threshold monitoring job named jobName. A resumed job will begin collecting data and sending reports according to its schedule. The jobName must be one displayed by the thrsh-job list subcommand. This is the counterpart to the thrsh-job suspend subcommand.

Security: This subcommand can be run only by the user who launched the Common Agent Container.