SNMP Output Module

From 9088fb40be054a25deea50baaae0a33c5dac9040 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Tue, 4 Mar 2008 10:49:42 +0000 Subject: tweaked omsnmp doc a bit --- ChangeLog | 3 ++- doc/omsnmp.html | 45 +++++++++++++++++++++------------------------ 2 files changed, 23 insertions(+), 25 deletions(-) diff --git a/ChangeLog b/ChangeLog index 934ec9da..c59b68dc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,11 +1,12 @@ --------------------------------------------------------------------------- ---------------------------------------------------------------------------- Version 3.12.1 (rgerhards), 2008-0?-?? - improved debugging support; debug runtime options can now be set via an environment variable - bugfix: removed debugging code that I forgot to remove before releasing 3.12.0 (does not cause harm and happened only during startup) - internal code improvements (more code converted into classes) +- changed the default omsnmp mib/oid to a more appropriate value +- internal code reworking of the imtcp/imgssapi module --------------------------------------------------------------------------- Version 3.12.0 (rgerhards), 2008-02-28 - added full expression support for filters; filters can now contain diff --git a/doc/omsnmp.html b/doc/omsnmp.html index 5ead4014..2f60862a 100644 --- a/doc/omsnmp.html +++ b/doc/omsnmp.html @@ -1,9 +1,7 @@ - - - + + -SNMP Output Module - +SNMP Output Module @@ -13,8 +11,7 @@

Description:

Provides the ability to send syslog messages as an SNMPv1 & v2c traps. By default, SNMPv2c is preferred. The syslog message is wrapped into a OCTED -STRING variable, by default with the OID i.o.d.internet.private.enterprises. -This module uses the +STRING variable. This module uses the NET-SNMP library. In order to compile this module, you will need to have the NET-SNMP developer (headers) package installed.

@@ -25,7 +22,7 @@ developer (headers) package installed.

Configuration Directives:

$actionsnmptransport (This parameter is optional, the - default value is "udp")
+ default value is "udp")

Defines the transport type you wish to use. Technically we can support all transport types which are supported by NET-SNMP.
@@ -44,14 +41,14 @@ developer (headers) package installed.
Example: $actionsnmptarget server.domain.xxx
$actionsnmptargetport (This parameter is optional, the - default value is "162")
+ default value is "162")

The port which will be used, common values are port 162 or 161.

Example: $actionsnmptargetport 162
$actionsnmpversion (This parameter is optional, the - default value is "1")
+ default value is "1")

There can only be two choices for this parameter for now.
0 means SNMPv1 will be used.
@@ -61,18 +58,18 @@ developer (headers) package installed.
Example: $actionsnmpversion 1
$actionsnmpcommunity (This parameter is optional, the - default value is "public")
+ default value is "public")

This sets the used SNMP Community.

Example: $actionsnmpcommunity public
$actionsnmpsyslogmessageoid (This parameter is - optional, the default value is "1.3.6.1.4.1.9.9.41.2.0.1" which means "CISCO-SYSLOG-MIB::clogMessageGenerated")
+ optional, the default value is "1.3.6.1.4.1.9.9.41.2.0.1" which means "CISCO-SYSLOG-MIB::clogMessageGenerated")

- This OID will be used as a variable, type "OCTET STRING". This variable will - contain the full syslog message including syslog header. I also recommend to - use the default value here unless you require to use a different OID.
+ This OID will be used as a variable, type "OCTET STRING". This variable will + contain the full syslog message including syslog header. It is recommend to + use the default value here unless a different OID is required.
In order to decode this OID, you will need to have the CISCO-SYSLOG-MIB and CISCO-SMI mibs installed on the receiver side. Downloads of these mib files can be found here:
@@ -81,14 +78,14 @@ developer (headers) package installed.
http://www.oidview.com/mibs/9/CISCO-SMI.html

- We will add our own MIB definition in a later step here. For now, + We will add our own MIB definition in a later stage. For now, CISCO-SYSLOG-MIB::clogMessageGenerated is a good choice. Thanks to the net-snmp mailinglist for the help and the recommendations ;).

Example: $actionsnmpsyslogmessageoid 1.3.6.1.4.1.9.9.41.2.0.1
$actionsnmpenterpriseoid (This parameter is optional, - the default value is "1.3.6.1.4.1.3.1.1" which means "enterprises.cmu.1.1")
+ the default value is "1.3.6.1.4.1.3.1.1" which means "enterprises.cmu.1.1")

Customize this value if needed. I recommend to use the default value unless you require to use a different OID.
@@ -98,7 +95,7 @@ developer (headers) package installed.
Example: $actionsnmpenterpriseoid 1.3.6.1.4.1.3.1.1
$actionsnmpspecifictype (This parameter is optional, - the default value is "0")
+ the default value is "0")

This is the specific trap number. This configuration parameter is used for SNMPv1 only. It has no effect if SNMPv2 is @@ -107,7 +104,7 @@ developer (headers) package installed.
Example: $actionsnmpspecifictype 0
$actionsnmptraptype (This parameter is optional, the - default value is "6" which means SNMP_TRAP_ENTERPRISESPECIFIC)
+ default value is "6" which means SNMP_TRAP_ENTERPRISESPECIFIC)

There are only 7 Possible trap types defined which can be used here. These trap types are:
@@ -127,7 +124,9 @@ developer (headers) package installed.

Caveats/Known Bugs:

currently, the module is +depending on a CISCO MIB defintion. This will be changed in the future. +So be prepared to update some of your receivers when this happens.

Sample:

The following commands send every message as a snmp trap.