VMware vCenter vCenter Operations Manager 1.0 Configuration Guide

VMware vCenter Adapter Installation

and Configuration Guide

vCenter Operations Manager 1.0

This document supports the version of each product listed and

supports all subsequent versions until the document is replaced

by a new edition. To check for more recent editions of this

document, see http://www.vmware.com/support/pubs.

EN-000912-02

VMware vCenter 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

©

property 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 marks

and names mentioned herein may be trademarks of their respective companies.

VMware, Inc.

3401 Hillview Ave.

Palo Alto, CA 94304

www.vmware.com

Contents

VMware vCenter Adapter Installation and Configuration Guide

5

Updated Information 7

1

Introduction to the vCenter Adapter 9

How the Adapter Creates Resources 9

Data that the Adapter Collects

9

Using the VM Entity Status Resource Tag 10

Installation and Configuration Requirements 10

vCenter Adapter Resource Identification 11

2

Installing the vCenter Adapter 15

Install the Adapter in a Standalone Installation 15

Install the Adapter in a vApp Installation 16

vCenter Adapter Folders and Files 16

3

Configuring the vCenter Adapter 19

Add a Credential 19

Add an Adapter Instance 20

Reducing the Number of Collected Metrics 20

4

Troubleshooting the vCenter Adapter 21

Troubleshooting a vCenter Adapter Instance 21

View Collection Information 21

Viewing System Log Files 23

5

Metrics for vCenter Server Components 25

vCenter Server Metrics 25

Datacenter Metrics 28

Cluster Compute Resource Metrics 30

Resource Pool Metrics 35

Host System Metrics 37

Virtual Machine Metrics 48

Datastore Metrics 55

Capacity Planning Metrics 59

Badge Metrics 63

6

Metrics for vCenter Operations Manager Components 65

Analytics Metrics 65

Collector Metrics 70

ActiveMQ Service Metrics 71

VMware, Inc. 3

Web Server Metrics 72

Replication Server Metrics

74

Database Metrics 74

Host Operating System Metrics 75

Index 77

VMware vCenter Adapter Installation and Configuration Guide

4 VMware, Inc.

VMware vCenter Adapter Installation and

Configuration Guide

The VMware vCenter Adapter Installation and Configuration Guide describes how to install and configure the

vCenter adapter for vCenter Operations Manager.

Intended Audience

This information is intended for anyone who needs to install or configure the vCenter adapter.

VMware, Inc. 5

VMware vCenter Adapter Installation and Configuration Guide

6 VMware, Inc.

Updated Information

The VMware

vCenter Adapter Installation and Configuration Guide is updated with each release of the product or

when necessary.

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

Revision Description

EN-000912-02

n

Updated

the list of compatible vSphere versions in “Installation and Configuration Requirements,” on

page 10.

n

Added “Reducing the Number of Collected Metrics,” on page 20.

n

Added the datastore | notshared metric to “Virtual Machine Metrics,” on page 48.

n

Added Chapter 6, “Metrics for vCenter Operations Manager Components,” on page 65.

EN-000912-01

n

Changed the product name to reflect the new licensing model for the 5.6 release.

n

Added “vCenter Adapter Folders and Files,” on page 16.

n

Added information about configuring the adapter in a 5.6 or later vApp installation to Chapter 3,

“Configuring the vCenter Adapter,” on page 19.

n

Added “View Collection Information,” on page 21.

n

Added metrics to Chapter 5, “Metrics for vCenter Server Components,” on page 25

EN-000912-00 The vCenter Adapter Technical Note is now the VMware vCenter Adapter Installation and Configuration Guide.

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

VMware, Inc. 7

VMware vCenter Adapter Installation and Configuration Guide

8 VMware, Inc.

Introduction to the vCenter Adapter 1

The vCenter adapter is an embedded adapter for vCenter Operations Manager. The adapter collects metrics

from vCenter Server.

This chapter includes the following topics:

n

“How the Adapter Creates Resources,” on page 9

n

“Data that the Adapter Collects,” on page 9

n

“Using the VM Entity Status Resource Tag,” on page 10

n

“Installation and Configuration Requirements,” on page 10

n

“vCenter Adapter Resource Identification,” on page 11

