vCenter Operations Management Pack for ITM Installation ......7 1 Introduction to the Management Pack for ITM The Management Pack for IBM Tivoli Monitoring (ITM) is an embedded adapter

vCenter Operations Management Pack for ITM Installation and Configuration Guide

This document supports the version of each product listed and supports all subsequent versions until a new edition replaces the document. To check for more recent editions of this document, see http://support.bluemedora.com.

http://support.bluemedora.com/


2

You can find the most up-to-date technical documentation on the Blue Medora support site at:

http://support.bluemedora.com

The Blue Medora web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to:

[email protected]

Copyright © 2014 Blue Medora LLC. All rights reserved. U.S. and international copyright and intellectual property laws protect this product.

Blue Medora is a registered trademark or trademark of Blue Medora LLC in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

Blue Medora LLC 3225 N Evergreen Dr. NE STE 103 Grand Rapids, MI 49525 www.bluemedora.com

http://support.bluemedora.com/

mailto:[email protected]?subject=vCenter%20Operations%20Manager%20for%20OEM%20Documentation%20Feedback

http://www.bluemedora.com/

3

Table of Contents vCenter Operations Management Pack for ITM Installation and Configuration Guide ........................ 4

Updated Information ................................................................................................................................. 5

1 Introduction to the Management Pack for ITM .................................................................................. 7 Installation and Configuration Requirements ........................................................................................... 8 Connecting to a Tivoli Enterprise Portal Server (TEPS) via the ITM REST Provider ............................... 10 Discovering Resources ............................................................................................................................... 10 Collecting Data ............................................................................................................................................ 11

2 Installing the Management Pack for ITM .......................................................................................... 12 Install the Management Pack in a Standalone Installation ...................................................................... 12 Install the Management Pack in a vApp Installation ................................................................................ 13 Management Pack for ITM Folders and Files ........................................................................................... 14

3 Configuring the Management Pack for ITM ...................................................................................... 15 Overview of Configuration Steps .............................................................................................................. 15 Add a Credential ......................................................................................................................................... 15 Add an Adapter Instance ........................................................................................................................... 16 Import a Certificate .................................................................................................................................... 17 Configuring Attribute Groups .................................................................................................................... 17

4 Troubleshooting the Management Pack for ITM ..............................................................................19 Troubleshooting an ITM Rest Adapter Instance ....................................................................................... 19 Viewing System Log Files........................................................................................................................... 19 Testing the ITM REST Provider .................................................................................................................. 19 Resolving Common Problems ................................................................................................................... 21


4


The vCenter Operations Management Pack for ITM Installation and Configuration Guide describes how to configure the Management Pack for IBM Tivoli Monitoring (ITM) adapter.

Intended Audience This information is intended for anyone who wants to install or configure the Management Pack for IBM Tivoli Monitoring.

5

Updated Information

The vCenter Operations Management Pack for ITM Installation and Configuration Guide is updated with each release of the product or when necessary.

This table provides the update history of the vCenter Operations Management Pack for ITM Installation and Configuration Guide.

Revision Description REV-04 Replaced complicated configuration files with a single configuration file.

Replaced SOAP queries with REST calls. Added licensing support.

REV-03 Updated name of product to reflect management pack rebranding. Improved instructions on modifying configuration files for vApp installations.

REV-02 Updated library files listed in “Management Pack for ITM Folders and Files,” on page 14.

REV-01 Changed the product name to reflect the new licensing model for the 5.6 release. Added the open_source_license.txt file to “Management Pack for ITM Folders and Files,” on page 14.

REV-00 The vCenter Operations Management Pack for ITM Technical Note is now the vCenter Operations Management Pack for ITM Installation and Configuration Guide. The following technical changes are included in this revision. The topic “Management Pack for ITM Folders and Files,” on page 14 now lists the

file names for the default and instance-specific white and black lists and remote TEMS inclusion and exclusion lists.

The topic “Add an Adapter Instance,” on page 16 now describes the Use SQL over SOAP, White List Groups, and Black List Groups fields.

The topic “Error! Reference source not found.,” on page Error! Bookmark not defined. now describes the MAX_NUM_ORIGINNODE_FILTER_INQUERY and MAX_NUM_ORIGINNODE_FILTER properties.

