Previous Topic: Hardware Event API RulesNext Topic: Event ID, Associated Entity and Description Table


OPS/REXX Rule Variables For Hardware Events

All variables listed below are available for all event types. However, some variables are not applicable for all events. If a variable represents event data that is not applicable for a particular event, the variable will have a zero length for that event.

API.ALARMMSGFLG
Description

Indicates alarm message.

Data Type

Character, read-only, 1 character.

Values
0

Not an alarm message.

1

Alarm message.

Example

0

Applicable events

HWSOSMSG

API.APPLICATION
Description

Name of application providing the event.

Data Type

Character, read-only, up to 8 characters.

Values

Application name

Example

HIS

Note: HIS is the Hardware Interface Service

Applicable events

All events

API.CAPCHVAL
Description

Capacity change value.

Data Type

Character, read-only, up to 10 characters.

Values

Capacity change value.

Example

2

Applicable events

HWSCAPCHG

Capacity Change Values
0

FENCED_BOOK

1

DEFECTIVE_PROCESSOR

2

CONCURRENT_BOOK_REPLACE

3

CONCURRENT_BOOK_ADD

4

CHECK_STOP

5

CHANGES_ALLOWED

6

CHANGES_NOT_ALLOWED

API.CAPRECVL
Description

Capacity record value.

Data Type

Character, read-only, up to 10 characters.

Values

Capacity record value

Example

3

Applicable events

HWSCAPREC

Capacity Record Values
0

RECORD_ADD

1

RECORD_DELTA

2

RECORD_DELETE

3

RECORD_ACCOUNTING

4

ACTIVATION_LEVEL

5

PRIORITY_PENDING

6

RECORD_OTHER

API.CMDLASTFLG
Description

Indicates command last.

Data Type

Character, read-only, 1 character.

Values
0

Flag is off.

1

Flag is on.

Example

0

Applicable events

HWSCMDRESP

API.CMDRC
Description

Command return code.

Data Type

Character, read-only, up to 10 characters.

Values

Return Code

Example

12

Applicable events

HWSCMDRESP

API.CMDTYPE
Description

Command type.

Data Type

Character, read-only, up to 10 characters

Values

Command type

Example

5

Applicable events

HWSCMDRESP

API.DWPARTID
Description

Disabled wait partition ID.

Data Type

Character, read-only, up to 10 characters

Values

Partition ID

Example

4

Applicable events

HWSDBLWAIT

API.DWPROCNUM
Description

Disabaled wait processor number

Data Type

Character, read-only, up to 10 characters

Values

Processor number

Example

1

Applicable events

HWSDBLWAIT

API.DWPSW
Description

Disabled wait PSW.

Data Type

Character, read-only, up to 32 characters.

Values

PSW

Example

00020000000000000000000000009003

Applicable events

HWSDBLWAIT

API.DWSERIALNO
Description

Disabled wait serial number.

Data Type

Character, read-only, up to 16 characters

Values

Serial number

Example

00001316F574

Applicable events

HWSDBLWAIT

The variables API.NUMENTRIES, API.ELEVELx, API.ETYPEx, and API.ENAMEx describe the hierarchy of entities for an event. For each entity related event, the entity level, type and name are returned for the entity directly related to the event. In addition, the entity level, type and name are returned for each entity in the event entity hierarchy. That is, the level, type and name are returned for each parent, grandparent, and any other entity of the event entity. There can be up to 10 entities defined in the entity hierarchy.

Variables API.ELEVELx, API.ETYPEx, and API.ENAMEx where x is 1 through 10 are always defined for each event.

Variable API.NUMENTRIES indicates how many entities are actually returned in the hierarchy.

API.ENAME1, APIETYPE1, and APIELEVEL1 will contain the information for the entity which is directly related to the event. Starting at API.ENAME2, API.ETYPE2, and API.ELEVEL2, the variables will contain information related to the parent, grandparent, and any other entity. The entities go up the topology hierarchy.

Example

If API.NUMENTRIES=2, two entities are returned in the hierarchy. Variables API.ELEVEL1, API.ETYPE1, API.ENAME1, API.ELEVEL.2, API.ETYPE2, and API.ENAME2 will be filled in with entity information.

Variables API.ELEVELx, API.ETYPEx, and API.ENAMEx where x is 3-10 will have a zero length.

API.ELEVELx
Description

Level of entity in the returned entity hierarchy.

Data Type

Character, read-only, up to 10 characters.

Values

Level of entity in the hierarchy

Example

3

Applicable events

Entity related events

API.ENAMEx
Description

Name of entity in the returned entity hierarchy

Data Type

Character, read-only, up to 32 characters.

Values

Name of entity

Example

IBM500EX.SY01

Applicable events

Entity related events

API.ETYPEx
Description

