1
NET-SNMP-AGENT-MIB DEFINITIONS ::= BEGIN
4
-- Defines control and monitoring structures for the Net-SNMP agent.
8
netSnmpObjects, netSnmpModuleIDs, netSnmpNotifications, netSnmpGroups
11
OBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY, Integer32
14
OBJECT-GROUP, NOTIFICATION-GROUP
17
DisplayString, RowStatus, TruthValue FROM SNMPv2-TC;
20
netSnmpAgentMIB MODULE-IDENTITY
21
LAST-UPDATED "200202090000Z"
22
ORGANIZATION "www.net-snmp.org"
28
email: net-snmp-coders@lists.sourceforge.net"
30
"Defines control and monitoring structures for the Net-SNMP agent."
31
REVISION "200202090000Z"
34
::= { netSnmpModuleIDs 2 }
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}
47
-- MIB Module data caching management
50
NetsnmpCacheStatus ::= TEXTUAL-CONVENTION
52
DESCRIPTION "an indication of the status of data caching entries"
61
nsCacheDefaultTimeout OBJECT-TYPE
66
"Default cache timeout value (unless overridden
67
for a particular cache entry)."
68
DEFVAL { 5 --seconds-- }
71
nsCacheEnabled OBJECT-TYPE
76
"Whether data caching is active overall."
80
nsCacheTable OBJECT-TYPE
81
SYNTAX SEQUENCE OF NsCacheEntry
82
MAX-ACCESS not-accessible
85
"A table of individual MIB module data caches."
88
nsCacheEntry OBJECT-TYPE
90
MAX-ACCESS not-accessible
93
"A conceptual row within the cache table."
94
INDEX { IMPLIED nsCachedOID }
95
::= { nsCacheTable 1 }
97
NsCacheEntry ::= SEQUENCE {
98
nsCachedOID OBJECT IDENTIFIER,
99
nsCacheTimeout INTEGER, -- ?? TimeTicks ??
100
nsCacheStatus NetsnmpCacheStatus -- ?? INTEGER ??
103
nsCachedOID OBJECT-TYPE
104
SYNTAX OBJECT IDENTIFIER
105
MAX-ACCESS not-accessible
108
"The root OID of the data being cached."
109
::= { nsCacheEntry 1 }
111
nsCacheTimeout OBJECT-TYPE
113
MAX-ACCESS read-write
116
"The length of time (?in seconds) for which the data in
117
this particular cache entry will remain valid."
118
::= { nsCacheEntry 2 }
120
nsCacheStatus OBJECT-TYPE
121
SYNTAX NetsnmpCacheStatus
122
MAX-ACCESS read-write
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 }
133
-- Agent configuration
134
-- Debug and logging output
137
nsConfigDebug OBJECT IDENTIFIER ::= {nsConfiguration 1}
138
nsConfigLogging OBJECT IDENTIFIER ::= {nsConfiguration 2}
140
nsDebugEnabled OBJECT-TYPE
142
MAX-ACCESS read-write
145
"Whether the agent is configured to generate debugging output"
147
::= { nsConfigDebug 1 }
149
nsDebugOutputAll OBJECT-TYPE
151
MAX-ACCESS read-write
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)"
158
::= { nsConfigDebug 2 }
160
nsDebugDumpPdu OBJECT-TYPE
162
MAX-ACCESS read-write
165
"Whether the agent is configured to display raw packet dumps.
166
This is unrelated to the nsDebugEnabled setting."
168
::= { nsConfigDebug 3 }
170
nsDebugTokenTable OBJECT-TYPE
171
SYNTAX SEQUENCE OF NsDebugTokenEntry
172
MAX-ACCESS not-accessible
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 }
181
nsDebugTokenEntry OBJECT-TYPE
182
SYNTAX NsDebugTokenEntry
183
MAX-ACCESS not-accessible
186
"A conceptual row within the debug token table."
187
INDEX { IMPLIED nsDebugTokenPrefix }
188
::= { nsDebugTokenTable 1 }
190
NsDebugTokenEntry ::= SEQUENCE {
191
nsDebugTokenPrefix DisplayString,
192
nsDebugTokenStats RowStatus
195
nsDebugTokenPrefix OBJECT-TYPE
197
MAX-ACCESS not-accessible
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 }
208
nsDebugTokenStatus OBJECT-TYPE
210
MAX-ACCESS read-create
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 }
222
-- Logging configuration
225
nsLoggingTable OBJECT-TYPE
226
SYNTAX SEQUENCE OF NsLoggingEntry
227
MAX-ACCESS not-accessible
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 }
234
nsLoggingEntry OBJECT-TYPE
235
SYNTAX NsLoggingEntry
236
MAX-ACCESS not-accessible
239
"A conceptual row within the logging table."
240
INDEX { nsLogLevel, IMPLIED nsLogToken }
241
::= { nsLoggingTable 1 }
243
NsLoggingEntry ::= SEQUENCE {
245
nsLogToken DisplayString,
247
nsLogMaxLevel INTEGER,
248
nsLogStatus RowStatus
251
nsLogLevel OBJECT-TYPE
262
MAX-ACCESS not-accessible
265
"The (minimum) priority level for which this logging entry
267
::= { nsLoggingEntry 1 }
269
nsLogToken OBJECT-TYPE
271
MAX-ACCESS not-accessible
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 }
280
nsLogType OBJECT-TYPE
288
MAX-ACCESS read-create
291
"The type of logging for this entry."
292
::= { nsLoggingEntry 3 }
294
nsLogMaxLevel OBJECT-TYPE
305
MAX-ACCESS read-create
308
"The maximum priority level for which this logging entry
310
DEFVAL { emergency(0) }
311
::= { nsLoggingEntry 4 }
313
nsLogStatus OBJECT-TYPE
315
MAX-ACCESS read-create
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 }
325
-- Monitoring outstanding "transactions"
326
-- (i.e. requests sent to AgentX subagents, or proxied agents)
329
nsTransactionTable OBJECT-TYPE
330
SYNTAX SEQUENCE OF NsTransactionEntry
331
MAX-ACCESS not-accessible
334
"Lists currently outstanding transactions in the net-snmp agent.
335
This includes requests to AgentX subagents, or proxied SNMP agents."
336
::= { nsTransactions 1 }
338
nsTransactionEntry OBJECT-TYPE
339
SYNTAX NsTransactionEntry
340
MAX-ACCESS not-accessible
343
"A row describing a given transaction."
344
INDEX { nsTransactionID }
345
::= {nsTransactionTable 1 }
347
NsTransactionEntry ::= SEQUENCE {
348
nsTransactionID INTEGER,
349
nsTransactionMode Integer32
352
nsTransactionID OBJECT-TYPE
353
SYNTAX INTEGER (0..4294967295)
354
MAX-ACCESS not-accessible
357
"The internal identifier for a given transaction."
358
::= { nsTransactionEntry 1 }
360
nsTransactionMode OBJECT-TYPE
365
"The mode number for the current operation being performed."
366
::= { nsTransactionEntry 2 }
370
-- Monitoring the MIB modules currently registered in the agent
371
-- (an updated version of UCD-SNMP-MIB::mrTable)
374
nsModuleTable OBJECT-TYPE
375
SYNTAX SEQUENCE OF NsModuleEntry
376
MAX-ACCESS not-accessible
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 }
384
nsModuleEntry OBJECT-TYPE
386
MAX-ACCESS not-accessible
389
"An entry containing a registered mib oid."
390
INDEX { nsmContextName, nsmRegistrationPoint,
391
nsmRegistrationPriority }
392
::= { nsModuleTable 1 }
394
NsModuleEntry ::= SEQUENCE {
395
nsmContextName OCTET STRING,
396
nsmRegistrationPoint OBJECT IDENTIFIER,
397
nsmRegistrationPriority INTEGER,
398
nsModuleName DisplayString,
400
nsModuleTimeout Integer32
403
nsmContextName OBJECT-TYPE
405
MAX-ACCESS not-accessible
408
"The context name the module is registered under."
409
::= { nsModuleEntry 1 }
411
nsmRegistrationPoint OBJECT-TYPE
412
SYNTAX OBJECT IDENTIFIER
413
MAX-ACCESS not-accessible
416
"The registry OID of a mib module."
417
::= { nsModuleEntry 2 }
419
nsmRegistrationPriority OBJECT-TYPE
421
MAX-ACCESS not-accessible
424
"The priority of the registered mib module."
425
::= { nsModuleEntry 3 }
427
nsModuleName OBJECT-TYPE
432
"The module name that registered this OID."
433
::= { nsModuleEntry 4 }
435
nsModuleModes OBJECT-TYPE
436
SYNTAX BITS { getAndGetNext(0), set(1), getBulk(2) }
440
"The modes that the particular lower level handler can cope
442
::= { nsModuleEntry 5 }
444
nsModuleTimeout OBJECT-TYPE
449
"The registered timeout. This is only meaningful for handlers
450
that expect to return results at a later date (subagents,
452
::= { nsModuleEntry 6 }
456
-- Notifications relating to the basic operation of the agent
459
nsNotifyStart NOTIFICATION-TYPE
462
"An indication that the agent has started running."
463
::= { netSnmpNotifications 1 }
465
nsNotifyShutdown NOTIFICATION-TYPE
468
"An indication that the agent is in the process of being shut down."
469
::= { netSnmpNotifications 2 }
471
nsNotifyRestart NOTIFICATION-TYPE
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 }
481
-- Conformance-related definitions
484
nsModuleGroup OBJECT-GROUP
486
nsmContextName, nsmRegistrationPoint, nsmRegistrationPriority,
487
nsModuleName, nsModuleModes, nsModuleTimeout
491
"The objects relating to the list of MIB modules registered
492
with the Net-SNMP agent."
493
::= { netSnmpGroups 2 }
495
nsCacheGroup OBJECT-GROUP
497
nsCacheDefaultTimeout, nsCacheEnabled,
498
nsCacheTimeout, nsCacheStatus
502
"The objects relating to data caching in the Net-SNMP agent."
503
::= { netSnmpGroups 4 }
505
nsConfigGroups OBJECT IDENTIFIER ::= {netSnmpGroups 7}
507
nsDebugGroup OBJECT-GROUP
509
nsDebugEnabled, nsDebugOutputAll, nsDebugDumpPdu,
510
nsDebugTokenPrefix, nsDebugTokenStatus
514
"The objects relating to debug configuration in the Net-SNMP agent."
515
::= { nsConfigGroups 1 }
517
nsLoggingGroup OBJECT-GROUP
519
nsLogType, nsLogMaxLevel, nsLogStatus
523
"The objects relating to logging configuration in the Net-SNMP agent."
524
::= { nsConfigGroups 2 }
526
nsTransctionGroup OBJECT-GROUP
528
nsTransactionID, nsTransactionMode
532
"The objects relating to transaction monitoring in the Net-SNMP agent."
533
::= { netSnmpGroups 8 }
535
nsAgentNotifyGroup NOTIFICATION-GROUP
536
NOTIFICATIONS { nsNotifyStart, nsNotifyShutdown, nsNotifyRestart }
539
"The notifications relating to the basic operation of the Net-SNMP agent."
540
::= { netSnmpGroups 9 }