5.6.13 Mount a virtual disk
Function
This plug-in mounts a virtual disk to a Hyper-V server.
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.
Use situation
This plug-in can be used to mount a virtual disk to the Hyper-V server.
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 2016 Hyper-V
(2) Prerequisite OS for the virtual server
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
Conditions for using the execution-target server:
(1) The virtual server name must be unique within the Hyper-V server.
Cautions
(1) When virtual disks on a virtual server are mounted to the Hyper-V server, available drive letters on the Hyper-V server are temporarily locked. If there are no available drive letters, an error occurs and this plug-in terminates. Before you execute this plug-in, make sure that there are as many available drive letters on the Hyper-V server as the number of drives used by the virtual disks to be mounted.
Version
02.12.00
Plug-in tags
Modify VM,Hyper-V 2016
Plug-in name displayed in the task log
hyperv2016MountVhd
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.vhdPath |
Virtual disk file path (for first NIC) |
Specifies the path of the virtual disk file (first NIC) as a full path. |
-- |
Input |
R |
hyperv.vhdPath2 |
Virtual disk file path (for second NIC) |
Specifies the path of the virtual disk file (second NIC) as a full path. |
-- |
Input |
O |
hyperv.vhdPath3 |
Virtual disk file path (for third NIC) |
Specifies the path of the virtual disk file (third NIC) as a full path. |
-- |
Input |
O |
hyperv.vhdPath4 |
Virtual disk file path (for fourth NIC) |
Specifies the path of the virtual disk file (fourth NIC) as a full path. |
-- |
Input |
O |
hyperv.checkJobStateCountGetDriveList |
Job monitoring count (Win32_LogicalDisk method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (Win32_LogicalDisk method). You do not need to change the value of this property. |
1440 |
Input |
R |
hyperv.checkJobStateIntervalGetDriveList |
Job monitoring interval (Win32_LogicalDisk method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (Win32_LogicalDisk method). You do not need to change the value of this property. |
5 |
Input |
R |
hyperv.returnDriveLetter |
Drive letter |
Stores the drive letter assigned to the virtual disk that was mounted by this component. |
-- |
Output |
-- |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |
hyperv.returnVhdPath |
Virtual disk file path |
Stores the path of the virtual disk file as a full path. |
-- |
Output |
-- |