How the Adapter Creates Resources

The

vCenter adapter can create resources in vCenter Operations Manager by using auto-discovery and manual

discovery.

When you enable auto-discovery for a vCenter adapter instance, the adapter discovers and creates resources

in vCenter Operations Manager after it runs a main collection query.

You can use manual discovery to restrict the resources that the vCenter adapter creates in

vCenter Operations Manager. With manual discovery, the adapter sends a request to vCenter Server to return

all available resources and you select the resources to add.

Data that the Adapter Collects

During each collection cycle, the vCenter adapter retrieves metric values, events, and relationships from

vCenter Server.

For metric values, the adapter queries for up to five of the most recent 20-second samples from vCenter Server

and calculates the average. The adapter also adds several aggregate metrics, which it calculates based on those

values.

The vCenter adapter collects metrics for the following vCenter Server objects:

n

Datacenter

n

Cluster

n

Resource Pools

n

Host

n

Virtual Machine

VMware, Inc. 9

n

Datastore

n

Folder

For

information about the metrics that the adapter collects for these objects, see Chapter 5, “Metrics for vCenter

Server Components,” on page 25.

Using the VM Entity Status Resource Tag

The vCenter adapter creates the VM Entity Status resource tag in the Custom user interface.

The VM Entity Status resource tag values are NotExisting, PoweredOff, and PoweredOn. Each resource tag

value includes the name of the vCenter Server instance, for example, PoweredOn:vCenter4-qalab.

Figure 1-1. VM Entity Status Resource Tag

You can select the PoweredOff or PoweredOn tag value to filter host system and virtual machine resources

based on their running state.

You

can select the NotExisting tag value to locate resources that no longer exist in the vCenter Server inventory

and remove them from the Custom user interface. When objects are removed from the vCenter Server

inventory, they remain available in the user interface until you remove them.

Installation and Configuration Requirements

Before you install the vCenter adapter, you must make sure that your system meets certain requirements.

VMware vSphere Compatibility

The vCenter adapter is compatible with vSphere 2.5, 3.0, 3.5, 4.0 update 2, 4.1, 5.0, and 5.1.

Credential Requirements

You must provide a vCenter Server user name and password when you create a credential for a vCenter adapter

instance.

The vCenter Server privileges assigned to this user account determine the scope of the data that the vCenter

adapter can collect and the visibility of that data in vCenter Operations Manager.

The adapter calculates metric values based on the visibility that the user account has to the vCenter Server

inventory. If certain objects are not visible, vCenter Operations Manager does not consider the values for these

objects when it calculates metrics for their container objects.

VMware vCenter Adapter Installation and Configuration Guide

10 VMware, Inc.

At a minimum, the user account must have Read privileges and the Read privileges must be assigned at the

Datacenter or vCenter Server level. If the Read privileges are assigned to selected ESX hosts or individual

virtual machines, vCenter Operations Manager cannot show metrics for their parent objects. For example, if

the user account has Read privileges only for an ESX host, you cannot view metrics for the parent datastore,

cluster, or datacenter of that ESX host in vCenter Operations Manager.

vCenter Adapter Resource Identification

The

vCenter adapter uses certain resource identifiers. You must specify resource identifiers when you reference

vCenter adapter resources with the vCenter Operations Manager API.

Adapter Kind

The adapter kind for the vCenter adapter is VMware Adapter and the identifier key is VMWARE.

Adapter Instance Resource Kind

The adapter instance resource kind for a vCenter adapter instance is vCenter Server and the identifier key is

VMwareAdapter Instance.

A vCenter adapter instance resource has a specific identifier key.

Table 1-1. vCenter Adapter Instance Resource Identifier Key

Key Part of Uniqueness Default Name (en) Description

VCURL Yes VC Host Host name or IP address of a

vCenter Server host.

Datacenter Resource Kind

The resource kind for a vCenter Server datacenter is Datacenter and the identifier key is Datacenter.

A Datacenter resource has specific identifier keys.

Table 1-2. Datacenter Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the datacenter.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the datacenter, for example,

datacenter-2.

VMEntityVCID Yes VC ID vCenter Server unique ID.

Cluster Compute Resource Kind

The resource kind for a vCenter Server cluster is Cluster Compute Resource and the identifier key is

