3.6.3 Add a virtual server (virtual disk)
Function
This service template adds a disk to a virtual server in the Hyper-V environment.
The assumptions about the server in this service template are shown below.
- Hyper-V server
This is the server where Hyper-V is installed.
- Virtual server
This is a virtual server managed by Hyper-V.
An overview of the processing is as follows.
(1) The state of the virtual server is obtained.
(2) A check is performed that the virtual server is in the stopping complete state.
If the virtual server is in the startup complete or stopping complete state, the process is continued, but in other states (startup in progress, stopping in progress, paused, or acquiring snapshot), the task is abnormally terminated without performing any operations on the virtual server.
If the virtual server state is not startup complete, the User-Response Wait Plugin is executed to check whether shutdown has been performed.
If "Shutdown" was selected in the user response wait GUI, the virtual server is shut down.
If "Cancel" was selected, or a timeout occurred in the response wait, the task is abnormally terminated without performing any operation on the virtual server.
When the virtual server OS is shut down, a wait is performed for the number of seconds specified in the hyperv.checkVmStateDisabledInterval property, and the operation for checking the virtual server state is repeated for the count specified in the hyperv.checkVmStateDisabledCount property. Adjust the values of each property based on your usage environment.
(3) A virtual disk is added to the virtual server.
Although a virtual disk (adjustable size/fixed size) can be added to the virtual server, a virtual disk (differential) and pass-through (physical) disk cannot be added.
A new virtual disk file is created at the path specified in the hyperv.vhdPath property.
The virtual disk can be added to the SCSI controller, but it cannot be added to the IDE controller.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1)Prerequisite product of Hyper-V Server
- Windows Server 2008 R2 Hyper-V
[Prerequisite product OS running in the system executing the service template]
(1) Prerequisite OS of Hyper-V Server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
(2) Prerequisite OS of the virtual server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions of prerequisite products in the system executing the service template]
(1) The virtual server name must be unique within the Hyper-V server.
(2) The following Hyper-V Integration Service must be enabled in the target virtual server.
- Operating system shutdown
(3) The virtual server must be in a completely stopped state.
(4) A SCSI controller must be in the virtual server.
Cautions
(1) This service template does not initialize the virtual disk that was added to the virtual server. If necessary, log into the virtual server OS and perform initialization of the disk.
(2) Do not execute multiple instances of this service simultaneously for the same virtual server.
(3) If an HTML tag is specified for the UserResponseplugin.dialogText property, the tag and attribute that can be specified are identical to those for the User-Response Wait Plugin. For details, see the topics explained in "User-Response Wait Plugin" in this product manual.
(4) Virtual disk files that were already created in the Hyper-V server cannot be added.
(5) If "Shutdown" was selected in the user response wait GUI, the virtual server OS is forced to shut down. File data that was being edited in the virtual server is not saved.
Version
03.00.00
Tags
Modify VM,Hyper-V 2008
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Virtual system environment information |
Specify the Hyper-V server information. |
Y |
|
Virtual disk information |
Specify the information of the virtual disk that will be added. |
Y |
|
User response wait options |
This is the option for user responses when the virtual server is running. Make any changes as needed. |
N |
|
Options at execution |
This is the property for virtual server state confirmation. Make any changes as needed. |
N |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
hyperv.targetHost |
Hyper-V server host name |
Specifies the host name or IP address of the Hyper-V server. IPv6 addresses are not supported. |
Input |
Disabled |
R |
Virtual system environment information |
|
UserResponsePlugin.toAddress |
TO addresses |
Specify the email addresses to enter in the TO field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.ccAddress |
CC addresses |
Specify the email addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.bccAddress |
BCC addresses |
Specify the email addresses to enter in the BCC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.mailSubject |
Subject line |
Specify the subject line of notification emails sent when the service is waiting for a user response. |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.mailBody |
Email text |
Specify the body text of notification emails sent when the service is waiting for a user response. |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.encodeType |
Encoding |
Specify the encoding of notification emails sent when the service is waiting for a user response. The encodings you can specify are us-ascii, iso-2022-jp, shift_jis, euc-jp, and utf-8. If you omit this property, utf-8 is set. |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.dialogText |
Additional dialog box text |
Enter additional text to appear in the response input dialog box, in text or HTML format. Supported HTML tags are anchor tags, bold tags, break tags, font tags, italics tags, and underline tags. |
Input |
Disabled |
O |
User response wait options |
|
UserResponsePlugin.responseTimeOut |
Response timeout time (minutes) |
Specify how long (in minutes) the service waits for a user response before timing out. In the event of a response timeout, the service will terminate abnormally. |
Input |
Disabled |
R |
User response wait options |
|
hyperv.checkVmStateDisabledCount |
Virtual server status (stopping complete) check count |
Specifies the number of times to check whether virtual server stopping is complete. This value combined with the check interval for the virtual server status (stopping complete) determines the maximum wait time. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkVmStateDisabledInterval |
Virtual server status (stopping complete) check interval |
Specifies the interval in seconds between checks for whether virtual server stopping is complete. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobShutdownCount |
Job monitoring count (InitiateShutdown method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (InitiateShutdown method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobShutdownInterval |
Monitor interval (InitiateShutdown method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (InitiateShutdown method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobNewVhdCount |
Monitor count (CreateDynamic/FixedVirtualHardDisk) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDisk method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobNewVhdInterval |
Monitor interval (CreateDynamic/FixedVirtualHardDisk) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDisk method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobAssignSCSICount |
Monitor count (AddVirtualSystemResources method, Add hard drive) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (AddVirtualSystemResources method, Add hard drive). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobAssignSCSIInterval |
Monitor interval (AddVirtualSystemResources, Add hard drive) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (AddVirtualSystemResources method, Add hard drive). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobJoinCount |
Monitor count (AddVirtualSystemResources, Connect to disk) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (AddVirtualSystemResources method, Connect to disk). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
|
hyperv.checkJobJoinInterval |
Monitor interval (AddVirtualSystemResources, Connect to disk) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (AddVirtualSystemResources method, Connect to disk). You do not need to change the value of this property. |
Input |
Disabled |
R |
Options at execution |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
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 |
Disabled |
R |
Virtual disk information |
|
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 |
Disabled |
R |
Virtual disk information |
|
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 |
Disabled |
R |
Virtual disk information |
|
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 |
Disabled |
R |
Virtual disk information |
|
hyperv.vhdPath |
Virtual disk file path |
Specifies, as a full path, the path of the virtual disk file to be created. Specify vhd as the extension of the virtual disk file. Virtual disk files that have already been created cannot be specified. |
Input |
Disabled |
R |
Virtual disk information |
|
hyperv.capacity |
Size (GB) |
Specifies the size of the virtual disk, in gigabytes (GB). |
Input |
Disabled |
R |
Virtual disk information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
hyperv.targetHost |
Enter up to 256 halfwidth alphanumeric characters. You can also use periods (.) and hyphens (-). |
|
UserResponsePlugin.toAddress |
A maximum of 1024 characters can be entered. Characters that can be used include alphanumeric characters and symbols. |
|
UserResponsePlugin.ccAddress |
A maximum of 1024 characters can be entered. Characters that can be used include alphanumeric characters and symbols. |
|
UserResponsePlugin.bccAddress |
A maximum of 1024 characters can be entered. Characters that can be used include alphanumeric characters and symbols. |
|
UserResponsePlugin.mailSubject |
A character string of no more than 256 characters can be entered. |
|
UserResponsePlugin.mailBody |
A character string of no more than 1024 characters can be entered. |
|
UserResponsePlugin.encodeType |
Select one of the following values: us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8 |
|
UserResponsePlugin.dialogText |
A character string of no more than 512 characters can be entered. |
|
UserResponsePlugin.responseTimeOut |
Integer between 1 and 9999 can be entered. |
|
hyperv.checkVmStateDisabledCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateDisabledInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkJobShutdownCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobShutdownInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkJobNewVhdCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobNewVhdInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkJobAssignSCSICount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobAssignSCSIInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkJobJoinCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobJoinInterval |
Enter an integer from 1 to 60. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
hyperv.vmName |
Enter a character string of up to 100 characters. The character string must not start with a space, end with a space or period (.), or contain the following characters: < > | ; & ' " * ? [ ] ` , % \ / : |
|
hyperv.vHardDiskType |
Select one of the following values: Dynamic,Fixed |
|
hyperv.scsiControllerNumber |
Enter an integer from 0 to 3. |
|
hyperv.scsiLocationNumber |
Enter an integer from 0 to 63. |
|
hyperv.vhdPath |
Enter a character string of up to 256 characters. The character string must not end with a backslash (\) or contain the following characters: < > | ; & * ? " % / ' [ ] ` |
|
hyperv.capacity |
Enter an integer from 1 to 2040. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
hypervGetVMState |
Obtain the virtual server status |
Obtains the virtual server state in the Hyper-V environment. |
Check the virtual server state. |
|
2 |
hypervCheckVMState |
Flow Plug-in |
Checks the virtual server state, and if startup is completed, confirmation is sent to the user. |
-- |
|
2-3 |
Compatible Plug-in |
Determines if the virtual server is in the "Start completed" state. |
After removing the cause of the error, run the service again. |
|
|
2-4 |
Flow Plug-in |
Shuts down the virtual server. |
-- |
|
|
2-4-1 |
User-Response Wait Plug-in |
Checks if the virtual server is to be shut down. |
After removing the cause of the error, run the service again. |
|
|
2-4-2 |
Judge ReturnCode Plug-in |
Determines if the return value of the component waiting for a user response is 1. |
After removing the cause of the error, run the service again. |
|
|
2-4-3 |
Abnormal-End Plug-in |
Makes the jobnet an error. |
After removing the cause of the error, run the service again. |
|
|
2-4-4 |
Shut down a virtual server |
Shuts down a virtual server in the Hyper-V environment. |
After removing the cause of the error, run the service again. |
|
|
3 |
AddDisk |
Flow Plug-in |
Adds a disk to the virtual server. |
-- |
|
3-1 |
Add a disk to the virtual server |
Adds a disk to the virtual server in the Hyper-V environment. |
If the virtual disk file has been created, delete it manually. If the location for the SCSI controller of the virtual server is being used and the path of the virtual disk file is not specified, delete the hard drive from the SCSI controller to release the location for the SCSI controller from being used. And then run this service again. |
|