3.13.2 Start virtual server
Function
This service template starts instances in a KVM environment managed by OpenStack.
The OpenStack-related terms used in this document are names displayed in the OpenStack Dashboard. These terms are as follows:
- Identity
Displayed as "Identity" or "KeyStone".
- Project
Displayed as a project or tenant.
To use this service template, the following servers are required:
- OpenStack server
A server on which OpenStack is installed
- KVM server
A server on which a Kernel-based Virtual Machine is installed
- OpenStack control server
A server that executes REST-API functions on the OpenStack server
- Instance
An instance (a normal virtual server) managed by the OpenStack server and by KVM
The following is an overview of the processing:
(1) The status of an instance is obtained.
(2) If the instance is stopped, it is started. If the instance is already running, the processing to start the instance is skipped. In all other cases, processing for that instance ends in an error.
(3) If the network connection check is enabled, the IP address (IPv4) set for the instance that was started is obtained. Then the local server sends an ICMP echo request to that instance to check whether it is connected to the network.
The above processing is performed in parallel for the specified instances.
Before an instance is started, an instance status check is performed for the number of times specified by the property openstack.checkInstanceStateEnabledCount, at intervals specified (in seconds) by the property openstack.checkInstanceStateEnabledInterval. Adjust the values of these properties based on your 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 products for the system:
JP1/Automatic Operation 12-00 or later
Prerequisite products in the service-template execution system:
(1) Prerequisite products on the OpenStack server
- OpenStack
(2) Virtualization environment that manages the instance
- Kernel-based Virtual Machine
- VMware vCenter Server
- VMware vSphere ESXi
(3) OpenStack control server
- Microsoft .Net Framework 3.5 or later
Supported OSs for the prerequisite products in the service-template execution system:
(1) Prerequisite OS for the instance
- Red Hat Enterprise Linux Server 6 (32-bit x86) or Red Hat Enterprise Linux Server 6 (64-bit x86_64)
- Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(2) Prerequisite OS for the OpenStack server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
Note: Environments where Server Core is installed are excluded.
Conditions for using the prerequisite products in the service-template execution system:
(1) Conditions related to instances
- Each instance name must be unique within a single project.
- All instances must be inactive.
- If the network connection check is enabled, the firewall of the target virtual server must permit ICMP (ECHO) replies.
(2) Condition related to the local server
- If the network connection check is enabled, the local server (the loopback address that can be resolved from the name "localhost") must be set as the connection destination for agentless monitoring.
Cautions
(1) To perform the network connection check, make sure that the total length of the IP addresses (IPv4) set for all NICs of the instance 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.
(2) If you enable the network connection check, adjust the value of the property common.icmpEchoTimeout based on your environmental requirements.
(3) We recommend that you do not change the value of the property openstack.waitTime from its default value. However, if the wait time specified for the property is not long enough, the next step might start before OS setup finishes, causing the task to end abnormally.
Execution privilege
(1)The user who will be connecting to VMware vCenter Server must have the following permissions:
admin
(2) The user who executes the plug-in on the localhost must have the following permissions:
Built-in Administrator
Version
03.00.00
Tags
Control VM,OpenStack
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Cloud platform environment information |
Specify information about OpenStack. |
Y |
|
Instance information |
Specify information about the instance. |
Y |
|
Network connection check |
This property is used to check the network connection after the instance is started. If necessary, change the value of this property. |
N |
|
Run-time option |
This property is used to check statuses before instances 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 |
|---|---|---|---|---|---|---|
|
openstack.targetHost |
Host name of the OpenStack control server |
Specify the host name or IP address of the OpenStack control server. Make sure that you do not specify an IPv6 address. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.identityServerHostName |
Host name of the Identity server |
Specify the host name or IP address of the Identity server. Make sure that you do not specify an IPv6 address. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.userName |
User name for logging in to the Identity server |
Specify the user name for logging in to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.password |
Password for logging in to the Identity server |
Specify the password for logging in to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.protocol |
Identity server connection protocol |
Specify the protocol that is used to connect to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.portNumber |
Port number for connecting to the Identity server |
Specify the port number for logging in to the Identity server. |
Input |
Disabled |
R |
Cloud platform environment information |
|
openstack.projectName |
Project name |
Specify the project name. |
Input |
Disabled |
R |
Instance information |
|
openstack.waitTime |
Wait time before starting to obtain IP address |
When performing a network connectivity check, specifies the amount of time, in seconds, after the instance 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 |
|
openstack.checkInstanceStateEnabledCount |
Instance status (started) check count |
Specify the number of times to check whether the startup of an instance has been completed. This value and the instance status (started) check interval determine the maximum wait time. |
Input |
Disabled |
R |
Run-time option |
|
openstack.checkInstanceStateEnabledInterval |
Instance status (started) check interval |
Specify in seconds the interval at which to check whether the startup of an instance has been completed. |
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 |
|---|---|---|---|---|---|---|
|
openstack.foreachInstanceName |
Instance names |
Specify one or more instance names. Note that specifiable instance names are display names in OpenStack rather than host names in the OS. To specify multiple names, use a comma (,) as a separator. You can specify a maximum of 99 instance names. |
Input |
Disabled |
R |
Instance information |
|
openstack.checkNetworkConnection |
Whether to confirm the network connection |
Specify whether to confirm that the network has been connected after the instance is started. |
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 |
|---|---|
|
openstack.targetHost |
A string that has 256 or fewer single-byte alphanumeric characters, including periods (.) and hyphens (-) |
|
openstack.identityServerHostName |
A string that has 256 or fewer single-byte alphanumeric characters, including periods (.) and hyphens (-) |
|
openstack.userName |
A string that has 64 or fewer single-byte alphanumeric characters |
|
openstack.password |
A string that has 256 or fewer single-byte alphanumeric characters |
|
openstack.protocol |
Select one of the following values: http,https |
|
openstack.portNumber |
An integer in the range from 1 to 65,535 |
|
openstack.projectName |
A string that has 80 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
openstack.waitTime |
An integer in the range from 0 to 2,147,483,647 |
|
common.icmpEchoTimeout |
Enter an integer from 1 to 2147483647. |
|
openstack.checkInstanceStateEnabledCount |
An integer in the range from 1 to 2,147,483,647 |
|
openstack.checkInstanceStateEnabledInterval |
An integer in the range 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 |
|---|---|
|
openstack.foreachInstanceName |
A string that has 1,024 or fewer characters. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % \ |
|
openstack.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 |
powerOnVMOpenstack |
Repeated Execution Plug-in |
Repeats the startup processing the same number of times as the number of specified instances. |
After removing the cause of the error, run the service again. |