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