The topic “Error! Reference source not found.,” on page Error! Bookmark not defined. now describes the predefined mappings in the ITMProducts.txt.

A new topic, “Error! Reference source not found.,” on page Error! Bookmark not defined., describes how to add entries to the ITMProducts.txt file.

A new topic, “Error! Reference source not found.,” on page Error! Bookmark not defined., describes how to configure white and black lists.

A new topic, “Error! Reference source not found.,” on page Error! Bookmark not defined., describes file naming and formatting conventions for the default white and black list files.

A new topic, “Error! Reference source not found.,” on page Error! Bookmark not defined., describes how to create remote TEMS inclusion and exclusion list files.

A new topic, “Error! Reference source not found.,” on page Error! Bookmark not defined., describes file naming and formatting conventions for remote TEMS inclusion and exclusion list files.

A new topic, “Testing the ITM REST Provider,” on page 19, explains how to test a SOAP request for the ITM adapter.


6

The vCenter Operations Management Pack for ITM Technical Note was the initial release of this document.

7

1 Introduction to the Management Pack for ITM

The Management Pack for IBM Tivoli Monitoring (ITM) is an embedded adapter for vCenter Operations Manager. ITM manages system and network applications and monitors the performance of an enterprise system. The ITM Rest Adapter retrieves performance metrics that ITM collects. The adapter does not retrieve situations or change events.

This chapter includes the following topics:

”Installation and Configuration Requirements,” on page 8

“Installation and Configuration Requirements

The ITM Rest Adapter has certain installation and configuration requirements.

Compatible ITM Versions

The ITM Rest Adapter has been tested against the following ITM versions. ITM v6.3.0 or later is recommended due to improvements in the REST provider.

REST Provider Version ITM Versions Notes 1.2.2 6.2.3 FP 1

6.2.3 FP2 6.2.3 FP3 6.2.3 FP4

REST v1.2.2 does not support instanced attribute groups.

1.3.0 6.3.0 GA 6.3.0 FP1

1.3.1 6.3.0 FP2

Enabling the REST Provider The REST Provider must be enabled on the TEPS for the ITM Rest Adapter to connect. If the TEPS does not have REST turned on, follow these steps:

1. Open “Manage Tivoli Monitoring Services” (MTEMS)

2. Reconfigure the TEPS

3. Check “Enable the dashboard data provider” (ITM 6.3.0 and later) or “Enable ITM REST service” (earlier versions)

4. Restart TEPS

5. Verify that the REST provider has started by opening [TEPS_host]:15210/ITMRESTProvider/test.html in a browser that can connect to the TEPS. Note that it may take several minutes after the TEPS has been restarted for the test page to display. See “Testing the ITM REST Provider” on page 19.


8

Configuring the REST Provider Enabling the REST provider can cause TEPS to run out of memory in the default configuration. To prevent this from happening, increase the TEPS heap size by following these steps:

Calculate the Maximum Heap Size

To calculate the maximum heap size, first determine the ‘base’ memory usage. After enabling the REST provider on the TEPS and running a sample query (See “Testing the ITM REST Provider” on page 19), determine the amount of memory Java is currently using on the TEPS (e.g., using Task Manager on Windows or top on Linux). This is the base memory usage.

Then, add to the base memory usage at least 1GB. The primary driver of memory usage is the number of attribute groups the ITM Rest Adapter will collect. A rough rule of thumb is to add 1GB per 10 attribute groups collected. For example, if the base memory usage is 500MB and 80 attribute groups are set to be collected, set the maximum heap size to 8500MB.

If the heap size is set too small, an OutOfMemory exception and core dump will occur on the TEPS. If this happens, TEPS will need to be restarted, either with a larger heap size, or with the ITM Rest Adapter set to collect fewer attribute groups.

Set the Maximum Heap Size on the TEPS

1. On the TEPS installation, open a command prompt and navigate to: [install_dir]\cnpsj\profiles\ITMProfile\bin (Windows), or [install_dir]/platform/iw/profiles/ITMProfile/bin (Unix, Linux)

2. Start the eWAS console by running the command: wsadmin.bat (Windows), or wsadmin.sh (Unix, Linux)

3. At the prompt, enter the following commands, using the calculated maximum heap size to determine the value for maximumHeapSize (Shown here set to 1.5GB, or 1500MB):

