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