~ubuntu-branches/ubuntu/gutsy/net-snmp/gutsy-security

« back to all changes in this revision

Viewing changes to mibs/NET-SNMP-AGENT-MIB.txt

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2004-09-13 12:06:21 UTC
  • Revision ID: james.westby@ubuntu.com-20040913120621-g952ntonlleihcvm
Tags: upstream-5.1.1
ImportĀ upstreamĀ versionĀ 5.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
NET-SNMP-AGENT-MIB DEFINITIONS ::= BEGIN
 
2
 
 
3
--
 
4
-- Defines control and monitoring structures for the Net-SNMP agent.
 
5
--
 
6
 
 
7
IMPORTS
 
8
    netSnmpObjects, netSnmpModuleIDs, netSnmpNotifications, netSnmpGroups
 
9
        FROM NET-SNMP-MIB
 
10
 
 
11
    OBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY, Integer32
 
12
        FROM SNMPv2-SMI
 
13
 
 
14
    OBJECT-GROUP, NOTIFICATION-GROUP
 
15
        FROM SNMPv2-CONF
 
16
 
 
17
    DisplayString, RowStatus, TruthValue FROM SNMPv2-TC;
 
18
 
 
19
 
 
20
netSnmpAgentMIB MODULE-IDENTITY
 
21
    LAST-UPDATED "200202090000Z"
 
22
    ORGANIZATION "www.net-snmp.org"
 
23
    CONTACT-INFO    
 
24
         "postal:   Wes Hardaker
 
25
                    P.O. Box 382
 
26
                    Davis CA  95617
 
27
 
 
28
          email:    net-snmp-coders@lists.sourceforge.net"
 
29
    DESCRIPTION
 
30
         "Defines control and monitoring structures for the Net-SNMP agent."
 
31
    REVISION     "200202090000Z"
 
32
    DESCRIPTION
 
33
        "First revision."
 
34
    ::= { netSnmpModuleIDs 2 }
 
35
 
 
36
 
 
37
nsVersion              OBJECT IDENTIFIER ::= {netSnmpObjects 1}
 
38
nsMibRegistry          OBJECT IDENTIFIER ::= {netSnmpObjects 2}
 
39
nsExtensions           OBJECT IDENTIFIER ::= {netSnmpObjects 3}
 
40
nsDLMod                OBJECT IDENTIFIER ::= {netSnmpObjects 4}
 
41
nsCache                OBJECT IDENTIFIER ::= {netSnmpObjects 5}
 
42
nsErrorHistory         OBJECT IDENTIFIER ::= {netSnmpObjects 6}
 
43
nsConfiguration        OBJECT IDENTIFIER ::= {netSnmpObjects 7}
 
44
nsTransactions         OBJECT IDENTIFIER ::= {netSnmpObjects 8}
 
45
 
 
46
--
 
47
--  MIB Module data caching management
 
48
--
 
49
 
 
50
NetsnmpCacheStatus ::= TEXTUAL-CONVENTION
 
51
    STATUS      current
 
52
    DESCRIPTION "an indication of the status of data caching entries"
 
53
    SYNTAX INTEGER {
 
54
                enabled(1),
 
55
                disabled(2),
 
56
                empty  (3),
 
57
                cached (4),
 
58
                expired(5)
 
59
           }
 
60
 
 
61
nsCacheDefaultTimeout         OBJECT-TYPE
 
62
    SYNTAX      INTEGER         -- ???
 
63
    MAX-ACCESS  read-write
 
64
    STATUS      current
 
65
    DESCRIPTION
 
66
      "Default cache timeout value (unless overridden
 
67
       for a particular cache entry)."
 
68
    DEFVAL { 5 --seconds-- }
 
69
    ::= { nsCache 1 }
 
70
 
 
71
nsCacheEnabled                OBJECT-TYPE
 
72
    SYNTAX      TruthValue
 
73
    MAX-ACCESS  read-write
 
74
    STATUS      current
 
75
    DESCRIPTION
 
76
      "Whether data caching is active overall."
 
77
    DEFVAL { enabled(1) }
 
78
    ::= { nsCache 2 }
 
79
 
 
80
nsCacheTable     OBJECT-TYPE
 
