This service template uses an exported virtual server to add a new virtual server in a Hyper-V environment.
The general steps for using this service template are as follows:
- A virtual server is created on the Hyper-V server.
- Replicate a virtual server from an already exported one in the import destination folder.
- 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.
- 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 needs.
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.
- A response file to be used for OS customization is created and deployed.
- Mount the virtual disk of the virtual server to the Hyper-V server.
- On the mounted virtual disk, create a response file to be used for OS customization.
- Unmount the virtual disk from the Hyper-V server.
- The virtual server starts, and the initial settings on the virtual server are specified.
- 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.
- 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 needs. Some settings need to connect 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 follows.
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.
- 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 needs.
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.
- A static route is set 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.
- 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 gives notes on setting properties:
- 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.
- 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.
- 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.
- Make 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.
- If the virtual switch specification is missing, connections to the virtual switches are not established.
- 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.
- 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.
- Specifiable locales are as follows:
- ja-JP
- en-US
- zh-CN
- Specifiable OS names are as follows:
- Windows Server 2012
- Windows Server 2012 R2
- Windows Server 2016
Service Definition and Submit Service Properties
The following table lists the properties shown in the Service Definition window for the service template.
| Property key | Property name | Description |
|---|---|---|
| hyperv.targetHost R | Hyper-V server host name | Specifies the host name or IP address of the Hyper-V server. IPv6 addresses are not supported. |
| hyperv.userName O | 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. |
| hyperv.password O | 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. |
| windows.orgName R | Organization name (company name) | Specify the organization name to be set in the OS of the virtual server. |
| windows.ownerName R | Name (owner name) | Specify the owner name to be set in the OS of the virtual server. |
| OS.selectWorkgroupDomain R | Select workgroup/domain | Select which type of entity you want the virtual server to belong to: workgroup or domain. |
| OS.workgroupNameDomainName R | 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. |
| OS.domainUserName O | 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. |
| OS.domainUserPassword O | 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. |
| OS.subnetMaskMan O | Subnet mask (management LAN) | Specify the subnet mask for the management LAN of the virtual server. You cannot specify an IPv6 address. |
| OS.defaultGWMan O | Default gateway (management LAN) | Specify the default gateway for the management LAN of the virtual server. You cannot specify an IPv6 address. |
| OS.dnsMan O | 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. |
| hyperv.virtualSwitchMan O | 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. |
| OS.subnetMask2 O | Subnet mask (for second NIC) | Specify the 2nd subnet mask for the virtual server. You cannot specify an IPv6 address. |
| OS.defaultGW2 O | Default gateway (for second NIC) | Specify the 2nd default gateway for the virtual server. You cannot specify an IPv6 address. |
| OS.dns2 O | 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. |
| hyperv.virtualSwitch2 O | 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. |
| OS.subnetMask3 O | 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. |
| OS.defaultGW3 O | 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. |
| OS.dns3 O | 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. |
| hyperv.virtualSwitch3 O | 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. |
| OS.subnetMask4 O | 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. |
| OS.defaultGW4 O | 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. |
| OS.dns4 O | 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. |
| hyperv.virtualSwitch4 O | 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. |
| OS.destIPAddress O | Destination IP of static route | Specify the static-route destination IP address. Do not specify an IPv6 address. |
| OS.subnetMaskStaticRoute O | Subnet mask (static route) | Specify the subnet mask for the static route. You cannot specify an IPv6 address. |
| OS.defaultGWStaticRoute O | Default gateway (static route) | Specify the default gateway for the static route. You cannot specify an IPv6 address. |
| hyperv.scsiDiskLocation R | 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. |
| hyperv.osSettingWaitTime R | Wait time before initial OS setup finishes | Specify in seconds the time to wait before initial OS setup finishes. |
| common.icmpEchoTimeout R | Timeout period for ICMP echo requests | To verify network connectivity, specify in milliseconds the time to wait for a reply to an ICMP echo request performed after the virtual server starts. |
| hyperv.checkVmStateEnabledCount R | Virtual server status (startup complete) check count | Specifies the number of times to verify whether virtual server startup is complete. This value combined with the verification interval for the virtual server status (startup complete) determines the maximum wait time. |
| hyperv.checkVmStateEnabledInterval R | Virtual server status (startup complete) check interval | Specifies the interval in seconds between verifications for whether virtual server startup is complete. |
| hyperv.checkJobStateCountGetDriveList R | 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. |
| hyperv.checkJobStateIntervalGetDriveList R | 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. |
| 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. R: Required |
||
The following table lists the properties shown in the Service Definition and the Submit Service windows:
| Property key | Property name | Description |
|---|---|---|
| hyperv.vmName R | 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.) |
| hyperv.exportedVmName R | 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. |
| hyperv.importFolderPath R | Import target | Specifies the full path of the folder where the virtual server is stored. |
| windows.operatingSystem R | Operating system | Specifies the operating system (OS) of the virtual server. |
| OS.computerName R | Computer/host name | Specify the computer name (host name) in the OS. |
| OS.osUserPassword O | Administrator password | Enter the administrator password to be set in the OS. If you enter nothing, "Password123" is set. |
| OS.osUserPasswordReEnter O | Enter administrator password again | Re-enter the administrator password to be set in the OS. If you enter nothing, "Password123" is set. |
| OS.productKey O | OS product key | Specify the OS product key in the following format: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX |
| OS.ipAddressMan O | IP address (management LAN) | Specify the IP address for the management LAN of the virtual server. You cannot specify an IPv6 address. |
| OS.ipAddress2 O | IP address (for second NIC) | Specify the 2nd IP address for the virtual server. You cannot specify an IPv6 address. |
| OS.ipAddress3 O | 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. |
| OS.ipAddress4 O | 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. |
| OS.timeZoneWin O | Time zone | Specify the time zone to be set in the OS of the virtual server. |
| OS.systemLocale R | System locale | Specifies the system locale that is set for the OS of the virtual server. |
| 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. R: Required |
||
Prerequisites
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.
Conditions related to the exported virtual server to be deployed:
- The following service of Hyper-V Integration Service must be enabled: Data Exchange
- Before a virtual server is exported from the Hyper-V server, the virtual server must satisfy the following conditions:
- The administrator user password is blank.
- 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
The OS settings must have been initialized by using Sysprep and the following conditions must be satisfied:
- [Select Enter System Out of Box Experience (OOBE) from System Cleanup Action list.
- Select the Generalize check box.
- Agentless connection must be possible.
- A maximum of four NICs must be set up.
- Connections with virtual switches must be closed.
- The firewall must permit ICMP (ECHO) replies.
- 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.
- No legacy network adapter must be set.
- Snapshots and differential disks must not be created.
Conditions related to the settings on the virtual server:
- The virtual server name must be unique within the Hyper-V server.
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.
Server requirements
- 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.
Usage guidelines
- 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. Make sure to specify all necessary virtual switches.
- 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.
- 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.
- 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, verify whether IP addresses are set as intended. If IP addresses are not set as intended, correct the settings manually.
- 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 end abnormally.
- 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.
- 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, look for the relevant response file in the task log, and delete the file. Alternatively, delete the virtual server.
- If folders in the specified import destination path do not exist, they are created.
- If virtual disk files remain in folders in the specified import destination path, the task ends abnormally. Look for the folders in the specified path, and then delete them or specify another path.
- 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 needs.
- 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 ends 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.
- 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.
- 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 end abnormally.
- In this service template, drive letter of drive connected to the deployed virtual server might be changed, to initialize the system information of the OS by sysprep. So that the drive letter might 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 might not work correctly.