Description
This operation component uses IPCOM to remove a server from a load balancing target.
Options
Basic Options
Host name or IP address for connecting through an operation management network set in IPCOM.
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.
Host name or IP address of the server that is to be removed from a load balancing target managed by IPCOM.
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.
Advanced Options
Time period until the server is removed from a load balancing target managed by IPCOM.
Specify removetime in seconds.
Values between 0 and 3600 can be specified.
For example: If the removetime is 10 minutes: 600
An argument error occurs if a value outside the above range is entered.
If removetime is omitted, 0 (seconds) is specified.
Name of the user connecting with SSH to the IP address for connecting through an operation management network set in IPCOM.
The connecting user name must have a user role of administrator.
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.
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 IP address for connecting through an operation management network set in IPCOM.
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.
The maximum length of the connected user password is 1,024 characters. An argument error occurs if this is exceeded.
The execusername value cannot be used in operation components.
Invalidated when the value of execusername is input.
Password for the command for transitioning to the administrator EXEC mode (admin command).
If the password necessary for "execusername" and transitioning to the administrator EXEC mode is omitted, 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 password as the value.
The maximum length of the password for transitioning to the administrator EXEC mode 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.
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 | Removal from the load balancing target was successful. |
| Failure | 161 | Removal from the load balancing target failed. Retried if a retry count has been specified. |
187 | Authentication failed when an attempt was made to connect to the server over the network (using SSH). Alternatively, an error occurred during the processing of communications with 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 server over the 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 error output. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
197 | There is an error in the option content. | ||
- | - | 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 server is successfully removed from the load balancing target, . The operation component was successful. If removing the server form the load balancing target fails, this variable will be set to the content of the error as a string. |
returnCode | This variable is set to the return value. |
Notes
This operation component uses SSH communication to perform its operations. Refer to "3.16 Notes of Each Communication Method" for the notes of SSH communication.
This operation component relevant to following version of IPCOM.
IPCOM EX1000LB :EX LB series entry model
IPCOM EX1200LB :EX LB series middle range model
IPCOM EX2000LB :EX LB series hi-end model
IPCOM EX2200LB :EX LB series hi-end model
IPCOM EX2000IN :EX IN series hi-end model
IPCOM EX2200IN :EX IN series hi-end model
With an operation component, if username, password, and execpassword are omitted, Systemwalker Runbook Automation automatically sets the values stored in the CMDB. Therefore, if values stored in CMDB are to be used, it is necessary to store the required information in CMDB beforehand by using the swpm_uaimport command. Do not omit the password if information is to be stored in the CMDB. Refer to "1.4.2 swrba_uaimport (User Information Import Command)" in the Systemwalker Runbook Automation Reference Guide for information on the swpm_uaimport command.
Example of input file (CSV format) specified by the swpm_uaimport command
"IP address for connecting through an operation management network set in IPCOM","OS","User name (user roll: administrator) of the user connecting with SSH","Password of the user connecting with SSH","false","true",,"comment"
"IP address for connecting through an operation management network set in IPCOM","OS","user name different to the above connecting user name","Password for the command for transitioning to the administrator EXEC mode (admin command)"'"true"'"false",,"comment"
This operation component uses IPCOM. Refer to the relevant IPCOM documentation for information on how to set up IPCOM.
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.