$AdminConfig modify [$AdminConfig list JavaVirtualMachine] "{maximumHeapSize 1500}"

$AdminConfig save

quit

4. Restart TEPS

Connection and Credential Requirements

To query and retrieve metric data, the ITM Rest Adapter requires a user name and password to connect to a TEPS via the ITM REST Provider.

Connecting to a Tivoli Enterprise Portal Server (TEPS) via the ITM REST Provider ,” on page 10

“Discovering Resources,” on page 10

“Collecting Data,” on page 11

Installation and Configuration Requirements

The ITM Rest Adapter has certain installation and configuration requirements.

9

Compatible ITM Versions

The ITM Rest Adapter has been tested against the following ITM versions. ITM v6.3.0 or later is recommended due to improvements in the REST provider.

REST Provider Version ITM Versions Notes 1.2.2 6.2.3 FP 1

6.2.3 FP2 6.2.3 FP3 6.2.3 FP4

REST v1.2.2 does not support instanced attribute groups.

1.3.0 6.3.0 GA 6.3.0 FP1

1.3.1 6.3.0 FP2

Enabling the REST Provider The REST Provider must be enabled on the TEPS for the ITM Rest Adapter to connect. If the TEPS does not have REST turned on, follow these steps:

6. Open “Manage Tivoli Monitoring Services” (MTEMS)

7. Reconfigure the TEPS

8. Check “Enable the dashboard data provider” (ITM 6.3.0 and later) or “Enable ITM REST service” (earlier versions)

9. Restart TEPS

10. Verify that the REST provider has started by opening [TEPS_host]:15210/ITMRESTProvider/test.html in a browser that can connect to the TEPS. Note that it may take several minutes after the TEPS has been restarted for the test page to display. See “Testing the ITM REST Provider” on page 19.

Configuring the REST Provider Enabling the REST provider can cause TEPS to run out of memory1 in the default configuration. To prevent this from happening, increase the TEPS heap size by following these steps:

Calculate the Maximum Heap Size

To calculate the maximum heap size, first determine the ‘base’ memory usage. After enabling the REST provider on the TEPS and running a sample query (See “Testing the ITM REST Provider” on page 19), determine the amount of memory Java is currently using on the TEPS (e.g., using Task Manager on Windows or top on Linux). This is the base memory usage.

Then, add to the base memory usage at least 1GB. The primary driver of memory usage is the number of attribute groups the ITM Rest Adapter will collect. A rough rule of thumb is to add 1GB per 10 attribute groups collected. For example, if the base memory usage is 500MB and 80 attribute groups are set to be collected, set the maximum heap size to 8500MB.

1 http://publib.boulder.ibm.com/infocenter/tivihelp/v61r1/index.jsp?topic=%2Fcom.ibm.itm.doc_6.3%2Ftrouble%2Fteps_tepseheapsize_trouble.htm

http://publib.boulder.ibm.com/infocenter/tivihelp/v61r1/index.jsp?topic=%2Fcom.ibm.itm.doc_6.3%2Ftrouble%2Fteps_tepseheapsize_trouble.htm

http://publib.boulder.ibm.com/infocenter/tivihelp/v61r1/index.jsp?topic=%2Fcom.ibm.itm.doc_6.3%2Ftrouble%2Fteps_tepseheapsize_trouble.htm


10

If the heap size is set too small, an OutOfMemory exception and core dump will occur on the TEPS. If this happens, TEPS will need to be restarted, either with a larger heap size, or with the ITM Rest Adapter set to collect fewer attribute groups.

Set the Maximum Heap Size on the TEPS

5. On the TEPS installation, open a command prompt and navigate to: [install_dir]\cnpsj\profiles\ITMProfile\bin (Windows), or [install_dir]/platform/iw/profiles/ITMProfile/bin (Unix, Linux)

6. Start the eWAS console by running the command: wsadmin.bat (Windows), or wsadmin.sh (Unix, Linux)

7. At the prompt, enter the following commands, using the calculated maximum heap size to determine the value for maximumHeapSize (Shown here set to 1.5GB, or 1500MB):

$AdminConfig modify [$AdminConfig list JavaVirtualMachine] "{maximumHeapSize 1500}"

$AdminConfig save

quit

8. Restart TEPS

Connection and Credential Requirements

To query and retrieve metric data, the ITM Rest Adapter requires a user name and password to connect to a TEPS via the ITM REST Provider.

