3.7.6 Stop the virtual server
Function
This service template performs a forced shutdown of the OSs of multiple virtual servers in the Hyper-V environment.
The following servers are required for this service template:
- 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 status of the virtual server is obtained. For details, see "List of statuses of virtual servers managed by Hyper-V" in this product manual.
(2) If the virtual server is in the startup complete status, shut down the virtual server OS. If the status is stopping complete, the process for shutting down the virtual server OS is skipped. In cases where the status is something other than startup complete or stopping complete, an error occurs in the process of the relevant virtual server.
The above processing is performed in parallel for the specified virtual server group.
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 status is repeated for the count specified in the hyperv.checkVmStateDisabledCount property. Adjust the values of each property based on your usage environment.
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]
JP1/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
Cautions
(1) This service performs a forced shutdown of the specified virtual server OS. When this service is executed, file data that was being edited in the virtual server is not saved.
Version
03.00.00
Tags
Control 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 information. |
Y |
|
Virtual server information |
Specify the information of the virtual server that will be stopped. |
Y |
|
Execution options |
This is the property for the state check when stopping the virtual server. 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 |
|
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 |
Execution options |
|
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 |
Execution options |
|
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 |
Execution options |
|
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 |
Execution options |
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.foreachVmName |
Virtual server names (multiple names can be specified) |
Specifies one or more names for 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.) If specifying multiple names, separate them with commas. You can specify up to 99 names. |
Input |
Disabled |
R |
Virtual server information |
The following shows the list of the properties to be displayed in the "Task Details" window only:
|
Property key |
Property name |
Description |
I/O type |
Shared |
|---|---|---|---|---|
|
common.taskResult |
Results of repeating tasks |
This property contains the results of each task (as "true" or "false"), in a comma-delimited format. |
Output |
Disabled |
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 (-). |
|
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. |
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.foreachVmName |
Enter a character string of up to 1024 characters. The following characters are not allowed: < > | ; & ' " * ? [ ] ` % \ / : |
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 |
powerOffVMhyperV |
Repeated Execution Plug-in |
Performs a forced shutdown of multiple virtual server OSs. |
After removing the cause of the error, run the service again. |