userapps/opensource/net-snmp/mibs/NET-SNMP-AGENT-MIB.txt

   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 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 --  Monitoring outstanding "transactions"
  48 --    (i.e. requests sent to AgentX subagents, or proxied agents)
  49 --
  50
  51 nsTransactionTable OBJECT-TYPE
  52     SYNTAX      SEQUENCE OF NsTransactionEntry
  53     MAX-ACCESS  not-accessible
  54     STATUS      current
  55     DESCRIPTION
  56         "Lists currently outstanding transactions in the net-snmp agent.
  57          This includes requests to AgentX subagents, or proxied SNMP agents."
  58     ::= { nsTransactions 1 }
  59
  60 nsTransactionEntry OBJECT-TYPE
  61     SYNTAX      NsTransactionEntry
  62     MAX-ACCESS  not-accessible
  63     STATUS      current
  64     DESCRIPTION
  65         "A row describing a given transaction."
  66     INDEX   { nsTransactionID }
  67     ::= {nsTransactionTable 1 }
  68
  69 NsTransactionEntry ::= SEQUENCE {
  70     nsTransactionID   INTEGER,
  71     nsTransactionMode Integer32
  72 }
  73
  74 nsTransactionID OBJECT-TYPE
  75     SYNTAX      INTEGER (0..4294967295)
  76     MAX-ACCESS  not-accessible
  77     STATUS      current
  78     DESCRIPTION
  79         "The internal identifier for a given transaction."
  80     ::= { nsTransactionEntry 1 }
  81
  82 nsTransactionMode OBJECT-TYPE
  83     SYNTAX      Integer32
  84     MAX-ACCESS  read-only
  85     STATUS      current
  86     DESCRIPTION
  87         "The mode number for the current operation being performed."
  88     ::= { nsTransactionEntry 2 }
  89
  90
  91 --
  92 --  Monitoring the MIB modules currently registered in the agent
  93 --    (an updated version of UCD-SNMP-MIB::mrTable)
  94 --
  95
  96 nsModuleTable OBJECT-TYPE
  97     SYNTAX      SEQUENCE OF NsModuleEntry
  98     MAX-ACCESS  not-accessible
  99     STATUS      current
 100     DESCRIPTION
 101         "A table displaying all the oid's registered by mib modules in
 102          the agent.  Since the agent is modular in nature, this lists
 103          each module's OID it is responsible for and the name of the module"
 104     ::= { nsMibRegistry 1 }
 105
 106 nsModuleEntry OBJECT-TYPE
 107     SYNTAX      NsModuleEntry
 108     MAX-ACCESS  not-accessible
 109     STATUS      current
 110     DESCRIPTION
 111         "An entry containing a registered mib oid."
 112     INDEX       { nsmContextName, nsmRegistrationPoint,
 113                   nsmRegistrationPriority }
 114     ::= { nsModuleTable 1 }
 115
 116 NsModuleEntry ::= SEQUENCE {
 117     nsmContextName          OCTET STRING,
 118     nsmRegistrationPoint    OBJECT IDENTIFIER,
 119     nsmRegistrationPriority INTEGER,
 120     nsModuleName            DisplayString,
 121     nsModuleModes           BITS,
 122     nsModuleTimeout         Integer32
 123 }
 124
 125 nsmContextName OBJECT-TYPE
 126     SYNTAX      OCTET STRING
 127     MAX-ACCESS  not-accessible
 128     STATUS      current
 129     DESCRIPTION
 130         "The context name the module is registered under."
 131     ::= { nsModuleEntry 1 }
 132
 133 nsmRegistrationPoint OBJECT-TYPE
 134     SYNTAX      OBJECT IDENTIFIER
 135     MAX-ACCESS  not-accessible
 136     STATUS      current
 137     DESCRIPTION
 138         "The registry OID of a mib module."
 139     ::= { nsModuleEntry  2 }
 140
 141 nsmRegistrationPriority OBJECT-TYPE
 142     SYNTAX      INTEGER
 143     MAX-ACCESS  not-accessible
 144     STATUS      current
 145     DESCRIPTION
 146         "The priority of the registered mib module."
 147     ::= { nsModuleEntry  3 }
 148
 149 nsModuleName OBJECT-TYPE
 150     SYNTAX      DisplayString
 151     MAX-ACCESS  read-only
 152     STATUS      current
 153     DESCRIPTION
 154         "The module name that registered this OID."
 155     ::= { nsModuleEntry  4 }
 156
 157 nsModuleModes OBJECT-TYPE
 158     SYNTAX      BITS { getAndGetNext(0), set(1), getBulk(2) }
 159     MAX-ACCESS  read-only
 160     STATUS      current
 161     DESCRIPTION
 162         "The modes that the particular lower level handler can cope
 163          with directly."
 164     ::= { nsModuleEntry  5 }
 165
 166 nsModuleTimeout OBJECT-TYPE
 167     SYNTAX      Integer32
 168     MAX-ACCESS  read-only
 169     STATUS      current
 170     DESCRIPTION
 171         "The registered timeout.  This is only meaningful for handlers
 172          that expect to return results at a later date (subagents,
 173          etc)"
 174     ::= { nsModuleEntry  6 }
 175
 176
 177 --
 178 --  Notifications relating to the basic operation of the agent
 179 --
 180
 181 nsNotifyStart        NOTIFICATION-TYPE
 182     STATUS      current
 183     DESCRIPTION
 184         "An indication that the agent has started running."
 185     ::= { netSnmpNotifications 1 }
 186
 187 nsNotifyShutdown     NOTIFICATION-TYPE
 188     STATUS current
 189     DESCRIPTION
 190         "An indication that the agent is in the process of being shut down."
 191     ::= { netSnmpNotifications 2 }
 192
 193 nsNotifyRestart      NOTIFICATION-TYPE
 194     STATUS      current
 195     DESCRIPTION
 196         "An indication that the agent has been restarted.
 197          This does not imply anything about whether the configuration has
 198          changed or not (unlike the standard coldStart or warmStart traps)"
 199     ::= { netSnmpNotifications 3 }
 200
 201
 202 --
 203 -- Conformance-related definitions
 204 --
 205
 206 nsModuleGroup  OBJECT-GROUP
 207     OBJECTS {
 208         nsmContextName, nsmRegistrationPoint, nsmRegistrationPriority,
 209         nsModuleName, nsModuleModes, nsModuleTimeout
 210     }
 211     STATUS      current
 212     DESCRIPTION
 213         "The objects relating to the list of MIB modules registered
 214          with the Net-SNMP agent."
 215     ::= { netSnmpGroups 2 }
 216
 217 nsTransctionGroup  OBJECT-GROUP
 218     OBJECTS {
 219         nsTransactionID, nsTransactionMode
 220     }
 221     STATUS      current
 222     DESCRIPTION
 223         "The objects relating to transaction monitoring in the Net-SNMP agent."
 224     ::= { netSnmpGroups 8 }
 225
 226 nsAgentNotifyGroup NOTIFICATION-GROUP
 227     NOTIFICATIONS { nsNotifyStart, nsNotifyShutdown, nsNotifyRestart }
 228     STATUS      current
 229     DESCRIPTION
 230         "The notifications relating to the basic operation of the Net-SNMP agent."
 231     ::= { netSnmpGroups 9 }
 232
 233
 234
 235 END