5.5.14 Create Virtual Disk
Function
This plug-in creates a new virtual disk file in a Hyper-V environment.
This plug-in requires the following server:
- Hyper-V server (execution-target server)
A server on which Hyper-V is installed
This plug-in can create dynamic (variable-size) or fixed (fixed-size) virtual disks. It cannot create differential virtual disks or pass-through (physical) disks.
If you specify the property hyperv.vHardDiskFolderPath, a new virtual disk file is created in the folder path specified by the property. If you do not specify this property, a new virtual disk is saved in the default virtual-disk storage folder set on the Hyper-V server.
If you specify a path that includes non-existent folders, those folders are automatically created.
Use situation
You can use this plug-in when adding data disks to a virtual server (for example, when setting up a new virtual server or increasing the capacity of a disk).
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 product for the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products for the execution-target server:
(1) Prerequisite product for the Hyper-V server
- Windows Server 2012 Hyper-V, Windows Server 2012 R2 Hyper-V
Supported OSs for the prerequisite products on the execution-target server:
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
Note: Environments where Server Core is installed are excluded.
Conditions for using the prerequisite products on the execution-target server:
None.
Cautions
(1) The created virtual disk is not initialized. Manually initialize it as necessary.
Version
02.00.00
Plug-in tags
Modify VM,Hyper-V 2012
Plug-in name displayed in the task log
hyperv2012CreateVDisk
Return code
0: Normal
12: Error (Mistake by user): Invalid property
23: Error (Invalid environment): The environment requirements are not met.
27: Error (Check the task log for details of the error): 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.vHardDiskName |
Virtual Disk File Name |
Specify the name of the virtual disk file to be created. The file extension must be "vhd" or "vhdx". |
-- |
Input |
R |
|
hyperv.vHardDiskFolderPath |
Virtual Disk Folder Path |
Specify the full path of the folder in which to store the virtual disk to be created. If you omit this setting, the default folder for storing virtual disks specified on the Hyper-V server will be used. |
-- |
Input |
O |
|
hyperv.vHardDiskType |
Virtual disk type |
Specifies the virtual disk type. Specify one of the following: dynamic (an adjustable-size virtual disk is created) or fixed (a fixed-size virtual disk is created). |
-- |
Input |
R |
|
hyperv.vHardDiskCapacityGB |
Virtual disk capacity (GB) |
Specify (in GB) the capacity of the virtual disk to be created. Specify the capacity of the virtual disk as an integer. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |
|
hyperv.returnVhdPath |
Virtual disk file path |
Stores, as a full path, the file path of the virtual disk created by this component. |
-- |
Output |
-- |