3.10.3 Add a virtual server (deploy/OS initial settings)
Function
This service template uses an exported virtual server to add a new virtual server in a Hyper-V environment.
The following describes the servers that this service template requires:
- Hyper-V server
A server on which Hyper-V is installed.
- Virtual server
A virtual server managed by Hyper-V.
- Exported virtual server
A virtual server and its full set of configuration files
- Container server
A server that contains an exported virtual server to be replicated.
The following provides a processing overview:
(1) A virtual server is created on the Hyper-V server.
1. Replicate a virtual server from an already exported one in the import destination folder.
2. Create a virtual server by using the import function on the Hyper-V server.
Assign a new unique ID to the new virtual server you create.
If the specified import destination folder already exists, the folder is used as is.
(2) The virtual server's connection destination (management-use) virtual switch is set up.
You must set up a management-use virtual switch for a NIC to establish communication with the local server.
If a connection-destination virtual switch has already been set on the exported virtual server, the switch is replaced by the specified one.
For the first NIC, set up a management-use virtual switch that can communicate with the local server. For the second to fourth NICs, set a management-use or operation-use virtual switch according to the user operating requirements.
If the number of specified virtual switches exceeds the number of NICs on the virtual server, only the virtual switches allocated to NICs are enabled.
(3) A response file to be used for OS customization is created and deployed.
1. Mount the virtual disk of the virtual server to the Hyper-V server.
2. On the mounted virtual disk, create a response file to be used for OS customization.
3. Unmount the virtual disk from the Hyper-V server.
(4) The virtual server starts, and the initial settings on the virtual server are specified.
1. Specify the initial OS settings (such as the computer name and company name).
Set the computer name, company name, organization name, and time zone as the initial OS settings.
2. Set IP addresses for the virtual server.
A virtual server can have a maximum of four IP addresses. For the first IP address (management-use IP address), set an IP address for managing the deployed virtual server. For the second to fourth IP addresses, set an IP management-use IP address or operation-use IP address according to the user operating requirements. Some settings require connection to the OS by using a management-use IP address. The order in which IP addresses are set differs depending on the number of NICs installed on the virtual server, as shown below.
- When only one NIC is installed on the virtual server
The IP address to be set for the NIC is determined based on the following priority: IP address for management > second IP address > third IP address > fourth IP address. Among the specified IP addresses, only the one with the highest priority is set and the others are discarded.
- When two or more NICs are installed on the virtual server
Specified IP addresses are allocated to the NICs in the following order: management-use IP address > second IP address > third IP address > fourth IP address. Specification of blank IP addresses is skipped. For example, if the management-use IP address, second IP address, and fourth IP address are specified (that is, the third IP address is not specified), the fourth IP address is allocated to the third NIC on the virtual server. If the number of specified IP addresses exceeds the number of NICs installed on the virtual server, the IP addresses that are not allocated to NICs are discarded.
(5) The virtual server's (second to fourth) connection-destination virtual switches are set.
The connection-destination virtual switches that have already been set on the exported virtual server are replaced with the specified ones.
For the first NIC, set a management-use virtual switch that can communicate with the local server. For the second to fourth NICs, set a management-use or operation-use virtual switch according to the user operating requirements.
If the number of specified virtual switches exceeds the number of NICs installed on the virtual server, only the virtual switches allocated to NICs are enabled.
(6) If the management-use IP address to be set in the OS of the virtual server is specified and two or more IP addresses are set for the virtual server, a static route is set.
(7) If DOMAIN is selected from the selection list for the OS.selectWorkgroupDomain property, and the domain name, domain user name, and domain password are specified, processing to join the domain is executed.
The following provides notes on setting properties:
(1) The OS user password must be entered twice (the second entry is for confirmation). If the OS user password is not entered twice, "Password123" is set as the password. This password is also set if the first entered and second entered passwords do not match.
(2) If WORKGROUP is selected from the selection list for OS.selectWorkgroupDomain, the maximum length of the specifiable workgroup name is 15 bytes. If you specify a workgroup name longer than 15 bytes, the string "WORKGROUP" is set, instead of the specified name.
(3) If DOMAIN is selected from the selection list for the OS.selectWorkgroupDomain property, the domain name, domain user name, and domain password are required. If any values for these items are missing or domain participation fails, "WORKGROUP" is set as the workgroup name.
(4) Be sure to specify both the IP address and subnet mask. If you do not specify both of these items, the IP address, subnet mask and default gateway are not set.
(5) If the virtual switch specification is missing, connections to the virtual switches are not established.
(6) For the static route, specify the destination IP address, subnet mask and default gateway. If any of these items are missing, the static route is not set.
(7) Specifiable time zones are as follows:
- 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 no time zone is specified, the time zone set in the exported virtual server is used.
(8) Specifiable locales are as follows:
- ja-JP
- en-US
- zh-CN
(9) Specifiable OS names are as follows:
- Windows Server 2012
- Windows Server 2012 R2
- Windows Server 2016
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products in the system, prerequisite products in the service-template execution system, and OSs of prerequisite products in the service-template execution system.
Prerequisite products in the system:
JP1/Automatic Operation 12-00 or later
Prerequisite products in the service-template execution system:
(1) Prerequisite products on the Hyper-V server
- Windows Server 2016 Hyper-V
OSs of prerequisite products in the service-template execution system:
(1) Prerequisite OS for the Hyper-V server
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
(2) Prerequisite OS for the virtual server
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
Conditions for using the prerequisite products in the service-template execution system:
(1) Conditions related to the settings on the Hyper-V server
- Virtual switch settings must have been specified.
- Each virtual switch name must be unique within the Hyper-V server.
- An exported virtual server to be deployed must have been created.
(2) Conditions related to the exported virtual server to be deployed
(2-1) The following service of Hyper-V Integration Service must be enabled:
- Data Exchange
(2-2) Before a virtual server is exported from the Hyper-V server, the virtual server must satisfy the following conditions:
1) The administrator user password is blank.
2) The network settings are deleted.
If the network adapter settings have been specified on the virtual host, make sure that the values of the following settings are blank, and then set [Obtain an IP address automatically] and [Obtain DNS server address automatically]:
- IP address
- Subnet mask
- Default gateway
- Preferred DNS server
- Alternate DNS server
3) The OS settings must have been initialized by using Sysprep.
Also, the following conditions must be satisfied:
- [Enter System Out of Box Experience (OOBE)] is selected from the [System Cleanup Action] drop-down list.
- The [Generalize] check box is selected.
(2-3) Agentless connection must be possible.
(2-4) A maximum of four NICs must be set up.
- Connections with virtual switches must be closed.
(2-5) The firewall must permit ICMP (ECHO) replies.
(2-6) If the container server and the Hyper-V server are different, the folder containing the virtual server exported from the Hyper-V server must be a shared folder.
(2-7) No legacy network adapter must be set.
(2-8) Snapshots and differential disks must not be created.
(3) Conditions related to the settings on the virtual server
- The virtual server name must be unique within the Hyper-V server.
(4) Conditions related to this product settings
- For the following addresses, authentication information must have been set in the agentless connection definition on the [Management] tab: the local server address (a loopback address that can be resolved from the name "localhost"), Hyper-V server address, and the management-use IP address of the virtual server to be deployed.
Cautions
(1) If no virtual switch is specified, the connection-destination virtual switch information of the relevant NIC is deleted. As a result, the NIC is disconnected from the virtual switch. Be sure to specify all necessary virtual switches.
(2) For IP addresses to be set in the OS of the virtual server, enter only values that are treated as IP addresses. For example, you must not specify special addresses such as a network address, broadcast address, "0.0.0.0", or "255.255.255.255". If you enter such a special address, deployment of the virtual server fails. In addition, for management-use IP addresses, enter IP addresses that allow communication with the local server. If you enter an address that is correct but does not allow communication with the local server, deployment might fail.
(3) While the virtual server is being deployed, make sure that other services do not operate the virtual server. If other services operate the virtual server that is being deployed, deployment might fail. Direct operation from the Hyper-V server is also prohibited.
(4) IP addresses are set as described in the Function Specifications. However, depending on the order in which NICs are set in the OS of the virtual server, IP addresses might not be set as intended. Therefore, after the virtual server has been created, check whether IP addresses are set as intended. If IP addresses are not set as intended, correct the settings manually.
(5) Make sure that IP addresses set on the virtual server are not being used by other servers. If an IP address that is set on another server is set, no NICs on the virtual server are enabled, sometimes causing the task to terminate abnormally.
(6) Make sure that the settings to be specified during creation of the virtual server to be deployed have not been set on the exported virtual server. If the computer name, host name, or IP address has already been set on the exported virtual server, virtual server creation might fail (for example, an error occurs in static-route related processing). If creation fails, delete the virtual server, re-create an exported virtual server on which the computer name, host name, or IP address is not set, and then re-execute this service.
(7) If deployment fails, the response file used to specify the initial OS settings and IP addresses on the virtual server might remain on the system drive of the virtual server. If a response file remains, check for the relevant response file in the task log, and delete the file. Alternatively, delete the virtual server.
(8) If folders in the specified import destination path do not exist, they are created.
(9) If virtual disk files remain in folders in the specified import destination path, the task terminates abnormally. Check the folders in the specified path, and then delete them or specify another path.
(10) This service does not register virtual servers deployed for any services and applications of the failover cluster manager. Register those servers manually according to the user operating requirements.
(11) When virtual disks on a virtual server are mounted to the Hyper-V server, available drive letters on the Hyper-V server are temporarily locked. If there are no available drive letters, an error occurs when the virtual disk is being mounted, and the task terminates abnormally. Before you execute this service, make sure that there are as many available drive letters on the Hyper-V server as the number of drives used by the virtual disks on the exported virtual server.
(12) If the generation number of the exported virtual server is 2, for the hyperv.scsiDiskLocation property, specify the location of the SCSI controller in which the virtual server's system disk is set. If the location of the system disk differs from the location specified for that property, a search for the system disk takes place. In this case, therefore, a longer time might be required to complete deployment.
(13) We recommend that you do not change the value of the hyperv.osSettingWaitTime property from the default value. Note, however, that if the wait time specified for the property is not long enough, the next step might start before the initial OS setup finishes, causing the task to terminate abnormally.
(14) In this service template, drive letter of drive connected to the deployed virtual server may be changed, in order to initialize the system information of the OS by sysprep. So that the drive letter may not match between the deployed virtual server and template of the virtual server. Also if the application has been installed on the drive where the drive letter has been changed, there is a possibility that the application may not work correctly.
Execution privilege
Built-in Administrator
Version
03.00.00
Tags
Add VM,Hyper-V 2016
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 Hyper-V information. |
Y |
|
Virtual server information |
Specify the information about the virtual server to be added. |
Y |
|
OS information |
Specify the OS information to be set on the virtual server. |
Y |
|
Network information |
Specify the network information for the virtual server. |
Y |
|
Run-time option |
The property for checking the status before specifying the initial OS settings on the virtual server. Change the option, if 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 |
|---|---|---|---|---|---|---|
|
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) |
Specify the organization name to be set in the OS of the virtual server. |
Input |
Disabled |
R |
OS information |
|
windows.ownerName |
Name (owner name) |
Specify the owner name to be set in the OS of the virtual server. |
Input |
Disabled |
R |
OS information |
|
OS.selectWorkgroupDomain |
Select workgroup/domain |
Select which type of entity you want the virtual server to belong to: workgroup or domain. |
Input |
Disabled |
R |
OS information |
|
OS.workgroupNameDomainName |
Workgroup/domain name |
Specify the name of the workgroup or domain that the virtual server belongs to. The workgroup name can have a maximum of 15 characters. The domain name can have a maximum of 63 characters. |
Input |
Disabled |
R |
OS information |
|
OS.domainUserName |
Domain user name |
Specify the user name for the domain that the virtual server belongs to. This item must be specified if DOMAIN is selected as the type of entity that you want the virtual server to belong to. |
Input |
Disabled |
O |
OS information |
|
OS.domainUserPassword |
Domain password |
Specify the password for the domain that the virtual server belongs to. This item must be specified if DOMAIN is selected as the type of entity that you want the virtual server to belong to. |
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 connected to the management LAN to be set on the virtual server. Do not specify an IPv6 address. |
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) |
Specify the IP address of the DNS server to be set for the second NIC recognized by the OS of the virtual server. Do not specify an IPv6 address. |
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) |
Specify the IP address of the DNS server to be set for the third NIC recognized by the OS of the virtual server. Do not specify an IPv6 address. |
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) |
Specify the IP address of the DNS server to be set for the fourth NIC recognized by the OS of the virtual server. Do not specify an IPv6 address. |
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 |
Specify the static-route destination IP address. Do not specify an IPv6 address. |
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.scsiDiskLocation |
SCSI controller location |
Specify the location of the SCSI controller for which a system disk has been set. This property takes effect only if the generation number of the exported virtual server is 2. |
Input |
Disabled |
R |
Run-time option |
|
hyperv.osSettingWaitTime |
Wait time before initial OS setup finishes |
Specify in seconds the time to wait before initial OS setup finishes. |
Input |
Disabled |
R |
Run-time option |
|
common.icmpEchoTimeout |
Timeout period for ICMP echo requests |
To check network connectivity, specify in milliseconds the time to wait for a reply to an ICMP echo request performed after the virtual server starts. |
Input |
Disabled |
R |
Run-time option |
|
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 |
Run-time option |
|
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 |
Run-time option |
|
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 |
Run-time option |
|
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 |
Run-time option |
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 |
Specify the computer name (host name) in the OS. |
Input |
Disabled |
R |
OS information |
|
OS.osUserPassword |
Administrator password |
Enter the administrator password to be set in the OS. If you enter nothing, "Password123" is set. |
Input |
Disabled |
O |
OS information |
|
OS.osUserPasswordReEnter |
Enter administrator password again |
Re-enter the administrator password to be set in the OS. If you enter nothing, "Password123" is set. |
Input |
Disabled |
O |
OS information |
|
OS.productKey |
OS product key |
Specify the OS product key in the following 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 |
Specify the time zone to be set in the OS of the virtual server. |
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.scsiDiskLocation |
An integer in the range from 0 to 63 |
|
hyperv.osSettingWaitTime |
An integer in the range from 0 to 2,147,483,647 |
|
common.icmpEchoTimeout |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateEnabledCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateEnabledInterval |
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 2012,Windows Server 2012 R2,Windows Server 2016 |
|
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 \. 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 -. |
|
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 |
hyperv2016CreateVM |
Create a virtual server |
Creates a virtual server from an exported virtual server in a Hyper-V environment. |
After checking the task log and removing the cause of the error, run the service again. If virtual servers were already created on the Hyper-V server, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
2 |
hyperv2016SetVirtualSwitchMan |
Virtual server virtual switch settings |
Sets up a virtual switch for establishing a connection with the local server. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
3 |
hyperv2016CreateAnsFile |
Flow Plug-in |
Deploys a response file on a virtual server. |
-- |
|
3-1 |
Mount a virtual disk |
Mounts a virtual disk on the Hyper-V server. |
After checking the task log and removing the cause of the error, manually unmount any virtual disks mounted on the Hyper-V server. Then, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
3-2 |
Create a response file |
Creates a response file for specifying the initial OS settings and IP addresses for a virtual server in a Hyper-V environment. |
After checking the task log and removing the cause of the error, manually unmount any virtual disks mounted on the Hyper-V server. Then, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
3-3 |
Unmount a virtual disk |
Unmounts a virtual disk from the Hyper-V server. |
After checking the task log and removing the cause of the error, manually unmount any virtual disks mounted on the Hyper-V server. Then, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4 |
hyperv2016PowerOnVM |
Flow Plug-in |
Specifies the initial OS settings (computer name, company name, and organization name) and IP addresses for a virtual server, and then starts the virtual server. |
-- |
|
4-1 |
Starts a virtual server |
Starts a virtual server in a Hyper-V environment. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-2 |
Execute wait |
Waits for the completion of the initial OS settings if wait time is necessary. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-3 |
Judge Value Plug-in |
Judges whether IP addresses are set for the NICs. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-4 |
Flow Plug-in |
Checks whether the local server and virtual servers are connected to the network, and then sets IP addresses for the second to fourth NICs. |
-- |
|
|
4-4-1 |
Send ICMP echo request message |
Issues an ICMP echo request to a virtual server that is turned on. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-4-2 |
Judge Value Plug-in |
Judges whether the second to fourth NICs need to be set up. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-4-3 |
Flow Plug-in |
Sets up the second to fourth NICs. |
-- |
|
|
4-4-3-1 |
Obtain the MAC address of an NIC |
Obtains the MAC address of the management NIC. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-4-3-2 |
Virtual server virtual switch settings |
Closes the connections between the virtual switches and the second to fourth NICs. |
After checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
4-4-3-3 |
Windows network settings |
Sets IP addresses for the second to fourth NICs. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
5 |
hyperv2016SetVirtualSwitchBiz |
Flow Plug-in |
Sets up virtual switches for the second to fourth NICs. |
-- |
|
5-1 |
Judge Value Plug-in |
Judges whether IP addresses are set for the NICs. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
5-2 |
Flow Plug-in |
Sets up virtual switches for the second to fourth NICs. |
-- |
|
|
5-2-1 |
Judge Value Plug-in |
Judges whether the second to fourth NICs need to be set up. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
5-2-2 |
Flow Plug-in |
Sets up virtual switches for the second to fourth NICs. |
-- |
|
|
5-2-2-1 |
Obtain the MAC address of NICs |
Obtains the MAC addresses of the second to fourth NICs. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
5-2-2-2 |
Virtual server virtual switch settings |
Sets up virtual switches for the second to fourth NICs. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
5-3 |
Judge Value Plug-in |
Judges whether IP addresses are set for the NICs. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
5-4 |
Virtual server virtual switch settings |
Sets up virtual switches for the second to fourth NICs. |
Log in to the Hyper-V server and check the virtual server settings. Next, log in to the virtual server and check the virtual server settings. If necessary, manually set up the virtual server. Alternatively, after checking the task log and removing the cause of the error, delete the virtual servers and the virtual disks set on those virtual servers, and then run this service again. |
|
|
6 |
osSetStaticRoute |
Flow Plug-in |
Sets a static route on the OS of a virtual server. |
-- |
|
6-1 |
Judge Value Plug-in |
Judges whether multiple NICs are set up on the virtual server. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
6-2 |
Flow Plug-in |
Confirms that multiple IP addresses are set on the OS of the virtual server. |
-- |
|
|
6-2-1 |
Judge Value Plug-in |
Judges whether multiple IP addresses are set in the OS of the virtual server. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
6-2-2 |
Flow Plug-in |
Confirms that management IP addresses are set on the OS of the virtual server. |
-- |
|
|
6-2-2-1 |
Judge Value Plug-in |
Judges whether management IP addresses are set on the OS of the virtual server. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
6-2-2-2 |
Set static route |
Sets a static route on the OS of a virtual server. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
7 |
hyperv2016JoinDomain |
Flow Plug-in |
Joins a domain. |
-- |
|
7-1 |
Judge Value Plug-in |
Judges whether management IP addresses are set on the OS of the virtual server. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
7-2 |
Flow Plug-in |
Joins a domain. |
-- |
|
|
7-2-1 |
Judge Value Plug-in |
Judges whether it is necessary to join a domain. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
7-2-2 |
Flow Plug-in |
Checks whether the processing to join a domain was successful. |
-- |
|
|
7-2-2-1 |
Windows network settings |
Joins a domain. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
7-2-2-2 |
Judge Value Plug-in |
Judges whether the processing to join a domain was successful. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
7-2-2-3 |
Flow Plug-in |
Restarts a virtual server in a Hyper-V environment. |
-- |
|
|
7-2-2-3-1 |
Shut down a virtual server |
Shuts down a virtual server in a Hyper-V environment. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|
|
7-2-2-3-2 |
Start a virtual server |
Starts a virtual server in a Hyper-V environment. |
Check the task log, log in to the virtual server, and then remove the cause of the error. If necessary, manually set up the virtual server. |
|