Description
This operation component checks the occurrence of events.
Using operation management products such as Systemwalker Centric Manager enables you to search the event DB on the server where event monitoring is performed and to check if the specified event message exists in the specified time.
Options
Mandatory Options
Host name or IP address of a server where the event monitoring is performed.
Specify host name or IP address of Operation Management Server if event monitoring is used in Systemwalker Centric Manager,
To execute the operation component on the Management Server, specify the following:
For IPv4: 'localhost' or '127.0.0.1'
For IPv6: 'localhost' or '::1'
An argument error occurs if the host name or IP address is omitted.
The maximum length of the host name or IP address is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Specify a character string to search an event to check the occurrence of the event.
An argument error occurs if the event message is omitted.
The maximum length of the whole event message is 2,048 bytes. An argument error occurs if the length is larger than 2,048 bytes.
How to specify a search string may be different depending on the operation management product for which event monitoring is used.
If event monitoring is used in Systemwalker Centric Manager, up to 5 search strings can be specified. If the search string includes spaces, enclose the string in double quotes (").
Advanced Options
OS type of a server where the event monitoring is performed.
Specify Windows, Linux or Solaris. This option is not case sensitive.
If the OS type is omitted, the Configuration Management Database (CMDB) will be searched based on the specified hostname or IP address, the Systemwalker Runbook Automation automatically sets the obtained os type as the value.
The maximum length of the os type is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
User name who connects using SSH to the server where the event monitoring is performed.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified hostname or IP address and Systemwalker Runbook Automation automatically sets the obtained connected user name as the value.
If the operation component connects with the file transfer infrastructure, the connected user name will be fixed at either of the following names and cannot be changed. In this case, the user name is ignored even if specified.
If the Business Server is running on Windows: SYSTEM user
If the Business Server is running on Linux or Solaris: root
The maximum length of the connected user name is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Password of a user who connects using SSH to the server where the event monitoring is performed.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified hostname or IP address and Systemwalker Runbook Automation automatically sets the obtained password as the value.
If connecting to the server using File Transfer library, specifying password is not effective.
The maximum length of the password is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
User name who executes the check of the event occurrence on the server where the event monitoring is performed.
If the "execusername" and "execpassword" are not specified, the Configuration Management Database (CMDB) is searched based on the specified hostname or IP address and Systemwalker Runbook Automation automatically sets the obtained administrator user as the value.
If not to register to CMDB, it is executed by name of the user connecting.
If the host specified in "hostname" is running on Windows and it connects with file transfer infrastructure, execute the command as a SYSTEM user. In this case, the connected user name is invalid.
The maximum length of the executing user name is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
This operation component does not use the value of "execpassword". The value of "execpassword" is ignored even if specified.
Specify the name of the operation management product for which event monitoring is performed with this Operation Component.
If event monitoring is used in Systemwalker Centric Manager, specify "CMGR". This option is not case sensitive.
This Operation Component can be linked with only Systemwalker Centric Manager.
If the operation management product name is omitted, the Configuration Management Database (CMDB) will be searched based on the specified hostname or IP address, the Systemwalker Runbook Automation automatically sets the obtained value.
The maximum length of the operation management product name is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Specify the installation path of the command which linked with this Operation Component.
If event monitoring is used in Systemwalker Centric Manager, specify the full path name of the opmtrcsv command installation directory.
If the operation management product in linkage with this Operation Component is Systemwalker Centric Manager by mwtype setting, this argument can be omitted.
The Operation Components can be linked with only Systemwalker Centric Manager.
The maximum length of the installation path is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Specify the 'From' year, month and day for checking the occurrence of the event. The format is 4 digits for year, 2 digits each for month and day (YYYYMMDD).
Specify the year, month and day when the Operation Management Server received the event if event monitoring is used in Systemwalker Centric Manager,
startdate must be specified with starttime. startdate cannot be specified on its own, nor can it be omitted.
If startdate and starttime are omitted, checking is performed from the oldest monitored event stored in the monitored event DB.
Specify the 'From' time which is the starting point for checking the occurrence of the event.
The format is 2 digits each for hour, minute and second (hhmmss).
Specify the time when the Operation Management Server received the event if event monitoring is used in Systemwalker Centric Manager.
starttime must be specified with startdate. starttime cannot be specified on its own, nor can it be omitted.
If startdate and starttime are omitted, checking is performed from the oldest monitored event stored in the monitored event DB.
Specify the 'To' year, month and day for checking the occurrence of the event.
The format is 4 digits for year, 2 digits each for month and day (YYYYMMDD).
Specify the year, month and day when the Operation Management Server received the event if event monitoring is used in Systemwalker Centric Manager.
enddate must be specified with endtime. enddate cannot be specified on its own, nor can it be omitted.
If enddate and endtime are omitted, checking is performed to the final monitored event stored in the monitored event DB.
Specify the 'To' time for the checking the occurrence of the event..
The format is 2 digits each for hour, minute and second (hhmmss).
Specify the time when the Operation Management Server received the event if event monitoring is used in Systemwalker Centric Manager.
endtime must be specified with enddate. endtime cannot be specified on its own, nor can it be omitted.
If enddate and endtime are omitted, checking is performed to the final monitored event stored in the monitored event DB.
Specify the host name where the event has occurred.
Specify this to identify the place the event occurred. If this is omitted, all host events stored in the monitored event DB will be checked.
The format of targethostname may be different depending on the operation management product for which event monitoring is performed.
If event monitoring is performed in Systemwalker Centric Manager, specify ""host*"" (prefix search), ""*host"" (suffix search), or ""*host*"" (meet-in-the-middle search).
The maximum length of the host name where the event has occurred is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
When event will be acquired, specify options and parameters to pass the command of the linked product other than dates that is to be used as the start point and end point in acquire the event.
- 'From' time
- 'To' time
- Event's machine host name.
The format may be different depending on the operation management product for which event monitoring is performed.
If event monitoring is used in Systemwalker Centric Manager, the following options for the opmtrcsv command can be specified:
Options | Content of specification |
|---|---|
-s <output lead monitoring event number> | Start number for the monitoring event for the search target. |
-e <output final monitoring event number> | Final number for the monitoring event for the search target. |
-a | Set string search condition to AND. |
-I <item name 1> <item name 2>... | Log items to be added to the event information that will be the search target. |
-If <file name> | Specify log items to be added to the event information that will be the search target by file. |
-j | Add job number to the event information that will be the search target. |
The maximum length of the options and parameters string is 2,048 bytes. An argument error occurs if the length is larger than 2,048 bytes.
This is the completion timeout (seconds) for the execution of Operation Components.
Values between 300 and 86400 (1day) can be specified.
For example: when waiting for 10 minutes until completion: 600
If the execution of Operation Components is not completed after passing the specified time, the processing of Operation Components is stopped with the return value:201.
This is the retry count for the execution of operation components.
Specify retry count when operation components ended with the return value:161. Values between 0 and 5 can be specified.
If the processing of Operation Components ended with return value except 161 as a result of a retry, the execution of Operation Components stops at retry count less than the specified value. The return value of Operation Components is the value of the last execution.
For example: when retries are performed twice: 2
This is the retry interval (seconds) of Operation Components.
Specify interval until retry is to be performed when Operation Components ended with the return value:161. Values between 1 and 14400 can be specified.
For example: when retries are performed with 300 second interval: 300
If the specification of the timeout, retry and retry_interval is omitted, and a value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Issued event | 0 | Checking the occurrences of events was successful. The checked event has occurred. |
| Unissued event | 1 | Checking the occurrences of events was successful. The checked event has not occurred. |
| Failure | 161 | Checking the occurrences of events failed. If retry count is specified, retries are to be performed. |
187 | Authentication failed when an attempt was made to connect to the event monitoring server over the network (using SSH). Alternatively, an error occurred during the processing of communications with the event monitoring server (file transfer infrastructure). In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
188 | Network communication (SSH communication) to the event monitoring server was disconnected when the operation using Operation Components is performed to the event monitoring server which RBA Agent is not installed. | ||
189 | An attempt to connect to the event monitoring server over the network (using SSH) failed. Alternatively, an error occurred during the processing of communications with the event monitoring server (file transfer infrastructure). In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
197 | There was an error in option setting or there may be a problem on the information registered in the Configuration Management Database (CMDB). | ||
200 | Checking the occurrences of events ended abnormally. | ||
- | - | 201 | Execution of Operation Component timed out. |
202 | The Operation Component was not executed. There is a problem in the setting for executing the Operation Component. | ||
203 | The Operation Component was not executed. There is a problem in the Management Server environment. | ||
205 | The operation component was not executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component was not executed. There is a problem with the output information specification of the operation component. | ||
207 | The Operation Component was not executed. Operation Component may not be registered in the Management Server. | ||
208 | The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing. |
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if the operation component successfully checks the occurrence of events monitored by the monitoring product. The operation component was successful. If the operation component fails to check the occurrence of events monitored by the monitoring product, the content of the error will be set as a string. |
event_search_result | This variable is set to a string that indicates the result of searching the monitored event database. This variable is only set to the search result if the specified event message has been found. The output format varies depending on the operation management product that is performing event monitoring. If event monitoring is performed by Systemwalker Centric Manager, the opmtrcsv command is used to set the search results in CSV format. Refer to the Systemwalker Centric Manager Reference Manual for details on the setting format and the setting items. Note that if there are delays in receiving events on the Systemwalker Centric Manager Operation Management Server then this variable may be set to an event that occurred before the date and time specified by the "startdate" and "starttime" options. |
returnCode | This variable is set to the return value. |
Notes
The Operation Component uses File Transfer Library or SSH communication to perform its operation if hostname is entered with information other than Management Server. Set to enable either File Transfer Library or SSH communication at least. Refer to "3.16 Notes of Each Communication Method" for information on communication methods.
Refer to "3.16.7 Notes When Connected User And Executing User Are Different" for information on different connected and executing users.
If RBA Agent is not installed on the Business Server, specifying Japanese character on the eventmessage option may cause a problem on the operation result of the Operation Components. For specifying Japanese character, install the RBA Agent on the Business Server.
To check the return value, use Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
If the return value is between 201 and 208, the Automated Operation Process enters an abort or error state, and error messages are output to the places below.
The event log of Management Server(in case Windows(R) Management Server)
The syslog of Management Server(in case Linux Management Server)
BPMN custom messages
Check error messages in one of the places above and take the appropriate measures. Refer to the Systemwalker Runbook Automation Message Guide for details.
