3.6.2 Add a virtual server (deploy/OS initial settings)
Function
This service template uses an exported virtual server to add a virtual server to the Hyper-V environment.
The assumptions about the server in this service template are shown below.
- Hyper-V server
This is the server where Hyper-V is installed.
- Virtual server
This is a virtual server managed by Hyper-V.
- Exported virtual server
This is the virtual server exported from Hyper-V and the set of configuration files for the virtual server.
- Storage server
This is a server that stores the exported virtual server that is used as the copy source.
An overview of the processing is as follows.
(1) A virtual server is created in the Hyper-V server.
1. The exported virtual server is copied to the import target.
2. The import function is used to create a virtual server in the Hyper-V server.
A new unique ID is created for the new virtual server that is created.
If a folder already exists at the path specified for the import target, that folder is used.
(2) The connection target virtual switch (for management) of the virtual server is set.
The virtual switch (for management) is set to the NIC for establishing communication with the local server.
Connection target virtual switches that were already set to the exported virtual server are overwritten by the specified virtual switches.
Set a virtual switch for management that is capable of communication with the local server to the first NIC. For the second to fourth NICs, set virtual switches for management and applications based on user operation.
If the number of specified virtual switches exceeds the number of NICs held by the virtual server, the settings for virtual switches not assigned to NICs are invalid.
(3) The response file for OS customization is created and assigned.
1. The virtual disk of the virtual server is mounted to the Hyper-V server.
2. A response file for OS customization is created on the mounted virtual disk.
3. The virtual disk is unmounted from the Hyper-V server.
(4) The virtual server is started, and the initial information of the virtual server is set.
1. Set the initial information for the OS (such as computer name and company name).
Set the computer name, company name, organization name, and time zone for the initial settings of the OS.
2. Set 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.
(5) The connection target virtual switches (for the second to fourth NICs) of the virtual server are set.
Connection target virtual switches that were already set to the exported virtual server are overwritten by the specified virtual switches.
Set a virtual switch for management that is capable of communication with the local server to the first NIC. For the second to fourth NICs, set virtual switches for management and applications based on user operation.
If the number of specified virtual switches exceeds the number of NICs held by the virtual server, the settings for virtual switches not assigned to NICs are invalid.
(6) A static route is set when the IP address (for management) set to the virtual server OS is specified and multiple IP addresses are specified for the virtual server.
(7) The process for joining the domain is performed when DOMAIN is selected in the OS.selectWorkgroupDomain selection list, and a domain name, domain user name, and domain password were specified.
The important points for the property settings are shown below.
(1) Entry and re-entry of the OS user password are required. If both are not entered, "Password123" is set as the password. Also, if the two values do not match, "Password123" is set as the password.
(2) When WORKGROUP is selected in the OS.selectWorkgroupDomain selection list, the workgroup name can be specified using a maximum of 15 bytes. If the workgroup name exceeds 16 bytes, "WORKGROUP" is set.
(3) When DOMAIN is selected in the OS.selectWorkgroupDomain selection list, the domain name, domain user name, and domain password are required. If one of these is not specified, or if joining of the domain failed, "WORKGROUP" is set as the workgroup.
(4) Specify the IP address, subnet mask. If one of these items is not specified, none of these items are set.
(5) If no virtual switch is specified, the virtual switch connection is disconnected.
(6) Specify the destination IP address, subnet mask, and default gateway for the static route at the same time. If one of these items is not specified, the static route is not set.
(7) The time zones that can be specified are shown below.
Tokyo Standard Time
China Standard Time
GMT Standard Time
Pacific Standard Time
Eastern Standard Time
US Eastern Standard Time
Central Standard Time
Central America Standard Time
US Mountain Standard Time
Mountain Standard Time
Alaskan Standard Time
Hawaiian Standard Time
Singapore Standard Time
India Standard Time
If this is not specified, the time zone that was set to the exported virtual server is inherited.
(8) The locales that can be specified are shown below.
ja-JP
en-US
zh-CN
(9) The OS names that can be specified are shown below.
Windows Server 2008 R2
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1)Prerequisite product of Hyper-V Server
- Windows Server 2008 R2 Hyper-V
[Prerequisite product OS running in the system executing the service template]
(1) Prerequisite OS of Hyper-V Server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
(2) Prerequisite OS of the virtual server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions of prerequisite products in the system executing the service template]
(1) Setting requirements for Hyper-V server
- Virtual switch must be set.
- The virtual switch name must be unique within the Hyper-V server.
- The exported virtual server used during deployment must be already created.
(2) Setting requirements for exported virtual server used during deployment
- The following Hyper-V Integration Service must be enabled.
1. Data Exchange
- The following settings must have been made in the virtual server before exporting from the Hyper-V server.
1. The administrator password must be left blank.
2. The network settings must have been deleted.
If the network adapter information of the virtual host is set, the settings below must be made blank before setting to [Obtain an IP address automatically] or [Obtain DNS server address automatically].
- IP address
- Subnet mask
- Default gateway
- Preferred DNS server
- Alternate DNS server
3. Sysprep must be used to initialize the OS information.
During the initialization process, select the following options.
From the System Cleanup Action drop down, select [Enter System Out of Box Experience (OOBE)].
Select the [Generalize] check box.
- The settings allow agentless connections.
- The NICs must be already set (up to a maximum of four).
- The firewall allows ICMP (echo) replies.
- If the storage server is separate from the Hyper-V server, shared settings were made from the Hyper-V server to the folder where the exported virtual server is stored.
- No legacy network adapter is set.
- No snapshot or differencing disk is created.
(3) Setting requirements for virtual server
- The virtual server name must be unique within the Hyper-V server.
(4) this product requirements
- The authentication information for the local server (loopback address resolved by "localhost"), Hyper-V server, and deployed virtual server IP address (for management) must be registered beforehand to Connection Destinations in Administration tab.
Cautions
(1) If the virtual switch is not specified, the connection target virtual switch information of the NIC is deleted, and the virtual switch is in a disconnected state. Always specify the virtual switch when setting.
(2) Do not enter values that cannot be set as IP addresses for the IP address that is set for the virtual server OS. For example, network addresses, broadcast addresses, and special addresses such as "0.0.0.0" and "255.255.255.255" cannot be specified. If one of these addresses is entered, an error will occur in the deployment of the virtual server. Also, for the IP address (for management), enter an IP address capable of communication with the local server. Even if the address is correct, the virtual server might fail to deploy.
(3) While the virtual server is being deployed, do not operate the virtual server using another service. This could cause deployment of the virtual server to fail. Also, do not operate the virtual server directly from the Hyper-V server.
(4) The IP address is set as described in "Functions", but depending on the order that the NICs were set in the virtual server OS, the IP addresses might not be set properly. Make sure that the IP addresses were set after the virtual server is created. If the IP addresses were not set properly, change them manually.
(5) The IP address that is set for the virtual server must not duplicate the IP address of any other server. If another server has the same IP address, the NIC of the virtual server might become invalid, and the task abnormally terminated.
(6) Do not set the information that is set for creating the virtual server beforehand to the exported virtual server. If the computer name/host name or IP address are already set to the exported virtual server, creation of the virtual server might fail. If creation fails (one example of failure is an error occurring in the static route process), delete the virtual server, recreate an exported virtual server without setting the computer name, host name, and IP address, and then execute this service again.
(7) If deploying to Windows Server 2008 R2 Hyper-V based on a virtual server created by Windows Server 2008 R2 SP1 Hyper-V, disable both Microsoft RemoteFX and the dynamic memory.
(8) If deployment failed, the response file used in the virtual server OS initial settings and IP address settings might remain without being deleted from the system drive of the virtual server. Check the task log, and either delete the response file or virtual server.
(9) If a folder with the path specified at the import target does not exist, the folder is created.
(10) If a virtual disk file still remains in the folder of the path specified at the import target, the task is abnormally terminated. Check the folder of the path specified at the import target, and either delete the virtual disk or specify another path.
(11) This service does not register the deployed virtual server to the service and application of the failover cluster manager. Register manually based on user operation.
(12) When the virtual disk of the virtual server is mounted to the Hyper-V server, an available drive letter on the Hyper-V server is temporarily assigned. As a result, if there are no available drive letters on the Hyper-V server, an error occurs in the virtual disk mounting process, and the task is abnormally terminated. Execute this service after first confirming the number of drives used by the virtual disks of the exported virtual server and that drive letters are available on the Hyper-V server.
Execution privilege
Built-in Administrator
Version
03.00.00
Tags
Add VM,Hyper-V 2008
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 Hyper-V information. |
Y |
|
Virtual server information |
Specify the information of the virtual server that will be added. |
Y |
|
OS information |
Specify the OS information that is set for the virtual server. |
Y |
|
Network information |
Specify the network information of the virtual server. |
Y |
|
Options at execution |
These are the properties for status confirmation when making the OS initial settings of the virtual server. Make any changes as needed. |
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 |
|---|---|---|---|---|---|---|
|
hyperv.targetHost |
Hyper-V server host name |
Specifies the host name or IP address of the Hyper-V server. IPv6 addresses are not supported. |
Input |
Disabled |
R |
Virtual system environment information |
|
hyperv.userName |
User name for connecting to storage server |
Specifies the user name for connecting to the storage server. Specify this property if the storage server is a server other than the Hyper-V server. |
Input |
Disabled |
O |
Virtual server information |
|
hyperv.password |
Password for connecting to storage server |
Specifies the password for connecting to the storage server. Specify this property if the storage server is a server other than the Hyper-V server. |
Input |
Disabled |
O |
Virtual server information |
|
windows.orgName |
Organization name (company name) |
Specifies the organization name that is set for the virtual server OS. |
Input |
Disabled |
R |
OS information |
|
windows.ownerName |
Name (owner name) |
Specifies the name (owner name) that is set for the virtual server OS. |
Input |
Disabled |
R |
OS information |
|
OS.selectWorkgroupDomain |
Workgroup/domain selection |
Specifies whether the virtual server belongs to a workgroup or domain. |
Input |
Disabled |
R |
OS information |
|
OS.workgroupNameDomainName |
Workgroup/domain name |
Specifies the workgroup name or domain name where the virtual server belongs. Specify the workgroup name using a maximum of 15 characters. Specify the domain name using a maximum of 63 characters. |
Input |
Disabled |
R |
OS information |
|
OS.domainUserName |
Domain user name |
Specifies the user name of the domain where the virtual server belongs. This must be entered if "DOMAIN" was selected in the Workgroup/domain selection. |
Input |
Disabled |
O |
OS information |
|
OS.domainUserPassword |
Domain password |
Specifies the password of the domain where the virtual server belongs. This must be entered if "DOMAIN" was selected in the Workgroup/domain selection. |
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) |
Specifies the IP address of the DNS server of the management LAN that is set for the virtual server. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
hyperv.virtualSwitchMan |
Virtual switch name (for management) |
Specifies the virtual switch name (for management) set for the NIC (for management) that is set for the virtual server. |
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) |
Specifies the IP address of the DNS server that is set for the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
hyperv.virtualSwitch2 |
Virtual switch name (for second NIC) |
Specifies the virtual switch name (for second NIC) set for the second NIC that is set for the virtual server. |
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 third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
hyperv.virtualSwitch3 |
Virtual switch name (for third NIC) |
Specifies the virtual switch name (for third NIC) set for the third NIC that is set for the virtual server. |
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 fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
Input |
Disabled |
O |
Network information |
|
hyperv.virtualSwitch4 |
Virtual switch name (for fourth NIC) |
Specifies the virtual switch name (for fourth NIC) set for the fourth NIC that is set for the virtual server. |
Input |
Disabled |
O |
Network information |
|
OS.destIPAddress |
Destination IP of static route |
Specifies the destination IP address of the static route. IPv6 addresses are not supported. |
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 |
|
hyperv.checkVmStateEnabledCount |
Virtual server status (startup complete) check count |
Specifies the number of times to check whether virtual server startup is complete. This value combined with the check interval for the virtual server status (startup complete) determines the maximum wait time. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkVmStateEnabledInterval |
Virtual server status (startup complete) check interval |
Specifies the interval in seconds between checks for whether virtual server startup is complete. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkVmStateDisabledCount |
Virtual server status (stopping complete) check count |
Specifies the number of times to check whether virtual server stopping is complete. This value combined with the check interval for the virtual server status (stopping complete) determines the maximum wait time. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkVmStateDisabledInterval |
Virtual server status (stopping complete) check interval |
Specifies the interval in seconds between checks for whether virtual server stopping is complete. |
Input |
Disabled |
R |
Options at execution |
|
common.icmpEchoTimeout |
Timeout period for ICMP echo requests |
Specifies, in milliseconds, the wait time for the response to the ICMP echo request which is executed after virtual server startup when the network connection check is performed. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateCountNewSw |
Job monitoring count (ModifyVirtualSystemResources method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (ModifyVirtualSystemResources method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateIntervalNewSw |
Monitor interval (ModifyVirtualSystemResources method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (ModifyVirtualSystemResources method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateCountGetVm |
Job monitoring count (GetVirtualSystemImportSettingData method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (GetVirtualSystemImportSettingData method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateIntervalGetVm |
Monitor interval (GetVirtualSystemImportSettingData method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (GetVirtualSystemImportSettingData method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateCountNewVm |
Job monitoring count (ImportVirtualSystemEx method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (ImportVirtualSystemEx method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateIntervalNewVm |
Monitor interval (ImportVirtualSystemEx method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (ImportVirtualSystemEx method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobPowerOnCount |
Job monitoring count (RequestStateChange method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (RequestStateChange method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobPowerOnInterval |
Job monitoring interval (RequestStateChange method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (RequestStateChange method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobShutdownCount |
Job monitoring count (InitiateShutdown method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (InitiateShutdown method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobShutdownInterval |
Monitor interval (InitiateShutdown method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (InitiateShutdown method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateCountGetDriveList |
Job monitoring count (Win32_LogicalDisk method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (Win32_LogicalDisk method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobStateIntervalGetDriveList |
Job monitoring interval (Win32_LogicalDisk method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (Win32_LogicalDisk method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
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 |
|---|---|---|---|---|---|---|
|
hyperv.vmName |
Virtual server name |
Specifies the name of the virtual server. (This is the name of the virtual server as it is displayed in Hyper-V. This is not the host name in the OS.) |
Input |
Disabled |
R |
Virtual server information |
|
hyperv.exportedVmName |
Path of exported virtual server folder |
Specifies the folder name, as a full path, of the exported virtual server that is used as the copy source of the virtual server. If the storage server is a server other than the Hyper-V server, specify the path in UNC syntax. |
Input |
Disabled |
R |
Virtual server information |
|
hyperv.importFolderPath |
Import target |
Specifies the full path of the folder where the virtual server is stored. |
Input |
Disabled |
R |
Virtual server information |
|
windows.operatingSystem |
Operating system |
Specifies the operating system (OS) of the virtual server. |
Input |
Disabled |
R |
Virtual server information |
|
OS.computerName |
Computer/host name |
Specifies the OS computer name (host name). |
Input |
Disabled |
R |
OS information |
|
OS.osUserPassword |
Administrator password |
Specifies the administrator password that is set for the OS. If nothing is entered, "Password123" is set. |
Input |
Disabled |
O |
OS information |
|
OS.osUserPasswordReEnter |
Re-enter administrator password |
Re-enter the administrator password that is set for the OS. If nothing is entered, "Password123" is set. |
Input |
Disabled |
O |
OS information |
|
OS.productKey |
OS product key |
Specifies the product key of the OS. This is entered in the format "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX". |
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 |
Specifies the time zone that is set for the virtual server OS. |
Input |
Disabled |
O |
OS information |
|
OS.systemLocale |
System locale |
Specifies the system locale that is set for the OS of the virtual server. |
Input |
Disabled |
R |
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 |
|---|---|
|
hyperv.targetHost |
Enter up to 256 halfwidth alphanumeric characters. You can also use periods (.) and hyphens (-). |
|
hyperv.userName |
Enter up to 20 halfwidth alphanumeric characters and symbols. The following characters are not allowed: < > | ; & ' " * ? [ ] ` / : = , + \ @ % |
|
hyperv.password |
Enter up to 127 halfwidth alphanumeric characters and symbols. The following characters are not allowed: < > | ; & ' " * ? [ ] ` % |
|
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 |
Enter up to 63 halfwidth alphanumeric characters. You can also use periods (.) and hyphens (-). |
|
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.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 . . |
|
hyperv.virtualSwitchMan |
Enter a character string of up to 63 characters. The following characters are not allowed: < > | ; & ' " * ? [ ] ` % \ |
|
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 . . |
|
hyperv.virtualSwitch2 |
Enter a character string of up to 63 characters. The following characters are not allowed: < > | ; & ' " * ? [ ] ` % \ |
|
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 (.). |
|
hyperv.virtualSwitch3 |
Enter a character string of up to 63 characters. The following characters are not allowed: < > | ; & ' " * ? [ ] ` % \ |
|
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 (.). |
|
hyperv.virtualSwitch4 |
Enter a character string of up to 63 characters. The following characters are not allowed: < > | ; & ' " * ? [ ] ` % \ |
|
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 . . |
|
hyperv.checkVmStateEnabledCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateEnabledInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkVmStateDisabledCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateDisabledInterval |
Enter an integer from 1 to 60. |
|
common.icmpEchoTimeout |
Integer between 1 and 214783647 can be entered. |
|
hyperv.checkJobStateCountNewSw |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobStateIntervalNewSw |
Enter an integer from 1 to 60. |
|
hyperv.checkJobStateCountGetVm |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobStateIntervalGetVm |
Enter an integer from 1 to 60. |
|
hyperv.checkJobStateCountNewVm |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobStateIntervalNewVm |
Enter an integer from 1 to 60. |
|
hyperv.checkJobPowerOnCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobPowerOnInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkJobShutdownCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobShutdownInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkJobStateCountGetDriveList |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobStateIntervalGetDriveList |
Enter an integer from 1 to 60. |
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 |
|---|---|
|
hyperv.vmName |
Enter a character string of up to 100 characters. The character string must not start with a space, end with a space or period (.), or contain the following characters: < > | ; & ' " * ? [ ] ` , % \ / : |
|
hyperv.exportedVmName |
Enter a character string of up to 256 characters. The character string must not end with a backslash (\) or contain the following characters: < > | ; & * ? " % / ' [ ] ` |
|
hyperv.importFolderPath |
Enter a character string of up to 256 characters. The character string must not end with a backslash (\) or contain the following characters: < > | ; & * ? " % / ' [ ] ` |
|
windows.operatingSystem |
Select one of the following values: Windows Server 2008 R2 |
|
OS.computerName |
Enter up to 15 halfwidth alphanumeric characters. You can also use hyphens (-). |
|
OS.osUserPassword |
A character string of no more than 64 characters can be entered. It cannot include <, >, |, ;, &, `, or a trailing \. |
|
OS.osUserPasswordReEnter |
A character string of no more than 64 characters can be entered. It cannot include <, >, |, ;, &, `, or a trailing \. |
|
OS.productKey |
A maximum of 29 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 Standard Time, China Standard Time, GMT Standard Time, Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Central Standard Time, Central America Standard Time, US Mountain Standard Time, Mountain Standard Time, Alaskan Standard Time, Hawaiian Standard Time, Singapore Standard Time, India Standard Time |
|
OS.systemLocale |
Select one of the following values: ja-JP,en-US,zh-CN |
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 |
hypervCreateVM |
Create a virtual server |
Creates a virtual server from an exported virtual server in the Hyper-V environment. |
After removing the cause of the error, run the service again. If a virtual server is already created in the Hyper-V server, run the virtual server delete service, and then run this service again. |
|
2 |
hypervSetVirtualSwitchMan |
Virtual server virtual switch settings |
Sets the virtual switch for establishing communication with the local server. |
Check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
3 |
hypervCreateAnsFile |
Flow Plug-in |
Assigns the response file in the virtual server. |
-- |
|
3-1 |
Mount a virtual disk |
Mounts the virtual disk on the Hyper-V server. |
After removing the cause of the error, if the virtual disk is mounted on the Hyper-V server, manually unmount it. Run the virtual server delete service, and then run this service again. |
|
|
3-2 |
Create a response file |
Creates a response file to initialize the OS and set the IP address for the virtual server in the Hyper-V environment. |
After removing the cause of the error, if the virtual disk is mounted on the Hyper-V server, manually unmount it. Run the virtual server delete service, and then run this service again. |
|
|
3-3 |
Unmount a virtual disk |
Unmounts the virtual disk from the Hyper-V server. |
After removing the cause of the error, if the virtual disk is mounted on the Hyper-V server, manually unmount it. Run the virtual server delete service, and then run this service again. |
|
|
4 |
hypervPowerOnVM |
Flow Plug-in |
Makes the virtual server OS initial settings (computer name, company name, organization name) and IP address settings, and starts the virtual server. |
-- |
|
4-1 |
Start a virtual server |
Starts a virtual server in the Hyper-V environment. |
Remove the cause of the error, run the virtual server delete service, and then run this service again. |
|
|
4-4 |
Compatible Plug-in |
Determines if the IP address is set for the NIC. |
Check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
4-5 |
Flow Plug-in |
Check the network connection between the local server and the virtual server, and set the IP addresses for the second to the fourth NICs. |
-- |
|
|
4-5-1 |
Send ICMP echo request message |
Issues an ICMP echo request to the virtual server whose power has been turned ON. |
Check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
4-5-4 |
Compatible Plug-in |
Determines if the second to fourth NICs need to be set. |
Check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
4-5-5 |
Flow Plug-in |
Sets the second to fourth NICs. |
-- |
|
|
4-5-5-1 |
Obtain the MAC address of an NIC |
Obtains the MAC address of the NIC for management. |
Check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
4-5-5-2 |
Virtual server virtual switch settings |
Disconnects the virtual switch to the second to fourth NICs. |
Check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
4-5-5-3 |
Windows network settings |
Sets the IP address for the second to fourth NICs. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
5 |
hypervSetVirtualSwitchBiz |
Virtual server virtual switch settings (for second to fourth NICs) |
Sets the virtual switch to the second to fourth NICs. |
-- |
|
5-1 |
Compatible Plug-in |
Determines if the IP address is set for the NIC. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
5-2 |
Flow Plug-in |
Sets the virtual switch to the second to fourth NICs. |
-- |
|
|
5-2-1 |
Compatible Plug-in |
Determines if the second to fourth NICs need to be set. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
5-2-2 |
Flow Plug-in |
Sets the virtual switch to the second to fourth NICs. |
-- |
|
|
5-2-2-1 |
Obtain the MAC address of an NIC |
Obtains the MAC address of the second to fourth NICs. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
5-2-2-2 |
Virtual server virtual switch settings |
Sets the virtual switch to the second to fourth NICs. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
5-3 |
Compatible Plug-in |
Determines if the IP address is set for the NIC. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
5-4 |
Virtual server virtual switch settings |
Sets the virtual switch to the second to fourth NICs. |
Log in to the Hyper-V server and check the settings of the virtual server. After that, log in to the virtual server and check the settings of the virtual server. Manually set the virtual server as needed. Or, check the task log, and remove the cause of the error. After that, run the virtual server delete service, and then run this service again. |
|
|
6 |
osSetStaticRoute |
Flow Plug-in |
Sets the static route in the virtual server OS. |
-- |
|
6-3 |
Compatible Plug-in |
Determines if the static route needs to be set. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
6-4 |
Flow Plug-in |
Check with the OS of the virtual server to see that the IP address for administration is set. |
-- |
|
|
6-4-3 |
Compatible Plug-in |
Check with the OS of the virtual server to see if the IP address for administration is set. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
6-4-4 |
Set static route |
Sets the static route in the virtual server OS. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
7 |
hypervJoinDomain |
Flow Plug-in |
Performs the process for joining the domain. |
-- |
|
7-1 |
Compatible Plug-in |
Check with the OS of the virtual server to see if the IP address for administration is set. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
7-2 |
Flow Plug-in |
Performs the process for joining the domain. |
-- |
|
|
7-2-3 |
Compatible Plug-in |
Determines if the process for joining the domain is required. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
7-2-4 |
Flow Plug-in |
Checks if the process for joining the domain is successful. |
-- |
|
|
7-2-4-1 |
Windows network settings |
Performs the process for joining the domain. |
-- |
|
|
7-2-4-4 |
Compatible Plug-in |
Determines if the process for joining the domain is successful. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
7-2-4-5 |
Flow Plug-in |
Restarts a virtual server in the Hyper-V environment. |
-- |
|
|
7-2-4-5-1 |
Shut down a virtual server |
Shuts down a virtual server in the Hyper-V environment. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|
|
7-2-4-5-2 |
Start a virtual server |
Starts a virtual server in the Hyper-V environment. |
Check the task log and log in to the virtual server to remove the cause of the error. Manually set the virtual server as needed. |
|