81
    SYNTAX      SEQUENCE OF NsCacheEntry
 
82
    MAX-ACCESS  not-accessible
 
83
    STATUS      current
 
84
    DESCRIPTION
 
85
      "A table of individual MIB module data caches."
 
86
    ::= { nsCache 3 }
 
87
 
 
88
nsCacheEntry     OBJECT-TYPE
 
89
    SYNTAX      NsCacheEntry
 
90
    MAX-ACCESS  not-accessible
 
91
    STATUS      current
 
92
    DESCRIPTION
 
93
      "A conceptual row within the cache table."
 
94
    INDEX       { IMPLIED nsCachedOID }
 
95
    ::= { nsCacheTable 1 }
 
96
 
 
97
NsCacheEntry ::= SEQUENCE {
 
98
    nsCachedOID     OBJECT IDENTIFIER,
 
99
    nsCacheTimeout  INTEGER,            -- ?? TimeTicks ??
 
100
    nsCacheStatus   NetsnmpCacheStatus  -- ?? INTEGER ??
 
101
}
 
102
 
 
103
nsCachedOID     OBJECT-TYPE
 
104
    SYNTAX      OBJECT IDENTIFIER
 
105
    MAX-ACCESS  not-accessible
 
106
    STATUS      current
 
107
    DESCRIPTION
 
108
      "The root OID of the data being cached."
 
109
    ::= { nsCacheEntry 1 }
 
110
 
 
111
nsCacheTimeout  OBJECT-TYPE
 
112
    SYNTAX      INTEGER
 
113
    MAX-ACCESS  read-write
 
114
    STATUS      current
 
115
    DESCRIPTION
 
116
      "The length of time (?in seconds) for which the data in
 
117
       this particular cache entry will remain valid." 
 
118
    ::= { nsCacheEntry 2 }
 
119
 
 
120
nsCacheStatus   OBJECT-TYPE
 
121
    SYNTAX      NetsnmpCacheStatus
 
122
    MAX-ACCESS  read-write
 
123
    STATUS      current
 
124
    DESCRIPTION
 
125
      "The current status of this particular cache entry.
 
126
       Acceptable values for Set requests are 'enabled(1)',
 
127
       'disabled(2)' or 'empty(3)' (to clear all cached data).
 
128
       Requests to read the value of such an object will
 
129
       return 'disabled(2)' through to 'expired(5)'."
 
130
    ::= { nsCacheEntry 3 }
 
131
 
 
132
--
 
133
--  Agent configuration
 
134
--    Debug and logging output
 
135
--
 
136
 
 
137
nsConfigDebug          OBJECT IDENTIFIER ::= {nsConfiguration 1}
 
138
nsConfigLogging        OBJECT IDENTIFIER ::= {nsConfiguration 2}
 
139
 
 
140
nsDebugEnabled         OBJECT-TYPE
 
141
    SYNTAX      TruthValue
 
142
    MAX-ACCESS  read-write
 
143
    STATUS      current
 
144
    DESCRIPTION
 
145
      "Whether the agent is configured to generate debugging output"
 
146
    DEFVAL { false }
 
147
    ::= { nsConfigDebug 1 }
 
148
 
 
149
nsDebugOutputAll       OBJECT-TYPE
 
150
    SYNTAX      TruthValue
 
151
    MAX-ACCESS  read-write
 
152
    STATUS      current
 
153
    DESCRIPTION
 
154
      "Whether the agent is configured to display all debugging output
 
155
       rather than filtering on individual debug tokens.  Nothing will
 
156
       be generated unless nsDebugEnabled is also true(1)"
 
157
    DEFVAL { false }
 
158
    ::= { nsConfigDebug 2 }
 
159
 
 
160
nsDebugDumpPdu        OBJECT-TYPE
 
161
    SYNTAX      TruthValue
 
162
    MAX-ACCESS  read-write
 
163
    STATUS      current
 
164
    DESCRIPTION
 
165
      "Whether the agent is configured to display raw packet dumps.
 
166
       This is unrelated to the nsDebugEnabled setting."
 
167
    DEFVAL { false }
 
168
    ::= { nsConfigDebug 3 }
 
