5.8.12 Obtain Status of Virtual Server
Function
Obtain the status of an instance in a KVM environment 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"
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
Use situation
This plug-in can be used to obtain the status of an instance in an OpenStack environment.
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.
Condition 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.
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
openstackGetVMState
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 |
R |
|
openstack.instanceState |
Instance Status |
The work property where the status of the instance is stored. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |