--
-- OPENNMS-MIB       module definition
--

-- Copyright (C) 2005-2011 by The OpenNMS Group, Inc.


-- Version 1.0 - 2005-01-13: 	The main purpose of this first version of
--				the OpenNMS MIB is to instrument the values
--				passed in the trap sent by scriptd in the
--				example configuration file.

-- Version 1.1 - 2005-12-01: 	Added the ifresolve and nodelabel fields
--				for events. Also greatly increased the text
--				associated with each object.

-- Version 1.2 - 2008-09-16:	Drop-cased first letter of all OBJECTs
--				to placate smilint.

-- Version 1.3 - 2008-09-16:	Added TL1-specific objects and trap definition

-- Version 1.4 - 2011-04-09:	Added OpenNMS-alarmTrap, openNMS-heartbeatTrap
--                              openNMS-startSyncTrap, openNMS-endSyncTrap, openNMS-syncRequestTrap
--  							Added Objects openNMS-eventsAlarms OpenNMS-AlarmId and openNMS-synchronizing to 
--                             	host information regarding alarms and synchronization
--								Removed openNMS- unneeded prefix

-- Version 2.0 - 2011-12-13:    Converted to SMIv2.  Future revision history entries
--                              should be added inside the MODULE-IDENTITY module, not
--                              in these comments.

OPENNMS-MIB DEFINITIONS ::= BEGIN
IMPORTS
   MODULE-IDENTITY, OBJECT-TYPE,
   NOTIFICATION-TYPE, enterprises FROM SNMPv2-SMI
   DisplayString FROM SNMPv2-TC
   MODULE-COMPLIANCE, OBJECT-GROUP,
   NOTIFICATION-GROUP                  FROM SNMPv2-CONF;

openNMS MODULE-IDENTITY
    LAST-UPDATED "201112210000Z"		-- 21 December 2011
    ORGANIZATION "The OpenNMS Group, Inc."
    CONTACT-INFO "Tarus Balog
                  The OpenNMS Group, Inc.
                  112 Fawn Forest Lane
                  Pittsboro NC 27312
                  Phone: +1 919 533 0160
                  Email: tarus@opennms.com
                  WEB: www.opennms.org"
    DESCRIPTION
     "The MIB module for OpenNMS, the world's first enterprise-grade
      open-source network management application platform"
-- Revision history

    REVISION "201112210000Z"
    DESCRIPTION
     "Corrected errors in object names syslogTimestamp, syslogProcessName,
     and  syslogProcessID"


    REVISION "201112160000Z"
    DESCRIPTION
     "Added syslogMessageTrap, correlatedEventTrap, and supporting objects."

    REVISION "201112140000Z"
    DESCRIPTION
     "Integrated conformance groups from Antonio Russo's previous SMIv2 conversion."

    REVISION "201112130000Z"
    DESCRIPTION
     "This is the first SMIv2 version of this MIB. Welcome to the 21st century."
    ::= { enterprises 5813 }

onmsLegacyTraps		OBJECT IDENTIFIER
							::= { openNMS 1 }

groups 	OBJECT IDENTIFIER
	::= { openNMS 4 }

data			OBJECT IDENTIFIER
							::= { openNMS 20 }

events			OBJECT IDENTIFIER
							::= { data 1 }

eventsSpecific	OBJECT IDENTIFIER
							::= { data 2 }
							
tl1AutonomousMessage	OBJECT IDENTIFIER
							::= { eventsSpecific 1 }

syslogMessageObjects	OBJECT IDENTIFIER
							::= { eventsSpecific 2 }

correlatedEventObjects	OBJECT IDENTIFIER
							::= { eventsSpecific 3 }

eventsAlarms	OBJECT IDENTIFIER
	::= { data 3 }														

dbid		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the database ID for the event. Each
			event in OpenNMS is assigned a unique, sequential
			eventid. Unless the database is cleared, the 
			sequence should never repeat."
	::= { events 1 }

distPoller	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the distributed poller name for the event."
	::= { events 2 }

create-time	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the time the event was created in the database."
	::= { events 3 }

master-station	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the name of the master station for the event."
	::= { events 4 }