169
 
 
170
nsDebugTokenTable     OBJECT-TYPE
 
171
    SYNTAX      SEQUENCE OF NsDebugTokenEntry
 
172
    MAX-ACCESS  not-accessible
 
173
    STATUS      current
 
174
    DESCRIPTION
 
175
      "A table of individual debug tokens, used to control the selection
 
176
       of what debugging output should be produced.  This table is only
 
177
       effective if nsDebugOutputAll is false(2), and nothing will
 
178
       be generated unless nsDebugEnabled is also true(1)"
 
179
    ::= { nsConfigDebug 4 }
 
180
 
 
181
nsDebugTokenEntry     OBJECT-TYPE
 
182
    SYNTAX      NsDebugTokenEntry
 
183
    MAX-ACCESS  not-accessible
 
184
    STATUS      current
 
185
    DESCRIPTION
 
186
      "A conceptual row within the debug token table."
 
187
    INDEX       { IMPLIED nsDebugTokenPrefix }
 
188
    ::= { nsDebugTokenTable 1 }
 
189
 
 
190
NsDebugTokenEntry ::= SEQUENCE {
 
191
    nsDebugTokenPrefix  DisplayString,
 
192
    nsDebugTokenStats   RowStatus
 
193
}
 
194
 
 
195
nsDebugTokenPrefix    OBJECT-TYPE
 
196
    SYNTAX      DisplayString
 
197
    MAX-ACCESS  not-accessible
 
198
    STATUS      current
 
199
    DESCRIPTION
 
200
      "A token prefix for which to generate the corresponding
 
201
       debugging output.  Note that debug output will be generated
 
202
       for all registered debug statements sharing this prefix
 
203
       (rather than an exact match).  Nothing will be generated
 
204
       unless both nsDebuggingEnabled is set true(1) and the
 
205
       corresponding nsDebugTokenStatus value is active(1)."
 
206
    ::= { nsDebugTokenEntry 2 }
 
207
 
 
208
nsDebugTokenStatus   OBJECT-TYPE
 
209
    SYNTAX      RowStatus
 
210
    MAX-ACCESS  read-create
 
211
    STATUS      current
 
212
    DESCRIPTION
 
213
      "Whether to generate debug output for the corresponding debug
 
214
       token prefix.  Nothing will be generated unless both
 
215
       nsDebuggingEnabled is true(1) and this instance is active(1).
 
216
       Note that is valid for an instance to be left with the value
 
217
       notInService(2) indefinitely - i.e. the meaning of 'abnormally
 
218
       long' (see RFC 2579, RowStatus) for this table is infinite."
 
219
    ::= { nsDebugTokenEntry 4 }
 
220
 
 
221
--
 
222
-- Logging configuration
 
223
--
 
224
 
 
225
nsLoggingTable     OBJECT-TYPE
 
226
    SYNTAX      SEQUENCE OF NsLoggingEntry
 
227
    MAX-ACCESS  not-accessible
 
228
    STATUS      current
 
229
    DESCRIPTION
 
230
      "A table of individual logging output destinations, used to control
 
231
       where various levels of output from the agent should be directed."
 
232
    ::= { nsConfigLogging 1 }
 
233
 
 
234
nsLoggingEntry     OBJECT-TYPE
 
235
    SYNTAX      NsLoggingEntry
 
236
    MAX-ACCESS  not-accessible
 
237
    STATUS      current
 
238
    DESCRIPTION
 
239
      "A conceptual row within the logging table."
 
240
    INDEX       { nsLogLevel, IMPLIED nsLogToken }
 
241
    ::= { nsLoggingTable 1 }
 
242
 
 
243
NsLoggingEntry ::= SEQUENCE {
 
244
    nsLogLevel          INTEGER,
 
245
    nsLogToken          DisplayString,
 
246
    nsLogType           INTEGER,
 
247
    nsLogMaxLevel       INTEGER,
 
248
    nsLogStatus         RowStatus
 
249
}
 
250
 
 
251
nsLogLevel    OBJECT-TYPE
 