ClusterComputeResource.

A Cluster Compute Resource resource has specific identifier keys.

Chapter 1 Introduction to the vCenter Adapter

VMware, Inc. 11

Table 1-3. Cluster Compute Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the cluster.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the cluster, for example,

domain-c160.

VMEntityVCID Yes VC ID vCenter Server unique ID.

Folder Resource Kind

The resource kind for a vCenter Server folder is Folder and the identifier key is Folder.

A Folder resource has specific identifier keys.

Table 1-4. Folder Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the folder.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the folder, for example,

folder-41.

VMEntityVCID Yes VC ID vCenter Server unique ID.

Resource Pool Resource Kind

The

resource kind for a vCenter Server resource pool is Resource Pool and the identifier key is ResourcePool.

A Resource Pool resource has specific identifier keys.

Table 1-5. Resource Pool Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the resource pool.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the resource pool, for

example, resgroup-49.

VMEntityVCID Yes VC ID vCenter Server unique ID.

Host System Resource Kind

The resource kind for a vCenter Server host system (ESX server) is Host System and the identifier key is

HostSystem.

A Host System resource has specific identifier keys.

Table 1-6. Host System Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the host system.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the host system, for example,

host-67.

VMEntityVCID Yes VC ID vCenter Server unique ID.

VMware vCenter Adapter Installation and Configuration Guide

12 VMware, Inc.

Virtual Machine Resource Kind

The resource kind for a virtual machine is Virtual Machine and the identifier key is VirtualMachine.

A Virtual Machine resource has specific identifier keys.

Table 1-7. Cluster Compute Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the virtual machine.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the virtual machine, for

example, vm-67.

VMEntityVCID Yes VC ID vCenter Server unique ID.

Datastore Resource Kind

The resource kind for a vCenter Sever datastore is Datastore and the identifier key is Datastore.

A Datastore resource has specific identifier keys.

Table 1-8. Datastore Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the datastore.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the datastore, for example,

datastore-1.

VMEntityVCID Yes VC ID vCenter Server unique ID.

DataStorePath No Datastore Path For NFS-based datastores, a

string in the format

storage-

system-IP-address

/

path-

to-element-in-storage-

system

.

Compute Resource Kind

The resource kind for a vCenter server compute resource is Compute Resource and the identifier key is

ComputerResource.

A Compute Resource resource has specific identifier keys.

Table 1-9. Compute Resource Identifier Keys

Key Part of Uniqueness Default Name (en) Description

VMEntityName No VM Entity Name Name of the resource.

VMEntityObjectID Yes VM Entity Object ID vCenter Server object ID for

the resource.

VMEntityVCID Yes VC ID vCenter Server unique ID.

World Resource Kind

The

World object is a logical container for all monitored objects. The resource kind for the World object is World

and the identifier key is World.

Chapter 1 Introduction to the vCenter Adapter

VMware, Inc. 13

VC ID Values

For

vCenter Server 4.0 and later, the VC ID is set to the VC UUID. For version 2.5, the VC ID is set to the vCenter

Server host name.

VMware vCenter Adapter Installation and Configuration Guide

14 VMware, Inc.

Installing the vCenter Adapter 2

How you install the vCenter adapter depends on whether you have a standalone or vApp installation.

This chapter includes the following topics:

n

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

n

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

n

“vCenter Adapter Folders and Files,” on page 16

Install the Adapter in a Standalone Installation

If

you have a standalone installation, you install the vCenter adapter by extracting the adapter installation files

from a TGZ 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 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.

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 installs

the adapter on the remote collectors.

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.

VMware, Inc. 15

7 Verify

that the build number in the Adapter Version column for the adapter matches the build number in

the TGZ file that you downloaded.

Install the Adapter in a vApp Installation

If you have a vApp installation, you install the vCenter 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,

adapter

name-

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 update

is finished.

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

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

vCenter Adapter Folders and Files

The installer places the vCenter adapter files in the

vcenter-ops

/user/plugins/inbound/vcenter_adapter3

folder.

The vcenter_adapter3 folder contains several subfolders and files.

VMware vCenter Adapter Installation and Configuration Guide

16 VMware, Inc.

Table 2-1. vCenter Adapter Folders and Files

