5.8.11 Get list of virtual server information
Function
This plug-in outputs an instance information list contained in the project that is controlled by OpenStack to a file in CSV format.
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 (execution target 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.
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.
Use situation
You can use this plug-in to acquire instance information in an OpenStack environment.
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.
[Required product in the system]
JP1/Automatic Operation 11-00 or later
[Prerequisite products for the execution-target server]
(1) Products required 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 (execution target server)
- Microsoft .Net Framework 3.5 or later
(4) OSs required 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)
[Supported OSs for the prerequisite products for the execution-target server]
(1) OpenStack control server (execution target 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.
[Conditions for using the execution-target system]
None.
Cautions
(1) If the file names to be specified already exist, the existing files are overwritten. Therefore, make sure that the specified file names are correct.
(2) If the specified folder does not exist, create the folder.
(3) If 2 or more instances have the same name, instances cannot be identified in the CSV to be output.
Execution privilege
(1) Users who log in to the OpenStack server must have the following permission:
admin
Version
02.00.00
Plug-in tags
Gather VM information,OpenStack
Plug-in name displayed in the task log
openstackOutputVmSpec
Return code
0: Normal
12: Error (mistake by the user): A property is invalid.
23: Error (invalid environment): The environment requirements are not met.
27: Error (Check the details on the error in the task log.)
41: Error (An error was detected in the component.): A property was not entered. (An error was 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.vmInfoListOutputFileName |
Virtual Server Information Output File |
Specify the full path of the file to which the list of virtual server information is to be output. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |