userapps/opensource/net-snmp/mibs/AGENTX-MIB.txt

   1 AGENTX-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4  MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, mib-2
   5     FROM SNMPv2-SMI
   6  SnmpAdminString
   7     FROM SNMP-FRAMEWORK-MIB
   8  MODULE-COMPLIANCE, OBJECT-GROUP
   9     FROM SNMPv2-CONF
  10  TEXTUAL-CONVENTION, TimeStamp, TruthValue, TDomain
  11     FROM SNMPv2-TC;
  12 agentxMIB MODULE-IDENTITY
  13  LAST-UPDATED "200001100000Z" -- Midnight 10 January 2000
  14  ORGANIZATION "AgentX Working Group"
  15  CONTACT-INFO "WG-email:   agentx@dorothy.bmc.com
  16                Subscribe:  agentx-request@dorothy.bmc.com
  17                WG-email Archive:  ftp://ftp.peer.com/pub/agentx/archives
  18                FTP repository:  ftp://ftp.peer.com/pub/agentx
  19                http://www.ietf.org/html.charters/agentx-charter.html
  20
  21                Chair:      Bob Natale
  22                            ACE*COMM Corporation
  23                Email:      bnatale@acecomm.com
  24
  25                WG editor:  Mark Ellison
  26                            Ellison Software Consulting, Inc.
  27                Email:      ellison@world.std.com
  28
  29                Co-author:  Lauren Heintz
  30                            Cisco Systems,
  31                EMail:      lheintz@cisco.com
  32
  33                Co-author:  Smitha Gudur
  34                            Independent Consultant
  35                Email:      sgudur@hotmail.com
  36               "
  37  DESCRIPTION    "This is the MIB module for the SNMP Agent Extensibility
  38      Protocol (AgentX).  This MIB module will be implemented by
  39      the master agent.
  40     "
  41
  42   REVISION     "200001100000Z" -- Midnight 10 January 2000
  43  DESCRIPTION
  44     "Initial version published as RFC 2742."
  45   ::= { mib-2  74 }
  46
  47  -- Textual Conventions
  48
  49  AgentxTAddress ::= TEXTUAL-CONVENTION
  50    STATUS       current
  51    DESCRIPTION
  52      "Denotes a transport service address.  This is identical to
  53       the TAddress textual convention (SNMPv2-SMI) except that
  54       zero-length values are permitted.
  55      "
  56    SYNTAX       OCTET STRING (SIZE (0..255))
  57
  58  -- Administrative assignments
  59
  60  agentxObjects OBJECT IDENTIFIER      ::= { agentxMIB 1 }
  61  agentxGeneral OBJECT IDENTIFIER      ::= { agentxObjects 1 }
  62  agentxConnection OBJECT IDENTIFIER   ::= { agentxObjects 2 }
  63  agentxSession OBJECT IDENTIFIER      ::= { agentxObjects 3 }
  64  agentxRegistration OBJECT IDENTIFIER ::= { agentxObjects 4 }
  65
  66  agentxDefaultTimeout OBJECT-TYPE
  67   SYNTAX      INTEGER (0..255)
  68   UNITS       "seconds"
  69   MAX-ACCESS  read-only
  70   STATUS      current
  71   DESCRIPTION
  72      "The default length of time, in seconds, that the master
  73       agent should allow to elapse after dispatching a message
  74       to a session before it regards the subagent as not
  75       responding.  This is a system-wide value that may
  76       override the timeout value associated with a particular
  77       session (agentxSessionTimeout) or a particular registered
  78       MIB region (agentxRegTimeout).  If the associated value of
  79       agentxSessionTimeout and agentxRegTimeout are zero, or
  80       impractical in accordance with implementation-specific
  81       procedure of the master agent, the value represented by
  82       this object will be the effective timeout value for the
  83
  84       master agent to await a response to a dispatch from a
  85       given subagent.
  86      "
  87   DEFVAL      { 5 }
  88   ::= { agentxGeneral 1 }
  89
  90  agentxMasterAgentXVer OBJECT-TYPE
  91   SYNTAX      INTEGER (1..255)
  92   MAX-ACCESS  read-only
  93   STATUS      current
  94   DESCRIPTION
  95      "The AgentX protocol version supported by this master agent.
  96       The current protocol version is 1.  Note that the master agent
  97       must also allow interaction with earlier version subagents.
  98      "
  99   ::= { agentxGeneral 2 }
 100
 101  --      The AgentX Subagent Connection Group
 102
 103  agentxConnTableLastChange OBJECT-TYPE
 104   SYNTAX      TimeStamp
 105   MAX-ACCESS  read-only
 106   STATUS      current
 107   DESCRIPTION
 108      "The value of sysUpTime when the last row creation or deletion
 109       occurred in the agentxConnectionTable.
 110      "
 111   ::= { agentxConnection 1 }
 112
 113  agentxConnectionTable OBJECT-TYPE
 114    SYNTAX      SEQUENCE OF AgentxConnectionEntry
 115    MAX-ACCESS  not-accessible
 116    STATUS      current
 117    DESCRIPTION
 118      "The agentxConnectionTable tracks all current AgentX transport
 119       connections.  There may be zero, one, or more AgentX sessions
 120       carried on a given AgentX connection.
 121      "
 122    ::= { agentxConnection 2 }
 123
 124  agentxConnectionEntry OBJECT-TYPE
 125    SYNTAX      AgentxConnectionEntry
 126    MAX-ACCESS  not-accessible
 127    STATUS      current
 128    DESCRIPTION
 129      "An agentxConnectionEntry contains information describing a
 130       single AgentX transport connection.  A connection may be
 131
 132       used to support zero or more AgentX sessions.  An entry is
 133       created when a new transport connection is established,
 134       and is destroyed when the transport connection is terminated.
 135      "
 136    INDEX { agentxConnIndex }
 137    ::= { agentxConnectionTable 1 }
 138
 139  AgentxConnectionEntry ::= SEQUENCE {
 140           agentxConnIndex            Unsigned32,
 141           agentxConnOpenTime         TimeStamp,
 142           agentxConnTransportDomain  TDomain,
 143           agentxConnTransportAddress AgentxTAddress }
 144
 145  agentxConnIndex OBJECT-TYPE
 146    SYNTAX       Unsigned32 (1..4294967295)
 147    MAX-ACCESS   not-accessible
 148    STATUS       current
 149    DESCRIPTION
 150      "agentxConnIndex contains the value that uniquely identifies
 151       an open transport connection used by this master agent
 152       to provide AgentX service.  Values of this index should
 153       not be re-used.  The value assigned to a given transport
 154       connection is constant for the lifetime of that connection.
 155      "
 156    ::= { agentxConnectionEntry 1 }
 157
 158  agentxConnOpenTime OBJECT-TYPE
 159    SYNTAX       TimeStamp
 160    MAX-ACCESS   read-only
 161    STATUS       current
 162    DESCRIPTION
 163      "The value of sysUpTime when this connection was established
 164       and, therefore, its value when this entry was added to the table.
 165      "
 166    ::= { agentxConnectionEntry 2 }
 167
 168  agentxConnTransportDomain OBJECT-TYPE
 169    SYNTAX       TDomain
 170    MAX-ACCESS   read-only
 171    STATUS       current
 172    DESCRIPTION
 173      "The transport protocol in use for this connection to the
 174       subagent.
 175      "
 176    ::= { agentxConnectionEntry 3 }
 177
 178  agentxConnTransportAddress OBJECT-TYPE
 179    SYNTAX       AgentxTAddress
 180    MAX-ACCESS   read-only
 181    STATUS       current
 182    DESCRIPTION
 183      "The transport address of the remote (subagent) end of this
 184       connection to the master agent.  This object may be zero-length
 185       for unix-domain sockets (and possibly other types of transport
 186       addresses) since the subagent need not bind a filename to its
 187       local socket.
 188      "
 189    ::= { agentxConnectionEntry 4 }
 190
 191  -- The AgentX Subagent Session Group
 192
 193  agentxSessionTableLastChange OBJECT-TYPE
 194   SYNTAX      TimeStamp
 195   MAX-ACCESS  read-only
 196   STATUS      current
 197   DESCRIPTION
 198      "The value of sysUpTime when the last row creation or deletion
 199       occurred in the agentxSessionTable.
 200      "
 201   ::= { agentxSession 1 }
 202
 203  agentxSessionTable OBJECT-TYPE
 204   SYNTAX      SEQUENCE OF AgentxSessionEntry
 205   MAX-ACCESS  not-accessible
 206   STATUS      current
 207   DESCRIPTION
 208      "A table of AgentX subagent sessions currently in effect.
 209      "
 210   ::= { agentxSession 2 }
 211
 212  agentxSessionEntry OBJECT-TYPE
 213   SYNTAX      AgentxSessionEntry
 214   MAX-ACCESS  not-accessible
 215   STATUS      current
 216   DESCRIPTION
 217      "Information about a single open session between the AgentX
 218       master agent and a subagent is contained in this entry.  An
 219       entry is created when a new session is successfully established
 220       and is destroyed either when the subagent transport connection
 221       has terminated or when the subagent session is closed.
 222      "
 223   INDEX       { agentxConnIndex, agentxSessionIndex }
 224   ::= { agentxSessionTable 1 }
 225
 226  AgentxSessionEntry ::= SEQUENCE {
 227   agentxSessionIndex         Unsigned32,
 228   agentxSessionObjectID      OBJECT IDENTIFIER,
 229   agentxSessionDescr         SnmpAdminString,
 230   agentxSessionAdminStatus   INTEGER,
 231   agentxSessionOpenTime      TimeStamp,
 232   agentxSessionAgentXVer     INTEGER,
 233   agentxSessionTimeout       INTEGER
 234  }
 235
 236  agentxSessionIndex OBJECT-TYPE
 237   SYNTAX      Unsigned32 (0..4294967295)
 238   MAX-ACCESS  not-accessible
 239   STATUS      current
 240   DESCRIPTION
 241      "A unique index for the subagent session.  It is the same as
 242       h.sessionID defined in the agentx header.  Note that if
 243       a subagent's session with the master agent is closed for
 244       any reason its index should not be re-used.
 245       A value of zero(0) is specifically allowed in order
 246       to be compatible with the definition of h.sessionId.
 247      "
 248   ::= { agentxSessionEntry 1 }
 249
 250  agentxSessionObjectID OBJECT-TYPE
 251   SYNTAX      OBJECT IDENTIFIER
 252   MAX-ACCESS  read-only
 253   STATUS      current
 254   DESCRIPTION
 255      "This is taken from the o.id field of the agentx-Open-PDU.
 256       This attribute will report a value of '0.0' for subagents
 257       not supporting the notion of an AgentX session object
 258       identifier.
 259      "
 260   ::= { agentxSessionEntry 2 }
 261
 262  agentxSessionDescr OBJECT-TYPE
 263   SYNTAX      SnmpAdminString
 264   MAX-ACCESS  read-only
 265   STATUS      current
 266   DESCRIPTION
 267      "A textual description of the session.  This is analogous to
 268       sysDescr defined in the SNMPv2-MIB in RFC 1907 [19] and is
 269       taken from the o.descr field of the agentx-Open-PDU.
 270       This attribute will report a zero-length string value for
 271       subagents not supporting the notion of a session description.
 272      "
 273   ::= { agentxSessionEntry 3 }
 274
 275  agentxSessionAdminStatus OBJECT-TYPE
 276   SYNTAX      INTEGER {
 277                  up(1),
 278                  down(2)
 279               }
 280   MAX-ACCESS  read-write
 281   STATUS      current
 282   DESCRIPTION
 283      "The administrative (desired) status of the session.  Setting
 284       the value to 'down(2)' closes the subagent session (with c.reason
 285       set to 'reasonByManager').
 286      "
 287   ::= { agentxSessionEntry 4 }
 288
 289  agentxSessionOpenTime OBJECT-TYPE
 290   SYNTAX      TimeStamp
 291   MAX-ACCESS  read-only
 292   STATUS      current
 293   DESCRIPTION
 294      "The value of sysUpTime when this session was opened and,
 295       therefore, its value when this entry was added to the table.
 296      "
 297   ::= { agentxSessionEntry 5 }
 298
 299  agentxSessionAgentXVer OBJECT-TYPE
 300   SYNTAX      INTEGER (1..255)
 301   MAX-ACCESS  read-only
 302   STATUS      current
 303   DESCRIPTION
 304      "The version of the AgentX protocol supported by the
 305       session.  This must be less than or equal to the value of
 306       agentxMasterAgentXVer.
 307      "
 308   ::= { agentxSessionEntry 6 }
 309
 310  agentxSessionTimeout OBJECT-TYPE
 311   SYNTAX     INTEGER (0..255)
 312   UNITS      "seconds"
 313   MAX-ACCESS read-only
 314   STATUS     current
 315   DESCRIPTION
 316      "The length of time, in seconds, that a master agent should
 317       allow to elapse after dispatching a message to this session
 318       before it regards the subagent as not responding.  This value
 319       is taken from the o.timeout field of the agentx-Open-PDU.
 320       This is a session-specific value that may be overridden by
 321       values associated with the specific registered MIB regions
 322       (see agentxRegTimeout). A value of zero(0) indicates that
 323       the master agent's default timeout value should be used
 324
 325       (see agentxDefaultTimeout).
 326      "
 327   ::= { agentxSessionEntry 7 }
 328
 329  -- The AgentX Registration Group
 330
 331  agentxRegistrationTableLastChange OBJECT-TYPE
 332   SYNTAX      TimeStamp
 333   MAX-ACCESS  read-only
 334   STATUS      current
 335   DESCRIPTION
 336      "The value of sysUpTime when the last row creation or deletion
 337       occurred in the agentxRegistrationTable.
 338      "
 339   ::= { agentxRegistration 1 }
 340
 341  agentxRegistrationTable OBJECT-TYPE
 342   SYNTAX      SEQUENCE OF AgentxRegistrationEntry
 343   MAX-ACCESS  not-accessible
 344   STATUS      current
 345   DESCRIPTION
 346      "A table of registered regions.
 347      "
 348   ::= { agentxRegistration 2 }
 349
 350  agentxRegistrationEntry OBJECT-TYPE
 351   SYNTAX      AgentxRegistrationEntry
 352   MAX-ACCESS  not-accessible
 353   STATUS      current
 354   DESCRIPTION
 355      "Contains information for a single registered region.  An
 356       entry is created when a session  successfully registers a
 357       region and is destroyed for any of three reasons: this region
 358       is unregistered by the session, the session is closed,
 359       or the subagent connection is closed.
 360      "
 361   INDEX       { agentxConnIndex, agentxSessionIndex, agentxRegIndex }
 362   ::= { agentxRegistrationTable 1 }
 363
 364  AgentxRegistrationEntry ::= SEQUENCE {
 365   agentxRegIndex           Unsigned32,
 366   agentxRegContext         OCTET STRING,
 367   agentxRegStart           OBJECT IDENTIFIER,
 368   agentxRegRangeSubId      Unsigned32,
 369   agentxRegUpperBound      Unsigned32,
 370   agentxRegPriority        Unsigned32,
 371   agentxRegTimeout         INTEGER,
 372   agentxRegInstance        TruthValue }
 373
 374  agentxRegIndex OBJECT-TYPE
 375   SYNTAX      Unsigned32 (1..4294967295)
 376   MAX-ACCESS  not-accessible
 377   STATUS      current
 378   DESCRIPTION
 379      "agentxRegIndex uniquely identifies a registration entry.
 380       This value is constant for the lifetime of an entry.
 381      "
 382   ::= { agentxRegistrationEntry 1 }
 383
 384  agentxRegContext OBJECT-TYPE
 385   SYNTAX      OCTET STRING
 386   MAX-ACCESS  read-only
 387   STATUS      current
 388   DESCRIPTION
 389      "The context in which the session supports the objects in this
 390       region.  A zero-length context indicates the default context.
 391      "
 392   ::= { agentxRegistrationEntry 2 }
 393
 394  agentxRegStart OBJECT-TYPE
 395   SYNTAX      OBJECT IDENTIFIER
 396   MAX-ACCESS  read-only
 397   STATUS      current
 398   DESCRIPTION
 399      "The starting OBJECT IDENTIFIER of this registration entry.  The
 400       session identified by agentxSessionIndex implements objects
 401       starting at this value (inclusive).  Note that this value could
 402       identify an object type, an object instance, or a partial object
 403       instance.
 404      "
 405   ::= { agentxRegistrationEntry 3 }
 406
 407  agentxRegRangeSubId OBJECT-TYPE
 408   SYNTAX      Unsigned32
 409   MAX-ACCESS  read-only
 410   STATUS      current
 411   DESCRIPTION
 412      "agentxRegRangeSubId is used to specify the range.  This is
 413       taken from r.region_subid in the registration PDU.  If the value
 414       of this object is zero, no range is specified.  If it is non-zero,
 415       it identifies the `nth' sub-identifier in r.region for which
 416       this entry's agentxRegUpperBound value is substituted in the
 417       OID for purposes of defining the region's upper bound.
 418      "
 419   ::= { agentxRegistrationEntry 4 }
 420
 421  agentxRegUpperBound OBJECT-TYPE
 422   SYNTAX      Unsigned32
 423   MAX-ACCESS  read-only
 424   STATUS      current
 425   DESCRIPTION
 426     "agentxRegUpperBound represents the upper-bound sub-identifier in
 427      a registration.  This is taken from the r.upper_bound in the
 428      registration PDU.  If agentxRegRangeSubid (r.region_subid) is
 429      zero, this value is also zero and is not used to define an upper
 430      bound for this registration.
 431     "
 432   ::= { agentxRegistrationEntry 5 }
 433
 434  agentxRegPriority OBJECT-TYPE
 435   SYNTAX      Unsigned32
 436   MAX-ACCESS  read-only
 437   STATUS      current
 438   DESCRIPTION
 439      "The registration priority.  Lower values have higher priority.
 440       This value is taken from r.priority in the register PDU.
 441       Sessions should use the value of 127 for r.priority if a
 442       default value is desired.
 443      "
 444   ::= { agentxRegistrationEntry 6 }
 445
 446  agentxRegTimeout OBJECT-TYPE
 447   SYNTAX      INTEGER (0..255)
 448   UNITS       "seconds"
 449   MAX-ACCESS  read-only
 450   STATUS      current
 451   DESCRIPTION
 452      "The timeout value, in seconds, for responses to
 453       requests associated with this registered MIB region.
 454       A value of zero(0) indicates the default value (indicated
 455       by by agentxSessionTimeout or agentxDefaultTimeout) is to
 456       be used.  This value is taken from the r.timeout field of
 457       the agentx-Register-PDU.
 458      "
 459   ::= { agentxRegistrationEntry 7 }
 460
 461  agentxRegInstance OBJECT-TYPE
 462   SYNTAX      TruthValue
 463   MAX-ACCESS  read-only
 464   STATUS      current
 465   DESCRIPTION
 466      "The value of agentxRegInstance is `true' for
 467       registrations for which the INSTANCE_REGISTRATION
 468       was set, and is `false' for all other registrations.
 469      "
 470   ::= { agentxRegistrationEntry 8 }
 471
 472  -- Conformance Statements for AgentX
 473
 474  agentxConformance     OBJECT IDENTIFIER ::= { agentxMIB 2 }
 475  agentxMIBGroups       OBJECT IDENTIFIER ::= { agentxConformance 1 }
 476  agentxMIBCompliances  OBJECT IDENTIFIER ::= { agentxConformance 2 }
 477
 478  -- Compliance Statements for AgentX
 479
 480  agentxMIBCompliance MODULE-COMPLIANCE
 481   STATUS      current
 482   DESCRIPTION
 483      "The compliance statement for SNMP entities that implement the
 484       AgentX protocol.  Note that a compliant agent can implement all
 485       objects in this MIB module as read-only.
 486      "
 487   MODULE -- this module
 488      MANDATORY-GROUPS  { agentxMIBGroup }
 489
 490      OBJECT agentxSessionAdminStatus
 491         MIN-ACCESS read-only
 492         DESCRIPTION
 493            "Write access is not required.
 494            "
 495   ::= { agentxMIBCompliances 1 }
 496
 497  agentxMIBGroup OBJECT-GROUP
 498   OBJECTS {
 499      agentxDefaultTimeout,
 500      agentxMasterAgentXVer,
 501      agentxConnTableLastChange,
 502      agentxConnOpenTime,
 503      agentxConnTransportDomain,
 504      agentxConnTransportAddress,
 505      agentxSessionTableLastChange,
 506      agentxSessionTimeout,
 507      agentxSessionObjectID,
 508      agentxSessionDescr,
 509      agentxSessionAdminStatus,
 510      agentxSessionOpenTime,
 511      agentxSessionAgentXVer,
 512      agentxRegistrationTableLastChange,
 513      agentxRegContext,
 514      agentxRegStart,
 515      agentxRegRangeSubId,
 516      agentxRegUpperBound,
 517      agentxRegPriority,
 518      agentxRegTimeout,
 519      agentxRegInstance
 520     }
 521   STATUS      current
 522   DESCRIPTION
 523      "All accessible objects in the AgentX MIB.
 524      "
 525   ::= { agentxMIBGroups 1 }
 526
 527  END