28
SNMP 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-000876-03

SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Embed Size (px)

Citation preview

Page 1: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP 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-000876-03

Page 2: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP 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 © 2013 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

Page 3: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Contents

SNMP Adapter Installation and Configuration Guide 5

Updated Information 7

1 Introduction to the SNMP Adapter 9

Overview of Adapter Operation 9Installation and Configuration Requirements 9

2 Installing the SNMP Adapter 11

Install the Adapter in a Standalone Installation 11Install the Adapter in a vApp Installation 12SNMP Adapter Folders and Files 13

3 Configuring the SNMP Adapter 15

Overview of Configuration Steps 15Add a Credential 15Add an Adapter Instance 16Adding Devices as Resources 17

4 Troubleshooting the SNMP Adapter 25

Troubleshooting an SNMP Adapter Instance 25Viewing System Log Files 25SNMP Adapter Classes 25

Index 27

VMware, Inc. 3

Page 4: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and Configuration Guide

4 VMware, Inc.

Page 5: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and ConfigurationGuide

The SNMP Adapter Installation and Configuration Guide describes how to install and configure the SNMP adapter.The SNMP adapter is an embedded adapter for vCenter Operations Manager.

Intended AudienceThis information is intended for anyone who wants to install or configure the SNMP adapter.

VMware, Inc. 5

Page 6: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and Configuration Guide

6 VMware, Inc.

Page 7: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Updated Information

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

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

Revision Description

EN-000876-03 Added ireasoningsnmp.jar to “SNMP Adapter Folders and Files,” on page 13.

EN-000876-02 Changed the product name to reflect the new licensing model for the 5.6 release.

EN-000876-01 Added “Finding Interface Index Numbers,” on page 22.

EN-000876-00 Initial release.

VMware, Inc. 7

Page 8: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and Configuration Guide

8 VMware, Inc.

Page 9: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Introduction to the SNMP Adapter 1The Simple Network Management Protocol (SNMP) is a standard Internet protocol for managing devices onIP networks. The SNMP adapter is an embedded adapter for vCenter Operations Manager that collects metricsfrom devices that support SNMP. These devices typically include routers, switches, servers, workstations, andprinters.

This chapter includes the following topics:

n “Overview of Adapter Operation,” on page 9

n “Installation and Configuration Requirements,” on page 9

Overview of Adapter OperationSNMP exposes management data on SNMP-managed devices as variables, which are organized in hierarchies.Management Information Base (MIB) files describe these hierarchies and contain object identifiers (OIDs) thatidentify each variable.

The SNMP adapter uses MIB files to determine the metrics to collect from a particular device. When you installthe SNMP adapter, the installation utility places a set of standard MIB files in the conf/mib folder. You canimport additional MIB files after you install the SNMP adapter.

MIB files appear as resource kinds in the vCenter Operations Manager user interface. When you add a resourceor attribute package, you can select a MIB file that exists in the conf/mib folder or the Predefined MIB Statisticsresource kind. The Predefined MIB Statistics resource kind consists of common device-level and interface-levelvariables from RFC1213-MIB.mib.

When you select a MIB file, an OID tree appears in the user interface and you can select specific variables. TheSNMP adapter collects metrics for the variables that you select.

You can add SNMP-managed devices as resources in vCenter Operations Manager through manual discoveryor by adding resources individually. The SNMP adapter does not support auto-discovery.

Installation and Configuration RequirementsThe SNMP adapter must meet certain installation and configuration requirements.

Credential RequirementsWhen you add an adapter instance for the SNMP adapter, you must provide an SNMP community string. Thecommunity string authenticates messages sent between the SNMP management station and managed devices.The default read-only community string is public and the default read-write community string is private.

VMware, Inc. 9

Page 10: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Supported SNMP VersionsThe SNMP adapter supports SNMPv1 and SNMPv2c.

SNMP Adapter Installation and Configuration Guide

10 VMware, Inc.

Page 11: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Installing the SNMP Adapter 2How you install the SNMP adapter depends on whether you have a vCenter Operations Manager Standaloneor vApp installation.

