Job Management Partner 1/Integrated Management - Manager GUI Reference

2.25.1 Action Parameter Detailed Definitions window

The Action Parameter Detailed Definitions window has two pages: Action Condition and Execution Monitoring.

Organization of this subsection

(1) Action Condition page

(2) Execution Monitoring page

(1) Action Condition page

The following figure shows an example of the Action Condition page:

Figure 2-30 Action Parameter Detailed Definitions window (Action Condition page)

When linkage with JP1/IM - Rule Operation is enabled, the Type area is added under Action Definition in the Action Parameter Detailed Definitions window, as shown in the following figure.

Figure 2-31 Action Parameter Detailed Definitions window (when linkage with JP1/IM - Rule Operation is enabled)

The following describes the items displayed in the Action Parameter Detailed Definitions window.

Parameter group

Specifies the parameter group. A one-digit number from 0 to 9 or an ampersand (&), which indicates the AND condition, can be specified.

Action name

Specifies the action name. Strings of 1 to 50 bytes can be specified. Specifiable characters are characters other than the control characters (0x00 to 0x1F, 0x7F to 0x9F). Action n appears if the Action Parameter Detailed Definitions window is displayed by clicking the Apply button in the Action Parameter Definitions window. For n, the system selects the smallest available numeric value from 1 to 1,000 to create a name that does not duplicate an existing action name.

The action name cannot be omitted. Note, however, that if the user specifies & for Parameter group, an action name cannot be specified.

Comment

The user can specify a comment for the automated action definition by specifying a string of no more than 1,040 bytes. Specifying a comment is optional.

The following describes the items displayed on the Action Condition page.

Event ID

Specifies a specific event ID or all event IDs for use as a condition for executing the automated action.

To specify a specific event ID, the user selects the Specify ID radio button, and then enters the event ID in the text box. The event ID consists of a basic part and an extended part. Each part is a hexadecimal number of not more than 8 bytes. Specifiable values are from 0 to 7FFFFFFF. The two parts are separated by a colon (:). The extended part can be omitted.

To specify all event IDs, the user selects the All IDs radio button.

Read From Selected Event

Clicking this button automatically enters an event condition by using the attribute value of the JP1 event selected from the event list. This button is available only if the user selects one JP1 event from the event list displayed when the Action Parameter Detailed Definitions window opens. The event conditions specified before the Read From Selected Event button is clicked are deleted. If the JP1 event selected in the event list scrolls out of the list, no condition is entered.

Event conditions list

This area displays the event conditions.

The attribute name of an event condition is displayed in the Attribute name column. If the user specifies a specific extended attribute as the event condition, E. is prefixed to the attribute name, as in E.SEVERITY.

The attribute value is displayed in the Attribute value column. If multiple attribute values are specified, the values must be separated with a comma (,).

The Condition column displays the condition Match, Does not match, Is contained, Is not contained, First characters, or Regular expression for event condition comparison.

Add

Clicking this button allows the user to add a new event condition. When this button is clicked, an event condition that has not been set is added at the bottom of the event condition list. A maximum of 256 event conditions can be added.

Delete

Clicking this button deletes a selected event condition.

Up

Clicking this button moves the selected event condition up one line. Because event conditions are evaluated from the top of the list, the event conditions must be sorted in the order of priority.

Down

Clicking this button moves the selected event condition down one line. Because event conditions are evaluated from the top of the list, the event conditions must be sorted in the order of priority.

Area for editing event conditions

This area allows the user to edit event conditions. The area that is displayed differs according to the attribute that is selected. Each area is described below.

Event ID editing

The area shown above is displayed for the following attribute:

Event ID

A character string that is no more than 8 hexadecimal digits or no more than 4,096 bytes can be specified. Control characters cannot be specified.

The specifiable range for a hexadecimal string is from 0 to 7FFFFFFF.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

A maximum of 100 event IDs, separated by a comma (,), can be specified. Note, however, that if Regular expression is selected from the drop-down list, multiple event IDs cannot be specified.

From the drop-down list on the right, the user selects a condition for the specified event ID from Match, Does not match, and Regular expression.

Numeric value editing

The area shown above is displayed for the following attributes:

Registered reason

Source process ID

Source user ID

Source group ID

A decimal integer that is no more than 4,096 bytes can be specified. The range of specifiable values is from -2,147,483,648 to 2,147,483,648.

