SNMP Platform Service

Topics marked with * relate to features available only in vFabric Hyperic.

Monitor a Remote SNMP Agent

You can configure a platform service of type "SNMP" to report the availability of a remote SNMP agent.

Resource Plugin, Functions, and Classes

The SNMP service type is managed by Hyperic's netservices plugin and performs the following functions:

  • Metric collection using the org.hyperic.hq.product.SNMPMeasurementPlugin class.

Configure the SNMP Service in Hyperic

You manually configure an SNMP service on an operating system platform platform.

  1. Navigate to the platform whose Hyperic Agent will monitor the service.

  2. Select New Platform Service from the Tools menu.

  3. On New Service page, enter a name for the service and select "SNMP" from the Service Type pull-down.

  4. Supply all required values on the Configuration Properties page. Configuration options are defined below in SNMP Configuration Options.

Configuration Properties Page

The Configuration Properties page for the SNMP service type is shown below.

images/download/attachments/79038211/SnmpConfigOptions43.png

SNMP Configuration Options

The tables below document the options in the configuration schema for the SNMP service type.

name

description

default

opt

type

Notes

Where Defined

OID

OID

 

yes

 

If supplied, the plugin will issue a query for the value of the OID.

netservices plugin descriptor

snmpIp

SNMP agent IP address

127.0.0.1

no

 

The IP address of the SNMP agent for the network device.

snmp

snmpPort

SNMP agent port

161

no

port

The port the SNMP agent uses.

snmp

snmpTransport

SNMP Transport

no

enum

Values:

  • udp

  • tcp

snmp

snmpVersion

SNMP Version

no

enum

Values:

  • v2c

  • v1

  • v3

snmp

snmp
Community (v1 and v2c only)

SNMP Community

public

 

snmp

snmpUser
(v3 only)

SNMP Security Name

username

true

 

The SNMP security name to use when communicating with the remote SNMP agent.

snmp

snmpSecurity
Context
(v3 only)

SNMP Context Name

hqadmin

true

 

The name of the SNMP context that provides access to the remote management information.

snmp

snmpAuthType
(v3 only)

SNMP Authentication Protocol

none

true

enum

The SNMP authentication protocol to use for communicating with the remote SNMP agent.

Values:

  • none

  • MD5

  • SHA

snmp

snmpPassword
(v3 only)

SNMP Authentication Passphrase

true

secret

The SNMP authorization passphrase to use for communicating with the remote SNMP agent.

snmp

snmpPrivacy
Type
(v3 only)

SNMP Privacy Protocol

true

enum

The SNMP Privacy Protocol HQ Server should use for communicating with the remote SNMP agent.

Values:

  • none,

  • DES,

  • 3DES

  • AES-128

  • AES-192

  • AES-256

snmp

snmpPrivacy
PassPhrase
(v3 only)

SNMP Privacy Passphrase

 

true

secret

The SNMP privacy passphrase configured for use when communicating with the remote SNMP agent.

snmp

SNMP Metrics

  • Availability - An SNMP service is considered available if the Hyperic Agent is able to get sysUpTime from the remote SNMP agent. Otherwise the service is reported to be unavailable.

  • Response Time - The time (in ms) it took to determine service availability.

  • OID Value - Value returned by query, if OID option is configured.

SNMP Monitoring Defaults Page

You can enable and disable metrics, select indicator metrics, and change the collection interval for a resource type on its Monitoring Defaults page. To navigate to a resource type's Monitoring Defaults page:

  1. Click the Administration tab.

  2. Click Monitoring Defaults.

The Monitoring Defaults page for the Availability - type is shown below:

images/download/attachments/79038211/SNMPMetrics.png