Description
This operation component retrieves events occurring at a certain time.
The event that occurred in the specified time is acquired from event DB of the server that is monitoring the event with the operation management product such as Systemwalker Centric Manager and it is saved as a file.
Options
Basic Options
Host name or IP address of the server that is performing event monitoring.
If event monitoring is used in Systemwalker Centric Manager, specify the host name or IP address of the operation management server of the 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 characters. An argument error occurs if this is exceeded.
Specify the name (full path) of the file where the acquired event is to be saved.
An error occurs if the file name (full path) to be saved is omitted.
The maximum length of the file name (full path) to be saved is 1,024 characters. An argument error occurs if this is exceeded.
The event acquired is saved to the file specified as the file name (full path) to be saved on the server that is monitoring the event.
The form of the file where event is saved is different at the operation management product that is monitoring the event.
If event monitoring is used in Systemwalker Centric Manager, events are acquired by the opmtrcsv command, and the events are saved as the file of the CSV format. The specified file will be overwritten if it already exists.
If the delay of the event reception is occurring on the operation management server of Systemwalker Centric Manager, previous event of the specified date to startdate option or starttime option might be saved.
Advanced Options
Specify the date to start obtaining events.
Use the YYYYMMDD format to specify the date (four numbers for the year, and two numbers each for the month and day).
If event monitoring is used in Systemwalker Centric Manager, specify the date when the operation management server received the event.
Start date is necessary to specify with start time. Start date alone cannot be specified or omitted.
If startdate and starttime are omitted together with starttime, it will be obtained from the oldest monitored event stored in the monitored event DB.
Specify the time that is to be used as the start point in the check for event occurrences.
Use the hhmmss format to specify the time (two numbers each for the hour, minutes and seconds).
If event monitoring is used in Systemwalker Centric Manager, specify the time when the operation management server received the event.
Start time is necessary to specify with start date. Start time alone cannot be specified or omitted.
If startdate and starttime are omitted with start date, acquiring the monitoring event from most oldest one that is stored in the monitoring event DB.
Specify the date to end obtaining events.
Use the YYYYMMDD format to specify the date (four numbers for the year, and two numbers each for the month and day).
If event monitoring is used in Systemwalker Centric Manager, specify the date when the operation management server received the event.
End date is necessary to specify with end time. End date alone cannot be specified or omitted.
If enddate and endtime are omitted together with endtime, up to the last monitored event stored in the monitored event DB will be obtained.
Specify the time that is to be used as the end point in the check for event occurrences.
Use the hhmmss format to specify the time (two numbers each for the hour, minutes and seconds).
If event monitoring is used in Systemwalker Centric Manager, specify the time when the operation management server received the event.
End time is necessary to specify with end date. End time alone cannot be specified or omitted.
If enddate and endtime are omitted with end date, acquiring the monitoring event from most latest one that is stored in the monitoring event DB.
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.
The format that can be specified is different at the operation management product that is monitoring the event.
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 monitoring event to be obtained. |
-e <output final monitoring event number> | Final number for monitoring event to be acquired. |
-n <host name> | Originating host for the monitoring event for the acquired target. |
-I <item name 1> <item name 2>... | Log items for additional acquisitions. |
-If <file name> | Specify log items for additional acquisitions by file. |
-j | Add job number to the monitoring event to be acquired. |
The maximum length of the options and the parameters that can be specified is 2,048 characters. An argument error occurs if this is exceeded.
Specify the name of the operation management product performing event monitoring which is linked to this operation component.
If event monitoring is used in Systemwalker Centric Manager, specify "CMGR". This option is not case sensitive.
Only Systemwalker Centric Manager can be specified as a linked product with this operation component.
If the operation management product name is omitted, the Configuration Management Database (CMDB) will be searched based on the specified host name or IP address, and Systemwalker Runbook Automation automatically sets the acquired operation management product name as the value.
The maximum length of the operation management product name that can be specified is 1,024 characters. An argument error occurs if this is exceeded.
Specify the command installation path for the linked product to this operation component.
If event monitoring is used in Systemwalker Centric Manager, specify the full path name of the opmtrcsv command installation directory.
If Systemwalker Centric Manager is specified to mwtype as a linked product for this operation component, installation path is able to omit.
Only Systemwalker Centric Manager can be specified as a linked product with this operation component.
The maximum length of the installation path that can be specified is 1,024 characters. An argument error occurs if this is exceeded.
OS type of the server that performs event monitoring.
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 host name or IP address, and Systemwalker Runbook Automation automatically sets the acquired OS type as the value.
The maximum length of the OS type is 1,024 characters. An argument error occurs if this is exceeded.
Name of the user connecting with SSH to the host monitoring the event.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user name as the value.
If the operation component connects with the file transfer infrastructure, the connected user name is 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 characters. An argument error occurs if this is exceeded.
Password of the user connecting with SSH to the host monitoring the event.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user password as the value.
When connecting by using the file transfer infrastructure, it becomes invalid even if the password of the user is specified.
The maximum length of the connected user password is 1,024 characters. An argument error occurs if this is exceeded.
Name of the user checking occurrence of the event on the host monitoring the event.
If the "execusername" and "execpassword" are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired 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 characters. An argument error occurs if this is exceeded.
This operation component does not use the value of "execpassword". The value of "execpassword" is ignored even if specified.
This is the completion timeout (seconds) for the execution of operation components.
Values between 0 and 86400 (1 day) can be specified.
For example: When timeout is to occur every 10 minutes: 600
When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is stopped in return value 201.
This is the retry count for the execution of operation components.
Specify the count that will be retried when the operation component is finished in return value 161. Values between 0 and 5 can be specified.
When the operation components is terminated in return values other than 161 as a result of the retrying, the operation components will be terminated even if it doesn't reach the specified retry counts. The return value of the operation components returns the value executed at the end.
For example: When retries are to be performed twice: 2
This is the retry interval (seconds) for operation components.
Specify the interval that will be retried when the operation component is terminated in return value 161. Values between 1 and 14400 can be specified.
For example: When retries are to be performed at 300 seconds 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 |
|---|---|---|---|
| Success | 0 | Acquisition of the event was successful. |
| Failure | 161 | Failed the acquisition of the event. When the retry count is specified, it will be retried. |
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 | When the operation of the operation component are executing to the event monitoring server into which the RBA Agents have not been introduced, the network communication (SSH communication) with the event monitoring server was disconnected. | ||
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 is an error in the setting of the option. Or there is a problem in the registered information of the Configuration Management Database (CMDB). | ||
200 | Acquisition of the event terminated abnormally. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute the operation components. | ||
203 | Failed to execute the operation component. 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 components was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation component was not executed. There is a possibility that the operation components have not been 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 events that the monitoring product discovered during the specified time are obtained successfully. The operation component was successful. If an attempt to obtain the events that the monitoring product discovered during the specified time fails, the content of the error will be set as a string. |
returnCode | This variable is set to the return value. |
Notes
If the information except for the Management Server has been entered for 'hostname', this operation component uses the file transfer infrastructure or SSH communication to perform its operations. Set either at least to be able to communicate. 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.
This operation component saves the acquired event as the file on the event monitoring server. If necessary, transfer or delete the file where it is to be saved.
Use alphanumeric characters for the name of the file to be created.
Symbols that can be used: "!", "~", "_", "-", ".".
Use the Web console to check the return value. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When return values from 201 through 208 are output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of the Management Server (When the Management Server is Windows(R))
System log of the Management Server (When the Management Server is Linux)
Custom message of BPMN
Confirm the message in any of the above-mentioned place, and execute appropriate measures. Refer to the Systemwalker Runbook Automation Message Guide for details.
