3.11.6 Stop virtual server
Function
This service template shuts down the OSs of multiple virtual servers in a Hyper-V environment.
This service template requires the following servers:
- Hyper-V server
A server on which Hyper-V is installed
- Virtual servers
Virtual servers managed by Hyper-V
The following is an overview of the processing:
(1) The status of a virtual server is obtained.
(2) If the virtual server is running, the OS of that virtual server is shut down. If the virtual server is stopped, the processing to shut down the OS is skipped. In all other cases, processing for that virtual server fails.
The above processing is performed in parallel for the specified virtual servers.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products in the system, prerequisite products in the service-template execution system, and OSs of prerequisite products in the service-template execution system.
Prerequisite products in the system:
JP1/Automatic Operation 12-00 or later
Prerequisite products in the service-template execution system:
(1) Prerequisite products on the Hyper-V server
- Windows Server 2016 Hyper-V
OSs of prerequisite products in the service-template execution system:
(1) Prerequisite OS for the Hyper-V server
- Windows Server 2016 Standard/Datacenter
Note: Exceptions are environments in which Server Core/Nano Server is installed.
(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.
Conditions for using the prerequisite products in the service-template execution system:
(1) The name of each virtual server must be unique within a single Hyper-V server.
(2) The following service of Hyper-V Integration Service on the target virtual server must be enabled:
- Shut down operating system
Cautions
(1) If you execute this service, the data of files that are currently being edited on the virtual server will not be saved.
Version
03.00.00
Tags
Control VM,Hyper-V 2016
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 Hyper-V information. |
Y |
|
Virtual server information |
Specify information about the virtual server to be stopped. |
Y |
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 |
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 (-). |
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 |
powerOffVMhyperV2016 |
Repeated Execution Plug-in |
Shuts down the OSs of multiple virtual servers. |
After removing the cause of the error, run the service again. |