uei		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the Unique Event Identifier (UEI) for the event.
			 The UEI is a string that should be descriptive and unique
			 for each event type that OpenNMS handles."
	::= { events 6 }

source		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the source of the event, usually the OpenNMS process
			name, such as Capsd or Trapd."
	::= { events 7 }

nodeid		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the Node ID for the event. Node IDs are simply
			a handle that OpenNMS uses to group interfaces and services
			together, and each node should represent an actual device."
	::= { events 8 }

time		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the time the event occurred."
	::= { events 9 }

host		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the host for the event. In most cases it will
			represent the OpenNMS instance that generated it."
	::= { events 10 }

interface		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the interface for the event. It should contain
			the IP address of the interface that caused the event."
	::= { events 11 }

snmphost		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the SNMP host for the event. In the case of
			an SNMP Trap that was received by OpenNMS, it will 
			reflect the device that generated the trap. In the
			case of a trap generated by OpenNMS, such as forwarding
			a nodeLostService event to another system, it will
			reflect the OpenNMS server."
	::= { events 12 }

service		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the name of the service (ICMP, SSH, HTTP, etc.)
			that is associated with the event. For example, a failed 
			web server may generate a nodeLostService event. In that
			case this field would most likely read HTTP."
	::= { events 13 }

descr		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the verbose description of the event."
	::= { events 16 }

logmsg		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"The log message is a short, usually one sentence, description of
			the event suitable for displaying in a log or table."
	::= { events 17 }

severity		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This is the severity of the event, one of CLEARED,
			INDETERMINATE, NORMAL, WARNING, MINOR, MAJOR or CRITICAL."
	::= { events 18 }

pathoutage	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"The pathoutage field in the event has yet to be implemented,
			but it will be stored here when available."
	::= { events 19 }

operinst		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"It is possible to associate operator instructions with
			events in OpenNMS. If this information is available, it 
			will be stored here."
	::= { events 20 }

ifresolve		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"An attempt will be made to resolve the FQDN of
			the IP address in OpenNMS-event-interface and
			if successful, the value returned will be stored here."
	::= { events 21 }

nodelabel		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"This will contain the name of the node as known by OpenNMS. 
			This is based solely on OpenNMS-event-nodeid and can be
			considered an authoritative way to identify the device from
			the perspective of OpenNMS.

			This name is automatically assigned in the following order:

			1) DNS Name: The reverse-resolved name of the primary
			interface for the node.

			2) NetBIOS Name: If available on a Windows or SMB system.

			3) SNMP sysName: If SNMP is available, the sysName.

			4) IP Address

			All of these methods can be overridden by an end user via the webUI, 
			and thus the value can change over time, although the 
			OpenNMS-event-nodeid will not."
	::= { events 22 }

tl1amRawMessage	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION
				"The raw TL1 autonomous message in its entirety."
	::= { tl1AutonomousMessage 1 }
	
tl1amAlarmCode	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION
				"The ASCII alarm-code for this TL1 autonomous message."
	::= { tl1AutonomousMessage 2 }

tl1amAutonomousTag	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
				"The ASCII autonomous-tag for this TL1 autonomous message."
	::= { tl1AutonomousMessage 3 }

tl1amVerb		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION
				"The ASCII verb for this TL1 autonomous message.
				Should always be REPT."
	::= { tl1AutonomousMessage 4 }

tl1amAutoBlock	OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION
				"The ASCII auto-block for this TL1 autonomous message."
	::= { tl1AutonomousMessage 5 }

tl1amAID		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION
				"The ASCII AID (access identifier) for this TL1 autonomous
				message, as parsed from the auto-block."
	::= { tl1AutonomousMessage 6 }

tl1amAdditionalParams	OBJECT-TYPE
	SYNTAX				DisplayString
	MAX-ACCESS			read-only
	STATUS				current
	DESCRIPTION
						"The additional parameters for this TL1 autonomous message,
						as parsed from the auto-block."
	::= { tl1AutonomousMessage 7 }

--
-- Objects in support of syslog-derived event traps
--

syslogFacilityName	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The name of the facility from which this syslog message
						originated, e.g.: kernel, auth, mail..."
	::= { syslogMessageObjects 1 }

