3.33.2 Action Parameter Detailed Definitions (for compatibility) window
The Action Parameter Detailed Definitions (for compatibility) window is used to set up the automated actions for 08-01 and earlier versions of the automated action definition file. This window is displayed when the user chooses Add or Edit in the Action Parameter Definitions window. JP1/IM - View. No business group name can be used in this window. A business group name specified in this window is treated as a host name. The following figure shows an example of the Action Parameter Detailed Definitions (for compatibility) window.
|
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.
|
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 operator.
- 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. 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.
- Message
-
Specifies a regular expression that represents the message text (or a part of the message text) that is to be used as a condition for executing the automated action. The regular expression must not include any control characters used in message text. If a slash (/) is used as an ordinary character in the regular expression, it must be preceded by a backslash (\/).
Alphabetic characters are case sensitive.
For details about regular expressions, see G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.
- Basic event information
-
Specifies a regular expression that represents the basic JP1 event information to be used as a condition for executing the automated action. If a slash (/) is used as an ordinary character in the regular expression, it must be preceded by a backslash (\/). For details about regular expressions, see G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.
Alphabetic characters are case sensitive.
Basic event information is passed as the information for basic JP1 event attributes in order according to the format below. This format must be used to specify the conditions for executing actions.
event-IDΔevent-issuing-user-nameΔevent-issuing-user-IDΔ
event-issuing-group-nameΔevent-issuing-group-IDΔ
event-issuing-event-server-nameΔevent-issuing-process-IDΔ
event-registration-dateΔevent-registration-timeΔevent-issuing-host-IP-address
For details about the information included in the basic attributes for these JP1 events, see 3. JP1 Events in the manual JP1/Integrated Management 2 - Manager Command, Definition File and API Reference.
- Detailed event information
-
Specifies as the execution conditions for executing an automated action, a regular expression that represents information about the detailed attributes of the JP1 event basic attributes. If a slash (/) is used as an ordinary character in the regular expression, it must be preceded by a backslash (\/). For details about regular expressions, see G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.
Alphabetic characters are case sensitive.
The information for the detailed attributes for the JP1 event basic attributes contains additional JP1 event information. The information content and the format differ according to the JP1 event. Any detailed attribute information for JP1 events that is in binary format is treated as an absence of information (NULL).
The detailed attributes of the JP1 basic event attributes are used primarily when a product that issues events compatible with the JP1/SES format records detailed information in JP1-series products of version 5 or earlier. Many products of version 6 and later use JP1 event extended attributes to record detailed information.
- Extended event information
-
Specifies whether to use extended JP1 event information as a condition for executing an automated action. Extended JP1 event information is used as a condition for executing an automated action when the user selects the Use extended information check box, and then clicks the Configure button.
The Action Parameter Detailed Definitions (Extended Event Information) window appears.
- 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. If Command is selected, <RULE> cannot be specified in the Action area.
-
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 the setup for linkage with JP1/IM - Rule Operation, see 1010.3.1 Settings for enabling the JP1/IM - Rule Operation linkage function in the JP1/Integrated Management 2 - 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 not be 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, $EVUSR can be specified to execute the action under the name of the user who issued the 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.
- Target host
-
Specifies the name of the host on which the action is to be executed. The host name specified 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 the commands that can be specified, see 66. Command Execution by Automated Action in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.
The maximum length of commands that can be executed as actions is 4,096 bytes. If the length of the command, including converted information such as variables that can be used in the action definition (for example, $EVMSG), exceeds 4,096 bytes, the command is not executed, and the status of the action becomes Fail. In the Message column of the Action Parameter Detailed Definitions window, the following message is displayed:
KAVB4421-W
If an action contains an unrecognizable character code (anything outside the ASCII character set), the action might not be executed because of the shell or other specifications on the target host, or if executed, the results might be invalid. In this case, the action does not fail and its status becomes Ended. Invalid codes can also result when variables are replaced with 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 length of commands that can be executed as actions differs depending on the system running JP1/IM or 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 1212.4.1 Notes regarding the considerations for automated actions in the JP1/Integrated Management 2 - 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 variables that can be specified, see Variables that can be used in the Action Definition area of the Action Parameter Detailed Definitions window.
- Suppress
-
Specifies whether to suppress execution of the automated action.
-
Apply: Execution of the automated action is suppressed.
If 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 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, a number of seconds must be specified in the Monitoring time text box. If the action is not completed within the specified period of time, that action is assumed to be delayed. 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.
If delays are monitored, a JP1 event is issued or a notification command is executed to report the delay. The method of reporting the delay must be specified ahead of time in the automatic action notification definition file (actnotice.conf).
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.
- Note:
-
A monitoring interval appropriate for the automated action being monitored for execution delays should be set.
-
- Comment
-
The user can specify a comment for the automated action in this text box.