5.8.6 Create Temporary Volume
Function
Creates temporary volumes from volumes managed by OpenStack.
The terms related to OpenStack that are used in this document are names displayed in the OpenStack Dashboard. These terms are explained below.
- 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 a Kernel-based Virtual Machine is installed
- OpenStack control server
A server that executes REST-API functions on the OpenStack server
- Instance
An instance of a general virtual server managed by the OpenStack server and KVM
(1) Temporary volumes are created for volumes managed by Cinder that meet at least one of the conditions below. Temporary volumes cannot be created for instances or for server images.
a. The volume is allocated to the instance specified by the property openstack.instanceName.
b. The volume is specified by the property openstack.volumeNames.
(2) The created temporary volumes are of the same volume type as the backup-source volumes.
Use situation
After a volume is created, this plug-in can be used to create a temporary volume during volume backup for system maintenance.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products on the execution-target server, and the OSs for the prerequisite products on the execution-target server, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution-target server:
(1) Prerequisite product 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
(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)
OSs for the prerequisite products on the execution-target server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter
- Windows Server 2012 R2 Standard/Datacenter
Environments where Server Core is installed are excluded.
Conditions for using the prerequisite products in the execution-target system:
(1) Condition related to instances
- Each instance name must be unique within a single project.
(2) Condition related to volumes
- Each volume name must be unique within a single project.
Cautions
(1) Make sure that you specify either the instance name or the volume name. If you do not specify either of these, this plug-in fails.
(2) This plug-in can be executed for an instance that is currently running. In such a case, if an I/O operation is performed on the guest OS, inconsistencies between the guest OS and the backup might occur. For this reason, make sure to stop all I/O operations on the guest OS, or stop the guest OS itself, before executing this plug-in.
(3) A maximum of 27 volumes can be created concurrently. If you specify 28 or more volumes, this plug-in fails.
(4) The folder where temporary volumes are to be created must have enough free space for the volumes to be backed up. If the folder does not have enough free space, this plug-in fails.
(5) Depending on the volume statuses and types, this plug-in might not be able to create temporary volumes and might fail. Before starting this plug-in, check the volume statuses and types, and read the documentation for the Cinder driver you are using to see whether such a problem might occur.
Execution privilege
(1) Users who log in to the OpenStack server must have the following permission:
admin
Version
02.00.00
Plug-in tags
Add New Storage,OpenStack
Plug-in name displayed in the task log
openstackCreateTempVolume
Return code
0: Normal
12: Error (Mistake by user) Invalid property
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 |
Specify the name of the project. |
-- |
Input |
R |
|
openstack.instanceName |
Instance name |
Specifies the instance display-name for OpenStack (not the host name on the OS). |
-- |
Input |
O |
|
openstack.volumeNames |
Volume Name |
Specify the name of the volume. Separate entries with a comma when specifying multiple volumes. |
-- |
Input |
O |
|
openstack.tempVolumeName |
Temporary Volume Name |
Specify the name of the temporary volume used when obtaining a backup. |
-- |
Input |
R |
|
openstack.checkVolumeCreationCount |
Number of Times to Check Creation of Temporary Volumes |
Specify the number of times to check to see if a temporary volume was created. This, combined with the interval to check the creation of temporary volumes will be the maximum waiting time. |
-- |
Input |
R |
|
openstack.checkVolumeCreationInterval |
Interval to Check Creation of Temporary Volumes |
Specify the number of seconds to be used as the interval for checks to see if a temporary volume was created. |
-- |
Input |
R |
|
openstack.volumeIdWork |
Temporary Volume ID |
The work property where the ID of the temporary volume is stored. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |