This service template starts multiple virtual servers in a Hyper-V environment.
The general steps for using this service template are as follows:
- 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.
- If the network connectivity verification is enabled, the IP address (IPv4) set for the virtual server that was started is obtained. Then the local server sends an ICMP echo request to that server to verify whether it is connected to the network.
This processing is run in parallel for the specified virtual servers.
Before a virtual server is started, a verification of the virtual server status is performed for the number of times specified by the hyperv.checkVmStateEnabledCount property, at the interval specified (in seconds) by the hyperv.checkVmStateEnabledInterval property. Adjust the values of these properties based on your environmental needs.
Service Definition and Submit Service Properties
The following table lists the properties shown in the Service Definition window for the service template.
| Property key | Property name | Description |
|---|---|---|
| hyperv.targetHost R | Hyper-V server host name | Specifies the host name or IP address of the Hyper-V server. IPv6 addresses are not supported. |
| hyperv.waitTime R | Wait time before starting to obtain IP address | When performing a network connectivity verification, specifies the amount of time, in seconds, after the virtual server starts to wait before starting to obtain the IP address. |
| common.icmpEchoTimeout R | Timeout period for ICMP echo requests | Specify in milliseconds how long the service waits for a reply to an ICMP echo request sent to confirm startup of a virtual server. |
| hyperv.checkVmStateEnabledCount R | Virtual server status (startup complete) check count | Specifies the number of times to verify whether virtual server startup is complete. This value combined with the verification interval for the virtual server status (startup complete) determines the maximum wait time. |
| hyperv.checkVmStateEnabledInterval R | Virtual server status (startup complete) check interval | Specifies the interval in seconds between verifications for whether virtual server startup is complete. |
| 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. R: Required |
||
The following table lists the properties shown in the Service Definition and the Submit Service windows:
| Property key | Property name | Description |
|---|---|---|
| hyperv.foreachVmName R | 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. |
| hyperv.checkNetworkConnection R | Check network connectivity. | Specifies whether to verify network connectivity after starting a virtual server. |
| 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. R: Required |
||
Prerequisites
- The name of each virtual server on the Hyper-V server must be unique.
- The Operating System Shutdown and Data Exchange services of Hyper-V Integration Service on the target virtual server must be enabled.
- If the network connectivity verification is enabled, the local server (the loopback address resolved from the name "localhost") must be set as the agentless connection destination.
- If the network connection verification is enabled, the firewall for the target virtual server must permit ICMP (ECHO) replies.
- The virtual server must be running.
Server requirements
- Hyper-V server
A server on which Hyper-V is installed.
- Virtual server
A virtual server managed by Hyper-V.
Usage guidelines
- 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.
- If the network connectivity verification 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 end abnormally, because the osSendIcmp plug-in cannot verify 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 hyperv.waitTime property, which determines the amount of time to wait after the virtual server starts before obtaining IP addresses.
- To perform the network connection verification, make sure that the total length of the IP addresses (IPv4) set for all NICs on a 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, causing the task to end abnormally. The maximum length of one IP address (IPv4) including the comma used as an address separator is 16 characters.
- If you enable the network connectivity verification, adjust the value of the common.icmpEchoTimeout property based on your environmental needs.