Operands

NAME ruleid
Specifies the name of the rule.
MATCH mtext
Specifies the pattern that will be used to compare against a message to determine if there is a match. Wildcard pattern matching is allowed. If a match is found, the associated action is scheduled for processing. The value must be entered as 'mtext' if the value contains more than one blank-delimited word.
MCOL bbb:eee
Specifies the beginning and ending columns to search for the match pattern (inclusive). The valid format is bbb:eee, where bbb is the beginning column and eee is the ending column. The default is 001:999. Both the beginning and ending column values must be specified as three digits.
EXCLUDE etext
Specifies the pattern that will be used to compare against a message to determine if there is an exclusion. Wildcard pattern matching is allowed. The value must be entered as 'etext' if the value contains more than one blank-delimited word. If an exclusion is found, the associated action is not scheduled for processing.
ECOL bbb:eee
Specifies the beginning and ending columns to search for the exclude pattern (inclusive). The format is bbb:eee, where bbb is the beginning column and eee is the ending column. The default is 001:999. Both the beginning and ending column values must be specified as three digits.
Note: The ECOL operand may be specified only if the EXCLUDE operand is specified.
ACTION actnid
Specifies the name of the associated action. This action must have been previously defined using the DEFACTN command or the built-in action NULL.
An action with the name "NULL" is included in Operations Manager. The NULL action is equivalent to specifying DEFACTN NAME NULL and indicates that no action is to be performed. This is useful for rules and monitors that require no action initially, but may require action due to a LIMIT being reached or an idle monitor (via DEFIMON) being triggered.
CLASS c,c,...,c
Specifies that this rule is only applicable for the listed message classes. Any value from 1 to 255 may appear in the comma-separated list. Up to 32 values may be present. The default is all classes. For a list of valid message classes, see Using substitution variables in commands.
DAYS MTWTFSSH
Specifies the days of the week (Monday-Sunday) and if the rule is active on holidays. For the rule to be active on a day of the week and holiday, the corresponding location must contain the asterisk (*) symbol. The default is all days and holidays (********). See DEFDATE for information on defining holidays.
HOURS h,h,...,h
Specifies the hours of the day the rule is active. Any of the values from 0 to 23 may appear in the comma-separated list. Up to 24 values may be present. The default is all hours.
ENV procenv[,procsys]
Specifies that the processing environment and system of the action is to be overridden with the values assigned to procenv and procsys. See DEFACTN for more information on overriding the processing environment and system, and valid values for procenv and procsys.
LIMIT count,interval[,lmactn]
Specifies that the processing of the monitor's ACTION is limited to count times within interval period of time. Optionally, this command processes the alternate action specified by lmtactn if the limit condition is encountered.
  • The value for count must be from 0 to 999999.
  • When specified as a single positive integer, the value for interval must be from 0 to 999999 seconds. You can also use the format of ddd-hh:mm:ss, which specifies the interval value in days (ddd), hours (hh), minutes (mm), and seconds (ss). The maximum value for this input format is 999-23:59:59.

    For example, a LIMIT of 4 times in 10 seconds could be specified as:

    LIMIT '4,10'   OR   LIMIT '4,000-00:00:10'
  • A value of 0 for count and interval indicates that no processing limit should be applied. If count or interval are 0, both count and interval must be 0, and the lmtactn value omitted. If count and interval are non-zero, the alternate action lmtactn may be specified. The action lmtactn is only processed once if the limit condition is encountered within an interval.
Note: If the LIMIT operand is omitted, the default count and interval are obtained from the DEFOPTN command, EMONLIM operand.
SYSGRP groupid
Specifies that this rule is only applicable for systems where the local system name is in the group named groupid.
EXSYSGRP groupid
Specifies that this rule is only applicable for systems where the local system name is not in the group named groupid.
SUPNEXT lines
Suppresses the specified number of output lines from each user's console affected by this rule. The suppressed lines begin with the line following the line that triggered this rule. The value for lines can be from 0 to 999999. If lines are already suppressed for the affected user's console, the number of remaining suppressed lines will be changed to lines. If SUPNEXT is not specified on a triggered rule, the default is not to change the line suppression count for the affected user's console.
MASKNEXT lines
Masks the specified number of lines in the Operations Manager log coming from each user's console affected by this rule. The masked lines begin with the line following the line that triggered this rule. The value for lines can be from 0 to 999999. If lines are already masked for the affected user's console, the number of remaining masked lines will be changed to lines. If MASKNEXT is not specified on a triggered rule, the default is not to change the line mask count for the affected user's console.
PARM parm
Specifies the parameter or list of parameters that are passed to the ACTION when it is scheduled to run. The value(s) may be entered as parm, but must be enclosed in quotation marks ('parm') if there is more than one blank-delimited value. The DEFACTN command can use the parameter through the &p substitution variable. The parameter is also available to any chained action routine that is defined in the NEXTACTN operand on the DEFACTN command.
USER userid
Specifies this rule is only applicable for messages from the specified userid. Wildcard characters are not supported.
GROUP groupid
Specifies this rule is only applicable for messages from users in the group named groupid.
EXUSER userid
Specifies this rule is only applicable for messages NOT from userid. Wildcard characters are not supported.
EXGROUP groupid
Specifies this rule is only applicable for messages NOT from users in the group named groupid.
FINAL Y|N
Specifies if this is the final rule to process for the current message if the ACTION was scheduled. The default value is FINAL N, which indicates that rule processing continues for this message. FINAL Y indicates there will be no further rule processing for this message.