Connecting to a Tivoli Enterprise Portal Server (TEPS) via the ITM REST Provider

The ITM Rest Adapter connects to a TEPS via the ITM REST Provider over HTTP or HTTPS. The REST Provider host, port, and protocol are specified when adding an adapter instance for the ITM Rest Adapter, and the Test button can be used to verify the connection settings before creating the adapter instance. If a failure is encountered, consult the adapter instance log file for further information. The adapter obtains information through querying the HUB Tivoli Enterprise Monitoring Server via the ITM REST Provider (referred to as “Dashboard data provider” since ITM 6.3) that resides on the TEPS.

Discovering Resources

The ITM Rest Adapter uses the discovery process to identify resources on the TEMS or remote Tivoli Enterprise Monitoring Server. Queries are made to the monitoring server to request a list of all of the monitored agents, their relationship to one another, and metadata about the attribute groups and attributes for each active agent type.

NOTE ITM attribute groups are similar, but not the same as, vCenter Operations Manager attribute packages. An attribute package is a set of attributes (possibly spread across many ITM attribute groups) that are attached to a specific resource (or resources) invCenter Operations Manager. vCenter Operations Manager then discards any attributes from an adapter that are not in the attribute package.

The ITM Rest Adapter can create resources by using either auto-discovery or manual discovery. You enable or disable auto-discovery when you add an adapter instance. Auto-discovery is disabled by default.

11

Collecting Data

After it creates a resource, the ITM Rest Adapter will begin retrieving data for the resource’s attribute groups marked for collection in the configuration file specified during configuration.


12

2 Installing the Management Pack for ITM How you install the Management Pack for ITM depends on whether you have a vCenter Operations Manager Standalone or vApp installation.


“Install the Management Pack in a Standalone Installation,” on page 12

“Install the Management Pack in a vApp Installation,” on page 13

“Management Pack for ITM Folders and Files,” on page 14

Install the Management Pack in a Standalone Installation

If you have a standalone installation, you install the management pack for ITM by extracting installation files from a TGZ file and running an installation utility.

Prerequisites

Obtain the management pack installation file from http://www.bluemedora.com/vcops-trials.

Make a note of the build number in the TGZ file name. The build number appears after the adapter name, for example, adaptername-buildnumber.tgz.

Read the release notes that are included with the TGZ file.

Procedure

1. Open the TGZ file and extract the TAR file to a temporary folder on your vCenter Operations Manager server.

2. In the temporary folder, open the TAR file and extract and run the installer for your operating system platform.

3. Log in to the Custom user interface as an administrator.

4. Select Admin > Support.

5. On the Info tab, find the Adapters Info pane and click the Describe icon ( )

The Describe icon is located at the top right of the Adapters Info pane.

6. Click Yes to start the describe process and click OK.

vCenter Operations Manager gathers information about the abilities of the adapter, and updates the user interface with information about the adapter. If you have remote collectors, it installs the adapter on the remote collectors.

The describe process may take several minutes. When the describe process is finished, the adapter appears in the Adapters Info pane. The build number is in the Adapter Version column.

7. Verify that the build number in the Adapter Version column for the adapter matches the build number in

http://www.bluemedora.com/vcops-trials

13

the TGZ file that you downloaded.

Note: The installer creates the itm_rest_adapter3 folder and itm_rest_adapter3.jar file under the $ALIVE_BASE/user/plugins/inbound/ folder.

Install the Management Pack in a vApp Installation

If you have a vApp installation, you install the ITM Rest Adapter from a PAK file.

Prerequisites

Obtain the adapter installation file from http://www.bluemedora.com/vcops-trials.

Make a note of the build number in the PAK file name. The build number appears after the adapter name, for example, adaptername-buildnumber.pak.

Read the release notes that are included with the PAK file.

Procedure

1. Save the PAK file in a temporary folder.

2. Log in to the Admin user interface as the admin user.

For example: https://ipaddress/admin/

3. On the Update tab, click Browse to locate the temporary folder and select the PAK file.

4. Click Update and click OK to confirm the update.

The Admin user interface uploads the PAK file. The upload might take several minutes.

5. Read and accept the EULA and click OK.

6. Click OK to confirm and start the update process.

The update might take several minutes. Status information appears on the Update tab when the update is finished.


