Host Environment Commands › ADDRESS USS Commands › API Keywords

API Keywords

This section discusses the keywords for the Application Programming Interface (API).

ATTRIBUTE

Specifies the video attributes of the message in the CA Event Manager console display.

• BLINK-Causes the message to blink on and off
• REVERSE-Causes the message to appear against a highlighted background

Default: None

CATEGORY

Categorizes the message event using a string of 1 to 255 characters.

Default: UNIAPI

COLOR

Specifies the color of the message in the CA Event Manager console display. Valid values are red, green, yellow, orange, blue, pink, and purple.

cmd text

Specifies a 1- to 2048-character UNIX command in mixed case that is valid for a UNIX shell environment.

command text

Specifies a 1- to 255-character string of command text for the CA Event Manager in mixed case.

DEVICE

Specifies a string of 1 to 255 characters that associates an SNMP trap message with a particular device.

Default: None

INVISIBLE

Causes the message not to appear on the CA Event Manager console display. The message is still retained in the CA Event Manager log file.

Default: The message displays

HILITE

Causes the message to be highlighted on the CA Event Manager console display.

Default: Normal intensity

KEEP

Indicates that the message should be placed in the held message area of the CA Event Manger console display until the message is acknowledged.

Default: The message displays in the normal message area.

LITE

Indicates that PING should only test the connectivity to the target node, without sending a test message to the CA Event Manager on the target system.

LOGONLY

Skips the CA Event Manager action processing for the message. This means that the message cannot be automated by CA Event Manager rules; however, it can still be automated by CA OPS/MVS USS rules.

Default: Event Manager action processing proceeds

match text

Contains the 1- to 255-character string that is the exact message text of the message that is to be DOMd when the message number is not supplied. Generic matching of the remainder of the text is implied when an asterisk * appears as the last character of the match text.

MSGNUM

Assigns an arbitrary positive fullword integer to the message for identification purposes (such as 1302 in the OPS1302E message). When used with the DOM verb, the number for the message is the CA Event Manager log record number, which is acknowledged and removed from the held display area. The log record number can only be obtained from the detail message display of the CA Event Manager console.

Default: None

TEXT

Specifies a 1- to 255-character string of message text in mixed case.

NODE

Specifies a string of 1 to 64 characters that designates the target node for the API function. The TCP/IP host name of the target system is required for all API functions that are not directed to the local system.

Default: The local node name

TAG

Specifies a string of 1 to 255 characters that records the type of platform that generated the message. When this operand is omitted, default values are supplied for each platform type that runs Unicenter.

Default:

• OS390 (for CCS for z/OS)
• WNT (for the Windows NT framework)

PROCESS

Specifies a string of 1 to 255 characters that records the USS process ID and program data of the issuer of the message. The required format is: nnnnn,data

Notes:

• nnnnn is a numeric value (usually the USS process number). If this value is omitted, you must still supply the comma.
• data is an arbitrary string of characters, such as a program name.

Default: process ID, program name

reply number

Specifies the reply number that appears between the parentheses at the front of a WTOR message event.

For example, the number 12 is required for the REPLY verb to reply to the correct WTOR. When used with the DOM verb and when the REPLY ID is specified, the reply number is prefixed to the matching message text. This causes the correct WTOR to be acknowledged and removed from the held display area of the console of CA Event Manager. The REPLY ID can be omitted if the matching text already contains the REPLY ID.

Default: None

reply text

Specifies a 1- to 255-character string that replies to an outstanding CA Event Manager WTOR.

SEVERITY

Provides an indicator of the type and severity of the message.

Values are:

I = Informational

E = Error

F = Failure

S = Success

W = Warning

Default: None

SOURCE

Identifies the application that generated the event using a string of 1 to 255 characters.

Default: The CA OPS/MVS subsystem name (OPSS)

USERDATA

Specifies a string of 1 to 255 characters that may be used as desired. This field may contain additional data that further explains the meaning of the message text.

USERID

Identifies the user who generated the event using a string of 1 to 32 characters. For CCS for z/OS, this is the security package user ID. For Windows, this is the Domain\User who created the event.

Default: Security package user ID

WORKSTATION

Specifies the name of the workstation using a string of 1 to 255 characters. This field is primarily used by the CA Workload Management application.

Default: None