Type of entity in the returned entity hierarchy.

Data Type

Character, read-only, up to 10 characters.

Values

Entity type values:

1

Enterprise or Root

5

Installation or Data Center

10

Ensemble

12

Machine

15

CPC

16

zBX

20

LPAR

21

Capacity Record

22

Reset Activation Profile

23

Image Activation Profile

24

Load Activation Profile

30

Sysplex

31

System

32

Coupling Facility

Example

15

Applicable events

Entity related events

API.EVDATE
Description

Event date.

Data Type

Character, read-only, 10 characters.

Values

Format: YYYY/MM/DD

Example

2011/04/01

Applicable events

All events.

API.EVDESC
Description

Event description.

Data Type

Character, read-only, up to 60 characters.

Values

Each event has its own description. See the values listed with individual events in the Event ID, Associated Entity, and Description Table below.

Example:

ENTITY STATUS CHANGE

Applicable events

All events.

API.EVLEVEL
Description

Entity hierarchy level.

Data Type

Character, read only, up to 10 characters.

Values

0 for system related event, otherwise level of event entity in hierarchy.

Example

6

Applicable events

All events

API.EVTIME
Description

Event time

Data Type

Character, read-only, up to 11 characters.

Values

Format: HH:MM:SS.TH

Example

10:53:56.97

Applicable events

All events

API.EXCSTATE
Description

Exception State.

Data Type

Character, read-only, 1 character.

Value
0

Not exception state

1

Exception state

Example

0

Applicable events

HWSENTEXC

API.HELDMSGFLG
Description

Indicates held message

Data Type

Character, read-only, 1 character

Values
0

Not a held message

1

Held message

Example

0

Applicable events

HWSOSMSG

API.HWIFNAME
Description

Hardware I/F name. This is the name of the underlying hardware interface being used by the application in API.APPLICATION.

Data Type

Character, read-only, up to 16 characters.

Values

Name of underlying interface.

Example

BCPII

Applicable events

HWSINTFUP, HWSINTFDWN

API.ID
Description

Name of the event.

Data Type

Character, read-only, up to 10 characters.

Values

Each event has its own event ID. The event ID is the value used to match API rules. See the values listed with individual events in the Event ID, Associated Entity, and Description Table below. All event IDs start with the HWS prefix.

Example

HWSSTATCHG

Applicable events

All events.

API.IMGLIST
Description

Image List

Data Type

Character, read-only, up to 32000 characters.

Values

List of images

Example

TS03 TS12 TS22 TS30 COUPLEA1 COUPLEA2

Applicable events

HWSHWMSG, HWSHWMSGD

API.ITOPIP
Description

Indicates event was issued while topology initialization was in progress by application in API.APPLICATION.

Data Type

Character, read-only, 1 character.

Values
0

Topology initialization not in progress when event issued

1

Topology initialization was in progress when event issued

Example

0

Applicable events

HWSNEWCHLD, HWSNEWENT

API.LEVEL
Description

Reserved for future use.

Data Type

Character, read-only, up to 8 characters.

Values

Text indicating reserved field.

Example

RESERVED

Applicable events

All events.

API.MSGDATE
Description

Message Date

Data Type

Character, read-only, 8 characters.

Value

Format: YYYYMMDD

Example

20110402

Applicable events

HWSOSMSG

API.MSGID
Description

Message ID

Data Type

Character, read-only, up to 16 characters

Values

ID of message

Example

187898401

Applicable events

HWSOSMSG

API.MSGTEXT
Description

Message Text.

Data Type

Character, read-only, up to 32000 characters.

Values

Text of message. May include multiple lines separated by the EBCDIC ‘NL’ (X’15’) character. API.MTNUML specifies the number of lines and can be used in conjunction with the ‘NL’ character to parse into individual lines if desired. The ‘NL’ character is only present if there are two or more lines.

Example

The reset profile RESETSY01. was changed.

Applicable events

HWSOSMSG, HWSHWMSG, HWSSECUR

API.MSGTIME
Description

Message Time

Data Type

Character, read-only, 8 characters.

Value

Format: HHMMSSTH

Example

17015043

Applicable events

HWSOSMSG

API.MSGTS
Description

Message time stamp.

Data Type

Character, read-only, up to 32000 characters.

Values

Time stamp

Example

03-28-2011 16:14:03:806

Applicable events

HWSHWMSG, HWSSECUR

API.MTNUML
Description

Number of lines in API.MSGTEXT.

Data Type

Character, read-only, up to 10 characters.

Values

0 if no message text is included with the event, 1 or more if message text is included.

Example

2

Applicable events

HWSHWMSG, HWSOSMSG, HWSSECUR

API.NEWETYPE
Description

New entity type.

Data Type

Character, read-only, up to 10 characters.

Values

See Values under API.ETYPEx

