Operational Status Monitoring

opstat-job observable-classes

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

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

Display the list of all currently observable objects for which you can create operational status 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 opstat-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.

opstat-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 opstat-job observable-classes subcommand.

opstat-job list

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

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

opstat-job info jobName

Display verbose information about an operational status monitoring job named jobName. The jobName must be one displayed by the opstat-job list subcommand. This subcommand displays the following information:

• The name of the operational status monitoring job.

• The type of the operational status monitoring job, either “by object” or “by class.” Jobs by object monitor a named object instance, whereas jobs by class monitor every instance of an object class. Note that it is not possible to create jobs by class with the mfwkadm utility.

• The state of the operational status 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 opstat-job suspend and opstat-job resume subcommands to change the running state of an operational status monitoring job.

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

• Whether the operational status monitoring job is reporting by event. This means the results of the operational status monitoring job are sent as notifications to a registered client.

• Whether the operational status monitoring job is reporting by file. This means the reports of the operational status monitoring job are written in local files and notifications containing the filenames are sent to registered clients.

• The report format of the operational status monitoring job, which is always XML.

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

• For a job by-object, the list of observed objects, ordered by name.

• For a job by-class, the list of observed classes, ordered by name.

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

opstat-job create jobName granularity=integerValue object=objectName [object=objectName ...]

Creates a new operational status monitoring job on one or more objects. The mfwkadm command cannot create jobs by class. When creating performance monitoring jobs, the following parameters can be set:

jobName

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

granularity=integerValue

The time specified in seconds between the initiation of two successive collections of measurement data, while the job is active on-duty.

object=objectName [object=objectName ...]

One or more observable objects that the operational status monitoring job will collect data from and report on. The objectName must be one displayed by the opstat-job list or opstat-job observable-objects subcommands. Specifying multiple object=objectName parameters will create a single operational status job that monitors multiple objects.

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

opstat-job delete jobName

Delete an operational status monitoring job named jobName. The jobName must be one displayed by the opstat-job list subcommand.

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

opstat-job suspend jobName

Suspend an operational status 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 opstat-job resume subcommand. The jobName must be one displayed by the opstat-job list subcommand.

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

opstat-job resume jobName

Resume an operational status 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 opstat-job list subcommand. This is the counterpart to the opstat-job suspend subcommand.

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