This chapter includes the following topics:

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

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

n “SNMP Adapter Folders and Files,” on page 13

Install the Adapter in a Standalone InstallationIf you have a standalone installation, you install the SNMP adapter by extracting installation files from a TGZfile 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. 11

Page 12: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

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 installation utility creates the snmp_adapter3 folder and snmp_adapter.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 SNMP 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.

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 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 utility creates the snmp_adapter3 folder and snmp_adapter.jar file under the vcenter-ops/user/plugins/inbound folder.

SNMP Adapter Installation and Configuration Guide

12 VMware, Inc.

Page 13: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Folders and FilesThe SNMP adapter installation utility places the SNMP adapter files in the snmp_adapter3 folder.

The snmp_adapter3 folder contains subfolders and files.

Table 2-1. SNMP Adapter Subfolders and Files

Subfolder File Subfolder Description

conf mibs Contains the MIB files for the adapter and the mib-imports.props file.

describe.xml Describes the adapter.

history.txt Contains the history of the adapter changes.

mib-import.log MIB import script log file.

updateMibs.bat Script that adds MIB files to the adapter on Windows.

updateMibs.sh Script that adds MIB files to the adapter on Linux.

version.txt Contains version information.

lib ireasoningsnmp.jar iReasoning SNMP JAR file. Non-OSS library file.

Chapter 2 Installing the SNMP Adapter

VMware, Inc. 13

Page 14: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and Configuration Guide

14 VMware, Inc.

Page 15: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Configuring the SNMP Adapter 3To configure the SNMP adapter, you create a credential and adapter instance invCenter Operations Manager and add managed devices as resources. You can also create attribute packagesto collect specific metrics and import additional MIB files for the adapter.

This chapter includes the following topics:

n “Overview of Configuration Steps,” on page 15

n “Add a Credential,” on page 15

n “Add an Adapter Instance,” on page 16

n “Adding Devices as Resources,” on page 17

Overview of Configuration StepsConfiguring the SNMP adapter involves several steps. You must perform these steps in a particular order.

1 Verify that your system meets certain requirements. See “Installation and ConfigurationRequirements,” on page 9.

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

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

4 Add devices as resources. See “Adding Devices as Resources,” on page 17

Add a CredentialYou must add a credential for an SNMP adapter instance. The credential consists of an SNMP communitystring. The community string authenticates messages between the SNMP management station and manageddevices.

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

Prerequisites

Install the SNMP adapter. See Chapter 2, “Installing the SNMP Adapter,” on page 11.

Procedure

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

2 Select Environment > Configuration > Credentials.

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

VMware, Inc. 15

Page 16: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

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

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

6 Type the SNMP community string in the Community text box.

The default read-only community string is public and the default read-write community string isprivate.

7 Select the SNMP version from the Version drop-down menu.

The SNMP adapter supports SNMPv1 and SNMPv2c.

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

What to do next

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

Add an Adapter InstanceWhen you create an adapter instance for the SNMP adapter, you define the adapter type and select a credential.

Prerequisites

n Install the SMNP adapter. See Chapter 2, “Installing the SNMP Adapter,” on page 11.

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

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

4 Select SNMP 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 Select the credential from the Credential drop-down menu, or click Add to add a new credential.

8 Click OK to save your configuration.

What to do next

Add devices as resources in vCenter Operations Manager. See “Adding Devices as Resources,” on page 17.

SNMP Adapter Installation and Configuration Guide

16 VMware, Inc.

Page 17: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Adding Devices as ResourcesYou can use manual discovery to add SNMP-managed devices as resources in vCenter Operations Manager.You can also add resources individually. The SNMP adapter does not support auto-discovery.

Discover ResourcesThe manual discovery process returns a list of the available devices and you select the devices to add asresources in vCenter Operations Manager.

Prerequisites

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

n If you plan to define a new attribute package during the discovery process, become familiar with creatingattribute packages. See “Define an Attribute Package,” on page 19.

