3.7.3 Restart virtual servers
Function
This service template restarts 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) If the virtual server is in the startup complete status#1, the virtual server is restarted. If the virtual server is in a status other than startup complete, an error occurs in the process of the relevant virtual server.
(2) When the network connection check is performed, the IP address (IPv4) that was set to the restarted virtual server is obtained, and then an ICMP echo request is sent to the virtual server that was started from the local server to check the network connection.
The above processing is performed in parallel for the specified virtual server group.
When the virtual server is restarted, first, a wait is performed for the count specified in the hyperv.checkVmStateDisabledInterval property, and the operation for checking that the virtual server is in the stopping complete state is repeated for the count specified in the hyperv.checkVmStateDisabledCount property. Next, a wait is performed for the number of seconds specified in the hyperv.checkVmStateEnabledInterval property, and the operation for checking that the virtual server is in the startup complete state is repeated for the count specified in the hyperv.checkVmStateEnabledCount property. Adjust the values of each property based on your usage environment.
#1: For details on the virtual server status, see "List of statuses of virtual servers managed by Hyper-V" in this product manual.
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
- Data Exchange
(3) When the network connection check is executed, the local server (loopback address resolved by "localhost") must be set as an agentless connection target.
(4) When the network connection check is executed, the firewall of the target virtual server must allow ICMP (echo) replies.
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.
(2) When the network connection check is executed, all IP addresses might be unobtainable immediately after the virtual server is started in certain system environments. For this reason, regardless of whether the virtual server is started, the task might be terminated abnormally without being able to perform the network connection check for all IP addresses (IPv4) that were set to the virtual server by the osSendIcmp component. Specify the number of seconds for the hyperv.waitTime property that specifies the wait time from startup of the virtual server until obtaining of the IP addresses is started, and then make adjustments so that all IP addresses can be obtained.
(3) When the network connection check is performed, configure the settings so that the total length of the IP addresses (IPv4) that are set to all NICs of the virtual server does not exceed 1024 characters#1. If the total length of the IP addresses (IPv4) exceeds 1024 characters, an error might occur in the osSendIcmp component, and the task might terminate abnormally.
#1: The maximum length of one IP address (IPv4) is 16 characters (including the comma when listing multiple addresses).
(4) When the network connection check is performed, adjust the common.icmpEchoTimeout property based on the usage environment.
Execution privilege
Built-in Administrator
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 restarted. |
Y |
|
Check network connection |
This is the property for the network connection check after the virtual server is restarted. Make any changes as needed. |
N |
|
Execution options |
This is the property for the state check when restarting 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.waitTime |
Wait time before starting to obtain IP address |
Specifies, in seconds, the wait time from completion of virtual server restart until obtaining of the IP address is started when the network connection check is performed. |
Input |
Disabled |
R |
Check network connection |
|
common.icmpEchoTimeout |
Timeout period for ICMP echo requests |
Specifies, in milliseconds, the wait time for the response to the ICMP echo request which is executed after virtual server restart when the network connection check is performed. |
Input |
Disabled |
R |
Check network connection |
|
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.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 |
Execution options |
|
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 |
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 |
|
hyperv.checkJobPowerOnCount |
Job monitoring count (RequestStateChange method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (RequestStateChange method). You do not need to change the value of this property. |
Input |
Disabled |
R |
Execution options |
|
hyperv.checkJobPowerOnInterval |
Job monitoring interval (RequestStateChange method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (RequestStateChange 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 |
|
hyperv.checkNetworkConnection |
Check network connectivity |
Specifies whether the network connection check is performed after restarting the virtual server. |
Input |
Disabled |
R |
Check network connection |
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 |
Integer between 1 and 214783647 can be entered. |
|
hyperv.checkVmStateDisabledCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateDisabledInterval |
Enter an integer from 1 to 60. |
|
hyperv.checkVmStateEnabledCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkVmStateEnabledInterval |
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.checkJobPowerOnCount |
Enter an integer from 1 to 2147483647. |
|
hyperv.checkJobPowerOnInterval |
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 |
rebootVMhyperV |
Repeated Execution Plug-in |
Restarts multiple virtual servers. |
After removing the cause of the error, run the service again. |