For example: https://ipaddress/vcops-custom/

8. Select Admin > Support.

9. On the Info tab, find the Adapters Info pane and click the Describe icon ( )

The Describe icon is located at the top right of the Adapters Info pane.

10. Click Yes to start the describe process and click OK.

vCenter Operations Manager adds adapter files, gathers information about the abilities of the adapter, and updates the user interface with information about the adapter.

The describe process might take several minutes. When the describe process is finished, the adapter appears in the Adapters Info pane. The build number is in the Adapter Version column.

11. Verify that the build number in the Adapter Version column for the adapter matches the build number in the PAK file that you uploaded.

Note: The installer creates the itm_rest_adapter3 folder and itm_rest_adapter3.jar file under the $ALIVE_BASE/user/plugins/inbound/ folder.

http://www.bluemedora.com/vcops-trials


14

Management Pack for ITM Folders and Files

The installer places the ITM Rest Adapter files in the itm_rest_adapter3 folder.

The itm_rest_adapter3 folder contains subfolders and files.

Table 2-1 ITM Rest Adapter Folders, Subfolders, and Files

Subfolder File Subfolder Description conf describe.xml Describes the

resources for the adapter.

history.txt Adapter change history.

ITM_Adapter_Configuration_File Default configuration file (if user did not modify the name). Contains all product name and attribute groups combinations and columns that tell the adapter whether or not to collect said attribute group and at what interval.

ITM_Adapter_MetaData_* Metadata file for a specific version of a specific ITM agent affinity.

open_source_license.txt Open source license file.

version.txt Contains version information.

lib aopalliance.jar AOP Alliance interfaces used by Guice.

BMLicenseLib.jar Blue Medora licensing. gson-2.2.4.jar Google JSON jar gson_LICENSE.txt Apache license to

redistribute gson-2.2.4.jar.

guice-3.0.jar Google Guice lightweight dependency injection framework.

javax.inject.jar Javax package for dependency inject.

15

3 Configuring the Management Pack for ITM

To configure the management pack for ITM, you must add a credential and an adapter instance invCenter Operations Manager. You can optionally configure which attribute groups you would like to collect data for.


“Overview of Configuration Steps,” on page 15

“Add a Credential,” on page 15

“Add an Adapter Instance,” on page 16

“Import a Certificate,” on page 17

“Configuring Attribute Groups,” on page 17

Overview of Configuration Steps

Configuring the ITM Rest Adapter involves several steps. You must perform these steps in a particular order.

Verify that your system meets certain requirements. See “,” on page 11.

Add a credential for the adapter instance. See “Add a Credential,” on page 15.

Add an adapter instance. See “Add an Adapter Instance,” on page 16.

If you configured the adapter instance to use HTTPS, import a certificate. See “Import a Certificate,” on page 17.

(Optional) Configure which attribute groups to collect. See “Configuring Attribute Groups,” on page 17.

Add a Credential The ITM Rest Adapter uses a user name and password to connect to the REST Provider Host to query and retrieve metric data. You use this user name and password to create a credential for the adapter instance in vCenter Operations Manager.

You can add the credential before you create the adapter instance and select the correct credential when you define the adapter instance, or you can add the credential when you define the adapter instance.

Prerequisites

Install the ITM Rest Adapter. See Chapter 2, “Installing the Management Pack for ITM,” on page 12.

Procedure



16

2. Select Environment > Configuration > Credentials.

3. Select ITM Rest Adapter from the Adapter Kind drop-down menu.

4. Select the credential kind from the Credential kind drop-down menu.

5. At the top of the list of credentials, next to Action, click Add.

6. Type a unique name for the credential instance in the Instance name text box.

7. Type or select additional information for the credentials.

8. Click OK to add the credential for the adapter kind.

The credential appears in the list in the Manage Credentials window.

Add an Adapter Instance

When you create an adapter instance, you configure how it connects to the REST Provider Host and how it retrieves metric data.

Prerequisites

Install the ITM Rest Adapter. See Chapter 2, “Installing the Management Pack for ITM,” on page 12.

Create a credential or, if you plan to create a credential when you add the adapter instance, become familiar with creating credentials. See “Add a Credential,” on page 15.

Procedure


2. Select Environment > Configuration > Adapter Instances.

3. Select the collector to use from the Collector drop-down menu.

Unless you added additional collectors, the only available collector is vCenter Operations Server. You can change the name of this collector when you install the standalone version.

4. Select ITM Rest Adapter from the Adapter Kind drop-down menu.

5. Click the Add New Adapter Instance icon.

6. Type a name for the adapter in the Adapter Instance Name text box.

7. Configure the adapter settings.

Option Description

Support Autodiscovery

Enables or disables auto-discovery for the adapter instance. When auto-discovery is enabled by selecting True from the drop-down menu, the adapter instance imports all of the active resources from the TEMS. When auto-discovery is disabled by selecting False from the drop-down menu, you must use the manual discovery process to discover resources for the adapter instance. The default is False.

Configuration File Name

The name of the configuration file. The default name is ITM_Adapter_Configuration_File.

REST Provider Host Host name of the machine with the Tivoli Enterprise Portal Server. REST Provider Port Port number to use when connecting to the Tivoli Enterprise Portal Server. REST Provider Protocol

Protocol that the adapter instance uses to connect to the Tivoli Enterprise Portal Server. You can select http (the default) or https.

17

8. Select the credential to use to sign on to the data source from the Credential drop-down menu, or click Add to add a new credential.

9. Click OK to save your configuration.

Note: Creating multiple adapter instances that use the same REST provider is not supported.

What to do next

If you configured the adapter instance to use HTTPS, import a certificate. See “Import a Certificate,” on page 17.

Import a Certificate

If you configured an adapter instance to use HTTPS, you must export a certificate from the Tivoli Enterprise Portal Server and import it to the server truststore file on the vCenter Operations Manager server.

Prerequisites

Export a certificate from the Tivoli Enterprise Portal Server.

Become familiar with how to start vCenter Operations Manager services. See the administration guide for your vCenter Operations Manager version.

Procedure

1. Open a command prompt on the vCenter Operations Manager server.

2. Use the keytool utility to import the certificate to the sever truststore file.

For example:

$ALIVE_BASE\jre\bin\keytool.exe -import -alias ITMCERT -file certificate.cer

–keystore "vCenter-ops\user\conf\truststore" -storepass oxygen

In the example, certificate.cer is the name of the certificate that you exported from the Tivoli Enterprise Portal Server and oxygen is the password for the keystore file. The default password is oxygen.

3. Restart the vCenter Operations Manager Web, Analytics, and Collector services.

Configuring Attribute Groups The ITM Rest Adapter supports per-attribute group configuration. By modifying the configuration file specified in the adapter instance, attribute groups can be turned on and off, the timeout for an attribute group can be adjusted, and an instanced attribute group can be promoted to a resource.

Each adapter instance has a configuration file. This file can be shared between adapter instances, or an adapter instance can have its own configuration file by changing the name of the file when creating an adapter instance. The default configuration file name is ITM_Adapter_Configuration_File. This file is generated shortly after creating an adapter instance, if it does not already exist.

If the file does exist, any attribute groups that are not in the existing file are added, while any existing attribute groups’ configurations are left unchanged. If it does not exist, a new configuration file will have all non-instanced attribute groups set to collect, and instanced attribute groups set to not collect (unless an instanced attribute groups is needed for a build-in dashboard), and a default collection timeout of 5 seconds set for every attribute group.


18

Configuration files are located in $ALIVE_BASE/user/plugins/inbound/itm_adapter3/conf/.

The configuration file controls the attribute groups that are collected. Selecting fewer attribute groups generally results in better performance (less load on the TEPS REST provider). For detailed explanations of what is collected in each attribute group, see the user guide for the agent. For example, the Operating System User's Guides contains information for several operating system agents about each attribute, sorted by attribute group in the ‘Attributes’ subsection.

The collection timeout value is the maximum number of seconds that the adapter will allow each query to run for. Certain attribute groups may take longer to query than 5 seconds. If an attribute group is set to collect, but no data is returning, the attribute group may be timing out. Turning on debug logging will show any attribute groups that are timing out. Note that collecting many ‘slow’ attribute groups by increasing their timeout may degrade performance.

The configuration file also supports promoting instanced attribute groups to resources, to facilitate viewing data through vCenter Operations Manager dashboards. For example, if a resource has an instanced attribute group Processors, which has data for each of 4 CPU cores, setting that attribute group to be promoted will make 4 new resources, each representing one CPU, and the new resources will be children of the original resource.

