Description
This operation component acquires the status of the job net registered in the linked product of a server.
Options
Basic Options
Host name or IP address of the server that will acquire the status of the job net.
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.
Name of the job net whose status is to be acquired.
An argument error occurs if the name of the job net is omitted.
The maximum length of the name of the job net is 1,024 characters. An argument error occurs if this is exceeded.
If the linked product is System Operation Manager and the job net of the specified name exists in two or more projects, the error occurs because it is judged that the job net doesn't exist. In this case, specify projectname of the advanced option.
Advanced Options
Specify the project name where the job net information will be stored.
This option is effective when the linked product is System Operation Manager only.
This can be omitted if the job net specified in jobnetname exists in only one project.
If job net of the name that specified in jobnetname of the basic option exists in two or more projects, the error occurs because it is judged that the job net doesn't exist. In this case, specify the project name.
The maximum length of the project name is 1,024 characters. An argument error occurs if this is exceeded.
This option is for specifying the subsystem to be operated in systems that are operating multiple subsystems. Specify the subsystem number (between 0 and 9) that will be operated. If this option is omitted, sub system number 0 will be operated.
This option is effective when the linked product is System Operation Manager only.
An argument error occurs if the value that exceeded 0 to 9 was input.
Name of the user connecting with SSH to the host requesting acquisition of the job net status.
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.
Password of the user connecting with SSH to the host requesting acquisition of the job net status.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) will be searched based on the specified host name or IP address, and then Systemwalker Runbook Automation will automatically set 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 acquiring the job net status on the host requesting acquisition of the job net status.
If the "execusername" and "execpassword" are not specified, the Configuration Management Database (CMDB) will be searched based on the specified host name or IP address, and then Systemwalker Runbook Automation will automatically set 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.
OS type of the host that will acquire the status of the job net.
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 job management product for the linked product.
Specify "OMGR". This option is not case sensitive.
If the job 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 job management product name as the value. Only Systemwalker Operation Manager can be specified as a linked product with this operation component.
The maximum length of the job 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.
If the command installation path is omitted, the command installation path of the Systemwalker Operation Manager is set.
Only Systemwalker Operation 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.
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 job net status was successful. |
| Failure | 159 | The job net of the target was not found. |
161 | Failed the acquisition of the job net status. When the retry count is specified, it will be retried. | ||
187 | Authentication failed when an attempt was made to connect to the server over the network (via SSH). Alternatively, an error occurred during the processing of communications with the 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 server into which the RBA Agents have not been introduced, the network communication (SSH communication) with the server was disconnected. | ||
189 | An attempt to connect to the server over a network (using SSH) failed. Alternatively, an error occurred during the processing of communications with the 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 content of the option. | ||
200 | Acquisition of the job net status 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 | The operation components were not able to be executed normally. 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 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. 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 status of the job net is obtained successfully. The operation component was successful. If an attempt to obtain the status of the job net fails, the content of the error will be set as a string. |
jobnet_status | This variable is set to the result of acquiring the job net status, using one of the following strings:
|
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.
To check the return value, use Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When return values between 201 and 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.