A maximum of 100 numeric values, separated by a comma (,), can be specified. Note, however, that if Regular expression is selected from the drop-down list, multiple event IDs cannot be specified.

From the drop-down list, the user selects a condition for the specified character string from Match, Does not match, and Regular expression.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

If the user selects either Match or Does not match, only an integer from 0 to 9 or a hyphen (-) can be specified.

Date and time editing

The area shown above is displayed for the following attributes:

Registered timeframe

Arrived timeframe

A value of no more than 4,096 bytes in YYYYMMDDhhmmss format can be specified.

Multiple dates and times cannot be specified.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

From the drop-down list on the right, the user can select only Regular expression as the condition for the specified date and time.

Character string editing

The area shown above is displayed for the following attributes:

Source user name

Source group name

Source IP address

Source host

Message

Product name

Object name

Root object name

Object ID

Occurrence

User name

Return code

A character string of no more than 4,096 bytes can be specified.

A maximum of 100 character strings, separated by a comma (,), can be specified. Note, however, that if Regular expression is selected from the drop-down list, multiple character strings cannot be specified.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

From the drop-down list on the right, the user selects a condition for the specified character string from First characters, Match, Does not match, Is contained, Is not contained, and Regular expression.

Editing of character strings with input candidates

The area shown above is displayed for the following attributes:

Object type

Root object type

A character string of no more than 4,096 bytes can be specified.

A maximum of 100 character strings, separated by a comma (,), can be specified. Note, however, that if Regular expression is selected from the drop-down list, multiple character strings cannot be specified.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

From the drop-down list on the right, the user selects a condition for the specified character string from Match, Does not match, Is contained, Is not contained, and Regular expression.

Total number of seconds editing

The area shown above is displayed for the following attributes:

Start time

End time

A numeric value of no more than 4,096 bytes can be specified.

Multiple numeric values cannot be specified.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

From the drop-down list on the right, the user can select only Regular expression as the condition for the specified total number of seconds.

Severity-level editing

The area shown above is displayed for the following attribute:

Severity

To specify the severity by selecting a condition, the user selects the Specify directly radio button and then selects the check boxes for the desired severity levels from Emergency, Warning, Critical, Error, Warning, Notice, Information, and Debug.

To specify the condition for the severity level as a regular expression, select the Specify regular expression radio button, and enter the condition. The character string specified as the condition must be no more than 4,096 bytes.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

Extended-attribute editing

The area shown above is displayed for the following attribute:

Extended attribute

The name specified in the Attribute name text box must be no more than 32 bytes of upper-case alphabetic characters, numeric characters, and underscores (_). The attribute name must begin with an upper-case alphabetic character.

The condition the user specifies in the Condition text box must be a character string of no more than 4,096 bytes.

A maximum of 100 character strings, separated by a comma (,), can be specified. Note, however, that if Regular expression is selected from the drop-down list, multiple character strings cannot be specified.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

From the drop-down list on the right, the user selects a condition for the specified character string from First characters, Match, Does not match, Is contained, Is not contained, and Regular expression.

Compatibility editing

The area shown above is displayed for the following attributes:

Detailed event information

Basic event information

A character string of no more than 4,096 bytes can be specified.

If a character string that includes a comma (,) or backslash (\) is specified, a backslash (\) must be added before the comma (\,) or backslash (\\). Each character is a one-byte character.

From the drop-down list on the right, the user can select only Regular expression as the condition for the specified character string.

Type

Specifies the type of the action to be executed. The Type area is displayed only if linkage with JP1/IM - Rule Operation has been set up.

Command: A command is executed.

Rule: A condition for notifying JP1/IM - Rule Operation of a rule startup request is set. When Rule is selected, <RULE> is always specified in the Action area, and the Execution user name, Target host, and Environment variable file text boxes are disabled and uneditable.

For details about setting up linkage with JP1/IM - Rule Operation, see 8.1.1 Settings for enabling the JP1/IM - Rule Operation linkage function in the Job Management Partner 1/Integrated Management - Manager Configuration Guide.

Execution user name

Specifies the JP1 user name under which the action is to be executed. The JP1 user name specified must be no more than 31 bytes and must not include a space character.

In addition, a variable can be used to specify attribute information of the received JP1 event. For example, to execute an action under the name of the user that issued an event, the user specifies $EVUSR. For details about variables that can be specified, see Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window.

