3.9.1 Start virtual server
Function
This service template starts 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 stopped, it is started. If the virtual server is already running, the processing to start the virtual server is skipped. In all other cases, processing for that virtual server ends in an error.
(3) If the network connection check 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 check whether it is connected to the network.
The above processing is performed in parallel for the specified virtual servers.
Before a virtual server is started, a check of the virtual server status is performed for the number of times specified by the property hyperv.checkVmStateEnabledCount, at the interval specified (in seconds) by the property hyperv.checkVmStateEnabledInterval. Adjust the values of these properties based on your environmental requirements.
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 2012 Hyper-V or Windows Server 2012 R2 Hyper-V
OSs of prerequisite products in the service-template execution system:
(1) Prerequisite OS for the Hyper-V server
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
Note: Exceptions are environments in which Server Core is installed.
(2) Prerequisite OS for the virtual server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
Note: Exceptions are environments in which Server Core 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 Hyper-V Integration Service must be enabled on the target virtual server:
- Data Exchange
(3) If the network connection check is enabled, you must specify the address of the connection destination for agentless monitoring. Make sure to specify a loopback address that can be resolved from the name "localhost".
(4) If the network connection check is enabled, the firewall for the target virtual server must permit ICMP (ECHO) replies.
Cautions
(1) When the network connection check is performed, depending on the system environment, the task might not be able to obtain all IP addresses immediately after the virtual servers are started. As a result, even if all virtual servers are running, the plug-in osSendIcmp might not be able to confirm network connection for all IP addresses (IPv4) set on the virtual servers, and the task might end abnormally. To ensure that all IP addresses can be obtained, adjust the value (in seconds) of the property hyperv.waitTime, which specifies the amount of time to wait between starting a virtual server to obtaining an IP address.
(2) To perform the network connection check, 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 (#1). If the total length exceeds 1,024 characters, an error might occur in the plug-in osSendIcmp, causing the task to end abnormally.
#1: The maximum length of one IP address (IPv4) including the comma used as an address separator is 16 characters.
(3) If you enable the network connection check, adjust the value of the property common.icmpEchoTimeout based on your environmental requirements.
Execution privilege
Built-in Administrator
Version
03.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 2012. |
Y |
|
Virtual server information |
Specify information about the virtual server to be started. |
Y |
|
Network connection check |
This property is used to check the network connection after the virtual server is started. If necessary, change the value of this property. |
N |
|
Run-time option |
This property is used to check statuses before virtual servers are started. If necessary, change the value of this property. |
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 performing a network connectivity check, specifies the amount of time, in seconds, after the virtual server starts to wait before starting to obtain the IP address. |
Input |
Disabled |
R |
Network connection check |
|
common.icmpEchoTimeout |
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. |
Input |
Disabled |
R |
Network connection 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 network connectivity after starting a virtual server. |
Input |
Disabled |
R |
Network connection 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 |
powerOnVMhyperV2012 |
Repeated Execution Plug-in |
Starts multiple virtual servers. |
After removing the cause of the error, run the service again. |