3.12.1 Delete a virtual server
Function
This service template deletes instances in a KVM environment that is controlled by OpenStack. In addition, if floating IP addresses are set for instances, the service template releases the assignment of floating IP addresses.
The OpenStack-related terms used in this document are the names displayed in the OpenStack Dashboard. The OpenStack-related terms are:
- Identity
Displayed as "identity" or "KeyStone"
- Project
Displayed as "project" or "tenant"
- Volume
Displayed as "volume" or "block storage"
This service template requires the following servers:
- OpenStack server
A server on which OpenStack is installed
- KVM server
A server on which Kernel-based Virtual Machine is installed
- OpenStack control server
A server that executes the REST API on the OpenStack server
- Instance
An instance that is managed by the OpenStack server or by KVM. A general virtual server.
An overview of the processing is as follows:
(1) This service template deletes instances.
The instance names specified by the user are used.
Points to note concerning property settings:
(1) When instances are deleted, this service template waits for the number of seconds that has been specified for the openstack.checkInstanceDeletionInterval property, and then repeats the operation to check the status of the instance the number of times that has been specified for the openstack.checkInstanceDeletionCount property. Adjust the value of each property, according to the environment in use.
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.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1) Prerequisite products for the OpenStack server
- OpenStack
(2) Virtualization environment that manages instances
- Kernel-based Virtual Machine
- VMware vCenter Server
- VMware vSphere ESXi
(3) OpenStack control server
- Microsoft .Net Framework 3.5 or later
[Prerequisite product OS running in the system executing the service template]
(1) Prerequisite OSs for instances
- Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
- Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(2) Prerequisite OSs for the OpenStack control server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter
- Windows Server 2012 R2 Standard/Datacenter
Note that environments where Server Core is installed are excluded.
[Usage conditions of prerequisite products in the system executing the service template]
(1) Conditions related to instances
- Each instance name must be unique in a single project.
Cautions
(1) If volumes are connected to instances, the connected volumes are not deleted.
(2) If volumes are connected to instances, when the instances are deleted, make sure that the connected volumes are unmounted. If the instances are deleted in a state in which the volumes have been mounted, the file system might become corrupted.
Execution privilege
admin privileges
Version
02.00.00
Tags
Delete 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 OpenStack information. |
Y |
|
Instance information |
Specify instance information. |
Y |
|
Runtime options |
Properties for a status check that is performed when instances are deleted. Change the properties as necessary. |
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 |
-- |
|
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 |
-- |
|
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 |
-- |
|
openstack.password |
Password for logging in to the Identity server |
Specify the password for logging in to the Identity server. |
Input |
Disabled |
R |
-- |
|
openstack.protocol |
Identity server connection protocol |
Specify the protocol that is used to connect to the Identity server. |
Input |
Disabled |
R |
-- |
|
openstack.portNumber |
Port number for connecting to the Identity server |
Specify the port number for logging in to the Identity server. |
Input |
Disabled |
R |
-- |
|
openstack.projectName |
Project name |
Specify a project name. |
Input |
Disabled |
R |
-- |
|
openstack.checkInstanceDeletionCount |
Confirmation count for deleting instances |
Specify the number of times to confirm that the instance has been deleted. The value of this parameter combined with the confirmation interval for deleting instances is used as the maximum wait time. |
Input |
Disabled |
R |
-- |
|
openstack.checkInstanceDeletionInterval |
Confirmation interval for deleting instances |
Specify the interval (in seconds) for confirming that the instance has been deleted. |
Input |
Disabled |
R |
-- |
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.instanceName |
Instance name |
Specify the instance name. Note that the name you specify here is the display name of the instance in OpenStack, and is different from a host name in the OS. |
Input |
Disabled |
R |
-- |
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 |
-- |
|
openstack.identityServerHostName |
-- |
|
openstack.userName |
-- |
|
openstack.password |
-- |
|
openstack.protocol |
Select one of the following values: http,https |
|
openstack.portNumber |
-- |
|
openstack.projectName |
-- |
|
openstack.checkInstanceDeletionCount |
-- |
|
openstack.checkInstanceDeletionInterval |
-- |
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.instanceName |
-- |
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 |
openstackDeleteVM |
Delete a virtual server |
Deletes instances. |
Check the task log, remove the cause of the error, and then run this service again if instances remain. |