Target host

Specifies the name of the host on which the action is to be executed. The specified host name must not be more than 255 bytes, must not include a space character, and must be the name of a managed host defined in the system configuration definition.

A host group name can also be specified. If specified, it must be defined in the host group definition file.

In addition, a variable can be used to specify attribute information of the received JP1 event. For example, $EVHOST can be specified to execute the action on the host from which the event was issued. For details about variables that can be specified, see Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window.

Action

Specifies the command to be executed as an action. The command line specified in this area can include variables that indicate attribute information of the received JP1 event.

For details about variables that can be specified, see Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window.

Note that the specified command line must not end with a backslash (\).

For details about commands that can be specified, see 5. Command Execution by Automated Action in the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide.

The maximum length of a command that can be executed as an action is 4,096 bytes. If the length of the command, including variables (such as $EVMSG) that can be used to define the action, exceeds 4,096 bytes, the command is not executed, and the status of the action becomes Fail. In the Message area of the Action Log Details window, the following message is displayed:

KAVB4421-W Cannot execute action because command line is too long.

If an action contains an unrecognizable character code (anything outside the ASCII character set), the action is not executed because of the shell or other specifications on the target host, or if executed, the results might be incorrect. In this case, the action does not fail, and its status becomes Ended. Invalid codes can also result when variables are replaced by their values at runtime. For the values that replace variables, check the applicable manuals for the products that issue JP1 events ahead of time.

Note:

The maximum length of a command that can be executed as an action depends on the system that runs JP1/IM and JP1/Base.

If JP1/IM or JP1/Base of version 6 or 7 is installed on the hosts via which an automatic action is executed, the command must be 1,024 bytes or less. These hosts include the host from which the command is entered as well as the host on which the command is executed. For details, see 11.4(2) Notes in the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide.

Environment variable file

Specifies the full path name of the environment variable file saved on the host on which the command is executed. The maximum length of the specified full path name is 255 bytes.

The full path name can include variables that indicate attribute information of the received JP1 event. For details about the variables that can be specified, see Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window.

Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window

Variables can be used to specify the information contained in a JP1 event in the Action Definition area of the Action Parameter Detailed Definitions window for items such as Execution user name, Target host, Action, and Environment variable file. The variables are converted to information within the JP1 event when the action is executed.

The user specifies variables for these items in a format similar to $EVID. The following table describes the variables that can be used.

Table 2-12 Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window

Type of information Variable name Description

Information contained in the JP1 event basic attribute EVBASE Overall basic event information

EVID Event ID (basic-code:extended-code)

EVDATE Event occurrence date (yyyy/mm/dd)

EVTIME Event occurrence time (hh:mm:ss)

EVPID Process ID for the event-issuing source

EVUSRID User ID for the event-issuing source

EVGRPID Group ID for the event-issuing source

EVUSR Name of the event-issuing source user

EVGRP Name of the event-issuing source group

EVHOST Name of the event-issuing source host

EVIPADDR IP address of the event-issuing source

EVSEQNO Serial number in the event database

EVARVDATE Event arrival date (yyyy/mm/dd)

EVARVTIME Event arrival time (hh:mm:ss)

EVSRCNO Serial number in the event database of the event-issuing source

EVMSG Overall message text

EVDETAIL Overall detailed event information

Information contained in the JP1 event extended attribute EVSEV Severity of extended event information (Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug)

EV"extended-attribute-name" Optional extended attribute

Other information ACTHOST Name of the manager for the action execution request source

EVENV1 to EVENV9 In the specified execution condition of an action, data pulled from within () in a regular expression
(This can only be used when an extended regular expression is used on a manager)

If a value cannot be found for a variable, the corresponding item remains blank. Note, however, that an optional extended attribute (EV"extended-attribute-name") and pulled data (EVENV1 to EVENV9) will be handled as variable names. Depending on the type of JP1 event, there might be items without variables and actions that cannot be executed because the information in each attribute contains codes not recognized as characters (anything outside the ASCII character set). In this case, the action either cannot be executed, or if executed, the execution result would be invalid. For products that issue JP1 events before the setup, see the applicable manuals.

