5.5.8 Create a virtual server
Function
This plug-in creates a virtual server by replicating an exported virtual server 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.
- Exported virtual server
A virtual server exported from Hyper-V and a set of files that make up the virtual server.
- Container server
The server that contains the exported virtual server that is to be replicated.
The exported virtual server is replicated at the import destination.
The virtual server is created on the Hyper-V server by using the import function.
When a virtual server is created, a new unique ID is assigned.
If folders in the path specified as the import destination already exist, they are used as is.
Use situation
This plug-in can be used to create a new virtual server in a Hyper-V environment. By using this plug-in with the following plug-ins, you can specify the initial OS settings and set the IP address of the virtual server:
- hyperv2012CreateAnsFile
- hyperv2012MountVhd
- hyperv2012UnmountVhd
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 for 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 the virtual server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter or 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 the execution-target server:
(1) The virtual server name must be unique within the Hyper-V server.
(2) 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.
(3) Snapshots and differential disks must not be created on the exported virtual server.
(4) The NIC of the exported virtual server must be disconnected from a virtual switch.
Cautions
(1) If one or more folders in the specified import destination path do not exist, non-existent folders are created.
(2) 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.
(3) This plug-in 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.
Version
02.00.00
Plug-in tags
Add VM,Hyper-V 2012
Plug-in name displayed in the task log
hyperv2012CreateVM
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.importFolderPath |
Import target |
Specifies the path of the folder where the virtual server is stored. |
-- |
Input |
R |
|
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 |
O |
|
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 |
O |
|
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 |
R |
|
hyperv.scsiDiskLocation |
SCSI controller location |
Specifies the location of the SCSI controller to which the system disk is set. This property is enabled only if the generation of the exported virtual server is the second generation. |
0 |
Input |
R |
|
hyperv.returnVhdPath |
Virtual disk file path (for first NIC) |
Stores, as a full path, the file path of the virtual disk (first NIC) created by this component. |
-- |
Output |
O |
|
hyperv.returnVhdPath2 |
Virtual disk file path (for second NIC) |
Stores, as a full path, the file path of the virtual disk (second NIC) created by this component. |
-- |
Output |
O |
|
hyperv.returnVhdPath3 |
Virtual disk file path (for third NIC) |
Stores, as a full path, the file path of the virtual disk (third NIC) created by this component. |
-- |
Output |
O |
|
hyperv.returnVhdPath4 |
Virtual disk file path (for fourth NIC) |
Stores, as a full path, the file path of the virtual disk (fourth NIC) created by this component. |
-- |
Output |
O |
|
hyperv.returnNumOfNic |
Number of NICs |
Stores the number of NICs connected to the virtual server. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |