TeamQuest Adapter Installation and Configuration Guide · TeamQuest Adapter Installation and Configuration Guide vCenter Operations Manager 1.0 This document supports the version

TeamQuest Adapter Installation andConfiguration Guide

vCenter Operations Manager 1.0

This document supports the version of each product listed andsupports all subsequent versions until the document is replacedby a new edition. To check for more recent editions of thisdocument, see http://www.vmware.com/support/pubs.

EN-001005-01

http://www.vmware.com/support/pubs

TeamQuest Adapter Installation and Configuration Guide

2 VMware, Inc.

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

[email protected]

Copyright © 2012 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectualproperty laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marksand names mentioned herein may be trademarks of their respective companies.

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

http://www.vmware.com/support/

mailto:[email protected]

http://www.vmware.com/go/patents

Contents

TeamQuestAdapter Installation and Configuration Guide 5

Updated Information 7

1 Introduction to the TeamQuest Adapter 9

Resources That the Adapter Creates 9How the Adapter Retrieves Data 10Data That the Adapter Retrieves 12Installation and Configuration Requirements 12

2 Installing the TeamQuest Adapter 13

Install the Adapter in a Standalone Installation 13Install the Adapter in a vApp Installation 14TeamQuest Adapter Folders and Files 15

3 Configuring the TeamQuest Adapter 17

Add an Adapter Instance 17Defining Resources 18Modifying Adapter Properties 21

4 Troubleshooting the TeamQuest Adapter 23

Troubleshooting a TeamQuest Adapter Instance 23Validate Data 23Viewing System Log Files 24

Index 25

VMware, Inc. 3


4 VMware, Inc.

TeamQuestAdapter Installation and ConfigurationGuide

The TeamQuest Adapter Installation and Configuration Guide describes how to install and configure theTeamQuest adapter for vCenter Operations Manager.

Intended AudienceThis information is intended for anyone who needs to install or configure the TeamQuest adapter.

VMware, Inc. 5


6 VMware, Inc.

Updated Information

The TeamQuest Adapter Installation and Configuration Guide is updated with each release of the product or whennecessary.

This table provides the update history of the TeamQuest Adapter Installation and Configuration Guide.

Revision Description

EN-001005-01 Changed the product name to reflect the new licensing model for the 5.6 release.

EN-001005-00 The TeamQuest Adapter Technical Note is now the TeamQuest Adapter Installation and Configuration Guide.

The TeamQuest Adapter Technical Note was the initial release of this document.

VMware, Inc. 7


8 VMware, Inc.

Introduction to the TeamQuestAdapter 1

The TeamQuest adapter is an embedded adapter for vCenter Operations Manager. The adapter collects datafrom resources that the TeamQuest software monitors.

This chapter includes the following topics:

n “Resources That the Adapter Creates,” on page 9

n “How the Adapter Retrieves Data,” on page 10

n “Data That the Adapter Retrieves,” on page 12

n “Installation and Configuration Requirements,” on page 12

Resources That the Adapter CreatesThe resources that the TeamQuest adapter creates in vCenter Operations Manager represent TeamQuestmonitored devices.

The TeamQuest adapter can create resources through manual discovery. You can also add TeamQuestresources individually. The TeamQuest adapter does not support auto-discovery of resources.

Resource IdentificationThe TeamQuest adapter uses certain resource identifiers. If you use the vCenter Operations Manager API toreference a resource, you must use its resource identifier.

Adapter KindThe adapter kind for the TeamQuest adapter is TeamQuest and the identifier key is TeamQuest.

Adapter Instance Resource KindThe adapter instance resource kind for the TeamQuest adapter is TeamQuest Adapter Instance and theidentifier key is TeamQuestAdapter Instance.

Resource Kinds for DevicesThe resource kinds that the TeamQuest adapter creates represent the types of devices that TeamQuestmonitors.

Table 1-1. Operating System Resource Kinds

Device Type Resource Kind Name Identifier Key

Windows server Windows Windows

Linux server Linux Linux

VMware, Inc. 9

Table 1-1. Operating System Resource Kinds (Continued)

Device Type Resource Kind Name Identifier Key

Solaris server Solaris Solaris

HP-UX server HPUX HPUX

AIX server AIX AIX

SNMP device SNMP SNMP

Resources for DevicesThe resources that the TeamQuest adapter creates represent TeamQuest monitored devices. Resources havecertain identifiers.

Table 1-2. Resource Identifiers

KeyPart ofUniqueness Description

Host Yes Host name or IP address of a TeamQuest monitored server.

Port Yes HTTP port that TeamQuest Manager uses on a TeamQuest monitored server.

Dataset Yes TeamQuest Harvest dataset to use for data collection.

TimeShiftFromGMT Yes (Optional) Time shift from GMT.

DateFormat Yes (Optional) Format to use for dates.

SystemNames Yes (Optional) System name filter. The adapter passes this value to the tqharvccommand as a -S option. This key does not apply to SNMP devices.

Device name Yes Name of an SNMP device. This key applies only to SNMP devices.

How the Adapter Retrieves DataIn a TeamQuest software deployment, each monitored server has a local installation of TeamQuest Manager.With the proper extensions, a local TeamQuest Manager can collect operating system and application-levelmetrics.

Each local TeamQuest Manager monitors and collects metric data and stores the data in a local data store. TheTeamQuest adapter uses a TeamQuest Harvest command (tqharvc) to collect data from these local data stores.

The TeamQuest software uses TeamQuest Harvest to collect data from the local data stores and writes the datato a centralized data store. The TeamQuest software uses this centralized data store for enterprise reportingand analysis.

tqharvc CommandThe TeamQuest adapter uses the tqharvc command to collect data for each TeamQuest resource defined invCenter Operations Manager. A valid command result contains 13 columns.

Command SyntaxThe TeamQuest adapter uses the following tqharvc command to collect data.

%TQ_HOME%/manager/bin/tqharvc -m host -g dataset -s last_data_time -e

current_time -a 1-minute -c -p port [-S system_names]

Workload Category Column MappingsFor workload categories, the command result contains these column mappings.


10 VMware, Inc.

Column Value

columns[0] timestamp

columns[2] category

columns[3] subCategory

columns[5] attribute

columns[8] instance

colunns[12] value

SNMP Resource Column MappingsFor SNMP resources, the command result contains these column mappings.

Column Value


columns[2] category

columns[3] snmpDeviceName



columns[10] instance

columns[12] value

Other Column MappingsThe command result contains these column mappings for nonworkload categories and non-SNMP resources.

Column Value


columns[2] category



columns[10] instance

columns[12] value

ErrorsA parsing error occurs if a line in the command result contains any of these strings.

n Requested dataset and does not exist

n Error: The system could not read the data request from and Verify the TeamQuest tqhttpd serviceis running on

n requires login to TeamQuest Manager

n disabled because the connection failed

Chapter 1 Introduction to the TeamQuest Adapter

VMware, Inc. 11

Data That the Adapter RetrievesThe TeamQuest software uses a hierarchical definition of data that is based on operating system type. Metricgroups are below the system level and consist of operating system metric groups such as disk space, CPUperformance, memory, and application groups.

The TeamQuest adapter retrieves a single dataset definition that includes Windows operating system, Solarisoperating system, Oracle database, and WebSphere metrics.

The describe.xml file in the conf folder describes the metrics that the TeamQuest adapter collects. The adaptercollects data only for the metrics in the describe.xml file. You cannot modify the describe.xml file.

Installation and Configuration RequirementsBefore you install the TeamQuest adapter, verify that your system meets certain requirements.

TeamQuest Manager CompatibilityThe TeamQuest adapter is compatible with TeamQuest Manager versions 10.1 and 10.2.

Connection and Credential RequirementsBecause the TeamQuest adapter uses tqharvc commands on the local machine to collect data, it does not haveconnection or credential requirements.

Additional Software RequirementsOn each monitored server, the TeamQuest Harvest Service Authentication setting must be set to NO inTeamQuest Manager.

Depending on how you installed vCenter Operations Manager, you might need to install TeamQuest Manageron the vCenter Operations Manager server or on a remote collector.


12 VMware, Inc.

Installing the TeamQuest Adapter 2How you install the TeamQuest adapter depends on whether you have a vCenter Operations ManagerStandalone or vApp installation.


n “Install the Adapter in a Standalone Installation,” on page 13

n “Install the Adapter in a vApp Installation,” on page 14

n “TeamQuest Adapter Folders and Files,” on page 15

Install the Adapter in a Standalone InstallationIf you have a standalone installation, you install the TeamQuest adapter by extracting installation files from aTGZ file and running an installation utility.

Prerequisites

n Download the adapter installation TGZ file anonymously from ftp://ftp.integrien.com/.

n 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.

n 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 Managerserver.

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

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.

The Custom user interface finds the adapter files, gathers information about the abilities of the adapter,and updates the user interface with information about the adapter. If you have remote collectors, it installsthe adapter on the remote collectors.

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

VMware, Inc. 13

ftp://ftp.integrien.com/

7 Verify that the build number in the Adapter Version column for the adapter matches the build number inthe TGZ file that you downloaded.

The installer creates the teamquest_adapter3 folder and teamquest_adapter3.jar file under the vcenter-ops/user/plugins/inbound folder.

Install the Adapter in a vApp InstallationIf you have a vApp installation, you install the TeamQuest adapter from a PAK file.

Prerequisites

n Download the adapter installation PAK file anonymously from ftp://ftp.integrien.com.

n 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.

n 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 updateis 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.

The Custom user interface finds the 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 adapterappears 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 inthe PAK file that you uploaded.

The installation process creates the teamquest_adapter3 folder and teamquest_adapter3.jar file under thevcenter-ops/user/plugins/inbound folder.


14 VMware, Inc.

ftp://ftp.integrien.com

TeamQuest Adapter Folders and FilesThe adapter installation folder, vcenter-ops/user/plugins/inbound/teamquest_adapter3, contains severalfiles in the conf subfolder.

File Description

teamquest.properties Main configuration file for the adapter.

describe.xml Describes the metrics that the adapter collects.

version.txt Contains information about the adapter version.

history.txt Describes the changes in each adapter version.

Chapter 2 Installing the TeamQuest Adapter

VMware, Inc. 15


16 VMware, Inc.

Configuring the TeamQuest Adapter 3To configure the TeamQuest adapter, you must add an adapter instance and define resources for the adapterinstance in vCenter Operations Manager. You can optionally modify adapter properties to customize adapteroperation.


n “Add an Adapter Instance,” on page 17

n “Defining Resources,” on page 18

n “Modifying Adapter Properties,” on page 21

Add an Adapter InstanceYou must create an adapter instance for the TeamQuest adapter. The adapter instance defines the adapter typeand specifies the path to the TeamQuest installation folder.

Prerequisites

Install the TeamQuest adapter. See Chapter 2, “Installing the TeamQuest Adapter,” on page 13.

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. Youcan change the name of this collector when you install the standalone version.

4 Select TeamQuest 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 In the Home Path text box, type the full path of the TeamQuest installation.

8 Click OK to save your configuration.

What to do next

Define resources. See “Defining Resources,” on page 18.

VMware, Inc. 17

Defining ResourcesThe TeamQuest adapter cannot begin collecting data for TeamQuest monitored devices until you defineresources for those devices in vCenter Operations Manager.

You can define resources by using manual discovery or by adding resources individually. The TeamQuestadapter does not support auto-discovery of resources.

Manual Discovery XML File FormatThe TeamQuest adapter performs manual discovery by reading a manual discovery XML file that you create.

The following example shows a manual discovery XML file that declares two Windows resources,Qalab2vm-159 and Qalab2vm-18, and one Solaris resource, Qalab-70. The resources are grouped by resourcekind.

<?xml version="1.0"?>

<TeamQuestDiscovery>

<ResourceKind type="Windows">

<Resource Description="test" Host="10.1.15.159" Port="2780"

Dataset="mvCustom">Qalab2vm-159</Resource>


Dataset="mvCustom">Qalab2vm-158</Resource>

</ResourceKind>

<ResourceKind type="Solaris">


Dataset="mvCustom">Qalab-70</Resource>

</ResourceKind>

</TeamQuestDiscovery>

<ResourceKind> ElementYou use the <ResourceKind> element to specify the resource kind for a resource. The type attribute specifiesthe resource kind identifier. Valid names are AIX, HPUX, Linux, SNMP, Solaris, and Windows. The manualdiscovery XML file can contain multiple <ResourceKind> elements.

<Resource Description> ElementThe <Resource Description> element is a child element of the <ResourceKind> element. Each <ResourceKind>element can contain multiple <Resource Description> elements. You use the <Resource Description> elementto define each resource.

The <Resource Description> element contains several attributes.

Attribute Description

Dataset TeamQuest Harvest dataset to use for collection.

DateFormat (Optional) Format to use for dates.

Host Host name or IP address of the TeamQuest monitored server.

Port HTTP port that TeamQuest Manager users on the TeamQuest monitored server.

SystemNames (Optional) System name filter. The adapter passes this value to the tqharvc command as a -S option.NOTE This attribute is not currently supported through manual discovery.

TimeShiftFromGMT (Optional) Time shift from GMT.


18 VMware, Inc.

Discover Resources ManuallyYou can use the manual discovery process to define resources for the TeamQuest adapter.

Prerequisites

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

n Create a manual discovery XML file. See “Manual Discovery XML File Format,” on page 18.

Procedure


2 Select Environment > Environment Overview.

3 On the List tab, click the Discover Resources icon.

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

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

5 Select TeamQuest adapter from the Adapter kind drop-down menu.

6 Select the TeamQuest adapter instance from the Adapter instance drop-down menu.

7 In the File Name text box, type the path to the manual discovery XML file that you created.

8 Click OK to start the discovery process.

The discovery process can take several seconds to several minutes.

When the discovery process is finished, the Discovery Results window lists your resource kinds.

9 Double-click each resource kind that contains resources to add.

The resource list shows all of the resources of the specified resource kind. You can sort the resource listby clicking any column header. To find a specific resource in the list, type all or part of the resource namein the Search text box and click Search.

10 Select options for each resource kind.

Option Description

Import Import the resources but do not start collecting data. Resources appear in theresource list as Not Collecting and data is not stored and analysis is notperformed.

Collect Import the resources and start collecting data. When you select the Collectcheck box, the Import check box is also selected.

Attribute Package To use a nondefault attribute package for the resource kind, select anattribute package from the drop-down menu or click Add to define a newattribute package.

11 Click OK.

The Discovery Results window closes and the new resources appear on the List tab.

Add an Individual ResourceYou can define resources for the TeamQuest adapter by adding resources individually.

Prerequisites

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

Chapter 3 Configuring the TeamQuest Adapter

VMware, Inc. 19

Procedure


2 Select Environment > Environment Overview.

3 On the List tab, click the Add Resource icon.

4 Type a name for the resource in the Resource name text box.

Use only letters and numbers in the resource name. Do not use nonalphanumeric characters or spaces.The resource description is for informational purposes only.

5 (Optional) Type a description of the resource in the Resource description text box.

6 Select TeamQuest adapter from the Adapter kind drop-down menu.

7 Select the TeamQuest adapter instance from the Adapter instance drop-down menu.

8 Provide information about the resource.

Option Description

Resource kind Resource kind for the resource. You can select AIX, HPUX, Linux, SNMP, Solaris, or Windows.

Host Host name or IP address of the TeamQuest monitored server.

Port HTTP port that TeamQuest Manager uses on the TeamQuest monitored server.

SNMP Driver Name Name of an SNMP device. This option appears only if you select the SNMP resource kind.

Dataset TeamQuest Harvest dataset to use for collection.

Time shift from GMT (Optional) Time shift from GMT.

Date Format (Optional) Format to use for dates.

System Names System name filter. The adapter passes this value to the tqharvc command as a -S option.This option appears only if you select the SNMP resource kind.

9 Accept the default attribute and super metric packages.

10 Type the collection interval, in minutes, in the Collection Interval (Minutes) text box.

For example, if you expect the resource to generate performance data every 30 minutes, set the collectioninterval to 30 minutes.

The collection interval for a resource influences the collection status for that resource. The collectioninterval for the adapter instance resource determines how often to collect data. For example, if thecollection interval for the adapter instance resource is set to five minutes, setting the collection intervalfor a resource to 30 minutes prevents the resource from having the No Data Receiving collection statusafter five collection cycles (25 minutes).

11 Select the Enabled or Disabled check box to enable or disable dynamic thresholding and early warningsmart alerts.

Dynamic thresholding is enabled by default, which is the recommended value. Early warning smart alertsare enabled by default only for applications. Early warning smart alerts work best for applications andapplication-like container resources. Container resources have at least two levels of resources beneaththem, such as an application that contains tiers, which each contain resources.

Early warning smart alerts are generated for a resource only if the resource and its children have at leastthe required number of metrics defined. By default, the minimum number of metrics is 40, not includingvCenter Operations Manager generated metrics.

12 (Optional) If you plan to take the resource offline for maintenance at regular intervals, select themaintenance schedule for it to use from the Maintenance Schedule drop-down menu, or click Add todefine a new maintenance schedule.


20 VMware, Inc.

13 Click OK to add the resource.

What to do next

Start metric collection for the resource.

When you add an individual resource, vCenter Operations Manager does not begin collecting metrics for theresource until you start metric collection.

Modifying Adapter PropertiesThe teamquest.properties file in the conf folder contains configuration settings. You can modify these settingsto customize adapter operation.

NOTE In a vApp installation, you modify the teamquest.properties file on the Analytics virtual machine.

Table 3-1. teamquest.properties File Properties

Property Description Default

TeamQuest_Home Full path of the TeamQuest installation. C:/ProgramFiles/TeamQuest

NumberOfConcurrentRequests Number of concurrent command line requests. 10

maxMinWaitForData Maximum amount of time, in minutes, that theadapter waits for data.

30

Chapter 3 Configuring the TeamQuest Adapter

VMware, Inc. 21


22 VMware, Inc.

Troubleshooting the TeamQuestAdapter 4

Known troubleshooting information can help you diagnose and correct problems with the TeamQuest adapter.


n “Troubleshooting a TeamQuest Adapter Instance,” on page 23

n “Validate Data,” on page 23

n “Viewing System Log Files,” on page 24

Troubleshooting a TeamQuest Adapter InstanceYou can perform some general troubleshooting steps to diagnose and correct problems with a TeamQuestadapter instance.

1 Verify that the TeamQuest software is running.

2 View the collection status and collection state for the adapter instance resource on the EnvironmentOverview page in the Custom user interface. For more information about viewing resources in the userinterface, see the online help.

3 Validate the data that the TeamQuest adapter instance retrieves. See “Validate Data,” on page 23.

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

Validate DataYou can use the Custom user interface to verify that resources are created and metrics are collected throughthe TeamQuest adapter.

Prerequisites

Install and configure the TeamQuest adapter. See Chapter 2, “Installing the TeamQuest Adapter,” onpage 13 and Chapter 3, “Configuring the TeamQuest Adapter,” on page 17.

Procedure


2 Verify the details for each resource.

a Select the resource on the List tab and click the Show Detail icon.

The Resource Detail page appears for the resource.

b Examine the health tree and verify the resource relationships.

c Examine the metric graph and compare the values to the source values in the TeamQuest console.

VMware, Inc. 23

Viewing System Log FilesYou can view TeamQuest adapter errors in the vCenter Operations Manager adapter and collector log files.You can view adapter and collector log files in the Custom user interface or in an external log viewer.

TeamQuest adapter log files are in the vcenter-ops/user/log/adapters folder. Collector log files are in thevcenter-ops/user/log folder.

The logging level is set to ERROR by default. To troubleshoot issues, set the logging level to INFO. To viewdetailed messages, including micro steps, queries, and returned results, set the logging level to DEBUG.

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

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

TeamQuest Adapter ClassesThe TeamQuest adapter uses certain classes.

Class Description

com.integrien.adapter3.teamquest.TeamQuestAdapter Main adapter class. This class logs each line in the resultat the DEBUG level. Most process logging occurs at theDEBUG level.

com.integrien.adapter3.teamquest.CommandLineCreator Data retrieval command class. This class logs at theDEBUG level.


24 VMware, Inc.

Index

Aadapter classes 24adapter instances 17audience information 5

Ccollecting data 10configuration steps 17

Ddata types 12defining resources 19discovering resources 19

Iinstallation steps 13, 14introduction 9

Llog files 24

Mmanual discovery XML file 18

Rresource identification 9resources 9, 18

Ssystem requirements 12

Tteamquest_adapter3 folder 15teamquest.properties file 21tqharvc command 10troubleshooting steps 23

Uupdated information 7

Vvalidating data 23

VMware, Inc. 25


26 VMware, Inc.

Documents

TeamQuest Adapter Installation and Configuration Guide · TeamQuest Adapter Installation and Configuration Guide vCenter Operations Manager 1.0 This document supports the version