Example

15

Applicable events

HWSNEWCHLD, HWSNEWENT

API.NEWMSGFLG
Description

Indicates new message.

Data Type

Character, read-only, 1 character.

Values
0

Not a new message.

1

New message.

Example

0

Applicable events

HWSOSMSG, HWSHWMSG

API.NEWNAME
Description

New name.

Data Type

Character, read-only, up to 32 characters.

Values

Name

Example

SY03

Applicable events

HWSNEWCHLD, HWSNEWENT, HWSACTPCHG

API.NEWPMV
Description

New power mode value.

Data Type

Character, read-only, up to 10 characters.

Values

Power mode value

Example

4

Applicable events

HWSPOWCHG

API.NEWPSMA
Description

New power save mode allowed.

Data Type

Character, read-only, up to 10 characters

Values

Power mode allowed.

Example

3

Applicable events

HWSPOWCHG

API.NEWSTATUS
Description

New status value.

Data Type

4 byte binary (unprintable), read-only.

Values

See Status Values.

Example

'00000002'X

Applicable events

HWSSTATCHG

Status Values
'00000001'X

OPERATING

'00000002'X

NOT_OPERATING

'00000004'X

NO_POWER

'00000008'X

NOT ACTIVATED

'00000010'X

EXCEPTIONS

'00000020'X

STATUS_CHECK

'00000040'X

SERVICE

'00000080'X

LINKNOTACTIVE

'00000100'X

POWERSAVE

'00000200'X

SERIOUSALERT

'00000400'X

ALERT

'00000800'X

ENVALERT

'00001000'X

SERVICE_REQ

'00002000'X

DEGRADED

'01000000'X

STORAGE_EXCEEDED

'02000000'X

LOGOFF_TIMEOUT

'04000000'X

FORCED_SLEEP

'08000000'X

IMAGE_NOT_OPERATING

'10000000'X

IMAGE_NOT_ACTIVATED

'20000000'X

IMAGE_NOT_CAPABLE

API.NUMENTRIES
Description

Number of entries for entity hierarchy.

Data Type

Character, read-only, up to 10 characters.

Values

A number between 0 and 10.

Example

4

Applicable events

All events, but generally 0 for system related events.

API.OLDNAME
Description

Old/prior name.

Data Type

Character, read-only, up to 32 characters.

Values

Name

Example

COUPLEA1

Applicable events

HWSACTPCHG

API.OLDPMV
Description

Old power mode value.

Data Type

Character, read-only, up to 10 characters.

Values

Power mode value.

Example

5

Applicable events

HWSPOWCHG

API.OLDPSMA
Description

Old power save mode allowed.

Data Type

Character, read-only, up to 10 characters.

Values

Power mode allowed.

Example

6

Applicable events

HWSPOWCHG

API.OLDSTATUS
Description

Old/prior status value.

Data Type

4 byte binary (unprintable), read-only.

Values

See Status Values

Example

'00000004'X

Applicable events

HWSSTATCHG

API.OPSSSNA
Description

Name of CA OPS/MVS subsystem receiving the event.

Data Type

Character, read-only, 4 characters.

Value

CA OPS/MVS subsystem name.

Example

OPSS

Applicable Events

All events.

API.OSNAME
Description

Operating system instance name.

Data Type

Character, read-only, up to 16 characters.

Values

Name of the operating system.

Example

SY11

Applicable events

HWSOSMSG

API.PERMHWEFLG
Description

Indicates permanent hardware error.

Data Type

Character, read-only, 1 character.

Values
0

Not permanent error (temporary error).

1

Permanent error

Example

1

Applicable events

HWSHWCOMER

API.PRMPT
Description

Prompt text.

Data Type

Character, read-only, up to 32,000.

Values

Text of prompt

Example

NULL

Applicable events

HWSOSMSG

API.PRTYMSGFLG
Description

Indicates priority message.

Data Type

Character, read-only, 1 character.

Values
0

Not a priority message.

1

Priority message.

Example

0

Applicable events

HWSOSMSG

API.SYSTEMFLG
Description:

Indicates system or entity related event.

Data Type

Character, read only, 1 character.

Values
0

Entity related event.

1

System related event.

Example

0

Applicable events

All events.

API.TEXT
Description

Text for event.

Data Type

Character, read-only, up to 128 characters.

Values

Order of text fields:

Example

HWSSECUR SECURITY EVENT CPC IBM500EX.SY01 The reset profile RESETSY01. was changed.

Applicable events

All events.

API.VERSION
Description

Version of application identified in API.APPLICATION.

Data Type

Character, read-only , up to 8 characters.

Values

For application HIS (Hardware Interface Service) the version is in the form VV.MM.RR.

Example

01.00.09

Note: This is example in the format used by the HIS application.

Applicable events

All events.