NET-SNMP-AGENT-MIB.txt 16 KB

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