Description
This operation component stops the WorkUnit or IJ Server cluster on the Application Server. Relevant Application Server is Interstage. If the relevant option is registered as a work unit, then the work unit is stopped. If not, the IJ Server cluster is stopped.
Options
Basic Options
Host name or IP address of the host that will stop the WorkUnit or IJ Server cluster.
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.
Name of the WorkUnit or IJ Server cluster to be stopped.
An argument error occurs if the WorkUnit name or IJ Server cluster name is omitted.
The maximum length of the WorkUnit name or IJ Server cluster name is 1,024 characters. An argument error occurs if this is exceeded.
Advanced Options
Specify either "wu" or "ijs" to stop the WorkUnit or the IJServer cluster, respectively.
These values are not case sensitive.
If nothing is specified, the WorkUnit stops.
If the WorkUnit does not exist, the IJServer cluster stops.
The maximum string length is 1,024 characters. An argument error occurs if this limit is exceeded.
For IJ Server clusters, the relevant middleware version is V9.2.0 or later. An error will occur if middleware older than V9.2.0 is used.
Name of the system where the WorkUnit is to be stopped.
If the system name is omitted, default system is specified.
The specification of the system name is effective, if the server is Solaris system only. The specification of the system name is invalid, if the server is Windows system or Linux system.
The specification is invalid if an IJ Server cluster name is specified in wuname.
The maximum length of the system name is 1,024 characters. An argument error occurs if the exceeded.
The stop mode of the WorkUnit or the IJServer cluster.
Specify "gen", "syn" or "fc". This option is not case sensitive.
If "gen" is specified, it is stopped generally.
If "syn" is specified, it is stopped synchronously.
If "fc" is specified, it is stopped forcedly.
If a value is not specified for the WorkUnit, "syn" is used by default.
If specify "gen" to IJServer WorkUnit, it is stopped synchronously.
If a value is not specified for the IJServer cluster or if "syn" is used, "gen" is set by default.
Refer to Interstage documentation for information of each stop mode for detail.
Name of the Application Server for the linked product. This option is not case sensitive.
Specify IAPS, IBAS or IWS.
IAPS: Interstage Application Server
IBAS: Interstage Business Application Server
IWS : Interstage Web Server Express or Interstage Web Server
If the MW 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 mw type as a value.
The maximum length of the mw type is 1,024 characters. An argument error occurs if this exceeded.
Installation path of the command for the linked product.
If Interstage is specified to mwtype as a linked product for this operation component, Installation path is able to omit. Only Interstage can be specified as a linked product with this operation component.
The maximum length of the Installation path is 1,024 characters. An argument error occurs if this is exceeded.
OS type of the host that will stop the WorkUnit or IJ Server cluster.
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 stop WorkUnit or IJ Server cluster.
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. Argument error occurs if this is exceeded.
Password of the user connecting with SSH to the host stop WorkUnit or IJ Server cluster.
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. Argument error occurs if this is exceeded.
Name of the user stopping the WorkUnit or IJ Server cluster on the host where the WorkUnit or IJ Server cluster is to be stopped.
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 the file transfer infrastructure, execute the command as a SYSTEM user. In this case, the connected user name is invalid.
The maximum length of the 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 300 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 interrupted in return value 201.
This is the retry count for the execution of operation components.
When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it doesn't reach the specified retry count. The return values of the operation components become 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.
When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 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 | WorkUnit or IJ Server cluster stop was successful. |
| Failure | 159 | Specified WorkUnit or IJ Server cluster was not detected. Alternatively, the service required for IJ Server cluster operation was not started. |
161 | Failed to stop the WorkUnit or IJ Server cluster. Retried if a retry count has been specified. | ||
187 | Authentication failed when an attempt was made to connect to the Business Server over the network (using SSH). Alternatively, an error occurred during the processing of communications with the Business 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 a Business Server where an RBA Agent has not been installed, the network communications (SSH) with the Business Server was closed. | ||
189 | An attempt to connect to the Business Server over the network (using SSH) failed. Alternatively, an error occurred during the processing of communications with the Business 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 input information. | ||
198 | There is an error in the option content. | ||
200 | Stop of WorkUnit or IJ Server cluster 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 operation components. | ||
203 | Failed to execute the operation component. There is a problem in the Operation Automation 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 normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation components were not executed. There is a possibility that the operation components are not 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 WorkUnit or IJ Server cluster stops successfully. The operation component was successful. If the WorkUnit or IJ Server cluster fails to stop, the content of the error will be set as a string. |
returnCode | This variable is set to the return value. |
Notes
This operation component uses File transfer infrastructure or SSH communication to perform its operations when specify the host name other than the Management Server. It is necessary to be able to connect at least each one. 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.
To operate the IJ Server cluster, start the following service on the relevant operating server:
Interstage Java EE Node Agent service
Confirm the return values with the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When the return value of 201-208 is output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of Management Server (when the Management Server is Windows(R))
System log of Management Server (when the Management Server is Linux)
Custom message of BPMN
Confirm the message in either of the above-mentioned place, and take an appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
This operation component relevants following middleware.
Windows/Linux/Solaris
Interstage Application Server Enterprise Edition V9.0.0 or later.
Interstage Application Server Standard-J Edition V9.0.0 or later.
Interstage Business Application Server Enterprise Edition V9.0.0 or later.
Interstage Business Application Server Standard Edition V9.0.0 or later.
Interstage Web Server V9.0.0 or later.
Interstage Web Server Express V11.0.0 or later.
For IJ Server clusters, the relevant middleware version is V9.2.0 or later. An error will occur if middleware older than V9.2.0 is used.
