5.4.1 Create a response file
Function
This component creates a response file to initialize the OS and set the IP address for the virtual server (Windows) in the Hyper-V environment.
The following servers are required for this component:
- Hyper-V server (Execution target server)
This is the Windows server where Hyper-V is installed.
- Virtual server
This is a virtual server managed by Hyper-V.
Only one IP address can be set, and if the virtual server has two or more NICs, set the IP for the first NIC. The second and subsequent NICs all become disabled.
Set the IP addresses that were specified first in the order of IP address (for management)>IP address (for the second NIC)>IP address (for the third NIC)>IP address (for the fourth NIC). Note that the other IP addresses are discarded.
Specifiable time zones 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 for the exported virtual server is inherited.
Specifiable locales are shown below.
ja-JP
en-US
zh-CN
Specifiable OS names are shown below.
Windows Server 2008 R2
Use situation
This component can be used to create a response file to initialize the OS and set up IP address for the virtual server (Windows) in the Hyper-V environment.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
(1)Prerequisite product of Hyper-V Server
- Windows Server 2008 R2 Hyper-V
(2)Prerequisite OS running in the virtual servers
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Prerequisite product OS running in the execution target server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions for required products on the execution target server]
(1) The virtual server name must be unique within the Hyper-V server.
Cautions
(1) If the virtual server that is created uses Windows, the organization name and owner name are required. If the organization name is not specified, "Organization" is set. If the owner name is not specified, "Owner" is set.
(2) If the virtual server that is created uses Windows, 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.
(3) If the virtual server that is created uses Windows, the WORKGROUP or DOMAIN must be specified in the OS.selectWorkgroupDomain selection list. If neither is specified, "WORKGROUP" is set as the workgroup. Also, if nothing is entered for the workgroup name or domain name, "WORKGROUP" is set as the workgroup.
(4) If the virtual server that is created uses Windows, when WORKGROUP is selected in the OS.selectWorkgroupDomain selection list, the workgroup name can be specified using a maximum of 15 characters. If the workgroup name exceeds 15 characters, "WORKGROUP" is set.
(5) If the virtual server that is created uses Windows, 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 the entered value is invalid, "WORKGROUP" is set as the workgroup.
(6) Specify the IP address, subnet mask, and default gateway. If one of these items is not specified, none of these items are set.
Version
02.00.00
Plug-in tags
Modify VM,Hyper-V 2008
Plug-in name displayed in the task log
hypervCreateAnsFile
Return code
0: Normal
12: Error (Mistake by user) A property is invalid.
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check the task log for error details.)
41: Error (An error was detected in the component.) A property was not entered. (An error was detected in the component script.)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
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 |
R |
|
hyperv.ansFileStoreFolderPath |
Folder path for storing response file |
Specifies the full path of the folder where the response file is stored. |
-- |
Input |
R |
|
common.computerName |
Computer/Host name |
Specifies the OS computer name (host name). |
-- |
Input |
R |
|
Windows.orgName |
Organization name (company name) |
Specifies the organization name that is set for the OS of the virtual server. |
-- |
Input |
R |
|
Windows.ownerName |
Name (owner name) |
Specifies the name (owner name) that is set for the OS of the virtual server. |
-- |
Input |
R |
|
OS.ipAddressMan |
The 1st IP address |
Specify the 1st IP address for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.subnetMaskMan |
The 1st Subnet mask |
Specify the 1st subnet mask for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGWMan |
The 1st Default gateway |
Specify the 1st default gateway for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.dnsMan |
The 1st DNS server IP address |
Specify the 1st IP address of the DNS server for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.ipAddress2 |
IP address (for second NIC) |
Specifies the IP address set for the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMask2 |
Subnet mask (for second NIC) |
Specifies the subnet mask that is set to the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.defaultGW2 |
Default gateway (for second NIC) |
Specifies the default gateway that is set to the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.dns2 |
DNS server IP address (for second NIC) |
Specifies the IP address of the DNS server that is set to the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.ipAddress3 |
IP address (for third NIC) |
Specifies the IP address set for the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMask3 |
Subnet mask (for third NIC) |
Specifies the subnet mask that is set to the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.defaultGW3 |
Default gateway (for third NIC) |
Specifies the default gateway that is set to the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.dns3 |
DNS server IP address (for third NIC) |
Specifies the IP address of the DNS server that is set to the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.ipAddress4 |
IP address (for fourth NIC) |
Specifies the IP address set for the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMask4 |
Subnet mask (for fourth NIC) |
Specifies the subnet mask that is set to the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.defaultGW4 |
Default gateway (for fourth NIC) |
Specifies the default gateway that is set to the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.dns4 |
DNS server IP address (for fourth NIC) |
Specifies the IP address of the DNS server that is set to the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
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 |
R |
|
OS.domainUserName |
Domain user name |
Specifies the user name of the domain where the virtual server belongs. You must enter this if "DOMAIN" was selected in the Workgroup/domain selection. |
-- |
Input |
O |
|
OS.domainUserPassword |
Domain password |
Specifies the password of the domain where the virtual server belongs. You must enter this if "DOMAIN" was selected in the Workgroup/domain selection. |
-- |
Input |
O |
|
OS.selectWorkgroupDomain |
Select workgroup or domain |
Specifies whether the virtual server belongs to a workgroup or domain. |
-- |
Input |
R |
|
common.osUserPassword |
Administrator password |
Specifies the administrator password that is set for the OS. If nothing is entered, "Password123" is set. |
-- |
Input |
O |
|
common.osUserPasswordReEnter |
Re-enter administrator password |
Re-enter the administrator password that is set for the OS. If nothing is entered, "Password123" is set. |
-- |
Input |
O |
|
OS.productKey |
Windows product key |
Specifies the Windows product key. Enter this in the format "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX". |
-- |
Input |
O |
|
OS.operatingSystem |
Operating system |
Specifies the operating system (OS) of the virtual server. |
-- |
Input |
R |
|
OS.timeZone |
Time zone |
Specifies the time zone that is set to the OS of the virtual server. |
-- |
Input |
O |
|
OS.systemLocale |
System locale |
Specifies the system locale that is set for the OS of the virtual server. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |
|
common.flag2IPsSetup |
Whether two IP addresses are set to virtual server |
Property that indicates whether two IP addresses have been set to a virtual server (TRUE), or otherwise (FALSE). |
-- |
Output |
O |
|
common.flagJoinDomain |
Domain join process required |
The value stored for this property is TRUE when joining the domain, and FALSE when not joining the domain. |
-- |
Output |
O |
|
OS.mngIpaddr |
IP address (for management) |
Stores the IP address (for management). |
-- |
Output |
O |