Note: The resource promotion feature only works with the REST Provider v1.3.0 or later. See “Compatible ITM Versions” on page 9 for more information.

http://publib.boulder.ibm.com/infocenter/tivihelp/v61r1/nav/2_2_6_4

19

4 Troubleshooting the Management Pack for ITM Known troubleshooting information can help you diagnose and correct problems with the ITM Rest Adapter. Log files contain valuable information about adapter instance operation.


“Troubleshooting an ITM Rest Adapter Instance,” on page 19

“Viewing System Log Files,” on page 19

“Testing the ITM REST Provider,” on page 19

“Resolving Common Problems,” on page 21

Troubleshooting an ITM Rest Adapter Instance

Perform these general troubleshooting steps to diagnose and correct problems with an ITM Rest Adapter instance.

View the collection status and collection state of the adapter instance resource on the Environment Overview page in the Custom user interface.

Check the adapter and collector logs for errors. See “Viewing System Log Files,” on page 19.

Viewing System Log Files

You can view ITM Rest Adapter errors in the vCenter Operations Manager adapter and collector log files. You can view log files in the Custom user interface or in an external log viewer.

The collector file is in the $ALIVE_BASE/user/log/ folder. The ITM Rest Adapter log file is in the $ALIVE_BASE/user/log/adapters/ITMAdapter/ folder.

The logging level is set to ERROR by default. To troubleshoot issues, we recommend setting the logging level to at least INFO. You will find log messages about licensing information, poorly performing queries, parsing errors of the configuration file, and collection statistics at the resource level. To view log messages of non-fatal exceptions encountered or collection statistics at the attribute group level, set the logging level to DEBUG.

NOTE If you set the logging level to DEBUG, log files can quickly become large in size. Set the logging level to DEBUG only for short periods of time.

For information about viewing log files and modifying logging levels, see the online help.

Testing the ITM REST Provider

A test query can be made against the REST Provider Host to verify your credentials or to further investigate any peculiar behavior you are see in the product. Log into the ITM REST Provider test page and make a simple query to retrieve all of the managed systems of a certain agent type.


20

Procedure

1. Open a browser and navigate to the ITM REST Provider test page.

For example: http://restProviderHost:15210/ITMRESTProvider/test.html

15210 is the default port for the ITM REST Provider.

2. To access the page, you will be prompted for a username and password capable of viewing the page. Use the username and password that will be used for ITM Rest Adapter.

3. Press the GET button to return JSON containing the datasources that can be queried. The output will look similar to this:

4. The corresponding HUB TEMS that the ITM Rest Adapter will monitor needs to exist in the output. Modify

the URI text box to include the datasourcesUri for your TEMS and press the GET button. The output will look similar to this:

21

5. Find an entry of type TMSAgent that you know is currently pointed to your TEMS. Modify the URI text box

to target the datasetsUri of the entry you found and add the following string to the end of it: /msys/items?properties=ORIGINNODE. Press the GET button. The output will look similar to this:

Resolving Common Problems

Follow recommended procedures when you resolve common problems.


22

Cannot Load the Describe File

vCenter Operations Manager cannot load the ITM Rest Adapter describe.xml file for the adapter.

Problem

vCenter Operations Manager returns an error when it tries to load the describe.xml file for the ITM Rest Adapter.

Cause

The contents of the describe.xml file might be invalid.

Solution

Open the describe.xml file in a text editor and verify that the information in the file is accurate. The describe.xml is in the conf folder under the adapter installation folder.

Cannot Connect to the Server

The ITM Rest Adapter is not connected to the REST Provider Host.

Problem

The ITM Rest Adapter cannot connect to the REST Provider Host.

Cause

The credentials that you configured for the ITM Rest Adapter instance may be invalid.

Solution

1. Log in to vCenter Operations Manager as an administrator.

2. Select Environment > Configuration > Adapter Instances.

3. Select the adapter instance for the ITM Rest Adapter and click the Edit Selected Adapter Instance icon.

4. If the credential is invalid, type the correct information and click OK to save your changes.

Documents

vCenter Operations Management Pack for ITM Installation ......7 1 Introduction to the Management Pack for ITM The Management Pack for IBM Tivoli Monitoring (ITM) is an embedded adapter