AOF Variables Available in a CMD Rule

Coding Each AOF Rule Type › Command Rules › AOF Variables Available in a CMD Rule

AOF Variables Available in a CMD Rule

You can use all AOF variable types in CMD rules. The following unique AOF event variables are available in the )PROC section of a CMD rule. Also listed are the corresponding OPSLOG display field that you can manually interrogate as an aid in debugging or implementing rule logic.

CMD.AOFCMD

A value indicating whether CA OPS/MVS issued the current command from within an AOF rule

Data Type: Integer, read-only

Possible Values:

0-The command was not issued by a CA OPS/MVS AOF rule
1-The command was issued by a CA OPS/MVS AOF rule

Sample Value: 1

Notes:

When the value of the CMD.AOFCMD variable is 1, the value of the CMD.PRODCMD variable is also 1.
When the value of the CMD.AOFCMD variable is 1, it is most likely that the command was issued through an ADDRESS OPER host command in an AOF rule.

OPSLOG Browse Column: Second bit of OPSFLAGS when the EVENT column indicates a CMD event

CMD.CONSNAME

The name of the console from which the command was issued Data Type: Character, read-only

Sample Value: MASTSYSA

Note: For commands originating in the subsystem interface, CMD.CONSNAME contains the console name.

OPSLOG Browse Column: CONSNAME

CMD.IMSID

The ID of the IMS control region that issued this command, or NONE for non-IMS commands. The CMD.IMSID variable is available only if the IOF is licensed, installed, and active at your site (that is, the INITIMS parameter must be set to YES).

Data Type: Character, read-only

Sample Value: IMSA

OPSLOG Browse Column: IMSID

CMD.JES3PLEXSYN

Indicates whether the command prefix is a JES3 sysplex scope prefix. Set to 1 if the original JES3 command prefix is defined as a sysplex scope prefix (PLEXSYN).

Data Type: Character, read-only

Possible Values:

0-The prefix is not a JES3 sysplex scope prefix
1-The prefix is a JES3 sysplex scope prefix

Sample Value: 1

Note: This variable is only meaningful for JES3 commands in a JES3 environment.

OPSLOG Browse Column: Eighth bit of OPSFLAGS when the event column indicates a CMD event, and a JES command prefix was used.

CMD.JES3PREFIX

The original JES3 prefix used on the JES3 command

Data Type: Character, read-only

Possible Values: Any valid JES3 system or sysplex command prefix, which can be from 1 to 8 characters in length. With the special exception of the character 8, JES3 command prefixes cannot start with a numeric character.

Sample Value: *

Note: This variable is only meaningful for JES3 commands in a JES3 environment.

OPSLOG Browse Column: AUTOTOKN when the event column indicates a command event, and a JES command prefix is used.

CMD.JES3SYN

Indicates whether the command prefix is a JES3 system scope prefix. Set to 1 if the original JES3 command prefix is a system scope prefix (SYN).

Data Type: Character, read-only

Possible Values:

0-The prefix is not a JES3 system scope prefix
1-The prefix is a JES3 system scope prefix

Sample Value: 0

Note: This variable is only meaningful for JES3 commands in a JES3 environment.

OPSLOG Browse Column: Seventh bit of OPSFLAGS when the event column indicates a CMD event, and a JES command prefix was used.

CMD.JOBNAME

The name of the job or the TSO user who issued the command

Data Type: Character, read-only

OPSLOG Browse Column: JOBNAME

CMD.MSFID

The MSF system name of the copy of CA OPS/MVS that issued the command

Data Type: Character, read-only

Sample Value: OPSP

Note: For all commands issued from sources other than remote copies of CA OPS/MVS, the value of CMD.MSFID is the MSF ID of the local copy of CA OPS/MVS.

OPSLOG Browse Column: MSFID

CMD.ORIGINSYS

The system name from which the command originated. This variable enables you to identify the origin of commands routed to this system through the ROUTE command. CMD.ORIGINSYS can only return the correct information when the SSICMD product parameter is set to YES. When SSICMD is set to NO, this variable and the SYSNAME column in OPSLOG are set to UNKNOWN.

Data Type: Character, read-only.

Sample Value: SYSA

OPSLOG Browse Column: SYSNAME

CMD.OTEXT

The original text of the command, unmodified by subsequent rule processing

Data Type: Character, read-only

CMD.PRODCMD

A value indicating whether CA OPS/MVS issued the current command

Data Type: Integer, read-only

Possible Values: 0 (if CA OPS/MVS did not issue the command) or 1 (if CA OPS/MVS issued the command)

Sample Value: 1

Notes:

When the value of the CMD.PRODCMD variable is 1, the command was issued through either an ADDRESS OPER host command or the OPSCMD command processor.
The value of the CMD.PRODCMD variable is 1 only if the command was issued through a z/OS service. Thus, for JES3 commands this value is always 0.

