5.5.15 Connect Virtual Disk
Function
This plug-in connects a virtual disk to a virtual server in a Hyper-V environment.
This plug-in requires the following servers:
- Hyper-V server (execution-target server)
A server on which Hyper-V is installed
- Virtual server
A virtual server managed by Hyper-V
You can add virtual disks to a SCSI controller but not to an IDE controller.
The method for connecting a virtual disk to a SCSI controller varies depending on whether the SCSI controller ID number (the property hyperv.scsiControllerNumber) and SCSI controller location number (the property hyperv.scsiLocationNumber) are specified.
- If neither the SCSI controller ID number nor the SCSI controller location number is specified:
The Hyper-V server automatically connects the virtual disk to an available SCSI controller.
- If only the SCSI controller ID number is specified:
The Hyper-V server automatically connects the virtual disk to any location (0 to 63) of the specified SCSI controller.
- If only the SCSI controller location number is specified
The Hyper-V server automatically connects the virtual disk to the specified SCSI controller location of an available SCSI controller (0 to 3).
- If both the SCSI controller ID number and SCSI controller location number are specified
The virtual disk is connected to the specified location of the specified SCSI controller.
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
(2) OS of the virtual server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
Note: Environments where Server Core is installed are excluded.
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:
(1) The name of each virtual server on the Hyper-V server must be unique.
(2) There must be an available SCSI controller on the virtual server.
Cautions
(1) If another virtual disk is already connected to the specified SCSI controller location of the specified SCSI controller, this task terminates abnormally.
(2) For second-generation virtual servers, you can connect only virtual disks that are in VHDX file format. If you attempt to connect a created VHD file to a second-generation virtual server, this task terminates abnormally.
Version
02.00.00
Plug-in tags
Modify VM,Hyper-V 2012
Plug-in name displayed in the task log
hyperv2012AttachVDisk
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.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.attachVHardDiskFilePath |
Path of Virtual Disk File to Be Connected |
Specify the full path of the virtual disk file to be connected to the specified virtual server. |
-- |
Input |
R |
|
hyperv.scsiControllerNumber |
SCSI controller number |
Specifies the SCSI controller number of the virtual server that adds the virtual disk. Specify the SCSI controller number as an integer from 0 in the order that the SCSI controllers were added to the virtual server (displayed in the Hyper-V Manager). |
-- |
Input |
O |
|
hyperv.scsiLocationNumber |
SCSI controller location number |
Specifies the location number of the SCSI controller of the virtual server that adds the virtual disk. Specify the SCSI controller location number as an integer for the unused locations of SCSI controllers that were added to the virtual server. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |
|
hyperv.attachScsiControllerNumber |
Number of Connected SCSI Controller |
Stores the number of the SCSI controller to which the virtual disk file is connected. |
-- |
Output |
-- |
|
hyperv.attachScsiLocationNumber |
Location Number of Connected SCSI Controller |
Stores the location number of the SCSI controller to which the virtual disk file is connected. |
-- |
Output |
-- |