Description
This operation component connects to the virtual environment management product and creates a virtual server.
Options
Basic Options
Template name of the virtual sever to be built.
An argument error occurs if the template name is omitted.
The maximum length of the template name is 1,024 characters. An argument error occurs if this is exceeded.
Image name of the virtual server to be built.
An argument error occurs if the image name is omitted.
The maximum length of the image name is 1,024 characters. An argument error occurs if this is exceeded.
Name assigned to the virtual server to be built.
If the virtual environment is managed by ServerView Resource Orchestrator, specified virtual server name will be registered as L-Server name.
An argument error occurs if the virtual serve name is omitted.
The maximum length of the virtual server name is 1,024 characters. An argument error occurs if this is exceeded.
administrator password of the virtual server to be built.
Specify the administrator password that is set to apply image.
If the OS of the virtual server to be built is Windows, specified value will be set as the administrator password when the administrator password is not set to apply image.
An argument error occurs if the administrator password is omitted.
The maximum length of the administrator password is 1,024 characters. An argument error occurs if this is exceeded.
Network resource name to set the network environment of the virtual server to be built.
The network resource name can be specified for three network environments or less. .
If set the same network resource to a number of network environment, specify network resource name same number as network environment.
An argument error occurs if the network resource name is omitted.
The maximum length of the network resource name is 1,024 characters. An argument error occurs if this is exceeded.
The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.
For example 1: When specify to network environment 1: network_a, specify to network environment 2: network_b
network_a,network_b.
For example 2: When specify to network environment 1: network_a, specify to network environment 2: network_a, specify to network environment 3: network_b.
network_a,network_a,network_b
IP address of the Virtual Environment Management Server.
If the management Server of the virtual environment and Systemwalker Runbook Automation are same, specify '127.0.0.1'.
An argument error occurs, if IP address of the Virtual Environment Management Server is omitted.
The maximum length of the IP address of the Virtual Environment Management Server is 1,024 characters. An argument error occurs if this is exceeded.
Advanced Options
Virtual server CPU number.
If the virtual server CPU number is changed from the template configuration environment information, specify the new CPU number.
CPU number can be specified in a range between 1 and 8. If any other value is specified, an argument error occurs.
Virtual server CPU performance.
If the virtual server CPU performance is changed from the template configuration environment information, specify the new CPU performance.
GHz can be specified as a unit in a range between 0.1 and 8, up to one decimal place. A unit (GHz) does not need to specify.
The maximum length of the CPU performance is 1,024 characters. An argument error occurs if this is exceeded.
Virtual server memory size.
If the virtual server memory size is changed from the template configuration environment information, specify the new memory size.
Gbyte can be specified as a unit in a range between 0.1 and 255, up to one decimal place. A unit (Gbyte) does not need to specify.
The maximum length of the memory size is 1,024 characters. An argument error occurs if this is exceeded.
IP address allocated to the virtual server to be built.
Specify this option when allocating a specific IP address to the virtual server to be built.
The IP address can be specified for three network environments or less. Specification order is the same as "network: network resource name".
The maximum length of the IP address is 1,024 characters. An argument error occurs if this is exceeded.
The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.
The product key allocated to the virtual server to be built.
Specify this option when the OS type of the virtual server to be built is Windows.
If the OS type is other than Windows, this specification is invalid.
If the product key is omitted, the value that sets to the property definitions file of ServerView Resource Orchestrator will be used.
For example: AAAAA-BBBBB-CCCCC-DDDDD-EEEEE
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 | Building of virtual server was successful. |
| Failure | 161 | Connection error occurred between the Virtual Environment Management Server. Retried if a retry count has been specified. |
171 | Authentication failed to connect the Virtual Environment Management Server. | ||
172 | Failed to build the virtual server. | ||
188 | Connection to the Virtual Environment Management Server failed during execution. | ||
189 | An attempt to connect to the Virtual Environment Management Server has failed. | ||
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 in with the specification of the input information specification of the operation components. | ||
206 | The operation component was not executed normally. There is a problem in with the specification of the output information specification of the operation components. | ||
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 virtual server is created successfully. The operation component was successful. If an attempt to create a virtual server fails, the content of the error will be set as a string. |
returnCode | This variable is set to the return value. |
Notes
If manage a virtual environment by ServerView Resource Orchestrator, management product information and authentication information of the Management Server need to register to the Configuration Management Database (CMDB) before use this operation component. Refer to "3.18 Information Registration to CMDB (Management Product of Virtual Environment)" on how to register information.
If manage a virtual environment by ServerView Resource Orchestrator, OS property definition file is needed to define OS setting information before use this operation component. Refer to ServerView Resource Orchestrator Users Guide for details.
These operational components are relevant to the systems in which Systemwalker Software Configuration Manager is not installed.
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.
This operation component relevants following middleware.
ServerView Resource Orchestrator V2.2.0 to V3.1.1
Relevant virtualization software is VMware and Hyper-V.