syslogSeverityName	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The name of the severity of this syslog message,
						e.g.: Debug, Info, Error..."
	::= { syslogMessageObjects 2 }

syslogTimestamp	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The timestamp of this syslog message from the originating
						sender, if provided, in format: MMM dd HH:mm:ss"
	::= { syslogMessageObjects 3 }

syslogProcessName	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The process that sent this syslog message from the originating
						sender, if provided, e.g.: init, named, sendmail..."
	::= { syslogMessageObjects 4 }

syslogProcessID	OBJECT-TYPE
	SYNTAX			INTEGER
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The numeric PID of the process that sent this syslog message 
						from the originating sender, if provided."
	::= { syslogMessageObjects 5 }

syslogMessageBody	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The body of this syslog message with protocol metadata
						(timestamp, severity, priority, process name and PID) removed."
	::= { syslogMessageObjects 6 }

--
-- Objects in support of correlated event-based traps
--

correlationEngineName	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The name of the OpenNMS correlation engine responsible for
						the correlation that led to the event corresponding to this
						trap, e.g. Drools"
	::= { correlatedEventObjects 1 }

correlationRuleSetName	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"The name of the correlation rule set responsible for
						the correlation that led to the event corresponding to this
						trap. In combination with correlationEngineName, identifies
						the specific rule set that led to the creation of the event
						corresponding to this trap."
	::= { correlatedEventObjects 2 }

correlationComments	OBJECT-TYPE
	SYNTAX			DisplayString
	MAX-ACCESS		read-only
	STATUS			current
	DESCRIPTION
						"Contains optional comments from the correlation rule set
						to aid the operator in interpreting the event corresponding
						to this trap."
	::= { correlatedEventObjects 3 }

--
-- Objects in support of alarm-based traps
--

alarmId		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"The unique alarm identifier."
	::= { eventsAlarms 1 } 
 
synchronizing		OBJECT-TYPE
	SYNTAX		DisplayString
	MAX-ACCESS	read-only
	STATUS		current
	DESCRIPTION 	"flag indicating if the alarm is due to 
                         a synchronization session (SYNC) or not (null)"
	::= { eventsAlarms 2 }

-- Trap definitions

eventTrap		NOTIFICATION-TYPE
	OBJECTS {
		dbid,
		distPoller,
		create-time,
		master-station,
		uei,
		source,
		nodeid,
		time,
		host,
		interface,
		snmphost,
		service,
		descr,
		logmsg,
		severity,
		pathoutage,
		operinst,
		ifresolve,
		nodelabel
		}
	STATUS		current
	DESCRIPTION 
	"This is the definition of the generic OpenNMS trap sent from the
	scriptd process. Key variables are uei (which tells what type
	of OpenNMS event this was), interface (the IP address of the interface
	that caused the event) and severity."
	::= { onmsLegacyTraps 1 }

tl1AutonomousMessageTrap	NOTIFICATION-TYPE
	OBJECTS {
		nodeid,
		time,
		host,
		interface,
		service,
		severity,
		tl1amRawMessage,
		tl1amAlarmCode,
		tl1amAutonomousTag,
		tl1amVerb,
		tl1amAutoBlock,
		tl1amAID,
		tl1amAdditionalParams
	}
	STATUS		current
	DESCRIPTION
		"This trap is used to convey the contents of a TL1 autonomous message
		received from a TL1 NE or a north-bound TL1 EMS. Managers receiving
		this trap may need to perform additional analysis of its varbinds in
		order to realize value from this trap."
	::= { onmsLegacyTraps 2 }

alarmTrap	NOTIFICATION-TYPE
	OBJECTS { 		
		dbid,
		distPoller,
		create-time,
		master-station,
		uei,
		source,
		nodeid,
		time,
		host,
		interface,
		snmphost,
		service,
		descr,
		logmsg,
		severity,
		pathoutage,
		operinst,
		ifresolve,
		nodelabel,
		alarmId,
		synchronizing 
		}
	STATUS		current
	DESCRIPTION		
		"The OpenNMS alarm SNMP Trap"
		
	::=  { onmsLegacyTraps 3 }

heartbeatTrap	NOTIFICATION-TYPE   
	STATUS		current
	DESCRIPTION
		"Trap sent periodically by OpenNMS to keep alive external SNMP Manager"
	::=  { onmsLegacyTraps 4 }

