Description
This operation component installs software on servers.
This operation component installs software for which silent installations are possible.
Options
Basic Options
Target host name or IP address where the operation component will be executed.
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 will occur 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.
Command line (alongside its arguments) to install the software.
Either a full path or relative path can be used for command names and arguments.
If the command name includes path information, specify as shown below. However, if the arguments for the command specified in the commandline option include path information, follow the specification for the command.
Change the path delimiter from "\" to "/".
Enclose the path information in double quotes.
If the Business Server is running on Windows and the connection is established using the file transfer infrastructure and the path includes percent symbols ("%"), then repeat the percent symbols twice ("%%").
For command names with the ".bat" or ".cmd" extensions, specify the extension as well. Behavior is not guaranteed unless the extension is specified.
An argument error will occur if the command name and arguments are omitted.
The maximum length of the command name and arguments is 8,000 characters. An argument error will occur if this limit is exceeded.
An error will occur if an interactive command is executed.
Advanced Options
Host name or IP address of the server from which the software installation files are to be transferred.
To set the Management Server, as the transfer source, specify the following:
For IPv4: 'localhost' or '127.0.0.1'
For IPv6: 'localhost' or '::1'
This option can only be specified if sourcefile and destinationfile are specified.
This option and the sourcefile and destinationfile options can be omitted if the installation file already exists on the host where the software is to be installed. If omitting, omit all three.
The maximum length of the host name or IP address is 1,024 characters. An argument error will occur if this limit is exceeded.
Name (full path) of the software installation file.
If there are multiple installation files, specify the name (full path) of the folder (directory) in which they are stored.
This option can only be specified if sourcehostname and destinationfile are specified.
This option and the sourcehostname and destinationfile options can be omitted if the installation files already exist on the host where the software is to be installed. If omitting, omit all three.
The maximum length of the file name is 255 characters. An argument error will occur if this limit is exceeded.
Name (full path) of the installation destination software installation file.
If the folder (directory) name was specified for the source installation file, specify the name (full path) of the folder (directory).
This option can only be specified if sourcehostname and sourcefile are specified.
This option, sourcehostname option, and sourcefile option can be omitted if the installation files already exist on the host where the software is to be installed. If omitting, omit all three.
The maximum length of the file name is 255 characters. An argument error will occur if this limit is exceeded.
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 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 for the OS type that has been acquired from the CMDB.
The maximum length of the OS type is 1,024 characters. An argument error will occur if this limit is exceeded.
Name of the user connecting with SSH to the host executing the operation component.
If the connected user name and password required for connection are not specified, the command searches the Configuration Management Database (CMDB) based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the value for the connected user name that has been acquired from the CMDB.
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 will occur if this limit is exceeded.
Password of the user connecting with SSH to the host executing the operation component.
If the connected user name and password required for connection are not specified, 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 for the connected user password that has been acquired from the CMDB.
If the connection is made using the file transfer infrastructure, the password will not take effect even if it is specified.
The maximum length of the connected user password is 1,024 characters. An argument error will occur if this limit is exceeded.
Name of the user executing the command on the host executing the operation component.
If the "execusername" and "execpassword" are not specified, 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 for the administrator user that has been acquired from the CMDB.
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 will occur if this limit is exceeded.
This operation component does not use the value of "execpassword". The value of "execpassword" is ignored even if specified.
OS type of the file transfer source host.
Specify either Windows or Linux or Solaris. This option is not case sensitive.
If the OS type 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 for the OS type that has been acquired from the CMDB.
The maximum length of the OS type is 1,024 characters. An argument error will occur if this limit is exceeded.
Name of the user connecting with SSH to the file transfer source host.
If the connected user name and password required for connection are not specified, 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 for the connected user name that has been acquired from the CMDB.
If the operation component connects with the file transfer infrastructure, "sourceusername" 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 will occur if this limit is exceeded.
Password of the user connecting with SSH to the file transfer source host.
If the connected user name and password required for connection are not specified, 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 for the connected user password that has been acquired from the CMDB.
If the connection is made using the file transfer infrastructure, the password will not take effect even if it is specified.
The maximum length of the connected user password is 1,024 characters. An argument error will occur if this limit is exceeded.
This is the completion timeout (in seconds) for executing the operation component.
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 when the specified time has passed, the processing for the operation component will be interrupted with return value 201.
This is the retry count for executing the operation component.
Specify the number of retry attempts to be used when the operation component terminates with return value 161. Values between 0 and 5 can be specified.
If the operation component terminates with a return value other than "161" as a result of being re-executed from a retry, the 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 twice: 2
This is the retry interval (in seconds) for the operation component.
Specify the time to wait before a retry is attempted if the operation component terminates 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 | Successfully installed the software. |
| Failure | 161 | Failed to install the software. If a retry count has been specified, retries will be performed. |
177 | Failed to access the installation file. | ||
178 | The program that was being executed by the command has terminated abnormally. | ||
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 the operation component was performing an operation on a Business Server where an RBA Agent has not been installed, an SSH network connection to the Business Server has been disrupted. | ||
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 with an option specification, or there is a problem with the information registered in the Configuration Management Database (CMDB). | ||
200 | Installing the software has terminated abnormally. | ||
- | - | 201 | The execution of the operation component has timed out. |
202 | The operation component has not been executed due to a problem with the settings for executing the operation component. | ||
203 | Failed to execute the operation component. There is a problem with the environment for the Management Server. | ||
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 of 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. | ||
| Failure | Other | This is the return value for the command. |
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if the software is installed successfully. The operation component was successful. If an attempt to install the software fails, the content of the error will be set as a string. |
install_command_stdout | This variable is set to the standard output for the installation command. |
install_command_stderr | This variable is set to the standard error output for the installation command. |
install_command_rcode | This variable is set to the return value for the installation command. |
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 the file transfer infrastructure or SSH communications. 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 a folder (or directory) has been specified for the installation file, this operation component will compress the files in the specified folder (or directory) before sending the archive file to the host where the software is to be installed. While the processing for this operation component is being performed, an archive file is temporarily created in the folders (or directories) specified for the sourcefile and destinationfile options.
If a folder (or directory) that does not exist is specified for the software installation file on the source host and the software installation file on the destination host, an error will occur with return value "177".
If the installation file is a self-extracting file, extract the file beforehand.
The installation file that is sent to the host where the installation is performed is not deleted even after the processing for this operation component has completed.
Even if the software need to reboot the OS automatically are installed, operation components are exited normally.
This operation component may take a long time to execute, depending on the software being installed. For this reason, set an appropriate value for the "timeout" option so that the operation component does not time out abruptly.
For the name of the installation file, use only alphanumeric characters and white space and full width characters, and the symbols below:
"!" "~" "_" "-" "."
When SSH communications are performed on the server where the software is to be installed, the results of the operation component cannot be guaranteed if Japanese text is specified for the "commandline" option. To specify Japanese, install an RBA Agent on the server where the software is to be installed.
Systemwalker Runbook Automation uses return values between 159 and 240. Return values outside this range and unused return values within the range are values output by the installation command rather than values set by Systemwalker Runbook Automation. Investigate the command itself.
If a command that does not exist is specified for the commandline option, an error with return value 42 may occur.
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 enters an abort or 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 the messages in one of these locations, and take the appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