252
    SYNTAX      INTEGER {
 
253
                     emergency(0),
 
254
                     alert    (1),
 
255
                     critical (2),
 
256
                     error    (3),
 
257
                     warning  (4),
 
258
                     notice   (5),
 
259
                     info     (6),
 
260
                     debug    (7)
 
261
                }
 
262
    MAX-ACCESS  not-accessible
 
263
    STATUS      current
 
264
    DESCRIPTION
 
265
      "The (minimum) priority level for which this logging entry
 
266
       should be applied."
 
267
    ::= { nsLoggingEntry 1 }
 
268
 
 
269
nsLogToken    OBJECT-TYPE
 
270
    SYNTAX      DisplayString
 
271
    MAX-ACCESS  not-accessible
 
272
    STATUS      current
 
273
    DESCRIPTION
 
274
      "A token for which to generate logging entries.
 
275
       Depending on the style of logging, this may either
 
276
       be simply an arbitrary token, or may have some
 
277
       particular meaning (such as the filename to log to)."
 
278
    ::= { nsLoggingEntry 2 }
 
279
 
 
280
nsLogType     OBJECT-TYPE
 
281
    SYNTAX      INTEGER {
 
282
                     stdout   (1),
 
283
                     stderr   (2),
 
284
                     file     (3),
 
285
                     syslog   (4),
 
286
                     callback (5)
 
287
                }
 
288
    MAX-ACCESS  read-create
 
289
    STATUS      current
 
290
    DESCRIPTION
 
291
      "The type of logging for this entry."
 
292
    ::= { nsLoggingEntry 3 }
 
293
 
 
294
nsLogMaxLevel OBJECT-TYPE
 
295
    SYNTAX      INTEGER {
 
296
                     emergency(0),
 
297
                     alert    (1),
 
298
                     critical (2),
 
299
                     error    (3),
 
300
                     warning  (4),
 
301
                     notice   (5),
 
302
                     info     (6),
 
303
                     debug    (7)
 
304
                }
 
305
    MAX-ACCESS  read-create
 
306
    STATUS      current
 
307
    DESCRIPTION
 
308
      "The maximum priority level for which this logging entry
 
309
       should be applied."
 
310
    DEFVAL      { emergency(0) }
 
311
    ::= { nsLoggingEntry 4 }
 
312
 
 
313
nsLogStatus   OBJECT-TYPE
 
314
    SYNTAX      RowStatus
 
315
    MAX-ACCESS  read-create
 
316
    STATUS      current
 
317
    DESCRIPTION
 
318
      "Whether to generate logging output for this entry.
 
319
       Note that is valid for an instance to be left with the value
 
320
       notInService(2) indefinitely - i.e. the meaning of 'abnormally
 
321
       long' (see RFC 2579, RowStatus) for this table is infinite."
 
322
    ::= { nsLoggingEntry 5 }
 
323
 
 
324
--
 
325
--  Monitoring outstanding "transactions"
 
326
--    (i.e. requests sent to AgentX subagents, or proxied agents)
 
327
--
 
328
 
 
329
nsTransactionTable OBJECT-TYPE
 
330
    SYNTAX      SEQUENCE OF NsTransactionEntry
 
331
    MAX-ACCESS  not-accessible
 
332
    STATUS      current
 
333
    DESCRIPTION
 
334
        "Lists currently outstanding transactions in the net-snmp agent.
 
335
         This includes requests to AgentX subagents, or proxied SNMP agents."
 
336
    ::= { nsTransactions 1 }
 
337
 
 
338
nsTransactionEntry OBJECT-TYPE
 
339
    SYNTAX      NsTransactionEntry
 
340
    MAX-ACCESS  not-accessible
 
341
    STATUS      current
 
342
    DESCRIPTION
 
343
        "A row describing a given transaction."
 
344
    INDEX   { nsTransactionID }
 
345
    ::= {nsTransactionTable 1 }
 
346
 
 
347
NsTransactionEntry ::= SEQUENCE {
 
348
    nsTransactionID   INTEGER,
 
349
    nsTransactionMode Integer32
 
350
}
 
351
 
 
352
nsTransactionID OBJECT-TYPE
 
353
    SYNTAX      INTEGER (0..4294967295)
 
354
    MAX-ACCESS  not-accessible
 
