15.7. Input parameters passed on running actions (programs)

A program, that will be run, as its input parameters gets (besides parameters specified in a program field of a given action) information concerning a whole case and each event which are included in it. Kinds of parameters for each event included in a case depends on its kind i.e. if its source inforamtion is a type of data: SNMP Data or SNMP Trap. Nevertheless all parameters are preceded by keywords which begin double or single dash. Following parameters are given to all programs:

Table 15.2. Input parameters passed on running actions (programs)

Parameter name	Description
--flow-severity severity	Internal severity of a case.
--flow-id ID	Number of a case in a given day.
--action-id ID	Number of an action (value of id field of a given action).
--opened	Information about opening a case (running programs decides what it means; It's usually an notification of an operator). That parameter will occur if a case is marked as open.
--community community	Sum of communities included in each event of the case.
--closing-reason description	Note about closing reason of a case. It must be specified by previously occured actions. It is always a specified parameter for an action that is run after death of a case. In that case, not specified closing reason, is described as "Not specified".
--closed-by uid	An identifier of a person closing a case. The parameter will not occur if it hasn't been specified during previously run actions. It will never be empty for actions run after death of a case. Its default value is "-1" number.
--action-done numer_akcji:kod_powrotu	Number of an action and a code of its last return (an argument may occur zero or more times).
--flow-ctime seconds	Creation time of a case (in sec. since beginning of UNIX epoch).
--flow-mtime seconds	Modification time of a case (in sec. since beginning of UNIX epoch).

All arguments below occur for each event including in a given case. The arguments can be more then one full set given below:

Table 15.3. The list of arguments

Argument name	Description
--event-hitsnumber number	The appearances number of the event during the case is working.
--event-state state	Event state, where state parameter must be one of: active, passive.
--event-id number	Unique number that identifies that event.
--event-ctime seconds	Creation time of an event (in sec. since beginning of UNIX epoch).
--event-mtime seconds	Modification time of an event (in sec. since beginning of UNIX epoch).
--event-type type	Type of message that an event is originated from. The value must be one of: snmptrap, snmpdata.

When type of a message is snmptrap, following parameters will occur:

Table 15.4. Arguments for snmptrap massage

Argument name	Description
-T seconds	Receiving time of a message (in sec. since beginning of UNIX epoch).
-s IP	Source address of a message.
-a IP	IP address of a SNMP agent that sent a message.
-c community	SNMP community of a message.
-n OID	Identifier of a message in MIB.
-e OID	Identifier of enterprise in MIB.
-t timestamp	Timestamp of a message.
-g generic	Generic number of a message.
-p specific	Specific number of a message.
-d string	Identifier of a message in Operation Manager.
-m message	A human readable message that explains meaning of a message.

When type of a message is snmpdata, following parameters will occur:

Table 15.5. Arguments for snmpdata massage

Argument name	Description
-f type	Reason of sending of a message to Associations Database must be one of: min - a value below minimum limit of a window of average values of that data, max - a value under maximum limit of a window of average values of that data, error - error for this data, timeout - No responding for request for that data.
-T seconds	Receiving time of data (in sec. since beginning of UNIX epoch).
-s IP	Address of a polling device.
-o OID	Data identifier in MIB.
-t type	Type of data that must be one of: counte, gauge, error, timeout, none. other - none of above types.
-v value	The last value of data.
-a value	Minimum limit of a window of average values of that data.
-A value	Maximum limit of a window of average values of that data.
-d string	Identifier of that data in Operation Manager.
-m massage	A human readable message that explains meaning of that data.