Procedure

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

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 SNMP Adapter from the Adapter Kind drop-down menu.

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

7 Configure an IP address range by typing IP addresses in the Start IP and End IP text boxes.

The discovery process finds all of the devices that have IP addresses within this range.

8 Type the SNMP port in the the Port text box.

The default port for SNMP is 161.

9 (Optional) To omit resources that have already been added from the discovery results, select the OnlyNew Resources check box.

10 Click OK to start the manual discovery process.

The manual discovery process can take several seconds to several minutes.

When the manual discovery process is finished, the Discovery Results window lists the discovered devices.If a discovered device is a switch, router, firewall, or load balancer, the device type is included in theresource name, for example, 10.118.52.32 - switch.

Chapter 3 Configuring the SNMP Adapter

VMware, Inc. 17

Page 18: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

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

12 Click OK.

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

Add an Individual ResourceWhen you add an individual device as a resource in vCenter Operations Manager, you must select a resourcekind and provide an IP address and port number.

Prerequisites

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

n If the MIB files for the device are not in the conf/mibs folder, import them. See “Import MIB Files for theSNMP Adapter,” on page 22.

n If you plan to add an attribute package for the resource, become familiar with creating attribute packages.See “Define an Attribute Package,” on page 19.

Procedure

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

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.

For example: 10.118.52.32 - switch

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

For example: Allied Telesyn Ethernet Switch AT-8550SP - ATS62 v1.4.0

6 Select SNMP Adapter from the Adapter kind drop-down menu.

7 Select a resource kind from the Resource kind drop-down menu.

The resource kind determines the metrics that the adapter collects for the device.

Option Description

Predefined MIB Statistics Contains common device-level and interface-level variables from RFC1213-MIB.mib.

nnnnn-MIB.mib Main MIB file for the device.

8 Type the IP address of the device in the Host IP text box.

9 Type the SNMP port in the Port text box.

The default port for SNMP is 161.

SNMP Adapter Installation and Configuration Guide

18 VMware, Inc.

Page 19: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

10 Select a credential for the resource from the Credential drop-down menu, or click Add to add a credential.

11 Accept the default attribute package in the Attribute package drop-down menu, select a different package,or click Add to define a new package for the resource.

The default attribute package depends on the resource kind.

12 Accept the default super metric package, if any, in the Super metric package drop-down menu, select adifferent package, or click Add to define a new package for the resource.

A default super metric package is not available unless you previously defined a default super metricpackage for the selected resource kind.

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

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

Dynamic thresholding is enabled by default. Early warning smart alerts are enabled by default only forapplications.

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

16 Click OK to add the resource.

17 (Optional) Start data collection for the resource.

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

a Select Environment > Environment Overview.

b Select the resource on the List tab.

c Click the Start Collecting icon to start collection.

Define an Attribute PackageSNMP-managed devices can have many variables, especially interface-level variables. You can define anattribute package to select a subset of these variables. When you assign the attribute package to a resource, theadapter collects metrics only for the variables in the attribute package.

Prerequisites

n If the MIB files for the device are not in the conf/mibs folder, import them. See “Import MIB Files for theSNMP Adapter,” on page 22.

n (Optional) Use the SnmpWalk tool to obtain the necessary interface index numbers. You must assign indexnumbers as instance names when you configure interface-level groups. See “Finding Interface IndexNumbers,” on page 22.

Procedure

1 Select Environment > Configuration > Attribute Packages.

Chapter 3 Configuring the SNMP Adapter

VMware, Inc. 19

Page 20: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

2 Select SNMP Adapter from the Adapter kind drop-down menu.

3 Select a resource kind from the Resource kind drop-down menu.

The resource kind determines the metrics that the adapter collects for the device.

Option Description

Predefined MIB Statistics Contains common device-level and interface-level variables from RFC1213-MIB.mib.

nnnnn-MIB.mib Main MIB file for the device.

4 Click the Add New Attribute Package icon.

5 Type a name for the attribute package in the Package name text box.