startSyncTrap	NOTIFICATION-TYPE      
	STATUS		current
	DESCRIPTION
		"OpenNMS Synchronization Process is starting"
	::=  { onmsLegacyTraps 5 }

endSyncTrap	NOTIFICATION-TYPE      
	STATUS		current
	DESCRIPTION
		"OpenNMS Synchronization Process is successfully ended"
	::=  { onmsLegacyTraps 6 }

syncRequestTrap NOTIFICATION-TYPE  
	STATUS		current
  	DESCRIPTION 
    	"OpenNMS synchronization request" 
	::=  { onmsLegacyTraps 7 }

syslogMessageTrap	NOTIFICATION-TYPE
	OBJECTS {
		nodeid,
		time,
		host,
		interface,
		service,
		severity,
		syslogFacilityName,
		syslogSeverityName,
		syslogTimestamp,
		syslogProcessName,
		syslogProcessID,
		syslogMessageBody
	}
	STATUS		current
	DESCRIPTION
		"This trap is used to convey the contents of a syslog message
		received from a remote system. Managers receiving should be able
		to reconstruct all information present in the original syslog message
		based on the values of the trap's varbinds."
	::= { onmsLegacyTraps 8 }

correlatedEventTrap	NOTIFICATION-TYPE
	OBJECTS {
		dbid,
		distPoller,
		create-time,
		master-station,
		uei,
		source,
		nodeid,
		time,
		host,
		interface,
		snmphost,
		service,
		descr,
		logmsg,
		severity,
		pathoutage,
		operinst,
		ifresolve,
		nodelabel,
		correlationEngineName,
		correlationRuleSetName,
		correlationComments
	}
	STATUS		current
	DESCRIPTION
		"This trap is used to convey the contents of an OpenNMS event
		that was created as the output of a correlation rule set."
	::= { onmsLegacyTraps 9 }

events-Group	OBJECT-GROUP
	OBJECTS {
		dbid,
		distPoller,
		create-time,
		master-station,
		uei,
		source,
		nodeid,
		time,
		host,
		interface,
		snmphost,
		service,
		descr,
		logmsg,
		severity,
		pathoutage,
		operinst,
		ifresolve,
		nodelabel
	}
	STATUS current
	DESCRIPTION 
		"Conformance Group for OpenNMS Events"
	::= { groups 1 }

tl1AutonomousMessage-Group	OBJECT-GROUP
	OBJECTS {
		tl1amRawMessage,
		tl1amAlarmCode,
		tl1amAutonomousTag,
		tl1amVerb,
		tl1amAutoBlock,
		tl1amAID,
		tl1amAdditionalParams
	}
	STATUS current
	DESCRIPTION 
		"Conformance Group for TL1 autonomous message"
	::= { groups 2 }

eventsAlarms-Group	OBJECT-GROUP
	OBJECTS {
		alarmId,
		synchronizing
	}
	STATUS current
	DESCRIPTION 
		"Conformance Group for OpenNMS Events related to Alarms "
	::= { groups 3 }

traps-Group	NOTIFICATION-GROUP
	NOTIFICATIONS {
		eventTrap,
		tl1AutonomousMessageTrap,
		alarmTrap, 
		heartbeatTrap,
                startSyncTrap, 
		endSyncTrap, 
		syncRequestTrap,
		syslogMessageTrap
	}
	STATUS current
	DESCRIPTION 
		"OpenNMS Notification Group"
	::= { groups 4 }

syslogMessageGroup	OBJECT-GROUP
	OBJECTS {
		syslogFacilityName,
		syslogSeverityName,
		syslogTimestamp,
		syslogProcessName,
		syslogProcessID,
		syslogMessageBody
	}
	STATUS current
	DESCRIPTION 
		"Notification group for syslog message-derived traps"
	::= { groups 5 }

correlatedEventsGroup	OBJECT-GROUP
	OBJECTS {
		correlationEngineName,
		correlationRuleSetName,
		correlationComments
	}
	STATUS current
	DESCRIPTION 
		"Notification group for correlated event-based traps"
	::= { groups 6 }

END