This topic details the options in the configuration schema for the SNMP service type.

Table 1. SNMP Configuration Options

Name

Description

Default

Opt

Type

Notes

Where Defined

OID

OID

N/A

yes

N/A

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

N/A

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

N/A

no

enum

Values:

  • udp

  • tcp

snmp

snmpVersion

SNMP Version

N/A

no

enum

Values:

  • v2c

  • v1

  • v3

snmp

snmp Community (v1 and v2c only)

SNMP Community

public

N/A

N/A

N/A

snmp

snmpUser (v3 only)

SNMP Security Name

username

true

N/A

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

snmp

snmpSecurity Context (v3 only)

SNMP Context Name

hqadmin

true

N/A

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

N/A

true

secret

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

snmp

snmpPrivacy Type (v3 only)

SNMP Privacy Protocol

N/A

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

N/A

true

secret

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

snmp