OPSLOG Browse Column: First bit of OPSFLAGS when the EVENT column indicates a CMD event

CMD.SSMCMD

A value indicating whether System State Manager issued the current command

Data Type: Integer, read-only

Possible Values:

0-The command was not issued by System State Manager
1-The command was issued by System State Manager

Sample Value: 1

Notes:

When the value of the CMD.SSMCMD variable is 1, the value of the CMD.PRODCMD variable is also 1.
When the value of the CMD.SSMCMD variable is 1 and the value of SSM.AOFCMD is 1, the command was issued from a System Manager State Manager REQ rule (EVRULE or RULE action keywords).
The value of the CMD.SSMCMD variable will be 0 if the command was issued from an OSF TSO server as a result of an asynchronous System State Manager action (TSOCMD, CLIST or REXX action keywords).

OPSLOG Browse Column: Third bit of OPSFLAGS when the EVENT column indicates a CMD event

CMD.TERMNAME

The JES3 console name that submitted the current command, or the string NONE if the current JES3 command is not associated with a JES3 console

Notes:

If the command was issued from a TSO address space, the terminal name associated with the logged-on user is available in CMD.TERMNAME.
If the command was issued from CA Remote Console, the CMD.TERMNAME environmental variable contains the name of the terminal with which the RCS user logged on.

Data Type: Character, read-only

OPSLOG Browse Column: TERMNAME

CMD.TEXT

The command text as it will execute, taken from:

The MGCRTEXT field of the MGCR parameter list or the MGCETXT field of the MGCRE parameter list (z/OS or JES3 commands)
An internal IMS buffer (IMS commands)

Data Type: Character, read/write

Sample Value: 'D TS,L'

Notes:

You cannot change IMS command length, but z/OS commands can be lengthened or shortened.
z/OS and IMS always process modified command text.
If subsystems such as JES2 and JES3, DB2, and NetView receive the command text before CA OPS/MVS, the changes made by AOF CMD rules are ignored. However, these changes take effect if CA OPS/MVS gets the command first. To make sure that CA OPS/MVS processes commands prior to other subsystems, set the SSICMD parameter to YES. For a description of the SSICMD parameter, see the Parameter Reference.

OPSLOG Browse Column: Text is always displayed.

CMD.TYPE

The exit environment where the command was trapped

Data Type: Character, read-only

Possible Values:

MVS-Subsystem interface exit
JES3-JES3 IATUX18 exit
IMS-IMS AOI or command processing exit
NONE-Command was not obtained from an exit

OPSLOG Browse Column: Not applicable

CMD.USER

An 8-byte variable providing communication between rules executing for the same command event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Data Type: User-defined, read/write

Notes:

Before AOF processing, this variable is initialized to binary zeros. It is then passed to each rule that executes for the same command event. Each rule can look at or change the variable contents before passing the variable to the next rule for the command event.
The primary purpose for the USER variable is to provide a method to pass a small amount of data between the rules. This data may be binary or mixed case. The USER field may also be used for filtering in the OPSLOG. However, USER data used for OPSLOG filtering must be uppercase and displayable.

OPSLOG Browse Column: USER

CMD.USERID

The security user ID of the command issuer for the security product on your system. This value is usually the CA ACF2, CA Top Secret, or RACF user ID from the UTOKEN associated with the command. If the command was issued from CA Remote Console, this value is the user ID of the particular RCS user who issued the command.

Data Type: Character, read-only

Sample Value: TSOID01

Note: The CMD.USERID variable may contain the same value as the JOBNAME (which is typical for a TSO address space). These values need not match; for example, user IDs and the job names for batch jobs or started tasks may differ.

OPSLOG Browse Column: USERID

CMD.VERB

The command verb as CA OPS/MVS extracts it

Sample Value: DISPLAY

Data Type: Character, read-only

Notes:

The CMD.VERB value determines which command rules execute for a command event.
The variable contains the best verb found in the current command. For example, z/OS command aliases such as F for MODIFY are converted to the base verb, MODIFY. Likewise, z/OS command abbreviations and JES3 command aliases or abbreviations also revert to the base verb.
Except for $ADD, $DEL, $VS, and $TRACE, JES2 command verbs are always the first two characters of the command. For example, $D is the verb in the JES2 command $DJ1234.
In cases such as IMS commands, the command verb is the first blank delimited word of the command text.
Because the command verb is read-only, do not change it.

OPSLOG Browse Column: MSGID

CMD.XCONID

The decimal value corresponding to the 4-byte extended console ID of the console that issued the command. This field is not set for IMS commands.

Data Type: Integer, read-only

Sample Value: 16777253

Note: The XCONID column in OPSLOG displays this value as a hexadecimal value. For example, an extended console ID of 16777253 will be displayed in the XCONID column in OPSLOG as M01000025.

OPSLOG Browse Column: XCONID

More information:

AOF Rule Tools