3.15.8 Deploy and Setup OS on Virtual Machine
Function
Adds a virtual server to a VMware vSphere environment by using a template.
This service template assumes the following servers:
· vCenter server
This is a server on which VMware vCenter Server is installed.
· vCenter control server
This is a server on which VMware vSphere PowerCLI is installed.
· ESX server
Server on which VMware vSphere ESXi (or VMware ESX Server) is installed
· Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESX.
The following provides an overview of the processing.
(1) Creates a virtual server using an existing template.
(2) Specifies initial information for the virtual server.
1. Specifies initial information for the OS (such as computer name and company name). Depending on the virtual server's OS, the service template specifies the following settings:
(a) For Windows
· As initial settings for the OS, the service template specifies a computer name, company name, organization name, and time zone.
The service template uses sysprep to clear the system information for the virtual server and then specifies the OS information.
(b) For Linux
· As initial settings for the OS, the service template specifies a computer name and time zone.
2. Specifies the IP address of the virtual server.
Up to 4 IP addresses can be set for the virtual server. For the first IP address (for management), set the IP address for managing the virtual server that was deployed. For the second to fourth IP addresses for the second, third, and fourth NICs, set IP addresses for management and applications based on user operation. Some of the settings use the management IP address to connect to the OS and make the settings. Depending on the number of NICs held by the virtual server, the setting order of the IP addresses are shown below:
- When the virtual server has one NIC
Set the IP addresses that were specified first in the order of IP address (for management)>IP address (for second NIC)>IP address (for third NIC)>IP address (for fourth NIC). Note that the other IP addresses are discarded.
- When virtual server has two or more NICs
Set the IP addresses in the order of IP address (for management)>IP address (for second NIC)>IP address (for third NIC)>IP address (for fourth NIC). If a specified IP address is blank, set without leaving empty space. For example, if the specified IP addresses are IP address (for management), IP address (for second NIC), and IP address (for fourth NIC) (without any IP address (for third NIC)), the IP address (for fourth NIC) is set to the third NIC of the virtual machine. Note that, if the number of entered IP addresses exceeds the number of NICs held by the virtual server, the excess IP addresses are discarded.
When the OS of the virtual server to be created is Linux, the service template sets a DNS server IP addresses for a virtual server, not every NIC. Set the DNS server IP addresses that were specified first in the order of DNS server IP address (for management)>DNS server IP address (for second NIC)>DNS server IP address (for third NIC)>DNS server IP address (for fourth NIC).
(3) If multiple IP addresses are specified for the virtual server, the service template sets a static route for the virtual server's OS.
(4) Specifies a port group for the virtual server.
The following notes apply to property settings:
(1) When the OS of the virtual server to be created is Windows, an organization name and an owner name are required. If no organization name is specified, "Organization" is assumed; if no owner name is specified, "Owner" is assumed.
(2) When the OS of the virtual server to be created is Windows, entry and re-entry of an OS user password are required. If one of them is omitted or if the entered passwords do not match, "Password123" is set as the password.
(3) When the OS of the virtual server to be created is Windows, WORKGROUP or DOMAIN must be selected from the OS.selectWorkgroupDomain selection list. If neither WORKGROUP nor DOMAIN is selected, "WORKGROUP" is set as the workgroup. If no workgroup name or domain name is entered, "WORKGROUP" is set as the workgroup.
(4) When the OS of the virtual server to be created is Windows and WORKGROUP is selected from the OS.selectWorkgroupDomain selection list, a maximum of 15 bytes can be specified for the workgroup name. If the specified workgroup name exceeds 15 bytes, "WORKGROUP" is assumed.
(5) When the OS of the virtual server to be created is Windows and DOMAIN is selected from the OS.selectWorkgroupDomain selection list, a domain name, domain user name, and domain password are required. If any one of them is omitted or a specified value is invalid, "WORKGROUP" is set as the workgroup.
(6) When the OS of the virtual server to be created is Linux, a domain name and DNS suffix are required. If the specification is omitted, "localdomain" is assumed.
(7) When the OS of the virtual server to be created is Windows, all four of IP address, subnet mask, default gateway, and DNS server must be specified. If any one of them is omitted, none of them is set.
(8) When the OS of the virtual server to be created is Linux, all three of IP address, subnet mask, and default gateway must be specified. If any one of them is omitted, none of them is set.
(9) If the OS information acquisition repeat count is omitted, "72" is assumed.
(10) If the OS information acquisition repeat interval is omitted, "5" is assumed.
(11) You must specify both the current port group name and the new port group name. If either is omitted, the port group is not renamed. If there are multiple port groups with the same name, only one of them is renamed.
(12) All three of destination IP address, subnet mask, and default gateway must be specified. If any one of them is omitted, a static route is not set.
(13) A maximum of 60 characters can be specified in the virtual server name property (vmware.vmName).
(14) The time zones that can be specified are shown below.
(a) For Windows
Alaskan
Central (U.S. and Canada)
Central America+B28
China
Eastern (U.S. and Canada)
GMT (Greenwich Mean Time)
Hawaii
India
Mountain (U.S. and Canada)
Pacific
Singapore
Tokyo
U.S. Eastern: Indiana (East)
U.S. Mountain: Arizona
(b) For Linux
America/Adak
America/Anchorage
America/Boise
America/Chicago
America/Denver
America/Detroit
America/Indiana/Indianapolis
America/Indiana/Knox
America/Indiana/Marengo
America/Indiana/Petersburg
America/Indiana/Tell_City
America/Indiana/Vevay
America/Indiana/Vincennes
America/Indiana/Winamac
America/Juneau
America/Kentucky/Monticello
America/Los_Angeles
America/LouisVille
America/Menominee
America/Monterrey
America/Montevideo
America/New_York
America/Nome
America/North_Dakota/Beulah
America/North_Dakota/Center
America/North_Dakota/New_Salem
America/Phoenix
America/Shiprock
America/Tijuana
America/Vancouver
America/Yakutat
Asia/Chongqing
Asia/Hong_Kong
Asia/Kolkata
Asia/Macau
Asia/Shanghai
Asia/Singapore
Asia/Tokyo
Etc/UTC
Europe/London
Pacific/Honolulu
(15) If nothing is specified in the time zone property (OS.timeZoneWin), the time zone "International Date Line: Western side" is set.
(16) If nothing is specified in the time zone property (OS.timeZoneLin), the time zone in the template is used. For this reason, if the value that you want to set in the time zone property list is not found, set the time zone in the template beforehand.
Prerequisites
For the latest support information about [Required product for the system]/[Required products for the service template execution system]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product for the system]
JP1/Automatic Operation 12-00 or later
[Required products for the service template execution system]
(1) Required product for the vCenter server
· VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0, 4.1, or 4.0
(2) VMware vSphere ESXi (or VMware ESX Server) that manages virtual servers
· VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0 or VMware ESX Server 4.1 or 4.0
(3) Required product for the vCenter control server
· VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 5.0
· VMware PowerCLI 6.5 Release1
· VMware PowerCLI 6.5.1, 6.5.4
· VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
[Prerequisite product OS running in the system executing the service template]
(1) Prerequisite OS of the virtual server
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi (or VMware ESX Server)/vCenter control server that manages the virtual server.
· Windows Server 2008 R2 Standard/Enterprise/Datacenter
· Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
· Windows Server 2016 Standard/Datacenter
· Windows Server 2019 Standard/Datacenter
· Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64) (for vCenter4.1 or later; not supported by vCenter4.0)
· Red Hat Enterprise Linux Server 7 (64-bit x86_64)
The bind-utils package must be installed.
· Red Hat Enterprise Linux Server 8 (64-bit x86_64)
The bind-utils package must be installed.
· CentOS 6 (64-bit x86_64)
· CentOS 7 (64-bit x86_64)
The bind-utils package must be installed.
· CentOS 8 (64-bit x86_64)
The bind-utils package must be installed.
(2) Required OS for the vCenter control server
· Windows Server 2008 R2 Standard/Enterprise/Datacenter
· Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
· Windows Server 2016 Standard/Datacenter
· Windows Server 2019 Standard/Datacenter
[Usage conditions for the required products for the service template execution system]
(1) Conditions for the settings on VMware vSphere ESXi (or VMware ESX Server)
· A data store has been registered.
· The port group set in the template must be set on the deployment-destination ESX server, and must be able to communicate with the local server.
· The port group to set in the virtual server must be set on the deployment-destination ESX server, and must be able to communicate with the local server.
· For a port group, specify a port group on the network using a standard virtual switch (vNetwork or vSphere standard switch).
· The data store name and port group name used during deployment must consist of ASCII characters.
· The template used for deployment has already been created.
· If the virtual server is stored in a resource pool, the resource pool, cluster, and vApp names must be unique.
The same name cannot be assigned to more than one resource pool, cluster, and vApp although their types are different, such as a duplication of a cluster name and a vApp name or a duplication of a cluster name and a resource pool name.
· The VMware-related names listed below are case-sensitive in VMware, but they are not case-sensitive in vSphere Power CLI that is executed from this service. For this reason, this service cannot be used in an environment where names can be used that are the same except for case differences.
· Data store name
· Resource pool name
· vApp name
(2) Conditions for the template used for deployment:
· VMware Tools have been installed.
· The execution of remote commands is allowed as per the settings (administrative share for Windows, while SSH for Linux is enabled, respectively).
· NICs have been configured (up to four).
· For a port group, specify a port group on the network using a standard virtual switch (vNetwork or vSphere standard switch).
· The reception of and response to pings is allowed.
· For Windows, the password of the administrator is left blank.
· For Windows, execute sysprep. To execute sysprep, the maximum number of Windows initializations (three times) must not be reached.
· When you convert a virtual server to a template, do so when the virtual server is stopped.
(3) Condition of the virtual server
· There is no duplication of the virtual server name under the management of an identical vCenter.
(4) Conditions of this product
· The authentication information of the virtual server to be deployed has been registered to the agentless connection destination definition in the "Management" tab in advance.
Cautions
(1) The specified port group must be able to communicate with the local server. If there are multiple NICs for the virtual server, set one of the NICs to a port group that can communicate with the local server.
(2) Whether OS initialization processing has been completed is determined by whether the information set in the OS can be acquired. The time required for determining completion of initialization depends on the value specified for the OS information acquisition repeat interval (vmware.checkOSInitCountInterval property), as well as the specification of the OS information acquisition repeat count (vmware.checkOSInitCount property). If the specified value is too small, a timeout might occur even during OS initialization. Adjust the value appropriately for the performance of the virtualization environment being used. Initially, specify the settings so that the OS information acquisition repeat interval is at least a few hours.
(3) Do not specify for the IP addresses that are to be set values that are not valid as IP addresses in the virtual server's OS, such as management and application IP addresses. For example, network addresses, broadcast addresses, and special addresses such as 0.0.0.0 and 255.255.255.255 cannot be specified. If an invalid address is entered, the virtual server deployment processing will result in an error. For a management IP address, specify an IP address that can be used to communicate with the local server. Be aware that even though the correct address is specified, deployment might fail.
(4) While the virtual server is being deployed, do not use any other service to manipulate it. Doing so may cause deployment of the virtual server to fail. Also, do not manipulate the virtual server directly from a vCenter server.
(5) When you are deploying Linux, specify a root password for the template OS in the Linux.adminPassword property (using the permitted characters).
(6) Do not specify in advance in the virtual server template any information that is to be specified when the virtual server is created. If a computer name or host name and IP address are already set in the template, virtual server creation might fail. If virtual server creation fails (for example, static route processing results in an error), delete the virtual server, re-create a template in which no computer name, host name, or IP address is set, and then re-execute this service.
(7) The IP addresses are set as described in Function. However, depending on the order in which NICs are set in the virtual server's OS, the IP addresses might not be set as intended. After you have created the virtual server, check if the correct IP addresses have been set. If the correct IP addresses are not set, change them manually.
(8) For the virtual server, do not specify the same IP address as another server. Specifying the same IP address as another server disables the network interface card (NIC) of the virtual server, causing tasks to terminate abnormally.
(9) If the operating system of the virtual server is Red Hat Enterprise Linux Server 7 (64-bit x86_64), you must use open-vm-tools 9.10 or later for VMware Tools. If you use any version older than open-vm-tools 9.10, the host name is not modified and the service is not finished until completion of the initialization has been verified.
Execution privilege
(1)The user who will be connecting to VMware vCenter Server must have the following permissions:
System administrator role
(2) The user who will be connecting to vCenter operation server must have the following permissions:
Built-in Administrator
Version
03.00.00
Tags
Add VM,VMware vSphere
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Virtual system environment information |
Specify the VMware vCenter Server information. |
Y |
|
Virtual server information |
Specify the information for the virtual server to be added. |
Y |
|
OS information |
Specify the Windows or Linux OS information for creating the virtual server. |
Y |
|
Network information |
Specify the network information for the virtual server. |
Y |
|
Run-time options |
These are properties related to checking the status during initialization of the OS on the virtual server. Modify as necessary. |
N |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
vmware.targetHost |
Host name of VMware vCenter control server |
Specify the host name or IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.vCenterServerName |
VMware vCenter server name |
Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.portNumber |
Port number for VMware vCenter Server connection |
Specify the port number to use when connecting to the VMware vCenter server (specifically, the port number of the VMware vCenter server's Web service). If you omit this property, the default value of the VMware vCenter server applies. |
Input |
Disabled |
O |
Virtual system environment information |
|
vmware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
windows.orgName |
Organization (company name) :Windows only |
Specify the organization name for the virtual server OS (Windows only). When there is no input, "Organization" is set up. |
Input |
Disabled |
O |
OS information |
|
windows.ownerName |
Owner name :Windows only |
Specify the owner name for the OS on the virtual server (Windows only). When there is no input, "Owner" is set as the Owner name. |
Input |
Disabled |
O |
OS information |
|
OS.selectWorkgroupDomain |
Select workgroup or domain :Windows only |
Specify whether the virtual server belongs to a workgroup or domain (Windows only). |
Input |
Disabled |
O |
OS information |
|
OS.workgroupNameDomainName |
Workgroup/domain name |
Specify the name of the workgroup or domain of virtual server. A workgroup is specified a maximum of 15 characters. A domain of a maximum of 63 characters is specified in Windows. In Linux, a domain of a maximum of 256 characters is specified. |
Input |
Disabled |
O |
OS information |
|
OS.domainUserName |
Domain user name :Windows only |
Specify the domain user name for the virtual server (Windows only). When "DOMAIN" is chosen by selection of a workgroup/domain, it is necessary to input. |
Input |
Disabled |
O |
OS information |
|
OS.domainUserPassword |
Domain password :Windows only |
Specify the domain password for the virtual server (Windows only). When "DOMAIN" is chosen by selection of a workgroup/domain, it is necessary to input. |
Input |
Disabled |
O |
OS information |
|
OS.dnsSuffix |
DNS suffix :Linux only |
Specify the DNS suffix of the virtual server (Linux only). When there is no input, "localdomain" is set as the DNS suffix. |
Input |
Disabled |
O |
OS information |
|
OS.subnetMaskMan |
Subnet mask (management LAN) |
Specify the subnet mask for the management LAN of the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.defaultGWMan |
Default gateway (management LAN) |
Specify the default gateway for the management LAN of the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.dnsMan |
DNS server IP address (management LAN) |
Specify the IP address of the DNS server for the management LAN of the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.subnetMask2 |
Subnet mask (for second NIC) |
Specify the 2nd subnet mask for the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.defaultGW2 |
Default gateway (for second NIC) |
Specify the 2nd default gateway for the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.dns2 |
DNS server IP address (for second NIC) |
Specify the 2nd IP address of the DNS server for the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.subnetMask3 |
Subnet mask (for third NIC) |
Specifies the subnet mask that is set for the third NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.defaultGW3 |
Default gateway (for third NIC) |
Specifies the default gateway that is set for the third NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.dns3 |
DNS server IP address (for third NIC) |
Specifies the IP address of the DNS server that is set for the virtual server. In Windows, this value is set on the third NIC recognized by the OS. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.subnetMask4 |
Subnet mask (for fourth NIC) |
Specifies the subnet mask that is set for the fourth NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.defaultGW4 |
Default gateway (for fourth NIC) |
Specifies the default gateway that is set for the fourth NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.dns4 |
DNS server IP address (for fourth NIC) |
Specifies the IP address of the DNS server that is set for the virtual server. In Windows, this value is set on the fourth NIC recognized by the OS. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.destIPAddress |
Destination IP of static route |
Specify the destination IP address of the static route. |
Input |
Disabled |
O |
Network information |
|
OS.subnetMaskStaticRoute |
Subnet mask (static route) |
Specify the subnet mask for the static route. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.defaultGWStaticRoute |
Default gateway (static route) |
Specify the default gateway for the static route. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
vmware.checkOSInitCount |
Number of attempts to acquire OS information |
Specify the number of times the service attempts to acquire OS information to confirm that the OS has been initialized. The maximum wait time is determined by this property and the property that defines the checkOSInitCountInterval. |
Input |
Disabled |
O |
Run-time options |
|
vmware.checkOSInitCountInterval |
Interval for acquiring OS information (minutes) |
Specify the interval at which the service attempts to acquire OS information to confirm that the OS has been initialized. |
Input |
Disabled |
O |
Run-time options |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
vmware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
Input |
Disabled |
R |
Virtual server information |
|
vmware.templateName |
Template name |
Specify the name of the template on which the virtual server is to be based. |
Input |
Disabled |
R |
Virtual server information |
|
vmware.vmHostName |
ESX server name |
Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server. |
Input |
Disabled |
R |
Virtual server information |
|
vmware.dataStoreName |
Datastore name |
Specify the datastore name. |
Input |
Disabled |
R |
Virtual server information |
|
vmware.resourcePoolName |
Resource pool name |
Specify the resource pool, vApp, or cluster where the virtual server will be provisioned. |
Input |
Disabled |
O |
Virtual server information |
|
vmware.portGroupName |
Port group name |
Specify the name of the port group currently assigned to the virtual server. |
Input |
Disabled |
O |
Virtual server information |
|
vmware.portGroupNameNew |
Port group name (updated) |
Specify a new port group name to assign to the virtual server. |
Input |
Disabled |
O |
Virtual server information |
|
OS.computerName |
Computer/host name |
Specify the computer name (host name) used by the operating system. The computer name of a maximum of 15 characters is specified, in the case of Windows. The computer name of a maximum of 63 characters is specified, in the case of Linux. |
Input |
Disabled |
R |
OS information |
|
OS.osUserPassword |
Administrator password: Windows-specific |
Specifies the Administrator password specified in the OS (Windows systems only). If nothing is entered, "Password123" is specified. |
Input |
Disabled |
O |
OS information |
|
OS.osUserPasswordReEnter |
Re-enter Administrator password: Windows-specific |
Re-enter the Administrator password specified in the OS (Windows systems only). If nothing is entered, "Password123" is specified. |
Input |
Disabled |
O |
OS information |
|
OS.productKey |
OS product key :Windows only |
Specify the OS product key (for Windows-based virtual servers) in the format XXXXX-XXXXX-XXXXX-XXXXX-XXXXX (Windows only). |
Input |
Disabled |
O |
OS information |
|
Linux.adminPassword |
OS root user password :Linux only |
Specify the root user's password of OS for carrying out a OS setting check. In case of creating Linux virtual server, it's mandatory. |
Input |
Disabled |
O |
OS information |
|
OS.ipAddressMan |
IP address (management LAN) |
Specify the IP address for the management LAN of the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.ipAddress2 |
IP address (for second NIC) |
Specify the 2nd IP address for the virtual server. You cannot specify an IPv6 address. |
Input |
Disabled |
O |
Network information |
|
OS.ipAddress3 |
IP address (for third NIC) |
Specifies the IP address that is set for the third NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.ipAddress4 |
IP address (for fourth NIC) |
Specifies the IP address that is set for the fourth NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
OS.timeZoneWin |
Time zone: Windows setting |
Specifies the time zone that the OS on the virtual server is set to (for Windows only). If nothing is entered, the time zone "International Date Line West" is used. |
Input |
Disabled |
O |
OS information |
|
OS.timeZoneLin |
Time zone: Linux setting |
Specifies the time zone that the OS on the virtual server is set to (for Linux only). If nothing is entered, the time zone in the template is used. |
Input |
Disabled |
O |
OS information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
vmware.targetHost |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.vCenterServerName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.userName |
A maximum of 512 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, %. |
|
vmware.password |
A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
vmware.portNumber |
Integer between 1 and 65535 can be entered. |
|
vmware.protocol |
Select one of the following values: http,https |
|
windows.orgName |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
windows.ownerName |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, or %. |
|
OS.selectWorkgroupDomain |
Select one of the following values: WORKGROUP,DOMAIN |
|
OS.workgroupNameDomainName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
OS.domainUserName |
A maximum of 20 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, \, @ or %. |
|
OS.domainUserPassword |
A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], ` or %. |
|
OS.dnsSuffix |
A maximum of 63 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
OS.subnetMaskMan |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.defaultGWMan |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.dnsMan |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.subnetMask2 |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.defaultGW2 |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.dns2 |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.subnetMask3 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.defaultGW3 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.dns3 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.subnetMask4 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.defaultGW4 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.dns4 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.destIPAddress |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.subnetMaskStaticRoute |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.defaultGWStaticRoute |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
vmware.checkOSInitCount |
Integer between 1 and 1024 can be entered. |
|
vmware.checkOSInitCountInterval |
Integer between 1 and 1024 can be entered. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
vmware.vmName |
A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, , and %. |
|
vmware.templateName |
A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, ', ", *, ?, [, ], `, %. |
|
vmware.vmHostName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.dataStoreName |
A maximum of 42 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
vmware.resourcePoolName |
A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], ` and %. |
|
vmware.portGroupName |
A maximum of 49 characters can be entered. Characters that can be used include alphanumeric characters, as well as " "(space), -, ., / and _. |
|
vmware.portGroupNameNew |
A maximum of 49 characters can be entered. Characters that can be used include alphanumeric characters, as well as " "(space), -, ., / and _. |
|
OS.computerName |
A maximum of 63 characters can be entered. Characters that can be used include alphanumeric characters, as well as - . |
|
OS.osUserPassword |
A character string of no more than 64 characters can be entered. It cannot include <, >, |, ;, `, or a trailing \. In case of executing this service to UNIX, it cannot include multibyte character. |
|
OS.osUserPasswordReEnter |
A character string of no more than 64 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \. In case of executing this service to UNIX, it cannot include multibyte character. |
|
OS.productKey |
A maximum of 29 characters can be entered. Characters that can be used include alphanumeric characters, as well as -. |
|
Linux.adminPassword |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.ipAddressMan |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.ipAddress2 |
A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . . |
|
OS.ipAddress3 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.ipAddress4 |
A string of 15 characters of fewer. Usable characters are single-byte numbers and a period (.). |
|
OS.timeZoneWin |
Select one of the following values: Tokyo, China, GMT (Greenwich Mean Time), Pacific, Eastern (U.S. and Canada), U.S. Eastern: Indiana (East), Central (U.S. and Canada), Central America, U.S. Mountain: Arizona, Mountain (U.S. and Canada), Alaskan, Hawaii, Singapore, India |
|
OS.timeZoneLin |
Select one of the following values: Asia/Tokyo, Asia/Hong_Kong, Asia/Chongqing, Asia/Shanghai, Etc/UTC, America/Tijuana, America/Vancouver, America/Los_Angeles, America/Detroit, America/New_York, America/Montevideo, America/LouisVille, America/Indiana/Indianapolis, America/Indiana/Vevay, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indiana/Tell_City, America/Indiana/Knox, America/Chicago, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Kentucky/Monticello, America/Juneau, America/Menominee, America/Monterrey, America/Denver, America/Boise, America/Shiprock, America/Phoenix, America/Yakutat, America/Anchorage, America/Nome, America/Adak, Pacific/Honolulu, Asia/Singapore, Europe/London, Asia/Kolkata, America/North_Dakota/Beulah, Asia/Macau |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
vsphereCreateClone |
Create virtual server |
Creates a virtual server from a template. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
vsphereInitOS |
Flow Plug-in |
Sets the initial OS settings (computer name, company name, and organization name) and the IP address of a virtual server, then starts the server (In the case of Windows, sysprep is run internally). |
-- |
|
2-3 |
Compatible Plug-in |
Checks whether the OS is Windows. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
2-4 |
Set OS initialization settings and IP address of virtual server (Windows) |
Performs OS initialization and IP address setting on a virtual server (for Windows). |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
2-5 |
Compatible Plug-in |
Checks whether the OS is Linux. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
2-6 |
Set OS initialization settings and IP address of virtual server (Linux) |
Performs OS initialization and IP address setting on a virtual server (for Linux). |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
3 |
osSetStaticRoute |
Flow Plug-in |
Sets a static route in the OS of a virtual server. |
-- |
|
3-3 |
Compatible Plug-in |
Checks whether a static route needs to be set. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
3-4 |
Flow Plug-in |
-- |
-- |
|
|
3-4-3 |
Compatible Plug-in |
Checks whether the management IP address is set. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
3-4-4 |
Flow Plug-in |
Sets a static route on the OS. |
-- |
|
|
3-4-4-3 |
Compatible Plug-in |
Checks whether the OS is Windows. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
3-4-4-4 |
Set static route |
Sets a static route (for Windows). |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
3-4-4-5 |
Compatible Plug-in |
Checks whether the OS is Linux. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
3-4-4-6 |
Set static route |
Sets a static route (for Linux). |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |
|
|
4 |
vsphereChangeVMPortGroup |
Change virtual machine port group |
Specifies the port group of the virtual server. |
Eliminate the cause of the error, execute the virtual server deletion service, and then re-execute this service. |