Description
Collects a fingerprint of the specified file.
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 occurs if this option is omitted.
This option can contain up to 1,024 characters. An argument error occurs if this limit is exceeded.
Full name of the file which fingerprint will be collected. You can specify text or binary files (such as compressed files or graphics files).
The following will cause an error:
If the file name is omitted
If a non-existing file name is specified
If more than 1,024 characters are specified for the file name
Advanced Options
The hash algorithm that collects the fingerprint. Select [MD5] or [SHA-1].
If nothing was specified, the setting will be [MD5].
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 Data Base (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.
This option can contain up to 1,024 characters. An argument error occurs if this limit is exceeded.
Name of the user connecting with SSH or Windows PowerShell to the host executing the operation component.
If username or password is omitted, the hostname will be searched in the Configuration Management Data Base (CMDB), and the acquired user name will be used.
If using file transfer infrastructure to connect, username must have the value below (any other value specified in this option will be ignored):
For Linux and Solaris Business Servers: root
For Windows Business Server: SYSTEM user
This option can contain up to 1,024 characters. An argument error occurs if this limit is exceeded.
Password of the user connecting with SSH or Windows PowerShell to the host executing the operation component.
Also, the password for users on remote hosts that occur in rexec.
If username or password is omitted, the hostname will be searched in the Configuration Management Data Base (CMDB), and the acquired password will be used.
If using file transfer infrastructure to connect, even if the password is specified, it will be invalid.
This option can contain up to 1,024 characters. An argument error occurs if this limit is exceeded.
The user name for executing the command on the target host where the operation component is to be executed.
If execusername or execpassword is omitted, the hostname will be searched in Configuration Management Data Base (CMDB), and the acquired administrator user will be used. If the user is not registered on CMDB, the connected user name will be used.
If using file transfer infrastructure to connect and the specified hostname is running Windows, execution will be carried out by the SYSTEM user, and any value specified in this option will be ignored.
This option can contain up to 1,024 characters. An argument error occurs if this limit is exceeded.
Maximum number of seconds to wait for the execution of operation components.
The valid range is from 300 to 86,400 (1 day).
For example, specify 600 for a completion timeout of 10 minutes.
If the operation component times out, the operation component process will be suspended with a return value of 201.
Number of times to try to execute the operation components.
Retry will only attempted if the operation component ends with a return value of 161.
The valid range is from 0 to 5.
As a result of retrying, if the operation components ended with 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, specify 2 for retry twice to execute the components.
Number of seconds to wait between retries.
Retry will only attempted if the operation component ends with a return value of 161.
The valid range is from 1 to 14400.
For example, specify 300 to wait 300 seconds between each retry.
If timeout, retry or retry_interval are omitted or a value outside the range is specified, then the default value specified in the operation components definition file will be used. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Success | 0 | Fingerprint successfully collected. |
| Failure | 161 | Fingerprint collection failed. A retry will be attempted if the retry option was specified. |
171 | Fingerprint collection failed because the specified file does not exist. | ||
177 | Failed to access the file. | ||
178 | Program terminated abnormally due to a command. | ||
187 | If using SSH or Windows PowerShell: Authentication failed during an operation component connection to a Business Server over the network. If using file transfer infrastructure: An error occurred during an operation component communication with the Business Server. The error code for the file transfer infrastructure will be output to the execution results (refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes). | ||
188 | Network communication (SSH) with the Business Server was terminated during an operation component operation on a Business Server in which an RBA Agent is not installed,. | ||
189 | If using SSH or Windows PowerShell: Connection to Business Server network failed during an operation component operation. If using file transfer infrastructure: An error occurred during an operation component communication with the Business Server. The error code for the file transfer infrastructure will be 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 option content. | ||
200 | Command terminated abnormally. | ||
- | - | 201 | Operation component timed out. |
202 | Failed to execute the operation component because there is a configuration problem in the component. | ||
203 | Failed to execute the operation component because there is a problem in the Management Server environment. | ||
205 | Failed to execute the operation component because there is a problem with the operation component input. | ||
206 | The operation component was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation component was not executed. It is possible that the operation components are not registered in the Management Server. | ||
208 | The Automated Operation Process has been aborted because the Automated Operation Process was recovered while the operation component was executing. |
Output Data
Variable | Description |
|---|---|
message | This variable will be set to the following message if the fingerprint is obtained successfully: The operation component was successful. If collection of the fingerprint fails, error content is set as a string. |
finger_print | Sets the collected fingerprint result. Fingerprint is displayed using half-width alphanumeric characters (lower case letters). Output example: 3141f904eebe53206c25b58f8f3a6da0 |
returnCode | Sets return values |
Notes
This operation component sets information other than the Management Server to the hostname, and if the ostype has been set to Windows, then RBA Agent or Windows PowerShell is mandatory.
This operation component sets information other than the Management Server to the hostname, and if the ostype has been set to Linux, then fingerprint collection is carried out using md5sum command/sha1sum command
This operation component sets information other than the Management Server to the hostname, and if the ostype has been set to Solaris, then fingerprint collection is carried out using digest command.
Use alphanumeric characters, space characters, and the following symbols for the names of the files to collect the fingerprint.
Symbols that can be used: "!","~","_","-","."
Where the RBA agent is not installed in the Business Server, the operation results of the operation component are not guaranteed if Japanese is specified in the filename option. Install the RBA agent in the Business Server if Japanese is to be specified.
Confirmation of return values is carried out on the Web console. Refer to "Confirming the Operation Component Execution Status/Execution results" in the Systemwalker Runbook Automation Operation Guide for details.
If return values 201 to 208 are output, the automated operation process is cancelled or an error condition occurs, and error messages are output to the following locations:
Management Server event log (if Management Server is running on Windows (R)
Management Server sys log (if Management Server is running on Linux)
BMPN custom message
Check messages at the locations noted above and take appropriate remedial action. Refer to the Systemwalker Runbook Automation Message Guide for details.
