3.13.4 Obtain a virtual server information list
Function
This service template acquires an instance information list in the specified project in a KVM environment that is controlled by OpenStack.
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"
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 acquires an instance information list.
1. This service template outputs the instance information list to a specified remote file in CSV format. The output file is encoded by using the default encoding format of the OpenStack control server.
(2) This service template transfers a remote temporary file to a specified local output file.
(3) This service template deletes the remote temporary file.
Items contained in the CSV file to be output are listed below:
This service template outputs items by separating them with commas.
(a) Hypervisor host name (header name: HostName)
(b) Instance name (header name: InstanceName)
(c) Image name (header name: ImageName)
(d) Instance status (header name: Status)
(e) The number of instance CPUs (header name: NumCpu)#
(f) Instance memory capacity (MB) (header name: MemoryMB)#
(g) Instance disk size (GB) (header name: TotalDiskOfFlavorGB)#
(h) Flavor name (header name: FlavorName)
#: The numbers of instance CPUs, instance memory capacity (MB), and instance disk size (GB) are flavor information that was specified when the instance was started.
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 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 Framework3.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]
None.
Cautions
(1) If the file names to be specified already exist, the existing files are overwritten. The files on the remote side are deleted. Therefore, make sure that the specified file names are correct.
(2) If the folder in a remotely specified path does not exist, the folder is created in the path. The created folder is not deleted. If you do not use such folders, delete them periodically.
(3) If 2 or more instances have the same name, instances cannot be identified in a CSV file to be output.
Execution privilege
admin privileges
Version
02.00.00
Tags
Gather VM information,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 |
|
Output file storage information |
Specify a folder to store output files. |
Y |
|
Instance information |
Specify instance information. |
Y |
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 |
-- |
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.listOutputFileNameRemote |
Output file name (remote) |
Specify the name of the temporary file that is used when instance information is output to an OpenStack control server by using a full path. |
Input |
Disabled |
R |
-- |
|
openstack.listOutputFileNameLocal |
Output file name (local) |
Using a full path, specify the name of the local server file from which instance information is acquired. |
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 |
-- |
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.listOutputFileNameRemote |
-- |
|
openstack.listOutputFileNameLocal |
-- |
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 |
openstackOutputVmSpec |
Obtain a virtual server information list |
A virtual server information list is output to a temporary file of the OpenStack control server. |
After removing the cause of the error, run the service again. |
|
2 |
FileTransferPlugin |
File-Forwarding Plug-in |
Transfers remote temporary files to local specified output files. |
After removing the cause of the error, run the service again. |
|
3 |
osDeleteFile |
Delete file |
Deletes remote temporary files. |
After removing the cause of the error, run the service again. |