Description
This operation component changes either the computer name (for Windows) or host name (for Linux or Solaris) of the specified host.
To change host names using this operation component, the target host must be restarted.
Options
Basic Options
Target host name or IP address where the operation component will be executed.
An argument error will occur if the host name or IP address is omitted.
An argument error will occur if a loopback interface host name or IP address, such as 'localhost', '127.0.0.1' or '::1' is specified.
The maximum length of the host name or IP address is 1,024 characters. An argument error will occur if this limit is exceeded.
Specify the host name after the specified host was modified.
An argument error will occur if the new host name is omitted.
The maximum length of the new host name is 1,024 characters. An argument error will occur if this limit is exceeded.
Advanced Options
Specify whether the defined content will be reflected in the Configuration Management Database (CMDB).
To reflect the content in CMDB, specify "on".
To avoid reflecting the content in CMDB, specify "off".
If omitted or some other value than the options listed above is specified, "off" is used by default. This option is not case sensitive.
Operating system of the host executing the operation component.
Specify either Windows or Linux or Solaris. This option is not case sensitive.
If the OS type is omitted, the operation component 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.
User connecting to the domain.
Both this option and domainpassword must be specified if the host where the operation component will be executed is running Windows and participates in a domain.
This option is ignored if the host is running Linux or Solaris or is not participating in a domain.
The maximum length of the user name is 1,024 characters. An argument error will occur if this limit is exceeded.
Password of the user connecting to the domain.
Both this option and domainusername domainpassword must be specified if the host where the operation component will be executed is running Windows and participates in a domain.
This option is ignored if the host is running Linux or Solaris or is not participating in a domain.
The maximum length of the password 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 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 password that has been acquired from the CMDB.
If the connection is made using the file transfer infrastructure, the user name 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 that will execute the processing on the target host where the operation component is to be executed.
If the "execusername" and "execpassword" 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 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 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 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.
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 | The host name has been successfully changed. |
| Failure | 161 | Changing the host name has failed. If a retry count has been specified, retries will be performed. |
174 | Saving data to the Configuration Management Database (CMDB) has failed. | ||
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 the input information. | ||
198 | There is an error with an option specification. | ||
- | - | 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 | The operation component has not been executed normally. 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. |
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if the host name is changed successfully. The operation component was successful. If an attempt to change the host name fails, the content of the error will be set as a string. |
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 either 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.
To change a host name using this operation component, edit the following files.
If the relevant host is Linux:
/etc/sysconfig/network
/etc/hosts
If the relevant host is Solaris:
/etc/hosts
However, if IP address in an IPv6 environment is specified in hostname and IP address of host name changed by /etc/hosts file is described by the format "x:x:x:x:x:x:d.d.d.d" ("d" part in 4 low-order is IPv4 address), the execution of operation components may be failed.
Alphanumeric characters and hyphens "-" can be specified for the new host name. Specify a letter for the first character of the host name, and an alphanumeric character for the last character of the host name.
If "on" is specified for the cmdbupdate option, an error with return value "174" will occur if the information for the server specified by the hostname option has not been registered in the CMDB.
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 of 201-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.