355
    STATUS      current
 
356
    DESCRIPTION
 
357
        "The internal identifier for a given transaction."
 
358
    ::= { nsTransactionEntry 1 }
 
359
 
 
360
nsTransactionMode OBJECT-TYPE
 
361
    SYNTAX      Integer32
 
362
    MAX-ACCESS  read-only
 
363
    STATUS      current
 
364
    DESCRIPTION
 
365
        "The mode number for the current operation being performed."
 
366
    ::= { nsTransactionEntry 2 }
 
367
 
 
368
 
 
369
--
 
370
--  Monitoring the MIB modules currently registered in the agent
 
371
--    (an updated version of UCD-SNMP-MIB::mrTable)
 
372
--
 
373
 
 
374
nsModuleTable OBJECT-TYPE
 
375
    SYNTAX      SEQUENCE OF NsModuleEntry
 
376
    MAX-ACCESS  not-accessible
 
377
    STATUS      current
 
378
    DESCRIPTION
 
379
        "A table displaying all the oid's registered by mib modules in
 
380
         the agent.  Since the agent is modular in nature, this lists
 
381
         each module's OID it is responsible for and the name of the module"
 
382
    ::= { nsMibRegistry 1 }
 
383
 
 
384
nsModuleEntry OBJECT-TYPE
 
385
    SYNTAX      NsModuleEntry
 
386
    MAX-ACCESS  not-accessible
 
387
    STATUS      current
 
388
    DESCRIPTION
 
389
        "An entry containing a registered mib oid."
 
390
    INDEX       { nsmContextName, nsmRegistrationPoint, 
 
391
                  nsmRegistrationPriority }
 
392
    ::= { nsModuleTable 1 }
 
393
 
 
394
NsModuleEntry ::= SEQUENCE {
 
395
    nsmContextName          OCTET STRING,
 
396
    nsmRegistrationPoint    OBJECT IDENTIFIER,
 
397
    nsmRegistrationPriority INTEGER,
 
398
    nsModuleName            DisplayString,
 
399
    nsModuleModes           BITS,
 
400
    nsModuleTimeout         Integer32
 
401
}
 
402
 
 
403
nsmContextName OBJECT-TYPE
 
404
    SYNTAX      OCTET STRING
 
405
    MAX-ACCESS  not-accessible
 
406
    STATUS      current
 
407
    DESCRIPTION
 
408
        "The context name the module is registered under."
 
409
    ::= { nsModuleEntry 1 }
 
410
 
 
411
nsmRegistrationPoint OBJECT-TYPE
 
412
    SYNTAX      OBJECT IDENTIFIER
 
413
    MAX-ACCESS  not-accessible
 
414
    STATUS      current
 
415
    DESCRIPTION
 
416
        "The registry OID of a mib module."
 
417
    ::= { nsModuleEntry  2 }
 
418
 
 
419
nsmRegistrationPriority OBJECT-TYPE
 
420
    SYNTAX      INTEGER
 
421
    MAX-ACCESS  not-accessible
 
422
    STATUS      current
 
423
    DESCRIPTION
 
424
        "The priority of the registered mib module."
 
425
    ::= { nsModuleEntry  3 }
 
426
 
 
427
nsModuleName OBJECT-TYPE
 
428
    SYNTAX      DisplayString
 
429
    MAX-ACCESS  read-only
 
430
    STATUS      current
 
431
    DESCRIPTION
 
432
        "The module name that registered this OID."
 
433
    ::= { nsModuleEntry  4 }
 
434
 
 
435
nsModuleModes OBJECT-TYPE
 
436
    SYNTAX      BITS { getAndGetNext(0), set(1), getBulk(2) }
 
437
    MAX-ACCESS  read-only
 
438
    STATUS      current
 
439
    DESCRIPTION
 
440
        "The modes that the particular lower level handler can cope
 
441
         with directly."
 
442
    ::= { nsModuleEntry  5 }
 
443
 
 
444
nsModuleTimeout OBJECT-TYPE
 
445
    SYNTAX      Integer32
 
446
    MAX-ACCESS  read-only
 
447
    STATUS      current
 
448
    DESCRIPTION
 
