mibs/ietf/RMON2-MIB

   1 RMON2-MIB DEFINITIONS ::= BEGIN
   2 IMPORTS
   3     MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32,
   4     Gauge32, IpAddress, TimeTicks, mib-2         FROM SNMPv2-SMI
   5     TEXTUAL-CONVENTION, RowStatus, DisplayString, TimeStamp
   6                                                  FROM SNMPv2-TC
   7     MODULE-COMPLIANCE, OBJECT-GROUP              FROM SNMPv2-CONF
   8     ifIndex                                      FROM IF-MIB
   9     OwnerString, statistics, history, hosts,
  10     matrix, filter, etherStatsEntry, historyControlEntry,
  11     hostControlEntry, matrixControlEntry, filterEntry,
  12     channelEntry                    FROM RMON-MIB
  13     tokenRing, tokenRingMLStatsEntry, tokenRingPStatsEntry,
  14
  15
  16
  17     ringStationControlEntry, sourceRoutingStatsEntry
  18                                     FROM TOKEN-RING-RMON-MIB;
  19 --  Remote Network Monitoring MIB
  20
  21 rmon MODULE-IDENTITY
  22     LAST-UPDATED "200605020000Z"    -- May 2, 2006
  23     ORGANIZATION "IETF RMON MIB Working Group"
  24     CONTACT-INFO
  25         "Author:
  26                      Steve Waldbusser
  27              Phone:  +1-650-948-6500
  28              Fax :   +1-650-745-0671
  29              Email:  waldbusser@nextbeacon.com
  30
  31          Working Group Chair:
  32                      Andy Bierman
  33              E-mail: ietf@andybierman.com
  34
  35          Working Group Mailing List: <rmonmib@ietf.org>
  36          To subscribe send email to: <rmonmib-request@ietf.org>    "
  37     DESCRIPTION
  38         "The MIB module for managing remote monitoring
  39          device implementations.  This MIB module
  40          extends the architecture introduced in the original
  41          RMON MIB as specified in RFC 2819.
  42
  43          Copyright (C) The Internet Society (2006).  This version of
  44          this MIB module is part of RFC 4502;  see the RFC itself for
  45          full legal notices."
  46
  47     REVISION "200605020000Z"    -- May 2, 2006
  48     DESCRIPTION
  49         "This version updates the proposed-standard version of the
  50         RMON2 MIB (published as RFC 2021) by adding 2 new
  51         enumerations to the nlMatrixTopNControlRateBase object and
  52         4 new enumerations to the alMatrixTopNControlRateBase object.
  53         These new enumerations support the creation of high-capacity
  54         topN reports in the High Capacity RMON MIB [RFC3273].
  55
  56         Additionally, the following objects have been deprecated, as
  57         they have not had enough independent implementations to
  58         demonstrate interoperability to meet the requirements of a
  59         Draft Standard:
  60
  61         probeDownloadFile
  62         probeDownloadTFTPServer
  63         probeDownloadAction
  64         probeDownloadStatus
  65
  66
  67
  68         serialMode
  69         serialProtocol
  70         serialTimeout
  71         serialModemInitString
  72         serialModemHangUpString
  73         serialModemConnectResp
  74         serialModemNoConnectResp
  75         serialDialoutTimeout
  76         serialStatus
  77         serialConnectDestIpAddress
  78         serialConnectType
  79         serialConnectDialString
  80         serialConnectSwitchConnectSeq
  81         serialConnectSwitchDisconnectSeq
  82         serialConnectSwitchResetSeq
  83         serialConnectOwner
  84         serialConnectStatus
  85         netConfigIPAddress
  86         netConfigSubnetMask
  87         netConfigStatus
  88         netDefaultGateway
  89         tokenRingMLStats2DroppedFrames
  90         tokenRingMLStats2CreateTime
  91         tokenRingPStats2DroppedFrames
  92         tokenRingPStats2CreateTime
  93         ringStationControl2DroppedFrames
  94         ringStationControl2CreateTime
  95         sourceRoutingStats2DroppedFrames
  96         sourceRoutingStats2CreateTime
  97         trapDestIndex
  98         trapDestCommunity
  99         trapDestProtocol
 100         trapDestAddress
 101         trapDestOwner
 102         trapDestStatus
 103
 104         In addition, two corrections were made.  The LastCreateTime
 105         Textual Convention had been defined with a base type of
 106         another textual convention, which isn't allowed in SMIv2.  The
 107         definition has been modified to use TimeTicks as the base
 108         type.
 109
 110         Further, the SerialConfigEntry SEQUENCE definition included
 111         sub-typing information that is not allowed in SMIv2.  This
 112         information has been deleted.  Ranges were added to a number of
 113         objects and textual-conventions to constrain their maximum
 114         (and sometimes minimum) sizes.  The addition of these ranges
 115         documents existing practice for these objects.  These objects
 116
 117
 118
 119         are:
 120             ControlString
 121             protocolDirID
 122             protocolDirParameters
 123             addressMapNetworkAddress
 124             nlHostAddress
 125             nlMatrixSDSourceAddress
 126             nlMatrixSDDestAddress
 127             nlMatrixDSSourceAddress
 128             nlMatrixDSDestAddress
 129             nlMatrixTopNSourceAddress
 130             nlMatrixTopNDestAddress
 131             alHostEntry
 132             alMatrixSDEntry
 133             alMatrixDSEntry
 134             alMatrixTopNSourceAddress
 135             alMatrixTopNDestAddress
 136
 137         Finally, the TimeFilter TC has been updated to encourage agent
 138         implementations that allow a MIB walk to behave well even when
 139         performed by an application that is not aware of the special
 140         TimeFilter semantics."
 141
 142     REVISION "200207080000Z"        -- 08 July, 2002
 143     DESCRIPTION
 144         "Added new enumerations to support the High-Capacity RMON
 145         MIB as defined in RFC 3273.  Also fixed some typos and
 146         added clarifications."
 147
 148     REVISION "199605270000Z"    -- 27 May, 1996
 149     DESCRIPTION
 150         "Original version.  Published as RFC 2021."
 151     ::= { mib-2 16 }
 152
 153 -- { rmon 1 } through { rmon 10 } are defined in RMON and
 154 -- the Token Ring RMON MIB [RFC1513]
 155
 156     protocolDir     OBJECT IDENTIFIER ::= { rmon 11 }
 157     protocolDist    OBJECT IDENTIFIER ::= { rmon 12 }
 158     addressMap      OBJECT IDENTIFIER ::= { rmon 13 }
 159     nlHost          OBJECT IDENTIFIER ::= { rmon 14 }
 160     nlMatrix        OBJECT IDENTIFIER ::= { rmon 15 }
 161     alHost          OBJECT IDENTIFIER ::= { rmon 16 }
 162     alMatrix        OBJECT IDENTIFIER ::= { rmon 17 }
 163     usrHistory      OBJECT IDENTIFIER ::= { rmon 18 }
 164     probeConfig     OBJECT IDENTIFIER ::= { rmon 19 }
 165     rmonConformance OBJECT IDENTIFIER ::= { rmon 20 }
 166
 167
 168
 169
 170 -- Textual Conventions
 171
 172 ZeroBasedCounter32 ::= TEXTUAL-CONVENTION
 173     STATUS current
 174     DESCRIPTION
 175         "This TC describes an object that counts events with the
 176         following semantics: objects of this type will be set to
 177         zero(0) on creation and will thereafter count appropriate
 178         events, wrapping back to zero(0) when the value 2^32 is
 179         reached.
 180
 181         Provided that an application discovers the new object within
 182         the minimum time to wrap, it can use the initial value as a
 183         delta since it last polled the table of which this object is
 184         part.  It is important for a management station to be aware of
 185         this minimum time and the actual time between polls, and to
 186         discard data if the actual time is too long or there is no
 187         defined minimum time.
 188
 189         Typically, this TC is used in tables where the INDEX space is
 190         constantly changing and/or the TimeFilter mechanism is in use."
 191     SYNTAX Gauge32
 192
 193 LastCreateTime ::= TEXTUAL-CONVENTION
 194     STATUS current
 195     DESCRIPTION
 196         "This TC describes an object that stores the value of the
 197         sysUpTime object at the last time its entry was created.
 198
 199         This can be used for polling applications to determine that an
 200         entry has been deleted and re-created between polls, causing
 201         an otherwise undetectable discontinuity in the data.
 202
 203         If sysUpTime is reset to zero as a result of a re-
 204         initialization of the network management (sub)system, then
 205         the values of all LastCreateTime objects are also reset.
 206         However, after approximately 497 days without a re-
 207         initialization, the sysUpTime object will reach 2^^32-1 and
 208         then increment to zero; in this case, existing values
 209         of TimeStamp objects do not change.  This can lead to
 210         ambiguities in the value of TimeStamp objects."
 211     SYNTAX TimeTicks
 212
 213 TimeFilter ::= TEXTUAL-CONVENTION
 214   STATUS        current
 215   DESCRIPTION
 216       "To be used for the index to a table.  Allows an application
 217       to download only those rows changed since a particular time.
 218
 219
 220
 221       Note that this is not a history mechanism.  Only current values
 222       of underlying objects are returned; saved instance values
 223       associated with particular values of sysUpTime are not.
 224
 225       An entry is considered changed if the value of any object in the
 226       entry changes, if the row is created, or if any object in the
 227       entry is created or deleted.  Note that deleted entries cannot
 228       be detected or downloaded.
 229
 230       A time-filtered conceptual table is created by inserting a
 231       single object of SYNTAX TimeFilter as the first INDEX component
 232       in a copy of an existing basic conceptual table (i.e., any
 233       SEQUENCE without a TimeFilter INDEX component).  Thus, for
 234       each conceptual entry 'I' in the basic table, there exists N
 235       conceptual entries in the time-filtered version, indexed N.I,
 236       where 'N' is equal to the value of sysUpTime.
 237
 238       When an application retrieves conceptual instances from a
 239       time-filtered table, and an INDEX value is provided for the
 240       TimeFilter INDEX component 'N', the agent will only consider
 241       returning basic conceptual entries (e.g., 'fooColumn.N.I') if
 242       any column within the basic conceptual entry has changed since
 243       sysUpTime 'N'.  If not, the basic conceptual entry will
 244       be ignored for the particular retrieval operation.
 245
 246       When sysUpTime is equal to zero, this table shall be empty.
 247
 248       One conceptual entry exists for each past value of sysUpTime,
 249       except that the whole table is purged should sysUpTime wrap.
 250
 251       As an entry in a time-filtered table is updated (i.e., one of
 252       the columns in the basic conceptual table is changed), new
 253       conceptual entries are also created in the time-filtered version
 254       (which still shares the now updated object values with all other
 255       instances).  The number of unique time-filtered instances that
 256       are created is determined by the value of sysUpTime at which the
 257       basic entry was last updated.  One unique instance will exist
 258       for each value of sysUpTime at the last update time for the row.
 259       However, a new TimeFilter index instance is created for each new
 260       sysUpTime value.  The TimeFilter index values not associated
 261       with entry updates are called duplicate time-filtered instances.
 262
 263       After some deployment experience, it has been determined that
 264       a time-filtered table is more efficient if the agent
 265       stops a MIB walk operation by skipping over rows with a
 266       TimeFilter index value higher than the value in the received
 267       GetNext/GetBulk request.  That is, instead of incrementing a
 268       TimeFilter index value, the agent will continue to the next
 269
 270
 271
 272       object or table.  As a consequence, GetNext or GetBulk
 273       operations will provide only one pass through a time-filtered
 274       table.
 275
 276       It is suggested that an agent implement a time-filtered table
 277       in this manner to improve performance and avoid a MIB walk
 278       getting stuck in time-filtered tables.  It is, however, still
 279       acceptable for an agent to implement a time-filtered table in
 280       the traditional manner (i.e., every conceptual time-filtered
 281       instance is returned in GetNext and GetBulk PDU responses), and
 282       management applications must be able to deal with such
 283       traditional implementations.
 284
 285       See the appendix for further discussion of this textual
 286       convention.
 287
 288       The following example is provided to demonstrate TimeFilter
 289       behavior:
 290
 291       Consider the following basic conceptual table, basicFooTable.
 292       (Note that the basic version of a time-filtered table may not
 293       actually be defined.)
 294
 295           basicFooTable:
 296
 297           basicFooTable ...
 298           INDEX { fooIndex }
 299
 300           BasicFooEntry {
 301              fooIndex     Integer32,
 302              fooCounts    Counter32
 303           }
 304
 305       For this example, the basicFooTable contains two static
 306       conceptual entries (fooIndex equals '1' and '2'), created at
 307       time zero.  It also contains one dynamic conceptual entry
 308       (fooIndex equals '3'), which is created at time '3' and deleted
 309       at time '7'.
 310
 311       The time-filtered version of the basicFooTable could be defined
 312       as follows:
 313
 314           FooTable:
 315
 316           fooTable ...
 317           INDEX { fooTimeMark, fooIndex }
 318
 319           FooEntry {
 320
 321
 322
 323              fooTimeMark  TimeFilter,
 324              fooIndex     Integer32,
 325              fooCounts    Counter32
 326           }
 327
 328
 329       Note that entries exist in the time-filtered conceptual table
 330       only if they actually exist in the underlying (basic) table.
 331
 332       For this example, the fooTable will have three underlying
 333       basic entries (fooIndex == 1, 2, and 3), with the following
 334       activity (for sysUpTime equal 0 to 9):
 335
 336          - fooEntry.N.1 is created at time '0' and most recently
 337            updated at time '6' to the value '5'.
 338          - fooEntry.N.2 is created at time '0' and most recently
 339            updated at time '8' to the value '9'.
 340          - fooEntry.N.3 is created at time '3', updated at time '5'
 341            to the value '17', and deleted at time '7'.
 342
 343      The following tables show the values that would be returned for
 344      MIB walk operations with various TimeFilter values, done at
 345      different times.  An application issues a retrieval request at
 346      time 'T', with a TimeFilter value, 'N' (typically set to a lower
 347      value, such as the value of sysUpTime at the last polling cycle).
 348
 349      The following values would be returned in a MIB walk of
 350      fooCounts.N if T equals '0' and N equals '0':
 351
 352            fooCounts.N.I    Value
 353            ==========================
 354            fooCounts.0.1    0
 355            fooCounts.0.2    0
 356
 357        Note that nothing is returned for fooCounts.0.3, since that
 358        entry does not exist at sysUpTime equals '0'.
 359
 360      The following values would be returned in a full (traditional) MIB
 361      walk of fooCounts.N if T equals '3' and N equals '0':
 362
 363            fooCounts.N.I    Value
 364            =======================
 365            fooCounts.0.1    0
 366            fooCounts.0.2    0
 367            fooCounts.0.3    0
 368            fooCounts.1.3    0
 369            fooCounts.2.3    0
 370            fooCounts.3.3    0
 371
 372
 373
 374        Note that there are no instances for T equals 1 or 2 for the
 375        first two values of N, as these entries did not change
 376        since they were created at time '0'.
 377
 378        Note that the current value for 'fooCounts.N.3' is returned
 379        here, even for values of N less than '3' (when the entry was
 380        created).  The agent only considers the current existence of an
 381        entry in the TimeFilter algorithm, not the time when the entry
 382        was created.
 383
 384        Note that the instances 'fooCounts.0.3', 'fooCounts.1.3',
 385        and 'fooCounts.2.3' are duplicates and can be suppressed by the
 386        agent in a MIB walk.
 387
 388      The following values would be returned in a full (traditional)
 389      MIB walk of fooCounts.N if T equals '6' and N equals '3':
 390
 391            fooCounts.N.I    Value
 392            =======================
 393            fooCounts.3.1    5
 394            fooCounts.3.3    17
 395            fooCounts.4.1    5
 396            fooCounts.4.3    17
 397            fooCounts.5.1    5
 398            fooCounts.5.3    17
 399            fooCounts.6.1    5
 400
 401         Note that no instances for entry 'fooCounts.N.2' are returned,
 402         since it has not changed since time '3'.
 403
 404         Note that all instances except 'fooCounts.5.3' and
 405         'fooCounts.6.1' are duplicates and can be suppressed by the
 406         agent in a MIB walk.
 407
 408      The following values would be returned in a full (traditional)
 409      MIB walk of fooCounts.N if T equals '9' and N equals '6':
 410
 411            fooCounts.N.I    Value
 412            =======================
 413            fooCounts.6.1    5
 414            fooCounts.6.2    9
 415            fooCounts.7.2    9
 416            fooCounts.8.2    9
 417
 418         Note that no instances for entry 'fooCounts.N.3' are returned,
 419         since it was deleted at time '7'.
 420
 421         Note that instances 'fooCounts.6.2' and 'fooCounts.7.2'
 422
 423
 424
 425         are duplicates and can be suppressed by the agent in a MIB
 426         walk."
 427
 428   SYNTAX    TimeTicks
 429
 430 DataSource ::= TEXTUAL-CONVENTION
 431     STATUS        current
 432     DESCRIPTION
 433         "Identifies the source of the data that the associated
 434         function is configured to analyze.  This source can be any
 435         interface on this device.
 436
 437         In order to identify a particular interface, this
 438         object shall identify the instance of the ifIndex
 439         object, defined in [RFC2863], for the desired interface.
 440
 441         For example, if an entry were to receive data from
 442         interface #1, this object would be set to ifIndex.1."
 443     SYNTAX      OBJECT IDENTIFIER
 444
 445 --
 446 -- Protocol Directory Group
 447 --
 448 -- Lists the inventory of protocols the probe has the capability of
 449 -- monitoring and allows the addition, deletion, and configuration of
 450 -- entries in this list.
 451
 452 protocolDirLastChange OBJECT-TYPE
 453     SYNTAX      TimeStamp
 454     MAX-ACCESS  read-only
 455     STATUS      current
 456     DESCRIPTION
 457         "The value of sysUpTime at the time the protocol directory
 458         was last modified, either through insertions or deletions,
 459         or through modifications of the
 460         protocolDirAddressMapConfig, protocolDirHostConfig, or
 461         protocolDirMatrixConfig."
 462     ::= { protocolDir 1 }
 463
 464 protocolDirTable OBJECT-TYPE
 465     SYNTAX      SEQUENCE OF ProtocolDirEntry
 466     MAX-ACCESS  not-accessible
 467     STATUS      current
 468     DESCRIPTION
 469         "This table lists the protocols that this agent has the
 470         capability to decode and count.  There is one entry in this
 471         table for each such protocol.  These protocols represent
 472         different network-layer, transport-layer, and higher-layer
 473
 474
 475
 476         protocols.  The agent should boot up with this table
 477         preconfigured with those protocols that it knows about and
 478         wishes to monitor.  Implementations are strongly encouraged to
 479         support protocols higher than the network layer (at least for
 480         the protocol distribution group), even for implementations
 481         that don't support the application-layer groups."
 482     ::= { protocolDir 2 }
 483
 484 protocolDirEntry OBJECT-TYPE
 485     SYNTAX      ProtocolDirEntry
 486     MAX-ACCESS  not-accessible
 487     STATUS      current
 488     DESCRIPTION
 489         "A conceptual row in the protocolDirTable.
 490
 491          An example of the indexing of this entry is
 492          protocolDirLocalIndex.8.0.0.0.1.0.0.8.0.2.0.0, which is the
 493          encoding of a length of 8, followed by 8 subids encoding the
 494          protocolDirID of 1.2048, followed by a length of 2 and the
 495          2 subids encoding zero-valued parameters.
 496
 497          Note that some combinations of index values may result in an
 498          index that exceeds 128 sub-identifiers in length, which exceeds
 499          the maximum for the SNMP protocol.  Implementations should take
 500          care to avoid such combinations."
 501     INDEX { protocolDirID, protocolDirParameters }
 502     ::= { protocolDirTable  1 }
 503
 504 ProtocolDirEntry ::= SEQUENCE {
 505     protocolDirID                   OCTET STRING,
 506     protocolDirParameters           OCTET STRING,
 507     protocolDirLocalIndex           Integer32,
 508     protocolDirDescr                DisplayString,
 509     protocolDirType                 BITS,
 510     protocolDirAddressMapConfig     INTEGER,
 511     protocolDirHostConfig           INTEGER,
 512     protocolDirMatrixConfig         INTEGER,
 513     protocolDirOwner                OwnerString,
 514     protocolDirStatus               RowStatus
 515 }
 516
 517 protocolDirID OBJECT-TYPE
 518     SYNTAX      OCTET STRING  (SIZE (4..128))
 519     MAX-ACCESS  not-accessible
 520     STATUS      current
 521     DESCRIPTION
 522         "A unique identifier for a particular protocol.  Standard
 523         identifiers will be defined in such a manner that they
 524
 525
 526
 527         can often be used as specifications for new protocols - i.e.,
 528         a tree-structured assignment mechanism that matches the
 529         protocol encapsulation 'tree' and that has algorithmic
 530         assignment mechanisms for certain subtrees.  See RFC 2074 for
 531         more details.
 532
 533         Despite the algorithmic mechanism, the probe will only place
 534         entries in here for those protocols it chooses to collect.  In
 535         other words, it need not populate this table with all
 536         possible ethernet protocol types, nor need it create them on
 537         the fly when it sees them.  Whether it does these
 538         things is a matter of product definition (cost/benefit,
 539         usability) and is up to the designer of the product.
 540
 541         If an entry is written to this table with a protocolDirID that
 542         the agent doesn't understand, either directly or
 543         algorithmically, the SET request will be rejected with an
 544         inconsistentName or badValue (for SNMPv1) error."
 545     ::= { protocolDirEntry 1 }
 546
 547 protocolDirParameters OBJECT-TYPE
 548     SYNTAX      OCTET STRING (SIZE (1..32))
 549     MAX-ACCESS  not-accessible
 550     STATUS      current
 551     DESCRIPTION
 552         "A set of parameters for the associated protocolDirID.
 553         See the associated RMON2 Protocol Identifiers document
 554         for a description of the possible parameters.  There
 555         will be one octet in this string for each sub-identifier in
 556         the protocolDirID, and the parameters will appear here in the
 557         same order as the associated sub-identifiers appear in the
 558         protocolDirID.
 559
 560         Every node in the protocolDirID tree has a different, optional
 561         set of parameters defined (that is, the definition of
 562         parameters for a node is optional).  The proper parameter
 563         value for each node is included in this string.  Note that the
 564         inclusion of a parameter value in this string for each node is
 565         not optional.  What is optional is that a node may have no
 566         parameters defined, in which case the parameter field for that
 567         node will be zero."
 568     ::= { protocolDirEntry 2 }
 569
 570 protocolDirLocalIndex OBJECT-TYPE
 571     SYNTAX      Integer32 (1..2147483647)
 572     MAX-ACCESS  read-only
 573     STATUS      current
 574     DESCRIPTION
 575
 576
 577
 578         "The locally arbitrary but unique identifier associated
 579         with this protocolDir entry.
 580
 581         The value for each supported protocol must remain constant at
 582         least from one re-initialization of the entity's network
 583         management system to the next re-initialization, except that
 584         if a protocol is deleted and re-created, it must be re-created
 585         with a new value that has not been used since the last
 586         re-initialization.
 587
 588         The specific value is meaningful only within a given SNMP
 589         entity.  A protocolDirLocalIndex must not be re-used until the
 590         next agent restart in the event that the protocol directory
 591         entry is deleted."
 592     ::= { protocolDirEntry 3 }
 593
 594 protocolDirDescr OBJECT-TYPE
 595     SYNTAX      DisplayString (SIZE (1..64))
 596     MAX-ACCESS  read-create
 597     STATUS      current
 598     DESCRIPTION
 599         "A textual description of the protocol encapsulation.
 600         A probe may choose to describe only a subset of the
 601         entire encapsulation (e.g., only the highest layer).
 602
 603         This object is intended for human consumption only.
 604
 605         This object may not be modified if the associated
 606         protocolDirStatus object is equal to active(1)."
 607     ::= { protocolDirEntry 4 }
 608
 609 protocolDirType OBJECT-TYPE
 610     SYNTAX      BITS {
 611                     extensible(0),
 612                     addressRecognitionCapable(1)
 613                 }
 614     MAX-ACCESS  read-only
 615     STATUS      current
 616     DESCRIPTION
 617         "This object describes 2 attributes of this protocol
 618          directory entry.
 619
 620          The presence or absence of the 'extensible' bit describes
 621          whether this protocol directory entry can be extended
 622          by the user by creating protocol directory entries that are
 623          children of this protocol.
 624
 625          An example of an entry that will often allow extensibility is
 626
 627
 628
 629          'ip.udp'.  The probe may automatically populate some children
 630          of this node, such as 'ip.udp.snmp' and 'ip.udp.dns'.
 631          A probe administrator or user may also populate additional
 632          children via remote SNMP requests that create entries in this
 633          table.  When a child node is added for a protocol for which the
 634          probe has no built-in support extending a parent node (for
 635          which the probe does have built-in support),
 636          that child node is not extendable.  This is termed 'limited
 637          extensibility'.
 638
 639          When a child node is added through this extensibility
 640          mechanism, the values of protocolDirLocalIndex and
 641          protocolDirType shall be assigned by the agent.
 642
 643          The other objects in the entry will be assigned by the
 644          manager who is creating the new entry.
 645
 646          This object also describes whether this agent can
 647          recognize addresses for this protocol, should it be a
 648          network-level protocol.  That is, while a probe may be able
 649          to recognize packets of a particular network-layer protocol
 650          and count them, it takes additional logic to be able to
 651          recognize the addresses in this protocol and to populate
 652          network-layer or application-layer tables with the addresses
 653          in this protocol.  If this bit is set, the agent will
 654          recognize network-layer addresses for this protocol and
 655          populate the network- and application-layer host and matrix
 656          tables with these protocols.
 657
 658          Note that when an entry is created, the agent will supply
 659          values for the bits that match the capabilities of the agent
 660          with respect to this protocol.  Note that since row creations
 661          usually exercise the limited extensibility feature, these
 662          bits will usually be set to zero."
 663     ::= { protocolDirEntry 5 }
 664
 665 protocolDirAddressMapConfig OBJECT-TYPE
 666     SYNTAX      INTEGER {
 667                     notSupported(1),
 668                     supportedOff(2),
 669                     supportedOn(3)
 670                 }
 671     MAX-ACCESS  read-create
 672     STATUS      current
 673     DESCRIPTION
 674         "This object describes and configures the probe's support for
 675         address mapping for this protocol.  When the probe creates
 676         entries in this table for all protocols that it understands,
 677
 678
 679
 680         it will set the entry to notSupported(1) if it doesn't have
 681         the capability to perform address mapping for the protocol or
 682         if this protocol is not a network-layer protocol.  When
 683         an entry is created in this table by a management operation as
 684         part of the limited extensibility feature, the probe must set
 685         this value to notSupported(1), because limited extensibility
 686         of the protocolDirTable does not extend to interpreting
 687         addresses of the extended protocols.
 688
 689         If the value of this object is notSupported(1), the probe
 690         will not perform address mapping for this protocol and
 691         shall not allow this object to be changed to any other value.
 692         If the value of this object is supportedOn(3), the probe
 693         supports address mapping for this protocol and is configured
 694         to perform address mapping for this protocol for all
 695         addressMappingControlEntries and all interfaces.
 696         If the value of this object is supportedOff(2), the probe
 697         supports address mapping for this protocol but is configured
 698         to not perform address mapping for this protocol for any
 699         addressMappingControlEntries and all interfaces.
 700         Whenever this value changes from supportedOn(3) to
 701         supportedOff(2), the probe shall delete all related entries in
 702         the addressMappingTable."
 703     ::= { protocolDirEntry 6 }
 704
 705 protocolDirHostConfig OBJECT-TYPE
 706     SYNTAX      INTEGER {
 707                     notSupported(1),
 708                     supportedOff(2),
 709                     supportedOn(3)
 710                 }
 711     MAX-ACCESS  read-create
 712     STATUS      current
 713     DESCRIPTION
 714         "This object describes and configures the probe's support for
 715         the network-layer and application-layer host tables for this
 716         protocol.  When the probe creates entries in this table for
 717         all protocols that it understands, it will set the entry to
 718         notSupported(1) if it doesn't have the capability to track the
 719         nlHostTable for this protocol or if the alHostTable is
 720         implemented but doesn't have the capability to track this
 721         protocol.  Note that if the alHostTable is implemented, the
 722         probe may only support a protocol if it is supported in both
 723         the nlHostTable and the alHostTable.
 724
 725         If the associated protocolDirType object has the
 726         addressRecognitionCapable bit set, then this is a network-
 727         layer protocol for which the probe recognizes addresses, and
 728
 729
 730
 731         thus the probe will populate the nlHostTable and alHostTable
 732         with addresses it discovers for this protocol.
 733
 734         If the value of this object is notSupported(1), the probe
 735         will not track the nlHostTable or alHostTable for this
 736         protocol and shall not allow this object to be changed to any
 737         other value.  If the value of this object is supportedOn(3),
 738         the probe supports tracking of the nlHostTable and alHostTable
 739         for this protocol and is configured to track both tables
 740         for this protocol for all control entries and all interfaces.
 741         If the value of this object is supportedOff(2), the probe
 742         supports tracking of the nlHostTable and alHostTable for this
 743         protocol but is configured to not track these tables
 744         for any control entries or interfaces.
 745         Whenever this value changes from supportedOn(3) to
 746         supportedOff(2), the probe shall delete all related entries in
 747         the nlHostTable and alHostTable.
 748
 749         Note that since each alHostEntry references 2 protocol
 750         directory entries, one for the network address and one for the
 751         type of the highest protocol recognized, an entry will
 752         only be created in that table if this value is supportedOn(3)
 753         for both protocols."
 754     ::= { protocolDirEntry 7 }
 755
 756 protocolDirMatrixConfig OBJECT-TYPE
 757     SYNTAX      INTEGER {
 758                     notSupported(1),
 759                     supportedOff(2),
 760                     supportedOn(3)
 761                 }
 762     MAX-ACCESS  read-create
 763     STATUS      current
 764     DESCRIPTION
 765         "This object describes and configures the probe's support for
 766         the network-layer and application-layer matrix tables for this
 767         protocol.  When the probe creates entries in this table for
 768         all protocols that it understands, it will set the entry to
 769         notSupported(1) if it doesn't have the capability to track the
 770         nlMatrixTables for this protocol or if the alMatrixTables are
 771         implemented but don't have the capability to track this
 772         protocol.  Note that if the alMatrix tables are implemented,
 773         the probe may only support a protocol if it is supported in
 774         both of the nlMatrixTables and both of the
 775         alMatrixTables.
 776
 777         If the associated protocolDirType object has the
 778         addressRecognitionCapable bit set, then this is a network-
 779
 780
 781
 782         layer protocol for which the probe recognizes addresses, and
 783         thus the probe will populate both of the nlMatrixTables and
 784         both of the alMatrixTables with addresses it discovers for
 785         this protocol.
 786
 787         If the value of this object is notSupported(1), the probe
 788         will not track either of the nlMatrixTables or the
 789         alMatrixTables for this protocol and shall not allow this
 790         object to be changed to any other value.  If the value of this
 791         object is supportedOn(3), the probe supports tracking of both
 792         of the nlMatrixTables and (if implemented) both of the
 793         alMatrixTables for this protocol and is configured to track
 794         these tables for this protocol for all control entries and all
 795         interfaces.  If the value of this object is supportedOff(2),
 796         the probe supports tracking of both of the nlMatrixTables and
 797         (if implemented) both of the alMatrixTables for this protocol
 798         but is configured to not track these tables for this
 799         protocol for any control entries or interfaces.
 800         Whenever this value changes from supportedOn(3) to
 801         supportedOff(2), the probe shall delete all related entries in
 802         the nlMatrixTables and the alMatrixTables.
 803
 804         Note that since each alMatrixEntry references 2 protocol
 805         directory entries, one for the network address and one for the
 806         type of the highest protocol recognized, an entry will
 807         only be created in that table if this value is supportedOn(3)
 808         for both protocols."
 809     ::= { protocolDirEntry 8 }
 810
 811 protocolDirOwner OBJECT-TYPE
 812     SYNTAX      OwnerString
 813     MAX-ACCESS  read-create
 814     STATUS      current
 815     DESCRIPTION
 816         "The entity that configured this entry and is
 817         therefore using the resources assigned to it."
 818     ::= { protocolDirEntry 9 }
 819
 820 protocolDirStatus OBJECT-TYPE
 821     SYNTAX      RowStatus
 822     MAX-ACCESS  read-create
 823     STATUS      current
 824     DESCRIPTION
 825         "The status of this protocol directory entry.
 826
 827         An entry may not exist in the active state unless all
 828         objects in the entry have an appropriate value.
 829
 830
 831
 832
 833         If this object is not equal to active(1), all associated
 834         entries in the nlHostTable, nlMatrixSDTable, nlMatrixDSTable,
 835         alHostTable, alMatrixSDTable, and alMatrixDSTable shall be
 836         deleted."
 837     ::= { protocolDirEntry 10 }
 838
 839 --
 840 -- Protocol Distribution Group  (protocolDist)
 841 --
 842 -- Collects the relative amounts of octets and packets for the
 843 -- different protocols detected on a network segment.
 844 --    protocolDistControlTable,
 845 --    protocolDistStatsTable
 846
 847 protocolDistControlTable OBJECT-TYPE
 848     SYNTAX      SEQUENCE OF ProtocolDistControlEntry
 849     MAX-ACCESS  not-accessible
 850     STATUS      current
 851     DESCRIPTION
 852         "Controls the setup of protocol type distribution statistics
 853         tables.
 854
 855         Implementations are encouraged to add an entry per monitored
 856         interface upon initialization so that a default collection
 857         of protocol statistics is available.
 858
 859         Rationale:
 860         This table controls collection of very basic statistics
 861         for any or all of the protocols detected on a given interface.
 862         An NMS can use this table to quickly determine bandwidth
 863         allocation utilized by different protocols.
 864
 865         A media-specific statistics collection could also
 866         be configured (e.g., etherStats, trPStats) to easily obtain
 867         total frame, octet, and droppedEvents for the same
 868         interface."
 869     ::= { protocolDist 1 }
 870
 871 protocolDistControlEntry OBJECT-TYPE
 872     SYNTAX      ProtocolDistControlEntry
 873     MAX-ACCESS  not-accessible
 874     STATUS      current
 875     DESCRIPTION
 876         "A conceptual row in the protocolDistControlTable.
 877
 878          An example of the indexing of this entry is
 879          protocolDistControlDroppedFrames.7"
 880     INDEX { protocolDistControlIndex }
 881
 882
 883
 884     ::= { protocolDistControlTable 1 }
 885
 886 ProtocolDistControlEntry ::= SEQUENCE {
 887     protocolDistControlIndex                Integer32,
 888     protocolDistControlDataSource           DataSource,
 889     protocolDistControlDroppedFrames        Counter32,
 890     protocolDistControlCreateTime           LastCreateTime,
 891     protocolDistControlOwner                OwnerString,
 892     protocolDistControlStatus               RowStatus
 893 }
 894
 895 protocolDistControlIndex OBJECT-TYPE
 896     SYNTAX      Integer32 (1..65535)
 897     MAX-ACCESS  not-accessible
 898     STATUS      current
 899     DESCRIPTION
 900         "A unique index for this protocolDistControlEntry."
 901     ::= { protocolDistControlEntry 1 }
 902
 903 protocolDistControlDataSource OBJECT-TYPE
 904     SYNTAX      DataSource
 905     MAX-ACCESS  read-create
 906     STATUS      current
 907     DESCRIPTION
 908         "The source of data for the this protocol distribution.
 909
 910         The statistics in this group reflect all packets
 911         on the local network segment attached to the
 912         identified interface.
 913
 914         This object may not be modified if the associated
 915         protocolDistControlStatus object is equal to active(1)."
 916     ::= { protocolDistControlEntry 2 }
 917
 918 protocolDistControlDroppedFrames OBJECT-TYPE
 919     SYNTAX     Counter32
 920     MAX-ACCESS read-only
 921     STATUS     current
 922     DESCRIPTION
 923        "The total number of frames that were received by the probe
 924         and therefore not accounted for in the *StatsDropEvents, but
 925         that the probe chose not to count for this entry for
 926         whatever reason.  Most often, this event occurs when the probe
 927         is out of some resources and decides to shed load from this
 928         collection.
 929
 930         This count does not include packets that were not counted
 931         because they had MAC-layer errors.
 932
 933
 934
 935         Note that, unlike the dropEvents counter, this number is the
 936         exact number of frames dropped."
 937     ::= { protocolDistControlEntry 3 }
 938
 939 protocolDistControlCreateTime OBJECT-TYPE
 940     SYNTAX     LastCreateTime
 941     MAX-ACCESS read-only
 942     STATUS     current
 943     DESCRIPTION
 944         "The value of sysUpTime when this control entry was last
 945         activated.  This can be used by the management station to
 946         ensure that the table has not been deleted and recreated
 947         between polls."
 948     ::= { protocolDistControlEntry 4 }
 949
 950 protocolDistControlOwner OBJECT-TYPE
 951     SYNTAX      OwnerString
 952     MAX-ACCESS  read-create
 953     STATUS      current
 954     DESCRIPTION
 955         "The entity that configured this entry and is
 956         therefore using the resources assigned to it."
 957     ::= { protocolDistControlEntry 5 }
 958
 959 protocolDistControlStatus OBJECT-TYPE
 960     SYNTAX      RowStatus
 961     MAX-ACCESS  read-create
 962     STATUS      current
 963     DESCRIPTION
 964         "The status of this row.
 965
 966         An entry may not exist in the active state unless all
 967         objects in the entry have an appropriate value.
 968
 969         If this object is not equal to active(1), all associated
 970         entries in the protocolDistStatsTable shall be deleted."
 971     ::= { protocolDistControlEntry 6 }
 972
 973 -- per interface protocol distribution statistics table
 974 protocolDistStatsTable OBJECT-TYPE
 975     SYNTAX      SEQUENCE OF ProtocolDistStatsEntry
 976     MAX-ACCESS  not-accessible
 977     STATUS      current
 978     DESCRIPTION
 979         "An entry is made in this table for every protocol in the
 980         protocolDirTable that has been seen in at least one packet.
 981         Counters are updated in this table for every protocol type
 982         that is encountered when parsing a packet, but no counters are
 983
 984
 985
 986         updated for packets with MAC-layer errors.
 987
 988         Note that if a protocolDirEntry is deleted, all associated
 989         entries in this table are removed."
 990     ::= { protocolDist 2 }
 991
 992 protocolDistStatsEntry OBJECT-TYPE
 993     SYNTAX      ProtocolDistStatsEntry
 994     MAX-ACCESS  not-accessible
 995     STATUS      current
 996     DESCRIPTION
 997         "A conceptual row in the protocolDistStatsTable.
 998
 999         The index is composed of the protocolDistControlIndex of the
1000         associated protocolDistControlEntry, followed by the
1001         protocolDirLocalIndex of the associated protocol that this
1002         entry represents.  In other words, the index identifies the
1003         protocol distribution an entry is a part of and the
1004         particular protocol that it represents.
1005
1006         An example of the indexing of this entry is
1007         protocolDistStatsPkts.1.18"
1008     INDEX { protocolDistControlIndex, protocolDirLocalIndex }
1009     ::= { protocolDistStatsTable 1 }
1010
1011 ProtocolDistStatsEntry ::= SEQUENCE {
1012     protocolDistStatsPkts                    ZeroBasedCounter32,
1013     protocolDistStatsOctets                  ZeroBasedCounter32
1014 }
1015
1016 protocolDistStatsPkts OBJECT-TYPE
1017     SYNTAX      ZeroBasedCounter32
1018     MAX-ACCESS  read-only
1019     STATUS      current
1020     DESCRIPTION
1021         "The number of packets of this protocol type received
1022         without errors.  Note that this is the number of
1023         link-layer packets, so if a single network-layer packet
1024         is fragmented into several link-layer frames, this counter
1025         is incremented several times."
1026     ::= { protocolDistStatsEntry 1 }
1027
1028 protocolDistStatsOctets OBJECT-TYPE
1029     SYNTAX      ZeroBasedCounter32
1030     MAX-ACCESS  read-only
1031     STATUS      current
1032     DESCRIPTION
1033         "The number of octets in packets of this protocol type
1034
1035
1036
1037         received since it was added to the protocolDistStatsTable
1038         (excluding framing bits, but including FCS octets), except for
1039         those octets in packets that contained errors.
1040
1041         Note that this doesn't count just those octets in the
1042         particular protocol frames but includes the entire packet
1043         that contained the protocol."
1044     ::= { protocolDistStatsEntry 2 }
1045
1046 --
1047 -- Address Map Group   (addressMap)
1048 --
1049 -- Lists MAC address to network address bindings discovered by the
1050 -- probe and what interface they were last seen on.
1051 --    addressMapControlTable
1052 --    addressMapTable
1053
1054 addressMapInserts OBJECT-TYPE
1055     SYNTAX     Counter32
1056     MAX-ACCESS read-only
1057     STATUS     current
1058     DESCRIPTION
1059         "The number of times an address mapping entry has been
1060         inserted into the addressMapTable.  If an entry is inserted,
1061         then deleted, and then inserted, this counter will be
1062         incremented by 2.
1063
1064         Note that the table size can be determined by subtracting
1065         addressMapDeletes from addressMapInserts."
1066     ::= { addressMap 1 }
1067
1068 addressMapDeletes OBJECT-TYPE
1069     SYNTAX     Counter32
1070     MAX-ACCESS read-only
1071     STATUS     current
1072     DESCRIPTION
1073         "The number of times an address mapping entry has been
1074         deleted from the addressMapTable (for any reason).  If
1075         an entry is deleted, then inserted, and then deleted, this
1076         counter will be incremented by 2.
1077
1078         Note that the table size can be determined by subtracting
1079         addressMapDeletes from addressMapInserts."
1080     ::= { addressMap 2 }
1081
1082 addressMapMaxDesiredEntries OBJECT-TYPE
1083     SYNTAX      Integer32 (-1..2147483647)
1084     MAX-ACCESS  read-write
1085
1086
1087
1088     STATUS      current
1089     DESCRIPTION
1090         "The maximum number of entries that are desired in the
1091         addressMapTable.  The probe will not create more than
1092         this number of entries in the table but may choose to create
1093         fewer entries in this table for any reason, including the lack
1094         of resources.
1095
1096         If this object is set to a value less than the current number
1097         of entries, enough entries are chosen in an
1098         implementation-dependent manner and deleted so that the number
1099         of entries in the table equals the value of this object.
1100
1101         If this value is set to -1, the probe may create any number
1102         of entries in this table.
1103
1104         This object may be used to control how resources are allocated
1105         on the probe for the various RMON functions."
1106     ::= { addressMap 3 }
1107
1108 addressMapControlTable OBJECT-TYPE
1109     SYNTAX      SEQUENCE OF AddressMapControlEntry
1110     MAX-ACCESS  not-accessible
1111     STATUS      current
1112     DESCRIPTION
1113         "A table to control the collection of mappings from network
1114          layer address to physical address to interface.
1115
1116         Note that this is not like the typical RMON
1117         controlTable and dataTable in which each entry creates
1118         its own data table.  Each entry in this table enables the
1119         discovery of addresses on a new interface and the placement
1120         of address mappings into the central addressMapTable.
1121
1122         Implementations are encouraged to add an entry per monitored
1123         interface upon initialization so that a default collection
1124         of address mappings is available."
1125     ::= { addressMap 4 }
1126
1127 addressMapControlEntry OBJECT-TYPE
1128     SYNTAX      AddressMapControlEntry
1129     MAX-ACCESS  not-accessible
1130     STATUS      current
1131     DESCRIPTION
1132         "A conceptual row in the addressMapControlTable.
1133
1134         An example of the indexing of this entry is
1135         addressMapControlDroppedFrames.1"
1136
1137
1138
1139     INDEX { addressMapControlIndex }
1140     ::= { addressMapControlTable 1 }
1141
1142 AddressMapControlEntry ::= SEQUENCE {
1143     addressMapControlIndex              Integer32,
1144     addressMapControlDataSource         DataSource,
1145     addressMapControlDroppedFrames      Counter32,
1146     addressMapControlOwner              OwnerString,
1147     addressMapControlStatus             RowStatus
1148 }
1149
1150 addressMapControlIndex OBJECT-TYPE
1151     SYNTAX      Integer32 (1..65535)
1152     MAX-ACCESS  not-accessible
1153     STATUS      current
1154     DESCRIPTION
1155         "A unique index for this entry in the addressMapControlTable."
1156     ::= { addressMapControlEntry 1 }
1157
1158 addressMapControlDataSource OBJECT-TYPE
1159     SYNTAX      DataSource
1160     MAX-ACCESS  read-create
1161     STATUS      current
1162     DESCRIPTION
1163         "The source of data for this addressMapControlEntry."
1164     ::= { addressMapControlEntry 2 }
1165
1166 addressMapControlDroppedFrames OBJECT-TYPE
1167     SYNTAX     Counter32
1168     MAX-ACCESS read-only
1169     STATUS     current
1170     DESCRIPTION
1171        "The total number of frames that were received by the probe
1172         and therefore not accounted for in the *StatsDropEvents, but
1173         that the probe chose not to count for this entry for
1174         whatever reason.  Most often, this event occurs when the probe
1175         is out of some resources and decides to shed load from this
1176         collection.
1177
1178         This count does not include packets that were not counted
1179         because they had MAC-layer errors.
1180
1181         Note that, unlike the dropEvents counter, this number is the
1182         exact number of frames dropped."
1183     ::= { addressMapControlEntry 3 }
1184
1185 addressMapControlOwner OBJECT-TYPE
1186     SYNTAX      OwnerString
1187
1188
1189
1190     MAX-ACCESS  read-create
1191     STATUS      current
1192     DESCRIPTION
1193         "The entity that configured this entry and is
1194         therefore using the resources assigned to it."
1195     ::= { addressMapControlEntry 4 }
1196
1197 addressMapControlStatus OBJECT-TYPE
1198     SYNTAX      RowStatus
1199     MAX-ACCESS  read-create
1200     STATUS      current
1201     DESCRIPTION
1202         "The status of this addressMap control entry.
1203
1204         An entry may not exist in the active state unless all
1205         objects in the entry have an appropriate value.
1206
1207         If this object is not equal to active(1), all associated
1208         entries in the addressMapTable shall be deleted."
1209     ::= { addressMapControlEntry 5 }
1210
1211 addressMapTable OBJECT-TYPE
1212     SYNTAX      SEQUENCE OF AddressMapEntry
1213     MAX-ACCESS  not-accessible
1214     STATUS      current
1215     DESCRIPTION
1216         "A table of mappings from network layer address to physical
1217         address to interface.
1218
1219         The probe will add entries to this table based on the source
1220         MAC and network addresses seen in packets without MAC-level
1221         errors.  The probe will populate this table for all protocols
1222         in the protocol directory table whose value of
1223         protocolDirAddressMapConfig is equal to supportedOn(3), and
1224         will delete any entries whose protocolDirEntry is deleted or
1225         has a protocolDirAddressMapConfig value of supportedOff(2)."
1226     ::= { addressMap 5 }
1227
1228 addressMapEntry OBJECT-TYPE
1229     SYNTAX      AddressMapEntry
1230     MAX-ACCESS  not-accessible
1231     STATUS      current
1232     DESCRIPTION
1233         "A conceptual row in the addressMapTable.
1234
1235         The protocolDirLocalIndex in the index identifies the network
1236         layer protocol of the addressMapNetworkAddress.
1237
1238
1239
1240
1241         An example of the indexing of this entry is
1242         addressMapSource.783495.18.4.128.2.6.6.11.1.3.6.1.2.1.2.2.1.1.1.
1243
1244         Note that some combinations of index values may result in an
1245         index that exceeds 128 sub-identifiers in length, which exceeds
1246         the maximum for the SNMP protocol.  Implementations should take
1247         care to avoid such combinations."
1248     INDEX { addressMapTimeMark, protocolDirLocalIndex,
1249             addressMapNetworkAddress, addressMapSource }
1250     ::= { addressMapTable 1 }
1251
1252 AddressMapEntry ::= SEQUENCE {
1253     addressMapTimeMark                 TimeFilter,
1254     addressMapNetworkAddress           OCTET STRING,
1255     addressMapSource                   OBJECT IDENTIFIER,
1256     addressMapPhysicalAddress          OCTET STRING,
1257     addressMapLastChange               TimeStamp
1258 }
1259
1260 addressMapTimeMark OBJECT-TYPE
1261     SYNTAX      TimeFilter
1262     MAX-ACCESS  not-accessible
1263     STATUS      current
1264     DESCRIPTION
1265         "A TimeFilter for this entry.  See the TimeFilter textual
1266         convention to see how this works."
1267     ::= { addressMapEntry 1 }
1268
1269 addressMapNetworkAddress OBJECT-TYPE
1270     SYNTAX      OCTET STRING (SIZE (1..255))
1271     MAX-ACCESS  not-accessible
1272     STATUS      current
1273     DESCRIPTION
1274         "The network address for this relation.
1275
1276         This is represented as an octet string with
1277         specific semantics and length as identified
1278         by the protocolDirLocalIndex component of the
1279         index.
1280
1281         For example, if the protocolDirLocalIndex indicates an
1282         encapsulation of ip, this object is encoded as a length
1283         octet of 4, followed by the 4 octets of the IP address,
1284         in network byte order."
1285     ::= { addressMapEntry 2 }
1286
1287 addressMapSource OBJECT-TYPE
1288     SYNTAX      OBJECT IDENTIFIER
1289
1290
1291
1292     MAX-ACCESS  not-accessible
1293     STATUS      current
1294     DESCRIPTION
1295         "The interface or port on which the associated network
1296          address was most recently seen.
1297
1298         If this address mapping was discovered on an interface, this
1299         object shall identify the instance of the ifIndex
1300         object, defined in [RFC2863], for the desired interface.
1301         For example, if an entry were to receive data from
1302         interface #1, this object would be set to ifIndex.1.
1303
1304         If this address mapping was discovered on a port, this
1305         object shall identify the instance of the rptrGroupPortIndex
1306         object, defined in [RFC2108], for the desired port.
1307         For example, if an entry were to receive data from
1308         group #1, port #1, this object would be set to
1309         rptrGroupPortIndex.1.1.
1310
1311         Note that while the dataSource associated with this entry
1312         may only point to index objects, this object may at times
1313         point to repeater port objects.  This situation occurs when
1314         the dataSource points to an interface that is a locally
1315         attached repeater and the agent has additional information
1316         about the source port of traffic seen on that repeater."
1317     ::= { addressMapEntry 3 }
1318
1319 addressMapPhysicalAddress OBJECT-TYPE
1320     SYNTAX      OCTET STRING
1321     MAX-ACCESS  read-only
1322     STATUS      current
1323     DESCRIPTION
1324         "The last source physical address on which the associated
1325         network address was seen.  If the protocol of the associated
1326         network address was encapsulated inside of a network-level or
1327         higher protocol, this will be the address of the next-lower
1328         protocol with the addressRecognitionCapable bit enabled and
1329         will be formatted as specified for that protocol."
1330     ::= { addressMapEntry 4 }
1331
1332 addressMapLastChange OBJECT-TYPE
1333     SYNTAX      TimeStamp
1334     MAX-ACCESS  read-only
1335     STATUS      current
1336     DESCRIPTION
1337         "The value of sysUpTime at the time this entry was last
1338         created or the values of the physical address changed.
1339
1340
1341
1342
1343         This can be used to help detect duplicate address problems, in
1344         which case this object will be updated frequently."
1345     ::= { addressMapEntry 5 }
1346
1347 --
1348 -- Network Layer Host Group
1349 --
1350 -- Counts the amount of traffic sent from and to each network address
1351 -- discovered by the probe.
1352 -- Note that while the hlHostControlTable also has objects that
1353 -- control an optional alHostTable, implementation of the alHostTable is
1354 -- not required to fully implement this group.
1355
1356 hlHostControlTable OBJECT-TYPE
1357     SYNTAX      SEQUENCE OF HlHostControlEntry
1358     MAX-ACCESS  not-accessible
1359     STATUS      current
1360     DESCRIPTION
1361         "A list of higher-layer (i.e., non-MAC) host table control
1362         entries.
1363
1364         These entries will enable the collection of the network- and
1365         application-level host tables indexed by network addresses.
1366         Both the network- and application-level host tables are
1367         controlled by this table so that they will both be created
1368         and deleted at the same time, further increasing the ease with
1369         which they can be implemented as a single datastore.  (Note that
1370         if an implementation stores application-layer host records in
1371         memory, it can derive network-layer host records from them.)
1372
1373         Entries in the nlHostTable will be created on behalf of each
1374         entry in this table.  Additionally, if this probe implements
1375         the alHostTable, entries in the alHostTable will be created on
1376         behalf of each entry in this table.
1377
1378         Implementations are encouraged to add an entry per monitored
1379         interface upon initialization so that a default collection
1380         of host statistics is available."
1381     ::= { nlHost 1 }
1382
1383 hlHostControlEntry OBJECT-TYPE
1384     SYNTAX      HlHostControlEntry
1385     MAX-ACCESS  not-accessible
1386     STATUS      current
1387     DESCRIPTION
1388         "A conceptual row in the hlHostControlTable.
1389
1390         An example of the indexing of this entry is
1391
1392
1393
1394         hlHostControlNlDroppedFrames.1"
1395     INDEX { hlHostControlIndex }
1396     ::= { hlHostControlTable 1 }
1397
1398 HlHostControlEntry ::= SEQUENCE {
1399     hlHostControlIndex               Integer32,
1400     hlHostControlDataSource          DataSource,
1401     hlHostControlNlDroppedFrames     Counter32,
1402     hlHostControlNlInserts           Counter32,
1403     hlHostControlNlDeletes           Counter32,
1404     hlHostControlNlMaxDesiredEntries Integer32,
1405     hlHostControlAlDroppedFrames     Counter32,
1406     hlHostControlAlInserts           Counter32,
1407     hlHostControlAlDeletes           Counter32,
1408     hlHostControlAlMaxDesiredEntries Integer32,
1409     hlHostControlOwner               OwnerString,
1410     hlHostControlStatus              RowStatus
1411 }
1412
1413 hlHostControlIndex OBJECT-TYPE
1414     SYNTAX      Integer32 (1..65535)
1415     MAX-ACCESS  not-accessible
1416     STATUS      current
1417     DESCRIPTION
1418         "An index that uniquely identifies an entry in the
1419         hlHostControlTable.  Each such entry defines
1420         a function that discovers hosts on a particular
1421         interface and places statistics about them in the
1422         nlHostTable, and optionally in the alHostTable, on
1423         behalf of this hlHostControlEntry."
1424     ::= { hlHostControlEntry 1 }
1425
1426 hlHostControlDataSource OBJECT-TYPE
1427     SYNTAX      DataSource
1428     MAX-ACCESS  read-create
1429     STATUS      current
1430     DESCRIPTION
1431         "The source of data for the associated host tables.
1432
1433         The statistics in this group reflect all packets
1434         on the local network segment attached to the
1435         identified interface.
1436
1437         This object may not be modified if the associated
1438         hlHostControlStatus object is equal to active(1)."
1439     ::= { hlHostControlEntry 2 }
1440
1441 hlHostControlNlDroppedFrames OBJECT-TYPE
1442
1443
1444
1445     SYNTAX     Counter32
1446     MAX-ACCESS read-only
1447     STATUS     current
1448     DESCRIPTION
1449        "The total number of frames that were received by the probe
1450         and therefore not accounted for in the *StatsDropEvents, but
1451         that the probe chose not to count for the associated
1452         nlHost entries for whatever reason.  Most often, this event
1453         occurs when the probe is out of some resources and decides to
1454         shed load from this collection.
1455
1456         This count does not include packets that were not counted
1457         because they had MAC-layer errors.
1458
1459         Note that if the nlHostTable is inactive because no protocols
1460         are enabled in the protocol directory, this value should be 0.
1461
1462         Note that, unlike the dropEvents counter, this number is the
1463         exact number of frames dropped."
1464     ::= { hlHostControlEntry 3 }
1465
1466 hlHostControlNlInserts OBJECT-TYPE
1467     SYNTAX     Counter32
1468     MAX-ACCESS read-only
1469     STATUS     current
1470     DESCRIPTION
1471         "The number of times an nlHost entry has been
1472         inserted into the nlHost table.  If an entry is inserted, then
1473         deleted, and then inserted, this counter will be incremented
1474         by 2.
1475
1476         To allow for efficient implementation strategies, agents may
1477         delay updating this object for short periods of time.  For
1478         example, an implementation strategy may allow internal
1479         data structures to differ from those visible via SNMP for
1480         short periods of time.  This counter may reflect the internal
1481         data structures for those short periods of time.
1482
1483         Note that the table size can be determined by subtracting
1484         hlHostControlNlDeletes from hlHostControlNlInserts."
1485     ::= { hlHostControlEntry 4 }
1486
1487 hlHostControlNlDeletes OBJECT-TYPE
1488     SYNTAX     Counter32
1489     MAX-ACCESS read-only
1490     STATUS     current
1491     DESCRIPTION
1492         "The number of times an nlHost entry has been
1493
1494
1495
1496         deleted from the nlHost table (for any reason).  If an entry
1497         is deleted, then inserted, and then deleted, this counter will
1498         be incremented by 2.
1499
1500         To allow for efficient implementation strategies, agents may
1501         delay updating this object for short periods of time.  For
1502         example, an implementation strategy may allow internal
1503         data structures to differ from those visible via SNMP for
1504         short periods of time.  This counter may reflect the internal
1505         data structures for those short periods of time.
1506
1507         Note that the table size can be determined by subtracting
1508         hlHostControlNlDeletes from hlHostControlNlInserts."
1509     ::= { hlHostControlEntry 5 }
1510
1511 hlHostControlNlMaxDesiredEntries OBJECT-TYPE
1512     SYNTAX      Integer32 (-1..2147483647)
1513     MAX-ACCESS  read-create
1514     STATUS      current
1515     DESCRIPTION
1516         "The maximum number of entries that are desired in the
1517         nlHostTable on behalf of this control entry.  The probe will
1518         not create more than this number of associated entries in the
1519         table but may choose to create fewer entries in this table
1520         for any reason, including the lack of resources.
1521
1522         If this object is set to a value less than the current number
1523         of entries, enough entries are chosen in an
1524         implementation-dependent manner and deleted so that the number
1525         of entries in the table equals the value of this object.
1526
1527         If this value is set to -1, the probe may create any number
1528         of entries in this table.  If the associated
1529         hlHostControlStatus object is equal to 'active', this
1530         object may not be modified.
1531
1532         This object may be used to control how resources are allocated
1533         on the probe for the various RMON functions."
1534     ::= { hlHostControlEntry 6 }
1535
1536 hlHostControlAlDroppedFrames OBJECT-TYPE
1537     SYNTAX     Counter32
1538     MAX-ACCESS read-only
1539     STATUS     current
1540     DESCRIPTION
1541        "The total number of frames that were received by the probe
1542         and therefore not accounted for in the *StatsDropEvents, but
1543         that the probe chose not to count for the associated
1544
1545
1546
1547         alHost entries for whatever reason.  Most often, this event
1548         occurs when the probe is out of some resources and decides to
1549         shed load from this collection.
1550
1551         This count does not include packets that were not counted
1552         because they had MAC-layer errors.
1553
1554         Note that if the alHostTable is not implemented or is inactive
1555         because no protocols are enabled in the protocol directory,
1556         this value should be 0.
1557
1558         Note that, unlike the dropEvents counter, this number is the
1559         exact number of frames dropped."
1560     ::= { hlHostControlEntry 7 }
1561
1562 hlHostControlAlInserts OBJECT-TYPE
1563     SYNTAX     Counter32
1564     MAX-ACCESS read-only
1565     STATUS     current
1566     DESCRIPTION
1567         "The number of times an alHost entry has been
1568         inserted into the alHost table.  If an entry is inserted, then
1569         deleted, and then inserted, this counter will be incremented
1570         by 2.
1571
1572         To allow for efficient implementation strategies, agents may
1573         delay updating this object for short periods of time.  For
1574         example, an implementation strategy may allow internal
1575         data structures to differ from those visible via SNMP for
1576         short periods of time.  This counter may reflect the internal
1577         data structures for those short periods of time.
1578
1579         Note that the table size can be determined by subtracting
1580         hlHostControlAlDeletes from hlHostControlAlInserts."
1581     ::= { hlHostControlEntry 8 }
1582
1583 hlHostControlAlDeletes OBJECT-TYPE
1584     SYNTAX     Counter32
1585     MAX-ACCESS read-only
1586     STATUS     current
1587     DESCRIPTION
1588         "The number of times an alHost entry has been
1589         deleted from the alHost table (for any reason).  If an entry
1590         is deleted, then inserted, and then deleted, this counter will
1591         be incremented by 2.
1592
1593         To allow for efficient implementation strategies, agents may
1594         delay updating this object for short periods of time.  For
1595
1596
1597
1598         example, an implementation strategy may allow internal
1599         data structures to differ from those visible via SNMP for
1600         short periods of time.  This counter may reflect the internal
1601         data structures for those short periods of time.
1602
1603         Note that the table size can be determined by subtracting
1604         hlHostControlAlDeletes from hlHostControlAlInserts."
1605     ::= { hlHostControlEntry 9 }
1606
1607 hlHostControlAlMaxDesiredEntries OBJECT-TYPE
1608     SYNTAX      Integer32 (-1..2147483647)
1609     MAX-ACCESS  read-create
1610     STATUS      current
1611     DESCRIPTION
1612         "The maximum number of entries that are desired in the alHost
1613         table on behalf of this control entry.  The probe will not
1614         create more than this number of associated entries in the
1615         table but may choose to create fewer entries in this table
1616         for any reason, including the lack of resources.
1617
1618         If this object is set to a value less than the current number
1619         of entries, enough entries are chosen in an
1620         implementation-dependent manner and deleted so that the number
1621         of entries in the table equals the value of this object.
1622
1623         If this value is set to -1, the probe may create any number
1624         of entries in this table.  If the associated
1625         hlHostControlStatus object is equal to 'active', this
1626         object may not be modified.
1627
1628         This object may be used to control how resources are allocated
1629         on the probe for the various RMON functions."
1630     ::= { hlHostControlEntry 10 }
1631
1632 hlHostControlOwner OBJECT-TYPE
1633     SYNTAX      OwnerString
1634     MAX-ACCESS  read-create
1635     STATUS      current
1636     DESCRIPTION
1637         "The entity that configured this entry and is
1638         therefore using the resources assigned to it."
1639     ::= { hlHostControlEntry 11 }
1640
1641 hlHostControlStatus OBJECT-TYPE
1642     SYNTAX      RowStatus
1643     MAX-ACCESS  read-create
1644     STATUS      current
1645     DESCRIPTION
1646
1647
1648
1649         "The status of this hlHostControlEntry.
1650
1651         An entry may not exist in the active state unless all
1652         objects in the entry have an appropriate value.
1653
1654         If this object is not equal to active(1), all associated
1655         entries in the nlHostTable and alHostTable shall be deleted."
1656     ::= { hlHostControlEntry 12 }
1657
1658 nlHostTable OBJECT-TYPE
1659     SYNTAX      SEQUENCE OF NlHostEntry
1660     MAX-ACCESS  not-accessible
1661     STATUS      current
1662     DESCRIPTION
1663         "A collection of statistics for a particular network layer
1664         address that has been discovered on an interface of this
1665         device.
1666
1667         The probe will populate this table for all network layer
1668         protocols in the protocol directory table whose value of
1669         protocolDirHostConfig is equal to supportedOn(3), and
1670         will delete any entries whose protocolDirEntry is deleted or
1671         has a protocolDirHostConfig value of supportedOff(2).
1672
1673         The probe will add to this table all addresses seen
1674         as the source or destination address in all packets with no
1675         MAC errors, and will increment octet and packet counts in the
1676         table for all packets with no MAC errors."
1677 ::= { nlHost 2 }
1678
1679 nlHostEntry OBJECT-TYPE
1680     SYNTAX      NlHostEntry
1681     MAX-ACCESS  not-accessible
1682     STATUS      current
1683     DESCRIPTION
1684         "A conceptual row in the nlHostTable.
1685
1686         The hlHostControlIndex value in the index identifies the
1687         hlHostControlEntry on whose behalf this entry was created.
1688         The protocolDirLocalIndex value in the index identifies the
1689         network layer protocol of the nlHostAddress.
1690
1691         An example of the indexing of this entry is
1692         nlHostOutPkts.1.783495.18.4.128.2.6.6.
1693
1694         Note that some combinations of index values may result in an
1695         index that exceeds 128 sub-identifiers in length, which exceeds
1696         the maximum for the SNMP protocol.  Implementations should take
1697
1698
1699
1700         care to avoid such combinations."
1701     INDEX { hlHostControlIndex, nlHostTimeMark,
1702             protocolDirLocalIndex, nlHostAddress }
1703     ::= { nlHostTable 1 }
1704
1705 NlHostEntry ::= SEQUENCE {
1706     nlHostTimeMark              TimeFilter,
1707     nlHostAddress               OCTET STRING,
1708     nlHostInPkts                ZeroBasedCounter32,
1709     nlHostOutPkts               ZeroBasedCounter32,
1710     nlHostInOctets              ZeroBasedCounter32,
1711     nlHostOutOctets             ZeroBasedCounter32,
1712     nlHostOutMacNonUnicastPkts  ZeroBasedCounter32,
1713     nlHostCreateTime            LastCreateTime
1714 }
1715
1716 nlHostTimeMark OBJECT-TYPE
1717     SYNTAX      TimeFilter
1718     MAX-ACCESS  not-accessible
1719     STATUS      current
1720     DESCRIPTION
1721         "A TimeFilter for this entry.  See the TimeFilter textual
1722         convention to see how this works."
1723     ::= { nlHostEntry 1 }
1724
1725 nlHostAddress OBJECT-TYPE
1726     SYNTAX      OCTET STRING  (SIZE (1..255))
1727     MAX-ACCESS  not-accessible
1728     STATUS      current
1729     DESCRIPTION
1730         "The network address for this nlHostEntry.
1731
1732         This is represented as an octet string with
1733         specific semantics and length as identified
1734         by the protocolDirLocalIndex component of the index.
1735
1736         For example, if the protocolDirLocalIndex indicates an
1737         encapsulation of IP, this object is encoded as a length
1738         octet of 4, followed by the 4 octets of the IP address,
1739         in network byte order."
1740     ::= { nlHostEntry 2 }
1741
1742 nlHostInPkts OBJECT-TYPE
1743     SYNTAX      ZeroBasedCounter32
1744     MAX-ACCESS  read-only
1745     STATUS      current
1746     DESCRIPTION
1747         "The number of packets without errors transmitted to
1748
1749
1750
1751         this address since it was added to the nlHostTable.  Note that
1752         this is the number of link-layer packets, so if a single
1753         network-layer packet is fragmented into several link-layer
1754         frames, this counter is incremented several times."
1755     ::= { nlHostEntry 3 }
1756
1757 nlHostOutPkts OBJECT-TYPE
1758     SYNTAX      ZeroBasedCounter32
1759     MAX-ACCESS  read-only
1760     STATUS      current
1761     DESCRIPTION
1762         "The number of packets without errors transmitted by
1763         this address since it was added to the nlHostTable.  Note that
1764         this is the number of link-layer packets, so if a single
1765         network-layer packet is fragmented into several link-layer
1766         frames, this counter is incremented several times."
1767     ::= { nlHostEntry 4 }
1768
1769 nlHostInOctets OBJECT-TYPE
1770     SYNTAX      ZeroBasedCounter32
1771     MAX-ACCESS  read-only
1772     STATUS      current
1773     DESCRIPTION
1774         "The number of octets transmitted to this address
1775         since it was added to the nlHostTable (excluding
1776         framing bits, but including FCS octets), excluding
1777         octets in packets that contained errors.
1778
1779         Note that this doesn't count just those octets in the particular
1780         protocol frames but includes the entire packet that contained
1781         the protocol."
1782     ::= { nlHostEntry 5 }
1783
1784 nlHostOutOctets OBJECT-TYPE
1785     SYNTAX      ZeroBasedCounter32
1786     MAX-ACCESS  read-only
1787     STATUS      current
1788     DESCRIPTION
1789         "The number of octets transmitted by this address
1790         since it was added to the nlHostTable (excluding
1791         framing bits, but including FCS octets), excluding
1792         octets in packets that contained errors.
1793
1794         Note that this doesn't count just those octets in the particular
1795         protocol frames but includes the entire packet that contained
1796         the protocol."
1797     ::= { nlHostEntry 6 }
1798
1799
1800
1801
1802 nlHostOutMacNonUnicastPkts OBJECT-TYPE
1803     SYNTAX      ZeroBasedCounter32
1804     MAX-ACCESS  read-only
1805     STATUS      current
1806     DESCRIPTION
1807         "The number of packets without errors transmitted by this
1808         address that were directed to any MAC broadcast addresses
1809         or to any MAC multicast addresses since this host was
1810         added to the nlHostTable.  Note that this is the number of
1811         link-layer packets, so if a single network-layer packet is
1812         fragmented into several link-layer frames, this counter is
1813         incremented several times."
1814     ::= { nlHostEntry 7 }
1815
1816 nlHostCreateTime OBJECT-TYPE
1817     SYNTAX     LastCreateTime
1818     MAX-ACCESS read-only
1819     STATUS     current
1820     DESCRIPTION
1821         "The value of sysUpTime when this entry was last activated.
1822         This can be used by the management station to ensure that the
1823         entry has not been deleted and recreated between polls."
1824     ::= { nlHostEntry 8 }
1825
1826 --
1827 -- Network Layer Matrix Group
1828 --
1829 -- Counts the amount of traffic sent between each pair of network
1830 -- addresses discovered by the probe.
1831 -- Note that while the hlMatrixControlTable also has objects that
1832 -- control optional alMatrixTables, implementation of the
1833 -- alMatrixTables is not required to fully implement this group.
1834
1835 hlMatrixControlTable OBJECT-TYPE
1836     SYNTAX      SEQUENCE OF HlMatrixControlEntry
1837     MAX-ACCESS  not-accessible
1838     STATUS      current
1839     DESCRIPTION
1840         "A list of higher-layer (i.e., non-MAC) matrix control entries.
1841
1842         These entries will enable the collection of the network- and
1843         application-level matrix tables containing conversation
1844         statistics indexed by pairs of network addresses.
1845         Both the network- and application-level matrix tables are
1846         controlled by this table so that they will both be created
1847         and deleted at the same time, further increasing the ease with
1848         which they can be implemented as a single datastore.  (Note that
1849         if an implementation stores application-layer matrix records
1850
1851
1852
1853         in memory, it can derive network-layer matrix records from
1854         them.)
1855
1856         Entries in the nlMatrixSDTable and nlMatrixDSTable will be
1857         created on behalf of each entry in this table.  Additionally,
1858         if this probe implements the alMatrix tables, entries in the
1859         alMatrix tables will be created on behalf of each entry in
1860         this table."
1861     ::= { nlMatrix 1 }
1862
1863 hlMatrixControlEntry OBJECT-TYPE
1864     SYNTAX      HlMatrixControlEntry
1865     MAX-ACCESS  not-accessible
1866     STATUS      current
1867     DESCRIPTION
1868         "A conceptual row in the hlMatrixControlTable.
1869
1870         An example of indexing of this entry is
1871         hlMatrixControlNlDroppedFrames.1"
1872     INDEX { hlMatrixControlIndex }
1873     ::= { hlMatrixControlTable 1 }
1874
1875 HlMatrixControlEntry ::= SEQUENCE {
1876     hlMatrixControlIndex                  Integer32,
1877     hlMatrixControlDataSource             DataSource,
1878     hlMatrixControlNlDroppedFrames        Counter32,
1879     hlMatrixControlNlInserts              Counter32,
1880     hlMatrixControlNlDeletes              Counter32,
1881     hlMatrixControlNlMaxDesiredEntries    Integer32,
1882     hlMatrixControlAlDroppedFrames        Counter32,
1883     hlMatrixControlAlInserts              Counter32,
1884     hlMatrixControlAlDeletes              Counter32,
1885     hlMatrixControlAlMaxDesiredEntries    Integer32,
1886     hlMatrixControlOwner                  OwnerString,
1887     hlMatrixControlStatus                 RowStatus
1888 }
1889
1890 hlMatrixControlIndex OBJECT-TYPE
1891     SYNTAX      Integer32 (1..65535)
1892     MAX-ACCESS  not-accessible
1893     STATUS      current
1894     DESCRIPTION
1895         "An index that uniquely identifies an entry in the
1896         hlMatrixControlTable.  Each such entry defines
1897         a function that discovers conversations on a particular
1898         interface and places statistics about them in the
1899         nlMatrixSDTable and the nlMatrixDSTable, and optionally the
1900         alMatrixSDTable and alMatrixDSTable, on behalf of this
1901
1902
1903
1904         hlMatrixControlEntry."
1905     ::= { hlMatrixControlEntry 1 }
1906
1907 hlMatrixControlDataSource OBJECT-TYPE
1908     SYNTAX      DataSource
1909     MAX-ACCESS  read-create
1910     STATUS      current
1911     DESCRIPTION
1912         "The source of the data for the associated matrix tables.
1913
1914         The statistics in this group reflect all packets
1915         on the local network segment attached to the
1916         identified interface.
1917
1918         This object may not be modified if the associated
1919         hlMatrixControlStatus object is equal to active(1)."
1920     ::= { hlMatrixControlEntry 2 }
1921
1922 hlMatrixControlNlDroppedFrames OBJECT-TYPE
1923     SYNTAX     Counter32
1924     MAX-ACCESS read-only
1925     STATUS     current
1926     DESCRIPTION
1927        "The total number of frames that were received by the probe
1928         and therefore not accounted for in the *StatsDropEvents, but
1929         that the probe chose not to count for this entry for
1930         whatever reason.  Most often, this event occurs when the probe
1931         is out of some resources and decides to shed load from this
1932         collection.
1933
1934         This count does not include packets that were not counted
1935         because they had MAC-layer errors.
1936
1937         Note that if the nlMatrixTables are inactive because no
1938         protocols are enabled in the protocol directory, this value
1939         should be 0.
1940
1941         Note that, unlike the dropEvents counter, this number is the
1942         exact number of frames dropped."
1943     ::= { hlMatrixControlEntry 3 }
1944
1945 hlMatrixControlNlInserts OBJECT-TYPE
1946     SYNTAX     Counter32
1947     MAX-ACCESS read-only
1948     STATUS     current
1949     DESCRIPTION
1950         "The number of times an nlMatrix entry has been
1951         inserted into the nlMatrix tables.  If an entry is inserted,
1952
1953
1954
1955         then deleted, and then inserted, this counter will be
1956         incremented by 2.  The addition of a conversation into both
1957         the nlMatrixSDTable and nlMatrixDSTable shall be counted as
1958         two insertions (even though every addition into one table must
1959         be accompanied by an insertion into the other).
1960
1961         To allow for efficient implementation strategies, agents may
1962         delay updating this object for short periods of time.  For
1963         example, an implementation strategy may allow internal
1964         data structures to differ from those visible via SNMP for
1965         short periods of time.  This counter may reflect the internal
1966         data structures for those short periods of time.
1967
1968         Note that the sum of then nlMatrixSDTable and nlMatrixDSTable
1969         sizes can be determined by subtracting
1970         hlMatrixControlNlDeletes from hlMatrixControlNlInserts."
1971     ::= { hlMatrixControlEntry 4 }
1972
1973 hlMatrixControlNlDeletes OBJECT-TYPE
1974     SYNTAX     Counter32
1975     MAX-ACCESS read-only
1976     STATUS     current
1977     DESCRIPTION
1978         "The number of times an nlMatrix entry has been
1979         deleted from the nlMatrix tables (for any reason).  If an
1980         entry is deleted, then inserted, and then deleted, this
1981         counter will be incremented by 2.  The deletion of a
1982         conversation from both the nlMatrixSDTable and nlMatrixDSTable
1983         shall be counted as two deletions (even though every deletion
1984         from one table must be accompanied by a deletion from the
1985         other).
1986
1987         To allow for efficient implementation strategies, agents may
1988         delay updating this object for short periods of time.  For
1989         example, an implementation strategy may allow internal
1990         data structures to differ from those visible via SNMP for
1991         short periods of time.  This counter may reflect the internal
1992         data structures for those short periods of time.
1993
1994         Note that the table size can be determined by subtracting
1995         hlMatrixControlNlDeletes from hlMatrixControlNlInserts."
1996     ::= { hlMatrixControlEntry 5 }
1997
1998 hlMatrixControlNlMaxDesiredEntries OBJECT-TYPE
1999     SYNTAX      Integer32 (-1..2147483647)
2000     MAX-ACCESS  read-create
2001     STATUS      current
2002     DESCRIPTION
2003
2004
2005
2006         "The maximum number of entries that are desired in the
2007         nlMatrix tables on behalf of this control entry.  The probe
2008         will not create more than this number of associated entries in
2009         the table but may choose to create fewer entries in this
2010         table for any reason, including the lack of resources.
2011
2012         If this object is set to a value less than the current number
2013         of entries, enough entries are chosen in an
2014         implementation-dependent manner and deleted so that the number
2015         of entries in the table equals the value of this object.
2016
2017         If this value is set to -1, the probe may create any number
2018         of entries in this table.  If the associated
2019         hlMatrixControlStatus object is equal to 'active', this
2020         object may not be modified.
2021
2022         This object may be used to control how resources are allocated
2023         on the probe for the various RMON functions."
2024     ::= { hlMatrixControlEntry 6 }
2025
2026 hlMatrixControlAlDroppedFrames OBJECT-TYPE
2027     SYNTAX     Counter32
2028     MAX-ACCESS read-only
2029     STATUS     current
2030     DESCRIPTION
2031        "The total number of frames that were received by the probe
2032         and therefore not accounted for in the *StatsDropEvents, but
2033         that the probe chose not to count for this entry for
2034         whatever reason.  Most often, this event occurs when the probe
2035         is out of some resources and decides to shed load from this
2036         collection.
2037
2038         This count does not include packets that were not counted
2039         because they had MAC-layer errors.
2040
2041         Note that if the alMatrixTables are not implemented or are
2042         inactive because no protocols are enabled in the protocol
2043         directory, this value should be 0.
2044
2045         Note that, unlike the dropEvents counter, this number is the
2046         exact number of frames dropped."
2047     ::= { hlMatrixControlEntry 7 }
2048
2049 hlMatrixControlAlInserts OBJECT-TYPE
2050     SYNTAX     Counter32
2051     MAX-ACCESS read-only
2052     STATUS     current
2053     DESCRIPTION
2054
2055
2056
2057         "The number of times an alMatrix entry has been
2058         inserted into the alMatrix tables.  If an entry is inserted,
2059         then deleted, and then inserted, this counter will be
2060         incremented by 2.  The addition of a conversation into both
2061         the alMatrixSDTable and alMatrixDSTable shall be counted as
2062         two insertions (even though every addition into one table must
2063         be accompanied by an insertion into the other).
2064
2065         To allow for efficient implementation strategies, agents may
2066         delay updating this object for short periods of time.  For
2067         example, an implementation strategy may allow internal
2068         data structures to differ from those visible via SNMP for
2069         short periods of time.  This counter may reflect the internal
2070         data structures for those short periods of time.
2071
2072         Note that the table size can be determined by subtracting
2073         hlMatrixControlAlDeletes from hlMatrixControlAlInserts."
2074     ::= { hlMatrixControlEntry 8 }
2075
2076 hlMatrixControlAlDeletes OBJECT-TYPE
2077     SYNTAX     Counter32
2078     MAX-ACCESS read-only
2079     STATUS     current
2080     DESCRIPTION
2081         "The number of times an alMatrix entry has been
2082         deleted from the alMatrix tables.  If an entry is deleted,
2083         then inserted, and then deleted, this counter will be
2084         incremented by 2.  The deletion of a conversation from both
2085         the alMatrixSDTable and alMatrixDSTable shall be counted as
2086         two deletions (even though every deletion from one table must
2087         be accompanied by a deletion from the other).
2088
2089         To allow for efficient implementation strategies, agents may
2090         delay updating this object for short periods of time.  For
2091         example, an implementation strategy may allow internal
2092         data structures to differ from those visible via SNMP for
2093         short periods of time.  This counter may reflect the internal
2094         data structures for those short periods of time.
2095
2096         Note that the table size can be determined by subtracting
2097         hlMatrixControlAlDeletes from hlMatrixControlAlInserts."
2098     ::= { hlMatrixControlEntry 9 }
2099
2100 hlMatrixControlAlMaxDesiredEntries OBJECT-TYPE
2101     SYNTAX      Integer32 (-1..2147483647)
2102     MAX-ACCESS  read-create
2103     STATUS      current
2104     DESCRIPTION
2105
2106
2107
2108         "The maximum number of entries that are desired in the
2109         alMatrix tables on behalf of this control entry.  The probe
2110         will not create more than this number of associated entries in
2111         the table but may choose to create fewer entries in this
2112         table for any reason, including the lack of resources.
2113
2114         If this object is set to a value less than the current number
2115         of entries, enough entries are chosen in an
2116         implementation-dependent manner and deleted so that the number
2117         of entries in the table equals the value of this object.
2118
2119         If this value is set to -1, the probe may create any number
2120         of entries in this table.  If the associated
2121         hlMatrixControlStatus object is equal to 'active', this
2122         object may not be modified.
2123
2124         This object may be used to control how resources are allocated
2125         on the probe for the various RMON functions."
2126     ::= { hlMatrixControlEntry 10 }
2127
2128 hlMatrixControlOwner OBJECT-TYPE
2129     SYNTAX      OwnerString
2130     MAX-ACCESS  read-create
2131     STATUS      current
2132     DESCRIPTION
2133         "The entity that configured this entry and is
2134         therefore using the resources assigned to it."
2135     ::= { hlMatrixControlEntry 11 }
2136
2137 hlMatrixControlStatus OBJECT-TYPE
2138     SYNTAX      RowStatus
2139     MAX-ACCESS  read-create
2140     STATUS      current
2141     DESCRIPTION
2142         "The status of this hlMatrixControlEntry.
2143
2144         An entry may not exist in the active state unless all
2145         objects in the entry have an appropriate value.
2146
2147         If this object is not equal to active(1), all
2148         associated entries in the nlMatrixSDTable,
2149         nlMatrixDSTable, alMatrixSDTable, and alMatrixDSTable
2150         shall be deleted by the agent."
2151     ::= { hlMatrixControlEntry 12 }
2152
2153 nlMatrixSDTable OBJECT-TYPE
2154     SYNTAX      SEQUENCE OF NlMatrixSDEntry
2155     MAX-ACCESS  not-accessible
2156
2157
2158
2159     STATUS      current
2160     DESCRIPTION
2161         "A list of traffic matrix entries that collect statistics for
2162         conversations between two network-level addresses.  This table
2163         is indexed first by the source address and then by the
2164         destination address to make it convenient to collect all
2165         conversations from a particular address.
2166
2167         The probe will populate this table for all network layer
2168         protocols in the protocol directory table whose value of
2169         protocolDirMatrixConfig is equal to supportedOn(3), and
2170         will delete any entries whose protocolDirEntry is deleted or
2171         has a protocolDirMatrixConfig value of supportedOff(2).
2172
2173         The probe will add to this table all pairs of addresses
2174         seen in all packets with no MAC errors and will increment
2175         octet and packet counts in the table for all packets with no
2176         MAC errors.
2177
2178         Further, this table will only contain entries that have a
2179         corresponding entry in the nlMatrixDSTable with the same
2180         source address and destination address."
2181     ::= { nlMatrix 2 }
2182
2183 nlMatrixSDEntry OBJECT-TYPE
2184     SYNTAX      NlMatrixSDEntry
2185     MAX-ACCESS  not-accessible
2186     STATUS      current
2187     DESCRIPTION
2188         "A conceptual row in the nlMatrixSDTable.
2189
2190         The hlMatrixControlIndex value in the index identifies the
2191         hlMatrixControlEntry on whose behalf this entry was created.
2192         The protocolDirLocalIndex value in the index identifies the
2193         network-layer protocol of the nlMatrixSDSourceAddress and
2194         nlMatrixSDDestAddress.
2195
2196         An example of the indexing of this table is
2197         nlMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7.
2198
2199         Note that some combinations of index values may result in an
2200         index that exceeds 128 sub-identifiers in length, which exceeds
2201         the maximum for the SNMP protocol.  Implementations should take
2202         care to avoid such combinations."
2203     INDEX { hlMatrixControlIndex, nlMatrixSDTimeMark,
2204             protocolDirLocalIndex,
2205             nlMatrixSDSourceAddress, nlMatrixSDDestAddress }
2206     ::= { nlMatrixSDTable 1 }
2207
2208
2209
2210 NlMatrixSDEntry ::= SEQUENCE {
2211     nlMatrixSDTimeMark              TimeFilter,
2212     nlMatrixSDSourceAddress         OCTET STRING,
2213     nlMatrixSDDestAddress           OCTET STRING,
2214     nlMatrixSDPkts                  ZeroBasedCounter32,
2215     nlMatrixSDOctets                ZeroBasedCounter32,
2216     nlMatrixSDCreateTime            LastCreateTime
2217 }
2218
2219 nlMatrixSDTimeMark OBJECT-TYPE
2220     SYNTAX      TimeFilter
2221     MAX-ACCESS  not-accessible
2222     STATUS      current
2223     DESCRIPTION
2224         "A TimeFilter for this entry.  See the TimeFilter textual
2225         convention to see how this works."
2226     ::= { nlMatrixSDEntry 1 }
2227
2228 nlMatrixSDSourceAddress OBJECT-TYPE
2229     SYNTAX      OCTET STRING  (SIZE (1..255))
2230     MAX-ACCESS  not-accessible
2231     STATUS      current
2232     DESCRIPTION
2233         "The network source address for this nlMatrixSDEntry.
2234
2235         This is represented as an octet string with
2236         specific semantics and length as identified
2237         by the protocolDirLocalIndex component of the index.
2238
2239         For example, if the protocolDirLocalIndex indicates an
2240         encapsulation of IP, this object is encoded as a length
2241         octet of 4, followed by the 4 octets of the IP address,
2242         in network byte order."
2243     ::= { nlMatrixSDEntry 2 }
2244
2245 nlMatrixSDDestAddress OBJECT-TYPE
2246     SYNTAX      OCTET STRING  (SIZE (1..255))
2247     MAX-ACCESS  not-accessible
2248     STATUS      current
2249     DESCRIPTION
2250         "The network destination address for this
2251         nlMatrixSDEntry.
2252
2253         This is represented as an octet string with
2254         specific semantics and length as identified
2255         by the protocolDirLocalIndex component of the index.
2256
2257         For example, if the protocolDirLocalIndex indicates an
2258
2259
2260
2261         encapsulation of IP, this object is encoded as a length
2262         octet of 4, followed by the 4 octets of the IP address,
2263         in network byte order."
2264     ::= { nlMatrixSDEntry 3 }
2265
2266 nlMatrixSDPkts OBJECT-TYPE
2267     SYNTAX      ZeroBasedCounter32
2268     MAX-ACCESS  read-only
2269     STATUS      current
2270     DESCRIPTION
2271         "The number of packets without errors transmitted from the
2272         source address to the destination address since this entry was
2273         added to the nlMatrixSDTable.  Note that this is the number of
2274         link-layer packets, so if a single network-layer packet is
2275         fragmented into several link-layer frames, this counter is
2276         incremented several times."
2277     ::= { nlMatrixSDEntry 4 }
2278
2279 nlMatrixSDOctets OBJECT-TYPE
2280     SYNTAX      ZeroBasedCounter32
2281     MAX-ACCESS  read-only
2282     STATUS      current
2283     DESCRIPTION
2284         "The number of octets transmitted from the source address to
2285         the destination address since this entry was added to the
2286         nlMatrixSDTable (excluding framing bits, but
2287         including FCS octets), excluding octets in packets that
2288         contained errors.
2289
2290         Note that this doesn't count just those octets in the particular
2291         protocol frames but includes the entire packet that contained
2292         the protocol."
2293     ::= { nlMatrixSDEntry 5 }
2294
2295 nlMatrixSDCreateTime OBJECT-TYPE
2296     SYNTAX     LastCreateTime
2297     MAX-ACCESS read-only
2298     STATUS     current
2299     DESCRIPTION
2300         "The value of sysUpTime when this entry was last activated.
2301         This can be used by the management station to ensure that the
2302         entry has not been deleted and recreated between polls."
2303     ::= { nlMatrixSDEntry 6 }
2304
2305
2306 -- Traffic matrix tables from destination to source
2307
2308 nlMatrixDSTable OBJECT-TYPE
2309
2310
2311
2312     SYNTAX      SEQUENCE OF NlMatrixDSEntry
2313     MAX-ACCESS  not-accessible
2314     STATUS      current
2315     DESCRIPTION
2316         "A list of traffic matrix entries that collect statistics for
2317         conversations between two network-level addresses.  This table
2318         is indexed first by the destination address and then by the
2319         source address to make it convenient to collect all
2320         conversations to a particular address.
2321
2322         The probe will populate this table for all network layer
2323         protocols in the protocol directory table whose value of
2324         protocolDirMatrixConfig is equal to supportedOn(3), and
2325         will delete any entries whose protocolDirEntry is deleted or
2326         has a protocolDirMatrixConfig value of supportedOff(2).
2327
2328         The probe will add to this table all pairs of addresses
2329         seen in all packets with no MAC errors and will increment
2330         octet and packet counts in the table for all packets with no
2331         MAC errors.
2332
2333         Further, this table will only contain entries that have a
2334         corresponding entry in the nlMatrixSDTable with the same
2335         source address and destination address."
2336     ::= { nlMatrix 3 }
2337
2338 nlMatrixDSEntry OBJECT-TYPE
2339     SYNTAX      NlMatrixDSEntry
2340     MAX-ACCESS  not-accessible
2341     STATUS      current
2342     DESCRIPTION
2343         "A conceptual row in the nlMatrixDSTable.
2344
2345         The hlMatrixControlIndex value in the index identifies the
2346         hlMatrixControlEntry on whose behalf this entry was created.
2347         The protocolDirLocalIndex value in the index identifies the
2348         network-layer protocol of the nlMatrixDSSourceAddress and
2349         nlMatrixDSDestAddress.
2350
2351         An example of the indexing of this table is
2352         nlMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6.
2353
2354         Note that some combinations of index values may result in an
2355         index that exceeds 128 sub-identifiers in length, which exceeds
2356         the maximum for the SNMP protocol.  Implementations should take
2357         care to avoid such combinations."
2358     INDEX { hlMatrixControlIndex, nlMatrixDSTimeMark,
2359             protocolDirLocalIndex,
2360
2361
2362
2363             nlMatrixDSDestAddress, nlMatrixDSSourceAddress }
2364     ::= { nlMatrixDSTable 1 }
2365
2366 NlMatrixDSEntry ::= SEQUENCE {
2367     nlMatrixDSTimeMark                 TimeFilter,
2368     nlMatrixDSSourceAddress            OCTET STRING,
2369     nlMatrixDSDestAddress              OCTET STRING,
2370     nlMatrixDSPkts                     ZeroBasedCounter32,
2371     nlMatrixDSOctets                   ZeroBasedCounter32,
2372     nlMatrixDSCreateTime               LastCreateTime
2373 }
2374
2375 nlMatrixDSTimeMark OBJECT-TYPE
2376     SYNTAX      TimeFilter
2377     MAX-ACCESS  not-accessible
2378     STATUS      current
2379     DESCRIPTION
2380         "A TimeFilter for this entry.  See the TimeFilter textual
2381         convention to see how this works."
2382     ::= { nlMatrixDSEntry 1 }
2383
2384 nlMatrixDSSourceAddress OBJECT-TYPE
2385     SYNTAX      OCTET STRING  (SIZE (1..255))
2386     MAX-ACCESS  not-accessible
2387     STATUS      current
2388     DESCRIPTION
2389         "The network source address for this nlMatrixDSEntry.
2390
2391         This is represented as an octet string with
2392         specific semantics and length as identified
2393         by the protocolDirLocalIndex component of the index.
2394
2395         For example, if the protocolDirLocalIndex indicates an
2396         encapsulation of IP, this object is encoded as a length
2397         octet of 4, followed by the 4 octets of the IP address,
2398         in network byte order."
2399     ::= { nlMatrixDSEntry 2 }
2400
2401 nlMatrixDSDestAddress OBJECT-TYPE
2402     SYNTAX      OCTET STRING  (SIZE (1..255))
2403     MAX-ACCESS  not-accessible
2404     STATUS      current
2405     DESCRIPTION
2406         "The network destination address for this
2407         nlMatrixDSEntry.
2408
2409         This is represented as an octet string with
2410         specific semantics and length as identified
2411
2412
2413
2414         by the protocolDirLocalIndex component of the index.
2415
2416         For example, if the protocolDirLocalIndex indicates an
2417         encapsulation of IP, this object is encoded as a length
2418         octet of 4, followed by the 4 octets of the IP address,
2419         in network byte order."
2420     ::= { nlMatrixDSEntry 3 }
2421
2422 nlMatrixDSPkts OBJECT-TYPE
2423     SYNTAX      ZeroBasedCounter32
2424     MAX-ACCESS  read-only
2425     STATUS      current
2426     DESCRIPTION
2427         "The number of packets without errors transmitted from the
2428         source address to the destination address since this entry was
2429         added to the nlMatrixDSTable.  Note that this is the number of
2430         link-layer packets, so if a single network-layer packet is
2431         fragmented into several link-layer frames, this counter is
2432         incremented several times."
2433     ::= { nlMatrixDSEntry 4 }
2434
2435 nlMatrixDSOctets OBJECT-TYPE
2436     SYNTAX      ZeroBasedCounter32
2437     MAX-ACCESS  read-only
2438     STATUS      current
2439     DESCRIPTION
2440         "The number of octets transmitted from the source address
2441         to the destination address since this entry was added to the
2442         nlMatrixDSTable (excluding framing bits, but
2443         including FCS octets), excluding octets in packets that
2444         contained errors.
2445
2446         Note that this doesn't count just those octets in the particular
2447         protocol frames but includes the entire packet that contained
2448         the protocol."
2449     ::= { nlMatrixDSEntry 5 }
2450
2451 nlMatrixDSCreateTime OBJECT-TYPE
2452     SYNTAX     LastCreateTime
2453     MAX-ACCESS read-only
2454     STATUS     current
2455     DESCRIPTION
2456         "The value of sysUpTime when this entry was last activated.
2457         This can be used by the management station to ensure that the
2458         entry has not been deleted and recreated between polls."
2459     ::= { nlMatrixDSEntry 6 }
2460
2461 nlMatrixTopNControlTable OBJECT-TYPE
2462
2463
2464
2465     SYNTAX      SEQUENCE OF NlMatrixTopNControlEntry
2466     MAX-ACCESS  not-accessible
2467     STATUS      current
2468     DESCRIPTION
2469         "A set of parameters that control the creation of a
2470         report of the top N matrix entries according to
2471         a selected metric."
2472     ::= { nlMatrix 4 }
2473
2474 nlMatrixTopNControlEntry OBJECT-TYPE
2475     SYNTAX      NlMatrixTopNControlEntry
2476     MAX-ACCESS  not-accessible
2477     STATUS      current
2478     DESCRIPTION
2479         "A conceptual row in the nlMatrixTopNControlTable.
2480
2481         An example of the indexing of this table is
2482         nlMatrixTopNControlDuration.3"
2483     INDEX { nlMatrixTopNControlIndex }
2484     ::= { nlMatrixTopNControlTable 1 }
2485
2486 NlMatrixTopNControlEntry ::= SEQUENCE {
2487     nlMatrixTopNControlIndex            Integer32,
2488     nlMatrixTopNControlMatrixIndex      Integer32,
2489     nlMatrixTopNControlRateBase         INTEGER,
2490     nlMatrixTopNControlTimeRemaining    Integer32,
2491     nlMatrixTopNControlGeneratedReports Counter32,
2492     nlMatrixTopNControlDuration         Integer32,
2493     nlMatrixTopNControlRequestedSize    Integer32,
2494     nlMatrixTopNControlGrantedSize      Integer32,
2495     nlMatrixTopNControlStartTime        TimeStamp,
2496     nlMatrixTopNControlOwner            OwnerString,
2497     nlMatrixTopNControlStatus           RowStatus
2498 }
2499
2500 nlMatrixTopNControlIndex OBJECT-TYPE
2501     SYNTAX     Integer32 (1..65535)
2502     MAX-ACCESS not-accessible
2503     STATUS     current
2504     DESCRIPTION
2505         "An index that uniquely identifies an entry
2506         in the nlMatrixTopNControlTable.  Each such
2507         entry defines one topN report prepared for
2508         one interface."
2509     ::= { nlMatrixTopNControlEntry 1 }
2510
2511 nlMatrixTopNControlMatrixIndex OBJECT-TYPE
2512     SYNTAX     Integer32 (1..65535)
2513
2514
2515
2516     MAX-ACCESS read-create
2517     STATUS     current
2518     DESCRIPTION
2519         "The nlMatrix[SD/DS] table for which a topN report will be
2520         prepared on behalf of this entry.  The nlMatrix[SD/DS] table
2521         is identified by the value of the hlMatrixControlIndex
2522         for that table - that value is used here to identify the
2523         particular table.
2524
2525         This object may not be modified if the associated
2526         nlMatrixTopNControlStatus object is equal to active(1)."
2527     ::= { nlMatrixTopNControlEntry 2 }
2528
2529 nlMatrixTopNControlRateBase OBJECT-TYPE
2530     SYNTAX      INTEGER {
2531                     nlMatrixTopNPkts(1),
2532                     nlMatrixTopNOctets(2),
2533                     nlMatrixTopNHighCapacityPkts(3),
2534                     nlMatrixTopNHighCapacityOctets(4)
2535                 }
2536     MAX-ACCESS read-create
2537     STATUS     current
2538     DESCRIPTION
2539         "The variable for each nlMatrix[SD/DS] entry that the
2540         nlMatrixTopNEntries are sorted by, as well as a control
2541         for the table that the results will be reported in.
2542
2543         This object may not be modified if the associated
2544         nlMatrixTopNControlStatus object is equal to active(1).
2545
2546         If this value is less than or equal to 2, when the report
2547         is prepared, entries are created in the nlMatrixTopNTable
2548         associated with this object.
2549         If this value is greater than or equal to 3, when the report
2550         is prepared, entries are created in the
2551         nlMatrixTopNHighCapacityTable associated with this object."
2552     ::= { nlMatrixTopNControlEntry 3 }
2553
2554 nlMatrixTopNControlTimeRemaining OBJECT-TYPE
2555     SYNTAX     Integer32 (0..2147483647)
2556     MAX-ACCESS read-create
2557     STATUS     current
2558     DESCRIPTION
2559         "The number of seconds left in the report currently
2560         being collected.  When this object is modified by
2561         the management station, a new collection is started,
2562         possibly aborting a currently running report.  The
2563         new value is used as the requested duration of this
2564
2565
2566
2567         report and is immediately loaded into the associated
2568         nlMatrixTopNControlDuration object.
2569
2570         When the report finishes, the probe will automatically
2571         start another collection with the same initial value
2572         of nlMatrixTopNControlTimeRemaining.  Thus, the management
2573         station may simply read the resulting reports repeatedly,
2574         checking the startTime and duration each time to ensure that a
2575         report was not missed or that the report parameters were not
2576         changed.
2577
2578         While the value of this object is non-zero, it decrements
2579         by one per second until it reaches zero.  At the time
2580         that this object decrements to zero, the report is made
2581         accessible in the nlMatrixTopNTable, overwriting any report
2582         that may be there.
2583
2584         When this object is modified by the management station, any
2585         associated entries in the nlMatrixTopNTable shall be deleted.
2586
2587         (Note that this is a different algorithm than the one used
2588         in the hostTopNTable)."
2589     DEFVAL { 1800 }
2590     ::= { nlMatrixTopNControlEntry 4 }
2591
2592 nlMatrixTopNControlGeneratedReports OBJECT-TYPE
2593     SYNTAX     Counter32
2594     MAX-ACCESS read-only
2595     STATUS     current
2596     DESCRIPTION
2597         "The number of reports that have been generated by this entry."
2598     ::= { nlMatrixTopNControlEntry 5 }
2599
2600 nlMatrixTopNControlDuration OBJECT-TYPE
2601     SYNTAX     Integer32
2602     MAX-ACCESS read-only
2603     STATUS     current
2604     DESCRIPTION
2605         "The number of seconds that this report has collected
2606         during the last sampling interval.
2607
2608         When the associated nlMatrixTopNControlTimeRemaining object is
2609         set, this object shall be set by the probe to the
2610         same value and shall not be modified until the next
2611         time the nlMatrixTopNControlTimeRemaining is set.
2612
2613         This value shall be zero if no reports have been
2614         requested for this nlMatrixTopNControlEntry."
2615
2616
2617
2618     ::= { nlMatrixTopNControlEntry 6 }
2619
2620 nlMatrixTopNControlRequestedSize OBJECT-TYPE
2621     SYNTAX     Integer32 (0..2147483647)
2622     MAX-ACCESS read-create
2623     STATUS     current
2624     DESCRIPTION
2625         "The maximum number of matrix entries requested for this report.
2626
2627         When this object is created or modified, the probe
2628         should set nlMatrixTopNControlGrantedSize as closely to this
2629         object as possible for the particular probe
2630         implementation and available resources."
2631     DEFVAL { 150 }
2632     ::= { nlMatrixTopNControlEntry 7 }
2633
2634 nlMatrixTopNControlGrantedSize OBJECT-TYPE
2635     SYNTAX     Integer32 (0..2147483647)
2636     MAX-ACCESS read-only
2637     STATUS     current
2638     DESCRIPTION
2639         "The maximum number of matrix entries in this report.
2640
2641         When the associated nlMatrixTopNControlRequestedSize object is
2642         created or modified, the probe should set this
2643         object as closely to the requested value as
2644         possible for the particular implementation and
2645         available resources.  The probe must not lower this
2646         value except as a side-effect of a set to the associated
2647         nlMatrixTopNControlRequestedSize object.
2648
2649         If the value of nlMatrixTopNControlRateBase is equal to
2650         nlMatrixTopNPkts, when the next topN report is generated,
2651         matrix entries with the highest value of nlMatrixTopNPktRate
2652         shall be placed in this table in decreasing order of this rate
2653         until there is no more room or until there are no more
2654         matrix entries.
2655
2656         If the value of nlMatrixTopNControlRateBase is equal to
2657         nlMatrixTopNOctets, when the next topN report is generated,
2658         matrix entries with the highest value of nlMatrixTopNOctetRate
2659         shall be placed in this table in decreasing order of this rate
2660         until there is no more room or until there are no more
2661         matrix entries.
2662
2663         It is an implementation-specific matter how entries with the
2664         same value of nlMatrixTopNPktRate or nlMatrixTopNOctetRate are
2665         sorted.  It is also an implementation-specific matter as to
2666
2667
2668
2669         whether zero-valued entries are available."
2670     ::= { nlMatrixTopNControlEntry 8 }
2671
2672 nlMatrixTopNControlStartTime OBJECT-TYPE
2673     SYNTAX     TimeStamp
2674     MAX-ACCESS read-only
2675     STATUS     current
2676     DESCRIPTION
2677         "The value of sysUpTime when this topN report was
2678         last started.  In other words, this is the time that
2679         the associated nlMatrixTopNControlTimeRemaining object was
2680         modified to start the requested report or the time
2681         the report was last automatically (re)started.
2682
2683         This object may be used by the management station to
2684         determine whether a report was missed."
2685     ::= { nlMatrixTopNControlEntry 9 }
2686
2687 nlMatrixTopNControlOwner OBJECT-TYPE
2688     SYNTAX     OwnerString
2689     MAX-ACCESS read-create
2690     STATUS     current
2691     DESCRIPTION
2692         "The entity that configured this entry and is
2693         therefore using the resources assigned to it."
2694     ::= { nlMatrixTopNControlEntry 10 }
2695
2696 nlMatrixTopNControlStatus OBJECT-TYPE
2697     SYNTAX     RowStatus
2698     MAX-ACCESS read-create
2699     STATUS     current
2700     DESCRIPTION
2701         "The status of this nlMatrixTopNControlEntry.
2702
2703         An entry may not exist in the active state unless all
2704         objects in the entry have an appropriate value.
2705
2706         If this object is not equal to active(1), all
2707         associated entries in the nlMatrixTopNTable shall be deleted
2708         by the agent."
2709     ::= { nlMatrixTopNControlEntry 11 }
2710
2711 nlMatrixTopNTable OBJECT-TYPE
2712     SYNTAX     SEQUENCE OF NlMatrixTopNEntry
2713     MAX-ACCESS not-accessible
2714     STATUS     current
2715     DESCRIPTION
2716         "A set of statistics for those network-layer matrix entries
2717
2718
2719
2720         that have counted the highest number of octets or packets."
2721     ::= { nlMatrix 5 }
2722
2723 nlMatrixTopNEntry OBJECT-TYPE
2724     SYNTAX     NlMatrixTopNEntry
2725     MAX-ACCESS not-accessible
2726     STATUS     current
2727     DESCRIPTION
2728         "A conceptual row in the nlMatrixTopNTable.
2729
2730         The nlMatrixTopNControlIndex value in the index identifies the
2731         nlMatrixTopNControlEntry on whose behalf this entry was
2732         created.
2733
2734         An example of the indexing of this table is
2735         nlMatrixTopNPktRate.3.10"
2736     INDEX { nlMatrixTopNControlIndex, nlMatrixTopNIndex }
2737     ::= { nlMatrixTopNTable 1 }
2738
2739 NlMatrixTopNEntry ::= SEQUENCE {
2740     nlMatrixTopNIndex                 Integer32,
2741     nlMatrixTopNProtocolDirLocalIndex Integer32,
2742     nlMatrixTopNSourceAddress         OCTET STRING,
2743     nlMatrixTopNDestAddress           OCTET STRING,
2744     nlMatrixTopNPktRate               Gauge32,
2745     nlMatrixTopNReversePktRate        Gauge32,
2746     nlMatrixTopNOctetRate             Gauge32,
2747     nlMatrixTopNReverseOctetRate      Gauge32
2748 }
2749
2750 nlMatrixTopNIndex OBJECT-TYPE
2751     SYNTAX     Integer32 (1..65535)
2752     MAX-ACCESS not-accessible
2753     STATUS     current
2754     DESCRIPTION
2755         "An index that uniquely identifies an entry in
2756         the nlMatrixTopNTable among those in the same report.
2757         This index is between 1 and N, where N is the
2758         number of entries in this report.
2759
2760         If the value of nlMatrixTopNControlRateBase is equal to
2761         nlMatrixTopNPkts, increasing values of nlMatrixTopNIndex shall
2762         be assigned to entries with decreasing values of
2763         nlMatrixTopNPktRate until index N is assigned or there are no
2764         more nlMatrixTopNEntries.
2765
2766         If the value of nlMatrixTopNControlRateBase is equal to
2767         nlMatrixTopNOctets, increasing values of nlMatrixTopNIndex
2768
2769
2770
2771         shall be assigned to entries with decreasing values of
2772         nlMatrixTopNOctetRate until index N is assigned or there are
2773         no more nlMatrixTopNEntries."
2774     ::= { nlMatrixTopNEntry 1 }
2775
2776 nlMatrixTopNProtocolDirLocalIndex OBJECT-TYPE
2777     SYNTAX     Integer32 (1..2147483647)
2778     MAX-ACCESS read-only
2779     STATUS     current
2780     DESCRIPTION
2781         "The protocolDirLocalIndex of the network-layer protocol of
2782         this entry's network address."
2783     ::= { nlMatrixTopNEntry 2 }
2784
2785 nlMatrixTopNSourceAddress OBJECT-TYPE
2786     SYNTAX     OCTET STRING  (SIZE (1..255))
2787     MAX-ACCESS read-only
2788     STATUS     current
2789     DESCRIPTION
2790         "The network-layer address of the source host in this
2791         conversation.
2792
2793         This is represented as an octet string with
2794         specific semantics and length as identified
2795         by the associated nlMatrixTopNProtocolDirLocalIndex.
2796
2797         For example, if the protocolDirLocalIndex indicates an
2798         encapsulation of IP, this object is encoded as a length
2799         octet of 4, followed by the 4 octets of the IP address,
2800         in network byte order."
2801     ::= { nlMatrixTopNEntry 3 }
2802
2803 nlMatrixTopNDestAddress OBJECT-TYPE
2804     SYNTAX     OCTET STRING  (SIZE (1..255))
2805     MAX-ACCESS read-only
2806     STATUS     current
2807     DESCRIPTION
2808         "The network-layer address of the destination host in this
2809         conversation.
2810
2811         This is represented as an octet string with
2812         specific semantics and length as identified
2813         by the associated nlMatrixTopNProtocolDirLocalIndex.
2814
2815         For example, if the nlMatrixTopNProtocolDirLocalIndex
2816         indicates an encapsulation of IP, this object is encoded as a
2817         length octet of 4, followed by the 4 octets of the IP address,
2818         in network byte order."
2819
2820
2821
2822     ::= { nlMatrixTopNEntry 4 }
2823
2824 nlMatrixTopNPktRate OBJECT-TYPE
2825     SYNTAX     Gauge32
2826     MAX-ACCESS read-only
2827     STATUS     current
2828     DESCRIPTION
2829         "The number of packets seen from the source host
2830         to the destination host during this sampling interval, counted
2831         using the rules for counting the nlMatrixSDPkts object.
2832         If the value of nlMatrixTopNControlRateBase is
2833         nlMatrixTopNPkts, this variable will be used to sort this
2834         report."
2835     ::= { nlMatrixTopNEntry 5 }
2836
2837 nlMatrixTopNReversePktRate OBJECT-TYPE
2838     SYNTAX     Gauge32
2839     MAX-ACCESS read-only
2840     STATUS     current
2841     DESCRIPTION
2842         "The number of packets seen from the destination host to the
2843         source host during this sampling interval, counted
2844         using the rules for counting the nlMatrixSDPkts object.  (Note
2845         that the corresponding nlMatrixSDPkts object selected is the
2846         one whose source address is equal to nlMatrixTopNDestAddress
2847         and whose destination address is equal to
2848         nlMatrixTopNSourceAddress.)
2849
2850         Note that if the value of nlMatrixTopNControlRateBase is equal
2851         to nlMatrixTopNPkts, the sort of topN entries is based
2852         entirely on nlMatrixTopNPktRate, and not on the value of this
2853         object."
2854     ::= { nlMatrixTopNEntry 6 }
2855
2856 nlMatrixTopNOctetRate OBJECT-TYPE
2857     SYNTAX     Gauge32
2858     MAX-ACCESS read-only
2859     STATUS     current
2860     DESCRIPTION
2861         "The number of octets seen from the source host
2862         to the destination host during this sampling interval, counted
2863         using the rules for counting the nlMatrixSDOctets object.  If
2864         the value of nlMatrixTopNControlRateBase is
2865         nlMatrixTopNOctets, this variable will be used to sort this
2866         report."
2867     ::= { nlMatrixTopNEntry 7 }
2868
2869 nlMatrixTopNReverseOctetRate OBJECT-TYPE
2870
2871
2872
2873     SYNTAX     Gauge32
2874     MAX-ACCESS read-only
2875     STATUS     current
2876     DESCRIPTION
2877         "The number of octets seen from the destination host to the
2878         source host during this sampling interval, counted
2879         using the rules for counting the nlMatrixDSOctets object.  (Note
2880         that the corresponding nlMatrixSDOctets object selected is the
2881         one whose source address is equal to nlMatrixTopNDestAddress
2882         and whose destination address is equal to
2883         nlMatrixTopNSourceAddress.)
2884
2885         Note that if the value of nlMatrixTopNControlRateBase is equal
2886         to nlMatrixTopNOctets, the sort of topN entries is based
2887         entirely on nlMatrixTopNOctetRate, and not on the value of
2888         this object."
2889     ::= { nlMatrixTopNEntry 8 }
2890
2891 -- Application Layer Functions
2892 --
2893 -- The application layer host, matrix, and matrixTopN functions report
2894 -- on protocol usage at the network layer or higher.  Note that the
2895 -- use of the term application layer does not imply that only
2896 -- application-layer protocols are counted, rather it means that
2897 -- protocols up to and including the application layer are supported.
2898
2899 --
2900 -- Application Layer Host Group
2901 --
2902 -- Counts the amount of traffic, by protocol, sent from and to each
2903 -- network address discovered by the probe.
2904 -- Implementation of this group requires implementation of the Network
2905 -- Layer Host Group.
2906
2907 alHostTable OBJECT-TYPE
2908     SYNTAX      SEQUENCE OF AlHostEntry
2909     MAX-ACCESS  not-accessible
2910     STATUS      current
2911     DESCRIPTION
2912         "A collection of statistics for a particular protocol from a
2913         particular network address that has been discovered on an
2914         interface of this device.
2915
2916         The probe will populate this table for all protocols in the
2917         protocol directory table whose value of
2918         protocolDirHostConfig is equal to supportedOn(3), and
2919         will delete any entries whose protocolDirEntry is deleted or
2920         has a protocolDirHostConfig value of supportedOff(2).
2921
2922
2923
2924         The probe will add to this table all addresses
2925         seen as the source or destination address in all packets with
2926         no MAC errors and will increment octet and packet counts in
2927         the table for all packets with no MAC errors.  Further,
2928         entries will only be added to this table if their address
2929         exists in the nlHostTable and will be deleted from this table
2930         if their address is deleted from the nlHostTable."
2931     ::= { alHost 1 }
2932
2933 alHostEntry OBJECT-TYPE
2934     SYNTAX      AlHostEntry
2935     MAX-ACCESS  not-accessible
2936     STATUS      current
2937     DESCRIPTION
2938         "A conceptual row in the alHostTable.
2939
2940         The hlHostControlIndex value in the index identifies the
2941         hlHostControlEntry on whose behalf this entry was created.
2942         The first protocolDirLocalIndex value in the index identifies
2943         the network-layer protocol of the address.
2944         The nlHostAddress value in the index identifies the network-
2945         layer address of this entry.
2946         The second protocolDirLocalIndex value in the index identifies
2947         the protocol that is counted by this entry.
2948
2949         An example of the indexing in this entry is
2950         alHostOutPkts.1.783495.18.4.128.2.6.6.34.
2951
2952         Note that some combinations of index values may result in an
2953         index that exceeds 128 sub-identifiers in length, which exceeds
2954         the maximum for the SNMP protocol.  Implementations should take
2955         care to avoid such combinations."
2956     INDEX { hlHostControlIndex, alHostTimeMark,
2957             protocolDirLocalIndex, nlHostAddress,
2958             protocolDirLocalIndex }
2959     ::= { alHostTable 1 }
2960
2961 AlHostEntry ::= SEQUENCE {
2962     alHostTimeMark                 TimeFilter,
2963     alHostInPkts                   ZeroBasedCounter32,
2964     alHostOutPkts                  ZeroBasedCounter32,
2965     alHostInOctets                 ZeroBasedCounter32,
2966     alHostOutOctets                ZeroBasedCounter32,
2967     alHostCreateTime               LastCreateTime
2968 }
2969
2970 alHostTimeMark OBJECT-TYPE
2971     SYNTAX      TimeFilter
2972
2973
2974
2975     MAX-ACCESS  not-accessible
2976     STATUS      current
2977     DESCRIPTION
2978         "A TimeFilter for this entry.  See the TimeFilter textual
2979         convention to see how this works."
2980     ::= { alHostEntry 1 }
2981
2982 alHostInPkts OBJECT-TYPE
2983     SYNTAX      ZeroBasedCounter32
2984     MAX-ACCESS  read-only
2985     STATUS      current
2986     DESCRIPTION
2987         "The number of packets of this protocol type without errors
2988         transmitted to this address since it was added to the
2989         alHostTable.  Note that this is the number of link-layer
2990         packets, so if a single network-layer packet is fragmented
2991         into several link-layer frames, this counter is incremented
2992         several times."
2993     ::= { alHostEntry 2 }
2994
2995 alHostOutPkts OBJECT-TYPE
2996     SYNTAX      ZeroBasedCounter32
2997     MAX-ACCESS  read-only
2998     STATUS      current
2999     DESCRIPTION
3000         "The number of packets of this protocol type without errors
3001         transmitted by this address since it was added to the
3002         alHostTable.  Note that this is the number of link-layer
3003         packets, so if a single network-layer packet is fragmented
3004         into several link-layer frames, this counter is incremented
3005         several times."
3006      ::= { alHostEntry 3 }
3007
3008 alHostInOctets OBJECT-TYPE
3009     SYNTAX      ZeroBasedCounter32
3010     MAX-ACCESS  read-only
3011     STATUS      current
3012     DESCRIPTION
3013         "The number of octets transmitted to this address
3014         of this protocol type since it was added to the
3015         alHostTable (excluding framing bits, but including
3016         FCS octets), excluding octets in packets that
3017         contained errors.
3018
3019         Note that this doesn't count just those octets in the particular
3020         protocol frames but includes the entire packet that contained
3021         the protocol."
3022     ::= { alHostEntry 4 }
3023
3024
3025
3026 alHostOutOctets OBJECT-TYPE
3027     SYNTAX      ZeroBasedCounter32
3028     MAX-ACCESS  read-only
3029     STATUS      current
3030     DESCRIPTION
3031         "The number of octets transmitted by this address
3032         of this protocol type since it was added to the
3033         alHostTable (excluding framing bits, but including
3034         FCS octets), excluding octets in packets that
3035         contained errors.
3036
3037         Note that this doesn't count just those octets in the particular
3038         protocol frames but includes the entire packet that contained
3039         the protocol."
3040     ::= { alHostEntry 5 }
3041
3042 alHostCreateTime OBJECT-TYPE
3043     SYNTAX     LastCreateTime
3044     MAX-ACCESS read-only
3045     STATUS     current
3046     DESCRIPTION
3047         "The value of sysUpTime when this entry was last activated.
3048         This can be used by the management station to ensure that the
3049         entry has not been deleted and recreated between polls."
3050     ::= { alHostEntry 6 }
3051
3052 --
3053 -- Application Layer Matrix Group
3054 --
3055 -- Counts the amount of traffic, by protocol, sent between each pair
3056 -- of network addresses discovered by the probe.
3057 -- Implementation of this group requires implementation of the Network
3058 -- Layer Matrix Group.
3059
3060 alMatrixSDTable OBJECT-TYPE
3061     SYNTAX      SEQUENCE OF AlMatrixSDEntry
3062     MAX-ACCESS  not-accessible
3063     STATUS      current
3064     DESCRIPTION
3065         "A list of application traffic matrix entries that collect
3066         statistics for conversations of a particular protocol between
3067         two network-level addresses.  This table is indexed first by
3068         the source address and then by the destination address to make
3069         it convenient to collect all statistics from a particular
3070         address.
3071
3072         The probe will populate this table for all protocols in the
3073         protocol directory table whose value of
3074
3075
3076
3077         protocolDirMatrixConfig is equal to supportedOn(3), and
3078         will delete any entries whose protocolDirEntry is deleted or
3079         has a protocolDirMatrixConfig value of supportedOff(2).
3080
3081         The probe will add to this table all pairs of addresses for
3082         all protocols seen in all packets with no MAC errors and will
3083         increment octet and packet counts in the table for all packets
3084         with no MAC errors.  Further, entries will only be added to
3085         this table if their address pair exists in the nlMatrixSDTable
3086         and will be deleted from this table if the address pair is
3087         deleted from the nlMatrixSDTable."
3088     ::= { alMatrix 1 }
3089
3090 alMatrixSDEntry OBJECT-TYPE
3091     SYNTAX      AlMatrixSDEntry
3092     MAX-ACCESS  not-accessible
3093     STATUS      current
3094     DESCRIPTION
3095         "A conceptual row in the alMatrixSDTable.
3096
3097         The hlMatrixControlIndex value in the index identifies the
3098         hlMatrixControlEntry on whose behalf this entry was created.
3099         The first protocolDirLocalIndex value in the index identifies
3100         the network-layer protocol of the nlMatrixSDSourceAddress and
3101         nlMatrixSDDestAddress.
3102         The nlMatrixSDSourceAddress value in the index identifies the
3103         network-layer address of the source host in this conversation.
3104         The nlMatrixSDDestAddress value in the index identifies the
3105         network-layer address of the destination host in this
3106         conversation.
3107         The second protocolDirLocalIndex value in the index identifies
3108         the protocol that is counted by this entry.
3109
3110         An example of the indexing of this entry is
3111         alMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7.34.
3112
3113         Note that some combinations of index values may result in an
3114         index that exceeds 128 sub-identifiers in length, which exceeds
3115         the maximum for the SNMP protocol.  Implementations should take
3116         care to avoid such combinations."
3117     INDEX { hlMatrixControlIndex, alMatrixSDTimeMark,
3118             protocolDirLocalIndex,
3119             nlMatrixSDSourceAddress, nlMatrixSDDestAddress,
3120             protocolDirLocalIndex }
3121     ::= { alMatrixSDTable 1 }
3122
3123 AlMatrixSDEntry ::= SEQUENCE {
3124     alMatrixSDTimeMark                 TimeFilter,
3125
3126
3127
3128     alMatrixSDPkts                     ZeroBasedCounter32,
3129     alMatrixSDOctets                   ZeroBasedCounter32,
3130     alMatrixSDCreateTime               LastCreateTime
3131 }
3132
3133 alMatrixSDTimeMark OBJECT-TYPE
3134     SYNTAX      TimeFilter
3135     MAX-ACCESS  not-accessible
3136     STATUS      current
3137     DESCRIPTION
3138         "A TimeFilter for this entry.  See the TimeFilter textual
3139         convention to see how this works."
3140     ::= { alMatrixSDEntry 1 }
3141
3142 alMatrixSDPkts OBJECT-TYPE
3143     SYNTAX      ZeroBasedCounter32
3144     MAX-ACCESS  read-only
3145     STATUS      current
3146     DESCRIPTION
3147         "The number of packets of this protocol type without errors
3148         transmitted from the source address to the destination address
3149         since this entry was added to the alMatrixSDTable.  Note that
3150         this is the number of link-layer packets, so if a single
3151         network-layer packet is fragmented into several link-layer
3152         frames, this counter is incremented several times."
3153     ::= { alMatrixSDEntry 2 }
3154
3155 alMatrixSDOctets OBJECT-TYPE
3156     SYNTAX      ZeroBasedCounter32
3157     MAX-ACCESS  read-only
3158     STATUS      current
3159     DESCRIPTION
3160         "The number of octets in packets of this protocol type
3161         transmitted from the source address to the destination address
3162         since this entry was added to the alMatrixSDTable (excluding
3163         framing bits, but including FCS octets), excluding octets
3164         in packets that contained errors.
3165
3166         Note that this doesn't count just those octets in the particular
3167         protocol frames but includes the entire packet that contained
3168         the protocol."
3169     ::= { alMatrixSDEntry 3 }
3170
3171 alMatrixSDCreateTime OBJECT-TYPE
3172     SYNTAX     LastCreateTime
3173     MAX-ACCESS read-only
3174     STATUS     current
3175     DESCRIPTION
3176
3177
3178
3179         "The value of sysUpTime when this entry was last activated.
3180         This can be used by the management station to ensure that the
3181         entry has not been deleted and recreated between polls."
3182     ::= { alMatrixSDEntry 4 }
3183
3184 -- Traffic matrix tables from destination to source
3185
3186 alMatrixDSTable OBJECT-TYPE
3187     SYNTAX      SEQUENCE OF AlMatrixDSEntry
3188     MAX-ACCESS  not-accessible
3189     STATUS      current
3190     DESCRIPTION
3191         "A list of application traffic matrix entries that collect
3192         statistics for conversations of a particular protocol between
3193         two network-level addresses.  This table is indexed first by
3194         the destination address and then by the source address to make
3195         it convenient to collect all statistics to a particular
3196         address.
3197
3198         The probe will populate this table for all protocols in the
3199         protocol directory table whose value of
3200         protocolDirMatrixConfig is equal to supportedOn(3), and
3201         will delete any entries whose protocolDirEntry is deleted or
3202         has a protocolDirMatrixConfig value of supportedOff(2).
3203
3204         The probe will add to this table all pairs of addresses for
3205         all protocols seen in all packets with no MAC errors and will
3206         increment octet and packet counts in the table for all packets
3207         with no MAC errors.  Further, entries will only be added to
3208         this table if their address pair exists in the nlMatrixDSTable
3209         and will be deleted from this table if the address pair is
3210         deleted from the nlMatrixDSTable."
3211     ::= { alMatrix 2 }
3212
3213 alMatrixDSEntry OBJECT-TYPE
3214     SYNTAX      AlMatrixDSEntry
3215     MAX-ACCESS  not-accessible
3216     STATUS      current
3217     DESCRIPTION
3218         "A conceptual row in the alMatrixDSTable.
3219
3220         The hlMatrixControlIndex value in the index identifies the
3221         hlMatrixControlEntry on whose behalf this entry was created.
3222         The first protocolDirLocalIndex value in the index identifies
3223         the network-layer protocol of the alMatrixDSSourceAddress and
3224         alMatrixDSDestAddress.
3225         The nlMatrixDSDestAddress value in the index identifies the
3226         network-layer address of the destination host in this
3227
3228
3229
3230         conversation.
3231         The nlMatrixDSSourceAddress value in the index identifies the
3232         network-layer address of the source host in this conversation.
3233         The second protocolDirLocalIndex value in the index identifies
3234         the protocol that is counted by this entry.
3235
3236         An example of the indexing of this entry is
3237         alMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6.34.
3238
3239         Note that some combinations of index values may result in an
3240         index that exceeds 128 sub-identifiers in length, which exceeds
3241         the maximum for the SNMP protocol.  Implementations should take
3242         care to avoid such combinations."
3243     INDEX { hlMatrixControlIndex, alMatrixDSTimeMark,
3244             protocolDirLocalIndex,
3245             nlMatrixDSDestAddress, nlMatrixDSSourceAddress,
3246             protocolDirLocalIndex }
3247     ::= { alMatrixDSTable 1 }
3248
3249 AlMatrixDSEntry ::= SEQUENCE {
3250     alMatrixDSTimeMark                 TimeFilter,
3251     alMatrixDSPkts                     ZeroBasedCounter32,
3252     alMatrixDSOctets                   ZeroBasedCounter32,
3253     alMatrixDSCreateTime               LastCreateTime
3254 }
3255
3256 alMatrixDSTimeMark OBJECT-TYPE
3257     SYNTAX      TimeFilter
3258     MAX-ACCESS  not-accessible
3259     STATUS      current
3260     DESCRIPTION
3261         "A TimeFilter for this entry.  See the TimeFilter textual
3262         convention to see how this works."
3263     ::= { alMatrixDSEntry 1 }
3264
3265 alMatrixDSPkts OBJECT-TYPE
3266     SYNTAX      ZeroBasedCounter32
3267     MAX-ACCESS  read-only
3268     STATUS      current
3269     DESCRIPTION
3270         "The number of packets of this protocol type without errors
3271         transmitted from the source address to the destination address
3272         since this entry was added to the alMatrixDSTable.  Note that
3273         this is the number of link-layer packets, so if a single
3274         network-layer packet is fragmented into several link-layer
3275         frames, this counter is incremented several times."
3276     ::= { alMatrixDSEntry 2 }
3277
3278
3279
3280
3281 alMatrixDSOctets OBJECT-TYPE
3282     SYNTAX      ZeroBasedCounter32
3283     MAX-ACCESS  read-only
3284     STATUS      current
3285     DESCRIPTION
3286         "The number of octets in packets of this protocol type
3287         transmitted from the source address to the destination address
3288         since this entry was added to the alMatrixDSTable (excluding
3289         framing bits, but including FCS octets), excluding octets
3290         in packets that contained errors.
3291
3292         Note that this doesn't count just those octets in the particular
3293         protocol frames but includes the entire packet that contained
3294         the protocol."
3295     ::= { alMatrixDSEntry 3 }
3296
3297 alMatrixDSCreateTime OBJECT-TYPE
3298     SYNTAX     LastCreateTime
3299     MAX-ACCESS read-only
3300     STATUS     current
3301     DESCRIPTION
3302         "The value of sysUpTime when this entry was last activated.
3303         This can be used by the management station to ensure that the
3304         entry has not been deleted and recreated between polls."
3305     ::= { alMatrixDSEntry 4 }
3306
3307 alMatrixTopNControlTable OBJECT-TYPE
3308     SYNTAX      SEQUENCE OF AlMatrixTopNControlEntry
3309     MAX-ACCESS  not-accessible
3310     STATUS      current
3311     DESCRIPTION
3312         "A set of parameters that control the creation of a
3313         report of the top N matrix entries according to
3314         a selected metric."
3315     ::= { alMatrix 3 }
3316
3317 alMatrixTopNControlEntry OBJECT-TYPE
3318     SYNTAX      AlMatrixTopNControlEntry
3319     MAX-ACCESS  not-accessible
3320     STATUS      current
3321     DESCRIPTION
3322         "A conceptual row in the alMatrixTopNControlTable.
3323
3324         An example of the indexing of this table is
3325         alMatrixTopNControlDuration.3"
3326     INDEX { alMatrixTopNControlIndex }
3327     ::= { alMatrixTopNControlTable 1 }
3328
3329
3330
3331
3332 AlMatrixTopNControlEntry ::= SEQUENCE {
3333     alMatrixTopNControlIndex            Integer32,
3334     alMatrixTopNControlMatrixIndex      Integer32,
3335     alMatrixTopNControlRateBase         INTEGER,
3336     alMatrixTopNControlTimeRemaining    Integer32,
3337     alMatrixTopNControlGeneratedReports Counter32,
3338     alMatrixTopNControlDuration         Integer32,
3339     alMatrixTopNControlRequestedSize    Integer32,
3340     alMatrixTopNControlGrantedSize      Integer32,
3341     alMatrixTopNControlStartTime        TimeStamp,
3342     alMatrixTopNControlOwner            OwnerString,
3343     alMatrixTopNControlStatus           RowStatus
3344 }
3345
3346 alMatrixTopNControlIndex OBJECT-TYPE
3347     SYNTAX     Integer32 (1..65535)
3348     MAX-ACCESS not-accessible
3349     STATUS     current
3350     DESCRIPTION
3351         "An index that uniquely identifies an entry
3352         in the alMatrixTopNControlTable.  Each such
3353         entry defines one topN report prepared for
3354         one interface."
3355     ::= { alMatrixTopNControlEntry 1 }
3356
3357 alMatrixTopNControlMatrixIndex OBJECT-TYPE
3358     SYNTAX     Integer32 (1..65535)
3359     MAX-ACCESS read-create
3360     STATUS     current
3361     DESCRIPTION
3362         "The alMatrix[SD/DS] table for which a topN report will be
3363         prepared on behalf of this entry.  The alMatrix[SD/DS] table
3364         is identified by the value of the hlMatrixControlIndex
3365         for that table - that value is used here to identify the
3366         particular table.
3367
3368         This object may not be modified if the associated
3369         alMatrixTopNControlStatus object is equal to active(1)."
3370     ::= { alMatrixTopNControlEntry 2 }
3371
3372 alMatrixTopNControlRateBase OBJECT-TYPE
3373     SYNTAX     INTEGER {
3374                   alMatrixTopNTerminalsPkts(1),
3375                   alMatrixTopNTerminalsOctets(2),
3376                   alMatrixTopNAllPkts(3),
3377                   alMatrixTopNAllOctets(4),
3378                   alMatrixTopNTerminalsHighCapacityPkts(5),
3379                   alMatrixTopNTerminalsHighCapacityOctets(6),
3380
3381
3382
3383                   alMatrixTopNAllHighCapacityPkts(7),
3384                   alMatrixTopNAllHighCapacityOctets(8)
3385                }
3386     MAX-ACCESS read-create
3387     STATUS     current
3388     DESCRIPTION
3389         "This object controls which alMatrix[SD/DS] entry that the
3390         alMatrixTopNEntries are sorted by, which view of the matrix
3391         table that will be used, as well as which table the results
3392         will be reported in.
3393
3394         The values alMatrixTopNTerminalsPkts,
3395         alMatrixTopNTerminalsOctets,
3396         alMatrixTopNTerminalsHighCapacityPkts, and
3397         alMatrixTopNTerminalsHighCapacityOctets cause collection
3398         only from protocols that have no child protocols that are
3399         counted.  The values alMatrixTopNAllPkts,
3400         alMatrixTopNAllOctets, alMatrixTopNAllHighCapacityPkts, and
3401         alMatrixTopNAllHighCapacityOctets cause collection from all
3402         alMatrix entries.
3403
3404         This object may not be modified if the associated
3405         alMatrixTopNControlStatus object is equal to active(1)."
3406     ::= { alMatrixTopNControlEntry 3 }
3407
3408 alMatrixTopNControlTimeRemaining OBJECT-TYPE
3409     SYNTAX     Integer32 (0..2147483647)
3410     MAX-ACCESS read-create
3411     STATUS     current
3412     DESCRIPTION
3413         "The number of seconds left in the report currently
3414         being collected.  When this object is modified by
3415         the management station, a new collection is started,
3416         possibly aborting a currently running report.  The
3417         new value is used as the requested duration of this
3418         report and is immediately loaded into the associated
3419         alMatrixTopNControlDuration object.
3420
3421         When the report finishes, the probe will automatically
3422         start another collection with the same initial value
3423         of alMatrixTopNControlTimeRemaining.  Thus, the management
3424         station may simply read the resulting reports repeatedly,
3425         checking the startTime and duration each time to ensure that a
3426         report was not missed or that the report parameters were not
3427         changed.
3428
3429         While the value of this object is non-zero, it decrements
3430         by one per second until it reaches zero.  At the time
3431
3432
3433
3434         that this object decrements to zero, the report is made
3435         accessible in the alMatrixTopNTable, overwriting any report
3436         that may be there.
3437
3438         When this object is modified by the management station, any
3439         associated entries in the alMatrixTopNTable shall be deleted.
3440
3441         (Note that this is a different algorithm than the one used
3442         in the hostTopNTable)."
3443     DEFVAL { 1800 }
3444     ::= { alMatrixTopNControlEntry 4 }
3445
3446 alMatrixTopNControlGeneratedReports OBJECT-TYPE
3447     SYNTAX     Counter32
3448     MAX-ACCESS read-only
3449     STATUS     current
3450     DESCRIPTION
3451         "The number of reports that have been generated by this entry."
3452     ::= { alMatrixTopNControlEntry 5 }
3453
3454 alMatrixTopNControlDuration OBJECT-TYPE
3455     SYNTAX     Integer32
3456     MAX-ACCESS read-only
3457     STATUS     current
3458     DESCRIPTION
3459         "The number of seconds that this report has collected
3460         during the last sampling interval.
3461
3462         When the associated alMatrixTopNControlTimeRemaining object
3463         is set, this object shall be set by the probe to the
3464         same value and shall not be modified until the next
3465         time the alMatrixTopNControlTimeRemaining is set.
3466
3467         This value shall be zero if no reports have been
3468         requested for this alMatrixTopNControlEntry."
3469     ::= { alMatrixTopNControlEntry 6 }
3470
3471 alMatrixTopNControlRequestedSize OBJECT-TYPE
3472     SYNTAX     Integer32 (0..2147483647)
3473     MAX-ACCESS read-create
3474     STATUS     current
3475     DESCRIPTION
3476         "The maximum number of matrix entries requested for this report.
3477
3478         When this object is created or modified, the probe
3479         should set alMatrixTopNControlGrantedSize as closely to this
3480         object as possible for the particular probe
3481         implementation and available resources."
3482
3483
3484
3485     DEFVAL { 150 }
3486     ::= { alMatrixTopNControlEntry 7 }
3487
3488 alMatrixTopNControlGrantedSize OBJECT-TYPE
3489     SYNTAX     Integer32 (0..2147483647)
3490     MAX-ACCESS read-only
3491     STATUS     current
3492     DESCRIPTION
3493         "The maximum number of matrix entries in this report.
3494
3495         When the associated alMatrixTopNControlRequestedSize object
3496         is created or modified, the probe should set this
3497         object as closely to the requested value as
3498         possible for the particular implementation and
3499         available resources. The probe must not lower this
3500         value except as a side-effect of a set to the associated
3501         alMatrixTopNControlRequestedSize object.
3502
3503         If the value of alMatrixTopNControlRateBase is equal to
3504         alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, when the
3505         next topN report is generated, matrix entries with the highest
3506         value of alMatrixTopNPktRate shall be placed in this table in
3507         decreasing order of this rate until there is no more room or
3508         until there are no more matrix entries.
3509
3510         If the value of alMatrixTopNControlRateBase is equal to
3511         alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, when the
3512         next topN report is generated, matrix entries with the highest
3513         value of alMatrixTopNOctetRate shall be placed in this table
3514         in decreasing order of this rate until there is no more room
3515         or until there are no more matrix entries.
3516
3517         It is an implementation-specific matter how entries with the
3518         same value of alMatrixTopNPktRate or alMatrixTopNOctetRate are
3519         sorted.  It is also an implementation-specific matter as to
3520         whether zero-valued entries are available."
3521     ::= { alMatrixTopNControlEntry 8 }
3522
3523 alMatrixTopNControlStartTime OBJECT-TYPE
3524     SYNTAX     TimeStamp
3525     MAX-ACCESS read-only
3526     STATUS     current
3527     DESCRIPTION
3528         "The value of sysUpTime when this topN report was
3529         last started.  In other words, this is the time that
3530         the associated alMatrixTopNControlTimeRemaining object
3531         was modified to start the requested report or the time
3532         the report was last automatically (re)started.
3533
3534
3535
3536         This object may be used by the management station to
3537         determine whether a report was missed."
3538     ::= { alMatrixTopNControlEntry 9 }
3539
3540 alMatrixTopNControlOwner OBJECT-TYPE
3541     SYNTAX     OwnerString
3542     MAX-ACCESS read-create
3543     STATUS     current
3544     DESCRIPTION
3545         "The entity that configured this entry and is
3546         therefore using the resources assigned to it."
3547     ::= { alMatrixTopNControlEntry 10 }
3548
3549 alMatrixTopNControlStatus OBJECT-TYPE
3550     SYNTAX     RowStatus
3551     MAX-ACCESS read-create
3552     STATUS     current
3553     DESCRIPTION
3554         "The status of this alMatrixTopNControlEntry.
3555
3556         An entry may not exist in the active state unless all
3557         objects in the entry have an appropriate value.
3558
3559         If this object is not equal to active(1), all
3560         associated entries in the alMatrixTopNTable shall be
3561         deleted by the agent."
3562     ::= { alMatrixTopNControlEntry 11 }
3563
3564 alMatrixTopNTable OBJECT-TYPE
3565     SYNTAX     SEQUENCE OF AlMatrixTopNEntry
3566     MAX-ACCESS not-accessible
3567     STATUS     current
3568     DESCRIPTION
3569         "A set of statistics for those application-layer matrix
3570         entries that have counted the highest number of octets or
3571         packets."
3572     ::= { alMatrix 4 }
3573
3574 alMatrixTopNEntry OBJECT-TYPE
3575     SYNTAX     AlMatrixTopNEntry
3576     MAX-ACCESS not-accessible
3577     STATUS     current
3578     DESCRIPTION
3579         "A conceptual row in the alMatrixTopNTable.
3580
3581         The alMatrixTopNControlIndex value in the index identifies
3582         the alMatrixTopNControlEntry on whose behalf this entry was
3583         created.
3584
3585
3586
3587         An example of the indexing of this table is
3588         alMatrixTopNPktRate.3.10"
3589     INDEX { alMatrixTopNControlIndex, alMatrixTopNIndex }
3590     ::= { alMatrixTopNTable 1 }
3591
3592 AlMatrixTopNEntry ::= SEQUENCE {
3593     alMatrixTopNIndex                      Integer32,
3594     alMatrixTopNProtocolDirLocalIndex      Integer32,
3595     alMatrixTopNSourceAddress              OCTET STRING,
3596     alMatrixTopNDestAddress                OCTET STRING,
3597     alMatrixTopNAppProtocolDirLocalIndex   Integer32,
3598     alMatrixTopNPktRate                    Gauge32,
3599     alMatrixTopNReversePktRate             Gauge32,
3600     alMatrixTopNOctetRate                  Gauge32,
3601     alMatrixTopNReverseOctetRate           Gauge32
3602   }
3603
3604 alMatrixTopNIndex OBJECT-TYPE
3605     SYNTAX     Integer32 (1..65535)
3606     MAX-ACCESS not-accessible
3607     STATUS     current
3608     DESCRIPTION
3609         "An index that uniquely identifies an entry in
3610         the alMatrixTopNTable among those in the same report.
3611
3612         This index is between 1 and N, where N is the
3613         number of entries in this report.
3614
3615         If the value of alMatrixTopNControlRateBase is equal to
3616         alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, increasing
3617         values of alMatrixTopNIndex shall be assigned to entries with
3618         decreasing values of alMatrixTopNPktRate until index N is
3619         assigned or there are no more alMatrixTopNEntries.
3620
3621         If the value of alMatrixTopNControlRateBase is equal to
3622         alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets,
3623         increasing values of alMatrixTopNIndex shall be assigned to
3624         entries with decreasing values of alMatrixTopNOctetRate until
3625         index N is assigned or there are no more alMatrixTopNEntries."
3626     ::= { alMatrixTopNEntry 1 }
3627
3628 alMatrixTopNProtocolDirLocalIndex OBJECT-TYPE
3629     SYNTAX     Integer32 (1..2147483647)
3630     MAX-ACCESS read-only
3631     STATUS     current
3632     DESCRIPTION
3633         "The protocolDirLocalIndex of the network-layer protocol of
3634         this entry's network address."
3635
3636
3637
3638     ::= { alMatrixTopNEntry 2 }
3639
3640 alMatrixTopNSourceAddress OBJECT-TYPE
3641     SYNTAX     OCTET STRING  (SIZE (1..255))
3642     MAX-ACCESS read-only
3643     STATUS     current
3644     DESCRIPTION
3645         "The network-layer address of the source host in this
3646         conversation.
3647
3648         This is represented as an octet string with
3649         specific semantics and length as identified
3650         by the associated alMatrixTopNProtocolDirLocalIndex.
3651
3652         For example, if the alMatrixTopNProtocolDirLocalIndex
3653         indicates an encapsulation of IP, this object is encoded as a
3654         length octet of 4, followed by the 4 octets of the IP address,
3655         in network byte order."
3656     ::= { alMatrixTopNEntry 3 }
3657
3658 alMatrixTopNDestAddress OBJECT-TYPE
3659     SYNTAX     OCTET STRING  (SIZE (1..255))
3660     MAX-ACCESS read-only
3661     STATUS     current
3662     DESCRIPTION
3663         "The network-layer address of the destination host in this
3664         conversation.
3665
3666         This is represented as an octet string with
3667         specific semantics and length as identified
3668         by the associated alMatrixTopNProtocolDirLocalIndex.
3669
3670         For example, if the alMatrixTopNProtocolDirLocalIndex
3671         indicates an encapsulation of IP, this object is encoded as a
3672         length octet of 4, followed by the 4 octets of the IP address,
3673         in network byte order."
3674     ::= { alMatrixTopNEntry 4 }
3675
3676 alMatrixTopNAppProtocolDirLocalIndex OBJECT-TYPE
3677     SYNTAX     Integer32 (1..2147483647)
3678     MAX-ACCESS read-only
3679     STATUS     current
3680     DESCRIPTION
3681         "The type of the protocol counted by this matrix entry."
3682     ::= { alMatrixTopNEntry 5 }
3683
3684 alMatrixTopNPktRate OBJECT-TYPE
3685     SYNTAX     Gauge32
3686
3687
3688
3689     MAX-ACCESS read-only
3690     STATUS     current
3691     DESCRIPTION
3692         "The number of packets seen of this protocol from the source
3693         host to the destination host during this sampling interval,
3694         counted using the rules for counting the alMatrixSDPkts
3695         object.
3696
3697         If the value of alMatrixTopNControlRateBase is
3698         alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, this
3699         variable will be used to sort this report."
3700     ::= { alMatrixTopNEntry 6 }
3701
3702 alMatrixTopNReversePktRate OBJECT-TYPE
3703     SYNTAX     Gauge32
3704     MAX-ACCESS read-only
3705     STATUS     current
3706     DESCRIPTION
3707         "The number of packets seen of this protocol from the
3708         destination host to the source host during this sampling
3709         interval, counted using the rules for counting the
3710         alMatrixDSPkts object.  (Note that the corresponding
3711         alMatrixSDPkts object selected is the one whose source address
3712         is equal to alMatrixTopNDestAddress and whose destination
3713         address is equal to alMatrixTopNSourceAddress.)
3714
3715         Note that if the value of alMatrixTopNControlRateBase is equal
3716         to alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, the sort
3717         of topN entries is based entirely on alMatrixTopNPktRate, and
3718         not on the value of this object."
3719     ::= { alMatrixTopNEntry 7 }
3720
3721 alMatrixTopNOctetRate OBJECT-TYPE
3722     SYNTAX     Gauge32
3723     MAX-ACCESS read-only
3724     STATUS     current
3725     DESCRIPTION
3726         "The number of octets seen of this protocol from the source
3727         host to the destination host during this sampling interval,
3728         counted using the rules for counting the alMatrixSDOctets
3729         object.
3730
3731         If the value of alMatrixTopNControlRateBase is
3732         alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, this
3733         variable will be used to sort this report."
3734     ::= { alMatrixTopNEntry 8 }
3735
3736 alMatrixTopNReverseOctetRate OBJECT-TYPE
3737
3738
3739
3740     SYNTAX     Gauge32
3741     MAX-ACCESS read-only
3742     STATUS     current
3743     DESCRIPTION
3744         "The number of octets seen of this protocol from the
3745         destination host to the source host during this sampling
3746         interval, counted using the rules for counting the
3747         alMatrixDSOctets object.  (Note that the corresponding
3748         alMatrixSDOctets object selected is the one whose source
3749         address is equal to alMatrixTopNDestAddress and whose
3750         destination address is equal to alMatrixTopNSourceAddress.)
3751
3752         Note that if the value of alMatrixTopNControlRateBase is equal
3753         to alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, the
3754         sort of topN entries is based entirely on
3755         alMatrixTopNOctetRate, and not on the value of this object."
3756     ::= { alMatrixTopNEntry 9 }
3757
3758 --
3759 -- User History Collection Group (usrHistory)
3760 --
3761 -- The usrHistory group combines mechanisms seen in the alarm and
3762 -- history groups to provide user-specified history collection,
3763 -- utilizing two additional control tables and one additional data
3764 -- table.  This function has traditionally been done by NMS
3765 -- applications, via periodic polling.  The usrHistory group allows
3766 -- this task to be offloaded to an RMON probe.
3767 --
3768 -- Data (an ASN.1 INTEGER based object) is collected in the same
3769 -- manner as any history data table (e.g., etherHistoryTable) except
3770 -- that the user specifies the MIB instances to be collected.  Objects
3771 -- are collected in bucket-groups, with the intent that all MIB
3772 -- instances in the same bucket-group are collected as atomically as
3773 -- possible by the RMON probe.
3774 --
3775 -- The usrHistoryControlTable is a one-dimensional read-create table.
3776 -- Each row configures a collection of user history buckets, much
3777 -- the same as a historyControlEntry, except that the creation of a
3778 -- row in this table will cause one or more associated instances in
3779 -- the usrHistoryObjectTable to be created.  The user specifies the
3780 -- number of bucket elements (rows in the usrHistoryObjectTable)
3781 -- requested, as well as the number of buckets requested.
3782 --
3783 -- The usrHistoryObjectTable is a 2-d read-write table.
3784 -- Each row configures a single MIB instance to be collected.
3785 -- All rows with the same major index constitute a bucket-group.
3786 --
3787 -- The usrHistoryTable is a 3-d read-only table containing
3788
3789
3790
3791 -- the data of associated usrHistoryControlEntries.  Each
3792 -- entry represents the value of a single MIB instance
3793 -- during a specific sampling interval (or the rate of
3794 -- change during the interval).
3795 --
3796 -- A sample value is stored in two objects - an absolute value and
3797 -- a status object.  This allows numbers from -(2G-1) to +4G to be
3798 -- stored.  The status object also indicates whether a sample is
3799 -- valid.  This allows data collection to continue if periodic
3800 -- retrieval of a particular instance fails for any reason.
3801 --
3802 -- Row Creation Order Relationships
3803 --
3804 -- The static nature of the usrHistoryObjectTable creates
3805 -- some row creation/modification issues.  The rows in this
3806 -- table need to be set before the associated
3807 -- usrHistoryControlEntry can be activated.
3808 --
3809 -- Note that the usrHistoryObject entries associated with a
3810 -- particular usrHistoryControlEntry are not required to
3811 -- be active before the control entry is activated.  However,
3812 -- the usrHistory data entries associated with an inactive
3813 -- usrHistoryObject entry will be inactive (i.e.,
3814 -- usrHistoryValStatus == valueNotAvailable).
3815 --
3816
3817 usrHistoryControlTable OBJECT-TYPE
3818     SYNTAX SEQUENCE OF UsrHistoryControlEntry
3819     MAX-ACCESS not-accessible
3820     STATUS current
3821     DESCRIPTION
3822         "A list of data-collection configuration entries."
3823     ::= { usrHistory 1 }
3824
3825 usrHistoryControlEntry OBJECT-TYPE
3826     SYNTAX UsrHistoryControlEntry
3827     MAX-ACCESS not-accessible
3828     STATUS current
3829     DESCRIPTION
3830         "A list of parameters that set up a group of user-defined
3831         MIB objects to be sampled periodically (called a
3832         bucket-group).
3833
3834         For example, an instance of usrHistoryControlInterval
3835         might be named usrHistoryControlInterval.1"
3836     INDEX { usrHistoryControlIndex }
3837     ::= { usrHistoryControlTable 1 }
3838
3839
3840
3841
3842 UsrHistoryControlEntry ::= SEQUENCE {
3843     usrHistoryControlIndex             Integer32,
3844     usrHistoryControlObjects           Integer32,
3845     usrHistoryControlBucketsRequested  Integer32,
3846     usrHistoryControlBucketsGranted    Integer32,
3847     usrHistoryControlInterval          Integer32,
3848     usrHistoryControlOwner             OwnerString,
3849     usrHistoryControlStatus            RowStatus
3850 }
3851
3852 usrHistoryControlIndex OBJECT-TYPE
3853     SYNTAX Integer32 (1..65535)
3854     MAX-ACCESS not-accessible
3855     STATUS current
3856     DESCRIPTION
3857         "An index that uniquely identifies an entry in the
3858         usrHistoryControlTable.  Each such entry defines a
3859         set of samples at a particular interval for a specified
3860         set of MIB instances available from the managed system."
3861     ::= { usrHistoryControlEntry 1 }
3862
3863 usrHistoryControlObjects OBJECT-TYPE
3864     SYNTAX Integer32 (1..65535)
3865     MAX-ACCESS read-create
3866     STATUS current
3867     DESCRIPTION
3868         "The number of MIB objects to be collected
3869         in the portion of usrHistoryTable associated with this
3870         usrHistoryControlEntry.
3871
3872         This object may not be modified if the associated instance
3873         of usrHistoryControlStatus is equal to active(1)."
3874     ::= { usrHistoryControlEntry 2 }
3875
3876 usrHistoryControlBucketsRequested OBJECT-TYPE
3877     SYNTAX Integer32 (1..65535)
3878     MAX-ACCESS read-create
3879     STATUS current
3880     DESCRIPTION
3881         "The requested number of discrete time intervals
3882         over which data is to be saved in the part of the
3883         usrHistoryTable associated with this usrHistoryControlEntry.
3884
3885         When this object is created or modified, the probe
3886         should set usrHistoryControlBucketsGranted as closely to
3887         this object as possible for the particular probe
3888         implementation and available resources."
3889     DEFVAL { 50 }
3890
3891
3892
3893     ::= { usrHistoryControlEntry 3 }
3894
3895 usrHistoryControlBucketsGranted OBJECT-TYPE
3896     SYNTAX Integer32 (1..65535)
3897     MAX-ACCESS read-only
3898     STATUS current
3899     DESCRIPTION
3900         "The number of discrete sampling intervals
3901         over which data shall be saved in the part of
3902         the usrHistoryTable associated with this
3903         usrHistoryControlEntry.
3904
3905         When the associated usrHistoryControlBucketsRequested
3906         object is created or modified, the probe should set
3907         this object as closely to the requested value as
3908         possible for the particular probe implementation and
3909         available resources.  The probe must not lower this
3910         value except as a result of a modification to the associated
3911         usrHistoryControlBucketsRequested object.
3912
3913         The associated usrHistoryControlBucketsRequested object
3914         should be set before or at the same time as this object
3915         to allow the probe to accurately estimate the resources
3916         required for this usrHistoryControlEntry.
3917
3918         There will be times when the actual number of buckets
3919         associated with this entry is less than the value of
3920         this object.  In this case, at the end of each sampling
3921         interval, a new bucket will be added to the usrHistoryTable.
3922
3923         When the number of buckets reaches the value of this object
3924         and a new bucket is to be added to the usrHistoryTable,
3925         the oldest bucket associated with this usrHistoryControlEntry
3926         shall be deleted by the agent so that the new bucket can be
3927         added.
3928
3929         When the value of this object changes to a value less than
3930         the current value, entries are deleted from the
3931         usrHistoryTable associated with this usrHistoryControlEntry.
3932         Enough of the oldest of these entries shall be deleted by the
3933         agent so that their number remains less than or equal to the
3934         new value of this object.
3935
3936         When the value of this object changes to a value greater
3937         than the current value, the number of associated usrHistory
3938         entries may be allowed to grow."
3939     ::= { usrHistoryControlEntry 4 }
3940
3941
3942
3943
3944 usrHistoryControlInterval OBJECT-TYPE
3945     SYNTAX Integer32 (1..2147483647)
3946     MAX-ACCESS read-create
3947     STATUS current
3948     DESCRIPTION
3949         "The interval in seconds over which the data is
3950         sampled for each bucket in the part of the usrHistory
3951         table associated with this usrHistoryControlEntry.
3952
3953         Because the counters in a bucket may overflow at their
3954         maximum value with no indication, a prudent manager will
3955         take into account the possibility of overflow in any of
3956         the associated counters.  It is important to consider the
3957         minimum time in which any counter could overflow on a
3958         particular media type and to set the usrHistoryControlInterval
3959         object to a value less than this interval.
3960
3961         This object may not be modified if the associated
3962         usrHistoryControlStatus object is equal to active(1)."
3963     DEFVAL { 1800 }
3964     ::= { usrHistoryControlEntry 5 }
3965
3966 usrHistoryControlOwner OBJECT-TYPE
3967     SYNTAX OwnerString
3968     MAX-ACCESS read-create
3969     STATUS current
3970     DESCRIPTION
3971         "The entity that configured this entry and is
3972         therefore using the resources assigned to it."
3973     ::= { usrHistoryControlEntry 6 }
3974
3975 usrHistoryControlStatus OBJECT-TYPE
3976     SYNTAX RowStatus
3977     MAX-ACCESS read-create
3978     STATUS current
3979     DESCRIPTION
3980         "The status of this variable history control entry.
3981
3982         An entry may not exist in the active state unless all
3983         objects in the entry have an appropriate value.
3984
3985         If this object is not equal to active(1), all associated
3986         entries in the usrHistoryTable shall be deleted."
3987     ::= { usrHistoryControlEntry 7 }
3988
3989 -- Object table
3990
3991 usrHistoryObjectTable OBJECT-TYPE
3992
3993
3994
3995     SYNTAX SEQUENCE OF UsrHistoryObjectEntry
3996     MAX-ACCESS not-accessible
3997     STATUS current
3998     DESCRIPTION
3999         "A list of data-collection configuration entries."
4000     ::= { usrHistory 2 }
4001
4002 usrHistoryObjectEntry OBJECT-TYPE
4003     SYNTAX UsrHistoryObjectEntry
4004     MAX-ACCESS not-accessible
4005     STATUS current
4006     DESCRIPTION
4007         "A list of MIB instances to be sampled periodically.
4008
4009         Entries in this table are created when an associated
4010         usrHistoryControlObjects object is created.
4011
4012         The usrHistoryControlIndex value in the index is
4013         that of the associated usrHistoryControlEntry.
4014
4015         For example, an instance of usrHistoryObjectVariable might be
4016         usrHistoryObjectVariable.1.3"
4017     INDEX { usrHistoryControlIndex, usrHistoryObjectIndex }
4018     ::= { usrHistoryObjectTable 1 }
4019
4020 UsrHistoryObjectEntry ::= SEQUENCE {
4021     usrHistoryObjectIndex             Integer32,
4022     usrHistoryObjectVariable          OBJECT IDENTIFIER,
4023     usrHistoryObjectSampleType        INTEGER
4024 }
4025
4026 usrHistoryObjectIndex OBJECT-TYPE
4027     SYNTAX Integer32 (1..65535)
4028     MAX-ACCESS not-accessible
4029     STATUS current
4030     DESCRIPTION
4031         "An index used to uniquely identify an entry in the
4032         usrHistoryObject table.  Each such entry defines a
4033         MIB instance to be collected periodically."
4034     ::= { usrHistoryObjectEntry 1 }
4035
4036
4037 usrHistoryObjectVariable OBJECT-TYPE
4038     SYNTAX OBJECT IDENTIFIER
4039     MAX-ACCESS read-create
4040     STATUS current
4041     DESCRIPTION
4042         "The object identifier of the particular variable to be
4043
4044
4045
4046         sampled.
4047
4048         Only variables that resolve to an ASN.1 primitive type of
4049         Integer32 (Integer32, Counter, Gauge, or TimeTicks) may be
4050         sampled.
4051
4052         Because SNMP access control is articulated entirely in terms
4053         of the contents of MIB views, no access control mechanism
4054         exists that can restrict the value of this object to identify
4055         only those objects that exist in a particular MIB view.
4056         Because there is thus no acceptable means of restricting the
4057         read access that could be obtained through the user history
4058         mechanism, the probe must only grant write access to this
4059         object in those views that have read access to all objects on
4060         the probe.  See USM [RFC3414] and VACM [RFC3415] for more
4061         information.
4062
4063         During a set operation, if the supplied variable name is not
4064         available in the selected MIB view, a badValue error must be
4065         returned.
4066
4067         This object may not be modified if the associated
4068         usrHistoryControlStatus object is equal to active(1)."
4069     ::= { usrHistoryObjectEntry 2 }
4070
4071 usrHistoryObjectSampleType OBJECT-TYPE
4072     SYNTAX INTEGER {
4073                absoluteValue(1),
4074                deltaValue(2)
4075            }
4076     MAX-ACCESS read-create
4077     STATUS current
4078     DESCRIPTION
4079         "The method of sampling the selected variable for storage in
4080         the usrHistoryTable.
4081
4082         If the value of this object is absoluteValue(1), the value of
4083         the selected variable will be copied directly into the history
4084         bucket.
4085
4086         If the value of this object is deltaValue(2), the value of the
4087         selected variable at the last sample will be subtracted from
4088         the current value, and the difference will be stored in the
4089         history bucket.  If the associated usrHistoryObjectVariable
4090         instance could not be obtained at the previous sample
4091         interval, then a delta sample is not possible, and the value
4092         of the associated usrHistoryValStatus object for this interval
4093         will be valueNotAvailable(1).
4094
4095
4096
4097         This object may not be modified if the associated
4098         usrHistoryControlStatus object is equal to active(1)."
4099     ::= { usrHistoryObjectEntry 3 }
4100
4101 -- data table
4102
4103 usrHistoryTable OBJECT-TYPE
4104     SYNTAX SEQUENCE OF UsrHistoryEntry
4105     MAX-ACCESS not-accessible
4106     STATUS current
4107     DESCRIPTION
4108         "A list of user-defined history entries."
4109     ::= { usrHistory 3 }
4110
4111 usrHistoryEntry OBJECT-TYPE
4112     SYNTAX UsrHistoryEntry
4113     MAX-ACCESS not-accessible
4114     STATUS current
4115     DESCRIPTION
4116         "A historical sample of user-defined variables.  This sample
4117         is associated with the usrHistoryControlEntry that set up the
4118         parameters for a regular collection of these samples.
4119
4120         The usrHistoryControlIndex value in the index identifies the
4121         usrHistoryControlEntry on whose behalf this entry was created.
4122         The usrHistoryObjectIndex value in the index identifies the
4123         usrHistoryObjectEntry on whose behalf this entry was created.
4124
4125         For example, an instance of usrHistoryAbsValue, which represents
4126         the 14th sample of a variable collected as specified by
4127         usrHistoryControlEntry.1 and usrHistoryObjectEntry.1.5,
4128         would be named usrHistoryAbsValue.1.14.5"
4129     INDEX { usrHistoryControlIndex, usrHistorySampleIndex,
4130             usrHistoryObjectIndex }
4131     ::= { usrHistoryTable 1 }
4132
4133 UsrHistoryEntry ::= SEQUENCE {
4134     usrHistorySampleIndex   Integer32,
4135     usrHistoryIntervalStart TimeStamp,
4136     usrHistoryIntervalEnd   TimeStamp,
4137     usrHistoryAbsValue      Gauge32,
4138     usrHistoryValStatus     INTEGER
4139 }
4140
4141 usrHistorySampleIndex OBJECT-TYPE
4142     SYNTAX     Integer32 (1..2147483647)
4143     MAX-ACCESS not-accessible
4144     STATUS     current
4145
4146
4147
4148     DESCRIPTION
4149         "An index that uniquely identifies the particular sample this
4150         entry represents among all samples associated with the same
4151         usrHistoryControlEntry.  This index starts at 1 and increases
4152         by one as each new sample is taken."
4153     ::= { usrHistoryEntry 1 }
4154
4155 usrHistoryIntervalStart OBJECT-TYPE
4156     SYNTAX TimeStamp
4157     MAX-ACCESS read-only
4158     STATUS current
4159     DESCRIPTION
4160         "The value of sysUpTime at the start of the interval over
4161         which this sample was measured.  If the probe keeps track of
4162         the time of day, it should start the first sample of the
4163         history at a time such that when the next hour of the day
4164         begins, a sample is started at that instant.
4165
4166         Note that following this rule may require that the probe delay
4167         collecting the first sample of the history, as each sample
4168         must be of the same interval.  Also note that the sample that
4169         is currently being collected is not accessible in this table
4170         until the end of its interval."
4171     ::= { usrHistoryEntry 2 }
4172
4173 usrHistoryIntervalEnd OBJECT-TYPE
4174     SYNTAX TimeStamp
4175     MAX-ACCESS read-only
4176     STATUS current
4177     DESCRIPTION
4178         "The value of sysUpTime at the end of the interval over which
4179         this sample was measured."
4180     ::= { usrHistoryEntry 3 }
4181
4182 usrHistoryAbsValue OBJECT-TYPE
4183     SYNTAX Gauge32
4184     MAX-ACCESS read-only
4185     STATUS current
4186     DESCRIPTION
4187         "The absolute value (i.e., unsigned value) of the
4188         user-specified statistic during the last sampling period.  The
4189         value during the current sampling period is not made available
4190         until the period is completed.
4191
4192         To obtain the true value for this sampling interval, the
4193         associated instance of usrHistoryValStatus must be checked,
4194         and usrHistoryAbsValue adjusted as necessary.
4195
4196
4197
4198
4199         If the MIB instance could not be accessed during the sampling
4200         interval, then this object will have a value of zero, and the
4201         associated instance of usrHistoryValStatus will be set to
4202         'valueNotAvailable(1)'.
4203
4204         The access control check prescribed in the definition of
4205         usrHistoryObjectVariable SHOULD be checked for each sampling
4206         interval.  If this check determines that access should not be
4207         allowed, then this object will have a value of zero, and the
4208         associated instance of usrHistoryValStatus will be set to
4209         'valueNotAvailable(1)'."
4210     ::= { usrHistoryEntry 4 }
4211
4212
4213 usrHistoryValStatus OBJECT-TYPE
4214     SYNTAX INTEGER {
4215         valueNotAvailable(1),
4216         valuePositive(2),
4217         valueNegative(3)
4218     }
4219     MAX-ACCESS read-only
4220     STATUS current
4221     DESCRIPTION
4222         "This object indicates the validity and sign of the data in
4223         the associated instance of usrHistoryAbsValue.
4224
4225         If the MIB instance could not be accessed during the sampling
4226         interval, then 'valueNotAvailable(1)' will be returned.
4227
4228         If the sample is valid and the actual value of the sample is
4229         greater than or equal to zero, then 'valuePositive(2)' is
4230         returned.
4231
4232         If the sample is valid and the actual value of the sample is
4233         less than zero, 'valueNegative(3)' will be returned.  The
4234         associated instance of usrHistoryAbsValue should be multiplied
4235         by -1 to obtain the true sample value."
4236     ::= { usrHistoryEntry 5 }
4237
4238 -- The Probe Configuration Group
4239 --
4240 -- This group controls the configuration of various operating
4241 -- parameters of the probe.
4242
4243 ControlString ::= TEXTUAL-CONVENTION
4244     STATUS current
4245     DESCRIPTION
4246         "This data type is used to communicate with a modem or a
4247
4248
4249
4250         serial data switch.  A ControlString contains embedded
4251         commands to control how the device will interact with the
4252         remote device through the serial interface.  Commands are
4253         represented as two-character sequences beginning with
4254         the '^' character.
4255
4256         The following commands are recognized by the device (note
4257         that command characters are case sensitive):
4258
4259            ^s  Send string that follows, which is terminated by the
4260                next command or the end of string.
4261            ^c  Delay for the number of seconds that follows.  Toss
4262                out any data received rather than store it in a
4263                buffer for parsing.
4264            ^t  Set timeout to the value represented by the decimal
4265                digits that follow.  The default timeout is 20
4266                seconds.  Note that this timeout may be overridden
4267                by a smaller serialTimeout configured for the
4268                associated serial interface (see serialConfigTable).
4269            ^w  Wait for the reply string that follows, which is
4270                terminated by the next command or the end of string.
4271                Partial and case-insensitive matching is applied, i.e.,
4272                if the reply string (any case combination) is found
4273                anywhere in the received string, then the a match is
4274                found.  If the current timeout elapses without a match,
4275                then the remaining control string is ignored.
4276            ^!  The ^ character.
4277            ^d  Delay the number of seconds specified by the decimal
4278                digits that follow.
4279            ^b  Send break for the number of milliseconds specified by
4280                the decimal digits that follow.  If no digits follow,
4281                break will be enforced for 250 milliseconds by default.
4282
4283         The following ASCII control characters may be inserted into
4284         the '^s' send string or the '^w' reply string:
4285
4286            ^@    0x00
4287            ^A    0x01
4288             ..
4289            ^M    0x0D
4290             ..
4291            ^Z    0x1A
4292            ^[    0x1B
4293            ^    0x1C
4294            ^]    0x1D
4295            ^^    0x1E
4296            ^_    0x1F
4297
4298
4299
4300
4301         Binary data may also be inserted into the data stream.  The
4302         control sequence for each byte of binary data is ^0x##, where
4303         ## is the hexadecimal representation of the data byte.  Two
4304         ASCII characters (0-9, a-f, A-F) must follow the '^0x'
4305         control prefix.  For example, '^0x0D^0x0A' is interpreted as a
4306         carriage return followed by a line feed."
4307     SYNTAX OCTET STRING (SIZE (0..255))
4308
4309 probeCapabilities OBJECT-TYPE
4310     SYNTAX BITS {
4311         etherStats(0),
4312         historyControl(1),
4313         etherHistory(2),
4314         alarm(3),
4315         hosts(4),
4316         hostTopN(5),
4317         matrix(6),
4318         filter(7),
4319         capture(8),
4320         event(9),
4321         tokenRingMLStats(10),
4322         tokenRingPStats(11),
4323         tokenRingMLHistory(12),
4324         tokenRingPHistory(13),
4325         ringStation(14),
4326         ringStationOrder(15),
4327         ringStationConfig(16),
4328         sourceRouting(17),
4329         protocolDirectory(18),
4330         protocolDistribution(19),
4331         addressMapping(20),
4332         nlHost(21),
4333         nlMatrix(22),
4334         alHost(23),
4335         alMatrix(24),
4336         usrHistory(25),
4337         probeConfig(26)
4338     }
4339     MAX-ACCESS read-only
4340     STATUS current
4341     DESCRIPTION
4342         "An indication of the RMON MIB groups supported
4343         on at least one interface by this probe."
4344     ::= { probeConfig 1 }
4345
4346 probeSoftwareRev  OBJECT-TYPE
4347     SYNTAX     DisplayString (SIZE(0..15))
4348     MAX-ACCESS read-only
4349
4350
4351
4352     STATUS     current
4353     DESCRIPTION
4354         "The software revision of this device.  This string will have
4355         a zero length if the revision is unknown."
4356     ::= { probeConfig 2 }
4357
4358 probeHardwareRev  OBJECT-TYPE
4359     SYNTAX     DisplayString (SIZE(0..31))
4360     MAX-ACCESS read-only
4361     STATUS     current
4362     DESCRIPTION
4363         "The hardware revision of this device.  This string will have
4364         a zero length if the revision is unknown."
4365     ::= { probeConfig 3 }
4366
4367 probeDateTime  OBJECT-TYPE
4368     SYNTAX     OCTET STRING (SIZE (0 | 8 | 11))
4369     MAX-ACCESS read-write
4370     STATUS     current
4371     DESCRIPTION
4372         "Probe's current date and time.
4373
4374          field  octets  contents                  range
4375          -----  ------  --------                  -----
4376            1      1-2   year                      0..65536
4377            2       3    month                     1..12
4378            3       4    day                       1..31
4379            4       5    hour                      0..23
4380            5       6    minutes                   0..59
4381            6       7    seconds                   0..60
4382                          (use 60 for leap-second)
4383            7       8    deci-seconds              0..9
4384            8       9    direction from UTC        '+' / '-'
4385            9      10    hours from UTC            0..11
4386           10      11    minutes from UTC          0..59
4387
4388          For example, Tuesday May 26, 1992 at 1:30:15 PM
4389          EDT would be displayed as:
4390
4391                      1992-5-26,13:30:15.0,-4:0
4392
4393          Note that if only local time is known, then
4394          time zone information (fields 8-10) is not
4395          present, and that if no time information is known, the
4396          null string is returned."
4397     ::= { probeConfig 4 }
4398
4399 probeResetControl  OBJECT-TYPE
4400
4401
4402
4403     SYNTAX     INTEGER {
4404                     running(1),
4405                     warmBoot(2),
4406                     coldBoot(3)
4407               }
4408
4409     MAX-ACCESS read-write
4410     STATUS     current
4411     DESCRIPTION
4412         "Setting this object to warmBoot(2) causes the device to
4413         restart the application software with current configuration
4414         parameters saved in non-volatile memory.  Setting this
4415         object to coldBoot(3) causes the device to reinitialize
4416         configuration parameters in non-volatile memory to default
4417         values and to restart the application software.  When the device
4418         is running normally, this variable has a value of
4419         running(1)."
4420     ::= { probeConfig 5 }
4421
4422 -- The following download objects do not restrict an implementation
4423 -- from implementing additional download mechanisms (controlled in an
4424 -- implementation-specific manner).  Further, in the case where the RMON
4425 -- agent shares a processor with other types of systems, the
4426 -- implementation is not required to download those non-RMON functions
4427 -- with this mechanism.
4428
4429 probeDownloadFile  OBJECT-TYPE
4430     SYNTAX     DisplayString (SIZE(0..127))
4431     MAX-ACCESS read-write
4432     STATUS     deprecated
4433     DESCRIPTION
4434         "The file name to be downloaded from the TFTP server when a
4435         download is next requested via this MIB.  This value is set to
4436         the zero-length string when no file name has been specified.
4437
4438         This object has been deprecated, as it has not had enough
4439         independent implementations to demonstrate interoperability to
4440         meet the requirements of a Draft Standard."
4441     ::= { probeConfig 6 }
4442
4443 probeDownloadTFTPServer  OBJECT-TYPE
4444     SYNTAX     IpAddress
4445     MAX-ACCESS read-write
4446     STATUS     deprecated
4447     DESCRIPTION
4448         "The IP address of the TFTP server that contains the boot
4449         image to load when a download is next requested via this MIB.
4450         This value is set to '0.0.0.0' when no IP address has been
4451
4452
4453
4454         specified.
4455
4456         This object has been deprecated, as it has not had enough
4457         independent implementations to demonstrate interoperability to
4458         meet the requirements of a Draft Standard."
4459     ::= { probeConfig 7 }
4460
4461 probeDownloadAction  OBJECT-TYPE
4462     SYNTAX     INTEGER {
4463                   notDownloading(1),
4464                   downloadToPROM(2),
4465                   downloadToRAM(3)
4466                }
4467     MAX-ACCESS read-write
4468     STATUS     deprecated
4469     DESCRIPTION
4470         "When this object is set to downloadToRAM(3) or
4471         downloadToPROM(2), the device will discontinue its
4472         normal operation and begin download of the image specified
4473         by probeDownloadFile from the server specified by
4474         probeDownloadTFTPServer using the TFTP protocol.  If
4475         downloadToRAM(3) is specified, the new image is copied
4476         to RAM only (the old image remains unaltered in the flash
4477         EPROM).  If downloadToPROM(2) is specified,
4478         the new image is written to the flash EPROM
4479         memory after its checksum has been verified to be correct.
4480         When the download process is completed, the device will
4481         warm boot to restart the newly loaded application.
4482         When the device is not downloading, this object will have
4483         a value of notDownloading(1).
4484
4485         This object has been deprecated, as it has not had enough
4486         independent implementations to demonstrate interoperability to
4487         meet the requirements of a Draft Standard."
4488     ::= { probeConfig 8 }
4489
4490 probeDownloadStatus  OBJECT-TYPE
4491     SYNTAX     INTEGER {
4492                     downloadSuccess(1),
4493                     downloadStatusUnknown(2),
4494                     downloadGeneralError(3),
4495                     downloadNoResponseFromServer(4),
4496                     downloadChecksumError(5),
4497                     downloadIncompatibleImage(6),
4498                     downloadTftpFileNotFound(7),
4499                     downloadTftpAccessViolation(8)
4500                }
4501     MAX-ACCESS read-only
4502
4503
4504
4505     STATUS     deprecated
4506     DESCRIPTION
4507         "The status of the last download procedure, if any.  This
4508         object will have a value of downloadStatusUnknown(2) if no
4509         download process has been performed.
4510
4511         This object has been deprecated, as it has not had enough
4512         independent implementations to demonstrate interoperability to
4513         meet the requirements of a Draft Standard."
4514     ::= { probeConfig 9 }
4515
4516 serialConfigTable  OBJECT-TYPE
4517     SYNTAX     SEQUENCE OF SerialConfigEntry
4518     MAX-ACCESS not-accessible
4519     STATUS     deprecated
4520     DESCRIPTION
4521         "A table of serial interface configuration entries.  This data
4522         will be stored in non-volatile memory and preserved across
4523         probe resets or power loss.
4524
4525         This table has been deprecated, as it has not had enough
4526         independent implementations to demonstrate interoperability to
4527         meet the requirements of a Draft Standard."
4528     ::= { probeConfig 10 }
4529
4530 serialConfigEntry  OBJECT-TYPE
4531     SYNTAX     SerialConfigEntry
4532     MAX-ACCESS not-accessible
4533     STATUS     deprecated
4534     DESCRIPTION
4535         "A set of configuration parameters for a particular
4536         serial interface on this device.  If the device has no serial
4537         interfaces, this table is empty.
4538
4539         The index is composed of the ifIndex assigned to this serial
4540         line interface."
4541     INDEX  { ifIndex }
4542     ::= { serialConfigTable 1 }
4543
4544 SerialConfigEntry ::= SEQUENCE {
4545     serialMode                   INTEGER,
4546     serialProtocol               INTEGER,
4547     serialTimeout                Integer32,
4548     serialModemInitString        ControlString,
4549     serialModemHangUpString      ControlString,
4550     serialModemConnectResp       DisplayString,
4551     serialModemNoConnectResp     DisplayString,
4552     serialDialoutTimeout         Integer32,
4553
4554
4555
4556     serialStatus                 RowStatus
4557 }
4558
4559 serialMode  OBJECT-TYPE
4560     SYNTAX     INTEGER {
4561                    direct(1),
4562                    modem(2)
4563                }
4564     MAX-ACCESS read-create
4565     STATUS     deprecated
4566     DESCRIPTION
4567         "The type of incoming connection to be expected on this
4568          serial interface."
4569     DEFVAL { direct }
4570     ::= { serialConfigEntry 1 }
4571
4572 serialProtocol  OBJECT-TYPE
4573     SYNTAX     INTEGER {
4574                    other(1),
4575                    slip(2),
4576                    ppp(3)
4577                }
4578     MAX-ACCESS read-create
4579     STATUS     deprecated
4580     DESCRIPTION
4581         "The type of data link encapsulation to be used on this
4582         serial interface."
4583     DEFVAL { slip }
4584     ::= { serialConfigEntry 2 }
4585
4586 serialTimeout  OBJECT-TYPE
4587     SYNTAX     Integer32 (1..65535)
4588     MAX-ACCESS read-create
4589     STATUS     deprecated
4590     DESCRIPTION
4591         "This timeout value is used when the Management Station has
4592         initiated the conversation over the serial link.  This variable
4593         represents the number of seconds of inactivity allowed before
4594         terminating the connection on this serial interface.  Use the
4595         serialDialoutTimeout in the case where the probe has initiated
4596         the connection for the purpose of sending a trap."
4597     DEFVAL { 300 }
4598     ::= { serialConfigEntry 3 }
4599
4600 serialModemInitString  OBJECT-TYPE
4601     SYNTAX     ControlString (SIZE (0..255))
4602     MAX-ACCESS read-create
4603     STATUS     deprecated
4604
4605
4606
4607     DESCRIPTION
4608         "A control string that controls how a modem attached to this
4609         serial interface should be initialized.  The initialization
4610         is performed once during startup and again after each
4611         connection is terminated if the associated serialMode has the
4612         value of modem(2).
4613
4614         A control string that is appropriate for a wide variety of
4615         modems is: '^s^MATE0Q0V1X4 S0=1 S2=43^M'."
4616     ::= { serialConfigEntry 4 }
4617
4618 serialModemHangUpString  OBJECT-TYPE
4619     SYNTAX     ControlString (SIZE (0..255))
4620     MAX-ACCESS read-create
4621     STATUS     deprecated
4622     DESCRIPTION
4623         "A control string that specifies how to disconnect a modem
4624          connection on this serial interface.  This object is only
4625          meaningful if the associated serialMode has the value
4626          of modem(2).
4627
4628          A control string that is appropriate for a wide variety of
4629          modems is: '^d2^s+++^d2^sATH0^M^d2'."
4630     ::= { serialConfigEntry 5 }
4631
4632 serialModemConnectResp  OBJECT-TYPE
4633     SYNTAX     DisplayString (SIZE (0..255))
4634     MAX-ACCESS read-create
4635     STATUS     deprecated
4636     DESCRIPTION
4637         "An ASCII string containing substrings that describe the
4638         expected modem connection response code and associated bps
4639         rate.  The substrings are delimited by the first character
4640         in the string, for example:
4641            /CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/
4642            CONNECT 4800/4800/CONNECT 9600/9600
4643         will be interpreted as:
4644             response code    bps rate
4645             CONNECT            300
4646             CONNECT 1200      1200
4647             CONNECT 2400      2400
4648             CONNECT 4800      4800
4649             CONNECT 9600      9600
4650         The agent will use the information in this string to adjust
4651         the bps rate of this serial interface once a modem connection
4652         is established.
4653
4654         A value that is appropriate for a wide variety of modems is:
4655
4656
4657
4658         '/CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/
4659          CONNECT 4800/4800/CONNECT 9600/9600/CONNECT 14400/14400/
4660         CONNECT 19200/19200/CONNECT 38400/38400/'."
4661     ::= { serialConfigEntry 6 }
4662
4663 serialModemNoConnectResp  OBJECT-TYPE
4664     SYNTAX     DisplayString (SIZE (0..255))
4665     MAX-ACCESS read-create
4666     STATUS     deprecated
4667     DESCRIPTION
4668         "An ASCII string containing response codes that may be
4669         generated by a modem to report the reason why a connection
4670         attempt has failed.  The response codes are delimited by
4671         the first character in the string, for example:
4672            /NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/
4673
4674         If one of these response codes is received via this serial
4675         interface while attempting to make a modem connection,
4676         the agent will issue the hang up command as specified by
4677         serialModemHangUpString.
4678
4679         A value that is appropriate for a wide variety of modems is:
4680         '/NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/'."
4681     ::= { serialConfigEntry 7 }
4682
4683 serialDialoutTimeout  OBJECT-TYPE
4684     SYNTAX     Integer32 (1..65535)
4685     MAX-ACCESS read-create
4686     STATUS     deprecated
4687     DESCRIPTION
4688         "This timeout value is used when the probe initiates the
4689         serial connection with the intention of contacting a
4690         management station.  This variable represents the number
4691         of seconds of inactivity allowed before terminating the
4692         connection on this serial interface."
4693     DEFVAL { 20 }
4694     ::= { serialConfigEntry 8 }
4695
4696 serialStatus  OBJECT-TYPE
4697     SYNTAX     RowStatus
4698     MAX-ACCESS read-create
4699     STATUS     deprecated
4700     DESCRIPTION
4701         "The status of this serialConfigEntry.
4702
4703         An entry may not exist in the active state unless all
4704         objects in the entry have an appropriate value."
4705     ::= { serialConfigEntry 9 }
4706
4707
4708
4709 netConfigTable  OBJECT-TYPE
4710     SYNTAX     SEQUENCE OF NetConfigEntry
4711     MAX-ACCESS not-accessible
4712     STATUS     deprecated
4713     DESCRIPTION
4714         "A table of netConfigEntries.
4715
4716         This table has been deprecated, as it has not had enough
4717         independent implementations to demonstrate interoperability to
4718         meet the requirements of a Draft Standard."
4719     ::= { probeConfig 11 }
4720
4721 netConfigEntry  OBJECT-TYPE
4722     SYNTAX     NetConfigEntry
4723     MAX-ACCESS not-accessible
4724     STATUS     deprecated
4725     DESCRIPTION
4726         "A set of configuration parameters for a particular
4727         network interface on this device.  If the device has no network
4728         interface, this table is empty.
4729
4730         The index is composed of the ifIndex assigned to the
4731         corresponding interface."
4732     INDEX  { ifIndex }
4733     ::= { netConfigTable 1 }
4734
4735 NetConfigEntry ::= SEQUENCE {
4736     netConfigIPAddress         IpAddress,
4737     netConfigSubnetMask        IpAddress,
4738     netConfigStatus            RowStatus
4739 }
4740
4741 netConfigIPAddress  OBJECT-TYPE
4742     SYNTAX     IpAddress
4743     MAX-ACCESS read-create
4744     STATUS     deprecated
4745     DESCRIPTION
4746         "The IP address of this Net interface.  The default value
4747         for this object is 0.0.0.0.  If either the netConfigIPAddress
4748         or netConfigSubnetMask is 0.0.0.0, then when the device
4749         boots, it may use BOOTP to try to figure out what these
4750         values should be.  If BOOTP fails before the device
4751         can talk on the network, this value must be configured
4752         (e.g., through a terminal attached to the device).  If BOOTP is
4753         used, care should be taken to not send BOOTP broadcasts too
4754         frequently and to eventually send them very infrequently if no
4755         replies are received."
4756     ::= { netConfigEntry 1 }
4757
4758
4759
4760 netConfigSubnetMask  OBJECT-TYPE
4761     SYNTAX     IpAddress
4762     MAX-ACCESS read-create
4763     STATUS     deprecated
4764     DESCRIPTION
4765         "The subnet mask of this Net interface.  The default value
4766         for this object is 0.0.0.0.  If either the netConfigIPAddress
4767         or netConfigSubnetMask is 0.0.0.0, then when the device
4768         boots, it may use BOOTP to try to figure out what these
4769         values should be.  If BOOTP fails before the device
4770         can talk on the network, this value must be configured
4771         (e.g., through a terminal attached to the device).  If BOOTP is
4772         used, care should be taken to not send BOOTP broadcasts too
4773         frequently and to eventually send them very infrequently if no
4774         replies are received."
4775     ::= { netConfigEntry 2 }
4776
4777 netConfigStatus  OBJECT-TYPE
4778     SYNTAX     RowStatus
4779     MAX-ACCESS read-create
4780     STATUS     deprecated
4781     DESCRIPTION
4782         "The status of this netConfigEntry.
4783
4784         An entry may not exist in the active state unless all
4785         objects in the entry have an appropriate value."
4786     ::= { netConfigEntry 3 }
4787
4788 netDefaultGateway  OBJECT-TYPE
4789     SYNTAX     IpAddress
4790     MAX-ACCESS read-write
4791     STATUS     deprecated
4792     DESCRIPTION
4793         "The IP Address of the default gateway.  If this value is
4794         undefined or unknown, it shall have the value 0.0.0.0."
4795     ::= { probeConfig 12 }
4796
4797 -- Trap Destination Table
4798 --
4799 -- This table defines the destination addresses for traps generated
4800 -- from the device.  This table maps a community to one or more trap
4801 -- destination entries.
4802 --
4803 -- The same trap will be sent to all destinations specified in the
4804 -- entries that have the same trapDestCommunity as the eventCommunity
4805 -- (as defined by RMON MIB), as long as no access control mechanism
4806 -- (e.g., VACM) prohibits sending to one or more of the destinations.
4807 -- Information in this table will be stored in non-volatile memory.
4808
4809
4810
4811 -- If the device has gone through a hard restart, this information
4812 -- will be reset to its default state.
4813
4814 trapDestTable  OBJECT-TYPE
4815     SYNTAX     SEQUENCE OF TrapDestEntry
4816     MAX-ACCESS not-accessible
4817     STATUS     deprecated
4818     DESCRIPTION
4819         "A list of trap destination entries."
4820     ::= { probeConfig 13 }
4821
4822 trapDestEntry  OBJECT-TYPE
4823     SYNTAX     TrapDestEntry
4824     MAX-ACCESS not-accessible
4825     STATUS     deprecated
4826     DESCRIPTION
4827         "This entry includes a destination IP address to which
4828         traps are sent for this community."
4829     INDEX { trapDestIndex }
4830     ::= { trapDestTable 1 }
4831
4832 TrapDestEntry ::= SEQUENCE {
4833     trapDestIndex               Integer32,
4834     trapDestCommunity           OCTET STRING,
4835     trapDestProtocol            INTEGER,
4836     trapDestAddress             OCTET STRING,
4837     trapDestOwner               OwnerString,
4838     trapDestStatus              RowStatus
4839 }
4840
4841 trapDestIndex  OBJECT-TYPE
4842     SYNTAX     Integer32 (1..65535)
4843     MAX-ACCESS not-accessible
4844     STATUS     deprecated
4845     DESCRIPTION
4846         "A value that uniquely identifies this trapDestEntry."
4847     ::= { trapDestEntry 1 }
4848
4849 trapDestCommunity  OBJECT-TYPE
4850     SYNTAX     OCTET STRING (SIZE(0..127))
4851     MAX-ACCESS read-create
4852     STATUS     deprecated
4853     DESCRIPTION
4854         "A community to which this destination address belongs.
4855         This entry is associated with any eventEntries in the RMON
4856         MIB whose value of eventCommunity is equal to the value of
4857         this object.  Every time an associated event entry sends a
4858         trap due to an event, that trap will be sent to each
4859
4860
4861
4862         address in the trapDestTable with a trapDestCommunity equal
4863         to eventCommunity, as long as no access control mechanism
4864         precludes it (e.g., VACM).
4865
4866         This object may not be modified if the associated
4867         trapDestStatus object is equal to active(1)."
4868     ::= { trapDestEntry 2 }
4869
4870 trapDestProtocol OBJECT-TYPE
4871     SYNTAX     INTEGER {
4872                     ip(1),
4873                     ipx(2)
4874                 }
4875     MAX-ACCESS read-create
4876     STATUS     deprecated
4877     DESCRIPTION
4878         "The protocol with which this trap is to be sent."
4879     ::= { trapDestEntry 3 }
4880
4881 trapDestAddress  OBJECT-TYPE
4882     SYNTAX     OCTET STRING
4883     MAX-ACCESS read-create
4884     STATUS     deprecated
4885     DESCRIPTION
4886         "The destination address for traps on behalf of this entry.
4887
4888         If the associated trapDestProtocol object is equal to ip(1),
4889         the encoding of this object is the same as the snmpUDPAddress
4890         textual convention in RFC 3417, 'Transport Mappings for the
4891          Simple Network Management Protocol (SNMP)' [RFC3417]:
4892           -- for a SnmpUDPAddress of length 6:
4893           --
4894           -- octets   contents        encoding
4895           --  1-4     IP-address      network-byte order
4896           --  5-6     UDP-port        network-byte order
4897
4898         If the associated trapDestProtocol object is equal to ipx(2),
4899         the encoding of this object is the same as the snmpIPXAddress
4900         textual convention in RFC 3417, 'Transport Mappings for the
4901          Simple Network Management Protocol (SNMP)' [RFC3417]:
4902           -- for a SnmpIPXAddress of length 12:
4903           --
4904           -- octets   contents            encoding
4905           --  1-4     network-number      network-byte order
4906           --  5-10    physical-address    network-byte order
4907           -- 11-12    socket-number       network-byte order
4908
4909         This object may not be modified if the associated
4910
4911
4912
4913         trapDestStatus object is equal to active(1)."
4914     ::= { trapDestEntry 4 }
4915
4916 trapDestOwner  OBJECT-TYPE
4917     SYNTAX     OwnerString
4918     MAX-ACCESS read-create
4919     STATUS     deprecated
4920     DESCRIPTION
4921         "The entity that configured this entry and is
4922         therefore using the resources assigned to it."
4923     ::= { trapDestEntry 5 }
4924
4925 trapDestStatus  OBJECT-TYPE
4926     SYNTAX     RowStatus
4927     MAX-ACCESS read-create
4928     STATUS     deprecated
4929     DESCRIPTION
4930         "The status of this trap destination entry.
4931
4932         An entry may not exist in the active state unless all
4933         objects in the entry have an appropriate value."
4934     ::= { trapDestEntry 6 }
4935
4936 -- Serial Connection Table
4937 --
4938 -- The device may communicate with a management station using
4939 -- SLIP.  In order for the device to send traps via SLIP, it must
4940 -- be able to initiate a connection over the serial interface.  The
4941 -- serialConnectionTable stores the parameters for such connection
4942 -- initiation.
4943
4944 serialConnectionTable  OBJECT-TYPE
4945     SYNTAX     SEQUENCE OF SerialConnectionEntry
4946     MAX-ACCESS not-accessible
4947     STATUS     deprecated
4948     DESCRIPTION
4949         "A list of serialConnectionEntries.
4950
4951         This table has been deprecated, as it has not had enough
4952         independent implementations to demonstrate interoperability
4953         to meet the requirements of a Draft Standard."
4954     ::= { probeConfig 14 }
4955
4956 serialConnectionEntry  OBJECT-TYPE
4957     SYNTAX     SerialConnectionEntry
4958     MAX-ACCESS not-accessible
4959     STATUS     deprecated
4960     DESCRIPTION
4961
4962
4963
4964         "Configuration for a SLIP link over a serial line."
4965     INDEX { serialConnectIndex }
4966     ::= { serialConnectionTable 1 }
4967
4968 SerialConnectionEntry ::= SEQUENCE {
4969     serialConnectIndex                   Integer32,
4970     serialConnectDestIpAddress           IpAddress,
4971     serialConnectType                    INTEGER,
4972     serialConnectDialString              ControlString,
4973     serialConnectSwitchConnectSeq        ControlString,
4974     serialConnectSwitchDisconnectSeq     ControlString,
4975     serialConnectSwitchResetSeq          ControlString,
4976     serialConnectOwner                   OwnerString,
4977     serialConnectStatus                  RowStatus
4978 }
4979
4980 serialConnectIndex  OBJECT-TYPE
4981     SYNTAX     Integer32 (1..65535)
4982     MAX-ACCESS not-accessible
4983     STATUS     deprecated
4984     DESCRIPTION
4985         "A value that uniquely identifies this serialConnection
4986         entry."
4987     ::= { serialConnectionEntry 1 }
4988
4989 serialConnectDestIpAddress  OBJECT-TYPE
4990     SYNTAX     IpAddress
4991     MAX-ACCESS read-create
4992     STATUS     deprecated
4993     DESCRIPTION
4994         "The IP Address that can be reached at the other end of this
4995         serial connection.
4996
4997         This object may not be modified if the associated
4998         serialConnectStatus object is equal to active(1)."
4999     ::= { serialConnectionEntry 2 }
5000
5001
5002 serialConnectType  OBJECT-TYPE
5003     SYNTAX     INTEGER {
5004                     direct(1),
5005                     modem(2),
5006                     switch(3),
5007                     modemSwitch(4)
5008                }
5009     MAX-ACCESS read-create
5010     STATUS     deprecated
5011     DESCRIPTION
5012
5013
5014
5015         "The type of outgoing connection to be made.  If this object
5016         has the value direct(1), then a direct serial connection
5017         is assumed.  If this object has the value modem(2),
5018         then serialConnectDialString will be used to make a modem
5019         connection.  If this object has the value switch(3),
5020         then serialConnectSwitchConnectSeq will be used to establish
5021         the connection over a serial data switch, and
5022         serialConnectSwitchDisconnectSeq will be used to terminate
5023         the connection.  If this object has the value
5024         modem-switch(4), then a modem connection will be made first,
5025         followed by the switch connection.
5026
5027         This object may not be modified if the associated
5028         serialConnectStatus object is equal to active(1)."
5029     DEFVAL { direct }
5030     ::= { serialConnectionEntry 3 }
5031
5032 serialConnectDialString  OBJECT-TYPE
5033     SYNTAX     ControlString (SIZE(0..255))
5034     MAX-ACCESS read-create
5035     STATUS     deprecated
5036     DESCRIPTION
5037         "A control string that specifies how to dial the phone
5038         number in order to establish a modem connection.  The
5039         string should include the dialing prefix and suffix.  For
5040         example: '^s^MATD9,888-1234^M' will instruct the Probe
5041         to send a carriage return, followed by the dialing prefix
5042         'ATD', the phone number '9,888-1234', and a carriage
5043         return as the dialing suffix.
5044
5045         This object may not be modified if the associated
5046         serialConnectStatus object is equal to active(1)."
5047     ::= { serialConnectionEntry 4 }
5048
5049 serialConnectSwitchConnectSeq  OBJECT-TYPE
5050     SYNTAX     ControlString (SIZE(0..255))
5051     MAX-ACCESS read-create
5052     STATUS     deprecated
5053     DESCRIPTION
5054         "A control string that specifies how to establish a
5055         data switch connection.
5056
5057         This object may not be modified if the associated
5058         serialConnectStatus object is equal to active(1)."
5059      ::= { serialConnectionEntry 5 }
5060
5061 serialConnectSwitchDisconnectSeq  OBJECT-TYPE
5062     SYNTAX     ControlString (SIZE(0..255))
5063
5064
5065
5066     MAX-ACCESS read-create
5067     STATUS     deprecated
5068     DESCRIPTION
5069         "A control string that specifies how to terminate a
5070         data switch connection.
5071
5072         This object may not be modified if the associated
5073         serialConnectStatus object is equal to active(1)."
5074     ::= { serialConnectionEntry 6 }
5075
5076 serialConnectSwitchResetSeq  OBJECT-TYPE
5077     SYNTAX     ControlString (SIZE(0..255))
5078     MAX-ACCESS read-create
5079     STATUS     deprecated
5080     DESCRIPTION
5081         "A control string that specifies how to reset a data
5082         switch in the event of a timeout.
5083
5084         This object may not be modified if the associated
5085         serialConnectStatus object is equal to active(1)."
5086     ::= { serialConnectionEntry 7 }
5087
5088 serialConnectOwner  OBJECT-TYPE
5089     SYNTAX     OwnerString
5090     MAX-ACCESS read-create
5091     STATUS     deprecated
5092     DESCRIPTION
5093         "The entity that configured this entry and is
5094         therefore using the resources assigned to it."
5095     ::= { serialConnectionEntry 8 }
5096
5097 serialConnectStatus  OBJECT-TYPE
5098     SYNTAX     RowStatus
5099     MAX-ACCESS read-create
5100     STATUS     deprecated
5101     DESCRIPTION
5102         "The status of this serialConnectionEntry.
5103
5104         If the manager attempts to set this object to active(1) when
5105         the serialConnectType is set to modem(2) or modem-switch(4)
5106         and the serialConnectDialString is a zero-length string or
5107         cannot be correctly parsed as a ConnectString, the set
5108         request will be rejected with badValue(3).
5109
5110         If the manager attempts to set this object to active(1) when
5111         the serialConnectType is set to switch(3) or modem-switch(4)
5112         and the serialConnectSwitchConnectSeq,
5113         the serialConnectSwitchDisconnectSeq, or
5114
5115
5116
5117         the serialConnectSwitchResetSeq is a zero-length string
5118         or cannot be correctly parsed as a ConnectString, the set
5119         request will be rejected with badValue(3).
5120
5121         An entry may not exist in the active state unless all
5122         objects in the entry have an appropriate value."
5123     ::= { serialConnectionEntry 9 }
5124
5125 --
5126 -- Extensions to the RMON 1 MIB for RMON 2 devices
5127 --
5128 -- These extensions include the standard LastCreateTime Textual
5129 -- Convention for all control tables, as well as an augmentation of
5130 -- the filter entry that provides variable-length offsets into
5131 -- packets.
5132
5133
5134 -- Each of the following, except for filterDroppedFrames, is a
5135 -- read-only object which, if implemented, automatically appears when
5136 -- the RMON1 row it is associated with is created.
5137
5138 etherStats2Table  OBJECT-TYPE
5139     SYNTAX     SEQUENCE OF EtherStats2Entry
5140     MAX-ACCESS not-accessible
5141     STATUS     current
5142     DESCRIPTION
5143         "Contains the RMON-2 augmentations to RMON-1."
5144     ::= { statistics 4 }
5145
5146 etherStats2Entry  OBJECT-TYPE
5147     SYNTAX     EtherStats2Entry
5148     MAX-ACCESS not-accessible
5149     STATUS     current
5150     DESCRIPTION
5151         "Contains the RMON-2 augmentations to RMON-1."
5152     AUGMENTS { etherStatsEntry }
5153     ::= { etherStats2Table 1 }
5154
5155 EtherStats2Entry ::= SEQUENCE {
5156     etherStatsDroppedFrames     Counter32,
5157     etherStatsCreateTime        LastCreateTime
5158 }
5159
5160 etherStatsDroppedFrames OBJECT-TYPE
5161     SYNTAX     Counter32
5162     MAX-ACCESS read-only
5163     STATUS     current
5164     DESCRIPTION
5165
5166
5167
5168        "The total number of frames that were received by the probe
5169         and therefore not accounted for in the *StatsDropEvents, but
5170         that the probe chose not to count for this entry for
5171         whatever reason.  Most often, this event occurs when the
5172         probe is out of some resources and decides to shed load from
5173         this collection.
5174
5175         This count does not include packets that were not counted
5176         because they had MAC-layer errors.
5177
5178         Note that, unlike the dropEvents counter, this number is the
5179         exact number of frames dropped."
5180     ::= { etherStats2Entry 1 }
5181
5182 etherStatsCreateTime OBJECT-TYPE
5183     SYNTAX     LastCreateTime
5184     MAX-ACCESS read-only
5185     STATUS     current
5186     DESCRIPTION
5187         "The value of sysUpTime when this control entry was last
5188         activated.  This can be used by the management station to
5189         ensure that the table has not been deleted and recreated
5190         between polls."
5191     ::= { etherStats2Entry 2 }
5192
5193 historyControl2Table  OBJECT-TYPE
5194     SYNTAX     SEQUENCE OF HistoryControl2Entry
5195     MAX-ACCESS not-accessible
5196     STATUS     current
5197     DESCRIPTION
5198         "Contains the RMON-2 augmentations to RMON-1."
5199     ::= { history 5 }
5200
5201 historyControl2Entry  OBJECT-TYPE
5202     SYNTAX     HistoryControl2Entry
5203     MAX-ACCESS not-accessible
5204     STATUS     current
5205     DESCRIPTION
5206         "Contains the RMON-2 augmentations to RMON-1."
5207     AUGMENTS { historyControlEntry }
5208     ::= { historyControl2Table 1 }
5209
5210 HistoryControl2Entry ::= SEQUENCE {
5211     historyControlDroppedFrames Counter32
5212 }
5213
5214 historyControlDroppedFrames OBJECT-TYPE
5215     SYNTAX     Counter32
5216
5217
5218
5219     MAX-ACCESS read-only
5220     STATUS     current
5221     DESCRIPTION
5222        "The total number of frames that were received by the probe
5223         and therefore not accounted for in the *StatsDropEvents, but
5224         that the probe chose not to count for this entry for
5225         whatever reason.  Most often, this event occurs when the
5226         probe is out of some resources and decides to shed load from
5227         this collection.
5228
5229         This count does not include packets that were not counted
5230         because they had MAC-layer errors.
5231
5232         Note that, unlike the dropEvents counter, this number is the
5233         exact number of frames dropped."
5234     ::= { historyControl2Entry 1 }
5235
5236 hostControl2Table  OBJECT-TYPE
5237     SYNTAX     SEQUENCE OF HostControl2Entry
5238     MAX-ACCESS not-accessible
5239     STATUS     current
5240     DESCRIPTION
5241         "Contains the RMON-2 augmentations to RMON-1."
5242     ::= { hosts 4 }
5243
5244 hostControl2Entry  OBJECT-TYPE
5245     SYNTAX     HostControl2Entry
5246     MAX-ACCESS not-accessible
5247     STATUS     current
5248     DESCRIPTION
5249         "Contains the RMON-2 augmentations to RMON-1."
5250     AUGMENTS { hostControlEntry }
5251     ::= { hostControl2Table 1 }
5252
5253 HostControl2Entry ::= SEQUENCE {
5254     hostControlDroppedFrames    Counter32,
5255     hostControlCreateTime       LastCreateTime
5256 }
5257
5258 hostControlDroppedFrames OBJECT-TYPE
5259     SYNTAX     Counter32
5260     MAX-ACCESS read-only
5261     STATUS     current
5262     DESCRIPTION
5263        "The total number of frames that were received by the probe
5264         and therefore not accounted for in the *StatsDropEvents, but
5265         that the probe chose not to count for this entry for
5266         whatever reason.  Most often, this event occurs when the
5267
5268
5269
5270         probe is out of some resources and decides to shed load from
5271         this collection.
5272
5273         This count does not include packets that were not counted
5274         because they had MAC-layer errors.
5275
5276         Note that, unlike the dropEvents counter, this number is the
5277         exact number of frames dropped."
5278     ::= { hostControl2Entry 1 }
5279
5280 hostControlCreateTime OBJECT-TYPE
5281     SYNTAX     LastCreateTime
5282     MAX-ACCESS read-only
5283     STATUS     current
5284     DESCRIPTION
5285         "The value of sysUpTime when this control entry was last
5286         activated.  This can be used by the management station to
5287         ensure that the table has not been deleted and recreated
5288         between polls."
5289     ::= { hostControl2Entry 2 }
5290
5291 matrixControl2Table  OBJECT-TYPE
5292     SYNTAX     SEQUENCE OF MatrixControl2Entry
5293     MAX-ACCESS not-accessible
5294     STATUS     current
5295     DESCRIPTION
5296         "Contains the RMON-2 augmentations to RMON-1."
5297     ::= { matrix 4 }
5298
5299 matrixControl2Entry  OBJECT-TYPE
5300     SYNTAX     MatrixControl2Entry
5301     MAX-ACCESS not-accessible
5302     STATUS     current
5303     DESCRIPTION
5304         "Contains the RMON-2 augmentations to RMON-1."
5305     AUGMENTS { matrixControlEntry }
5306     ::= { matrixControl2Table 1 }
5307
5308 MatrixControl2Entry ::= SEQUENCE {
5309     matrixControlDroppedFrames  Counter32,
5310     matrixControlCreateTime     LastCreateTime
5311 }
5312
5313 matrixControlDroppedFrames OBJECT-TYPE
5314     SYNTAX     Counter32
5315     MAX-ACCESS read-only
5316     STATUS     current
5317     DESCRIPTION
5318
5319
5320
5321        "The total number of frames that were received by the probe
5322         and therefore not accounted for in the *StatsDropEvents, but
5323         that the probe chose not to count for this entry for
5324         whatever reason.  Most often, this event occurs when the
5325         probe is out of some resources and decides to shed load from
5326         this collection.
5327
5328         This count does not include packets that were not counted
5329         because they had MAC-layer errors.
5330
5331         Note that, unlike the dropEvents counter, this number is the
5332         exact number of frames dropped."
5333     ::= { matrixControl2Entry 1 }
5334
5335 matrixControlCreateTime OBJECT-TYPE
5336     SYNTAX     LastCreateTime
5337     MAX-ACCESS read-only
5338     STATUS     current
5339     DESCRIPTION
5340         "The value of sysUpTime when this control entry was last
5341         activated.  This can be used by the management station to
5342         ensure that the table has not been deleted and recreated
5343         between polls."
5344     ::= { matrixControl2Entry 2 }
5345
5346 channel2Table  OBJECT-TYPE
5347     SYNTAX     SEQUENCE OF Channel2Entry
5348     MAX-ACCESS not-accessible
5349     STATUS     current
5350     DESCRIPTION
5351         "Contains the RMON-2 augmentations to RMON-1."
5352     ::= { filter 3 }
5353
5354 channel2Entry  OBJECT-TYPE
5355     SYNTAX     Channel2Entry
5356     MAX-ACCESS not-accessible
5357     STATUS     current
5358     DESCRIPTION
5359         "Contains the RMON-2 augmentations to RMON-1."
5360     AUGMENTS { channelEntry }
5361     ::= { channel2Table 1 }
5362
5363 Channel2Entry ::= SEQUENCE {
5364     channelDroppedFrames    Counter32,
5365     channelCreateTime       LastCreateTime
5366 }
5367
5368 channelDroppedFrames OBJECT-TYPE
5369
5370
5371
5372     SYNTAX     Counter32
5373     MAX-ACCESS read-only
5374     STATUS     current
5375     DESCRIPTION
5376        "The total number of frames that were received by the probe
5377         and therefore not accounted for in the *StatsDropEvents, but
5378         that the probe chose not to count for this entry for
5379         whatever reason.  Most often, this event occurs when the
5380         probe is out of some resources and decides to shed load from
5381         this collection.
5382
5383         This count does not include packets that were not counted
5384         because they had MAC-layer errors.
5385
5386         Note that, unlike the dropEvents counter, this number is the
5387         exact number of frames dropped."
5388     ::= { channel2Entry 1 }
5389
5390 channelCreateTime OBJECT-TYPE
5391     SYNTAX     LastCreateTime
5392     MAX-ACCESS read-only
5393     STATUS     current
5394     DESCRIPTION
5395         "The value of sysUpTime when this control entry was last
5396         activated.  This can be used by the management station to
5397         ensure that the table has not been deleted and recreated
5398         between polls."
5399     ::= { channel2Entry 2 }
5400
5401 tokenRingMLStats2Table  OBJECT-TYPE
5402     SYNTAX     SEQUENCE OF TokenRingMLStats2Entry
5403     MAX-ACCESS not-accessible
5404     STATUS     deprecated
5405     DESCRIPTION
5406         "Contains the RMON-2 augmentations to RMON-1.
5407
5408         This table has been deprecated, as it has not had enough
5409         independent implementations to demonstrate interoperability
5410         to meet the requirements of a Draft Standard."
5411     ::= { statistics 5 }
5412
5413 tokenRingMLStats2Entry  OBJECT-TYPE
5414     SYNTAX     TokenRingMLStats2Entry
5415     MAX-ACCESS not-accessible
5416     STATUS     deprecated
5417     DESCRIPTION
5418         "Contains the RMON-2 augmentations to RMON-1."
5419     AUGMENTS { tokenRingMLStatsEntry }
5420
5421
5422
5423     ::= { tokenRingMLStats2Table 1 }
5424
5425 TokenRingMLStats2Entry ::= SEQUENCE {
5426     tokenRingMLStatsDroppedFrames       Counter32,
5427     tokenRingMLStatsCreateTime          LastCreateTime
5428 }
5429
5430 tokenRingMLStatsDroppedFrames OBJECT-TYPE
5431     SYNTAX     Counter32
5432     MAX-ACCESS read-only
5433     STATUS     deprecated
5434     DESCRIPTION
5435        "The total number of frames that were received by the probe
5436         and therefore not accounted for in the *StatsDropEvents, but
5437         that the probe chose not to count for this entry for
5438         whatever reason.  Most often, this event occurs when the
5439         probe is out of some resources and decides to shed load from
5440         this collection.
5441
5442         This count does not include packets that were not counted
5443         because they had MAC-layer errors.
5444
5445         Note that, unlike the dropEvents counter, this number is the
5446         exact number of frames dropped."
5447     ::= { tokenRingMLStats2Entry 1 }
5448
5449 tokenRingMLStatsCreateTime OBJECT-TYPE
5450     SYNTAX     LastCreateTime
5451     MAX-ACCESS read-only
5452     STATUS     deprecated
5453     DESCRIPTION
5454         "The value of sysUpTime when this control entry was last
5455         activated.  This can be used by the management station to
5456         ensure that the table has not been deleted and recreated
5457         between polls."
5458     ::= { tokenRingMLStats2Entry 2 }
5459
5460 tokenRingPStats2Table  OBJECT-TYPE
5461     SYNTAX     SEQUENCE OF TokenRingPStats2Entry
5462     MAX-ACCESS not-accessible
5463     STATUS     deprecated
5464     DESCRIPTION
5465         "Contains the RMON-2 augmentations to RMON-1.
5466
5467         This table has been deprecated, as it has not had enough
5468         independent implementations to demonstrate interoperability
5469         to meet the requirements of a Draft Standard."
5470     ::= { statistics 6 }
5471
5472
5473
5474 tokenRingPStats2Entry  OBJECT-TYPE
5475     SYNTAX     TokenRingPStats2Entry
5476     MAX-ACCESS not-accessible
5477     STATUS     deprecated
5478     DESCRIPTION
5479         "Contains the RMON-2 augmentations to RMON-1."
5480     AUGMENTS {  tokenRingPStatsEntry }
5481     ::= { tokenRingPStats2Table 1 }
5482
5483 TokenRingPStats2Entry ::= SEQUENCE {
5484     tokenRingPStatsDroppedFrames    Counter32,
5485     tokenRingPStatsCreateTime       LastCreateTime
5486 }
5487
5488 tokenRingPStatsDroppedFrames OBJECT-TYPE
5489     SYNTAX     Counter32
5490     MAX-ACCESS read-only
5491     STATUS     deprecated
5492     DESCRIPTION
5493        "The total number of frames that were received by the probe
5494         and therefore not accounted for in the *StatsDropEvents, but
5495         that the probe chose not to count for this entry for
5496         whatever reason.  Most often, this event occurs when the
5497         probe is out of some resources and decides to shed load from
5498         this collection.
5499
5500         This count does not include packets that were not counted
5501         because they had MAC-layer errors.
5502
5503         Note that, unlike the dropEvents counter, this number is the
5504         exact number of frames dropped."
5505     ::= { tokenRingPStats2Entry 1 }
5506
5507 tokenRingPStatsCreateTime OBJECT-TYPE
5508     SYNTAX     LastCreateTime
5509     MAX-ACCESS read-only
5510     STATUS     deprecated
5511     DESCRIPTION
5512         "The value of sysUpTime when this control entry was last
5513         activated.  This can be used by the management station to
5514         ensure that the table has not been deleted and recreated
5515         between polls."
5516     ::= { tokenRingPStats2Entry 2 }
5517
5518 ringStationControl2Table  OBJECT-TYPE
5519     SYNTAX     SEQUENCE OF RingStationControl2Entry
5520     MAX-ACCESS not-accessible
5521     STATUS     deprecated
5522
5523
5524
5525     DESCRIPTION
5526         "Contains the RMON-2 augmentations to RMON-1.
5527
5528         This table has been deprecated, as it has not had enough
5529         independent implementations to demonstrate interoperability
5530         to meet the requirements of a Draft Standard."
5531     ::= { tokenRing 7 }
5532
5533 ringStationControl2Entry  OBJECT-TYPE
5534     SYNTAX     RingStationControl2Entry
5535     MAX-ACCESS not-accessible
5536     STATUS     deprecated
5537     DESCRIPTION
5538         "Contains the RMON-2 augmentations to RMON-1."
5539     AUGMENTS { ringStationControlEntry }
5540     ::= { ringStationControl2Table 1 }
5541
5542 RingStationControl2Entry ::= SEQUENCE {
5543     ringStationControlDroppedFrames Counter32,
5544     ringStationControlCreateTime    LastCreateTime
5545 }
5546
5547 ringStationControlDroppedFrames OBJECT-TYPE
5548     SYNTAX     Counter32
5549     MAX-ACCESS read-only
5550     STATUS     deprecated
5551     DESCRIPTION
5552        "The total number of frames that were received by the probe
5553         and therefore not accounted for in the *StatsDropEvents, but
5554         that the probe chose not to count for this entry for
5555         whatever reason.  Most often, this event occurs when the
5556         probe is out of some resources and decides to shed load from
5557         this collection.
5558
5559         This count does not include packets that were not counted
5560         because they had MAC-layer errors.
5561
5562         Note that, unlike the dropEvents counter, this number is the
5563         exact number of frames dropped."
5564     ::= { ringStationControl2Entry 1 }
5565
5566 ringStationControlCreateTime OBJECT-TYPE
5567     SYNTAX     LastCreateTime
5568     MAX-ACCESS read-only
5569     STATUS     deprecated
5570     DESCRIPTION
5571         "The value of sysUpTime when this control entry was last
5572         activated.  This can be used by the management station to
5573
5574
5575
5576         ensure that the table has not been deleted and recreated
5577         between polls."
5578     ::= { ringStationControl2Entry 2 }
5579
5580 sourceRoutingStats2Table  OBJECT-TYPE
5581     SYNTAX     SEQUENCE OF SourceRoutingStats2Entry
5582     MAX-ACCESS not-accessible
5583     STATUS     deprecated
5584     DESCRIPTION
5585         "Contains the RMON-2 augmentations to RMON-1.
5586
5587         This table has been deprecated, as it has not had enough
5588         independent implementations to demonstrate interoperability
5589         to meet the requirements of a Draft Standard."
5590     ::= { tokenRing 8 }
5591
5592 sourceRoutingStats2Entry  OBJECT-TYPE
5593     SYNTAX     SourceRoutingStats2Entry
5594     MAX-ACCESS not-accessible
5595     STATUS     deprecated
5596     DESCRIPTION
5597         "Contains the RMON-2 augmentations to RMON-1."
5598     AUGMENTS { sourceRoutingStatsEntry }
5599     ::= { sourceRoutingStats2Table 1 }
5600
5601 SourceRoutingStats2Entry ::= SEQUENCE {
5602     sourceRoutingStatsDroppedFrames Counter32,
5603     sourceRoutingStatsCreateTime    LastCreateTime
5604 }
5605
5606 sourceRoutingStatsDroppedFrames OBJECT-TYPE
5607     SYNTAX     Counter32
5608     MAX-ACCESS read-only
5609     STATUS     deprecated
5610     DESCRIPTION
5611        "The total number of frames that were received by the probe
5612         and therefore not accounted for in the *StatsDropEvents, but
5613         that the probe chose not to count for this entry for
5614         whatever reason.  Most often, this event occurs when the
5615         probe is out of some resources and decides to shed load from
5616         this collection.
5617
5618         This count does not include packets that were not counted
5619         because they had MAC-layer errors.
5620
5621         Note that, unlike the dropEvents counter, this number is the
5622         exact number of frames dropped."
5623     ::= { sourceRoutingStats2Entry 1 }
5624
5625
5626
5627 sourceRoutingStatsCreateTime OBJECT-TYPE
5628     SYNTAX     LastCreateTime
5629     MAX-ACCESS read-only
5630     STATUS     deprecated
5631     DESCRIPTION
5632         "The value of sysUpTime when this control entry was last
5633         activated.  This can be used by the management station to
5634         ensure that the table has not been deleted and recreated
5635         between polls."
5636     ::= { sourceRoutingStats2Entry 2 }
5637
5638 filter2Table OBJECT-TYPE
5639     SYNTAX     SEQUENCE OF Filter2Entry
5640     MAX-ACCESS not-accessible
5641     STATUS     current
5642     DESCRIPTION
5643         "Provides a variable-length packet filter feature to the
5644         RMON-1 filter table."
5645     ::= { filter 4 }
5646
5647 filter2Entry OBJECT-TYPE
5648     SYNTAX     Filter2Entry
5649     MAX-ACCESS not-accessible
5650     STATUS     current
5651     DESCRIPTION
5652         "Provides a variable-length packet filter feature to the
5653         RMON-1 filter table."
5654     AUGMENTS { filterEntry }
5655     ::= { filter2Table 1 }
5656
5657 Filter2Entry ::= SEQUENCE {
5658     filterProtocolDirDataLocalIndex     Integer32,
5659     filterProtocolDirLocalIndex         Integer32
5660 }
5661
5662 filterProtocolDirDataLocalIndex OBJECT-TYPE
5663     SYNTAX     Integer32 (0..2147483647)
5664     MAX-ACCESS read-create
5665     STATUS     current
5666     DESCRIPTION
5667         "When this object is set to a non-zero value, the filter that
5668         it is associated with performs the following operations on
5669         every packet:
5670
5671         1) If the packet doesn't match the protocol directory entry
5672            identified by this object, discard the packet and exit
5673            (i.e., discard the packet if it is not of the identified
5674            protocol).
5675
5676
5677
5678         2) If the associated filterProtocolDirLocalIndex is non-zero
5679            and the packet doesn't match the protocol directory
5680            entry identified by that object, discard the packet and
5681            exit.
5682         3) If the packet matches, perform the regular filter
5683            algorithm as if the beginning of this named protocol is
5684            the beginning of the packet, potentially applying the
5685            filterOffset value to move further into the packet."
5686     DEFVAL { 0 }
5687     ::= { filter2Entry 1 }
5688
5689 filterProtocolDirLocalIndex OBJECT-TYPE
5690     SYNTAX     Integer32 (0..2147483647)
5691     MAX-ACCESS read-create
5692     STATUS     current
5693     DESCRIPTION
5694         "When this object is set to a non-zero value, the filter that
5695         it is associated with will discard the packet if the packet
5696         doesn't match this protocol directory entry."
5697     DEFVAL { 0 }
5698     ::= { filter2Entry 2 }
5699
5700 -- Conformance Macros
5701
5702 rmon2MIBCompliances OBJECT IDENTIFIER ::= { rmonConformance 1 }
5703 rmon2MIBGroups      OBJECT IDENTIFIER ::= { rmonConformance 2 }
5704
5705
5706 rmon2MIBCompliance MODULE-COMPLIANCE
5707     STATUS  current
5708     DESCRIPTION
5709         "Describes the requirements for conformance to
5710         the RMON2 MIB"
5711     MODULE  -- this module
5712         MANDATORY-GROUPS { protocolDirectoryGroup,
5713                            protocolDistributionGroup,
5714                            addressMapGroup,
5715                            nlHostGroup,
5716                            nlMatrixGroup,
5717                            usrHistoryGroup,
5718                            probeInformationGroup }
5719
5720         OBJECT nlMatrixTopNControlRateBase
5721             SYNTAX      INTEGER {
5722                           nlMatrixTopNPkts(1),
5723                           nlMatrixTopNOctets(2)
5724                         }
5725             DESCRIPTION
5726
5727
5728
5729                 "Conformance to RMON2 requires only support for these
5730                 values of nlMatrixTopNControlRateBase."
5731
5732         GROUP   rmon1EnhancementGroup
5733             DESCRIPTION
5734                 "The rmon1EnhancementGroup is mandatory for systems
5735                 that implement RMON [RFC2819]."
5736         GROUP  rmon1EthernetEnhancementGroup
5737             DESCRIPTION
5738                 "The rmon1EthernetEnhancementGroup is optional and is
5739                 appropriate for systems that implement the Ethernet
5740                 group of RMON [RFC2819]."
5741     ::= { rmon2MIBCompliances 1 }
5742
5743 rmon2MIBApplicationLayerCompliance MODULE-COMPLIANCE
5744     STATUS  current
5745     DESCRIPTION
5746         "Describes the requirements for conformance to
5747         the RMON2 MIB with Application-Layer Enhancements."
5748     MODULE  -- this module
5749         MANDATORY-GROUPS { protocolDirectoryGroup,
5750                            protocolDistributionGroup,
5751                            addressMapGroup,
5752                            nlHostGroup,
5753                            nlMatrixGroup,
5754                            alHostGroup,
5755                            alMatrixGroup,
5756                            usrHistoryGroup,
5757                            probeInformationGroup }
5758
5759         OBJECT nlMatrixTopNControlRateBase
5760             SYNTAX      INTEGER {
5761                           nlMatrixTopNPkts(1),
5762                           nlMatrixTopNOctets(2)
5763                         }
5764             DESCRIPTION
5765                 "Conformance to RMON2 requires only support for these
5766                 values of nlMatrixTopNControlRateBase."
5767
5768         OBJECT alMatrixTopNControlRateBase
5769             SYNTAX     INTEGER {
5770                            alMatrixTopNTerminalsPkts(1),
5771                            alMatrixTopNTerminalsOctets(2),
5772                            alMatrixTopNAllPkts(3),
5773                            alMatrixTopNAllOctets(4)
5774                        }
5775             DESCRIPTION
5776                 "Conformance to RMON2 requires only support for these
5777
5778
5779
5780                 values of alMatrixTopNControlRateBase."
5781
5782         GROUP   rmon1EnhancementGroup
5783             DESCRIPTION
5784                 "The rmon1EnhancementGroup is mandatory for systems
5785                 that implement RMON [RFC2819]."
5786         GROUP  rmon1EthernetEnhancementGroup
5787             DESCRIPTION
5788                 "The rmon1EthernetEnhancementGroup is optional and is
5789                 appropriate for systems that implement the Ethernet
5790                 group of RMON [RFC2819]."
5791     ::= { rmon2MIBCompliances 2 }
5792
5793
5794 protocolDirectoryGroup OBJECT-GROUP
5795     OBJECTS { protocolDirLastChange,
5796               protocolDirLocalIndex, protocolDirDescr,
5797               protocolDirType, protocolDirAddressMapConfig,
5798               protocolDirHostConfig, protocolDirMatrixConfig,
5799               protocolDirOwner, protocolDirStatus }
5800     STATUS  current
5801     DESCRIPTION
5802         "Lists the inventory of protocols the probe has the
5803         capability of monitoring and allows the addition, deletion,
5804         and configuration of entries in this list."
5805     ::= { rmon2MIBGroups 1 }
5806
5807 protocolDistributionGroup OBJECT-GROUP
5808     OBJECTS { protocolDistControlDataSource,
5809               protocolDistControlDroppedFrames,
5810               protocolDistControlCreateTime,
5811               protocolDistControlOwner, protocolDistControlStatus,
5812               protocolDistStatsPkts, protocolDistStatsOctets }
5813     STATUS  current
5814     DESCRIPTION
5815         "Collects the relative amounts of octets and packets for the
5816         different protocols detected on a network segment."
5817     ::= { rmon2MIBGroups 2 }
5818
5819 addressMapGroup OBJECT-GROUP
5820     OBJECTS { addressMapInserts, addressMapDeletes,
5821               addressMapMaxDesiredEntries,
5822               addressMapControlDataSource,
5823               addressMapControlDroppedFrames,
5824               addressMapControlOwner, addressMapControlStatus,
5825               addressMapPhysicalAddress,
5826               addressMapLastChange }
5827     STATUS  current
5828
5829
5830
5831     DESCRIPTION
5832         "Lists MAC address to network address bindings discovered by
5833         the probe and what interface they were last seen on."
5834     ::= { rmon2MIBGroups 3 }
5835
5836 nlHostGroup OBJECT-GROUP
5837     OBJECTS { hlHostControlDataSource,
5838               hlHostControlNlDroppedFrames, hlHostControlNlInserts,
5839               hlHostControlNlDeletes,
5840               hlHostControlNlMaxDesiredEntries,
5841               hlHostControlAlDroppedFrames, hlHostControlAlInserts,
5842               hlHostControlAlDeletes,
5843               hlHostControlAlMaxDesiredEntries, hlHostControlOwner,
5844               hlHostControlStatus, nlHostInPkts, nlHostOutPkts,
5845               nlHostInOctets, nlHostOutOctets,
5846               nlHostOutMacNonUnicastPkts, nlHostCreateTime }
5847     STATUS  current
5848     DESCRIPTION
5849         "Counts the amount of traffic sent from and to each network
5850         address discovered by the probe.  Note that while the
5851         hlHostControlTable also has objects that control an optional
5852         alHostTable, implementation of the alHostTable is not
5853         required to fully implement this group."
5854     ::= { rmon2MIBGroups 4 }
5855
5856 nlMatrixGroup OBJECT-GROUP
5857     OBJECTS { hlMatrixControlDataSource,
5858               hlMatrixControlNlDroppedFrames,
5859               hlMatrixControlNlInserts, hlMatrixControlNlDeletes,
5860               hlMatrixControlNlMaxDesiredEntries,
5861               hlMatrixControlAlDroppedFrames,
5862               hlMatrixControlAlInserts, hlMatrixControlAlDeletes,
5863               hlMatrixControlAlMaxDesiredEntries,
5864               hlMatrixControlOwner, hlMatrixControlStatus,
5865               nlMatrixSDPkts, nlMatrixSDOctets, nlMatrixSDCreateTime,
5866               nlMatrixDSPkts, nlMatrixDSOctets, nlMatrixDSCreateTime,
5867               nlMatrixTopNControlMatrixIndex,
5868               nlMatrixTopNControlRateBase,
5869               nlMatrixTopNControlTimeRemaining,
5870               nlMatrixTopNControlGeneratedReports,
5871               nlMatrixTopNControlDuration,
5872               nlMatrixTopNControlRequestedSize,
5873               nlMatrixTopNControlGrantedSize,
5874               nlMatrixTopNControlStartTime,
5875               nlMatrixTopNControlOwner, nlMatrixTopNControlStatus,
5876               nlMatrixTopNProtocolDirLocalIndex,
5877               nlMatrixTopNSourceAddress, nlMatrixTopNDestAddress,
5878               nlMatrixTopNPktRate, nlMatrixTopNReversePktRate,
5879
5880
5881
5882               nlMatrixTopNOctetRate, nlMatrixTopNReverseOctetRate }
5883     STATUS  current
5884     DESCRIPTION
5885         "Counts the amount of traffic sent between each pair of
5886         network addresses discovered by the probe.  Note that while
5887         the hlMatrixControlTable also has objects that control
5888         optional alMatrixTables, implementation of the
5889         alMatrixTables is not required to fully implement this
5890         group."
5891      ::= { rmon2MIBGroups 5 }
5892
5893 alHostGroup OBJECT-GROUP
5894     OBJECTS { alHostInPkts, alHostOutPkts,
5895               alHostInOctets, alHostOutOctets, alHostCreateTime }
5896     STATUS  current
5897     DESCRIPTION
5898         "Counts the amount of traffic, by protocol, sent from and to
5899         each network address discovered by the probe.  Implementation
5900         of this group requires implementation of the Network-Layer
5901         Host Group."
5902     ::= { rmon2MIBGroups 6 }
5903
5904 alMatrixGroup OBJECT-GROUP
5905     OBJECTS { alMatrixSDPkts, alMatrixSDOctets, alMatrixSDCreateTime,
5906               alMatrixDSPkts, alMatrixDSOctets, alMatrixDSCreateTime,
5907               alMatrixTopNControlMatrixIndex,
5908               alMatrixTopNControlRateBase,
5909               alMatrixTopNControlTimeRemaining,
5910               alMatrixTopNControlGeneratedReports,
5911               alMatrixTopNControlDuration,
5912               alMatrixTopNControlRequestedSize,
5913               alMatrixTopNControlGrantedSize,
5914               alMatrixTopNControlStartTime,
5915               alMatrixTopNControlOwner, alMatrixTopNControlStatus,
5916               alMatrixTopNProtocolDirLocalIndex,
5917               alMatrixTopNSourceAddress, alMatrixTopNDestAddress,
5918               alMatrixTopNAppProtocolDirLocalIndex,
5919               alMatrixTopNPktRate, alMatrixTopNReversePktRate,
5920               alMatrixTopNOctetRate, alMatrixTopNReverseOctetRate }
5921     STATUS  current
5922     DESCRIPTION
5923         "Counts the amount of traffic, by protocol, sent between each
5924         pair of network addresses discovered by the
5925         probe.  Implementation of this group requires implementation
5926         of the Network-Layer Matrix Group."
5927     ::= { rmon2MIBGroups 7 }
5928
5929 usrHistoryGroup OBJECT-GROUP
5930
5931
5932
5933     OBJECTS { usrHistoryControlObjects,
5934               usrHistoryControlBucketsRequested,
5935               usrHistoryControlBucketsGranted,
5936               usrHistoryControlInterval,
5937               usrHistoryControlOwner, usrHistoryControlStatus,
5938               usrHistoryObjectVariable, usrHistoryObjectSampleType,
5939               usrHistoryIntervalStart, usrHistoryIntervalEnd,
5940               usrHistoryAbsValue, usrHistoryValStatus }
5941     STATUS  current
5942     DESCRIPTION
5943         "The usrHistoryGroup provides user-defined collection of
5944         historical information from MIB objects on the probe."
5945     ::= { rmon2MIBGroups 8 }
5946
5947 probeInformationGroup OBJECT-GROUP
5948     OBJECTS { probeCapabilities,
5949               probeSoftwareRev, probeHardwareRev, probeDateTime }
5950     STATUS  current
5951     DESCRIPTION
5952         "This group describes various operating parameters of the
5953         probe and controls the local time of the probe."
5954     ::= { rmon2MIBGroups 9 }
5955
5956 probeConfigurationGroup OBJECT-GROUP
5957     OBJECTS { probeResetControl, probeDownloadFile,
5958               probeDownloadTFTPServer, probeDownloadAction,
5959               probeDownloadStatus,
5960               serialMode, serialProtocol, serialTimeout,
5961               serialModemInitString, serialModemHangUpString,
5962               serialModemConnectResp, serialModemNoConnectResp,
5963               serialDialoutTimeout, serialStatus,
5964               netConfigIPAddress, netConfigSubnetMask,
5965               netConfigStatus, netDefaultGateway,
5966               trapDestCommunity, trapDestProtocol, trapDestAddress,
5967               trapDestOwner, trapDestStatus,
5968               serialConnectDestIpAddress, serialConnectType,
5969               serialConnectDialString, serialConnectSwitchConnectSeq,
5970               serialConnectSwitchDisconnectSeq,
5971               serialConnectSwitchResetSeq,
5972               serialConnectOwner, serialConnectStatus }
5973     STATUS  deprecated
5974     DESCRIPTION
5975         "This group controls the configuration of various operating
5976         parameters of the probe.  This group is not referenced by any
5977         MODULE-COMPLIANCE macro because it is 'grandfathered' from
5978         more recent MIB review rules that would require it."
5979     ::= { rmon2MIBGroups 10 }
5980
5981
5982
5983
5984 rmon1EnhancementGroup OBJECT-GROUP
5985     OBJECTS { historyControlDroppedFrames, hostControlDroppedFrames,
5986               hostControlCreateTime, matrixControlDroppedFrames,
5987               matrixControlCreateTime, channelDroppedFrames,
5988               channelCreateTime, filterProtocolDirDataLocalIndex,
5989               filterProtocolDirLocalIndex }
5990     STATUS  current
5991     DESCRIPTION
5992         "This group adds some enhancements to RMON-1 that help
5993         management stations."
5994     ::= { rmon2MIBGroups 11 }
5995
5996 rmon1EthernetEnhancementGroup OBJECT-GROUP
5997     OBJECTS { etherStatsDroppedFrames, etherStatsCreateTime }
5998     STATUS  current
5999     DESCRIPTION
6000         "This group adds some enhancements to RMON-1 that help
6001         management stations."
6002     ::= { rmon2MIBGroups 12 }
6003
6004 rmon1TokenRingEnhancementGroup OBJECT-GROUP
6005     OBJECTS { tokenRingMLStatsDroppedFrames,
6006               tokenRingMLStatsCreateTime,
6007               tokenRingPStatsDroppedFrames, tokenRingPStatsCreateTime,
6008               ringStationControlDroppedFrames,
6009               ringStationControlCreateTime,
6010               sourceRoutingStatsDroppedFrames,
6011               sourceRoutingStatsCreateTime }
6012     STATUS  deprecated
6013     DESCRIPTION
6014         "This group adds some enhancements to RMON-1 that help
6015         management stations.  This group is not referenced by any
6016         MODULE-COMPLIANCE macro because it is 'grandfathered' from
6017         more recent MIB review rules that would require it."
6018     ::= { rmon2MIBGroups 13 }
6019 END