monitoring agent for openstack reference -...

Monitoring Agent for OpenStackVersion 1.0.0.0

User's Guide

��

NoteBefore using this information and the product it supports, read the information in “Notices” on page 59.

This edition applies to version 1.0.0.0 of the Monitoring Agent for OpenStack and to all subsequent releases andmodifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2015.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Tables . . . . . . . . . . . . . . . v

Chapter 1. Monitoring Agent forOpenStack . . . . . . . . . . . . . 1

Chapter 2. Prerequisites . . . . . . . . 3

Chapter 3. Installing the OpenStackagent . . . . . . . . . . . . . . . . 5Installing an agent . . . . . . . . . . . . 5

Installing the agent by responding to prompts . . 5Performing a silent installation . . . . . . . 6

Enabling the self-describing capability toautomatically install application support . . . . . 9Manually installing application support . . . . . 10

Installing Tivoli Enterprise Monitoring Serversupport. . . . . . . . . . . . . . . 10Installing Tivoli Enterprise Portal Server support 11Installing Tivoli Enterprise Portal desktop clientsupport . . . . . . . . . . . . . . . 11

Chapter 4. Configuring the agent . . . 13Configuring the agent . . . . . . . . . . . 13

Configuring the agent by responding theprompts . . . . . . . . . . . . . . 13Configuring the agent with a response file . . . 14

Configuring agent data collector and SSHconnections . . . . . . . . . . . . . . 15

Chapter 5. Uninstalling the agent . . . 17Uninstalling the OpenStack agent . . . . . . . 17Uninstalling the support files . . . . . . . . 17Clearing the agent information from TivoliEnterprise Portal. . . . . . . . . . . . . 18

Chapter 6. Troubleshooting . . . . . . 19Changing the agent trace level . . . . . . . . 19Cannot connect to remote OpenStack componentsthrough domain name . . . . . . . . . . . 19Installation fails . . . . . . . . . . . . . 20Agent instance node displays incorrectly on TivoliEnterprise Portal. . . . . . . . . . . . . 20A delay occurs between OpenStack environmentand the monitoring data in Tivoli Enterprise Portal . 20Agent installation fails with error code 99 and errorcode 4 . . . . . . . . . . . . . . . . 21Agent name strings are not correctly displayed . . 21Installation fails on Redhat 7 if the agent is installedin the same directory as the OS agent . . . . . 21Remote installation or configuration fails due tolong managed system name . . . . . . . . . 22

Chapter 7. Reference . . . . . . . . 23Workspaces . . . . . . . . . . . . . . 23

Predefined workspaces . . . . . . . . . 23Workspace descriptions . . . . . . . . . 24

Attributes . . . . . . . . . . . . . . . 28Attribute groups or data sets for the monitoringagent . . . . . . . . . . . . . . . 29Attributes in each attribute group or data set . . 30

Situations . . . . . . . . . . . . . . . 55Predefined situations . . . . . . . . . . 56Descriptions and formulas . . . . . . . . 56

Notices . . . . . . . . . . . . . . 59Trademarks . . . . . . . . . . . . . . 61Privacy policy considerations . . . . . . . . 61

Index . . . . . . . . . . . . . . . 63

© Copyright IBM Corp. 2015 iii

iv Monitoring Agent for OpenStack Reference

Tables

1. Silent installation parameters . . . . . . . 7

© Copyright IBM Corp. 2015 v

vi Monitoring Agent for OpenStack Reference

Chapter 1. Monitoring Agent for OpenStack

The Monitoring Agent for OpenStack offers a central point of management for your OpenStackenvironment or application.

By using the OpenStack agent you can collect and analyze complex OpenStack environment in an easyway. The agent alerts you when an event is triggered and help you to determine which part of thesystem has an error.

The OpenStack agent monitors related resource in the following layers:v OpenStack infrastructure and services run time, for example, processes status and API health status.v Cloud resources that are controlled by OpenStack, including running cloud instance amount, total

instance amount, total CPU or core number, total memory size (GB), total disk (number), total images,and resources used percentage.

v Lifecycle of workload (Virtual Server) instances that are administered by OpenStack, for example,workload instance status and workload instance metrics available (including CPU, Memory, andNetwork usage).

© Copyright IBM Corp. 2015 1

2 Monitoring Agent for OpenStack Reference

Chapter 2. Prerequisites

The Monitoring Agent for OpenStack uses the OpenStack Python API (OpenStack component client) tocollect monitored resource metrics remotely. The agent requires the credentials to access the remote serverthrough ssh. The agent also requires the administrator authorization to access the OpenStack componentsthrough keystone.

Software prerequisites

You must have the following software on the environment before you can use the OpenStack agent:v IBM Tivoli Monitoring 6.2.3 FP5, or IBM Tivoli Monitoring 6.3.0 or later.v Python 2.6.0 or later, or Python 2.7.0 or later.v OpenStack clients:

– Keystone– Nova– Neutron– Cinder– Swift

v Supported OpenStack client versions:– Juno