6 Type a collection interval value, in minutes, in the Collection Interval (mins) text box.

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

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

NOTE The collection interval that you set for a resource overrides the collection interval in the attributepackage that you assign to the resource.

7 If you selected a MIB file from the Resource kind drop-down menu, select the variables to include in theattribute package in the OID tree in the Attributes To Configure pane.

8 For interface-level groups, click the Add New Instance icon above the Instance Name pane and type theinterface index in the text box.

Interface indexes begin at 1 and end at the number of interfaces within the device. The interface indexbecomes the group instance name.

IMPORTANT The option to add an interface index appears for all groups, even device-level groups that donot require an interface index. For device-level groups, type 0 or leave the Instance Name text box blank.

9 Click OK to return to the Manage Attribute Packages window.

10 Click OK to save the attribute package.

Example: Defining Attribute PackagesThis example shows an attribute package named TestSnmpPack. The RFC1213-MIB group appears in theattribute tree in the Attributes to Configure pane because RFC1213-MIB.mib is selected as the resource kind. ThePredefined MIB Statistics (Device level) and Predefined MIB Statistics (Interface level) groups appear inthe attribute tree because the predefined variables are included in all MIB file-specific resource kinds.

In the Attribute Packages window, where Predefined MIB Statistics (Interface level) and the Instance Namepane are highlighted, interface index 1 is added for the Predefined MIB Statistics (Interface level) group.

SNMP Adapter Installation and Configuration Guide

20 VMware, Inc.

Page 21: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Figure 3-1. Configuring Index 1 in the Instance Name Pane

In the Attribute Packages window, where ifEntry and the Instance Name pane are highlighted, interfaceindexes 1 and 2 are added for the interface-level group ifEntry.

Figure 3-2. Configuring Multiple Indexes in the Instance Name Pane

If you configure an incorrect interface index, an error appears in the adapter log file. The following exampleshows the type of error that occurs when you do not define an interface index for an interface-level variableand index 0 is used instead. Interface-level variables require a non-zero index.

Error fetching data for SNMP resource 10.118.52.32 - switch attribute ipRouteProto SNMP

Error, please check the MIB variable or Index value oid=.1.3.6.1.2.1.4.21.1.9 index=0

What to do next

Assign the attribute package to a resource. See “Discover Resources,” on page 17 or “Add an IndividualResource,” on page 18.

Chapter 3 Configuring the SNMP Adapter

VMware, Inc. 21

Page 22: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Finding Interface Index NumbersWhen you configure interface-level groups in an attribute package, you must assign index numbers as instancenames. You can use the SnmpWalk tool to parse the MIB tree and obtain the necessary index numbers.

SnmpWalk has many useful options. For example, you can use the following command to get all index numbers:

snmpwalk -v1 -c public ip:port

The index for an OID applies to the entire group in an attribute package. To obtain the correct index numbersto assign as instance names to a group, choose an OID of that group and run the following command:

snmpwalk -v1 -c public ip:port OID

The command lists all indexes and their current counter values for the specified OID.

You can download SnmpWalk for free from several Web sites. For installation instructions and information aboutcommand options, see the SnmpWalk documentation.

Import MIB Files for the SNMP AdapterIf a device requires MIB files that are not in the conf/mibs folder, you must import the required MIB files andredescribe the SNMP adapter. For information about the MIB files for a specific device, see the devicedocumentation.

Procedure

1 Copy the MIB files, including any dependent MIB files, to the conf/mibs folder.

In a vApp installation, you copy the files to the conf/mibs folder on the Analytics virtual machine.

2 Run the MIB file update script to import the MIB files.

The conf folder contains MIB update scripts for Windows and Linux.

Option Action

Windows Run updateMibs.bat.

Linux Run updateMibs.sh. The MIB file update script updates the conf/mibs/mib-imports.props file, which keeps track of all MIBfile dependencies.

mib-imports.props file entries are in the format MainFile=DependentFile. Multiple dependent files areseparated by a semicolon (;). For example:

