AOF Variables Available in an ARM Rule

Coding Each AOF Rule Type › Automatic Restart Management Rules › AOF Variables Available in an ARM Rule

AOF Variables Available in an ARM Rule

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

ARM.CLONEID

Specifies the z/OS sysplex clone ID of the system on which the job originally registered with ARM.

Data Type: 2-byte character, read-only

Sample Value: 02

ARM.COLOR

Specifies the color that the ARM event message text will use in OPSLOG Browse.

Data Type: 1-byte binary (unprintable), read/write

Sample Value: '00'X

Notes:

Use the OPSCOLOR function of OPS/REXX to set the ARM.COLOR variable.
If multiple rules set ARM.COLOR for a single ARM message, CA OPS/MVS uses only the last value. To trace the color set by each rule, set the RULETRACE parameter to ON.
For a description of the RULETRACE parameter, see the Parameter Reference.

OPSLOG Browse Column: COLOR

ARM.ELEMENT

Specifies the ARM element name of the job or started task that is being restarted. ARM element names are unique across a sysplex. The first 10 characters of the element name are also in the OPSLOG MSGID field.

Data Type: 1 to 16-byte character, read-only

Sample Value: OPSMVSSYSA

OPSLOG Browse Column: Text is always displayed

ARM.ELEMTYPE

Specifies the ARM element type, which is used in the ARM policy to define restart characteristics for groups of related resources so that individual definitions are not required for every element.

Data Type: 0 to 8 characters, read-only

Sample Value: OPSMVS

OPSLOG Browse Column: TERMNAME

ARM.EVENTCODE

Specifies a code value that represents the reason that ARM restarted the job.

Data Type: 2-byte binary (unprintable), read-only

Possible Values:

1 (the restart was caused by the termination of the element)
2 (the restart was caused by the termination of the system)

Sample Value: 1

ARM.FROMSYS

Specifies the z/OS system name of the system on which the job was last executed.

Data Type: 1- to 8-byte character, read-only

Sample Value: SYS03

OPSLOG Browse Column: DSPNAME

ARM.HOMESYS

Specifies the z/OS system name of the system on which the job originally registered with ARM.

Data Type: 1- to 8-byte character, read-only

Sample Value: SYS02

ARM.JCLDSN

Specifies the name of the data set that contains the JCL that will be submitted to restart the job.

Data Type: 0 to 44 characters, read/write

Sample Value: USER.CNTL

Note: If this value is changed, the ARM.RESTARTTYPE variable must be set to 4. If the JCL requires system variable substitution, variable values from the home system will be used.

ARM.JCLMEM

Specifies the PDS member name of the data set name specified in ARM.JCLDSN, which contains the JCL that will be used to restart the job. If the data set is not a PDS, the value of this variable will be null.

Data Type: 0 to 8 characters, read/write

Sample Value: USERJOB

ARM.JOBNAME

Specifies the job name of the ARM element that is being restarted.

Data Type: 1- to 8-byte character, read-only

Sample Value: OPSMAIN

OPSLOG Browse Column: JOBNAME

ARM.PERSISTJCL

Specifies a value indicating whether persistent JCL is available for the restart of the job.

Data Type: Integer, read-only

Possible Values: 0 (persistent JCL is not available) or 1 (persistent JCL is available)

Sample Value: 0

ARM.POLICYSTART

Specifies a value indicating whether the start command text for a restart that is being performed using a start command (ARM.RESTARTTYPE=2) is from the ARM policy definition or a system-entered start command (persistent text).

Data Type: Integer, read-only

Possible Values:

0-start text is persistent
1-start text is from ARM policy

Sample Value: 1

ARM.RESTARTTYPE

Specifies a value indicating the type of restart to be performed.

Data Type: 1-byte binary, read/write

Possible Values:

1-Do not restart this job (same as RETURN 'SUPPRESS')
2-Restart this started task using the start text value in ARM.STARTTEXT
3-Restart this job using the persistent JCL
4-Restart this job using the override JCL specified in ARM.JCLDSN and ARM.JCLMEM

Sample Value: 1

ARM.STARTTEXT

Specifies the text of the z/OS start command that will be issued to restart the job. This may be the original start command text, command text from the ARM policy couple data set, or an override value from an AOF ARM rule.

Data Type: 0 to 126 characters, read/write

Sample Value: START USERJOB, PARM='RESTART'

Note: If this value is changed, the variable ARM.RESTARTTYPE must be set to 2. If the text requires system variable substitution, variable values from the home system will be used.

ARM.TEXT

Specifies the message text generated for this ARM AOF event. The text is constant except for the last word, which is the ARM element name.

Data Type: Character, read-only

Sample Value: MVS ARM RESTART OF OPSMVSSYSA

OPSLOG Browse Column: Text is always displayed

ARM.TOSYS

Specifies the current z/OS system name on which the job is being restarted

Data Type: 1- to 8-byte character, read-only

Sample Value: SYS03

OPSLOG Browse Column: SYSNAME

ARM.USER

Contains an 8-byte variable providing communication between rules that execute for the same ARM 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 ARM event; each rule can look at or change the variable contents before passing the variable to the next rule for the ARM 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

More information:

AOF Rule Tools