Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


5.5.1 Create a response file

Function

This plug-in creates a response file for specifying the initial OS settings and setting an IP address for a virtual server (Windows) in a Hyper-V environment.

The following describes the servers that this plug-in requires:

- Hyper-V server (execution target server)

A Windows server on which Hyper-V is installed.

- Virtual server

A virtual server managed by Hyper-V.

Only one IP address can be set. If the virtual server has two or more NICs, the IP address is set for the first NIC. The other NICs are unavailable.

The IP address to be set for the (first) NIC is determined based on the following priority: management-use IP address > 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.

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 2008 R2

Windows Server 2012

Windows Server 2012 R2

Use situation

This plug-in can be used to create a response file that sets up the OS and sets an IP address for a virtual server (Windows) in a Hyper-V environment.

Prerequisites

For the most recent information about the prerequisite products for the system, prerequisite products for the execution-target server, and the supported OSs for the prerequisite products for the execution-target server, see the Release Notes.

Prerequisite products for the system:

JP1/Automatic Operation 11-00 or later

Prerequisite products on the execution target server:

(1) Prerequisite products for the Hyper-V server

-Windows Server 2012 Hyper-V, Windows Server 2012 R2 Hyper-V

(2) Prerequisite OS for virtual servers

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

-Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

Note: Exceptions are environments in which Server Core is installed.

Supported OSs for the prerequisite products for the execution-target server:

- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter

Note: Exceptions are environments in which Server Core is installed.

Conditions for using prerequisite products on the execution target server:

(1) The virtual server name must be unique within the Hyper-V server.

Cautions

(1) If the OS of the virtual server being created is Windows, the organization name and owner name are required. If the organization name is omitted, the string "Organization" is set as the organization name. If the owner name is omitted, the string "Owner" is set as the owner name.

(2) If the OS of the virtual server being created is Windows, the OS user password must be entered twice (the second entry being 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 and second entered passwords do not match.

(3) If the OS of the virtual server being created is Windows, either WORKGROUP or DOMAIN must be selected from the selection list for the OS.selectWorkgroupDomain property. If neither WORKGROUP nor DOMAIN is selected, "WORKGROUP" is set as the workgroup name. Similarly, if workgroup-name/domain-name is not entered, "WORKGROUP" is set as the workgroup name.

(4) If the OS of the virtual server being created is Windows and WORKGROUP is selected from the selection list for the OS.selectWorkgroupDomain property, the maximum length of the specifiable workgroup name is 15 characters. If you specify a workgroup name longer than 15 characters, the string "WORKGROUP" is set, instead of the specified name.

(5) If the OS of the virtual server being created is Windows and 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 invalid, "WORKGROUP" is set as the workgroup name.

(6) 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.

Version

02.00.00

Plug-in tags

Modify VM,Hyper-V 2012

Plug-in name displayed in the task log

hyperv2012CreateAnsFile

Return code

0: Normal

12: Error (Mistake by user) Invalid property

23: Error (Invalid environment) The environment requirements are not met.

27: Error (Check with the task log about the error detail) Unidentified error

41: Error (An error has been detected in the component) Property not entered (An error has been 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