RFC1271-MIB.mib=RFC-1155-SMI.mib;RFC-1212.mib;RFC1213-MIB.mib;RFC-1271-MIB.mib;

3 Check the mib-import.log log file for errors.

The script generates the mib-import.log log file in the conf folder. Errors commonly occur when dependentMIB files are not present in the conf/mibs folder.

4 Open the conf/describe.xml file in a text editor and increment the version number.

For example, if version="4", change it to version="5".

<AdapterKind CredentialKind="" key="SNMP" namekey="1" version="4">

5 Redescribe the SNMP adapter.

a Log in to vCenter Operations Manager as an administrator.

b Select Admin > Support.

c On the Info tab, click the Describe icon in the Adapters pane.

SNMP Adapter Installation and Configuration Guide

22 VMware, Inc.

Page 23: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

6 Verify that the new MIB files appear in the Resource kind drop-down menu when you add an individualresource or attribute package.

Chapter 3 Configuring the SNMP Adapter

VMware, Inc. 23

Page 24: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and Configuration Guide

24 VMware, Inc.

Page 25: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Troubleshooting the SNMP Adapter 4Known troubleshooting information can help you diagnose and correct problems with the SNMP adapter.

This chapter includes the following topics:

n “Troubleshooting an SNMP Adapter Instance,” on page 25

n “Viewing System Log Files,” on page 25

n “SNMP Adapter Classes,” on page 25

Troubleshooting an SNMP Adapter InstancePerform these general troubleshooting steps to diagnose and correct problems with an SNMP adapter instance.

n View the collection status and collection state for the adapter instance resource on the EnvironmentOverview page in the Custom user interface.

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

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

SNMP adapter log files are in the vcenter-ops/user/log/adapters/SNMPAdapter folder. Collector log files arein the vcenter-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.

SNMP Adapter ClassesThe SNMP adapter uses certain adapter classes. These classes are in the snmp_adapter.jar file.

Table 4-1. SNMP Adapter Classes

Class Description

com.integrien.adapter3.snmp.SNMPAdapter Adapter entry class. Contains the main adapter functionmethods.

com.integrien.adapter3.snmp.SNMPConstants Contains the constant values that the adapter uses.

VMware, Inc. 25

Page 26: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Table 4-1. SNMP Adapter Classes (Continued)

Class Description

com.integrien.adapter3.snmp.SNMPResource (hostand port)

Represents an SNMP resource object.

com.integrien.adapter3.snmp.SNMPCredential Represents an SNMP credential object.

com.integrien.adapter3.snmp.SNMPHost (resource andcredential)

Represents an SNMP resource host object.

com.integrien.adapter3.snmp.SNMPDiscover Multithreaded discovery functions.

com.integrien.adapter3.snmp.SNMPTPDiscoveryWorkItem

Discovery of a single SNMP resource.

com.integrien.adapter3.snmp.MibImportParser Parses the mib-imports.props file.

com.integrien.adapter3.snmp.SNMPMIBLookup Main class to retrieve data from an SNMP-managed device.

com.integrien.adapter3.snmp.SNMPNodeInfo Represents information about an SNMP node.

com.integrien.adapter3.snmp.UDPScanner Low-level SNMP connection class.

SNMP Adapter Installation and Configuration Guide

26 VMware, Inc.

Page 27: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

Index

Aadapter classes 25adapter instances 16attribute packages 19audience information 5

Cconfiguration steps 15credentials 15

Ddiscovering resources 17

Iinstallation steps 11, 12introduction 9

Llog messages 25

MMIB files 9, 22

Rrequirements 9resources 17, 18

Ssnmp_adapter3 folder 13snmpwalk 22

Ttroubleshooting steps 25

Uupdated information 7

VMware, Inc. 27

Page 28: SNMP Adapter Installation and Configuration Guide · PDF fileSNMP Adapter Installation and Configuration ... The SNMP Adapter Installation and Configuration Guide is ... lib ireasoningsnmp.jar

SNMP Adapter Installation and Configuration Guide

28 VMware, Inc.