3.9.3 Restart virtual server
Function
This service template restarts 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 server
A virtual server managed by Hyper-V
The following is an overview of the processing:
(1) For a virtual server that is running, this service template restarts the virtual server. For a virtual server in any state other than the running state, processing for that virtual server ends in an error.
(2) If the network connectivity check is enabled, this service template obtains the IP address (IPv4) set for the restarted virtual server. Then, network connectivity is checked by sending an ICMP echo request from the local server to the restarted virtual server.
The above processing is executed in parallel for the specified virtual servers.
After a virtual server starts, a status check is performed for that server for the number of times specified by the property hyperv.checkVmStateEnabledCount, at the interval (in seconds) specified by the property hyperv.checkVmStateEnabledInterval. Adjust the values of these properties based on the environmental requirements.
Prerequisites
For the most recent information about the prerequisite products for the system, prerequisite products for the system executing the service templates, and the supported OSs for the prerequisite products for the system executing the service templates, see the Release Notes.
Prerequisite product for the system:
JP1/Automatic Operation 11-10 or later
Prerequisite products in the system executing the service template:
(1) Prerequisite product for the Hyper-V server
- Windows Server 2012 Hyper-V, Windows Server 2012 R2 Hyper-V
Supported OSs for the prerequisite products in the system executing the service template:
(1) OS of the Hyper-V server
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
Note: Environments where Server Core is installed are excluded.
(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.
Conditions for using the prerequisite products on the system executing the service template:
(1) The name of each virtual server on the Hyper-V server must be unique.
(2) The following services of Hyper-V Integration Services must be enabled on the target virtual server:
- Operating System Shutdown
- Data Exchange
(3) If the network connectivity check is enabled, the local server (the loopback address resolved from the name "localhost") must be set as the agentless connection destination.
(4) If the network connectivity check is enabled, the firewall of the target virtual server must permit ICMP (ECHO) replies.
(5) The virtual server must be running.
Cautions
(1) This service forcibly shuts down the OS of the specified virtual server. When this service is executed, data in files that are being edited on the virtual server will not be saved.
(2) If the network connectivity check is enabled, depending on the system environment, the service might not be able to obtain all IP addresses immediately after the virtual server starts. For this reason, even if the virtual server is running, the task might terminate abnormally, because the plug-in osSendIcmp cannot check network connectivity for all IPv4 addresses set on the virtual server. To ensure that all IP addresses are obtained, adjust the number of seconds specified for the property hyperv.waitTime, which determines the amount of time to wait after the virtual server starts before obtaining IP addresses.
(3) If the network connectivity check is enabled, make sure that the total length of all IPv4 addresses set for the NICs of the virtual server does not exceed 1,024 characters#. If the total length exceeds 1,024 characters, an error might occur in the plug-in osSendIcmp, and the task might terminate abnormally.
#: The maximum length for each IPv4 address is 16 characters (including the comma used to delimit the IP address).
(4) If the network connectivity check is enabled, adjust the value of the property common.icmpEchoTimeout based on the environmental requirements.
Version
02.00.00
Tags
Control VM,Hyper-V 2012
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 information about Hyper-V. |
Y |
Virtual server information |
Specify information about the virtual server to be restarted. |
Y |
Network connectivity check |
This property is related to the network connectivity check that is performed after a virtual server is restarted. Change the settings of this property as necessary. |
N |
Run-time option |
This property is related to the status check that is performed when a virtual server is restarted. Change the settings of this property as necessary. |
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.waitTime |
Wait time before starting to obtain IP address |
When the network connectivity check is enabled, this specifies the amount of time (in seconds) to wait before starting the acquisition of IP addresses after the virtual server restarts. |
Input |
Disabled |
R |
Network connectivity check |
common.icmpEchoTimeout |
Timeout period for ICMP echo requests |
When the network connectivity check is enabled, this specifies the amount of time (in milliseconds) to wait for a response to an ICMP echo request issued after the virtual server restarts. |
Input |
Disabled |
R |
Network connectivity check |
hyperv.checkVmStateEnabledCount |
Virtual server status (startup complete) check count |
Specifies the number of times to check whether virtual server startup is complete. This value combined with the check interval for the virtual server status (startup complete) determines the maximum wait time. |
Input |
Disabled |
R |
Run-time option |
hyperv.checkVmStateEnabledInterval |
Virtual server status (startup complete) check interval |
Specifies the interval in seconds between checks for whether virtual server startup is complete. |
Input |
Disabled |
R |
Run-time option |
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 |
hyperv.checkNetworkConnection |
Check network connectivity |
Specifies whether to check the network connectivity after a virtual server restarts. |
Input |
Disabled |
R |
Network connectivity check |
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.waitTime |
Enter an integer from 0 to 3600. |
common.icmpEchoTimeout |
Enter an integer from 1 to 2147483647. |
hyperv.checkVmStateEnabledCount |
Enter an integer from 1 to 2147483647. |
hyperv.checkVmStateEnabledInterval |
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: < > | ; & ' " * ? [ ] ` % \ / : |
hyperv.checkNetworkConnection |
Select one of the following values: yes,no |
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 |
rebootVMhyperV2012 |
Repeated Execution Plug-in |
Restarts multiple virtual servers. |
After removing the cause of the error, run the service again. |