Precautions regarding the specification of variables
When alphanumeric characters and an underscore (_) are specified immediately after a variable, conversion will not be performed properly. To ensure proper conversion, the user must enclose the variable in curly brackets ({}), as shown in the following examples. The following examples assume that the event ID ($EVID) is set to 100:0, and the extended attribute EX ($EV"EX") is set to ABC.
Example specifications
Action definition -> Converted information
$EVID abc -> 100:0 abc
$EVIDabc -> $EVIDabc (in Windows) or N/A (in UNIX)
${EVID}abc -> 100:0abc
$EVID_abc -> $EVID_abc (in Windows) or N/A (in UNIX)
${EVID}_abc -> 100:0_abc
$EV"EX" abc -> ABC abc
$EV"EX"abc -> ABCabc
If the source character information contains the following control characters, the control characters are converted to space characters (0x20) and then processed.
These control characters are 0x01 to 0x1F and 0x7F (but not the tab character (0x09)).
For example, if the message obtained by specifying $EVMSG contains a line break (0x0A), the line break (0x0A) is converted to a space character (0x20) and then processed.
As another example, when an action (echo $EVMSG) is set, and a string containing a line break, such as line-10x0Aline-2 is received as an event message, the command executed as the action is echo line-1line-2 ( represents a space character).

In UNIX, the final expansion depends on evaluation by the shell. If the expanded data contains * or another character that has a special meaning in the shell, the contents are converted. To prevent this replacement, the user must enclose the entire variable in double quotation marks ("), as, for example, "$EVMSG".

Type of information	Variable name	Description
Information contained in the JP1 event basic attribute	EVBASE	Overall basic event information
EVID	Event ID (basic-code:extended-code)
EVDATE	Event occurrence date (yyyy/mm/dd)
EVTIME	Event occurrence time (hh:mm:ss)
EVPID	Process ID for the event-issuing source
EVUSRID	User ID for the event-issuing source
EVGRPID	Group ID for the event-issuing source
EVUSR	Name of the event-issuing source user
EVGRP	Name of the event-issuing source group
EVHOST	Name of the event-issuing source host
EVIPADDR	IP address of the event-issuing source
EVSEQNO	Serial number in the event database
EVARVDATE	Event arrival date (yyyy/mm/dd)
EVARVTIME	Event arrival time (hh:mm:ss)
EVSRCNO	Serial number in the event database of the event-issuing source
EVMSG	Overall message text
EVDETAIL	Overall detailed event information
Information contained in the JP1 event extended attribute	EVSEV	Severity of extended event information (Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug)
EV"extended-attribute-name"	Optional extended attribute
Other information	ACTHOST	Name of the manager for the action execution request source
EVENV1 to EVENV9	In the specified execution condition of an action, data pulled from within () in a regular expression (This can only be used when an extended regular expression is used on a manager)

(2) Execution Monitoring page

The following figure shows an example of the Execution Monitoring page.

Figure 2-32 Action Parameter Detailed Definitions window (Execution Monitoring page)

Suppress

Specifies whether to suppress execution of the automated action.

Apply: Execution of the automated action is suppressed.
When Apply is selected, the length of time (in seconds) that the automated action is to be suppressed must be specified in the Suppression time text box. The range of specifiable values is from 1 to 3,600. The default is 300.

Do not apply: Execution of the automated action is not suppressed.
When Do not apply is selected, the Suppression time text box is disabled.

The default is Do not apply.

The Suppress area is disabled in the following cases:

An ampersand (&) is specified in the Parameter group area.

The Action name text box is blank.

Delay monitoring

Specifies whether to monitor delays in executing the automated action.

Apply: Delays in executing the action are monitored.
When Apply is selected, the length of time (in seconds) for monitoring delays must be specified in the Monitoring time text box. If the action is not completed within the specified period of time, the action is regarded as a delayed action. The range of specifiable values is from 1 to 86,400. The default is 600.

Do not apply: Delays in executing the action are not monitored.

The default is Do not apply.

When delays in executing the automated action are monitored, if the execution of an action is delayed, a JP1 event is issued or a notification command is executed to report the delay. The method of reporting the abnormal status must be specified in the automatic action notification definition file (actnotice.conf) ahead of time.

The Action Log window, the List of Action Results window, or the Action Log Details window can be used to check the action delay status. Also, the Event Console window can be used to check whether the execution of an action has been delayed.

A monitoring interval appropriate for the automated action being monitored for execution delays needs to be set.

[Contents][Back][Next]

[Trademarks]