addressing Perl::Critic warnings in perllib/Torrus/Collector/*
[torrus-plus.git] / htdocs / TORRUS-MIB.txt
blob927946bf7bbd5d40f577c01851d12872ff35154e
1 TORRUS-MIB DEFINITIONS ::= BEGIN
3 IMPORTS
4     MODULE-IDENTITY, OBJECT-IDENTITY, NOTIFICATION-TYPE,
5     Integer32
6         FROM SNMPv2-SMI
7     DateAndTime
8         FROM SNMPv2-TC
9     rrdtool
10         FROM RRDTOOL-SMI;
12 torrus MODULE-IDENTITY
13     LAST-UPDATED "200308060000Z"
14     ORGANIZATION "Round Robin Database Framework project"
15     CONTACT-INFO
16         "Round Robin Database Framework project
17                 
18          Project description and documentation:
19          http://torrus.org
20          
21          Administrative contact for MIB module:
23          Stanislav Sinyagin
24          Tel. +41 79 407 02 24
25          E-mail: ssinyagin@yahoo.com"
26     DESCRIPTION
27         "The MIB module for SNMP variables specific to Torrus project"
28         ::= { rrdtool 1 }
30 EventType ::= TEXTUAL-CONVENTION
31     STATUS current
32     DESCRIPTION
33         "Defines the event type:
34         set      -- The monitor condition is first time met
35         repeat   -- The monitor condition is met again on the consequtive
36                     monitorin cycle
37         clear    -- The monitor condition is not met the first time after
38                     event type set or repeat
39         forget   -- The monitor condition was not met during the expiration
40                     period since the last event type clear"
41     SYNTAX INTEGER {
42              set(1),
43              repeat(2),
44              clear(3),
45              forget(4)
46              }
47                    
48 TreeName ::= TEXTUAL-CONVENTION
49     STATUS current
50     DESCRIPTION
51         "Torrus system operates with several datasource trees
52         identified by names"
53     SYNTAX OCTET STRING (SIZE (1..512))
54     
55 Token ::= TEXTUAL-CONVENTION
56     STATUS current
57     DESCRIPTION
58         "Token is a short ID for the leaf or subtree of the Torrus
59         datasources hierarchy"
60     SYNTAX OCTET STRING (SIZE (5..10))
62 Path ::= TEXTUAL-CONVENTION
63     STATUS current
64     DESCRIPTION
65         "Path is the full name of the Torrus datasource, containing its
66         parent nodes separated by slashes"
67     SYNTAX OCTET STRING (SIZE (1..512))
69 MonitorEventsEntry ::= SEQUENCE {
70     torrusEventIndex     Integer32,
71     torrusToken          Token,
72     torrusMonitorName    OCTET STRING,
73     torrusEventType      EventType,
74     torrusPath           Path,
75     torrusTimestamp      DateAndTime
77     
78 torrusMonitorEventsTable OBJECT-TYPE
79     SYNTAX      SEQUENCE OF MonitorEventsEntry
80     MAX-ACCESS  not-accessible
81     STATUS      current
82     DESCRIPTION
83         "Table of current monitor events"    
84     ::= { torrus 1 }
86 torrusMonitorEventsEntry OBJECT-TYPE
87     SYNTAX      MonitorEventsEntry
88     MAX-ACCESS  not-accessible
89     STATUS      current
90     DESCRIPTION
91         "Each monitor event is characterized by the datasource token and
92          monitor name"
93     INDEX { torrusEventIndex }
94     ::= { torrusMonitorEventsTable 1 }
96 torrusEventIndex OBJECT-TYPE
97     SYNTAX      Integer32 (1..65535)
98     MAX-ACCESS  not-accessible
99     STATUS      current
100     DESCRIPTION
101         "The value of this object uniquely identifies this
102         event entry."
103     ::= { torrusMonitorEventsEntry 1 }
104                         
105 torrusToken OBJECT-TYPE
106     SYNTAX      Token
107     MAX-ACCESS  not-accessible
108     STATUS      current
109     DESCRIPTION
110         "Token is a short ID for the leaf or subtree of the Torrus
111          datasources hierarchy"
112     ::= { torrusMonitorEventsEntry 2 }
114 torrusMonitorName OBJECT-TYPE
115     SYNTAX      OCTET STRING
116     MAX-ACCESS  not-accessible
117     STATUS      current
118     DESCRIPTION
119         "Each monitor instance is identified by unique name"
120     ::= { torrusMonitorEventsEntry 3 }
122 torrusEventType OBJECT-TYPE
123     SYNTAX      EventType
124     MAX-ACCESS  not-accessible
125     STATUS      current
126     DESCRIPTION
127         "The type of the event: set(1), repeat(2), clear(3), forget(4)"
128     ::= { torrusMonitorEventsEntry 4 }
129     
130 torrusPath OBJECT-TYPE
131     SYNTAX      Path
132     MAX-ACCESS  not-accessible
133     STATUS      current
134     DESCRIPTION
135         "The full name of the Torrus datasource, containing its
136         parent nodes separated by slashes"
137     ::= { torrusMonitorEventsEntry 5 }
139 torrusTimestamp OBJECT-TYPE
140     SYNTAX      DateAndTime
141     MAX-ACCESS  not-accessible
142     STATUS      current
143     DESCRIPTION
144         "Timestamp of the event, in SNMPv2 format, e.g.
145          1992-5-26,13:30:15.0,-4:0"
146     ::= { torrusMonitorEventsEntry 6 }
147         
148 torrusTreeName OBJECT-TYPE
149     SYNTAX      TreeName
150     MAX-ACCESS  not-accessible
151     STATUS      current
152     DESCRIPTION
153         "Name of the datasource tree"
154     ::= { torrusMonitorEventsEntry 7 }
156 torrusAlarm NOTIFICATION-TYPE
157     OBJECTS  { torrusToken, torrusMonitorName, torrusEventType,
158                torrusPath, torrusTimestamp }
159     STATUS   current
160     DESCRIPTION
161         "The SNMP trap that is generated when an Torrus monitor
162         condition is changed for the leaf being monitored"
163     ::= { torrus 2 }
164