Description
This operation component generates an event to the event database on the server that is performing event monitoring via an operation management product, such as Systemwalker Centric Manager.
If event monitoring is being performed using Systemwalker Centric Manager, a message will be created using the "label: error type: message text" format and then notified to the Systemwalker Centric Manager system monitoring agent.
Options
Basic Options
Target host name or IP address where the operation component will be executed.
If event monitoring is being performed using Systemwalker Centric Manager, specify the host name or IP address of the Systemwalker Centric Manager Operation Management Server.
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 will occur if this limit is exceeded.
This is the label which is displayed in the event.
When event monitoring is used in Systemwalker Centric Manager, the upper limit for the number of characters is as follows. If the upper limit is exceeded, an argument error occurs.
If the operating system for the server used to execute event monitoring is Windows, the number of characters is 80.
If the operating system type for the server used to execute event monitoring is Linux or Solaris, the number of characters is 8.
A suffix colon (":") is added automatically.
If the label was omitted, the format is "error type:message text", and the label is not displayed.
This is the error type displayed in the event.
If event monitoring is performed by Systemwalker Centric Manager, specify one of the strings in the "String specified" column. This option is not case sensitive.
If the operating system type for the server performing event monitoring is Windows:
String specified | Error type | Importance |
|---|---|---|
HALT | HALT | Very important |
ERROR | ERROR | Important |
WARNING | WARNING | Warning |
NOTICE | INFO | Notification |
INFO | INFO | General |
If the operating system type for the server performing event monitoring is Linux or Solaris:
String specified | Error type | Importance |
|---|---|---|
HALT | Halt | Very important |
ERROR | error | Important |
WARNING | Warning | Warning |
NOTICE | Information | Notification |
INFO | Information | General |
If the error type is omitted, "ERROR" will be used for Windows and "error" will be used for Linux or Solaris.
This is the message text displayed in the event.
When event monitoring is used in Systemwalker Centric Manager, the upper limit for the number of characters is as follows. If the upper limit is exceeded, an argument error occurs.
The upper limit which can be specified for the message text is 600, including label and errorkind. If this number is exceeded, an argument error occurs.
An argument error occurs if the message text is omitted.
If the message text contains a line feed, it is converted to a blank space.
The following string will be added to the start of the message text.
"[RBAXXXXX]", where "XXXXX" is the process ID for the operation process
Advanced Options
Operating system of the host executing the operation component.
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.
This is the name of the user that uses SSH to connect to the target host where the operation component is to be executed.
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 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 characters. An argument error occurs if this is exceeded.
This is the password of the user that uses SSH to connect to the target host where the operation component is to be executed.
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.
If it connects with file transfer infrastructure, the connected user password is invalid.
The maximum length of the connected user password is 1,024 characters. An argument error occurs if this is exceeded.
This is the name of the user that executes the command on the target host where the operation component is to be executed.
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 as the value. If an administrator has not been registered with the CMDB, the command is executed using the name of the connected user.
If the host specified in the "hostname" option is running on Windows and the connection is made using the file transfer infrastructure, execute the command as a SYSTEM user. In this case, the user name is ignored even if specified.
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.
Specify the name of the operation management product that performs event monitoring and is to be linked to this operation component.
If event monitoring is performed by Systemwalker Centric Manager, specify "CMGR". This option is not case sensitive.
At this point, the only operation management product that can be linked to this operation component is Systemwalker Centric Manager.
If the name of the operation management product is omitted, the command will search the Configuration Management Database (CMDB) based on the specified host name or IP address, and then Systemwalker Runbook Automation will automatically set the value that has been acquired from the CMDB.
The maximum length of the string that can be specified for the name of the operation management product is 1,024 characters. An argument error occurs if this is exceeded.
Specify the installation path of the command that will be linked to this operation component.
If event monitoring is performed by Systemwalker Centric Manager, specify the absolute pathname of the opfmt command installation directory.
This option can be omitted if the "mwtype" option specifies that the operation management product linked to this operation component is Systemwalker Centric Manager.
At this point, the only operation management product that can be linked to this operation component is Systemwalker Centric Manager.
The maximum length of the installation path that can be specified is 1,024 characters. An argument error occurs if this is exceeded.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 and 86400 (1 day) can be specified.
Example) If the completion timeout is 10 minutes: 600
If the operation component has not finished executing even though the specified time has passed, the processing for the operation component will be interrupted with return value 201.
This is the retry count for the execution of operation components.
Specify the number of retry attempts to be used when operation components terminate with return value 161. Values between 0 and 5 can be specified.
If an operation component terminates with a return value other than "161" as a result of being re-executed from a retry, execution of the operation component will terminate even if the specified number of retries has not been reached. The return value for the operation component will be the value from the last time the operation component was executed.
Example) To retry the operation component twice: 2
This is the retry interval (seconds) for operation components.
Specify the time to wait before a retry is attempted if operation components terminate with return value 161. Values between 1 and 14400 can be specified.
Example) To retry at 300 second intervals: 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 | The event has been notified successfully. |
| Failure | 161 | Notification of the event has failed. If a retry count has been specified, retries will be attempted. |
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 an operation component was performing an operation on an event monitoring server where an RBA Agent has not been installed, an SSH network connection with the event monitoring server was closed. | ||
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 with an option specification. Alternatively, there is a problem with the information registered in the Configuration Management Database (CMDB). | ||
200 | Notification of the event terminated abnormally. | ||
- | - | 201 | Execution of the operation component timed out. |
202 | The operation component has not been executed. There is a problem with the settings for executing the operation component. | ||
203 | Failed to execute the operation component. There is a problem with the Management Server environment. | ||
205 | The operation component has not been executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component has not been executed normally. There is a problem with the output information specification for the operation component. | ||
207 | The operation component has not been executed. The operation component may not have been registered on 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 event is notified successfully. The operation component was successful. If notification of the event fails, the content of the error will be set as a string. |
event_message | This variable is set to a message that is displayed for the event. The message varies depending on the operation management product that is performing event monitoring. If event monitoring is performed by Systemwalker Centric Manager, the message will be output by the opfmt command. Refer to the Systemwalker Centric Manager Reference Manual for details on the output format and the output items. |
returnCode | This variable is set to the return value. |
Notes
If information other than the Management Server is entered for the "hostname" option, this operation component will execute actions using either the file transfer infrastructure or SSH. Specify settings so that communications can be performed using at least one of these methods. 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 event monitoring is being performed by Systemwalker Centric Manager, this operation component can be linked to V13.1.0 or later.
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.
If a return value between 201 and 208 has been output, the Automated Operation Process will enter an aborted state or an error state, and error messages will be output to the following locations:
Event logs for the Management Server (if the Management Server is running on Windows(R))
syslogs for the Management Server (if the Management Server is running on Linux)
Custom messages for BPMN
Check for messages in these locations and take the appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
