Basic Commands

This is a list of basic commands, when to use them, and their syntax.

ACTION

To perform an action when a pattern matches a message. See B.3.2 for syntax.

CONSTRAINT

To add conditional logic to the pattern matching process:

CONSTRAINT expression

CREATE

To create a member of a variable group:

CREATE variable-group-name:member-name

DEFAULT

To specify the initial value of a user-defined variable or variable group:

DEFAULT default-value

DEFINE

To begin a pattern definition:

DEFINE "group-name" [pattern-number]

To begin a variable or variable group definition:

DEFINE VARIABLE [GROUP] "variable-name"

DELIMITERS

To specify a delimiter set or delimiter list for tokenizing messages:

DELIMITERS delimiter-spec

DESTROY

To delete one member of a variable group:

DESTROY variable-group-name:member-name

To delete all members of a variable group:

DESTROY variable-group-name:_ALL

ELSE

To continue a conditional construct: Specify actions that are executed if the condition specified in the previous IF and ELSEIF expressions are false:

ELSE   [action]...

ELSEIF

To continue a conditional construct: Specify an expression that is evaluated if the condition in the preceding IF and ELSEIF expressions are false, and actions to take if the condition of this ELSEIF expression is true:

ELSEIF expression
  [action]...

END

To end a pattern definition or variable definition:

END

ENDIF

To end a conditional construct:

ENDIF

To begin a conditional construct, by specifying a condition that is evaluated, and actions to take if this condition is true:

IF expression 
   [action]...

INSTANCE

To define the message instance that you want a pattern to match:

INSTANCE [PRIMARY | ECHO | ANY-INSTANCE]

MESSAGE

To define the message text you want a pattern to match:

MESSAGE "message-text"

OMIT

To prevent the preceding pattern or variable definition from being included in the compiled database:

OMIT

PRIORITY

To set a numeric value as the priority for matching messages to standard patterns with the same keyword token or to nonstandard patterns:

PRIORITY integer

REMOVE

To remove one or more patterns from the run-time autoaction database:

REMOVE "group-name" {pattern-number ) ALL}

RESET

To reset the value of a variable to its default value:

RESET variable-name

To reset the value of a member of a variable group to its default value:

RESET variable-group-name:member-name

SET

To set the value of a user-defined variable:

SET variable-name = expression

To set the value of a member of a variable group:

SET variable-group-name:member-name = expression

TIMEOUT

To specify the amount of time that must elapse after a SET or RESET command before the value of the variable being defined is reset to its default value:

TIMEOUT timeout-value [<SECONDS> ) MINUTES]

TOKEN

To define a pattern token as one of the following types:

KEYWORD
FIXED
MASKED
[SP-AMS]
HOSTID
[CP-AMS]
RUNID

TOKEN [token-type] token-position ["token-text"]

TYPE

To specify

The type of the pattern being defined
- Test pattern
- Match the pattern to messages with a variable number of tokens

TYPE [message-type] [sender-type] [TEST] [VARIABLE-LENGTH]

where:

message-type is one of the following:

OTHER
[CP-AMS]
READ-AND-REPLY
[CP-AMS]
CONTINUOUS-DISPLAY

sender-type is one of the following:

ANY-SENDER
[CP-AMS]
PRIVILEGE-EXEC
[CP-AMS]
NON-PRIVILEGED

The type of the variable or variable group being defined
- Specify the data type of the variable: integer or string
- Specify a variable that is retained when a new database is activated
```
TYPE  [<STRING> │ INTEGER]  [RETAINED]
```