Folder File Description

conf describe.xml

Describes the adapter.

eventlist.txt

Lists the events for which the adapter creates change

events in vCenter Operations Manager.

history.txt

Contains information about the changes

implemented in the adapter versions.

rmi.properties

RMI properties.

version.txt

Contains information about the adapter version.

vm3.png

VMware logo.

vmware.properties

Main configuration file for the adapter.

open_source_license.txt

Open source license file.

lib apputils-custom.jar

JAR files and other commonly used files.

axis.jar

axis-ant.jar

commons-discovery-0.2.jar

commons-logging-1.1.jar

jaxen.license

jaxen.readme

jaxrpc.jar

saaj.jar

vim.jar

vim25.jar

wbem.jar

wsdl4j-1.5.1.jar

Chapter 2 Installing the vCenter Adapter

VMware, Inc. 17

VMware vCenter Adapter Installation and Configuration Guide

18 VMware, Inc.

Configuring the vCenter Adapter 3

For pre-5.6 releases, you configure the vCenter adapter by adding a credential and an adapter instance in the

Custom user interface.

For 5.6 and later releases, you add a credential and an adapter instance in the Custom user interface only if

you have a standalone installation.

If

you have a 5.6 or later vApp installation, you manage the vCenter adapter from vCenter Operations Manager

Administration. You define adapter settings for a vCenter server system in the vCenter Server Registration

pane on the Registration tab. For more information, see the vCenter Operations Manager Administration online

help.

This chapter includes the following topics:

n

“Add a Credential,” on page 19

n

“Add an Adapter Instance,” on page 20

n

“Reducing the Number of Collected Metrics,” on page 20

Add a Credential

You must use the Custom user interface to create a credential for a vCenter adapter instance if you have a 5.6

or later standalone installation or a pre-5.6 standalone or vApp installation.

You use a vCenter Server user name and password to create a credential for the adapter instance.

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

n

Install or upgrade the vCenter adapter. See Chapter 2, “Installing the vCenter Adapter,” on page 15.

n

Verify that the user name and password meet the credential requirements. See “Credential

Requirements,” on page 10.

Procedure

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

2 Select Environment > Configuration > Credentials.

3 Select VMware Adapter from the Adapter Kind drop-down menu.

4 Select Principal Credential 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.

VMware, Inc. 19

7 Type the user name and password combination in the User name and Password text boxes.

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

You must use the Custom user interface to create an adapter instance for the vCenter adapter if you have a 5.6

or later standalone installation or a pre-5.6 standalone or vApp installation. The adapter instance defines the

adapter type and identifies the vCenter Server host.

If you have a 5.6 or later vApp installation, you manage the vCenter adapter from vCenter Operations Manager

Administration. You define adapter settings for a vCenter server system in the vCenter Server Registration

pane on the Registration tab. For more information, see the vCenter Operations Manager Administration online

help.

Prerequisites

n

Install or upgrade the vCenter adapter. See Chapter 2, “Installing the vCenter Adapter,” on page 15.

n

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

Procedure

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

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 VMware 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 Type the IP address or host name of the vCenter Server host in the VC Host text box.

8 Select true or false from the Auto Discovery drop-down menu to enable or disable auto-discovery.

If you enable auto-discovery, the data collection process discovers new resources and creates the resources

for you. If you disable auto-discovery, you must use manual discovery to create resources. Manual

discovery is useful for restricing the resources that the adapter adds. You typically enable auto-discovery

for the vCenter adapter.

9 Select true or false from the Process Change Events drop-down menu to configure whether the adapter

instance processes change events.

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

11 Click OK to save your configuration.

Reducing the Number of Collected Metrics

If you have a 5.7 or later vApp installation, you can reduce the number of metrics that the vCenter adapter

collects by selecting the Balanced profile metrics profile.

You select a metrics profile option on the Registration tab in the vCenter Operations Manager Administration

user interface. For more information, see the Administration online help.

VMware vCenter Adapter Installation and Configuration Guide

20 VMware, Inc.

Page is loading ...

VMware vCenter vCenter Operations Manager 1.0 Configuration Guide

VMware vCenter vCenter Operations Manager 1.0 Configuration Guide

Related papers

Other documents