To install the OpenStack Juno release command-line clients, refer to Install the OpenStackcommand-line clients (http://docs.openstack.org/user-guide/content/install_clients.html).

– IceHouseTo install the OpenStack IceHouse release command-line clients, refer to OpenStack API Quick Start(http://docs.openstack.org/api/quick-start/content/index.html#cli_clients_install).

v Paramiko library for remote access in Python.v KornShell.


http://docs.openstack.org/user-guide/content/install_clients.html

http://docs.openstack.org/user-guide/content/install_clients.html

http://docs.openstack.org/api/quick-start/content/index.html#cli_clients_install

Chapter 3. Installing the OpenStack agent

Installation involves installing an agent and installing agent application support on IBM TivoliMonitoring components.

Procedure

Complete the following steps to install the OpenStack agent:1. Decide whether you want to use the self-describing capability. For detailed information about the

self-describing capability, see “Enabling the self-describing capability to automatically installapplication support” on page 9.

2. Install the OpenStack agent. For instructions, see “Installing an agent.”3. (Self-describing capability is disabled) Install the application support on Tivoli Enterprise Monitoring

Server, Tivoli Enterprise Portal Server, and Tivoli Enterprise Portal desktop client. For instructions, see“Manually installing application support” on page 10.

4. (Self-describing capability is enabled) If you are using the Tivoli Enterprise Portal desktop client,install the application support on the portal desktop client. For instructions, see “Installing TivoliEnterprise Portal desktop client support” on page 11.

Installing an agentYou must install the OpenStack agent before you can monitor your OpenStack environment. The agentcan be installed through a refresh installation only.

Before you begin

Make sure that the software listed in Chapter 2, “Prerequisites,” on page 3 is installed.

If you want to enable self-describing agent capability, see “Enabling the self-describing capability toautomatically install application support” on page 9

About this task

To avoid high CPU and memory load on the server, you can install the OpenStack agent on a stand-aloneserver and remotely monitor the OpenStack environment.

Procedure

You have two options to install the OpenStack agent on a Linux system:v To install the agent by running the script and responding to prompts, see “Installing the agent by

responding to prompts.”v To install the agent by editing the silent response file and running the script with no interaction, see

“Performing a silent installation” on page 6.

Installing the agent by responding to promptsProcedure1. Download and extract the agent installation image to the system where you want to install the

OpenStack agent.2. In the directory where you extracted the agent installation image, run the following command:

./install.sh


3. When prompted for the IBM Tivoli Monitoring home directory, press Enter to accept the defaultdirectory /opt/IBM/ITM or type a different directory where you want to install the agent.

4. If the installation directory does not exist, you are asked if you want to create it. Type y to create thisdirectory and press Enter.

5. If any existing IBM Tivoli Monitoring components are currently running on the computer, theinstaller stops the components during the installation process, then restarts the components when theinstallation is complete. To confirm this action, type 1 when prompted and press Enter. If you choosenot to stop the components, the installation process ends.

6. When prompted to install products to the local host, type 1 and press Enter.7. When the software license agreement is displayed, type 1 to accept the agreement and press Enter.8. If IBM GSKit is not installed on the computer, you are prompted to provide an encryption key. Use

the same key across the enterprise. Either type the key or accept the default and press Enter.9. When a numbered list of available operating systems is displayed, type 1 to install the IBM Tivoli

Monitoring components for this operating system and press Enter.10. When a numbered list of available components is displayed, type the number corresponding to

Monitoring Agent for OpenStack and press Enter.11. Type 1 to confirm your selection.12. At the prompt Do you want to install additional products or product support packages, type 2

and press Enter.13. If your IBM Tivoli Monitoring environment is not secured, you are asked if you want to secure it. If

your IBM Tivoli Monitoring environment is already secured, this question is skipped. The productinstallation process creates most of directories and files with write permissions. You can secure yourinstallation or choose the default value.

Results

The OpenStack agent is installed.

What to do next

If you enabled self-describing feature for the OpenStack agent, the agent will automatically push theapplication support files to Tivoli Enterprise Monitoring Server and Tivoli Enterprise Portal Server. Youonly need to manually install the application support files on Tivoli Enterprise Portal desktop client ifyou are using the desktop client. For instructions on how to install application support on the portaldesktop client, see “Installing Tivoli Enterprise Portal desktop client support” on page 11.

If you do not use the self-describing feature, you must manually the application support on IBM TivoliMonitoring components. For detailed information, see “Manually installing application support” on page10.

Performing a silent installationAbout this task

Silent installation uses a response file to define the installation parameters for the OpenStack agent. Youcan edit the parameters in this response file to control the installation options. A sample response file isshipped with the agent installation image. The file name is silent_install.txt.

Procedure1. Download and extract the installation image to the system where you want to install the agent.2. In the root directory of the extracted installation image, locate the silent_install.txt file.3. Edit the silent_install.txt file to set the parameters described in Table 1 on page 7 to appropriate

values for your environment and save the changes.


Table 1. Silent installation parameters

Parameter Definition

INSTALL_ENCRYPTION_KEY REQUIRED. The data encryption key that is used toencrypt data that is sent between systems. This key mustbe the same for all components in your IBM TivoliMonitoring environment.

Do not use the following characters in the key:& ampersand| pipe' single quote= equal sign$ dollar signIn addition, do not specify double-byte (DBCS)characters.

INSTALL_FOR_PLATFORM The operating system for which to install thecomponents. You can specify an architecture code. If youdo not specify an architecture code, the operating systemfor the current computer is used. You can find a list ofthe architecture codes for the supported architectures inarchdsc.tbl in the registry directory.

INSTALL_PRODUCT The product code for the components (or "products") thatyou want to install.

Note: The product code for the OpenStack agent is sg.

You can use the ./cinfo command to view the productcodes for the applications that are installed on thiscomputer. You can also find a list of the product codes inthe registry directory in proddsc.tbl.

You can specify "all" to install all available components.

To install multiple components (but not all), repeat thisparameter for each component that you want to install.For example:

INSTALL_PRODUCT=sgINSTALL_PRODUCT=cjINSTALL_PRODUCT=cq

This example installs the monitoring server, portal server,and portal desktop client on a Linux computer.

In the same pass, you can install support with thecomponents. After you specify the components that youwant to install, specify the support that you want toinstall by using the following parameters:

INSTALL_PRODUCT_TMS (for TEMS support)INSTALL_PRODUCT_TPS (for TEPS support)INSTALL_PRODUCT_TPW (for TEP Browser Client support)INSTALL_PRODUCT_TPD (for TEP Desktop Client support)INSTALL_PRODUCT_TPA (for ITPA Domain support)

MS_CMS_NAME If you are installing a monitoring server, use thisparameter to specify the name for the monitoring server,such as HUB hostname. Do not specify an IP address orfully qualified host name.

Chapter 3. Installing the OpenStack agent 7

Table 1. Silent installation parameters (continued)

Parameter Definition

SKIP_SDA_CHECK You can use this parameter to overwrite product supportthat was seeded in self-describing mode. By default, thisparameter is set to NO and a self-describing modeseeding status check is performed. If this parameter is setto YES, the seeding process at the end of the installationdoes not check the self-describing mode seeding status.

PREREQ_CHECK Set this parameter to PREREQ_CHECK=YES to identifyany missing system prerequisites before you begin aninstallation or upgrade to a new version of IBM®Tivoli®

Monitoring.

4. Run the following command to install OpenStack agent:./install.sh -q -h install_dir -p response_file

Where :

install_dirSpecifies the installation location for the OpenStack agent. The default installation location is/opt/IBM/ITM.

Do not use the number sign (#) or exclamation mark (!) characters anywhere in the specifiedinstallation path.

Important: You must not specify the path of the directory that contains the ./install.shscript as your installation directory. On certain operating systems, this can cause the plug-inJAR files to overwrite themselves and become zero length files. The installation will fail as aresult.

response_fileSpecifies the full path of the silent_install.txt response file that you use to specify theinstallation parameters.

The following parameters are available for the ./install.sh script:

[-k] Optional.

Secures your IBM Tivoli Monitoring installation. If you do not secure the installation at thispoint you will be asked at the end of this procedure if you want to do so.

[-c] Optional.

Prints diagnostic messages to the console

[-d] Optional.

Indicates the location of the product installation image.

[-h] Optional.

Indicates the installation directory of IBM Tivoli Monitoring components.

[-j] Optional.

Indicate the JRE installed location. This parameter is available on Tandem system only.

[-p] Optional.

Specifies the silent installation response file with installation parameters specified.


Results

The OpenStack agent is installed.

What to do next

If you enabled self-describing feature for the OpenStack agent, the agent will automatically push theapplication support files to Tivoli Enterprise Monitoring Server and Tivoli Enterprise Portal Server. Youonly need to manually install the application support files on Tivoli Enterprise Portal desktop client ifyou are using the desktop client. For instructions on how to install application support on the portaldesktop client, see “Installing Tivoli Enterprise Portal desktop client support” on page 11.

If you do not use the self-describing feature, you must manually the application support on IBM TivoliMonitoring components. For detailed information, see “Manually installing application support” on page10.

Enabling the self-describing capability to automatically installapplication supportThe OpenStack agent supports the self-describing capability, which can automatically install agentapplication support on IBM Tivoli Monitoring servers. Before you install a self-describing agent, decidewhether you want to enable the self-describing capability.

About this task

By default, the self-describing environment variable is set to Y to enable the self-describing capability onthe following IBM Tivoli Monitoring components:v Any remote Tivoli Enterprise Monitoring Server the agent is connected to (KMS_SDA)v Tivoli Enterprise Portal Server (TEPS_SDA)v Monitoring agent that supports the self-describing capability (TEMA_SDA)

You can disable the self-describing capability by changing the self-describing environment to N for eachcomponent.

A best practice is to accept the default settings and use the self-describing environment variable only atthe hub monitoring server to control the self-describing agent enablement.

Procedure

To enable and use the self-describing capability to automatically install agent application support,complete the following steps:1. Configure the hub monitoring server to set the KMS_SDA variable to Y.2. (IBM Tivoli Monitoring V6.3 or later) Run the following command to permit self-describing agent

installations without any blocking:tacmd editsdainstalloptions -t DEFAULT -i ON

Tip: The command above permits the application support installation for all self-describing agents. Topermit self-describing agent installation only for the OpenStack agent, use the following command:tacmd addsdainstalloptions –t sg –v 01000000

For more information about the self-describing capability, see Dynamically controlling the hub monitoringserver self-describing agent capability section in the IBM Tivoli Monitoring: Installation and Setup Guide.


Manually installing application supportYou must install application support before you can view data collected by the OpenStack agent.

Procedure

Follow the steps in the following topics to install application support manually:v Installing Tivoli Enterprise Monitoring Server support.v Installing Tivoli Enterprise Portal Server support.v Installing Tivoli Enterprise Portal Desktop Client support.

Installing Tivoli Enterprise Monitoring Server supportInstall the application support for the OpenStack agent to work properly with Tivoli EnterpriseMonitoring Server.

Procedure

Complete the following steps to install Tivoli Enterprise Monitoring Server support:1. In the directory where you extracted the installation files, run the following command:

./install.sh

2. When prompted for the IBM Tivoli Monitoring home directory, press Enter to accept the defaultdirectory /opt/IBM/ITM or type the full path of the monitoring server installation directory.

3. If a message is displayed stating that the directory already exists and asking whether to use it, type1 and press Enter.

4. If any existing IBM Tivoli Monitoring components are currently running on the computer, theinstallation program stops the components during the installation process, then restarts thecomponents when the installation is complete. To confirm this action, type 1 when prompted andpress Enter. If you choose not to stop the components, the installation process ends.


the same key across the enterprise. Either type the key or accept the default and press Enter.8. When a numbered list of available components is displayed, type the number for Tivoli Enterprise

Monitoring Server support and press Enter.9. Type 1 to confirm your selection and press Enter.

10. When a list of products for which the support files are to be added is displayed, type the numbercorresponding to Monitoring Agent for OpenStack and press Enter.

11. Type 1 to confirm your selection and press Enter.12. At the prompt Do you want to install additional products or product support packages, type 2

and press Enter.13. At the prompt Do you want to seed product support on the Tivoli Enterprise Monitoring

Server, type 1 and press Enter.14. When prompted to select support packages to be seeded, type 1 and press Enter.15. If your IBM Tivoli Monitoring environment is not secured, you are asked if you want to secure it. If

your IBM Tivoli Monitoring environment is already secured, this question is skipped. The productinstallation process creates most of directories and files with write permissions. You can secure yourinstallation or choose the default value.

Results

Tivoli Enterprise Monitoring Server support is installed.


Installing Tivoli Enterprise Portal Server supportInstall the application support for the OpenStack agent to work properly with Tivoli Enterprise PortalServer.

Procedure

Complete the following steps to install Tivoli Enterprise Portal Server support:1. In the directory where you extracted the installation files, run the following command:

./install.sh

2. When prompted for the IBM Tivoli Monitoring home directory, press Enter to accept the defaultdirectory /opt/IBM/ITM or type the full path of the portal server installation directory.





Portal Server support and press Enter.9. Type 1 to confirm your selection and press Enter.


11. Type 1 to confirm your selection and press Enter.12. If the system is running Tivoli Enterprise Portal Server and you want to install Tivoli Enterprise

Portal Browser Client support, at the prompt Do you want to install additional products orproduct support packages, type 1 and press Enter.

13. At the list of component support categories, type the number for Tivoli Enterprise Portal BrowserClient support and press Enter.

14. Repeat from step 7 through step 11, selecting Tivoli Enterprise Portal Browser Client Support.15. At the prompt Do you want to install additional products or product support packages, type 2

and press Enter.

Results

Tivoli Enterprise Portal Server support is installed.

Installing Tivoli Enterprise Portal desktop client supportInstall the application support for the OpenStack agent to work properly with Tivoli Enterprise Portaldesktop client.

Procedure

Complete the following steps to install Tivoli Enterprise Portal desktop client support:1. In the directory where you extracted the installation files, run the following command:

./install.sh


2. When prompted for the IBM Tivoli Monitoring home directory, press Enter to accept the defaultdirectory /opt/IBM/ITM or type the full path of the portal desktop client installation directory.





Portal desktop client support and press Enter.9. Type 1 to confirm your selection and press Enter.


11. Type 1 to confirm your selection and press Enter.12. At the prompt Do you want to install additional products or product support packages, type 2

and press Enter.

Results

Tivoli Enterprise Portal desktop client support is installed.


Chapter 4. Configuring the agent

You must configure the OpenStack agent before the agent can automatically monitor the OpenStackenvironment.

Procedure1. You can either configure the agent by responding to prompts or by using a response file. For

instructions, see “Configuring the agent.”2. If you want to collect process-related information, configure the data collector for the OpenStack

agent. For instructions, see Configuring agent data collector and SSH connections.

Configuring the agentFor a typical environment, if you want the OpenStack agent to automatically monitor the OpenStackenvironment, you must configure the agent first.

Procedure

You have two options to configure the OpenStack agent on a Linux system:v To configure the agent by running the script and responding to prompts, see “Configuring the agent by

responding the prompts.”v To configure the agent by editing the silent response file and running the script with no interaction, see

“Configuring the agent with a response file” on page 14.

Configuring the agent by responding the promptsProcedure1. To configure the agent, run the following command:

install_dir/bin/itmcmd agent config -A sg

Where install_dir is the IBM Tivoli Monitoring installation directory. The default IBM TivoliMonitoring installation directory is /opt/IBM/ITM.

2. When prompted to Enter instance name, input an instance name and enter 1 to continue.

Important: The OpenStack agent is a multiple instance agent and requires an instance name for eachagent instance. The instance name that you specify is included in the managed system nameinstance_name:host_name:sg. The length of the instance name you specify is limited to 28 charactersminus the length of your host name. For example, if you specify OS1 as your instance name, yourmanaged system name is OS1:hostname:SG.

3. When prompted to Edit Monitoring Agent for OpenStack, enter 1 to continue.4. When prompted to Edit OpenStack environment authentication information, enter 1 to continue

and provide the following information:OpenStack authentication url (default is: http://localhost:5000/v2.0):OpenStack username (default is: admin):Enter OpenStack password (default is: ):Re-type: OpenStack password (default is: ):OpenStack tenant name (default is: admin):

5. When prompted to Edit Python, enter 1 to continue.6. When prompted for Python Executable Location, specify the Python executable location, for

example, /usr/bin/python. You can find the fully qualified path by running the following commandin your environment:


which python

7. When prompted to Edit Socket settings, enter 1 to continue.8. When prompted for Port Number, accept the default value or specify a port number. The port

number is the port that the agent uses to listen on for data from socket clients. A value of 0 indicatesthat an ephemeral port is used. This port does NOT correspond to any port that is used by yourapplication. This port is for internal use by the agent.

9. Press Enter when you are asked if the agent connects to a Tivoli Enterprise Monitoring Server.10. Type the protocol that you want to use to communicate with the Tivoli Enterprise Monitoring Server.11. If you want to set up a backup protocol, enter that protocol and press Enter.12. When prompted for TEMS Host Name for IPv4, type the name of the host system on which the Tivoli

Enterprise Monitoring Server that you want the agent to connect to is installed and press Enter.13. Depending on the type of protocol you specified, provide the port number and press Enter.14. When you are asked to Configure connection for a secondary TEMS, provide the secondary TEMS

information if you have a secondary TEMS.15. After you finish configuring the agent, you can start the agent instance by running the command:

install_dir/bin/itmcmd agent -o instance_name start sg

where instance_name is the name of the agent instance you configure.

Results

The agent is configured successfully.

What to do next

If you want to collect process-related information, configure the data collector for the OpenStack agent bycompleting the steps in Configuring agent data collector and SSH connections.

If you want to change the trace level of the agent for troubleshooting purpose, edit the value of thevariable KBB_RAS1 in the install_dir/config/sg.ini file according to the instruction in the file.

For more information about the agent environment variables, see the Environment variables topics inAppendix E. Agent configuration and environment variables of the IBM Tivoli Monitoring: Installation and SetupGuide.

Configuring the agent with a response fileProcedure1. Go to the install_dir/sample directory and edit the sg_silent_config.txt configuration file for the

OpenStack agent.2. Specify values for the parameters that are identified in the file. The response file contains comments

that define the available parameters and the values to specify.3. Save the file and exit.4. Run the following command to configure the agent:

./itmcmd config -A -p response_file sg

where response_file is the name of the configuration response file. Specify an absolute path to this file.

Results

The agent is configured.


What to do next

If you want to collect process-related information, configure the data collector for the OpenStack agent bycompleting the steps in Configuring agent data collector and SSH connections.

If you want to change the trace level of the agent for troubleshooting purpose, edit the value of thevariable KBB_RAS1 in the install_dir/config/sg.ini file according to the instruction in the file.


Configuring agent data collector and SSH connectionsIf you want to collect process-related information, configure the agent data collector for the OpenStackagent and set up SSH connections with the target OpenStack component server.

About this task

You must set up SSH connection to collect process information before you start the OpenStack agent. Todo this, you can use the product provided ksg_setup_key.sh or ksg_ssh_setup.py assistance tool asindicated in the following procedure.

If you are familiar with setting up SSH connections, you can also use the ssh-keygen and ssh-copy-idLinux commands to do it.

Procedure1. Go to the install_dir/config directory, where install_dir is the IBM Tivoli Monitoring installation

directory.2. Edit the ksg_dc_instance_name.cfg file, where instance_name is the name you specified for this agent

instance. The file is created after the agent instance starts. If the file does not exist, copyinstall_dir/$ITM_BINARCH/sg/bin/ksg_dc.cfg to the directory install_dir/config and change thefile name to ksg_dc_instance_name.cfg. For example, if the instance name is OS1, change the name toksg_dc_OS1.cfg.

3. In the ksg_dc_instance_name.cfg file, set the value of the parameter collect_process_information toYES.

4. In the section OS_process_collection, specify value for the parameter ssh_user_ip with the users andIP addresses of the OpenStack component servers according to the format of the following example:[email protected],[email protected]

5. Save the settings.6. For the settings to take effect, restart the agent instance by running the following commands:

install_dir/bin/itmcmd agent -o instance_name stop sginstall_dir/bin/itmcmd agent -o instance_name start sg

7. Set up the SSH connections with the target component server by using one of the following ways:v Set up the connections one by one by using the ksg_setup_key.sh script . To do that, go to

install_dir/$ITM_BINARCH/sg/bin directory and run the ksg_setup_key.sh script with parametersIP and user to build the SSH connections with component servers that are specified in Step 4. Ifyou follow the example that is given in Step 4, you must run the script twice to set up theconnection one by one:./ksg_setup_key.sh 9.112.250.248 root./ksg_setup_key.sh 9.112.250.249 user1

Note: You must provide the passwords when you run the scripts for the first time. You don't needto provide the passwords again.

Chapter 4. Configuring the agent 15

v Set up the connections one by one or in a batch job by using the ksg_ssh_setup.py tool that isprovided by OpenStack agent in install_dir/$ITM_BINARCH/sg/bin. You must install Pythonpexpect library before you can use this tool.– To set up SSH connections one by one, run the command:

python ksg_ssh_setup.py -single

This command helps you to set up the SSH connection to the remote target server. You mustprovide the following information.Enter the remote target machine IP address: (Type ’END’ to end input.)Enter the account to access the remote machine(e.g. root):Enter the above user’s password:

– To set up SSH connections in a batch job, run the command:python ksg_ssh_setup.py -ssh SSH_file

where SSH_file is the file that contains the target server, user, and password information. Youmust create the file according to the ksg_dc_ssh_list.txt file in the same directory as thePython tool, and specify the host and user information in the file according to the format of theexamples:shorthostname1 9.112.250.248 root passw0rdshorthostname2 9.112.250.249 user1 passw0rd

Note: No need to set up the connections again after you restart the agent or change the agentconfiguration. You must set up the connections again only when the user name or password for thetarget server change.

Results

The data collector is configured and the SSH connections are set up properly.


Chapter 5. Uninstalling the agent

To uninstall the OpenStack agent from your system, you must uninstall the agent and support files, andthen clear the agent related information from the Tivoli Enterprise Portal.

Procedure1. Uninstall the OpenStack agent.2. Uninstall the support files.3. Clear the agent related information from the Tivoli Enterprise Portal.

Uninstalling the OpenStack agentYou must uninstall the agent from the systems before you uninstall the support files.

Procedure1. Go to the install_dir/bin directory, where install_dir is the IBM Tivoli Monitoring installation

directory.2. Run the command:

./uninstall.sh

The installed agents that are available for uninstall are listed.3. Type the number corresponding to the Monitoring Agent for OpenStack component that you want to

uninstall.4. Type 1 to confirm your selection and press Enter.5. After the uninstall completes, type 99 to exit the uninstaller.

Results

The agent is removed from the system.

Uninstalling the support filesAfter you uninstall the agent from the system, you can uninstall the support files.

Procedure1. Go to the install_dir/bin directory, where install_dir is the IBM Tivoli Monitoring installation

directory.2. Run the command:

./cinfo

3. Type 1 to list the installed product support.4. Run the following commands to uninstall the support files.v To remove Monitoring Agent for OpenStack support for Tivoli Enterprise Monitoring Server, run:

$install_dir/bin/uninstall.sh sg tms.v To remove Monitoring Agent for OpenStack support for Tivoli Enterprise Portal Server,

run:$install_dir/bin/uninstall.sh sg tps.v To remove Monitoring Agent for OpenStack support for Tivoli Enterprise Portal Browser Client,

run: $install_dir/bin/uninstall.sh sg tpw.


v To remove Monitoring Agent for OpenStack support for Tivoli Enterprise Portal Desktop Client,run: $install_dir/bin/uninstall.sh sg tpd

Results

The support files are uninstalled.

Clearing the agent information from Tivoli Enterprise PortalAfter you uninstall the OpenStack agent from the systems, clear the remaining agent information fromTivoli Enterprise Portal.

Procedure1. In the Tivoli Enterprise Portal, find Enterprise in the navigator.2. Right click Enterprise and select Workspace > Manage System Status.3. In the Managed System Status view, right click each of the offline entries and select Clear offline

entry.4. Click Refresh to update the information that is displayed in Tivoli Enterprise Portal

Results

The OpenStack agent information is removed from Tivoli Enterprise Portal.


Chapter 6. Troubleshooting

Use the information in this chapter to determine cause and solutions to the issues that you mightencounter when you are using the OpenStack agent.

Changing the agent trace levelTo collect more information for troubleshooting, you can change the trace level of the agent and the datacollector.

Changing the agent trace level

To change the trace level of the agent, edit the value of the variable KBB_RAS1 in the CANDLEHOME/config/sg.ini file according to the instruction in the file. Then restart the agent for the changes to take effect.


Changing the trace level of the data collector

To change the trace level of the data collector, complete the following steps:1. Edit the value of the trace_level parameter in the CANDLEHOME/config/ksg_dc_instance_name.cfg file.2. Save the settings.3. For the settings to take effect, restart the agent instance by running the following commands:

CANDLEHOME/bin/itmcmd agent -o instance_name stop sgCANDLEHOME/bin/itmcmd agent -o instance_name start sg

Cannot connect to remote OpenStack components through domainnameSymptom

The OpenStack agent is installed on a stand-alone server with OpenStack Python clients, andcannot connect to the remote OpenStack components through domain name.

Cause The server where the agent is installed does not belong to the OpenStack network area.

SolutionYou must edit /etc/hosts file and map the domain names with IP addresses. Here are someexamples:9.112.250.244 ico-ds ico-ds.demo.com9.112.250.245 ico-cs1 ico-cs1.demo.com9.112.250.246 ico-cs2 ico-cs2.demo.com9.112.250.247 ico-cs3 ico-cs3.demo.com9.112.250.248 ico-vmware-region ico-vmware-region.demo.com9.112.250.249 ico-vmware-neutron ico-vmware-neutron.demo.com9.112.250.250 ico-kvm-region ico-kvm-region.demo.com9.123.101.85 ico-kvm-compute ico-kvm-compute.demo.com9.123.101.81 ico-kvm-neutron ico-kvm-neutron.demo.com

Note: If you use an HTTP proxy server on the agent server, you must make sure that the proxyserver can access the remote OpenStack components through domain name.


Installation failsSymptom

The OpenStack agent installation failed with the following error:[root@rhel66 KSGinstaller]# ./install.sh-bash: ./install.sh: /bin/ksh: bad interpreter: No such file or directory[root@rhel66 KSGinstaller]# yum install ksh

Cause Ksh(KornShell) is not installed.

SolutionInstall ksh(KornShell) before you install the agent.

Agent instance node displays incorrectly on Tivoli Enterprise PortalSymptom

The OpenStack agent instance node displays incorrectly Tivoli Enterprise Portal when themanaged system name instancename:hostname:SG is too long.

Cause When the managed system name instancename:hostname:SG is longer than 32 characters, theinstancename:hostname part is truncated. After the truncation, if there are agent instances with thesame node name, and these agent instances are connected to the same hub Tivoli EnterpriseMonitoring Server, the agent instances do not work correctly.

SolutionShorten the host name portion of the name by completing the following steps:1. Open the configuration file for the monitoring agent, which is in the following path:

install_dir/config/sg_instance_name.config.2. Find the line that begins with CTIRA_HOSTNAME=.3. Specify a unique and shorter host name for the host computer. The final concatenated name

that includes the instance name, new host name, and SG, cannot exceed 32 characters.

Note: Make sure that the resulting name is unique regarding any existing monitoringcomponent that was previously registered with the Tivoli Enterprise Monitoring Server.

4. Save the file.5. Restart the agent.

A delay occurs between OpenStack environment and the monitoringdata in Tivoli Enterprise PortalSymptom

There is a delay between OpenStack environment and the monitoring data in Tivoli EnterprisePortal.

Cause The OpenStack agent data collector collects monitoring data every 300 seconds, and sends thedata to IBM Tivoli Monitoring every 300 seconds by default. A delay might occur between theOpenStack environment and the monitoring data in Tivoli Enterprise Portal. To reduce the delay,you can shorten the data collection and emitting intervals by changing the settings in the datacollector configuration file to see the updated data sooner.

SolutionComplete the following steps to shorten the intervals:1. Locate and edit the following agent instance data collector configuration file:

CANDLEHOME/$ITM_BINARCH/sg/bin/ksg_dc_instance_name.cfg

2. Edit the value of the parameter data_collect_interval to change the data collection interval.3. Edit the value of the parameter data_emit_interval to change the data emitting interval.


4. Save the configuration file.5. Stop the agent instance by running the command: CANDLEHOME/bin/itmcmd agent -o

instance_name stop sg

6. Start the agent instance by running the command: CANDLEHOME/bin/itmcmd agent -oinstance_name start sg

Agent installation fails with error code 99 and error code 4Symptom

The agent installation failed with the following error:runGSkit failure: Return error code: 99.runGSkit failure: GSKit check failure, script: /opt/IBM/ITM/ls3263/gs/bin/private_verifyinstall.runGSkit failure: ls3263 - GSK check error, verifyInstall test failed.install.sh failure: Return error code: 4.

Cause The environment does not have package compat-libstdc++-33-3.2.3-69.el6.i686.rpm andcompat-libstdc++-33-3.2.3-69.el6.x86_64.rpm.

SolutionInstall the package compat-libstdc++-33-3.2.3-69.el6.i686.rpm and compat-libstdc++-33-3.2.3-69.el6.x86_64.rpm.

Agent name strings are not correctly displayedSymptom

When you use the Tivoli Enterprise Portal browser client based on IBM 1.5 JRE that is providedbefore ITM 6.2.3 FP5, the strings of the agents are not displayed correctly.

SolutionFollow the steps to identify a higher JRE version to the Tivoli Enterprise Portal Server for theclient to use:1. Go to the computer where the Tivoli Enterprise Portal Server is installed.2. Find the file ITM_install_dir/arch/cw/jrelevel.js.3. Edit the jrelevel.js file by changing the value of the variable jreLevel to 1.6.0 as in the

following example:jreLevel = "1.6.0"

This variable has the following possible values:

* The browser client uses the default JER for the computer.

1.6.0The browser client uses the IBM 1.6 JRE.

6.0The browser client uses the latest Sun 1.6.0_xx JRE installed.

Installation fails on Redhat 7 if the agent is installed in the samedirectory as the OS agentSymptom

On Redhat 7, if you installed the OS agent within IBM Tivoli Monitoring V6.3 FP2 by runningsetarch $(uname -m) --uname-2.6, the installation of the OpenStack agent to the same directoryfails.

SolutionFollow the workaround to install the OpenStack agent and the OS agent in the same directory:

Chapter 6. Troubleshooting 21

1. Install the OpenStack agent to a directory that is different from the OS agent installationdirectory.

2. Replace the OSAgent_dir/bin/dynarch.shl file with the OpenStackAgent_dir/bin/dynarch.shl.3. Install the OpenStack agent again to the same directory as the OS agent.

Remote installation or configuration fails due to long managed systemnameSymptom

Remote installation or configuration of OpenStack agent fails. The agent instance cannot bestarted or stopped from Tivoli Enterprise Portal.

Cause The OpenStack agent registers the following strings as the managed system name:

instancename:hostname:SG

where instancename is the name that you assign to the agent; hostname is the host name.

This problem occurs because the managed system name is longer than 32 characters. When themanaged system name is too long, the instancename:hostname part is truncated.

SolutionTo avoid this problem, shorten the instance name or the host name to make sure that themanaged system name does not exceed 32 characters.

For instructions on how to shorten the host name in the managed system name, see “Agentinstance node displays incorrectly on Tivoli Enterprise Portal” on page 20.


Chapter 7. Reference

You can find help information in this chapter about workspaces, situations, and attributes.

WorkspacesA workspace is the working area of the Tivoli Enterprise Portal application window. The Navigatorcontains a list of the workspaces provided by the agent.

About workspaces

Use the Navigator to select the workspace you want to see. As part of the application window, the statusbar shows the Tivoli Enterprise Portal Server name and port number to which the displayed informationapplies and the ID of the current user.

When you select an item in the Navigator, a default workspace is displayed. When you right-click anavigator item, a menu that includes a Workspace item is displayed. The Workspace item contains a listof workspaces for that navigator item. Each workspace has at least one view. Some views have links toother workspaces. You can also use the Workspace Gallery tool as described in the Tivoli Enterprise PortalUser's Guide to open workspaces.

The workspaces in the Navigator are displayed in a Physical view that shows your enterprise as aphysical mapping or a dynamically populated logical view that is agent-specific. You can also create aLogical view. The Physical view is the default view.

This monitoring agent provides predefined workspaces. You cannot modify or delete the predefinedworkspaces, but you can create new workspaces by editing them and saving the changes with a differentname.

Workspace views can be any combination of query-based views, event views, and special purpose views.

Additional information about workspaces

For more information about creating, customizing, and working with workspaces, see "Using workspaces"in the Tivoli Enterprise Portal User's Guide.

For a list of the predefined workspaces for this monitoring agent and a description of each workspace,see Predefined workspaces and the information about each individual workspace.

Some attribute groups for this monitoring agent might not be represented in the predefined workspacesor views for this agent. For a full list of the attribute groups, see “Attribute groups or data sets for themonitoring agent” on page 29.

Predefined workspacesThe OpenStack agent provides predefined workspaces, which are organized by navigator item.v OpenStack navigator item

– OpenStack workspace– API Endpoints workspace– API Endpoints Details workspace– Environment Summary workspace– Flavors workspace


– Hypervisors workspace– Object Containers workspace– Object Storage Account Statistics workspace– Objects workspace– Process Details workspace– Processes workspace– Regions workspace– Virtual Machines workspace– Volumes workspace

Workspace descriptionsEach workspace description provides information about the workspace such as the purpose and a list ofviews in the workspace.

Workspaces are listed under navigator items.

OpenStack navigator itemThe workspace descriptions are organized by the navigator item to which the workspaces are relevant.OpenStack workspace

This workspace contains the following view:.

API Endpoints workspaceThe API Endpoints workspace displays the API endpoints status summarized by OpenStackservice type in monitored OpenStack environment. You can link to API Endpoints Detailsworkspace from API Endpoints navigation node to check the detailed information of all the APIEndpoints. To link to that workspace, right-click the API Endpoints navigation node and selectAPI Endpoints Details link.

This workspace contains the following views:API Endpoints

The API Endpoints view shows a table view displaying the number of available orunavailable API endpoints of each OpenStack component. You can link to API EndpointsDetails workspace from API Endpoints table view to check the API Endpoints Details of aspecific OpenStack component. To link to that workspace, right-click the row thatrepresents the OpenStack component you want to check then select the link to APIEndpoint Details in the context menu.

API Endpoint Statistics by ComponentThe API Endpoint Statistics by Component view displays the number of available orunavailable API endpoints of each OpenStack component. You can link to API EndpointsDetails workspace from API Endpoint Statistics by Component view to check the APIEndpoints Details of a specific OpenStack component. To link to that workspace,right-click the bar that represents the OpenStack component you want to check and clickLink To, then click API Endpoints Details.

Total API EndpointsThe Total API Endpoints view displays the number of total available API endpoints andthe number of total unavailable API endpoints.

API Endpoints Details workspaceThe API Endpoints Details workspace is a link to workspace that displays the detailedinformation about each API endpoint, such as its region name, service type, public URL, status,detecting information and http status code.

This workspace contains the following view:


API Endpoints DetailsThe API Endpoints Details view shows a table view displaying the detailed informationabout API endpoints.

Environment Summary workspaceThe Environment Summary workspace displays the overall status of the monitored OpenStackenvironment. You can open this workspace by clicking the OpenStack Agent navigation node.You can link to Object Storage Account Statistics workspace from OpenStack Agent navigationnode to check the object storage account information for current tenant. To link to thatworkspace, right-click the OpenStack Agent navigation node and then select the link to ObjectStorage Account Statistics in the context menu.

This workspace contains the following views:Environment Summary

The Environment Summary view shows a table view displaying the overall status of themonitored OpenStack environment, such as the number of processes, API endpoints,virtual machine instances in the environment, and the number of regions with differentresource usages. You can link to Object Storage Account Statistics workspace fromEnvironment Summary table view to check the object storage account information forcurrent tenant. To link to that workspace, right-click the row that represents OpenStackenvironment summary and then select the link to Object Storage Account Statistics in thecontext menu.

API Endpoint Statistics by ComponentThe API Endpoint Statistics by Component view displays the number of available orunavailable API endpoints in monitored OpenStack environment grouped by OpenStackcomponent.

Process Count by ComponentThe Process Count by Component view displays the number of running processes inmonitored OpenStack environment grouped by OpenStack component.

Flavors workspaceThe Flavors workspace is a link to workspace that displays the information about each flavor,such as its ID, name, configurations and reference count.

This workspace contains the following view:Flavors

The Flavors view shows a table view displaying the detailed information about flavors.Hypervisors workspace

The Hypervisors workspace displays the hypervisors information and the resource usages of thehypervisors in all the monitored OpenStack regions. You can link to Virtual Machine workspacefrom Hypervisors navigation node to check the virtual machines on all the hypervisors. To link tothat workspace, right-click the Hypervisors navigation node and select Virtual Machines link.

This workspace contains the following views:Hypervisor Summary

The Hypervisor Summary view shows a table view displaying the hypervisorsinformation and the resource usages of all the hypervisors, such as each hypervisor'sVCPU, Memory, File System Storage usage percentages and the number of runningvirtual machine instances on each hypervisor. You can link to Virtual Machinesworkspace from Hypervisor Summary table view to check the virtual machines createdby a specific hypervisor. To link to that workspace, right-click the row that represents thehypervisor you want to check, then select link to Virtual Machines in the context menu. .

Top 5 Hypervisors by Count of Running VMsThe Top 5 Hypervisors by Count of Running VMs view displays the top 5 hypervisorsthat have the most running virtual machines. You can link to Virtual Machines workspacefrom Top 5 Hypervisors by Count of Running VMs view to check the virtual machinescreated by a specific hypervisor. To link to that workspace, right-click the bar thatrepresents the hypervisor you want to check and click Link To, then click VirtualMachines.

Chapter 7. Reference 25

Top 5 Hypervisors by VCPU Usage PercentageThe Top 5 Hypervisors by VCPU Usage Percentage view displays the top 5 hypervisorsthat have the highest VCPU usage percentage. You can link to Virtual Machinesworkspace from Top 5 Hypervisors by VCPU Usage Percentage view to check the virtualmachines created by a specific hypervisor. To link to that workspace, right-click the barthat represents the hypervisor you want to check and click Link To, then click VirtualMachines.

Top 5 Hypervisors by Memory Usage PercentageThe Top 5 Hypervisors by Memory Usage Percentage view displays the top 5 hypervisorsthat have the highest memory usage percentage. You can link to Virtual Machinesworkspace from Top 5 Hypervisors by Memory Usage Percentage view to check thevirtual machines created by a specific hypervisor. To link to that workspace, right-clickthe bar that represents the hypervisor you want to check and click Link To, then clickVirtual Machines.

Top 5 Hypervisors by Storage Usage PercentageThe Top 5 Hypervisors by Storage Usage Percentage view displays the top 5 hypervisorsthat have the highest file system storage usage percentage. You can link to VirtualMachines workspace from Top 5 Hypervisors by Storage Usage Percentage view to checkthe virtual machines created by a specific hypervisor. To link to that workspace,right-click the bar that represents the hypervisor you want to check and click click LinkTo, then click Virtual Machines.

Object Containers workspaceThe Object Containers workspace is a link to workspace that displays the information about eachobject container, such as container name, object count and used bytes. You can link to Objectsworkspace from Object Containers workspace to check the object list for a specific objectcontainer. To link to that workspace, right-click the row that represents an object container andthen select the link to Objects in the context menu.

This workspace contains the following view:Object Containers

The Object Containers view shows a table view displaying the information about objectcontainers.

Object Storage Account Statistics workspaceThe Object Storage Account Statistics workspace is a link to the workspace that displays theinformation about the account of current project, such as container count, object count and usedbytes. You can link to Object Containers workspace from Object Storage Account Statisticsworkspace to check the container list for the account. To link to that workspace, right-click therow that represents the account and then select the link to Object Containers in the context menu.

This workspace contains the following view:Object Storage Account Statistics

The Object Storage Account Statistics view shows a table view displaying the informationabout the account of current project.

Objects workspaceThe Objects workspace is a link to workspace that displays the information about each object inan object container, such as its name, size, content type and last modified time.

This workspace contains the following view:Objects

The Objects view shows a table view displaying the information about objects.Process Details workspace

The Process Details workspace is a link to workspace that displays the detailed information abouteach process, such as its process name, PID, PPID, CPU usage, service type, status.

This workspace contains the following view:Process Details

The Process Details view shows a table view displaying the detailed information aboutprocesses.


Processes workspaceThe Processes workspace displays processes status summarized by OpenStack service type orhost in monitored OpenStack environment. You can link to Process Details workspace fromProcesses navigation node to check the detailed information of all processes. To link to thatworkspace, right-click the Processes navigation node and select Process Details link.

This workspace contains the following views:Top 5 Components by Process Count

The Top 5 Components by Process Count view displays the top 5 service types by theprocess count of each service type. You can link to Process Details workspace to check thedetailed information of processes that belong to the selected service type. To link to thatworkspace, right-click the component and select Process Details link.

Top 5 Hosts by Process CountThe Top 5 Hosts by Process Count view displays the top 5 hosts by the process count ofeach host. You can link to Process Details workspace to check the detailed information ofprocesses that belong to the selected host. To link to that workspace, right-click the hostand select Process Details link.

Process Summary by ComponentThe Process Summary by Component view shows a table view displaying the number ofprocesses of each OpenStack component. You can link to Process Details workspace tocheck the detailed information of processes that belong to the selected component. To linkto that workspace, right-click the component and select Process Details link.

Process Summary by HostThe Process Summary by Host view shows a table view displaying the number ofprocesses of each OpenStack host. You can link to Process Details workspace to check thedetailed information of processes that belong to the selected host. To link to thatworkspace, right-click the host and select Process Details link.

Regions workspaceThe Regions workspace displays the resource usages of the monitored OpenStack regions. Youcan link to Flavors and Volulmes workspaces from Regions navigation node to check the flavorsand volumes in all the regions. To link to that workspace, right-click the Regions navigation nodeand select Flavors and Volulmes links.

This workspace contains the following views:Region Summary

The Region Summary view shows a table view displaying the resource usages of all theregions, such as each region's VCPU, Memory, File System Storage usage percentage andthe number of virtual machine instances. You can link to Hypervisors, Virtual Machines,Flavors and Volumes workspaces from Region Summary table view to check thehypervisors, virtual machines, flavors and volumes in a specific region. To link to thoseworkspaces, right-click the row that represents the region you want to check then selectlinks to Hypervisors, Virtual Machines, Flavors and Volumes in the context menu.

Top 5 Regions by VCPU Usage PercentageThe Top 5 Regions by VCPU Usage Percentage view displays the top 5 regions that havethe highest VCPU usage percentage. You can link to Hypervisors, Virtual Machines,Flavors and Volumes workspaces from Top 5 Regions by VCPU Usage Percentage view tocheck the hypervisors, virtual machines, flavors and volumes in a specific region. To linkto those workspaces, right-click the bar that represents the region you want to check andclick Links To, then click Hypervisors, Virtual Machines, Flavors and Volumes.

Top 5 Regions by Memory Usage PercentageThe Top 5 Regions by Memory Usage Percentage view displays the top 5 regions thathave the highest memory usage percentage. You can link to Hypervisors, VirtualMachines, Flavors and Volumes workspaces from Top 5 Regions by Memory UsagePercentage view to check the hypervisors, virtual machines, flavors and volumes in aspecific region. To link to those workspaces, right-click the bar that represents the regionyou want to check and click Links To, then click Hypervisors, Virtual Machines, Flavorsand Volumes.


Top 5 Regions by Storage Usage PercentageThe Top 5 Regions by Storage Usage Percentage view displays the top 5 regions that havethe highest file system storage usage percentage. You can link to Hypervisors, VirtualMachines, Flavors and Volumes workspaces from Top 5 Regions by Storage UsagePercentage view to check the hypervisors, virtual machines, flavors and volumes in aspecific region. To link to those workspaces, right-click the bar that represents the regionyou want to check and click Links To, the click Hypervisors, Virtual Machines, Flavorsand Volumes.

Top 5 Regions by Floating IP Quota PercentageThe Top 5 Regions by Floating IP Quota Percentage view displays the top 5 regions thathave the highest floating IP quota percentage in current project. You can link toHypervisors, Virtual Machines, Flavors and Volumes workspaces from Top 5 Regions byFloation IP Quota Percentage view to check the hypervisors, virtual machines, flavors andvolumes in a specific region. To link to those workspaces, right-click the bar thatrepresents the region you want to check and click Links To, then click Hypervisors,Virtual Machines, Flavors and Volumes.

Virtual Machines workspaceThe Virtual Machines workspace is a link to workspace that displays the information about eachvirtual machine, such as its ID, name, IP addresses, status, image, flavor, key pairs, tenant, userand user email.

This workspace contains the following view:Virtual Machines

The Virtual Machines view shows a table view displaying the detailed information aboutvirtual machines. You can link to OS agent from Virtual Machines table view to check theperformance of a specific virtual machine if OS agent has been installed in the virtualmachine and connected to the same ITM Hub TEMS with the OpenStack monitoringagent. To link to that workspace, right-click the row that represents the virtual machineyou want to check and then select the link to OS Agent in the context menu.

Volumes workspaceThe Volumes workspace is a link to workspace that displays the information about each volume,such as its ID, name, type, size, metadata, status and attachments.

This workspace contains the following view:Volumes

The Volumes view shows a table view displaying the detailed information aboutvolumes.

AttributesAttributes are the application properties that are being measured and reported by the Monitoring Agentfor OpenStack.

About attributes

Attributes are organized into attribute groups. Attributes in an attribute group relate to a single objectsuch as an application, or to a single kind of data such as status information.

Attributes in a group can be used in queries, query-based views, situations, policy workflows, take actiondefinitions, and launch application definitions. Chart or table views and situations are two examples ofhow attributes in a group can be used:

Chart or table viewsAttributes are displayed in chart and table views. The chart and table views use queries tospecify which attribute values to request from a monitoring agent. You use the Properties editorto apply filters and set styles to define the content and appearance of a view based on an existingquery.


SituationsYou use attributes to create situations that monitor the state of your operating system, database,or application. A situation describes a condition you want to test. When you start a situation, thevalues you assign to the situation attributes are compared with the values collected by theOpenStack agent and registers an event if the condition is met. You are alerted to events byindicator icons that are displayed in the Navigator.

Attributes are organized into attribute groups or data sets, the values of which can be selectivelydisplayed in dashboards or used to define a threshold. After the dashboard is opened, the threshold isstarted, or the historical data collection interval completes, data samples of the attributes in the attributegroup or data set are taken.

For a list of the attribute groups or data sets, a list of the attributes in each attribute group or data set,and descriptions of the attributes for this monitoring agent, see “Attribute groups or data sets for themonitoring agent” and “Attributes in each attribute group or data set” on page 30.

Additional information about attributes

For more information about using attributes and attribute groups, see the Tivoli Enterprise Portal User'sGuide.

For a list of the attribute groups, a list of the attributes in each attribute group, and descriptions of theattributes for this monitoring agent, see “Attribute groups or data sets for the monitoring agent” and“Attributes in each attribute group or data set” on page 30.

Attribute groups or data sets for the monitoring agentThe OpenStack agent contains the following attribute groups or data sets. For agents that use IBM TivoliMonitoring infrastructure, attributes are in attribute groups. For agents that use the lightweightinfrastructure, attributes are in data sets.

The table name depends on the maximum table name limits of the target database being used for thehistorical data collection. If the maximum name is 30 characters, any warehouse or historical table namelonger than 30 characters is shortened to 30 characters.

Note: Agents that use the Tivoli Monitoring infrastructure refer to the historical table name as thewarehouse table name.v Attribute group or data set name: API Endpoint Details

– Table name: KSGAPIDET– Warehouse or historical table name: KSG_API_DETAILS or KSGAPIDET

v Attribute group or data set name: API Endpoints– Table name: KSGSERSUM– Warehouse or historical table name: KSG_API_STATUS_SUMMARY or KSGSERSUM

v Attribute group or data set name: Environment Summary– Table name: KSGOSSUM– Warehouse or historical table name: KSG_ENVIRONMENT_SUMMARY or KSGOSSUM

v Attribute group or data set name: Flavors– Table name: KSGFLAVORR– Warehouse or historical table name: KSG_FLAVORS or KSGFLAVORR

v Attribute group or data set name: Hypervisors– Table name: KSGHYPERVS– Warehouse or historical table name: KSG_HYPERVISORS or KSGHYPERVS


v Attribute group or data set name: Object Containers– Table name: KSGCONTANS– Warehouse or historical table name: KSG_OBJECT_CONTAINERS or KSGCONTANS

v Attribute group or data set name: Object Storage Account Statistics– Table name: KSGACCOUNT– Warehouse or historical table name: KSG_ACCOUNT_STATISTICS or KSGACCOUNT

v Attribute group or data set name: Objects– Table name: KSGOBJECTS– Warehouse or historical table name: KSG_OBJECTS

v Attribute group or data set name: Performance Object Status– Table name: KSGPOBJST– Warehouse or historical table name: KSG_PERFORMANCE_OBJECT_STATUS or KSGPOBJST

v Attribute group or data set name: Process Details– Table name: KSGPROCDET– Warehouse or historical table name: KSG_PROCESS_DETAILS or KSGPROCDET

v Attribute group or data set name: Processes– Table name: KSGPROCSUM– Warehouse or historical table name: KSG_PROCESS_SUMMARY or KSGPROCSUM

v Attribute group or data set name: Processes by Host– Table name: KSGPRCHOST– Warehouse or historical table name: KSG_PROCESS_SUMMARY_BY_HOST or KSGPRCHOST

v Attribute group or data set name: Regions– Table name: KSGREGISUM– Warehouse or historical table name: KSG_REGION_SUMMARY or KSGREGISUM

v Attribute group or data set name: Take Action Status– Table name: KSGTACTST– Warehouse or historical table name: KSG_TAKE_ACTION_STATUS or KSGTACTST

v Attribute group or data set name: Thread Pool Status– Table name: KSGTHPLST– Warehouse or historical table name: KSG_THREAD_POOL_STATUS or KSGTHPLST

v Attribute group or data set name: VM Details– Table name: KSGINSTDET– Warehouse or historical table name: KSG_VM_DETAILS or KSGINSTDET

v Attribute group or data set name: Volumes– Table name: KSGVOLUMES– Warehouse or historical table name: KSG_VOLUMES

Attributes in each attribute group or data setAttributes in each OpenStack agent attribute group or data set collect data that the agent uses formonitoring.

The description of each attribute group or data set contains the following details:v Whether the attribute group or data set is a historical type that you can roll off to a data warehouse.v Information such as whether the attribute is a key attribute, type, verification method, warehouse name

(as applicable), and other names.


A key attribute is an attribute that is used in warehouse aggregation to identify rows of data thatrepresent the same object.

API Endpoint Details attribute group or data setThe OpenStack API details This attribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:API Endpoint Detecting Failure Percent attribute

The API endpoint detecting failure percentage during the last collection interval The type isinteger (32-bit gauge).

The following names are defined for this attribute: API_FAILURE_PERCENT or F_PERC(warehouse name), API Endpoint Detecting Failure Percent (caption), API_Failure_Percent(attribute name), and F_PERC (column name).

API Endpoint Detecting Failure Times attributeThe count of API endpoint detecting failure during the last collection interval The type is integer(32-bit gauge).

The following names are defined for this attribute: API_DETECTING_FAILURE_TIMES orF_TIMES (warehouse name), API Endpoint Detecting Failure Times (caption),API_Detecting_Failure_Times (attribute name), and F_TIMES (column name).

API Endpoint Detecting Status Code attributeThe return code of API endpoint detecting The type is integer (32-bit gauge).

The following names are defined for this attribute: API_STATUS_CODE or SCODE (warehousename), API Endpoint Detecting Status Code (caption), API_Status_Code (attribute name), andSCODE (column name).

API Endpoint Detecting Times attributeThe count of API endpoint detecting during the last collection interval The type is integer (32-bitgauge).

The following names are defined for this attribute: API_DETECTING_TIMES or D_TIMES(warehouse name), API Endpoint Detecting Times (caption), API_Detecting_Times (attributename), and D_TIMES (column name).

Keystone Host attributeThe host of Keystone service This attribute is a key attribute. The type is string.

The following names are defined for this attribute: KEYSTONE_HOST or KS_HOST (warehousename), Keystone Host (caption), Keystone_Host (attribute name), and KS_HOST (column name).

Node attributeThe managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (warehouse name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Public URL attributeThe public URL of the API endpoint This attribute is a key attribute. The type is string.

The following names are defined for this attribute: PUBLIC_URL or API_URL (warehouse name),Public URL (caption), Public_URL (attribute name), and API_URL (column name).

Region Name attributeThe name of the monitored region This attribute is a key attribute. The type is string.

The following names are defined for this attribute: REGION_NAME or REGI_NAME (warehousename), Region Name (caption), Region_Name (attribute name), and REGI_NAME (column name).

Service Type attributeThe service type of the API endpoint The type is string.

The following names are defined for this attribute: COMPONENT_NAME or COMP_NAME(warehouse name), Service Type (caption), Component_Name (attribute name), andCOMP_NAME (column name).


Status attributeThe current status of the API endpoint The type is integer with enumerated values. The followingvalues are defined: Available (0), Unavailable (1), Unreachable (2). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: STATUS (warehouse name), Status (caption),Status (attribute name), and STATUS (column name).

Timestamp attributeThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (warehouse name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

API Endpoints attribute group or data setThe OpenStack API status summary by component This attribute group or data set is eligible for usewith Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Available API Endpoints attribute

The number of available API endpoints The type is integer (32-bit gauge).

The following names are defined for this attribute: AVAILABLE_API_ENDPOINTS or AVAI_API(warehouse name), Available API Endpoints (caption), Available_API_Endpoints (attribute name),and AVAI_API (column name).





Service Type attributeThe service type of the API endpoint This attribute is a key attribute. The type is string.

The following names are defined for this attribute: COMPONENT_NAME or COMP_NAME(warehouse name), Service Type (caption), Component_Name (attribute name), andCOMP_NAME (column name).



Unavailable API Endpoints attributeThe number of unavailable API endpoints The type is integer (32-bit gauge).

The following names are defined for this attribute: UNAVAILABLE_API_ENDPOINTS orUNAVA_API (warehouse name), Unavailable API Endpoints (caption),Unavailable_API_Endpoints (attribute name), and UNAVA_API (column name).

Environment Summary attribute group or data setThe summary information of the OpenStack environment This attribute group or data set is eligible foruse with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Active Instances attribute

The number of power-on OpenStack virtual machine instances The type is integer (32-bit gauge).


The following names are defined for this attribute: ACTIVE_INSTANCE_COUNT or ACT_INST(warehouse name), Active Instances (caption), Active_Instance_Count (attribute name), andACT_INST (column name).

Available API Endpoints attributeThe number of available OpenStack API Endpoints The type is integer (32-bit gauge).

The following names are defined for this attribute: AVAILABLE_API_COUNT or AVAI_API(warehouse name), Available API Endpoints (caption), Available_API_Count (attribute name), andAVAI_API (column name).

Inactive Instances attributeThe number of power-off OpenStack virtual machine instances The type is integer (32-bit gauge).

The following names are defined for this attribute: INACTIVE_INSTANCE_COUNT orINAC_INST (warehouse name), Inactive Instances (caption), Inactive_Instance_Count (attributename), and INAC_INST (column name).





Region Count (Critical File System Storage Usage) attributeThe number of regions with critical file system storage usage (Greater than or equal 90%) Thetype is integer (32-bit gauge).

The following names are defined for this attribute:FILE_SYSTEM_STORAGE_USAGE_CRITICAL_REGIONS or FSS_RED (warehouse name), RegionCount (Critical File System Storage Usage) (caption), File_System_Storage_Usage_Critical_Regions(attribute name), and FSS_RED (column name).

Region Count (Critical Floating IP Quota Usage) attributeThe number of regions with critical floating IP quota usage for current project (Greater than orequal 90%) The type is integer (32-bit gauge).

The following names are defined for this attribute: FLOATING_IP_USAGE_CRITICAL_REGIONSor IP_RED (warehouse name), Region Count (Critical Floating IP Quota Usage) (caption),Floating_IP_Usage_Critical_Regions (attribute name), and IP_RED (column name).

Region Count (Critical Memory Usage) attributeThe number of regions with critical memory usage (Greater than or equal 90%) The type isinteger (32-bit gauge).

The following names are defined for this attribute: MEMORY_USAGE_CRITICAL_REGIONS orMEM_RED (warehouse name), Region Count (Critical Memory Usage) (caption),Memory_Usage_Critical_Regions (attribute name), and MEM_RED (column name).

Region Count (Critical vCPU Usage) attributeThe number of regions with critical vCPU usage (Greater than or equal 90%) The type is integer(32-bit gauge).

The following names are defined for this attribute: VCPU_USAGE_CRITICAL_REGIONS orVCPU_RED (warehouse name), Region Count (Critical vCPU Usage) (caption),VCPU_Usage_Critical_Regions (attribute name), and VCPU_RED (column name).

Region Count (Normal File System Storage Usage) attributeThe number of regions with normal file system storage usage (Less than 80%) The type is integer(32-bit gauge).

The following names are defined for this attribute:FILE_SYSTEM_STORAGE_USAGE_NORMAL_REGIONS or FSS_GRE (warehouse name), Region


Count (Normal File System Storage Usage) (caption),File_System_Storage_Usage_Normal_Regions (attribute name), and FSS_GRE (column name).

Region Count (Normal Floating IP Quota Usage) attributeThe number of regions with normal floating IP quota usage for current project (Less than 80%)The type is integer (32-bit gauge).

The following names are defined for this attribute: FLOATING_IP_USAGE_NORMAL_REGIONSor IP_GRE (warehouse name), Region Count (Normal Floating IP Quota Usage) (caption),Floating_IP_Usage_Normal_Regions (attribute name), and IP_GRE (column name).

Region Count (Normal Memory Usage) attributeThe number of regions with normal memory usage (Less than 80%) The type is integer (32-bitgauge).

The following names are defined for this attribute: MEMORY_USAGE_NORMAL_REGIONS orMEM_GRE (warehouse name), Region Count (Normal Memory Usage) (caption),Memory_Usage_Normal_Regions (attribute name), and MEM_GRE (column name).

Region Count (Normal vCPU Usage) attributeThe number of regions with normal vCPU usage (Less than 80%) The type is integer (32-bitgauge).

The following names are defined for this attribute: VCPU_USAGE_NORMAL_REGIONS orVCPU_GRE (warehouse name), Region Count (Normal vCPU Usage) (caption),VCPU_Usage_Normal_Regions (attribute name), and VCPU_GRE (column name).

Region Count (Warning File System Storage Usage) attributeThe number of regions with warning file system storage usage (Greater than or equal 80% andless than 90%) The type is integer (32-bit gauge).

The following names are defined for this attribute:FILE_SYSTEM_STORAGE_USAGE_WARNING_REGIONS or FSS_YEL (warehouse name), RegionCount (Warning File System Storage Usage) (caption),File_System_Storage_Usage_Warning_Regions (attribute name), and FSS_YEL (column name).

Region Count (Warning Floating IP Quota Usage) attributeThe number of regions with warning floating IP quota usage for current project (Greater than orequal 80% and less than 90%) The type is integer (32-bit gauge).

The following names are defined for this attribute: FLOATING_IP_USAGE_WARNING_REGIONSor IP_YEL (warehouse name), Region Count (Warning Floating IP Quota Usage) (caption),Floating_IP_Usage_Warning_Regions (attribute name), and IP_YEL (column name).

Region Count (Warning Memory Usage) attributeThe number of regions with warning memory usage (Greater than or equal 80% and less than90%) The type is integer (32-bit gauge).

The following names are defined for this attribute: MEMORY_USAGE_WARNING_REGIONS orMEM_YEL (warehouse name), Region Count (Warning Memory Usage) (caption),Memory_Usage_Warning_Regions (attribute name), and MEM_YEL (column name).

Region Count (Warning vCPU Usage) attributeThe number of regions with warning vCPU usage (Greater than or equal 80% and less than 90%)The type is integer (32-bit gauge).

The following names are defined for this attribute: VCPU_USAGE_WARNING_REGIONS orVCPU_YEL (warehouse name), Region Count (Warning vCPU Usage) (caption),VCPU_Usage_Warning_Regions (attribute name), and VCPU_YEL (column name).

Running Processes attributeThe number of running OpenStack processes The type is integer (32-bit gauge).

The following names are defined for this attribute: RUNNING_PROCESS_COUNT orAVAI_PROC (warehouse name), Running Processes (caption), Running_Process_Count (attributename), and AVAI_PROC (column name).

Tenant attributeThe tenant to which the current user belongs This attribute is a key attribute. The type is string.


The following names are defined for this attribute: TENANT_NAME or TENNAME (warehousename), Tenant (caption), Tenant_Name (attribute name), and TENNAME (column name).



Unavailable API Endpoints attributeThe number of unavailable OpenStack API Endpoints The type is integer (32-bit gauge).

The following names are defined for this attribute: UNAVAILABLE_API_COUNT or UNAV_API(warehouse name), Unavailable API Endpoints (caption), Unavailable_API_Count (attributename), and UNAV_API (column name).

Flavors attribute group or data setThe flavors information This attribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Ephemeral Disk (GB) attribute

The ephemeral disk setting of the flavor The type is integer (32-bit gauge).

The following names are defined for this attribute: EPHEMERAL_DISK or EPHE_DISK(warehouse name), Ephemeral Disk (GB) (caption), Ephemeral_Disk (attribute name), andEPHE_DISK (column name).

Flavor ID attributeThe flavor ID This attribute is a key attribute. The type is string.

The following names are defined for this attribute: FLAVOR_ID (warehouse name), Flavor ID(caption), Flavor_ID (attribute name), and FLAVOR_ID (column name).

Flavor Name attributeThe flavor name This attribute is a key attribute. The type is string.

The following names are defined for this attribute: FLAVOR_NAME or FLAV_NAME (warehousename), Flavor Name (caption), Flavor_Name (attribute name), and FLAV_NAME (column name).

Is Public attributeThis attribute shows whether the flavor is public or not The type is string.

The following names are defined for this attribute: IS_PUBLIC (warehouse name), Is Public(caption), Is_Public (attribute name), and IS_PUBLIC (column name).

Keystone Host attributeThe host of Keystone service of the OpenStack environment This attribute is a key attribute. Thetype is string.


Memory (MB) attributeThe memory setting of the flavor The type is integer (32-bit gauge).

The following names are defined for this attribute: MEMORY (warehouse name), Memory (MB)(caption), Memory (attribute name), and MEMORY (column name).



Reference Count attributeThe reference count. This attribute indicates how many VMs were created with this flavor Thetype is integer (32-bit gauge).


The following names are defined for this attribute: REFERENCE_COUNT or REF_COUNT(warehouse name), Reference Count (caption), Reference_Count (attribute name), andREF_COUNT (column name).



Root Disk (GB) attributeThe root disk setting of the flavor The type is integer (32-bit gauge).

The following names are defined for this attribute: ROOT_DISK (warehouse name), Root Disk(GB) (caption), Root_Disk (attribute name), and ROOT_DISK (column name).

Swap Disk (MB) attributeThe swap disk setting of the flavor The type is integer (32-bit gauge).

The following names are defined for this attribute: SWAP_DISK (warehouse name), Swap Disk(MB) (caption), Swap_Disk (attribute name), and SWAP_DISK (column name).



vCPU Count attributeThe vCPU setting of the flavor The type is integer (32-bit gauge).

The following names are defined for this attribute: VCPU_COUNT or VCPU (warehouse name),vCPU Count (caption), VCPU_Count (attribute name), and VCPU (column name).

Hypervisors attribute group or data setThe hypervisor list This attribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:CPU Architecture attribute

The hypervisor CPU architecture The type is string.

The following names are defined for this attribute: CPU_ARCHITECTURE or CPU_ARCH(warehouse name), CPU Architecture (caption), CPU_Architecture (attribute name), andCPU_ARCH (column name).

CPU Model attributeThe hypervisor CPU model The type is string.

The following names are defined for this attribute: CPU_MODEL or CPU_MOD (warehousename), CPU Model (caption), CPU_Model (attribute name), and CPU_MOD (column name).

CPU Vendor attributeThe hypervisor CPU vendor The type is string.

The following names are defined for this attribute: CPU_VENDOR or CPU_VEND (warehousename), CPU Vendor (caption), CPU_Vendor (attribute name), and CPU_VEND (column name).

Host IP attributeThe IP address of the host This attribute is a key attribute. The type is string.

The following names are defined for this attribute: HOST_IP (warehouse name), Host IP(caption), Host_IP (attribute name), and HOST_IP (column name).

Hypervisor Hostname attributeThe hypervisor host name This attribute is a key attribute. The type is string.

The following names are defined for this attribute: HYPERVISOR_HOSTNAME or HPVHOST(warehouse name), Hypervisor Hostname (caption), Hypervisor_Hostname (attribute name), andHPVHOST (column name).


Hypervisor ID attributeThe hypervisor ID This attribute is a key attribute. The type is string.

The following names are defined for this attribute: ID or HYPERV_ID (warehouse name),Hypervisor ID (caption), ID (attribute name), and HYPERV_ID (column name).

Hypervisor Type attributeThe hypervisor type The type is string.

The following names are defined for this attribute: HYPERVISOR_TYPE or HPVTYPE (warehousename), Hypervisor Type (caption), Hypervisor_Type (attribute name), and HPVTYPE (columnname).

Hypervisor Version attributeThe hypervisor version The type is string.

The following names are defined for this attribute: HYPERVISOR_VERSION or HPVVER(warehouse name), Hypervisor Version (caption), Hypervisor_Version (attribute name), andHPVVER (column name).



Local Storage Size (TB) attributeThe local file system storage size (TB) of the hypervisor The type is string.

The following names are defined for this attribute: LOCAL_STORAGE_SIZE or STORAGE(warehouse name), Local Storage Size (TB) (caption), Local_Storage_Size (attribute name), andSTORAGE (column name).





Running VMs attributeThe count of running virtual machine instances of the hypervisor The type is integer (32-bitgauge).

The following names are defined for this attribute: RUNNING_VMS or VMS (warehouse name),Running VMs (caption), Running_VMs (attribute name), and VMS (column name).

Service Host attributeThe compute service host The type is string.

The following names are defined for this attribute: SERVICE_HOST or SRVHOST (warehousename), Service Host (caption), Service_Host (attribute name), and SRVHOST (column name).



Total Memory Size (GB) attributeThe total memory size (GB) of the hypervisor The type is string.

The following names are defined for this attribute: TOTAL_MEMORY_SIZE or MEM (warehousename), Total Memory Size (GB) (caption), Total_Memory_Size (attribute name), and MEM(column name).


Total vCPU Count attributeThe count of all vCPUs of the hypervisor The type is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_VCPU_COUNT or VCPU (warehousename), Total vCPU Count (caption), Total_vCPU_Count (attribute name), and VCPU (columnname).

Used Memory Percent attributeThe percentage of memory usage of the hypervisor The type is integer (32-bit gauge).

The following names are defined for this attribute: USED_MEMORY_PERCENT or MEM_RATE(warehouse name), Used Memory Percent (caption), Used_Memory_Percent (attribute name), andMEM_RATE (column name).

Used Memory Size (GB) attributeThe used memory size (GB) of the hypervisor The type is string.

The following names are defined for this attribute: USED_MEMORY_SIZE or USED_MEM(warehouse name), Used Memory Size (GB) (caption), Used_Memory_Size (attribute name), andUSED_MEM (column name).

Used Storage Percent attributeThe percentage of used local file system storage of the hypervisor The type is integer (32-bitgauge).

The following names are defined for this attribute: USED_STORAGE_PERCENT or FSTO_RATE(warehouse name), Used Storage Percent (caption), Used_Storage_Percent (attribute name), andFSTO_RATE (column name).

Used Storage Size (TB) attributeThe used local file system storage size (TB) of the hypervisor The type is string.

The following names are defined for this attribute: USED_STORAGE_SIZE or USED_FSTO(warehouse name), Used Storage Size (TB) (caption), Used_Storage_Size (attribute name), andUSED_FSTO (column name).

Used vCPU Count attributeThe count of used vCPUs of the hypervisor The type is integer (32-bit gauge).

The following names are defined for this attribute: USED_VCPU_COUNT or USED_VCPU(warehouse name), Used vCPU Count (caption), Used_vCPU_Count (attribute name), andUSED_VCPU (column name).

Used vCPU Percent attributeThe percentage of vCPU usage of the hypervisor The type is integer (32-bit gauge).

The following names are defined for this attribute: USED_VCPU_PERCENT or VCPU_RATE(warehouse name), Used vCPU Percent (caption), Used_vCPU_Percent (attribute name), andVCPU_RATE (column name).

Object Containers attribute group or data setThe object containers This attribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Accept Ranges attribute

The accept ranges of the object storage account The type is string.

The following names are defined for this attribute: ACCEPT_RANGES or ACC_RAG (warehousename), Accept Ranges (caption), Accept_Ranges (attribute name), and ACC_RAG (column name).

Container Name attributeThe name of the object container This attribute is a key attribute. The type is string.

The following names are defined for this attribute: CONTAINER_NAME or CON_NAME(warehouse name), Container Name (caption), Container_Name (attribute name), andCON_NAME (column name).

Content Type attributeThe content type of object storage The type is string.


The following names are defined for this attribute: CONTENT_TYPE or CON_TYPE (warehousename), Content Type (caption), Content_Type (attribute name), and CON_TYPE (column name).





Object Count attributeThe number of objects in the container The type is integer (32-bit gauge).

The following names are defined for this attribute: OBJECT_COUNT or OBJ_COUNT (warehousename), Object Count (caption), Object_Count (attribute name), and OBJ_COUNT (column name).

Tenant attributeThe tenant to which the object storage account belongs This attribute is a key attribute. The typeis string.




Used Bytes attributeThe bytes used by the container The type is integer (64-bit gauge).

The following names are defined for this attribute: USED_BYTES or USED_BYTE (warehousename), Used Bytes (caption), Used_Bytes (attribute name), and USED_BYTE (column name).

Object Storage Account Statistics attribute group or data setThe object storage account statistics This attribute group or data set is eligible for use with Tivoli DataWarehouse.

This attribute group or data set contains the following attributes:Accept Ranges attribute

The accept ranges of the object storage account The type is string.

The following names are defined for this attribute: ACCEPT_RANGES or ACC_RAG (warehousename), Accept Ranges (caption), Accept_Ranges (attribute name), and ACC_RAG (column name).

Container Count attributeThe number of containers The type is integer (32-bit gauge).

The following names are defined for this attribute: CONTAINER_COUNT or CON_COUNT(warehouse name), Container Count (caption), Container_Count (attribute name), andCON_COUNT (column name).








Object Count attributeThe number of objects The type is integer (32-bit gauge).

The following names are defined for this attribute: OBJECT_COUNT or OBJ_COUNT (warehousename), Object Count (caption), Object_Count (attribute name), and OBJ_COUNT (column name).





Used Bytes attributeThe bytes used by the account The type is integer (64-bit gauge).

The following names are defined for this attribute: USED_BYTES or USED_BYTE (warehousename), Used Bytes (caption), Used_Bytes (attribute name), and USED_BYTE (column name).

Objects attribute group or data setThe objects in containers This attribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Bytes attribute

The length of the object in bytes The type is integer (64-bit gauge).

The following names are defined for this attribute: BYTES or LENGTH (warehouse name), Bytes(caption), Bytes (attribute name), and LENGTH (column name).

Container Name attributeThe name of the object container This attribute is a key attribute. The type is string.

The following names are defined for this attribute: CONTAINER_NAME or CON_NAME(warehouse name), Container Name (caption), Container_Name (attribute name), andCON_NAME (column name).





Last Modified attributeThe last modified time of the object The type is string.

The following names are defined for this attribute: LAST_MODIFIED or MOD_TIME (warehousename), Last Modified (caption), Last_Modified (attribute name), and MOD_TIME (column name).




Object Name attributeThe name of the object This attribute is a key attribute. The type is string.

The following names are defined for this attribute: OBJECT_NAME or OBJECT (warehousename), Object Name (caption), Object_Name (attribute name), and OBJECT (column name).





Performance Object Status attribute group or data setThe Performance Object Status attribute group contains information that reflects the status of otherattribute groups so you can see the status of all performance objects that make up this application all atonce. Each of these other performance attribute groups is represented by a row in this table (or other typeof view). The status for an attribute group reflects the result of the last attempt to collect data for thatattribute group, so you can see whether the agent is collecting data correctly. Unlike other attributegroups, the Performance Object Status attribute group does not reflect the state of the monitoredapplication. This attribute group is most often used to determine why data is not available for one of theperformance attribute groups. This attribute group or data set is eligible for use with Tivoli DataWarehouse.

This attribute group or data set contains the following attributes:Average Collection Duration attribute

The average duration of all data collections of this group in seconds. The type is real number(32-bit counter) with two decimal places of precision with enumerated values. The followingvalues are defined: NO DATA (-100). Any value that does not have a definition here is displayedin the User Interface.

The following names are defined for this attribute: AVERAGE_COLLECTION_DURATION orCOLAVGD (warehouse name), Average Collection Duration (caption),Average_Collection_Duration (attribute name), and COLAVGD (column name).

Cache Hit Percent attributeThe percentage of external data requests for this group that were satisfied from the cache. Thetype is real number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: CACHE_HIT_PERCENT or CACHPCT(warehouse name), Cache Hit Percent (caption), Cache_Hit_Percent (attribute name), andCACHPCT (column name).

Cache Hits attributeThe number of times an external data request for this group was satisfied from the cache. Thetype is integer (32-bit counter).

The following names are defined for this attribute: CACHE_HITS or CACHEHT (warehousename), Cache Hits (caption), Cache_Hits (attribute name), and CACHEHT (column name).

Cache Misses attributeThe number of times an external data request for this group was not available in the cache. Thetype is integer (32-bit counter).

The following names are defined for this attribute: CACHE_MISSES or CACHEMS (warehousename), Cache Misses (caption), Cache_Misses (attribute name), and CACHEMS (column name).

Error Code attributeThe error code associated with the query. The type is integer with enumerated values. Thefollowing values are defined: NO ERROR (0), GENERAL ERROR (1), OBJECT NOT FOUND (2),


COUNTER NOT FOUND (3), NAMESPACE ERROR (4), OBJECT CURRENTLY UNAVAILABLE(5), COM LIBRARY INIT FAILURE (6), SECURITY INIT FAILURE (7), PROXY SECURITYFAILURE (9), NO INSTANCES RETURNED (10), ASSOCIATOR QUERY FAILED (11),REFERENCE QUERY FAILED (12), NO RESPONSE RECEIVED (13), CANNOT FIND JOINEDQUERY (14), CANNOT FIND JOIN ATTRIBUTE IN QUERY 1 RESULTS (15), CANNOT FINDJOIN ATTRIBUTE IN QUERY 2 RESULTS (16), QUERY 1 NOT A SINGLETON (17), QUERY 2NOT A SINGLETON (18), NO INSTANCES RETURNED IN QUERY 1 (19), NO INSTANCESRETURNED IN QUERY 2 (20), CANNOT FIND ROLLUP QUERY (21), CANNOT FIND ROLLUPATTRIBUTE (22), FILE OFFLINE (23), NO HOSTNAME (24), MISSING LIBRARY (25),ATTRIBUTE COUNT MISMATCH (26), ATTRIBUTE NAME MISMATCH (27), COMMON DATAPROVIDER NOT STARTED (28), CALLBACK REGISTRATION ERROR (29), MDL LOAD ERROR(30), AUTHENTICATION FAILED (31), CANNOT RESOLVE HOST NAME (32), SUBNODEUNAVAILABLE (33), SUBNODE NOT FOUND IN CONFIG (34), ATTRIBUTE ERROR (35),CLASSPATH ERROR (36), CONNECTION FAILURE (37), FILTER SYNTAX ERROR (38), FILENAME MISSING (39), SQL QUERY ERROR (40), SQL FILTER QUERY ERROR (41), SQL DBQUERY ERROR (42), SQL DB FILTER QUERY ERROR (43), PORT OPEN FAILED (44), ACCESSDENIED (45), TIMEOUT (46), NOT IMPLEMENTED (47), REQUESTED A BAD VALUE (48),RESPONSE TOO BIG (49), GENERAL RESPONSE ERROR (50), SCRIPT NONZERO RETURN(51), SCRIPT NOT FOUND (52), SCRIPT LAUNCH ERROR (53), CONF FILE DOES NOT EXIST(54), CONF FILE ACCESS DENIED (55), INVALID CONF FILE (56), EIF INITIALIZATIONFAILED (57), CANNOT OPEN FORMAT FILE (58), FORMAT FILE SYNTAX ERROR (59),REMOTE HOST UNAVAILABLE (60), EVENT LOG DOES NOT EXIST (61), PING FILE DOESNOT EXIST (62), NO PING DEVICE FILES (63), PING DEVICE LIST FILE MISSING (64), SNMPMISSING PASSWORD (65), DISABLED (66), URLS FILE NOT FOUND (67), XML PARSE ERROR(68), NOT INITIALIZED (69), ICMP SOCKETS FAILED (70), DUPLICATE CONF FILE (71). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: ERROR_CODE or ERRCODE (warehousename), Error Code (caption), Error_Code (attribute name), and ERRCODE (column name).

Intervals Skipped attributeThe number of times a background data collection for this group was skipped because theprevious collection was still running when the next one was due to start. The type is integer(32-bit counter).

The following names are defined for this attribute: INTERVALS_SKIPPED or INTSKIP(warehouse name), Intervals Skipped (caption), Intervals_Skipped (attribute name), and INTSKIP(column name).

Last Collection Duration attributeThe duration of the most recently completed data collection of this group in seconds. The type isreal number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: LAST_COLLECTION_DURATION orCOLDURA (warehouse name), Last Collection Duration (caption), Last_Collection_Duration(attribute name), and COLDURA (column name).

Last Collection Finished attributeThe most recent time a data collection of this group finished. The type is timestamp withenumerated values. The following values are defined: NOT COLLECTED (0691231190000000),NOT COLLECTED (0000000000000001). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: LAST_COLLECTION_FINISHED or COLFINI(warehouse name), Last Collection Finished (caption), Last_Collection_Finished (attribute name),and COLFINI (column name).

Last Collection Start attributeThe most recent time a data collection of this group started. The type is timestamp withenumerated values. The following values are defined: NOT COLLECTED (0691231190000000),NOT COLLECTED (0000000000000001). Any value that does not have a definition here isdisplayed in the User Interface.


The following names are defined for this attribute: LAST_COLLECTION_START or COLSTRT(warehouse name), Last Collection Start (caption), Last_Collection_Start (attribute name), andCOLSTRT (column name).



Number of Collections attributeThe number of data collections for this group since the agent started. The type is integer (32-bitcounter).

The following names are defined for this attribute: NUMBER_OF_COLLECTIONS or NUMCOLL(warehouse name), Number of Collections (caption), Number_of_Collections (attribute name), andNUMCOLL (column name).

Object Name attributeThe name of the performance object. The type is string.

The following names are defined for this attribute: OBJECT_NAME or OBJNAME (warehousename), Object Name (caption), Object_Name (attribute name), and OBJNAME (column name).

Object Status attributeThe status of the performance object. The type is integer with enumerated values. The followingvalues are defined: ACTIVE (0), INACTIVE (1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: OBJECT_STATUS or OBJSTTS (warehousename), Object Status (caption), Object_Status (attribute name), and OBJSTTS (column name).

Object Type attributeThe type of the performance object. The type is integer with enumerated values. The followingvalues are defined: WMI (0), PERFMON (1), WMI ASSOCIATION GROUP (2), JMX (3), SNMP(4), SHELL COMMAND (5), JOINED GROUPS (6), CIMOM (7), CUSTOM (8), ROLLUP DATA (9),WMI REMOTE DATA (10), LOG FILE (11), JDBC (12), CONFIG DISCOVERY (13), NT EVENTLOG (14), FILTER (15), SNMP EVENT (16), PING (17), DIRECTOR DATA (18), DIRECTOREVENT (19), SSH REMOTE SHELL COMMAND (20). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: OBJECT_TYPE or OBJTYPE (warehousename), Object Type (caption), Object_Type (attribute name), and OBJTYPE (column name).

Query Name attributeThe name of the attribute group. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: QUERY_NAME or ATTRGRP (warehousename), Query Name (caption), Query_Name (attribute name), and ATTRGRP (column name).

Refresh Interval attributeThe interval at which this group is refreshed in seconds. The type is integer (32-bit counter).

The following names are defined for this attribute: REFRESH_INTERVAL or REFRINT(warehouse name), Refresh Interval (caption), Refresh_Interval (attribute name), and REFRINT(column name).



Process Details attribute group or data setThe OpenStack process details This attribute group or data set is eligible for use with Tivoli DataWarehouse.

This attribute group or data set contains the following attributes:


Component Name attributeThe OpenStack component name The type is string.

The following names are defined for this attribute: COMPONENT_NAME or COMP_NAME(warehouse name), Component Name (caption), Component_Name (attribute name), andCOMP_NAME (column name).

CPU Usage(%) attributeThe percentage of CPU usage of a specific OpenStack process This attribute is a key attribute. Thetype is real number (32-bit gauge) with one decimal places of precision.

The following names are defined for this attribute: CPU (warehouse name), CPU Usage(%)(caption), CPU (attribute name), and CPU (column name).

Host IP attributeThe IP of the host where the process is running on This attribute is a key attribute. The type isstring.

The following names are defined for this attribute: HOST_IP (warehouse name), Host IP(caption), HOST_IP (attribute name), and HOST_IP (column name).

Host Name attributeThe host where the process is running on This attribute is a key attribute. The type is string.

The following names are defined for this attribute: HOSTNAME (warehouse name), Host Name(caption), HOSTNAME (attribute name), and HOSTNAME (column name).



Memory Usage(%) attributeThe percentage of memory usage of a specific OpenStack process This attribute is a key attribute.The type is real number (32-bit gauge) with one decimal places of precision.

The following names are defined for this attribute: MEM (warehouse name), Memory Usage(%)(caption), MEM (attribute name), and MEM (column name).



pid attributeThe process ID This attribute is a key attribute. The type is integer (32-bit numeric property).

The following names are defined for this attribute: PID (warehouse name), pid (caption), PID(attribute name), and PID (column name).

ppid attributeThe parent process ID This attribute is a key attribute. The type is integer (32-bit numericproperty).

The following names are defined for this attribute: PPID (warehouse name), ppid (caption), PPID(attribute name), and PPID (column name).

Process Name attributeThe process name This attribute is a key attribute. The type is string.

The following names are defined for this attribute: PROCESS_NAME or PNAME (warehousename), Process Name (caption), Process_Name (attribute name), and PNAME (column name).

Start Time attributeThe specific OpenStack process start time. The type is string.

The following names are defined for this attribute: START_TIME (warehouse name), Start Time(caption), Start_Time (attribute name), and START_TIME (column name).


Status attributeThe current status of a specific OpenStack process The type is integer with enumerated values.The following values are defined: Running (0), Defunct (1). Any value that does not have adefinition here is displayed in the User Interface.




Processes attribute group or data setThe OpenStack process summary by service This attribute group or data set is eligible for use with TivoliData Warehouse.

This attribute group or data set contains the following attributes:Component Name attribute

The component name This attribute is a key attribute. The type is string.

The following names are defined for this attribute: COMPONENT_NAME or COMP_NAME(warehouse name), Component Name (caption), Component_Name (attribute name), andCOMP_NAME (column name).

Component Process Count attributeThe component process count This attribute is a key attribute. The type is integer (32-bit gauge).

The following names are defined for this attribute: COMPONENT_PROCESS_COUNT orCOMPPRCNUM (warehouse name), Component Process Count (caption),Component_Process_Count (attribute name), and COMPPRCNUM (column name).







Processes by Host attribute group or data setThe OpenStack process summary by host This attribute group or data set is eligible for use with TivoliData Warehouse.

This attribute group or data set contains the following attributes:Host Name attribute

The host name This attribute is a key attribute. The type is string.

The following names are defined for this attribute: HOSTNAME (warehouse name), Host Name(caption), HOSTNAME (attribute name), and HOSTNAME (column name).

Host Process Count attributeThe host process count This attribute is a key attribute. The type is integer (32-bit gauge).


The following names are defined for this attribute: HOST_PROCESS_COUNT or HOSTPRCNUM(warehouse name), Host Process Count (caption), Host_Process_Count (attribute name), andHOSTPRCNUM (column name).







Regions attribute group or data setThe OpenStack region resource usage summary This attribute group or data set is eligible for use withTivoli Data Warehouse.

This attribute group or data set contains the following attributes:Active Instances attribute

The number of power-on instances in monitored OpenStack region The type is integer (32-bitgauge).

The following names are defined for this attribute: ACTIVE_INSTANCE_COUNT or ACT_INST(warehouse name), Active Instances (caption), Active_Instance_Count (attribute name), andACT_INST (column name).

Allocated Floating IP Count attributeThe number of allocated floating IP addresses for current project The type is integer (32-bitgauge).

The following names are defined for this attribute: ALLOCATED_FLOATING_IP_COUNT orUSED_IP (warehouse name), Allocated Floating IP Count (caption), Allocated_Floating_IP_Count(attribute name), and USED_IP (column name).

Floating IP Quota attributeThe floating IP quota for current project The type is integer (32-bit gauge).

The following names are defined for this attribute: FLOATING_IP_QUOTA or IP_QUOTA(warehouse name), Floating IP Quota (caption), Floating_IP_Quota (attribute name), andIP_QUOTA (column name).

Inactive Instances attributeThe number of power-off instances in monitored OpenStack region The type is integer (32-bitgauge).

The following names are defined for this attribute: INACTIVE_INSTANCE_COUNT orINAC_INST (warehouse name), Inactive Instances (caption), Inactive_Instance_Count (attributename), and INAC_INST (column name).










Total File System Storage Size (TB) attributeThe total file system storage Size (TB) of the monitored OpenStack region The type is string.

The following names are defined for this attribute: TOTAL_FILE_SYSTEM_STORAGE_SIZE orSTORAGE (warehouse name), Total File System Storage Size (TB) (caption),Total_File_System_Storage_Size (attribute name), and STORAGE (column name).

Total Floating IP Count attributeThe number of floating IP addresses for current project The type is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_FLOATING_IP_COUNT or FLOATIP(warehouse name), Total Floating IP Count (caption), Total_Floating_IP_Count (attribute name),and FLOATIP (column name).

Total Instances attributeThe number of total instances in monitored OpenStack region The type is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_INSTANCE_COUNT or INST(warehouse name), Total Instances (caption), Total_Instance_Count (attribute name), and INST(column name).

Total Memory Size (GB) attributeThe total memory size (GB) in the monitored OpenStack region The type is string.

The following names are defined for this attribute: TOTAL_MEMORY_SIZE or MEM (warehousename), Total Memory Size (GB) (caption), Total_Memory_Size (attribute name), and MEM(column name).

Total vCPUs attributeThe number of total vCPUs in the monitored OpenStack region The type is integer (32-bit gauge).

The following names are defined for this attribute: TOTAL_VCPU_COUNT or VCPU (warehousename), Total vCPUs (caption), Total_vCPU_Count (attribute name), and VCPU (column name).

Used File System Storage Percent attributeThe percentage of used file system storage in the monitored OpenStack region The type is integer(32-bit gauge).

The following names are defined for this attribute: USED_FILE_SYSTEM_STORAGE_PERCENTor FSTO_RATE (warehouse name), Used File System Storage Percent (caption),Used_File_System_Storage_Percent (attribute name), and FSTO_RATE (column name).

Used File System Storage Size (TB) attributeThe used file system storage Size (TB) of the monitored OpenStack region The type is string.

The following names are defined for this attribute: USED_FILE_SYSTEM_STORAGE_SIZE orUSED_FSTO (warehouse name), Used File System Storage Size (TB) (caption),Used_File_System_Storage_Size (attribute name), and USED_FSTO (column name).

Used Floating IP Quota Percent attributeThe percentage of used floating IP quota for the current project The type is integer (32-bit gauge).

The following names are defined for this attribute: ALLOCATED_FLOATING_IP_PERCENT orUIP_RATE (warehouse name), Used Floating IP Quota Percent (caption),Allocated_Floating_IP_Percent (attribute name), and UIP_RATE (column name).

Used Memory Percent attributeThe percentage of memory usage of the monitored OpenStack region The type is integer (32-bitgauge).


The following names are defined for this attribute: USED_MEMORY_PERCENT or MEM_RATE(warehouse name), Used Memory Percent (caption), Used_Memory_Percent (attribute name), andMEM_RATE (column name).

Used Memory Size (GB) attributeThe used memory size (GB) in the monitored OpenStack region The type is string.

The following names are defined for this attribute: USED_MEMORY_SIZE or USED_MEM(warehouse name), Used Memory Size (GB) (caption), Used_Memory_Size (attribute name), andUSED_MEM (column name).

Used vCPU Percent attributeThe percentage of vCPU usage of the monitored OpenStack region The type is integer (32-bitgauge).

The following names are defined for this attribute: USED_VCPU_PERCENT or VCPU_RATE(warehouse name), Used vCPU Percent (caption), Used_vCPU_Percent (attribute name), andVCPU_RATE (column name).

Used vCPUs attributeThe number of used vCPUs in the monitored OpenStack region The type is integer (32-bit gauge).

The following names are defined for this attribute: USED_VCPU_COUNT or USED_VCPU(warehouse name), Used vCPUs (caption), Used_vCPU_Count (attribute name), and USED_VCPU(column name).

Take Action Status attribute group or data setThe Take Action Status data set contains information about the results of actions this agent ran. Thisattribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Action App Return Code attribute

The application return code of the action is the actual return code of the command run. The typeis integer (32-bit numeric property).

The following names are defined for this attribute: ACTION_APP_RETURN_CODE or TSKAPRC(warehouse name), Action App Return Code (caption), Action_App_Return_Code (attributename), and TSKAPRC (column name).

Action Command attributeThe command that was run by the action. The type is string.

The following names are defined for this attribute: ACTION_COMMAND or TSKCMND(warehouse name), Action Command (caption), Action_Command (attribute name), andTSKCMND (column name).

Action ID attributeThe id of the action. The type is integer (32-bit numeric property).

The following names are defined for this attribute: ACTION_ID or TSKID (warehouse name),Action ID (caption), Action_ID (attribute name), and TSKID (column name).

Action Instance attributeThe instance that is associated with the output produced by running the action. The type isstring.

The following names are defined for this attribute: ACTION_INSTANCE or TSKINST (warehousename), Action Instance (caption), Action_Instance (attribute name), and TSKINST (column name).

Action Message attributeThe message that is associated with the return code of the action. The type is string.

The following names are defined for this attribute: ACTION_MESSAGE or TSKMSGE (warehousename), Action Message (caption), Action_Message (attribute name), and TSKMSGE (columnname).

Action Name attributeThe name of the action that was run. The type is string.


The following names are defined for this attribute: ACTION_NAME or TSKNAME (warehousename), Action Name (caption), Action_Name (attribute name), and TSKNAME (column name).

Action Node attributeThe node where the action ran. The type is string.

The following names are defined for this attribute: ACTION_NODE or TSKORGN (warehousename), Action Node (caption), Action_Node (attribute name), and TSKORGN (column name).

Action Owner attributeThe name of the situation or user that initiated the action. The type is string.

The following names are defined for this attribute: ACTION_OWNER or TSKOWNR (warehousename), Action Owner (caption), Action_Owner (attribute name), and TSKOWNR (column name).

Action Results attributeThe output that is produced by running the action. The type is string.

The following names are defined for this attribute: ACTION_RESULTS or TSKOUTP (warehousename), Action Results (caption), Action_Results (attribute name), and TSKOUTP (column name).

Action Status attributeThe return code from the Action Status dialog, which is the return code category that is definedfor the application return code. The type is integer (32-bit numeric property) with enumeratedvalues. The following values are defined: OK (0), NOT APPLICABLE (1), GENERAL ERROR (2),WARNING (3), NOT RUNNING (4), DEPENDENT NOT RUNNING (5), ALREADY RUNNING(6), PREREQ NOT RUNNING (7), TIMED OUT (8), DOESNT EXIST (9), UNKNOWN (10),DEPENDENT STILL RUNNING (11), INSUFFICIENT USER AUTHORITY (12). Any value thatdoes not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: ACTION_STATUS or TSKSTAT (warehousename), Action Status (caption), Action_Status (attribute name), and TSKSTAT (column name).

Action Subnode attributeThe subnode where the action ran. The type is string.

The following names are defined for this attribute: ACTION_SUBNODE or TSKSBND (warehousename), Action Subnode (caption), Action_Subnode (attribute name), and TSKSBND (columnname).

Action Type attributeThe type of the action. The type is integer (32-bit numeric property) with enumerated values. Thefollowing values are defined: UNKNOWN (0), AUTOMATION (1). Any value that does not havea definition here is displayed in the User Interface.

The following names are defined for this attribute: ACTION_TYPE or TSKTYPE (warehousename), Action Type (caption), Action_Type (attribute name), and TSKTYPE (column name).



Timestamp attributeThe time the event was generated. The type is string.


Thread Pool Status attribute group or data setThe Thread Pool Status attribute group contains information that reflects the status of the internal threadpool used to collect data asynchronously. This attribute group or data set is eligible for use with TivoliData Warehouse.

This attribute group or data set contains the following attributes:Node attribute

The managed system name of the agent. This attribute is a key attribute. The type is string.



Thread Pool Active Threads attributeThe number of threads in the thread pool currently active doing work. The type is integer (32-bitgauge) with enumerated values. The following values are defined: NO DATA (-1), NO DATA(-100). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_ACTIVE_THREADS orTPACTTH (warehouse name), Thread Pool Active Threads (caption),Thread_Pool_Active_Threads (attribute name), and TPACTTH (column name).

Thread Pool Avg Active Threads attributeThe average number of threads in the thread pool simultaneously active doing work. The type isreal number (32-bit gauge) with two decimal places of precision with enumerated values. Thefollowing values are defined: NO DATA (-1), NO DATA (-100). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_AVG_ACTIVE_THREADS orTPAVGAT (warehouse name), Thread Pool Avg Active Threads (caption),Thread_Pool_Avg_Active_Threads (attribute name), and TPAVGAT (column name).

Thread Pool Avg Job Wait attributeThe average time a job spends waiting on the thread pool queue in seconds. The type is realnumber (32-bit gauge) with two decimal places of precision with enumerated values. Thefollowing values are defined: NO DATA (-1), NO DATA (-100). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_AVG_JOB_WAIT orTPAVJBW (warehouse name), Thread Pool Avg Job Wait (caption), Thread_Pool_Avg_Job_Wait(attribute name), and TPAVJBW (column name).

Thread Pool Avg Queue Length attributeThe average length of the thread pool queue during this run. The type is real number (32-bitgauge) with two decimal places of precision with enumerated values. The following values aredefined: NO DATA (-1), NO DATA (-100). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_AVG_QUEUE_LENGTH orTPAVGQL (warehouse name), Thread Pool Avg Queue Length (caption),Thread_Pool_Avg_Queue_Length (attribute name), and TPAVGQL (column name).

Thread Pool Max Active Threads attributeThe peak number of threads in the thread pool that were simultaneously active doing work. Thetype is integer (32-bit counter) with enumerated values. The following values are defined: NODATA (-1), NO DATA (-100). Any value that does not have a definition here is displayed in theUser Interface.

The following names are defined for this attribute: THREAD_POOL_MAX_ACTIVE_THREADSor TPMAXAT (warehouse name), Thread Pool Max Active Threads (caption),Thread_Pool_Max_Active_Threads (attribute name), and TPMAXAT (column name).

Thread Pool Max Queue Length attributeThe peak length the thread pool queue reached. The type is integer (32-bit counter) withenumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_MAX_QUEUE_LENGTH orTPMAXQL (warehouse name), Thread Pool Max Queue Length (caption),Thread_Pool_Max_Queue_Length (attribute name), and TPMAXQL (column name).

Thread Pool Max Size attributeThe maximum number of threads that are allowed to exist in the thread pool. The type is integer(32-bit numeric property) with enumerated values. The following values are defined: NO DATA(-1), NO DATA (-100). Any value that does not have a definition here is displayed in the UserInterface.


The following names are defined for this attribute: THREAD_POOL_MAX_SIZE or TPMAXSZ(warehouse name), Thread Pool Max Size (caption), Thread_Pool_Max_Size (attribute name), andTPMAXSZ (column name).

Thread Pool Min Active Threads attributeThe smallest number of threads in the thread pool that were simultaneously active doing work.The type is integer (32-bit counter) with enumerated values. The following values are defined:NO DATA (-1), NO DATA (-100). Any value that does not have a definition here is displayed inthe User Interface.

The following names are defined for this attribute: THREAD_POOL_MIN_ACTIVE_THREADS orTPMINAT (warehouse name), Thread Pool Min Active Threads (caption),Thread_Pool_Min_Active_Threads (attribute name), and TPMINAT (column name).

Thread Pool Min Queue Length attributeThe minimum length the thread pool queue reached. The type is integer (32-bit counter) withenumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_MIN_QUEUE_LENGTH orTPMINQL (warehouse name), Thread Pool Min Queue Length (caption),Thread_Pool_Min_Queue_Length (attribute name), and TPMINQL (column name).

Thread Pool Queue Length attributeThe number of jobs currently waiting in the thread pool queue. The type is integer (32-bit gauge)with enumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_QUEUE_LENGTH orTPQLGTH (warehouse name), Thread Pool Queue Length (caption), Thread_Pool_Queue_Length(attribute name), and TPQLGTH (column name).

Thread Pool Size attributeThe number of threads currently existing in the thread pool. The type is integer (32-bit gauge)with enumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_SIZE or THPSIZE(warehouse name), Thread Pool Size (caption), Thread_Pool_Size (attribute name), and THPSIZE(column name).

Thread Pool Total Jobs attributeThe number of jobs that are completed by all threads in the pool since agent start. The type isinteger (32-bit counter) with enumerated values. The following values are defined: NO DATA (-1),NO DATA (-100). Any value that does not have a definition here is displayed in the UserInterface.

The following names are defined for this attribute: THREAD_POOL_TOTAL_JOBS or TPTJOBS(warehouse name), Thread Pool Total Jobs (caption), Thread_Pool_Total_Jobs (attribute name),and TPTJOBS (column name).



VM Details attribute group or data setThe virtual machine instances This attribute group or data set is eligible for use with Tivoli DataWarehouse.

This attribute group or data set contains the following attributes:Availability Zone attribute

The availability zone of the virtual machine instance The type is string.


The following names are defined for this attribute: AVAILABILITY_ZONE or ZONE (warehousename), Availability Zone (caption), Availability_Zone (attribute name), and ZONE (column name).

Created Time attributeThe virtual machine instance created time The type is string.

The following names are defined for this attribute: CREATED_TIME or CRT_TIME (warehousename), Created Time (caption), Created_Time (attribute name), and CRT_TIME (column name).

Flavor attributeThe flavor that is referenced by virtual machine instance The type is string.

The following names are defined for this attribute: FLAVOR (warehouse name), Flavor (caption),Flavor (attribute name), and FLAVOR (column name).

Host attributeThe host where the virtual machine instance is running on The type is string.

The following names are defined for this attribute: HOST (warehouse name), Host (caption), Host(attribute name), and HOST (column name).

Hypervisor Hostname attributeThe hypervisor host name The type is string.

The following names are defined for this attribute: HYPERVISOR_HOSTNAME or HPVHOST(warehouse name), Hypervisor Hostname (caption), Hypervisor_Hostname (attribute name), andHPVHOST (column name).

Image attributeThe image used by virtual machine instance The type is string.

The following names are defined for this attribute: IMAGE (warehouse name), Image (caption),Image (attribute name), and IMAGE (column name).

Instance ID attributeThe virtual machine instance ID This attribute is a key attribute. The type is string.

The following names are defined for this attribute: INSTANCE_ID or INS_ID (warehouse name),Instance ID (caption), Instance_ID (attribute name), and INS_ID (column name).

Instance Name attributeThe virtual machine instance name The type is string.

The following names are defined for this attribute: INSTANCE_NAME or INS_NAME(warehouse name), Instance Name (caption), Instance_Name (attribute name), and INS_NAME(column name).

IP Addresses attributeThe virtual machine instance IP addresses The type is string.

The following names are defined for this attribute: IP_ADDRESSES or IP_ADDR (warehousename), IP Addresses (caption), IP_Addresses (attribute name), and IP_ADDR (column name).

IP Key attributeThe selected instance ip addresses The type is string.

The following names are defined for this attribute: IP_KEY or IPKEY (warehouse name), IP Key(caption), IP_Key (attribute name), and IPKEY (column name).

Key Name attributeThe key pair name which is used to access the virtual machine The type is string.

The following names are defined for this attribute: KEY_NAME or KEYNAME (warehousename), Key Name (caption), Key_Name (attribute name), and KEYNAME (column name).



Launched Time attributeThe virtual machine instance launched time The type is string.


The following names are defined for this attribute: LAUNCHED_TIME or LAU_TIME (warehousename), Launched Time (caption), Launched_Time (attribute name), and LAU_TIME (columnname).

Name attributeThe virtual machine instance display name The type is string.

The following names are defined for this attribute: NAME (warehouse name), Name (caption),Name (attribute name), and NAME (column name).





Status attributeThe virtual machine instance status The type is string.

The following names are defined for this attribute: STATUS or VM_STATUS (warehouse name),Status (caption), Status (attribute name), and VM_STATUS (column name).

Tenant attributeThe tenant to which the virtual machine instance belongs The type is string.


Tenant ID attributeThe tenant ID which the virtual machine instance belongs to The type is string.

The following names are defined for this attribute: TENANT_ID or TENID (warehouse name),Tenant ID (caption), Tenant_ID (attribute name), and TENID (column name).



Update Time attributeThe virtual machine updated time The type is string.

The following names are defined for this attribute: UPDATE_TIME or UPD_TIME (warehousename), Update Time (caption), Update_Time (attribute name), and UPD_TIME (column name).

User attributeThe user who created this virtual machine instance The type is string.

The following names are defined for this attribute: USER_NAME or USERNAME (warehousename), User (caption), User_Name (attribute name), and USERNAME (column name).

User Email attributeThe email address of the virtual machine creator The type is string.

The following names are defined for this attribute: USER_EMAIL or EMAIL (warehouse name),User Email (caption), User_Email (attribute name), and EMAIL (column name).

User ID attributeThe user ID who created this virtual machine instance The type is string.

The following names are defined for this attribute: USER_ID (warehouse name), User ID(caption), User_ID (attribute name), and USER_ID (column name).


Volumes attribute group or data setThe volumes information This attribute group or data set is eligible for use with Tivoli Data Warehouse.

This attribute group or data set contains the following attributes:Attachments attribute

The volume attachments information The type is string.

The following names are defined for this attribute: ATTACHMENTS or ATTACHS (warehousename), Attachments (caption), Attachments (attribute name), and ATTACHS (column name).

Availability Zone attributeThe availability zone of the volume The type is string.

The following names are defined for this attribute: AVAILABILITY_ZONE or ZONE (warehousename), Availability Zone (caption), Availability_Zone (attribute name), and ZONE (column name).

Bootable attributeThis attribute shows whether the volume is bootable or not The type is string.

The following names are defined for this attribute: BOOTABLE (warehouse name), Bootable(caption), Bootable (attribute name), and BOOTABLE (column name).

Encrypted attributeThis attribute shows whether the volume is encrypted or not The type is string.

The following names are defined for this attribute: ENCRYPTED (warehouse name), Encrypted(caption), Encrypted (attribute name), and ENCRYPTED (column name).

Host attributeThe host on which the volume is created The type is string.

The following names are defined for this attribute: HOST (warehouse name), Host (caption), Host(attribute name), and HOST (column name).



Metadata attributeThe volume metadata The type is string.

The following names are defined for this attribute: METADATA (warehouse name), Metadata(caption), Metadata (attribute name), and METADATA (column name).



Project attributeThe project to which the volume belongs The type is string.

The following names are defined for this attribute: PROJECT (warehouse name), Project (caption),Project (attribute name), and PROJECT (column name).

Project ID attributeThe project ID which the volume belongs to This attribute is a key attribute. The type is string.

The following names are defined for this attribute: PROJECT_ID or PROID (warehouse name),Project ID (caption), Project_ID (attribute name), and PROID (column name).




Size (GB) attributeThe volume size (GB) The type is integer (32-bit gauge).

The following names are defined for this attribute: SIZE (warehouse name), Size (GB) (caption),Size (attribute name), and SIZE (column name).

Status attributeThe volume status The type is string.




Type attributeThe volume type The type is string.

The following names are defined for this attribute: TYPE (warehouse name), Type (caption), Type(attribute name), and TYPE (column name).

Volume ID attributeThe volume ID This attribute is a key attribute. The type is string.

The following names are defined for this attribute: VOLUME_ID (warehouse name), Volume ID(caption), Volume_ID (attribute name), and VOLUME_ID (column name).

Volume Name attributeThe volume display name The type is string.

The following names are defined for this attribute: VOLUME_NAME or VOL_NAME (warehousename), Volume Name (caption), Volume_Name (attribute name), and VOL_NAME (columnname).

SituationsA situation is a logical expression involving one or more system conditions. Situations are used tomonitor the condition of systems in your network. You can manage situations from the Tivoli EnterprisePortal by using the Situation Editor or from the command-line interface using the tacmd commands forsituations. You can manage private situations in the private configuration XML file.

About situations

The monitoring agents that you use to monitor your system environment include a set of predefinedsituations that you can use as-is. You can also create new situations to meet your requirements.

Predefined situations contain attributes that check for system conditions common to many enterprises.Using predefined situations can improve the speed with which you can begin using the MonitoringAgent for OpenStack. You can change the conditions or values being monitored by a predefined situationto the conditions or values best suited to your enterprise.

You can display predefined situations and create your own situations using the Situation editor. TheSituation editor initially lists the situations associated with the navigator item that you selected. Whenyou click a situation name or create a situation, a panel opens with the following tabs:

FormulaFormula describing the condition being tested.

DistributionList of managed systems (operating systems, subsystems, or applications) to which the situationcan be distributed. All the OpenStack agent managed systems are assigned by default.


Expert adviceComments and instructions to be read in the event workspace.

ActionCommand to be sent to the system.

EIF Customize forwarding of the event to an Event Integration Facility receiver. (Available when theTivoli Enterprise Monitoring Server is configured to forward events.)

Until Options to close the event after a period of time, or when another situation becomes true.

Additional information about situations

The Tivoli Enterprise Portal User's Guide contains more information about predefined and customsituations and how to use them to respond to alerts.

For a list of the predefined situations and information about each individual situation for this monitoringagent, see “Predefined situations.”

Predefined situationsThe monitoring agent contains predefined situations.v KSG_APIEndpoint_Unavailablev KSG_Hyperv_Memory_High_Criv KSG_Hyperv_Memory_High_Warnv KSG_Hyperv_Storage_High_Criv KSG_Hyperv_Storage_High_Warnv KSG_Hyperv_vCPU_High_Criv KSG_Hyperv_vCPU_High_Warnv KSG_Keystone_Unreachable

Descriptions and formulasYou can use predefined situations immediately to monitor your environment. You can also createcustomized situations that test for certain conditions and raise an event when key attributes exceed thethreshold.

KSG_APIEndpoint_UnavailableThe API Endpoint is unavailable. Check the return code of this API Endpoint. The defaultconfiguration has the following SQL syntax:*IF *VALUE KSG_API_DETAILS.Status *EQ Unavailable

This situation is evaluated every 5 minutes.

This situation is automatically distributed to instances of this agent.

KSG_Hyperv_Memory_High_CriThe used memory percentage of the hypervisor has exceeded 150%. Consider adding memory tothe hypervisor. The default configuration has the following SQL syntax:*IF *VALUE KSG_HYPERVISORS.Used_Memory_Percent *GT 150

This situation is evaluated every 5 minutes 5 seconds.


KSG_Hyperv_Memory_High_WarnThe used memory percentage of the hypervisor has exceeded 100%. Consider adding memory tothe hypervisor. The default configuration has the following SQL syntax:*IF *VALUE KSG_HYPERVISORS.Used_Memory_Percent *GT 100 *AND*VALUE KSG_HYPERVISORS.Used_Memory_Percent *LE 150




KSG_Hyperv_Storage_High_CriThe used local file system storage percentage of the hypervisor has exceeded 90%. Considerenlarging the local file system storage. The default configuration has the following SQL syntax:*IF *VALUE KSG_HYPERVISORS.Used_Storage_Percent *GT 90



KSG_Hyperv_Storage_High_WarnThe used local file system storage percentage of the hypervisor has exceeded 80%. Considerenlarging the local file system storage. The default configuration has the following SQL syntax:*IF *VALUE KSG_HYPERVISORS.Used_Storage_Percent *GT 80 *AND*VALUE KSG_HYPERVISORS.Used_Storage_Percent *LE 90



KSG_Hyperv_vCPU_High_CriThe used vCPU percentage of the hypervisor has exceeded 1500%. Consider adding more vCPUs.The default configuration has the following SQL syntax:*IF *VALUE KSG_HYPERVISORS.Used_vCPU_Percent *GT 1500



KSG_Hyperv_vCPU_High_WarnThe used vCPU percentage of the hypervisor has exceeded 1000%. Consider adding more vCPUs.The default configuration has the following SQL syntax:*IF *VALUE KSG_HYPERVISORS.Used_vCPU_Percent *GT 1000 *AND*VALUE KSG_HYPERVISORS.Used_vCPU_Percent *LE 1500



KSG_Keystone_UnreachableUnable to connect to Keystone service. Check the status of Keystone service. The defaultconfiguration has the following SQL syntax:*IF *VALUE KSG_API_DETAILS.Status *EQ Unreachable




Notices

This information was developed for products and services offered in the U.S.A. IBM may not offer theproducts, services, or features discussed in this document in other countries. Consult your local IBMrepresentative for information on the products and services currently available in your area. Anyreference to an IBM product, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product, program, or service thatdoes not infringe any IBM intellectual property right may be used instead. However, it is the user'sresponsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in thisdocument. The furnishing of this document does not give you any license to these patents. You can sendlicense inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual PropertyDepartment in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where suchprovisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION “AS IS”WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore,this statement might not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodicallymade to the information herein; these changes will be incorporated in new editions of the publication.IBM may make improvements and/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not inany manner serve as an endorsement of those Web sites. The materials at those Web sites are not part ofthe materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate withoutincurring any obligation to you.


Licensees of this program who wish to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including thisone) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some casespayment of a fee.

The licensed program described in this document and all licensed material available for it are providedby IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement orany equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, theresults obtained in other operating environments may vary significantly. Some measurements may havebeen made on development-level systems and there is no guarantee that these measurements will be thesame on generally available systems. Furthermore, some measurement may have been estimated throughextrapolation. Actual results may vary. Users of this document should verify the applicable data for theirspecific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related to non-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to the suppliers ofthose products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal withoutnotice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change withoutnotice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before theproducts described become available.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to the names and addresses used by anactual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programmingtechniques on various operating platforms. You may copy, modify, and distribute these sample programsin any form without payment to IBM, for the purposes of developing, using, marketing or distributingapplication programs conforming to the application programming interface for the operating platform forwhich the sample programs are written. These examples have not been thoroughly tested under allconditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of theseprograms. You may copy, modify, and distribute these sample programs in any form without payment toIBM for the purposes of developing, using, marketing, or distributing application programs conformingto IBM‘s application programming interfaces.


Each copy or any portion of these sample programs or any derivative work, must include a copyrightnotice as follows:

© IBM 2009. Portions of this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp.2009. All rights reserved.

If you are viewing this information in softcopy form, the photographs and color illustrations might not bedisplayed.

TrademarksIBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of International BusinessMachines Corp., registered in many jurisdictions worldwide. Other product and service names might betrademarks of IBM or other companies. A current list of IBM trademarks is available on the web atCopyright and trademark information (www.ibm.com/legal/copytrade.shtml).

Intel, Intel logo, and Intel Xeon, are trademarks or registered trademarks of Intel Corporation or itssubsidiaries in the United States and other countries.

Java™ and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, orboth.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Other company, product, or service names may be trademarks or service marks of others.

Privacy policy considerationsIBM Software products, including software as a service solutions, (“Software Offerings”) may use cookiesor other technologies to collect product usage information, to help improve the end user experience, totailor interactions with the end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offerings can help enable you tocollect personally identifiable information. If this Software Offering uses cookies to collect personallyidentifiable information, specific information about this offering’s use of cookies is set forth below.

Depending upon the configurations deployed, this Software Offering may use session cookies that collecteach user’s user name for purposes of session management, authentication, and single sign-onconfiguration. These cookies cannot be disabled.

If the configurations deployed for this Software Offering provide you as customer the ability to collectpersonally identifiable information from end users via cookies and other technologies, you should seekyour own legal advice about any laws applicable to such data collection, including any requirements fornotice and consent.

Notices 61

http://www.ibm.com/legal/copytrade.shtml

For more information about the use of various technologies, including cookies, for these purposes, SeeIBM’s Privacy Policy at http://www.ibm.com/privacy and IBM’s Online Privacy Statement athttp://www.ibm.com/privacy/details the section entitled “Cookies, Web Beacons and OtherTechnologies” and the “IBM Software Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.


http://www.ibm.com/privacy

http://www.ibm.com/privacy/details

http://www.ibm.com/software/info/product-privacy

Index

AAccept Ranges attribute 38, 39Action App Return Code attribute 48Action Command attribute 48Action ID attribute 48Action Instance attribute 48Action Message attribute 48Action Name attribute 48Action Node attribute 49Action Owner attribute 49Action Results attribute 49Action Status attribute 49Action Subnode attribute 49Action Type attribute 49Active Instances attribute 32, 46additional information

attributes 28situations 55Workspaces 23

agent 19agent configuration 13agent installation failed 21agent instance name 20agent instance node 20agent name incorrect 21agent uninstall 17Allocated Floating IP Count attribute 46API Endpoint Details attribute group 31API Endpoint Details data set 31API Endpoint Detecting Failure Percent attribute 31API Endpoint Detecting Failure Times attribute 31API Endpoint Detecting Status Code attribute 31API Endpoint Detecting Times attribute 31API Endpoints attribute group 32API Endpoints data set 32API Endpoints Details workspace 24API Endpoints workspace 24Attachments attribute 54attribute group 30attribute groups

API Endpoint Details 31API Endpoints 32Environment Summary 32Flavors 35Hypervisors 36list of all 29Object Containers 38Object Storage Account Statistics 39Objects 40overview 28Performance Object Status 41Process Details 43Processes 45Processes by Host 45Regions 46Take Action Status 48Thread Pool Status 49VM Details 51Volumes 54

attributes 30Accept Ranges 38, 39

attributes (continued)Action App Return Code 48Action Command 48Action ID 48Action Instance 48Action Message 48Action Name 48Action Node 49Action Owner 49Action Results 49Action Status 49Action Subnode 49Action Type 49Active Instances 32, 46additional information 28Allocated Floating IP Count 46API Endpoint Details 31API Endpoint Detecting Failure Percent 31API Endpoint Detecting Failure Times 31API Endpoint Detecting Status Code 31API Endpoint Detecting Times 31API Endpoints 32Attachments 54Availability Zone 51, 54Available API Endpoints 32, 33Average Collection Duration 41Bootable 54Bytes 40Cache Hit Percent 41Cache Hits 41Cache Misses 41Component Name 44, 45Component Process Count 45Container Count 39Container Name 38, 40Content Type 38, 39, 40CPU Architecture 36CPU Model 36CPU Usage(%) 44CPU Vendor 36Created Time 52Encrypted 54Environment Summary 32Ephemeral Disk (GB) 35Error Code 41Flavor 52Flavor ID 35Flavor Name 35Flavors 35Floating IP Quota 46Host 52, 54Host IP 36, 44Host Name 44, 45Host Process Count 45Hypervisor Hostname 36, 52Hypervisor ID 37Hypervisor Type 37Hypervisor Version 37Hypervisors 36Image 52Inactive Instances 33, 46


attributes (continued)Instance ID 52Instance Name 52Intervals Skipped 42IP Addresses 52IP Key 52Is Public 35Key Name 52Keystone Host 31, 32, 33, 35, 37, 39, 40, 44, 45, 46, 52, 54Last Collection Duration 42Last Collection Finished 42Last Collection Start 42Last Modified 40Launched Time 52Local Storage Size (TB) 37Memory (MB) 35Memory Usage(%) 44Metadata 54Name 53Node 31, 32, 33, 35, 37, 39, 40, 43, 44, 45, 46, 49, 53, 54Number of Collections 43Object Containers 38Object Count 39, 40Object Name 41, 43Object Status 43Object Storage Account Statistics 39Object Type 43Objects 40overview 28Performance Object Status 41pid 44ppid 44Process Details 43Process Name 44Processes 45Processes by Host 45Project 54Project ID 54Public URL 31Query Name 43Reference Count 35Refresh Interval 43Region Count (Critical File System Storage Usage) 33Region Count (Critical Floating IP Quota Usage) 33Region Count (Critical Memory Usage) 33Region Count (Critical vCPU Usage) 33Region Count (Normal File System Storage Usage) 33Region Count (Normal Floating IP Quota Usage) 34Region Count (Normal Memory Usage) 34Region Count (Normal vCPU Usage) 34Region Count (Warning File System Storage Usage) 34Region Count (Warning Floating IP Quota Usage) 34Region Count (Warning Memory Usage) 34Region Count (Warning vCPU Usage) 34Region Name 31, 36, 37, 47, 53, 54Regions 46Root Disk (GB) 36Running Processes 34Running VMs 37Service Host 37Service Type 31, 32Size (GB) 55Start Time 44Status 32, 45, 53, 55Swap Disk (MB) 36Take Action Status 48Tenant 34, 39, 40, 41, 53

attributes (continued)Tenant ID 53Thread Pool Active Threads 50Thread Pool Avg Active Threads 50Thread Pool Avg Job Wait 50Thread Pool Avg Queue Length 50Thread Pool Max Active Threads 50Thread Pool Max Queue Length 50Thread Pool Max Size 50Thread Pool Min Active Threads 51Thread Pool Min Queue Length 51Thread Pool Queue Length 51Thread Pool Size 51Thread Pool Status 49Thread Pool Total Jobs 51Timestamp 32, 35, 36, 37, 39, 40, 41, 43, 45, 46, 47, 49, 51,

53, 55Total File System Storage Size (TB) 47Total Floating IP Count 47Total Instances 47Total Memory Size (GB) 37, 47Total vCPU Count 38Total vCPUs 47Type 55Unavailable API Endpoints 32, 35Update Time 53Used Bytes 39, 40Used File System Storage Percent 47Used File System Storage Size (TB) 47Used Floating IP Quota Percent 47Used Memory Percent 38, 47Used Memory Size (GB) 38, 48Used Storage Percent 38Used Storage Size (TB) 38Used vCPU Count 38Used vCPU Percent 38, 48Used vCPUs 48User 53User Email 53User ID 53vCPU Count 36VM Details 51Volume ID 55Volume Name 55Volumes 54

Availability Zone attribute 51, 54Available API Endpoints attribute 32, 33Average Collection Duration attribute 41

BBootable attribute 54Bytes attribute 40

CCache Hit Percent attribute 41Cache Hits attribute 41Cache Misses attribute 41cannot install 20cinfo command 7clear the agent information 18Component Name attribute 44, 45Component Process Count attribute 45configuration 13, 15configure 13, 15


configure the agent 13configure the data collector 15configuring the agent 13configuring the agent data collector 15connect 19Container Count attribute 39Container Name attribute 38, 40Content Type attribute 38, 39, 40cookies 61CPU Architecture attribute 36CPU Model attribute 36CPU Usage(%) attribute 44CPU Vendor attribute 36Created Time attribute 52

Ddata collector configuration 15data set

attributes 30data sets

API Endpoint Details 31API Endpoints 32Environment Summary 32Flavors 35Hypervisors 36list of all 29Object Containers 38Object Storage Account Statistics 39Objects 40Performance Object Status 41Process Details 43Processes 45Processes by Host 45Regions 46Take Action Status 48Thread Pool Status 49VM Details 51Volumes 54

delay 20descriptions 56domain name 19duplicate instance names 20

EEncrypted attribute 54Environment Summary attribute group 32Environment Summary data set 32Environment Summary workspace 25Ephemeral Disk (GB) attribute 35Error Code attribute 41error code: 4 21error code: 99 21

FFlavor attribute 52Flavor ID attribute 35Flavor Name attribute 35Flavors attribute group 35Flavors data set 35Flavors workspace 25Floating IP Quota attribute 46

HHost attribute 52, 54Host IP attribute 36, 44Host Name attribute 44, 45Host Process Count attribute 45Hypervisor Hostname attribute 36, 52Hypervisor ID attribute 37Hypervisor Type attribute 37Hypervisor Version attribute 37Hypervisors attribute group 36Hypervisors data set 36Hypervisors workspace 25

IImage attribute 52Inactive Instances attribute 33, 46install 5, 20install fail 20, 21install self-describing agent 9installation 5installation failed 20Instance ID attribute 52Instance Name attribute 52Intervals Skipped attribute 42Introduction 1IP Addresses attribute 52IP Key attribute 52Is Public attribute 35

JJRE level 21

KKey Name attribute 52Keystone Host attribute 31, 32, 33, 35, 37, 39, 40, 44, 45, 46,

52, 54

LLast Collection Duration attribute 42Last Collection Finished attribute 42Last Collection Start attribute 42Last Modified attribute 40Launched Time attribute 52Local Storage Size (TB) attribute 37

Mmanaged system name 22Memory (MB) attribute 35Memory Usage(%) attribute 44Metadata attribute 54monitoring data 20

NName attribute 53name string 21Node attribute 31, 32, 33, 35, 37, 39, 40, 43, 44, 45, 46, 49, 53,

54Number of Collections attribute 43

Index 65

OObject Containers attribute group 38Object Containers data set 38Object Containers workspace 26Object Count attribute 39, 40Object Name attribute 41, 43Object Status attribute 43Object Storage Account Statistics attribute group 39Object Storage Account Statistics data set 39Object Storage Account Statistics workspace 26Object Type attribute 43Objects attribute group 40Objects data set 40Objects workspace 26OpenStack

workspacesdescriptions 24

openstack components 19OpenStack workspace 24

PPerformance Object Status attribute group 41Performance Object Status data set 41pid attribute 44ppid attribute 44prerequisite, software 3privacy policy 61Process Details attribute group 43Process Details data set 43Process Details workspace 26Process Name attribute 44Processes attribute group 45Processes by Host attribute group 45Processes by Host data set 45Processes data set 45Processes workspace 27proddsc.tbl 7Project attribute 54Project ID attribute 54Public URL attribute 31

Qqueries, using attributes 28Query Name attribute 43

RRedhat 7 21Reference Count attribute 35Refresh Interval attribute 43Region Count (Critical File System Storage Usage)

attribute 33Region Count (Critical Floating IP Quota Usage) attribute 33Region Count (Critical Memory Usage) attribute 33Region Count (Critical vCPU Usage) attribute 33Region Count (Normal File System Storage Usage)

attribute 33Region Count (Normal Floating IP Quota Usage) attribute 34Region Count (Normal Memory Usage) attribute 34Region Count (Normal vCPU Usage) attribute 34Region Count (Warning File System Storage Usage)

attribute 34

Region Count (Warning Floating IP Quota Usage)attribute 34

Region Count (Warning Memory Usage) attribute 34Region Count (Warning vCPU Usage) attribute 34Region Name attribute 31, 36, 37, 47, 53, 54Regions attribute group 46Regions data set 46Regions workspace 27remote configuration fails 22remote installation fails 22remove agent from TEP 18Root Disk (GB) attribute 36Running Processes attribute 34Running VMs attribute 37

Ssame directory as OS agent 21self-describing agent installation 9Service Host attribute 37Service Type attribute 31, 32situations 56

additional informationpredefined, defined 55

overview 55predefined 56Situation Editor 55

situations, using attributes 28Size (GB) attribute 55Software prerequisite 3SSH connection 15Start Time attribute 44Status attribute 32, 45, 53, 55support 10support files 10support files uninstall 17Swap Disk (MB) attribute 36

TTake Action Status attribute group 48Take Action Status data set 48Tenant attribute 34, 39, 40, 41, 53Tenant ID attribute 53Thread Pool Active Threads attribute 50Thread Pool Avg Active Threads attribute 50Thread Pool Avg Job Wait attribute 50Thread Pool Avg Queue Length attribute 50Thread Pool Max Active Threads attribute 50Thread Pool Max Queue Length attribute 50Thread Pool Max Size attribute 50Thread Pool Min Active Threads attribute 51Thread Pool Min Queue Length attribute 51Thread Pool Queue Length attribute 51Thread Pool Size attribute 51Thread Pool Status attribute group 49Thread Pool Status data set 49Thread Pool Total Jobs attribute 51Timestamp attribute 32, 35, 36, 37, 39, 40, 41, 43, 45, 46, 47,

49, 51, 53, 55Tivoli Enterprise Monitoring Server support 10Tivoli Enterprise Portal desktop client support 11Tivoli Enterprise Portal Server support 11Total File System Storage Size (TB) attribute 47Total Floating IP Count attribute 47Total Instances attribute 47


Total Memory Size (GB) attribute 37, 47Total vCPU Count attribute 38Total vCPUs attribute 47troubleshoot 19troubleshooting 19truncate 20Type attribute 55

UUnavailable API Endpoints attribute 32, 35uninstall 17uninstall the agent 17uninstall the support files 17uninstalling 17uninstalling the agent 17uninstalling the support files 17Update Time attribute 53Used Bytes attribute 39, 40Used File System Storage Percent attribute 47Used File System Storage Size (TB) attribute 47Used Floating IP Quota Percent attribute 47Used Memory Percent attribute 38, 47Used Memory Size (GB) attribute 38, 48Used Storage Percent attribute 38Used Storage Size (TB) attribute 38Used vCPU Count attribute 38Used vCPU Percent attribute 38, 48Used vCPUs attribute 48User attribute 53User Email attribute 53User ID attribute 53

VvCPU Count attribute 36views

API Endpoints Details workspace 24API Endpoints workspace 24Environment Summary workspace 25Flavors workspace 25Hypervisors workspace 25Object Containers workspace 26Object Storage Account Statistics workspace 26Objects workspace 26OpenStack workspace 24Process Details workspace 26Processes workspace 27Regions workspace 27Virtual Machines workspace 28Volumes workspace 28

Virtual Machines workspace 28VM Details attribute group 51VM Details data set 51Volume ID attribute 55Volume Name attribute 55Volumes attribute group 54Volumes data set 54Volumes workspace 28

Wworkspaces

API Endpoints 24API Endpoints Details 24descriptions 24

workspaces (continued)Environment Summary 25Flavors 25Hypervisors 25Object Containers 26Object Storage Account Statistics 26Objects 26OpenStack 24predefined 23Process Details 26Processes 27Regions 27Virtual Machines 28Volumes 28

Workspacesadditional information 23overview 23

Index 67

��

Printed in USA

monitoring agent for openstack reference -...

Documents