Description
This operation component sets up network definitions for servers.
After a virtual server has been created, the following definitions can be set up for the virtual server.
If the operating system is Windows:
Domain name
Work group name
DNS server address
WINS address
If the operating system is Linux or Solaris:
DNS server address
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.
Domain name defined for the operating system.
This option can be specified only if the OS type is Windows. If the operating system is not Windows, this will be ignored.
If this option is specified, both the "domainusername" option and the "domainpassword" option must also be specified.
The maximum length of the domain name is 255 characters. An argument error will occur if this limit is exceeded.
If the domain name is omitted, the domain name will not be set up.
Workgroup name defined for the operating system.
This option can be specified only if the OS type is Windows. If the operating system is not Windows, this will be ignored.
Additionally, if the domain name is specified, the specified workgroup name will be ignored.
The maximum length of the work group name is 1,024 characters. An argument error will occur if this limit is exceeded.
If the work group name is omitted, a work group name will not be set up.
Network interface name in which the DNS server address and WINS address are defined.
This option can be specified only if the OS type is Windows. If the operating system is not Windows, this will be ignored.
The maximum length of the network interface name is 1,024 characters. An argument error will occur if this limit is exceeded.
This option cannot be omitted when setting up either a DNS server address or WINS address if the OS type is Windows.
DNS server address defined for the operating system.
Multiple DNS server addresses can be specified. The first address specified is set as the preferred DNS server.
The maximum allowable number of DNS server addresses is 10. An argument error will occur if this limit is exceeded.
If the operating system type is "Windows", "dns" must be specified together with "interfacename". You cannot specify "dns" alone.
When specifying the Management Server, specify the address of the Management Server instead of a loopback address.
If a DNS server address is omitted, a DNS server address will not be set up.
The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.
WINS address defined for the operating system.
This option can be specified only if the OS type is Windows. If the operating system is not Windows, this will be ignored.
Multiple WINS addresses can be specified. The first address specified will be set up as the primary WINS server.
The maximum allowable number of WINS server addresses is 10. An argument error will occur if this limit is exceeded.
When specifying the Management Server, specify the address of the Management Server instead of a loopback address.
"wins" must be specified together with "interfacename". You cannot specify "wins" alone.
If a WINS address is omitted, a WINS address will not be set up.
The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.
Advanced Options
The user name for participating in the domain.
If a domain name is specified, both this option and the "domainpassword" option must also be specified.
If the domain name specification is omitted, the specification for this option will be ignored.
The maximum length of the user name is 1,024 characters. An argument error will occur if this limit is exceeded.
The password for participating in the domain.
If a domain name is specified, both this option and the "domainusername" option must also be specified.
If the domain name specification is omitted, the specification for this option will be ignored.
The maximum length of the password is 1,024 characters. An argument error will occur if this limit is exceeded.
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 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 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 even though 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
Note that the retries will not be performed if multiple network definitions have been specified, or if multiple values have been specified for each network definition.
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 set up the network for the operating system. | |
Failure | 161 | Failed to set up the network for the operating system. If a retry count has been specified, retries will be performed. If multiple network definitions have been specified, retries will not be performed. | |
174 | Saving data to the Configuration Management Database (CMDB) has failed. | ||
180 | Failed to set up the domain name, the workgroup name, the DNS server address or the WINS address. Check the "Return_code" column in the standard output for the return values for each setting. | ||
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. Alternatively, there is a problem with the information registered in the Configuration Management Database (CMDB). | ||
200 | Setting up the network for the operating system 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. |
Output information
Variable | Description |
---|---|
message | This variable will be set to the following message if all of the network definitions are set successfully. The operation component was successful. If some or all of the network definition settings fail, information for the items that failed to be set will be set using the same format as the "network_set_result" variable. |
network_set_result | This variable is set to the return values and setting results for each network definition. Each of the return values and the setting results that are set is separated by a comma (","). |
returnCode | This variable is set to the return value. |
The output format for the "network_set_result" variable is as follows:
[definition item],[setting value],[return value],[setting result]
For [setting result], one of the following will be output:
The string "Success" will be output if definitions are set successfully.
If an attempt to set definitions fails, the content of the error will be output as a string.
Example: If all network definitions are specified and setting the WINS address fails
"Item","Value",Return_code,"Result"
"domain","domain1",0,"Success"
"dns","192.0.2.0",0,"Success"
"dns","192.0.2.1",0,"Success"
"wins", "192.0.2.3", 161, " Invalid interface Local Area Connection2 specified"
In the example above, the following will be output to the "message" variable.
Example:
"Item","Value",Return_code,"Result"
"wins", "192.0.2.3", 161, " Invalid interface Local Area Connection2 specified"
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.
At least one of the following network definitions must be specified:
Domain name
Work group name
DNS server address
WINS address
It is not possible to set up work group names for servers that participate in domains. An error will occur if an attempt is made to set up a work group name.
This operation component uses the netdom command to set up a domain. For Windows Server 2003, this command is included in the support tool. To set up a domain for Windows Server 2003 servers, install the support tool in advance. There is no need to install the support tool for Windows Server 2008 and Windows Server 2012.
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.
Operations are carried out for the following files if defining the network using this operation component:
If the relevant host is Linux:
/etc/resolve.conf
If the relevant host is Solaris:
/etc/resolve.conf (if the file does not exist, this operation component will create it. To validate the DNS registration, restart the relevant host.)
/etc/nsswitch.conf
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.