449
        "The registered timeout.  This is only meaningful for handlers
 
450
         that expect to return results at a later date (subagents,
 
451
         etc)"
 
452
    ::= { nsModuleEntry  6 }
 
453
 
 
454
 
 
455
--
 
456
--  Notifications relating to the basic operation of the agent
 
457
--
 
458
 
 
459
nsNotifyStart        NOTIFICATION-TYPE
 
460
    STATUS      current
 
461
    DESCRIPTION
 
462
        "An indication that the agent has started running."
 
463
    ::= { netSnmpNotifications 1 }
 
464
    
 
465
nsNotifyShutdown     NOTIFICATION-TYPE
 
466
    STATUS current
 
467
    DESCRIPTION
 
468
        "An indication that the agent is in the process of being shut down."
 
469
    ::= { netSnmpNotifications 2 }
 
470
 
 
471
nsNotifyRestart      NOTIFICATION-TYPE
 
472
    STATUS      current
 
473
    DESCRIPTION
 
474
        "An indication that the agent has been restarted.
 
475
         This does not imply anything about whether the configuration has
 
476
         changed or not (unlike the standard coldStart or warmStart traps)"
 
477
    ::= { netSnmpNotifications 3 }
 
478
    
 
479
 
 
480
--
 
481
-- Conformance-related definitions
 
482
--
 
483
 
 
484
nsModuleGroup  OBJECT-GROUP
 
485
    OBJECTS {
 
486
        nsmContextName, nsmRegistrationPoint, nsmRegistrationPriority,
 
487
        nsModuleName, nsModuleModes, nsModuleTimeout
 
488
    }
 
489
    STATUS      current
 
490
    DESCRIPTION
 
491
        "The objects relating to the list of MIB modules registered
 
492
         with the Net-SNMP agent."
 
493
    ::= { netSnmpGroups 2 }
 
494
 
 
495
nsCacheGroup  OBJECT-GROUP
 
496
    OBJECTS {
 
497
        nsCacheDefaultTimeout, nsCacheEnabled,
 
498
        nsCacheTimeout,        nsCacheStatus
 
499
    }
 
500
    STATUS      current
 
501
    DESCRIPTION
 
502
        "The objects relating to data caching in the Net-SNMP agent."
 
503
    ::= { netSnmpGroups 4 }
 
504
 
 
505
nsConfigGroups OBJECT IDENTIFIER ::= {netSnmpGroups 7}
 
506
 
 
507
nsDebugGroup  OBJECT-GROUP
 
508
    OBJECTS {
 
509
        nsDebugEnabled, nsDebugOutputAll, nsDebugDumpPdu,
 
510
        nsDebugTokenPrefix, nsDebugTokenStatus
 
511
    }
 
512
    STATUS      current
 
513
    DESCRIPTION
 
514
        "The objects relating to debug configuration in the Net-SNMP agent."
 
515
    ::= { nsConfigGroups 1 }
 
516
 
 
517
nsLoggingGroup  OBJECT-GROUP
 
518
    OBJECTS {
 
519
        nsLogType, nsLogMaxLevel, nsLogStatus
 
520
    }
 
521
    STATUS      current
 
522
    DESCRIPTION
 
523
        "The objects relating to logging configuration in the Net-SNMP agent."
 
524
    ::= { nsConfigGroups 2 }
 
525
 
 
526
nsTransctionGroup  OBJECT-GROUP
 
527
    OBJECTS {
 
528
        nsTransactionID, nsTransactionMode
 
529
    }
 
530
    STATUS      current
 
531
    DESCRIPTION
 
532
        "The objects relating to transaction monitoring in the Net-SNMP agent."
 
533
    ::= { netSnmpGroups 8 }
 
534
 
 
535
nsAgentNotifyGroup NOTIFICATION-GROUP
 
536
    NOTIFICATIONS { nsNotifyStart, nsNotifyShutdown, nsNotifyRestart }
 
537
    STATUS      current
 
538
    DESCRIPTION
 
539
        "The notifications relating to the basic operation of the Net-SNMP agent."
 
540
    ::= { netSnmpGroups 9 }
 
541
 
 
542
    
 
543
 
 
544
END