5.8.9 Create a virtual server
Function
This service template starts an instance from a server image 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".
- Instance type
Displayed as an instance type or flavor.
- 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
Use situation
This plug-in can be used to start an instance in an OpenStack environment.
You can use this plug-in with the following plug-in to perform the initial setup of the instance OS:
- osSetLinuxInfo
Prerequisites
For the most recent information about the prerequisite products for the system, prerequisite products for the execution-target server, and the supported OSs for the prerequisite products for the execution-target server, see the Release Notes.
Prerequisite products for the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products for the execution-target server:
(1) Prerequisite products for 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
(4) 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)
Supported OSs for the prerequisite products for the execution-target 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 execution-target system:
(1) Conditions related to OpenStack server settings
- In the subnet settings of the network to which the instance is connected, DHCP must be enabled so that an IP address can be assigned dynamically.
- The server image used to start the instance must already be created.
- The instance type used to start the instance must already be created.
- The network used to start the instance must already be created.
- The image name must be unique within the tenant.
- The instance type name must be unique within the tenant.
- The network name must be unique within the tenant.
(2) Conditions related to the server image used to start the instance
- Agentless connection must be possible.
- The firewall must permit ICMP (ECHO) replies.
(3) Conditions related to instances
- The names of instances name within the same tenant must be unique.
Cautions
(1) Do not operate an instance during the instance startup. If you do so, instance startup might fail. In addition, do not directly operate an instance from the OpenStack server.
(2) To assign a floating IP address to an instance, select "yes" from the list for the property openstack.floatingIpOption, and then specify the floating IP address for the property openstack.floatingIpAddress. If you do not specify a floating address, the first floating IP address obtained from the floating IP address pool for the network specified by the property openstack.networkNameExt will be set.
(3) To use an external network for communication with the JP1/AO server, select "yes" from the list for the property openstack.floatingIpOption. If you select "no", the task terminates abnormally, because the JP1/AO server cannot access the instance.
(4) If you select "yes" from the list for the property openstack.floatingIpOption, make sure to specify a value for the property openstack.networkNameExt. If you omit the property openstack.networkNameExt, the task terminates abnormally, because the external network from which the floating IP address is to be obtained cannot be identified.
(5) If you omit the property openstack.securityGroupName, "default" is set for the security group name.
(6) If you select "https" from the list for the property openstack.protocol, make sure the certificate for the OpenStack server is a public certificate. If it is not a public certificate, the task terminates abnormally, because the authenticity of the certificate cannot be verified.
Execution privilege
(1) Any user who logs in to the OpenStack server must have the following permission:
admin
Version
02.00.00
Plug-in tags
Add VM,OpenStack
Plug-in name displayed in the task log
openstackCreateVM
Return code
0: Normal
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
openstack.identityServerHostName |
Identity server host name |
Specifies the Identity server host name or IP address. Does not support IPv6 addresses. |
-- |
Input |
R |
|
openstack.userName |
Identity server login username |
Specifies the username to log into the Identity server. |
-- |
Input |
R |
|
openstack.password |
Identity server login password |
Specifies the password to log into the Identity server. |
-- |
Input |
R |
|
openstack.protocol |
Identity server connection protocol |
Specifies the protocol used to connect to the Identity server. |
-- |
Input |
R |
|
openstack.portNumber |
Identity server connection port number |
Specifies the port number to connect to the Identity server. |
-- |
Input |
R |
|
openstack.projectName |
Project name |
Specifies the project name that runs an instance. |
-- |
Input |
R |
|
openstack.instanceName |
Instance name |
Specifies the instance display-name for OpenStack (not the host name on the OS). |
-- |
Input |
R |
|
openstack.imageName |
Image name |
Specifies the image name. |
-- |
Input |
R |
|
openstack.instanceTypeName |
Instance type name |
Specifies the instance type name. |
-- |
Input |
R |
|
openstack.keyPairName |
Key pair name |
Specifies the key pair name. |
-- |
Input |
O |
|
openstack.securityGroupName |
Security group name |
Specifies the security group name. |
-- |
Input |
O |
|
openstack.networkNameMng |
Network name (management) |
Specifies the management network name to be set for the instance. |
-- |
Input |
R |
|
openstack.networkNameBiz |
Network name (business) |
Specifies the business network name to be set for the instance. |
-- |
Input |
O |
|
openstack.floatingIpOption |
Floating IP address setting availability |
Specifies whether to assign a Floating IP address to an instance. Select "yes" to assign a Floating IP address. Select "no" to not assign a Floating IP address. |
-- |
Input |
R |
|
openstack.networkNameExt |
Network name (external connections) |
Specifies the external network name that acquires a Floating IP address. |
-- |
Input |
O |
|
openstack.floatingIpAddress |
Floating IP address |
Specifies the Floating IP address assigned to an instance. Does not support IPv6 addresses. |
-- |
Input |
O |
|
openstack.checkInstanceStateCount |
Number of checks on the instance status |
Specifies the number of times an instance will be checked to make sure that it is running. This number combined with the wait time for checking instances is the maximum wait time. |
-- |
Input |
R |
|
openstack.checkInstanceStateInterval |
Wait interval for checking instances |
Specifies the amount of time in seconds to wait between checks when checking to make sure that the instance is running. |
-- |
Input |
R |
|
openstack.checkOSStateWaittime |
Wait time for checking the OS |
Specifies the amount of time in seconds to wait between checks when checking to make sure that the OS is running. |
-- |
Input |
R |
|
openstack.ipAddressMng |
IP address (management) |
Stores the IP address assigned to the management network of an instance. |
-- |
Output |
O |
|
openstack.ipAddressBiz |
IP address (business) |
Stores the IP address assigned to the business network of an instance. |
-- |
Output |
O |
|
openstack.floatingIpAddressWork |
Floating IP address |
Stores the Floating IP address assigned to an instance. |
-- |
Output |
O |
|
openstack.instanceHostName |
Instance host name |
This is the work property that stores the instance host name. |
-- |
Output |
O |
|
common.flag2IPsSetup |
Whether two IP addresses are set to instance |
Property that indicates whether two IP addresses have been set to a instance (TRUE), or otherwise (FALSE). |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |