1
RMON-MIB DEFINITIONS ::= BEGIN
4
MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY,
5
NOTIFICATION-TYPE, mib-2, Counter32,
6
Integer32, TimeTicks FROM SNMPv2-SMI
8
TEXTUAL-CONVENTION, DisplayString FROM SNMPv2-TC
10
MODULE-COMPLIANCE, OBJECT-GROUP,
11
NOTIFICATION-GROUP FROM SNMPv2-CONF;
13
-- Remote Network Monitoring MIB
15
rmonMibModule MODULE-IDENTITY
16
LAST-UPDATED "200005110000Z" -- 11 May, 2000
17
ORGANIZATION "IETF RMON MIB Working Group"
20
Phone: +1-650-948-6500
22
Email: waldbusser@nextbeacon.com"
24
"Remote network monitoring devices, often called
25
monitors or probes, are instruments that exist for
26
the purpose of managing a network. This MIB defines
27
objects for managing remote network monitoring devices."
29
REVISION "200005110000Z" -- 11 May, 2000
31
"Reformatted into SMIv2 format.
33
This version published as RFC 2819."
35
REVISION "199502010000Z" -- 1 Feb, 1995
37
"Bug fixes, clarifications and minor changes based on
38
implementation experience, published as RFC1757 [18].
40
Two changes were made to object definitions:
42
1) A new status bit has been defined for the
43
captureBufferPacketStatus object, indicating that the
44
packet order within the capture buffer may not be identical to
45
the packet order as received off the wire. This bit may only
47
be used for packets transmitted by the probe. Older NMS
48
applications can safely ignore this status bit, which might be
51
2) The packetMatch trap has been removed. This trap was never
52
actually 'approved' and was not added to this document along
53
with the risingAlarm and fallingAlarm traps. The packetMatch
54
trap could not be throttled, which could cause disruption of
55
normal network traffic under some circumstances. An NMS should
56
configure a risingAlarm threshold on the appropriate
57
channelMatches instance if a trap is desired for a packetMatch
58
event. Note that logging of packetMatch events is still
59
supported--only trap generation for such events has been
62
In addition, several clarifications to individual object
63
definitions have been added to assist agent and NMS
66
- global definition of 'good packets' and 'bad packets'
68
- more detailed text governing conceptual row creation and
71
- instructions for probes relating to interface changes and
74
- clarification of some ethernet counter definitions
76
- recommended formula for calculating network utilization
78
- clarification of channel and captureBuffer behavior for some
81
- examples of proper instance naming for each table"
83
REVISION "199111010000Z" -- 1 Nov, 1991
85
"The original version of this MIB, published as RFC1271."
86
::= { rmonConformance 8 }
88
rmon OBJECT IDENTIFIER ::= { mib-2 16 }
90
-- textual conventions
92
OwnerString ::= TEXTUAL-CONVENTION
95
"This data type is used to model an administratively
96
assigned name of the owner of a resource. Implementations
97
must accept values composed of well-formed NVT ASCII
98
sequences. In addition, implementations should accept
99
values composed of well-formed UTF-8 sequences.
101
It is suggested that this name contain one or more of
102
the following: IP address, management station name,
103
network manager's name, location, or phone number.
104
In some cases the agent itself will be the owner of
105
an entry. In these cases, this string shall be set
106
to a string starting with 'monitor'.
108
SNMP access control is articulated entirely in terms
109
of the contents of MIB views; access to a particular
110
SNMP object instance depends only upon its presence
111
or absence in a particular MIB view and never upon
112
its value or the value of related object instances.
113
Thus, objects of this type afford resolution of
114
resource contention only among cooperating
115
managers; they realize no access control function
116
with respect to uncooperative parties."
117
SYNTAX OCTET STRING (SIZE (0..127))
119
EntryStatus ::= TEXTUAL-CONVENTION
122
"The status of a table entry.
124
Setting this object to the value invalid(4) has the
125
effect of invalidating the corresponding entry.
126
That is, it effectively disassociates the mapping
127
identified with said entry.
128
It is an implementation-specific matter as to whether
129
the agent removes an invalidated entry from the table.
130
Accordingly, management stations must be prepared to
131
receive tabular information from agents that corresponds
132
to entries currently not in use. Proper
133
interpretation of such entries requires examination
134
of the relevant EntryStatus object.
136
An existing instance of this object cannot be set to
137
createRequest(2). This object may only be set to
138
createRequest(2) when this instance is created. When
139
this object is created, the agent may wish to create
140
supplemental object instances with default values
141
to complete a conceptual row in this table. Because the
143
creation of these default objects is entirely at the option
144
of the agent, the manager must not assume that any will be
145
created, but may make use of any that are created.
146
Immediately after completing the create operation, the agent
147
must set this object to underCreation(3).
149
When in the underCreation(3) state, an entry is allowed to
150
exist in a possibly incomplete, possibly inconsistent state,
151
usually to allow it to be modified in multiple PDUs. When in
152
this state, an entry is not fully active.
153
Entries shall exist in the underCreation(3) state until
154
the management station is finished configuring the entry
155
and sets this object to valid(1) or aborts, setting this
156
object to invalid(4). If the agent determines that an
157
entry has been in the underCreation(3) state for an
158
abnormally long time, it may decide that the management
159
station has crashed. If the agent makes this decision,
160
it may set this object to invalid(4) to reclaim the
161
entry. A prudent agent will understand that the
162
management station may need to wait for human input
163
and will allow for that possibility in its
164
determination of this abnormally long period.
166
An entry in the valid(1) state is fully configured and
167
consistent and fully represents the configuration or
168
operation such a row is intended to represent. For
169
example, it could be a statistical function that is
170
configured and active, or a filter that is available
171
in the list of filters processed by the packet capture
174
A manager is restricted to changing the state of an entry in
177
To: valid createRequest underCreation invalid
180
createRequest N/A N/A N/A N/A
181
underCreation OK NO OK OK
183
nonExistent NO OK NO OK
185
In the table above, it is not applicable to move the state
186
from the createRequest state to any other state because the
187
manager will never find the variable in that state. The
188
nonExistent state is not a value of the enumeration, rather
189
it means that the entryStatus variable does not exist at all.
191
An agent may allow an entryStatus variable to change state in
192
additional ways, so long as the semantics of the states are
193
followed. This allowance is made to ease the implementation of
194
the agent and is made despite the fact that managers should
195
never exercise these additional state transitions."
203
statistics OBJECT IDENTIFIER ::= { rmon 1 }
204
history OBJECT IDENTIFIER ::= { rmon 2 }
205
alarm OBJECT IDENTIFIER ::= { rmon 3 }
206
hosts OBJECT IDENTIFIER ::= { rmon 4 }
207
hostTopN OBJECT IDENTIFIER ::= { rmon 5 }
208
matrix OBJECT IDENTIFIER ::= { rmon 6 }
209
filter OBJECT IDENTIFIER ::= { rmon 7 }
210
capture OBJECT IDENTIFIER ::= { rmon 8 }
211
event OBJECT IDENTIFIER ::= { rmon 9 }
212
rmonConformance OBJECT IDENTIFIER ::= { rmon 20 }
214
-- The Ethernet Statistics Group
216
-- Implementation of the Ethernet Statistics group is optional.
217
-- Consult the MODULE-COMPLIANCE macro for the authoritative
218
-- conformance information for this MIB.
220
-- The ethernet statistics group contains statistics measured by the
221
-- probe for each monitored interface on this device. These
222
-- statistics take the form of free running counters that start from
223
-- zero when a valid entry is created.
225
-- This group currently has statistics defined only for
226
-- Ethernet interfaces. Each etherStatsEntry contains statistics
227
-- for one Ethernet interface. The probe must create one
228
-- etherStats entry for each monitored Ethernet interface
231
etherStatsTable OBJECT-TYPE
232
SYNTAX SEQUENCE OF EtherStatsEntry
233
MAX-ACCESS not-accessible
236
"A list of Ethernet statistics entries."
239
etherStatsEntry OBJECT-TYPE
240
SYNTAX EtherStatsEntry
241
MAX-ACCESS not-accessible
244
"A collection of statistics kept for a particular
245
Ethernet interface. As an example, an instance of the
246
etherStatsPkts object might be named etherStatsPkts.1"
247
INDEX { etherStatsIndex }
248
::= { etherStatsTable 1 }
250
EtherStatsEntry ::= SEQUENCE {
251
etherStatsIndex Integer32,
252
etherStatsDataSource OBJECT IDENTIFIER,
253
etherStatsDropEvents Counter32,
254
etherStatsOctets Counter32,
255
etherStatsPkts Counter32,
256
etherStatsBroadcastPkts Counter32,
257
etherStatsMulticastPkts Counter32,
258
etherStatsCRCAlignErrors Counter32,
259
etherStatsUndersizePkts Counter32,
260
etherStatsOversizePkts Counter32,
261
etherStatsFragments Counter32,
262
etherStatsJabbers Counter32,
263
etherStatsCollisions Counter32,
264
etherStatsPkts64Octets Counter32,
265
etherStatsPkts65to127Octets Counter32,
266
etherStatsPkts128to255Octets Counter32,
267
etherStatsPkts256to511Octets Counter32,
268
etherStatsPkts512to1023Octets Counter32,
269
etherStatsPkts1024to1518Octets Counter32,
270
etherStatsOwner OwnerString,
271
etherStatsStatus EntryStatus
274
etherStatsIndex OBJECT-TYPE
275
SYNTAX Integer32 (1..65535)
279
"The value of this object uniquely identifies this
281
::= { etherStatsEntry 1 }
283
etherStatsDataSource OBJECT-TYPE
284
SYNTAX OBJECT IDENTIFIER
285
MAX-ACCESS read-create
288
"This object identifies the source of the data that
289
this etherStats entry is configured to analyze. This
290
source can be any ethernet interface on this device.
291
In order to identify a particular interface, this object
292
shall identify the instance of the ifIndex object,
293
defined in RFC 2233 [17], for the desired interface.
294
For example, if an entry were to receive data from
295
interface #1, this object would be set to ifIndex.1.
297
The statistics in this group reflect all packets
298
on the local network segment attached to the identified
301
An agent may or may not be able to tell if fundamental
302
changes to the media of the interface have occurred and
303
necessitate an invalidation of this entry. For example, a
304
hot-pluggable ethernet card could be pulled out and replaced
305
by a token-ring card. In such a case, if the agent has such
306
knowledge of the change, it is recommended that it
307
invalidate this entry.
309
This object may not be modified if the associated
310
etherStatsStatus object is equal to valid(1)."
311
::= { etherStatsEntry 2 }
313
etherStatsDropEvents OBJECT-TYPE
318
"The total number of events in which packets
319
were dropped by the probe due to lack of resources.
320
Note that this number is not necessarily the number of
321
packets dropped; it is just the number of times this
322
condition has been detected."
323
::= { etherStatsEntry 3 }
325
etherStatsOctets OBJECT-TYPE
331
"The total number of octets of data (including
332
those in bad packets) received on the
333
network (excluding framing bits but including
336
This object can be used as a reasonable estimate of
337
10-Megabit ethernet utilization. If greater precision is
338
desired, the etherStatsPkts and etherStatsOctets objects
339
should be sampled before and after a common interval. The
340
differences in the sampled values are Pkts and Octets,
341
respectively, and the number of seconds in the interval is
342
Interval. These values are used to calculate the Utilization
345
Pkts * (9.6 + 6.4) + (Octets * .8)
346
Utilization = -------------------------------------
349
The result of this equation is the value Utilization which
350
is the percent utilization of the ethernet segment on a
351
scale of 0 to 100 percent."
352
::= { etherStatsEntry 4 }
354
etherStatsPkts OBJECT-TYPE
360
"The total number of packets (including bad packets,
361
broadcast packets, and multicast packets) received."
362
::= { etherStatsEntry 5 }
364
etherStatsBroadcastPkts OBJECT-TYPE
370
"The total number of good packets received that were
371
directed to the broadcast address. Note that this
372
does not include multicast packets."
373
::= { etherStatsEntry 6 }
375
etherStatsMulticastPkts OBJECT-TYPE
381
"The total number of good packets received that were
382
directed to a multicast address. Note that this number
383
does not include packets directed to the broadcast
386
::= { etherStatsEntry 7 }
388
etherStatsCRCAlignErrors OBJECT-TYPE
394
"The total number of packets received that
395
had a length (excluding framing bits, but
396
including FCS octets) of between 64 and 1518
397
octets, inclusive, but had either a bad
398
Frame Check Sequence (FCS) with an integral
399
number of octets (FCS Error) or a bad FCS with
400
a non-integral number of octets (Alignment Error)."
401
::= { etherStatsEntry 8 }
403
etherStatsUndersizePkts OBJECT-TYPE
409
"The total number of packets received that were
410
less than 64 octets long (excluding framing bits,
411
but including FCS octets) and were otherwise well
413
::= { etherStatsEntry 9 }
415
etherStatsOversizePkts OBJECT-TYPE
421
"The total number of packets received that were
422
longer than 1518 octets (excluding framing bits,
423
but including FCS octets) and were otherwise
425
::= { etherStatsEntry 10 }
427
etherStatsFragments OBJECT-TYPE
433
"The total number of packets received that were less than
434
64 octets in length (excluding framing bits but including
435
FCS octets) and had either a bad Frame Check Sequence
436
(FCS) with an integral number of octets (FCS Error) or a
437
bad FCS with a non-integral number of octets (Alignment
440
Note that it is entirely normal for etherStatsFragments to
441
increment. This is because it counts both runts (which are
442
normal occurrences due to collisions) and noise hits."
443
::= { etherStatsEntry 11 }
445
etherStatsJabbers OBJECT-TYPE
451
"The total number of packets received that were
452
longer than 1518 octets (excluding framing bits,
453
but including FCS octets), and had either a bad
454
Frame Check Sequence (FCS) with an integral number
455
of octets (FCS Error) or a bad FCS with a non-integral
456
number of octets (Alignment Error).
458
Note that this definition of jabber is different
459
than the definition in IEEE-802.3 section 8.2.1.5
460
(10BASE5) and section 10.3.1.4 (10BASE2). These
461
documents define jabber as the condition where any
462
packet exceeds 20 ms. The allowed range to detect
463
jabber is between 20 ms and 150 ms."
464
::= { etherStatsEntry 12 }
466
etherStatsCollisions OBJECT-TYPE
472
"The best estimate of the total number of collisions
473
on this Ethernet segment.
475
The value returned will depend on the location of the
476
RMON probe. Section 8.2.1.3 (10BASE-5) and section
477
10.3.1.3 (10BASE-2) of IEEE standard 802.3 states that a
478
station must detect a collision, in the receive mode, if
479
three or more stations are transmitting simultaneously. A
480
repeater port must detect a collision when two or more
482
stations are transmitting simultaneously. Thus a probe
483
placed on a repeater port could record more collisions
484
than a probe connected to a station on the same segment
487
Probe location plays a much smaller role when considering
488
10BASE-T. 14.2.1.4 (10BASE-T) of IEEE standard 802.3
489
defines a collision as the simultaneous presence of signals
490
on the DO and RD circuits (transmitting and receiving
491
at the same time). A 10BASE-T station can only detect
492
collisions when it is transmitting. Thus probes placed on
493
a station and a repeater, should report the same number of
496
Note also that an RMON probe inside a repeater should
497
ideally report collisions between the repeater and one or
498
more other hosts (transmit collisions as defined by IEEE
499
802.3k) plus receiver collisions observed on any coax
500
segments to which the repeater is connected."
501
::= { etherStatsEntry 13 }
503
etherStatsPkts64Octets OBJECT-TYPE
509
"The total number of packets (including bad
510
packets) received that were 64 octets in length
511
(excluding framing bits but including FCS octets)."
512
::= { etherStatsEntry 14 }
514
etherStatsPkts65to127Octets OBJECT-TYPE
520
"The total number of packets (including bad
521
packets) received that were between
522
65 and 127 octets in length inclusive
523
(excluding framing bits but including FCS octets)."
524
::= { etherStatsEntry 15 }
526
etherStatsPkts128to255Octets OBJECT-TYPE
532
"The total number of packets (including bad
533
packets) received that were between
534
128 and 255 octets in length inclusive
535
(excluding framing bits but including FCS octets)."
536
::= { etherStatsEntry 16 }
538
etherStatsPkts256to511Octets OBJECT-TYPE
544
"The total number of packets (including bad
545
packets) received that were between
546
256 and 511 octets in length inclusive
547
(excluding framing bits but including FCS octets)."
548
::= { etherStatsEntry 17 }
550
etherStatsPkts512to1023Octets OBJECT-TYPE
556
"The total number of packets (including bad
557
packets) received that were between
558
512 and 1023 octets in length inclusive
559
(excluding framing bits but including FCS octets)."
560
::= { etherStatsEntry 18 }
562
etherStatsPkts1024to1518Octets OBJECT-TYPE
568
"The total number of packets (including bad
569
packets) received that were between
570
1024 and 1518 octets in length inclusive
571
(excluding framing bits but including FCS octets)."
572
::= { etherStatsEntry 19 }
574
etherStatsOwner OBJECT-TYPE
576
MAX-ACCESS read-create
579
"The entity that configured this entry and is therefore
580
using the resources assigned to it."
581
::= { etherStatsEntry 20 }
583
etherStatsStatus OBJECT-TYPE
585
MAX-ACCESS read-create
588
"The status of this etherStats entry."
589
::= { etherStatsEntry 21 }
591
-- The History Control Group
593
-- Implementation of the History Control group is optional.
594
-- Consult the MODULE-COMPLIANCE macro for the authoritative
595
-- conformance information for this MIB.
597
-- The history control group controls the periodic statistical
598
-- sampling of data from various types of networks. The
599
-- historyControlTable stores configuration entries that each
600
-- define an interface, polling period, and other parameters.
601
-- Once samples are taken, their data is stored in an entry
602
-- in a media-specific table. Each such entry defines one
603
-- sample, and is associated with the historyControlEntry that
604
-- caused the sample to be taken. Each counter in the
605
-- etherHistoryEntry counts the same event as its similarly-named
606
-- counterpart in the etherStatsEntry, except that each value here
607
-- is a cumulative sum during a sampling period.
609
-- If the probe keeps track of the time of day, it should start
610
-- the first sample of the history at a time such that
611
-- when the next hour of the day begins, a sample is
612
-- started at that instant. This tends to make more
613
-- user-friendly reports, and enables comparison of reports
614
-- from different probes that have relatively accurate time
617
-- The probe is encouraged to add two history control entries
618
-- per monitored interface upon initialization that describe a short
619
-- term and a long term polling period. Suggested parameters are 30
620
-- seconds for the short term polling period and 30 minutes for
621
-- the long term period.
623
historyControlTable OBJECT-TYPE
624
SYNTAX SEQUENCE OF HistoryControlEntry
625
MAX-ACCESS not-accessible
628
"A list of history control entries."
631
historyControlEntry OBJECT-TYPE
632
SYNTAX HistoryControlEntry
633
MAX-ACCESS not-accessible
636
"A list of parameters that set up a periodic sampling of
637
statistics. As an example, an instance of the
638
historyControlInterval object might be named
639
historyControlInterval.2"
640
INDEX { historyControlIndex }
641
::= { historyControlTable 1 }
643
HistoryControlEntry ::= SEQUENCE {
644
historyControlIndex Integer32,
645
historyControlDataSource OBJECT IDENTIFIER,
646
historyControlBucketsRequested Integer32,
647
historyControlBucketsGranted Integer32,
648
historyControlInterval Integer32,
649
historyControlOwner OwnerString,
650
historyControlStatus EntryStatus
653
historyControlIndex OBJECT-TYPE
654
SYNTAX Integer32 (1..65535)
658
"An index that uniquely identifies an entry in the
659
historyControl table. Each such entry defines a
660
set of samples at a particular interval for an
661
interface on the device."
662
::= { historyControlEntry 1 }
664
historyControlDataSource OBJECT-TYPE
665
SYNTAX OBJECT IDENTIFIER
666
MAX-ACCESS read-create
669
"This object identifies the source of the data for
670
which historical data was collected and
671
placed in a media-specific table on behalf of this
672
historyControlEntry. This source can be any
673
interface on this device. In order to identify
675
a particular interface, this object shall identify
676
the instance of the ifIndex object, defined
677
in RFC 2233 [17], for the desired interface.
678
For example, if an entry were to receive data from
679
interface #1, this object would be set to ifIndex.1.
681
The statistics in this group reflect all packets
682
on the local network segment attached to the identified
685
An agent may or may not be able to tell if fundamental
686
changes to the media of the interface have occurred and
687
necessitate an invalidation of this entry. For example, a
688
hot-pluggable ethernet card could be pulled out and replaced
689
by a token-ring card. In such a case, if the agent has such
690
knowledge of the change, it is recommended that it
691
invalidate this entry.
693
This object may not be modified if the associated
694
historyControlStatus object is equal to valid(1)."
695
::= { historyControlEntry 2 }
697
historyControlBucketsRequested OBJECT-TYPE
698
SYNTAX Integer32 (1..65535)
699
MAX-ACCESS read-create
702
"The requested number of discrete time intervals
703
over which data is to be saved in the part of the
704
media-specific table associated with this
707
When this object is created or modified, the probe
708
should set historyControlBucketsGranted as closely to
709
this object as is possible for the particular probe
710
implementation and available resources."
712
::= { historyControlEntry 3 }
714
historyControlBucketsGranted OBJECT-TYPE
715
SYNTAX Integer32 (1..65535)
719
"The number of discrete sampling intervals
720
over which data shall be saved in the part of
721
the media-specific table associated with this
724
When the associated historyControlBucketsRequested
725
object is created or modified, the probe
726
should set this object as closely to the requested
727
value as is possible for the particular
728
probe implementation and available resources. The
729
probe must not lower this value except as a result
730
of a modification to the associated
731
historyControlBucketsRequested object.
733
There will be times when the actual number of
734
buckets associated with this entry is less than
735
the value of this object. In this case, at the
736
end of each sampling interval, a new bucket will
737
be added to the media-specific table.
739
When the number of buckets reaches the value of
740
this object and a new bucket is to be added to the
741
media-specific table, the oldest bucket associated
742
with this historyControlEntry shall be deleted by
743
the agent so that the new bucket can be added.
745
When the value of this object changes to a value less
746
than the current value, entries are deleted
747
from the media-specific table associated with this
748
historyControlEntry. Enough of the oldest of these
749
entries shall be deleted by the agent so that their
750
number remains less than or equal to the new value of
753
When the value of this object changes to a value greater
754
than the current value, the number of associated media-
755
specific entries may be allowed to grow."
756
::= { historyControlEntry 4 }
758
historyControlInterval OBJECT-TYPE
759
SYNTAX Integer32 (1..3600)
761
MAX-ACCESS read-create
764
"The interval in seconds over which the data is
765
sampled for each bucket in the part of the
766
media-specific table associated with this
767
historyControlEntry. This interval can
768
be set to any number of seconds between 1 and
771
Because the counters in a bucket may overflow at their
773
maximum value with no indication, a prudent manager will
774
take into account the possibility of overflow in any of
775
the associated counters. It is important to consider the
776
minimum time in which any counter could overflow on a
777
particular media type and set the historyControlInterval
778
object to a value less than this interval. This is
779
typically most important for the 'octets' counter in any
780
media-specific table. For example, on an Ethernet
781
network, the etherHistoryOctets counter could overflow
782
in about one hour at the Ethernet's maximum
785
This object may not be modified if the associated
786
historyControlStatus object is equal to valid(1)."
788
::= { historyControlEntry 5 }
790
historyControlOwner OBJECT-TYPE
792
MAX-ACCESS read-create
795
"The entity that configured this entry and is therefore
796
using the resources assigned to it."
797
::= { historyControlEntry 6 }
799
historyControlStatus OBJECT-TYPE
801
MAX-ACCESS read-create
804
"The status of this historyControl entry.
806
Each instance of the media-specific table associated
807
with this historyControlEntry will be deleted by the agent
808
if this historyControlEntry is not equal to valid(1)."
809
::= { historyControlEntry 7 }
811
-- The Ethernet History Group
813
-- Implementation of the Ethernet History group is optional.
814
-- Consult the MODULE-COMPLIANCE macro for the authoritative
815
-- conformance information for this MIB.
817
-- The Ethernet History group records periodic statistical samples
818
-- from a network and stores them for later retrieval.
819
-- Once samples are taken, their data is stored in an entry
820
-- in a media-specific table. Each such entry defines one
822
-- sample, and is associated with the historyControlEntry that
823
-- caused the sample to be taken. This group defines the
824
-- etherHistoryTable, for Ethernet networks.
827
etherHistoryTable OBJECT-TYPE
828
SYNTAX SEQUENCE OF EtherHistoryEntry
829
MAX-ACCESS not-accessible
832
"A list of Ethernet history entries."
835
etherHistoryEntry OBJECT-TYPE
836
SYNTAX EtherHistoryEntry
837
MAX-ACCESS not-accessible
840
"An historical sample of Ethernet statistics on a particular
841
Ethernet interface. This sample is associated with the
842
historyControlEntry which set up the parameters for
843
a regular collection of these samples. As an example, an
844
instance of the etherHistoryPkts object might be named
845
etherHistoryPkts.2.89"
846
INDEX { etherHistoryIndex , etherHistorySampleIndex }
847
::= { etherHistoryTable 1 }
849
EtherHistoryEntry ::= SEQUENCE {
850
etherHistoryIndex Integer32,
851
etherHistorySampleIndex Integer32,
852
etherHistoryIntervalStart TimeTicks,
853
etherHistoryDropEvents Counter32,
854
etherHistoryOctets Counter32,
855
etherHistoryPkts Counter32,
856
etherHistoryBroadcastPkts Counter32,
857
etherHistoryMulticastPkts Counter32,
858
etherHistoryCRCAlignErrors Counter32,
859
etherHistoryUndersizePkts Counter32,
860
etherHistoryOversizePkts Counter32,
861
etherHistoryFragments Counter32,
862
etherHistoryJabbers Counter32,
863
etherHistoryCollisions Counter32,
864
etherHistoryUtilization Integer32
867
etherHistoryIndex OBJECT-TYPE
868
SYNTAX Integer32 (1..65535)
872
"The history of which this entry is a part. The
873
history identified by a particular value of this
874
index is the same history as identified
875
by the same value of historyControlIndex."
876
::= { etherHistoryEntry 1 }
878
etherHistorySampleIndex OBJECT-TYPE
879
SYNTAX Integer32 (1..2147483647)
883
"An index that uniquely identifies the particular
884
sample this entry represents among all samples
885
associated with the same historyControlEntry.
886
This index starts at 1 and increases by one
887
as each new sample is taken."
888
::= { etherHistoryEntry 2 }
890
etherHistoryIntervalStart OBJECT-TYPE
895
"The value of sysUpTime at the start of the interval
896
over which this sample was measured. If the probe
897
keeps track of the time of day, it should start
898
the first sample of the history at a time such that
899
when the next hour of the day begins, a sample is
900
started at that instant. Note that following this
901
rule may require the probe to delay collecting the
902
first sample of the history, as each sample must be
903
of the same interval. Also note that the sample which
904
is currently being collected is not accessible in this
905
table until the end of its interval."
906
::= { etherHistoryEntry 3 }
908
etherHistoryDropEvents OBJECT-TYPE
913
"The total number of events in which packets
914
were dropped by the probe due to lack of resources
915
during this sampling interval. Note that this number
916
is not necessarily the number of packets dropped, it
917
is just the number of times this condition has been
920
::= { etherHistoryEntry 4 }
922
etherHistoryOctets OBJECT-TYPE
928
"The total number of octets of data (including
929
those in bad packets) received on the
930
network (excluding framing bits but including
932
::= { etherHistoryEntry 5 }
934
etherHistoryPkts OBJECT-TYPE
940
"The number of packets (including bad packets)
941
received during this sampling interval."
942
::= { etherHistoryEntry 6 }
944
etherHistoryBroadcastPkts OBJECT-TYPE
950
"The number of good packets received during this
951
sampling interval that were directed to the
953
::= { etherHistoryEntry 7 }
955
etherHistoryMulticastPkts OBJECT-TYPE
961
"The number of good packets received during this
962
sampling interval that were directed to a
963
multicast address. Note that this number does not
964
include packets addressed to the broadcast address."
965
::= { etherHistoryEntry 8 }
967
etherHistoryCRCAlignErrors OBJECT-TYPE
973
"The number of packets received during this
974
sampling interval that had a length (excluding
975
framing bits but including FCS octets) between
976
64 and 1518 octets, inclusive, but had either a bad Frame
977
Check Sequence (FCS) with an integral number of octets
978
(FCS Error) or a bad FCS with a non-integral number
979
of octets (Alignment Error)."
980
::= { etherHistoryEntry 9 }
982
etherHistoryUndersizePkts OBJECT-TYPE
988
"The number of packets received during this
989
sampling interval that were less than 64 octets
990
long (excluding framing bits but including FCS
991
octets) and were otherwise well formed."
992
::= { etherHistoryEntry 10 }
994
etherHistoryOversizePkts OBJECT-TYPE
1000
"The number of packets received during this
1001
sampling interval that were longer than 1518
1002
octets (excluding framing bits but including
1003
FCS octets) but were otherwise well formed."
1004
::= { etherHistoryEntry 11 }
1006
etherHistoryFragments OBJECT-TYPE
1009
MAX-ACCESS read-only
1012
"The total number of packets received during this
1013
sampling interval that were less than 64 octets in
1014
length (excluding framing bits but including FCS
1016
octets) had either a bad Frame Check Sequence (FCS)
1017
with an integral number of octets (FCS Error) or a bad
1018
FCS with a non-integral number of octets (Alignment
1021
Note that it is entirely normal for etherHistoryFragments to
1022
increment. This is because it counts both runts (which are
1023
normal occurrences due to collisions) and noise hits."
1024
::= { etherHistoryEntry 12 }
1026
etherHistoryJabbers OBJECT-TYPE
1029
MAX-ACCESS read-only
1032
"The number of packets received during this
1033
sampling interval that were longer than 1518 octets
1034
(excluding framing bits but including FCS octets),
1035
and had either a bad Frame Check Sequence (FCS)
1036
with an integral number of octets (FCS Error) or
1037
a bad FCS with a non-integral number of octets
1040
Note that this definition of jabber is different
1041
than the definition in IEEE-802.3 section 8.2.1.5
1042
(10BASE5) and section 10.3.1.4 (10BASE2). These
1043
documents define jabber as the condition where any
1044
packet exceeds 20 ms. The allowed range to detect
1045
jabber is between 20 ms and 150 ms."
1046
::= { etherHistoryEntry 13 }
1048
etherHistoryCollisions OBJECT-TYPE
1051
MAX-ACCESS read-only
1054
"The best estimate of the total number of collisions
1055
on this Ethernet segment during this sampling
1058
The value returned will depend on the location of the
1059
RMON probe. Section 8.2.1.3 (10BASE-5) and section
1060
10.3.1.3 (10BASE-2) of IEEE standard 802.3 states that a
1061
station must detect a collision, in the receive mode, if
1062
three or more stations are transmitting simultaneously. A
1063
repeater port must detect a collision when two or more
1065
stations are transmitting simultaneously. Thus a probe
1066
placed on a repeater port could record more collisions
1067
than a probe connected to a station on the same segment
1070
Probe location plays a much smaller role when considering
1071
10BASE-T. 14.2.1.4 (10BASE-T) of IEEE standard 802.3
1072
defines a collision as the simultaneous presence of signals
1073
on the DO and RD circuits (transmitting and receiving
1074
at the same time). A 10BASE-T station can only detect
1075
collisions when it is transmitting. Thus probes placed on
1076
a station and a repeater, should report the same number of
1079
Note also that an RMON probe inside a repeater should
1080
ideally report collisions between the repeater and one or
1081
more other hosts (transmit collisions as defined by IEEE
1082
802.3k) plus receiver collisions observed on any coax
1083
segments to which the repeater is connected."
1084
::= { etherHistoryEntry 14 }
1086
etherHistoryUtilization OBJECT-TYPE
1087
SYNTAX Integer32 (0..10000)
1088
MAX-ACCESS read-only
1091
"The best estimate of the mean physical layer
1092
network utilization on this interface during this
1093
sampling interval, in hundredths of a percent."
1094
::= { etherHistoryEntry 15 }
1098
-- Implementation of the Alarm group is optional. The Alarm Group
1099
-- requires the implementation of the Event group.
1100
-- Consult the MODULE-COMPLIANCE macro for the authoritative
1101
-- conformance information for this MIB.
1103
-- The Alarm group periodically takes statistical samples from
1104
-- variables in the probe and compares them to thresholds that have
1105
-- been configured. The alarm table stores configuration
1106
-- entries that each define a variable, polling period, and
1107
-- threshold parameters. If a sample is found to cross the
1108
-- threshold values, an event is generated. Only variables that
1109
-- resolve to an ASN.1 primitive type of INTEGER (INTEGER, Integer32,
1110
-- Counter32, Counter64, Gauge32, or TimeTicks) may be monitored in
1114
-- This function has a hysteresis mechanism to limit the generation
1115
-- of events. This mechanism generates one event as a threshold
1116
-- is crossed in the appropriate direction. No more events are
1117
-- generated for that threshold until the opposite threshold is
1120
-- In the case of a sampling a deltaValue, a probe may implement
1121
-- this mechanism with more precision if it takes a delta sample
1122
-- twice per period, each time comparing the sum of the latest two
1123
-- samples to the threshold. This allows the detection of threshold
1124
-- crossings that span the sampling boundary. Note that this does
1125
-- not require any special configuration of the threshold value.
1126
-- It is suggested that probes implement this more precise algorithm.
1128
alarmTable OBJECT-TYPE
1129
SYNTAX SEQUENCE OF AlarmEntry
1130
MAX-ACCESS not-accessible
1133
"A list of alarm entries."
1136
alarmEntry OBJECT-TYPE
1138
MAX-ACCESS not-accessible
1141
"A list of parameters that set up a periodic checking
1142
for alarm conditions. For example, an instance of the
1143
alarmValue object might be named alarmValue.8"
1144
INDEX { alarmIndex }
1145
::= { alarmTable 1 }
1147
AlarmEntry ::= SEQUENCE {
1148
alarmIndex Integer32,
1149
alarmInterval Integer32,
1150
alarmVariable OBJECT IDENTIFIER,
1151
alarmSampleType INTEGER,
1152
alarmValue Integer32,
1153
alarmStartupAlarm INTEGER,
1154
alarmRisingThreshold Integer32,
1155
alarmFallingThreshold Integer32,
1156
alarmRisingEventIndex Integer32,
1157
alarmFallingEventIndex Integer32,
1158
alarmOwner OwnerString,
1159
alarmStatus EntryStatus
1162
alarmIndex OBJECT-TYPE
1163
SYNTAX Integer32 (1..65535)
1164
MAX-ACCESS read-only
1167
"An index that uniquely identifies an entry in the
1168
alarm table. Each such entry defines a
1169
diagnostic sample at a particular interval
1170
for an object on the device."
1171
::= { alarmEntry 1 }
1173
alarmInterval OBJECT-TYPE
1176
MAX-ACCESS read-create
1179
"The interval in seconds over which the data is
1180
sampled and compared with the rising and falling
1181
thresholds. When setting this variable, care
1182
should be taken in the case of deltaValue
1183
sampling - the interval should be set short enough
1184
that the sampled variable is very unlikely to
1185
increase or decrease by more than 2^31 - 1 during
1186
a single sampling interval.
1188
This object may not be modified if the associated
1189
alarmStatus object is equal to valid(1)."
1190
::= { alarmEntry 2 }
1192
alarmVariable OBJECT-TYPE
1193
SYNTAX OBJECT IDENTIFIER
1194
MAX-ACCESS read-create
1197
"The object identifier of the particular variable to be
1198
sampled. Only variables that resolve to an ASN.1 primitive
1199
type of INTEGER (INTEGER, Integer32, Counter32, Counter64,
1200
Gauge, or TimeTicks) may be sampled.
1202
Because SNMP access control is articulated entirely
1203
in terms of the contents of MIB views, no access
1204
control mechanism exists that can restrict the value of
1205
this object to identify only those objects that exist
1206
in a particular MIB view. Because there is thus no
1207
acceptable means of restricting the read access that
1208
could be obtained through the alarm mechanism, the
1209
probe must only grant write access to this object in
1211
those views that have read access to all objects on
1214
During a set operation, if the supplied variable name is
1215
not available in the selected MIB view, a badValue error
1216
must be returned. If at any time the variable name of
1217
an established alarmEntry is no longer available in the
1218
selected MIB view, the probe must change the status of
1219
this alarmEntry to invalid(4).
1221
This object may not be modified if the associated
1222
alarmStatus object is equal to valid(1)."
1223
::= { alarmEntry 3 }
1225
alarmSampleType OBJECT-TYPE
1230
MAX-ACCESS read-create
1233
"The method of sampling the selected variable and
1234
calculating the value to be compared against the
1235
thresholds. If the value of this object is
1236
absoluteValue(1), the value of the selected variable
1237
will be compared directly with the thresholds at the
1238
end of the sampling interval. If the value of this
1239
object is deltaValue(2), the value of the selected
1240
variable at the last sample will be subtracted from
1241
the current value, and the difference compared with
1244
This object may not be modified if the associated
1245
alarmStatus object is equal to valid(1)."
1246
::= { alarmEntry 4 }
1248
alarmValue OBJECT-TYPE
1250
MAX-ACCESS read-only
1253
"The value of the statistic during the last sampling
1254
period. For example, if the sample type is deltaValue,
1255
this value will be the difference between the samples
1256
at the beginning and end of the period. If the sample
1257
type is absoluteValue, this value will be the sampled
1258
value at the end of the period.
1260
This is the value that is compared with the rising and
1263
The value during the current sampling period is not
1264
made available until the period is completed and will
1265
remain available until the next period completes."
1266
::= { alarmEntry 5 }
1268
alarmStartupAlarm OBJECT-TYPE
1272
risingOrFallingAlarm(3)
1274
MAX-ACCESS read-create
1277
"The alarm that may be sent when this entry is first
1278
set to valid. If the first sample after this entry
1279
becomes valid is greater than or equal to the
1280
risingThreshold and alarmStartupAlarm is equal to
1281
risingAlarm(1) or risingOrFallingAlarm(3), then a single
1282
rising alarm will be generated. If the first sample
1283
after this entry becomes valid is less than or equal
1284
to the fallingThreshold and alarmStartupAlarm is equal
1285
to fallingAlarm(2) or risingOrFallingAlarm(3), then a
1286
single falling alarm will be generated.
1288
This object may not be modified if the associated
1289
alarmStatus object is equal to valid(1)."
1290
::= { alarmEntry 6 }
1292
alarmRisingThreshold OBJECT-TYPE
1294
MAX-ACCESS read-create
1297
"A threshold for the sampled statistic. When the current
1298
sampled value is greater than or equal to this threshold,
1299
and the value at the last sampling interval was less than
1300
this threshold, a single event will be generated.
1301
A single event will also be generated if the first
1302
sample after this entry becomes valid is greater than or
1303
equal to this threshold and the associated
1304
alarmStartupAlarm is equal to risingAlarm(1) or
1305
risingOrFallingAlarm(3).
1307
After a rising event is generated, another such event
1309
will not be generated until the sampled value
1310
falls below this threshold and reaches the
1311
alarmFallingThreshold.
1313
This object may not be modified if the associated
1314
alarmStatus object is equal to valid(1)."
1315
::= { alarmEntry 7 }
1317
alarmFallingThreshold OBJECT-TYPE
1319
MAX-ACCESS read-create
1322
"A threshold for the sampled statistic. When the current
1323
sampled value is less than or equal to this threshold,
1324
and the value at the last sampling interval was greater than
1325
this threshold, a single event will be generated.
1326
A single event will also be generated if the first
1327
sample after this entry becomes valid is less than or
1328
equal to this threshold and the associated
1329
alarmStartupAlarm is equal to fallingAlarm(2) or
1330
risingOrFallingAlarm(3).
1332
After a falling event is generated, another such event
1333
will not be generated until the sampled value
1334
rises above this threshold and reaches the
1335
alarmRisingThreshold.
1337
This object may not be modified if the associated
1338
alarmStatus object is equal to valid(1)."
1339
::= { alarmEntry 8 }
1341
alarmRisingEventIndex OBJECT-TYPE
1342
SYNTAX Integer32 (0..65535)
1343
MAX-ACCESS read-create
1346
"The index of the eventEntry that is
1347
used when a rising threshold is crossed. The
1348
eventEntry identified by a particular value of
1349
this index is the same as identified by the same value
1350
of the eventIndex object. If there is no
1351
corresponding entry in the eventTable, then
1352
no association exists. In particular, if this value
1353
is zero, no associated event will be generated, as
1354
zero is not a valid event index.
1356
This object may not be modified if the associated
1358
alarmStatus object is equal to valid(1)."
1359
::= { alarmEntry 9 }
1361
alarmFallingEventIndex OBJECT-TYPE
1362
SYNTAX Integer32 (0..65535)
1363
MAX-ACCESS read-create
1366
"The index of the eventEntry that is
1367
used when a falling threshold is crossed. The
1368
eventEntry identified by a particular value of
1369
this index is the same as identified by the same value
1370
of the eventIndex object. If there is no
1371
corresponding entry in the eventTable, then
1372
no association exists. In particular, if this value
1373
is zero, no associated event will be generated, as
1374
zero is not a valid event index.
1376
This object may not be modified if the associated
1377
alarmStatus object is equal to valid(1)."
1378
::= { alarmEntry 10 }
1380
alarmOwner OBJECT-TYPE
1382
MAX-ACCESS read-create
1385
"The entity that configured this entry and is therefore
1386
using the resources assigned to it."
1387
::= { alarmEntry 11 }
1389
alarmStatus OBJECT-TYPE
1391
MAX-ACCESS read-create
1394
"The status of this alarm entry."
1395
::= { alarmEntry 12 }
1399
-- Implementation of the Host group is optional.
1400
-- Consult the MODULE-COMPLIANCE macro for the authoritative
1401
-- conformance information for this MIB.
1403
-- The host group discovers new hosts on the network by
1404
-- keeping a list of source and destination MAC Addresses seen
1405
-- in good packets. For each of these addresses, the host group
1407
-- keeps a set of statistics. The hostControlTable controls
1408
-- which interfaces this function is performed on, and contains
1409
-- some information about the process. On behalf of each
1410
-- hostControlEntry, data is collected on an interface and placed
1411
-- in both the hostTable and the hostTimeTable. If the
1412
-- monitoring device finds itself short of resources, it may
1413
-- delete entries as needed. It is suggested that the device
1414
-- delete the least recently used entries first.
1416
-- The hostTable contains entries for each address discovered on
1417
-- a particular interface. Each entry contains statistical
1418
-- data about that host. This table is indexed by the
1419
-- MAC address of the host, through which a random access
1422
-- The hostTimeTable contains data in the same format as the
1423
-- hostTable, and must contain the same set of hosts, but is
1424
-- indexed using hostTimeCreationOrder rather than hostAddress.
1425
-- The hostTimeCreationOrder is an integer which reflects
1426
-- the relative order in which a particular entry was discovered
1427
-- and thus inserted into the table. As this order, and thus
1428
-- the index, is among those entries currently in the table,
1429
-- the index for a particular entry may change if an
1430
-- (earlier) entry is deleted. Thus the association between
1431
-- hostTimeCreationOrder and hostTimeEntry may be broken at
1434
-- The hostTimeTable has two important uses. The first is the
1435
-- fast download of this potentially large table. Because the
1436
-- index of this table runs from 1 to the size of the table,
1437
-- inclusive, its values are predictable. This allows very
1438
-- efficient packing of variables into SNMP PDU's and allows
1439
-- a table transfer to have multiple packets outstanding.
1440
-- These benefits increase transfer rates tremendously.
1442
-- The second use of the hostTimeTable is the efficient discovery
1443
-- by the management station of new entries added to the table.
1444
-- After the management station has downloaded the entire table,
1445
-- it knows that new entries will be added immediately after the
1446
-- end of the current table. It can thus detect new entries there
1447
-- and retrieve them easily.
1449
-- Because the association between hostTimeCreationOrder and
1450
-- hostTimeEntry may be broken at any time, the management
1451
-- station must monitor the related hostControlLastDeleteTime
1452
-- object. When the management station thus detects a deletion,
1453
-- it must assume that any such associations have been broken,
1454
-- and invalidate any it has stored locally. This includes
1456
-- restarting any download of the hostTimeTable that may have been
1457
-- in progress, as well as rediscovering the end of the
1458
-- hostTimeTable so that it may detect new entries. If the
1459
-- management station does not detect the broken association,
1460
-- it may continue to refer to a particular host by its
1461
-- creationOrder while unwittingly retrieving the data associated
1462
-- with another host entirely. If this happens while downloading
1463
-- the host table, the management station may fail to download
1464
-- all of the entries in the table.
1466
hostControlTable OBJECT-TYPE
1467
SYNTAX SEQUENCE OF HostControlEntry
1468
MAX-ACCESS not-accessible
1471
"A list of host table control entries."
1474
hostControlEntry OBJECT-TYPE
1475
SYNTAX HostControlEntry
1476
MAX-ACCESS not-accessible
1479
"A list of parameters that set up the discovery of hosts
1480
on a particular interface and the collection of statistics
1481
about these hosts. For example, an instance of the
1482
hostControlTableSize object might be named
1483
hostControlTableSize.1"
1484
INDEX { hostControlIndex }
1485
::= { hostControlTable 1 }
1487
HostControlEntry ::= SEQUENCE {
1489
hostControlIndex Integer32,
1490
hostControlDataSource OBJECT IDENTIFIER,
1491
hostControlTableSize Integer32,
1492
hostControlLastDeleteTime TimeTicks,
1493
hostControlOwner OwnerString,
1494
hostControlStatus EntryStatus
1497
hostControlIndex OBJECT-TYPE
1498
SYNTAX Integer32 (1..65535)
1499
MAX-ACCESS read-only
1502
"An index that uniquely identifies an entry in the
1504
hostControl table. Each such entry defines
1505
a function that discovers hosts on a particular interface
1506
and places statistics about them in the hostTable and
1507
the hostTimeTable on behalf of this hostControlEntry."
1508
::= { hostControlEntry 1 }
1510
hostControlDataSource OBJECT-TYPE
1511
SYNTAX OBJECT IDENTIFIER
1512
MAX-ACCESS read-create
1515
"This object identifies the source of the data for
1516
this instance of the host function. This source
1517
can be any interface on this device. In order
1518
to identify a particular interface, this object shall
1519
identify the instance of the ifIndex object, defined
1520
in RFC 2233 [17], for the desired interface.
1521
For example, if an entry were to receive data from
1522
interface #1, this object would be set to ifIndex.1.
1524
The statistics in this group reflect all packets
1525
on the local network segment attached to the identified
1528
An agent may or may not be able to tell if fundamental
1529
changes to the media of the interface have occurred and
1530
necessitate an invalidation of this entry. For example, a
1531
hot-pluggable ethernet card could be pulled out and replaced
1532
by a token-ring card. In such a case, if the agent has such
1533
knowledge of the change, it is recommended that it
1534
invalidate this entry.
1536
This object may not be modified if the associated
1537
hostControlStatus object is equal to valid(1)."
1538
::= { hostControlEntry 2 }
1540
hostControlTableSize OBJECT-TYPE
1542
MAX-ACCESS read-only
1545
"The number of hostEntries in the hostTable and the
1546
hostTimeTable associated with this hostControlEntry."
1547
::= { hostControlEntry 3 }
1549
hostControlLastDeleteTime OBJECT-TYPE
1551
MAX-ACCESS read-only
1554
"The value of sysUpTime when the last entry
1555
was deleted from the portion of the hostTable
1556
associated with this hostControlEntry. If no
1557
deletions have occurred, this value shall be zero."
1558
::= { hostControlEntry 4 }
1560
hostControlOwner OBJECT-TYPE
1562
MAX-ACCESS read-create
1565
"The entity that configured this entry and is therefore
1566
using the resources assigned to it."
1567
::= { hostControlEntry 5 }
1569
hostControlStatus OBJECT-TYPE
1571
MAX-ACCESS read-create
1574
"The status of this hostControl entry.
1576
If this object is not equal to valid(1), all associated
1577
entries in the hostTable, hostTimeTable, and the
1578
hostTopNTable shall be deleted by the agent."
1579
::= { hostControlEntry 6 }
1581
hostTable OBJECT-TYPE
1582
SYNTAX SEQUENCE OF HostEntry
1583
MAX-ACCESS not-accessible
1586
"A list of host entries."
1589
hostEntry OBJECT-TYPE
1591
MAX-ACCESS not-accessible
1594
"A collection of statistics for a particular host that has
1595
been discovered on an interface of this device. For example,
1596
an instance of the hostOutBroadcastPkts object might be
1597
named hostOutBroadcastPkts.1.6.8.0.32.27.3.176"
1598
INDEX { hostIndex, hostAddress }
1601
HostEntry ::= SEQUENCE {
1602
hostAddress OCTET STRING,
1603
hostCreationOrder Integer32,
1604
hostIndex Integer32,
1605
hostInPkts Counter32,
1606
hostOutPkts Counter32,
1607
hostInOctets Counter32,
1608
hostOutOctets Counter32,
1609
hostOutErrors Counter32,
1610
hostOutBroadcastPkts Counter32,
1611
hostOutMulticastPkts Counter32
1614
hostAddress OBJECT-TYPE
1616
MAX-ACCESS read-only
1619
"The physical address of this host."
1622
hostCreationOrder OBJECT-TYPE
1623
SYNTAX Integer32 (1..65535)
1624
MAX-ACCESS read-only
1627
"An index that defines the relative ordering of
1628
the creation time of hosts captured for a
1629
particular hostControlEntry. This index shall
1630
be between 1 and N, where N is the value of
1631
the associated hostControlTableSize. The ordering
1632
of the indexes is based on the order of each entry's
1633
insertion into the table, in which entries added earlier
1634
have a lower index value than entries added later.
1636
It is important to note that the order for a
1637
particular entry may change as an (earlier) entry
1638
is deleted from the table. Because this order may
1639
change, management stations should make use of the
1640
hostControlLastDeleteTime variable in the
1641
hostControlEntry associated with the relevant
1642
portion of the hostTable. By observing
1643
this variable, the management station may detect
1644
the circumstances where a previous association
1645
between a value of hostCreationOrder
1646
and a hostEntry may no longer hold."
1649
hostIndex OBJECT-TYPE
1650
SYNTAX Integer32 (1..65535)
1651
MAX-ACCESS read-only
1654
"The set of collected host statistics of which
1655
this entry is a part. The set of hosts
1656
identified by a particular value of this
1657
index is associated with the hostControlEntry
1658
as identified by the same value of hostControlIndex."
1661
hostInPkts OBJECT-TYPE
1664
MAX-ACCESS read-only
1667
"The number of good packets transmitted to this
1668
address since it was added to the hostTable."
1671
hostOutPkts OBJECT-TYPE
1674
MAX-ACCESS read-only
1677
"The number of packets, including bad packets, transmitted
1678
by this address since it was added to the hostTable."
1681
hostInOctets OBJECT-TYPE
1684
MAX-ACCESS read-only
1687
"The number of octets transmitted to this address since
1688
it was added to the hostTable (excluding framing
1689
bits but including FCS octets), except for those
1690
octets in bad packets."
1693
hostOutOctets OBJECT-TYPE
1696
MAX-ACCESS read-only
1699
"The number of octets transmitted by this address since
1700
it was added to the hostTable (excluding framing
1701
bits but including FCS octets), including those
1702
octets in bad packets."
1705
hostOutErrors OBJECT-TYPE
1708
MAX-ACCESS read-only
1711
"The number of bad packets transmitted by this address
1712
since this host was added to the hostTable."
1715
hostOutBroadcastPkts OBJECT-TYPE
1718
MAX-ACCESS read-only
1721
"The number of good packets transmitted by this
1722
address that were directed to the broadcast address
1723
since this host was added to the hostTable."
1726
hostOutMulticastPkts OBJECT-TYPE
1729
MAX-ACCESS read-only
1732
"The number of good packets transmitted by this
1733
address that were directed to a multicast address
1734
since this host was added to the hostTable.
1735
Note that this number does not include packets
1736
directed to the broadcast address."
1737
::= { hostEntry 10 }
1741
hostTimeTable OBJECT-TYPE
1742
SYNTAX SEQUENCE OF HostTimeEntry
1743
MAX-ACCESS not-accessible
1746
"A list of time-ordered host table entries."
1749
hostTimeEntry OBJECT-TYPE
1750
SYNTAX HostTimeEntry
1751
MAX-ACCESS not-accessible
1754
"A collection of statistics for a particular host that has
1755
been discovered on an interface of this device. This
1756
collection includes the relative ordering of the creation
1757
time of this object. For example, an instance of the
1758
hostTimeOutBroadcastPkts object might be named
1759
hostTimeOutBroadcastPkts.1.687"
1760
INDEX { hostTimeIndex, hostTimeCreationOrder }
1761
::= { hostTimeTable 1 }
1763
HostTimeEntry ::= SEQUENCE {
1764
hostTimeAddress OCTET STRING,
1765
hostTimeCreationOrder Integer32,
1766
hostTimeIndex Integer32,
1767
hostTimeInPkts Counter32,
1768
hostTimeOutPkts Counter32,
1769
hostTimeInOctets Counter32,
1770
hostTimeOutOctets Counter32,
1771
hostTimeOutErrors Counter32,
1772
hostTimeOutBroadcastPkts Counter32,
1773
hostTimeOutMulticastPkts Counter32
1776
hostTimeAddress OBJECT-TYPE
1778
MAX-ACCESS read-only
1781
"The physical address of this host."
1782
::= { hostTimeEntry 1 }
1784
hostTimeCreationOrder OBJECT-TYPE
1785
SYNTAX Integer32 (1..65535)
1786
MAX-ACCESS read-only
1789
"An index that uniquely identifies an entry in
1790
the hostTime table among those entries associated
1791
with the same hostControlEntry. This index shall
1792
be between 1 and N, where N is the value of
1794
the associated hostControlTableSize. The ordering
1795
of the indexes is based on the order of each entry's
1796
insertion into the table, in which entries added earlier
1797
have a lower index value than entries added later.
1798
Thus the management station has the ability to
1799
learn of new entries added to this table without
1800
downloading the entire table.
1802
It is important to note that the index for a
1803
particular entry may change as an (earlier) entry
1804
is deleted from the table. Because this order may
1805
change, management stations should make use of the
1806
hostControlLastDeleteTime variable in the
1807
hostControlEntry associated with the relevant
1808
portion of the hostTimeTable. By observing
1809
this variable, the management station may detect
1810
the circumstances where a download of the table
1811
may have missed entries, and where a previous
1812
association between a value of hostTimeCreationOrder
1813
and a hostTimeEntry may no longer hold."
1814
::= { hostTimeEntry 2 }
1816
hostTimeIndex OBJECT-TYPE
1817
SYNTAX Integer32 (1..65535)
1818
MAX-ACCESS read-only
1821
"The set of collected host statistics of which
1822
this entry is a part. The set of hosts
1823
identified by a particular value of this
1824
index is associated with the hostControlEntry
1825
as identified by the same value of hostControlIndex."
1826
::= { hostTimeEntry 3 }
1828
hostTimeInPkts OBJECT-TYPE
1831
MAX-ACCESS read-only
1834
"The number of good packets transmitted to this
1835
address since it was added to the hostTimeTable."
1836
::= { hostTimeEntry 4 }
1838
hostTimeOutPkts OBJECT-TYPE
1841
MAX-ACCESS read-only
1844
"The number of packets, including bad packets, transmitted
1845
by this address since it was added to the hostTimeTable."
1846
::= { hostTimeEntry 5 }
1848
hostTimeInOctets OBJECT-TYPE
1851
MAX-ACCESS read-only
1854
"The number of octets transmitted to this address since
1855
it was added to the hostTimeTable (excluding framing
1856
bits but including FCS octets), except for those
1857
octets in bad packets."
1858
::= { hostTimeEntry 6 }
1860
hostTimeOutOctets OBJECT-TYPE
1863
MAX-ACCESS read-only
1866
"The number of octets transmitted by this address since
1867
it was added to the hostTimeTable (excluding framing
1868
bits but including FCS octets), including those
1869
octets in bad packets."
1870
::= { hostTimeEntry 7 }
1872
hostTimeOutErrors OBJECT-TYPE
1875
MAX-ACCESS read-only
1878
"The number of bad packets transmitted by this address
1879
since this host was added to the hostTimeTable."
1880
::= { hostTimeEntry 8 }
1882
hostTimeOutBroadcastPkts OBJECT-TYPE
1885
MAX-ACCESS read-only
1888
"The number of good packets transmitted by this
1889
address that were directed to the broadcast address
1891
since this host was added to the hostTimeTable."
1892
::= { hostTimeEntry 9 }
1894
hostTimeOutMulticastPkts OBJECT-TYPE
1897
MAX-ACCESS read-only
1900
"The number of good packets transmitted by this
1901
address that were directed to a multicast address
1902
since this host was added to the hostTimeTable.
1903
Note that this number does not include packets directed
1904
to the broadcast address."
1905
::= { hostTimeEntry 10 }
1907
-- The Host Top "N" Group
1909
-- Implementation of the Host Top N group is optional. The Host Top N
1910
-- group requires the implementation of the host group.
1911
-- Consult the MODULE-COMPLIANCE macro for the authoritative
1912
-- conformance information for this MIB.
1914
-- The Host Top N group is used to prepare reports that describe
1915
-- the hosts that top a list ordered by one of their statistics.
1916
-- The available statistics are samples of one of their
1917
-- base statistics, over an interval specified by the management
1918
-- station. Thus, these statistics are rate based. The management
1919
-- station also selects how many such hosts are reported.
1921
-- The hostTopNControlTable is used to initiate the generation of
1922
-- such a report. The management station may select the parameters
1923
-- of such a report, such as which interface, which statistic,
1924
-- how many hosts, and the start and stop times of the sampling.
1925
-- When the report is prepared, entries are created in the
1926
-- hostTopNTable associated with the relevant hostTopNControlEntry.
1927
-- These entries are static for each report after it has been
1930
hostTopNControlTable OBJECT-TYPE
1931
SYNTAX SEQUENCE OF HostTopNControlEntry
1932
MAX-ACCESS not-accessible
1935
"A list of top N host control entries."
1938
hostTopNControlEntry OBJECT-TYPE
1939
SYNTAX HostTopNControlEntry
1940
MAX-ACCESS not-accessible
1943
"A set of parameters that control the creation of a report
1944
of the top N hosts according to several metrics. For
1945
example, an instance of the hostTopNDuration object might
1946
be named hostTopNDuration.3"
1947
INDEX { hostTopNControlIndex }
1948
::= { hostTopNControlTable 1 }
1950
HostTopNControlEntry ::= SEQUENCE {
1951
hostTopNControlIndex Integer32,
1952
hostTopNHostIndex Integer32,
1953
hostTopNRateBase INTEGER,
1954
hostTopNTimeRemaining Integer32,
1955
hostTopNDuration Integer32,
1956
hostTopNRequestedSize Integer32,
1957
hostTopNGrantedSize Integer32,
1958
hostTopNStartTime TimeTicks,
1959
hostTopNOwner OwnerString,
1960
hostTopNStatus EntryStatus
1963
hostTopNControlIndex OBJECT-TYPE
1964
SYNTAX Integer32 (1..65535)
1965
MAX-ACCESS read-only
1968
"An index that uniquely identifies an entry
1969
in the hostTopNControl table. Each such
1970
entry defines one top N report prepared for
1972
::= { hostTopNControlEntry 1 }
1974
hostTopNHostIndex OBJECT-TYPE
1975
SYNTAX Integer32 (1..65535)
1976
MAX-ACCESS read-create
1979
"The host table for which a top N report will be prepared
1980
on behalf of this entry. The host table identified by a
1981
particular value of this index is associated with the same
1982
host table as identified by the same value of
1985
This object may not be modified if the associated
1986
hostTopNStatus object is equal to valid(1)."
1987
::= { hostTopNControlEntry 2 }
1989
hostTopNRateBase OBJECT-TYPE
1993
hostTopNInOctets(3),
1994
hostTopNOutOctets(4),
1995
hostTopNOutErrors(5),
1996
hostTopNOutBroadcastPkts(6),
1997
hostTopNOutMulticastPkts(7)
1999
MAX-ACCESS read-create
2002
"The variable for each host that the hostTopNRate
2003
variable is based upon.
2005
This object may not be modified if the associated
2006
hostTopNStatus object is equal to valid(1)."
2007
::= { hostTopNControlEntry 3 }
2009
hostTopNTimeRemaining OBJECT-TYPE
2012
MAX-ACCESS read-create
2015
"The number of seconds left in the report currently being
2016
collected. When this object is modified by the management
2017
station, a new collection is started, possibly aborting
2018
a currently running report. The new value is used
2019
as the requested duration of this report, which is
2020
loaded into the associated hostTopNDuration object.
2022
When this object is set to a non-zero value, any
2023
associated hostTopNEntries shall be made
2024
inaccessible by the monitor. While the value of this
2025
object is non-zero, it decrements by one per second until
2026
it reaches zero. During this time, all associated
2027
hostTopNEntries shall remain inaccessible. At the time
2028
that this object decrements to zero, the report is made
2029
accessible in the hostTopNTable. Thus, the hostTopN
2030
table needs to be created only at the end of the collection
2033
::= { hostTopNControlEntry 4 }
2035
hostTopNDuration OBJECT-TYPE
2038
MAX-ACCESS read-only
2041
"The number of seconds that this report has collected
2042
during the last sampling interval, or if this
2043
report is currently being collected, the number
2044
of seconds that this report is being collected
2045
during this sampling interval.
2047
When the associated hostTopNTimeRemaining object is set,
2048
this object shall be set by the probe to the same value
2049
and shall not be modified until the next time
2050
the hostTopNTimeRemaining is set.
2052
This value shall be zero if no reports have been
2053
requested for this hostTopNControlEntry."
2055
::= { hostTopNControlEntry 5 }
2057
hostTopNRequestedSize OBJECT-TYPE
2059
MAX-ACCESS read-create
2062
"The maximum number of hosts requested for the top N
2065
When this object is created or modified, the probe
2066
should set hostTopNGrantedSize as closely to this
2067
object as is possible for the particular probe
2068
implementation and available resources."
2070
::= { hostTopNControlEntry 6 }
2072
hostTopNGrantedSize OBJECT-TYPE
2074
MAX-ACCESS read-only
2077
"The maximum number of hosts in the top N table.
2079
When the associated hostTopNRequestedSize object is
2080
created or modified, the probe should set this
2081
object as closely to the requested value as is possible
2082
for the particular implementation and available
2084
resources. The probe must not lower this value except
2085
as a result of a set to the associated
2086
hostTopNRequestedSize object.
2088
Hosts with the highest value of hostTopNRate shall be
2089
placed in this table in decreasing order of this rate
2090
until there is no more room or until there are no more
2092
::= { hostTopNControlEntry 7 }
2094
hostTopNStartTime OBJECT-TYPE
2096
MAX-ACCESS read-only
2099
"The value of sysUpTime when this top N report was
2100
last started. In other words, this is the time that
2101
the associated hostTopNTimeRemaining object was
2102
modified to start the requested report."
2103
::= { hostTopNControlEntry 8 }
2105
hostTopNOwner OBJECT-TYPE
2107
MAX-ACCESS read-create
2110
"The entity that configured this entry and is therefore
2111
using the resources assigned to it."
2112
::= { hostTopNControlEntry 9 }
2114
hostTopNStatus OBJECT-TYPE
2116
MAX-ACCESS read-create
2119
"The status of this hostTopNControl entry.
2121
If this object is not equal to valid(1), all associated
2122
hostTopNEntries shall be deleted by the agent."
2123
::= { hostTopNControlEntry 10 }
2125
hostTopNTable OBJECT-TYPE
2126
SYNTAX SEQUENCE OF HostTopNEntry
2127
MAX-ACCESS not-accessible
2130
"A list of top N host entries."
2133
hostTopNEntry OBJECT-TYPE
2134
SYNTAX HostTopNEntry
2135
MAX-ACCESS not-accessible
2138
"A set of statistics for a host that is part of a top N
2139
report. For example, an instance of the hostTopNRate
2140
object might be named hostTopNRate.3.10"
2141
INDEX { hostTopNReport, hostTopNIndex }
2142
::= { hostTopNTable 1 }
2144
HostTopNEntry ::= SEQUENCE {
2145
hostTopNReport Integer32,
2146
hostTopNIndex Integer32,
2147
hostTopNAddress OCTET STRING,
2148
hostTopNRate Integer32
2151
hostTopNReport OBJECT-TYPE
2152
SYNTAX Integer32 (1..65535)
2153
MAX-ACCESS read-only
2156
"This object identifies the top N report of which
2157
this entry is a part. The set of hosts
2158
identified by a particular value of this
2159
object is part of the same report as identified
2160
by the same value of the hostTopNControlIndex object."
2161
::= { hostTopNEntry 1 }
2163
hostTopNIndex OBJECT-TYPE
2164
SYNTAX Integer32 (1..65535)
2165
MAX-ACCESS read-only
2168
"An index that uniquely identifies an entry in
2169
the hostTopN table among those in the same report.
2170
This index is between 1 and N, where N is the
2171
number of entries in this table. Increasing values
2172
of hostTopNIndex shall be assigned to entries with
2173
decreasing values of hostTopNRate until index N
2174
is assigned to the entry with the lowest value of
2175
hostTopNRate or there are no more hostTopNEntries."
2176
::= { hostTopNEntry 2 }
2178
hostTopNAddress OBJECT-TYPE
2180
MAX-ACCESS read-only
2183
"The physical address of this host."
2184
::= { hostTopNEntry 3 }
2186
hostTopNRate OBJECT-TYPE
2188
MAX-ACCESS read-only
2191
"The amount of change in the selected variable
2192
during this sampling interval. The selected
2193
variable is this host's instance of the object
2194
selected by hostTopNRateBase."
2195
::= { hostTopNEntry 4 }
2199
-- Implementation of the Matrix group is optional.
2200
-- Consult the MODULE-COMPLIANCE macro for the authoritative
2201
-- conformance information for this MIB.
2203
-- The Matrix group consists of the matrixControlTable, matrixSDTable
2204
-- and the matrixDSTable. These tables store statistics for a
2205
-- particular conversation between two addresses. As the device
2206
-- detects a new conversation, including those to a non-unicast
2207
-- address, it creates a new entry in both of the matrix tables.
2208
-- It must only create new entries based on information
2209
-- received in good packets. If the monitoring device finds
2210
-- itself short of resources, it may delete entries as needed.
2211
-- It is suggested that the device delete the least recently used
2214
matrixControlTable OBJECT-TYPE
2215
SYNTAX SEQUENCE OF MatrixControlEntry
2216
MAX-ACCESS not-accessible
2219
"A list of information entries for the
2220
traffic matrix on each interface."
2223
matrixControlEntry OBJECT-TYPE
2224
SYNTAX MatrixControlEntry
2225
MAX-ACCESS not-accessible
2228
"Information about a traffic matrix on a particular
2230
interface. For example, an instance of the
2231
matrixControlLastDeleteTime object might be named
2232
matrixControlLastDeleteTime.1"
2233
INDEX { matrixControlIndex }
2234
::= { matrixControlTable 1 }
2236
MatrixControlEntry ::= SEQUENCE {
2237
matrixControlIndex Integer32,
2238
matrixControlDataSource OBJECT IDENTIFIER,
2239
matrixControlTableSize Integer32,
2240
matrixControlLastDeleteTime TimeTicks,
2241
matrixControlOwner OwnerString,
2242
matrixControlStatus EntryStatus
2245
matrixControlIndex OBJECT-TYPE
2246
SYNTAX Integer32 (1..65535)
2247
MAX-ACCESS read-only
2250
"An index that uniquely identifies an entry in the
2251
matrixControl table. Each such entry defines
2252
a function that discovers conversations on a particular
2253
interface and places statistics about them in the
2254
matrixSDTable and the matrixDSTable on behalf of this
2255
matrixControlEntry."
2256
::= { matrixControlEntry 1 }
2258
matrixControlDataSource OBJECT-TYPE
2259
SYNTAX OBJECT IDENTIFIER
2260
MAX-ACCESS read-create
2263
"This object identifies the source of
2264
the data from which this entry creates a traffic matrix.
2265
This source can be any interface on this device. In
2266
order to identify a particular interface, this object
2267
shall identify the instance of the ifIndex object,
2268
defined in RFC 2233 [17], for the desired
2269
interface. For example, if an entry were to receive data
2270
from interface #1, this object would be set to ifIndex.1.
2272
The statistics in this group reflect all packets
2273
on the local network segment attached to the identified
2276
An agent may or may not be able to tell if fundamental
2277
changes to the media of the interface have occurred and
2279
necessitate an invalidation of this entry. For example, a
2280
hot-pluggable ethernet card could be pulled out and replaced
2281
by a token-ring card. In such a case, if the agent has such
2282
knowledge of the change, it is recommended that it
2283
invalidate this entry.
2285
This object may not be modified if the associated
2286
matrixControlStatus object is equal to valid(1)."
2287
::= { matrixControlEntry 2 }
2289
matrixControlTableSize OBJECT-TYPE
2291
MAX-ACCESS read-only
2294
"The number of matrixSDEntries in the matrixSDTable
2295
for this interface. This must also be the value of
2296
the number of entries in the matrixDSTable for this
2298
::= { matrixControlEntry 3 }
2300
matrixControlLastDeleteTime OBJECT-TYPE
2302
MAX-ACCESS read-only
2305
"The value of sysUpTime when the last entry
2306
was deleted from the portion of the matrixSDTable
2307
or matrixDSTable associated with this matrixControlEntry.
2308
If no deletions have occurred, this value shall be
2310
::= { matrixControlEntry 4 }
2312
matrixControlOwner OBJECT-TYPE
2314
MAX-ACCESS read-create
2317
"The entity that configured this entry and is therefore
2318
using the resources assigned to it."
2319
::= { matrixControlEntry 5 }
2321
matrixControlStatus OBJECT-TYPE
2323
MAX-ACCESS read-create
2326
"The status of this matrixControl entry.
2328
If this object is not equal to valid(1), all associated
2329
entries in the matrixSDTable and the matrixDSTable
2330
shall be deleted by the agent."
2331
::= { matrixControlEntry 6 }
2333
matrixSDTable OBJECT-TYPE
2334
SYNTAX SEQUENCE OF MatrixSDEntry
2335
MAX-ACCESS not-accessible
2338
"A list of traffic matrix entries indexed by
2339
source and destination MAC address."
2342
matrixSDEntry OBJECT-TYPE
2343
SYNTAX MatrixSDEntry
2344
MAX-ACCESS not-accessible
2347
"A collection of statistics for communications between
2348
two addresses on a particular interface. For example,
2349
an instance of the matrixSDPkts object might be named
2350
matrixSDPkts.1.6.8.0.32.27.3.176.6.8.0.32.10.8.113"
2351
INDEX { matrixSDIndex,
2352
matrixSDSourceAddress, matrixSDDestAddress }
2353
::= { matrixSDTable 1 }
2355
MatrixSDEntry ::= SEQUENCE {
2356
matrixSDSourceAddress OCTET STRING,
2357
matrixSDDestAddress OCTET STRING,
2358
matrixSDIndex Integer32,
2359
matrixSDPkts Counter32,
2360
matrixSDOctets Counter32,
2361
matrixSDErrors Counter32
2364
matrixSDSourceAddress OBJECT-TYPE
2366
MAX-ACCESS read-only
2369
"The source physical address."
2370
::= { matrixSDEntry 1 }
2372
matrixSDDestAddress OBJECT-TYPE
2374
MAX-ACCESS read-only
2377
"The destination physical address."
2378
::= { matrixSDEntry 2 }
2380
matrixSDIndex OBJECT-TYPE
2381
SYNTAX Integer32 (1..65535)
2382
MAX-ACCESS read-only
2385
"The set of collected matrix statistics of which
2386
this entry is a part. The set of matrix statistics
2387
identified by a particular value of this index
2388
is associated with the same matrixControlEntry
2389
as identified by the same value of matrixControlIndex."
2390
::= { matrixSDEntry 3 }
2392
matrixSDPkts OBJECT-TYPE
2395
MAX-ACCESS read-only
2398
"The number of packets transmitted from the source
2399
address to the destination address (this number includes
2401
::= { matrixSDEntry 4 }
2403
matrixSDOctets OBJECT-TYPE
2406
MAX-ACCESS read-only
2409
"The number of octets (excluding framing bits but
2410
including FCS octets) contained in all packets
2411
transmitted from the source address to the
2412
destination address."
2413
::= { matrixSDEntry 5 }
2415
matrixSDErrors OBJECT-TYPE
2418
MAX-ACCESS read-only
2421
"The number of bad packets transmitted from
2422
the source address to the destination address."
2423
::= { matrixSDEntry 6 }
2425
-- Traffic matrix tables from destination to source
2427
matrixDSTable OBJECT-TYPE
2428
SYNTAX SEQUENCE OF MatrixDSEntry
2429
MAX-ACCESS not-accessible
2432
"A list of traffic matrix entries indexed by
2433
destination and source MAC address."
2436
matrixDSEntry OBJECT-TYPE
2437
SYNTAX MatrixDSEntry
2438
MAX-ACCESS not-accessible
2441
"A collection of statistics for communications between
2442
two addresses on a particular interface. For example,
2443
an instance of the matrixSDPkts object might be named
2444
matrixSDPkts.1.6.8.0.32.10.8.113.6.8.0.32.27.3.176"
2445
INDEX { matrixDSIndex,
2446
matrixDSDestAddress, matrixDSSourceAddress }
2447
::= { matrixDSTable 1 }
2449
MatrixDSEntry ::= SEQUENCE {
2450
matrixDSSourceAddress OCTET STRING,
2451
matrixDSDestAddress OCTET STRING,
2452
matrixDSIndex Integer32,
2453
matrixDSPkts Counter32,
2454
matrixDSOctets Counter32,
2455
matrixDSErrors Counter32
2458
matrixDSSourceAddress OBJECT-TYPE
2460
MAX-ACCESS read-only
2463
"The source physical address."
2464
::= { matrixDSEntry 1 }
2466
matrixDSDestAddress OBJECT-TYPE
2468
MAX-ACCESS read-only
2471
"The destination physical address."
2472
::= { matrixDSEntry 2 }
2474
matrixDSIndex OBJECT-TYPE
2475
SYNTAX Integer32 (1..65535)
2476
MAX-ACCESS read-only
2479
"The set of collected matrix statistics of which
2480
this entry is a part. The set of matrix statistics
2481
identified by a particular value of this index
2482
is associated with the same matrixControlEntry
2483
as identified by the same value of matrixControlIndex."
2484
::= { matrixDSEntry 3 }
2486
matrixDSPkts OBJECT-TYPE
2489
MAX-ACCESS read-only
2492
"The number of packets transmitted from the source
2493
address to the destination address (this number includes
2495
::= { matrixDSEntry 4 }
2497
matrixDSOctets OBJECT-TYPE
2500
MAX-ACCESS read-only
2503
"The number of octets (excluding framing bits
2504
but including FCS octets) contained in all packets
2505
transmitted from the source address to the
2506
destination address."
2507
::= { matrixDSEntry 5 }
2509
matrixDSErrors OBJECT-TYPE
2512
MAX-ACCESS read-only
2515
"The number of bad packets transmitted from
2516
the source address to the destination address."
2517
::= { matrixDSEntry 6 }
2521
-- Implementation of the Filter group is optional.
2523
-- Consult the MODULE-COMPLIANCE macro for the authoritative
2524
-- conformance information for this MIB.
2526
-- The Filter group allows packets to be captured with an
2527
-- arbitrary filter expression. A logical data and
2528
-- event stream or "channel" is formed by the packets
2529
-- that match the filter expression.
2531
-- This filter mechanism allows the creation of an arbitrary
2532
-- logical expression with which to filter packets. Each
2533
-- filter associated with a channel is OR'ed with the others.
2534
-- Within a filter, any bits checked in the data and status are
2535
-- AND'ed with respect to other bits in the same filter. The
2536
-- NotMask also allows for checking for inequality. Finally,
2537
-- the channelAcceptType object allows for inversion of the
2540
-- If a management station wishes to receive a trap to alert it
2541
-- that new packets have been captured and are available for
2542
-- download, it is recommended that it set up an alarm entry that
2543
-- monitors the value of the relevant channelMatches instance.
2545
-- The channel can be turned on or off, and can also
2546
-- generate events when packets pass through it.
2548
filterTable OBJECT-TYPE
2549
SYNTAX SEQUENCE OF FilterEntry
2550
MAX-ACCESS not-accessible
2553
"A list of packet filter entries."
2556
filterEntry OBJECT-TYPE
2558
MAX-ACCESS not-accessible
2561
"A set of parameters for a packet filter applied on a
2562
particular interface. As an example, an instance of the
2563
filterPktData object might be named filterPktData.12"
2564
INDEX { filterIndex }
2565
::= { filterTable 1 }
2567
FilterEntry ::= SEQUENCE {
2568
filterIndex Integer32,
2569
filterChannelIndex Integer32,
2570
filterPktDataOffset Integer32,
2571
filterPktData OCTET STRING,
2572
filterPktDataMask OCTET STRING,
2573
filterPktDataNotMask OCTET STRING,
2574
filterPktStatus Integer32,
2575
filterPktStatusMask Integer32,
2576
filterPktStatusNotMask Integer32,
2577
filterOwner OwnerString,
2578
filterStatus EntryStatus
2581
filterIndex OBJECT-TYPE
2582
SYNTAX Integer32 (1..65535)
2583
MAX-ACCESS read-only
2586
"An index that uniquely identifies an entry
2587
in the filter table. Each such entry defines
2588
one filter that is to be applied to every packet
2589
received on an interface."
2590
::= { filterEntry 1 }
2592
filterChannelIndex OBJECT-TYPE
2593
SYNTAX Integer32 (1..65535)
2594
MAX-ACCESS read-create
2597
"This object identifies the channel of which this filter
2598
is a part. The filters identified by a particular value
2599
of this object are associated with the same channel as
2600
identified by the same value of the channelIndex object."
2601
::= { filterEntry 2 }
2603
filterPktDataOffset OBJECT-TYPE
2606
MAX-ACCESS read-create
2609
"The offset from the beginning of each packet where
2610
a match of packet data will be attempted. This offset
2611
is measured from the point in the physical layer
2612
packet after the framing bits, if any. For example,
2613
in an Ethernet frame, this point is at the beginning of
2614
the destination MAC address.
2616
This object may not be modified if the associated
2617
filterStatus object is equal to valid(1)."
2619
::= { filterEntry 3 }
2621
filterPktData OBJECT-TYPE
2623
MAX-ACCESS read-create
2626
"The data that is to be matched with the input packet.
2627
For each packet received, this filter and the accompanying
2628
filterPktDataMask and filterPktDataNotMask will be
2629
adjusted for the offset. The only bits relevant to this
2630
match algorithm are those that have the corresponding
2631
filterPktDataMask bit equal to one. The following three
2632
rules are then applied to every packet:
2634
(1) If the packet is too short and does not have data
2635
corresponding to part of the filterPktData, the packet
2636
will fail this data match.
2638
(2) For each relevant bit from the packet with the
2639
corresponding filterPktDataNotMask bit set to zero, if
2640
the bit from the packet is not equal to the corresponding
2641
bit from the filterPktData, then the packet will fail
2644
(3) If for every relevant bit from the packet with the
2645
corresponding filterPktDataNotMask bit set to one, the
2646
bit from the packet is equal to the corresponding bit
2647
from the filterPktData, then the packet will fail this
2650
Any packets that have not failed any of the three matches
2651
above have passed this data match. In particular, a zero
2652
length filter will match any packet.
2654
This object may not be modified if the associated
2655
filterStatus object is equal to valid(1)."
2656
::= { filterEntry 4 }
2658
filterPktDataMask OBJECT-TYPE
2660
MAX-ACCESS read-create
2663
"The mask that is applied to the match process.
2664
After adjusting this mask for the offset, only those
2665
bits in the received packet that correspond to bits set
2666
in this mask are relevant for further processing by the
2668
match algorithm. The offset is applied to filterPktDataMask
2669
in the same way it is applied to the filter. For the
2670
purposes of the matching algorithm, if the associated
2671
filterPktData object is longer than this mask, this mask is
2672
conceptually extended with '1' bits until it reaches the
2673
length of the filterPktData object.
2675
This object may not be modified if the associated
2676
filterStatus object is equal to valid(1)."
2677
::= { filterEntry 5 }
2679
filterPktDataNotMask OBJECT-TYPE
2681
MAX-ACCESS read-create
2684
"The inversion mask that is applied to the match
2685
process. After adjusting this mask for the offset,
2686
those relevant bits in the received packet that correspond
2687
to bits cleared in this mask must all be equal to their
2688
corresponding bits in the filterPktData object for the packet
2689
to be accepted. In addition, at least one of those relevant
2690
bits in the received packet that correspond to bits set in
2691
this mask must be different to its corresponding bit in the
2692
filterPktData object.
2694
For the purposes of the matching algorithm, if the associated
2695
filterPktData object is longer than this mask, this mask is
2696
conceptually extended with '0' bits until it reaches the
2697
length of the filterPktData object.
2699
This object may not be modified if the associated
2700
filterStatus object is equal to valid(1)."
2701
::= { filterEntry 6 }
2703
filterPktStatus OBJECT-TYPE
2705
MAX-ACCESS read-create
2708
"The status that is to be matched with the input packet.
2709
The only bits relevant to this match algorithm are those that
2710
have the corresponding filterPktStatusMask bit equal to one.
2711
The following two rules are then applied to every packet:
2713
(1) For each relevant bit from the packet status with the
2714
corresponding filterPktStatusNotMask bit set to zero, if
2715
the bit from the packet status is not equal to the
2717
corresponding bit from the filterPktStatus, then the
2718
packet will fail this status match.
2720
(2) If for every relevant bit from the packet status with the
2721
corresponding filterPktStatusNotMask bit set to one, the
2722
bit from the packet status is equal to the corresponding
2723
bit from the filterPktStatus, then the packet will fail
2726
Any packets that have not failed either of the two matches
2727
above have passed this status match. In particular, a zero
2728
length status filter will match any packet's status.
2730
The value of the packet status is a sum. This sum
2731
initially takes the value zero. Then, for each
2732
error, E, that has been discovered in this packet,
2733
2 raised to a value representing E is added to the sum.
2734
The errors and the bits that represent them are dependent
2735
on the media type of the interface that this channel
2736
is receiving packets from.
2738
The errors defined for a packet captured off of an
2739
Ethernet interface are as follows:
2742
0 Packet is longer than 1518 octets
2743
1 Packet is shorter than 64 octets
2744
2 Packet experienced a CRC or Alignment error
2746
For example, an Ethernet fragment would have a
2747
value of 6 (2^1 + 2^2).
2749
As this MIB is expanded to new media types, this object
2750
will have other media-specific errors defined.
2752
For the purposes of this status matching algorithm, if the
2753
packet status is longer than this filterPktStatus object,
2754
this object is conceptually extended with '0' bits until it
2755
reaches the size of the packet status.
2757
This object may not be modified if the associated
2758
filterStatus object is equal to valid(1)."
2759
::= { filterEntry 7 }
2761
filterPktStatusMask OBJECT-TYPE
2763
MAX-ACCESS read-create
2766
"The mask that is applied to the status match process.
2767
Only those bits in the received packet that correspond to
2768
bits set in this mask are relevant for further processing
2769
by the status match algorithm. For the purposes
2770
of the matching algorithm, if the associated filterPktStatus
2771
object is longer than this mask, this mask is conceptually
2772
extended with '1' bits until it reaches the size of the
2773
filterPktStatus. In addition, if a packet status is longer
2774
than this mask, this mask is conceptually extended with '0'
2775
bits until it reaches the size of the packet status.
2777
This object may not be modified if the associated
2778
filterStatus object is equal to valid(1)."
2779
::= { filterEntry 8 }
2781
filterPktStatusNotMask OBJECT-TYPE
2783
MAX-ACCESS read-create
2786
"The inversion mask that is applied to the status match
2787
process. Those relevant bits in the received packet status
2788
that correspond to bits cleared in this mask must all be
2789
equal to their corresponding bits in the filterPktStatus
2790
object for the packet to be accepted. In addition, at least
2791
one of those relevant bits in the received packet status
2792
that correspond to bits set in this mask must be different
2793
to its corresponding bit in the filterPktStatus object for
2794
the packet to be accepted.
2796
For the purposes of the matching algorithm, if the associated
2797
filterPktStatus object or a packet status is longer than this
2798
mask, this mask is conceptually extended with '0' bits until
2799
it reaches the longer of the lengths of the filterPktStatus
2800
object and the packet status.
2802
This object may not be modified if the associated
2803
filterStatus object is equal to valid(1)."
2804
::= { filterEntry 9 }
2806
filterOwner OBJECT-TYPE
2808
MAX-ACCESS read-create
2811
"The entity that configured this entry and is therefore
2812
using the resources assigned to it."
2813
::= { filterEntry 10 }
2815
filterStatus OBJECT-TYPE
2817
MAX-ACCESS read-create
2820
"The status of this filter entry."
2821
::= { filterEntry 11 }
2823
channelTable OBJECT-TYPE
2824
SYNTAX SEQUENCE OF ChannelEntry
2825
MAX-ACCESS not-accessible
2828
"A list of packet channel entries."
2831
channelEntry OBJECT-TYPE
2833
MAX-ACCESS not-accessible
2836
"A set of parameters for a packet channel applied on a
2837
particular interface. As an example, an instance of the
2838
channelMatches object might be named channelMatches.3"
2839
INDEX { channelIndex }
2840
::= { channelTable 1 }
2842
ChannelEntry ::= SEQUENCE {
2843
channelIndex Integer32,
2844
channelIfIndex Integer32,
2845
channelAcceptType INTEGER,
2846
channelDataControl INTEGER,
2847
channelTurnOnEventIndex Integer32,
2848
channelTurnOffEventIndex Integer32,
2849
channelEventIndex Integer32,
2850
channelEventStatus INTEGER,
2851
channelMatches Counter32,
2852
channelDescription DisplayString,
2853
channelOwner OwnerString,
2854
channelStatus EntryStatus
2857
channelIndex OBJECT-TYPE
2858
SYNTAX Integer32 (1..65535)
2859
MAX-ACCESS read-only
2862
"An index that uniquely identifies an entry in the channel
2863
table. Each such entry defines one channel, a logical
2864
data and event stream.
2866
It is suggested that before creating a channel, an
2867
application should scan all instances of the
2868
filterChannelIndex object to make sure that there are no
2869
pre-existing filters that would be inadvertently be linked
2871
::= { channelEntry 1 }
2873
channelIfIndex OBJECT-TYPE
2874
SYNTAX Integer32 (1..65535)
2875
MAX-ACCESS read-create
2878
"The value of this object uniquely identifies the
2879
interface on this remote network monitoring device to which
2880
the associated filters are applied to allow data into this
2881
channel. The interface identified by a particular value
2882
of this object is the same interface as identified by the
2883
same value of the ifIndex object, defined in RFC 2233 [17].
2885
The filters in this group are applied to all packets on
2886
the local network segment attached to the identified
2889
An agent may or may not be able to tell if fundamental
2890
changes to the media of the interface have occurred and
2891
necessitate an invalidation of this entry. For example, a
2892
hot-pluggable ethernet card could be pulled out and replaced
2893
by a token-ring card. In such a case, if the agent has such
2894
knowledge of the change, it is recommended that it
2895
invalidate this entry.
2897
This object may not be modified if the associated
2898
channelStatus object is equal to valid(1)."
2899
::= { channelEntry 2 }
2901
channelAcceptType OBJECT-TYPE
2906
MAX-ACCESS read-create
2909
"This object controls the action of the filters
2910
associated with this channel. If this object is equal
2911
to acceptMatched(1), packets will be accepted to this
2912
channel if they are accepted by both the packet data and
2913
packet status matches of an associated filter. If
2914
this object is equal to acceptFailed(2), packets will
2915
be accepted to this channel only if they fail either
2916
the packet data match or the packet status match of
2917
each of the associated filters.
2919
In particular, a channel with no associated filters will
2920
match no packets if set to acceptMatched(1) case and will
2921
match all packets in the acceptFailed(2) case.
2923
This object may not be modified if the associated
2924
channelStatus object is equal to valid(1)."
2925
::= { channelEntry 3 }
2927
channelDataControl OBJECT-TYPE
2932
MAX-ACCESS read-create
2935
"This object controls the flow of data through this channel.
2936
If this object is on(1), data, status and events flow
2937
through this channel. If this object is off(2), data,
2938
status and events will not flow through this channel."
2940
::= { channelEntry 4 }
2942
channelTurnOnEventIndex OBJECT-TYPE
2943
SYNTAX Integer32 (0..65535)
2944
MAX-ACCESS read-create
2947
"The value of this object identifies the event
2948
that is configured to turn the associated
2949
channelDataControl from off to on when the event is
2950
generated. The event identified by a particular value
2951
of this object is the same event as identified by the
2952
same value of the eventIndex object. If there is no
2953
corresponding entry in the eventTable, then no
2954
association exists. In fact, if no event is intended
2955
for this channel, channelTurnOnEventIndex must be
2956
set to zero, a non-existent event index.
2958
This object may not be modified if the associated
2959
channelStatus object is equal to valid(1)."
2960
::= { channelEntry 5 }
2962
channelTurnOffEventIndex OBJECT-TYPE
2963
SYNTAX Integer32 (0..65535)
2964
MAX-ACCESS read-create
2967
"The value of this object identifies the event
2968
that is configured to turn the associated
2969
channelDataControl from on to off when the event is
2970
generated. The event identified by a particular value
2971
of this object is the same event as identified by the
2972
same value of the eventIndex object. If there is no
2973
corresponding entry in the eventTable, then no
2974
association exists. In fact, if no event is intended
2975
for this channel, channelTurnOffEventIndex must be
2976
set to zero, a non-existent event index.
2978
This object may not be modified if the associated
2979
channelStatus object is equal to valid(1)."
2980
::= { channelEntry 6 }
2982
channelEventIndex OBJECT-TYPE
2983
SYNTAX Integer32 (0..65535)
2984
MAX-ACCESS read-create
2987
"The value of this object identifies the event
2988
that is configured to be generated when the
2989
associated channelDataControl is on and a packet
2990
is matched. The event identified by a particular value
2991
of this object is the same event as identified by the
2992
same value of the eventIndex object. If there is no
2993
corresponding entry in the eventTable, then no
2994
association exists. In fact, if no event is intended
2995
for this channel, channelEventIndex must be
2996
set to zero, a non-existent event index.
2998
This object may not be modified if the associated
2999
channelStatus object is equal to valid(1)."
3000
::= { channelEntry 7 }
3002
channelEventStatus OBJECT-TYPE
3008
MAX-ACCESS read-create
3011
"The event status of this channel.
3013
If this channel is configured to generate events
3014
when packets are matched, a means of controlling
3015
the flow of those events is often needed. When
3016
this object is equal to eventReady(1), a single
3017
event may be generated, after which this object
3018
will be set by the probe to eventFired(2). While
3019
in the eventFired(2) state, no events will be
3020
generated until the object is modified to
3021
eventReady(1) (or eventAlwaysReady(3)). The
3022
management station can thus easily respond to a
3023
notification of an event by re-enabling this object.
3025
If the management station wishes to disable this
3026
flow control and allow events to be generated
3027
at will, this object may be set to
3028
eventAlwaysReady(3). Disabling the flow control
3029
is discouraged as it can result in high network
3030
traffic or other performance problems."
3031
DEFVAL { eventReady }
3032
::= { channelEntry 8 }
3034
channelMatches OBJECT-TYPE
3037
MAX-ACCESS read-only
3040
"The number of times this channel has matched a packet.
3041
Note that this object is updated even when
3042
channelDataControl is set to off."
3043
::= { channelEntry 9 }
3045
channelDescription OBJECT-TYPE
3046
SYNTAX DisplayString (SIZE (0..127))
3047
MAX-ACCESS read-create
3050
"A comment describing this channel."
3051
::= { channelEntry 10 }
3053
channelOwner OBJECT-TYPE
3055
MAX-ACCESS read-create
3058
"The entity that configured this entry and is therefore
3059
using the resources assigned to it."
3060
::= { channelEntry 11 }
3062
channelStatus OBJECT-TYPE
3064
MAX-ACCESS read-create
3067
"The status of this channel entry."
3068
::= { channelEntry 12 }
3070
-- The Packet Capture Group
3072
-- Implementation of the Packet Capture group is optional. The Packet
3073
-- Capture Group requires implementation of the Filter Group.
3074
-- Consult the MODULE-COMPLIANCE macro for the authoritative
3075
-- conformance information for this MIB.
3077
-- The Packet Capture group allows packets to be captured
3078
-- upon a filter match. The bufferControlTable controls
3079
-- the captured packets output from a channel that is
3080
-- associated with it. The captured packets are placed
3081
-- in entries in the captureBufferTable. These entries are
3082
-- associated with the bufferControlEntry on whose behalf they
3085
bufferControlTable OBJECT-TYPE
3086
SYNTAX SEQUENCE OF BufferControlEntry
3087
MAX-ACCESS not-accessible
3090
"A list of buffers control entries."
3093
bufferControlEntry OBJECT-TYPE
3094
SYNTAX BufferControlEntry
3095
MAX-ACCESS not-accessible
3098
"A set of parameters that control the collection of a stream
3099
of packets that have matched filters. As an example, an
3100
instance of the bufferControlCaptureSliceSize object might
3101
be named bufferControlCaptureSliceSize.3"
3102
INDEX { bufferControlIndex }
3103
::= { bufferControlTable 1 }
3105
BufferControlEntry ::= SEQUENCE {
3106
bufferControlIndex Integer32,
3107
bufferControlChannelIndex Integer32,
3108
bufferControlFullStatus INTEGER,
3109
bufferControlFullAction INTEGER,
3110
bufferControlCaptureSliceSize Integer32,
3111
bufferControlDownloadSliceSize Integer32,
3112
bufferControlDownloadOffset Integer32,
3113
bufferControlMaxOctetsRequested Integer32,
3114
bufferControlMaxOctetsGranted Integer32,
3115
bufferControlCapturedPackets Integer32,
3116
bufferControlTurnOnTime TimeTicks,
3117
bufferControlOwner OwnerString,
3118
bufferControlStatus EntryStatus
3121
bufferControlIndex OBJECT-TYPE
3122
SYNTAX Integer32 (1..65535)
3123
MAX-ACCESS read-only
3126
"An index that uniquely identifies an entry
3127
in the bufferControl table. The value of this
3128
index shall never be zero. Each such
3129
entry defines one set of packets that is
3130
captured and controlled by one or more filters."
3131
::= { bufferControlEntry 1 }
3133
bufferControlChannelIndex OBJECT-TYPE
3134
SYNTAX Integer32 (1..65535)
3135
MAX-ACCESS read-create
3138
"An index that identifies the channel that is the
3139
source of packets for this bufferControl table.
3140
The channel identified by a particular value of this
3141
index is the same as identified by the same value of
3142
the channelIndex object.
3144
This object may not be modified if the associated
3145
bufferControlStatus object is equal to valid(1)."
3146
::= { bufferControlEntry 2 }
3148
bufferControlFullStatus OBJECT-TYPE
3154
MAX-ACCESS read-only
3157
"This object shows whether the buffer has room to
3158
accept new packets or if it is full.
3160
If the status is spaceAvailable(1), the buffer is
3161
accepting new packets normally. If the status is
3162
full(2) and the associated bufferControlFullAction
3163
object is wrapWhenFull, the buffer is accepting new
3164
packets by deleting enough of the oldest packets
3165
to make room for new ones as they arrive. Otherwise,
3166
if the status is full(2) and the
3167
bufferControlFullAction object is lockWhenFull,
3168
then the buffer has stopped collecting packets.
3170
When this object is set to full(2) the probe must
3171
not later set it to spaceAvailable(1) except in the
3172
case of a significant gain in resources such as
3173
an increase of bufferControlOctetsGranted. In
3174
particular, the wrap-mode action of deleting old
3175
packets to make room for newly arrived packets
3176
must not affect the value of this object."
3177
::= { bufferControlEntry 3 }
3179
bufferControlFullAction OBJECT-TYPE
3182
wrapWhenFull(2) -- FIFO
3184
MAX-ACCESS read-create
3187
"Controls the action of the buffer when it
3188
reaches the full status. When in the lockWhenFull(1)
3189
state and a packet is added to the buffer that
3190
fills the buffer, the bufferControlFullStatus will
3191
be set to full(2) and this buffer will stop capturing
3193
::= { bufferControlEntry 4 }
3195
bufferControlCaptureSliceSize OBJECT-TYPE
3198
MAX-ACCESS read-create
3201
"The maximum number of octets of each packet
3202
that will be saved in this capture buffer.
3203
For example, if a 1500 octet packet is received by
3204
the probe and this object is set to 500, then only
3205
500 octets of the packet will be stored in the
3206
associated capture buffer. If this variable is set
3207
to 0, the capture buffer will save as many octets
3210
This object may not be modified if the associated
3211
bufferControlStatus object is equal to valid(1)."
3213
::= { bufferControlEntry 5 }
3215
bufferControlDownloadSliceSize OBJECT-TYPE
3218
MAX-ACCESS read-create
3221
"The maximum number of octets of each packet
3222
in this capture buffer that will be returned in
3223
an SNMP retrieval of that packet. For example,
3224
if 500 octets of a packet have been stored in the
3225
associated capture buffer, the associated
3226
bufferControlDownloadOffset is 0, and this
3227
object is set to 100, then the captureBufferPacket
3228
object that contains the packet will contain only
3229
the first 100 octets of the packet.
3231
A prudent manager will take into account possible
3232
interoperability or fragmentation problems that may
3233
occur if the download slice size is set too large.
3234
In particular, conformant SNMP implementations are not
3235
required to accept messages whose length exceeds 484
3236
octets, although they are encouraged to support larger
3237
datagrams whenever feasible."
3239
::= { bufferControlEntry 6 }
3241
bufferControlDownloadOffset OBJECT-TYPE
3244
MAX-ACCESS read-create
3247
"The offset of the first octet of each packet
3248
in this capture buffer that will be returned in
3249
an SNMP retrieval of that packet. For example,
3250
if 500 octets of a packet have been stored in the
3251
associated capture buffer and this object is set to
3252
100, then the captureBufferPacket object that
3253
contains the packet will contain bytes starting
3254
100 octets into the packet."
3256
::= { bufferControlEntry 7 }
3258
bufferControlMaxOctetsRequested OBJECT-TYPE
3261
MAX-ACCESS read-create
3264
"The requested maximum number of octets to be
3265
saved in this captureBuffer, including any
3266
implementation-specific overhead. If this variable
3267
is set to -1, the capture buffer will save as many
3268
octets as is possible.
3270
When this object is created or modified, the probe
3271
should set bufferControlMaxOctetsGranted as closely
3272
to this object as is possible for the particular probe
3273
implementation and available resources. However, if
3274
the object has the special value of -1, the probe
3275
must set bufferControlMaxOctetsGranted to -1."
3277
::= { bufferControlEntry 8 }
3279
bufferControlMaxOctetsGranted OBJECT-TYPE
3282
MAX-ACCESS read-only
3285
"The maximum number of octets that can be
3286
saved in this captureBuffer, including overhead.
3287
If this variable is -1, the capture buffer will save
3288
as many octets as possible.
3290
When the bufferControlMaxOctetsRequested object is
3291
created or modified, the probe should set this object
3292
as closely to the requested value as is possible for the
3293
particular probe implementation and available resources.
3294
However, if the request object has the special value
3296
of -1, the probe must set this object to -1.
3298
The probe must not lower this value except as a result of
3299
a modification to the associated
3300
bufferControlMaxOctetsRequested object.
3302
When this maximum number of octets is reached
3303
and a new packet is to be added to this
3304
capture buffer and the corresponding
3305
bufferControlFullAction is set to wrapWhenFull(2),
3306
enough of the oldest packets associated with this
3307
capture buffer shall be deleted by the agent so
3308
that the new packet can be added. If the corresponding
3309
bufferControlFullAction is set to lockWhenFull(1),
3310
the new packet shall be discarded. In either case,
3311
the probe must set bufferControlFullStatus to
3314
When the value of this object changes to a value less
3315
than the current value, entries are deleted from
3316
the captureBufferTable associated with this
3317
bufferControlEntry. Enough of the
3318
oldest of these captureBufferEntries shall be
3319
deleted by the agent so that the number of octets
3320
used remains less than or equal to the new value of
3323
When the value of this object changes to a value greater
3324
than the current value, the number of associated
3325
captureBufferEntries may be allowed to grow."
3326
::= { bufferControlEntry 9 }
3328
bufferControlCapturedPackets OBJECT-TYPE
3331
MAX-ACCESS read-only
3334
"The number of packets currently in this captureBuffer."
3335
::= { bufferControlEntry 10 }
3337
bufferControlTurnOnTime OBJECT-TYPE
3339
MAX-ACCESS read-only
3342
"The value of sysUpTime when this capture buffer was
3344
::= { bufferControlEntry 11 }
3346
bufferControlOwner OBJECT-TYPE
3348
MAX-ACCESS read-create
3351
"The entity that configured this entry and is therefore
3352
using the resources assigned to it."
3353
::= { bufferControlEntry 12 }
3355
bufferControlStatus OBJECT-TYPE
3357
MAX-ACCESS read-create
3360
"The status of this buffer Control Entry."
3361
::= { bufferControlEntry 13 }
3363
captureBufferTable OBJECT-TYPE
3364
SYNTAX SEQUENCE OF CaptureBufferEntry
3365
MAX-ACCESS not-accessible
3368
"A list of packets captured off of a channel."
3371
captureBufferEntry OBJECT-TYPE
3372
SYNTAX CaptureBufferEntry
3373
MAX-ACCESS not-accessible
3376
"A packet captured off of an attached network. As an
3377
example, an instance of the captureBufferPacketData
3378
object might be named captureBufferPacketData.3.1783"
3379
INDEX { captureBufferControlIndex, captureBufferIndex }
3380
::= { captureBufferTable 1 }
3382
CaptureBufferEntry ::= SEQUENCE {
3383
captureBufferControlIndex Integer32,
3384
captureBufferIndex Integer32,
3385
captureBufferPacketID Integer32,
3386
captureBufferPacketData OCTET STRING,
3387
captureBufferPacketLength Integer32,
3388
captureBufferPacketTime Integer32,
3389
captureBufferPacketStatus Integer32
3392
captureBufferControlIndex OBJECT-TYPE
3393
SYNTAX Integer32 (1..65535)
3394
MAX-ACCESS read-only
3397
"The index of the bufferControlEntry with which
3398
this packet is associated."
3399
::= { captureBufferEntry 1 }
3401
captureBufferIndex OBJECT-TYPE
3402
SYNTAX Integer32 (1..2147483647)
3403
MAX-ACCESS read-only
3406
"An index that uniquely identifies an entry
3407
in the captureBuffer table associated with a
3408
particular bufferControlEntry. This index will
3409
start at 1 and increase by one for each new packet
3410
added with the same captureBufferControlIndex.
3412
Should this value reach 2147483647, the next packet
3413
added with the same captureBufferControlIndex shall
3414
cause this value to wrap around to 1."
3415
::= { captureBufferEntry 2 }
3417
captureBufferPacketID OBJECT-TYPE
3419
MAX-ACCESS read-only
3422
"An index that describes the order of packets
3423
that are received on a particular interface.
3424
The packetID of a packet captured on an
3425
interface is defined to be greater than the
3426
packetID's of all packets captured previously on
3427
the same interface. As the captureBufferPacketID
3428
object has a maximum positive value of 2^31 - 1,
3429
any captureBufferPacketID object shall have the
3430
value of the associated packet's packetID mod 2^31."
3431
::= { captureBufferEntry 3 }
3433
captureBufferPacketData OBJECT-TYPE
3435
MAX-ACCESS read-only
3438
"The data inside the packet, starting at the beginning
3439
of the packet plus any offset specified in the
3441
associated bufferControlDownloadOffset, including any
3442
link level headers. The length of the data in this object
3443
is the minimum of the length of the captured packet minus
3444
the offset, the length of the associated
3445
bufferControlCaptureSliceSize minus the offset, and the
3446
associated bufferControlDownloadSliceSize. If this minimum
3447
is less than zero, this object shall have a length of zero."
3448
::= { captureBufferEntry 4 }
3450
captureBufferPacketLength OBJECT-TYPE
3453
MAX-ACCESS read-only
3456
"The actual length (off the wire) of the packet stored
3457
in this entry, including FCS octets."
3458
::= { captureBufferEntry 5 }
3460
captureBufferPacketTime OBJECT-TYPE
3462
UNITS "Milliseconds"
3463
MAX-ACCESS read-only
3466
"The number of milliseconds that had passed since
3467
this capture buffer was first turned on when this
3468
packet was captured."
3469
::= { captureBufferEntry 6 }
3471
captureBufferPacketStatus OBJECT-TYPE
3473
MAX-ACCESS read-only
3476
"A value which indicates the error status of this packet.
3478
The value of this object is defined in the same way as
3479
filterPktStatus. The value is a sum. This sum
3480
initially takes the value zero. Then, for each
3481
error, E, that has been discovered in this packet,
3482
2 raised to a value representing E is added to the sum.
3484
The errors defined for a packet captured off of an
3485
Ethernet interface are as follows:
3488
0 Packet is longer than 1518 octets
3490
1 Packet is shorter than 64 octets
3491
2 Packet experienced a CRC or Alignment error
3492
3 First packet in this capture buffer after
3493
it was detected that some packets were
3494
not processed correctly.
3495
4 Packet's order in buffer is only approximate
3496
(May only be set for packets sent from
3499
For example, an Ethernet fragment would have a
3500
value of 6 (2^1 + 2^2).
3502
As this MIB is expanded to new media types, this object
3503
will have other media-specific errors defined."
3504
::= { captureBufferEntry 7 }
3508
-- Implementation of the Event group is optional.
3509
-- Consult the MODULE-COMPLIANCE macro for the authoritative
3510
-- conformance information for this MIB.
3512
-- The Event group controls the generation and notification
3513
-- of events from this device. Each entry in the eventTable
3514
-- describes the parameters of the event that can be triggered.
3515
-- Each event entry is fired by an associated condition located
3516
-- elsewhere in the MIB. An event entry may also be associated
3517
-- with a function elsewhere in the MIB that will be executed
3518
-- when the event is generated. For example, a channel may
3519
-- be turned on or off by the firing of an event.
3521
-- Each eventEntry may optionally specify that a log entry
3522
-- be created on its behalf whenever the event occurs.
3523
-- Each entry may also specify that notification should
3524
-- occur by way of SNMP trap messages. In this case, the
3525
-- community for the trap message is given in the associated
3526
-- eventCommunity object. The enterprise and specific trap
3527
-- fields of the trap are determined by the condition that
3528
-- triggered the event. Two traps are defined: risingAlarm and
3529
-- fallingAlarm. If the eventTable is triggered by a condition
3530
-- specified elsewhere, the enterprise and specific trap fields
3531
-- must be specified for traps generated for that condition.
3533
eventTable OBJECT-TYPE
3534
SYNTAX SEQUENCE OF EventEntry
3535
MAX-ACCESS not-accessible
3538
"A list of events to be generated."
3541
eventEntry OBJECT-TYPE
3543
MAX-ACCESS not-accessible
3546
"A set of parameters that describe an event to be generated
3547
when certain conditions are met. As an example, an instance
3548
of the eventLastTimeSent object might be named
3549
eventLastTimeSent.6"
3550
INDEX { eventIndex }
3551
::= { eventTable 1 }
3553
EventEntry ::= SEQUENCE {
3554
eventIndex Integer32,
3555
eventDescription DisplayString,
3557
eventCommunity OCTET STRING,
3558
eventLastTimeSent TimeTicks,
3559
eventOwner OwnerString,
3560
eventStatus EntryStatus
3563
eventIndex OBJECT-TYPE
3564
SYNTAX Integer32 (1..65535)
3565
MAX-ACCESS read-only
3568
"An index that uniquely identifies an entry in the
3569
event table. Each such entry defines one event that
3570
is to be generated when the appropriate conditions
3572
::= { eventEntry 1 }
3574
eventDescription OBJECT-TYPE
3575
SYNTAX DisplayString (SIZE (0..127))
3576
MAX-ACCESS read-create
3579
"A comment describing this event entry."
3580
::= { eventEntry 2 }
3582
eventType OBJECT-TYPE
3586
snmptrap(3), -- send an SNMP trap
3589
MAX-ACCESS read-create
3592
"The type of notification that the probe will make
3593
about this event. In the case of log, an entry is
3594
made in the log table for each event. In the case of
3595
snmp-trap, an SNMP trap is sent to one or more
3596
management stations."
3597
::= { eventEntry 3 }
3599
eventCommunity OBJECT-TYPE
3600
SYNTAX OCTET STRING (SIZE (0..127))
3601
MAX-ACCESS read-create
3604
"If an SNMP trap is to be sent, it will be sent to
3605
the SNMP community specified by this octet string."
3606
::= { eventEntry 4 }
3608
eventLastTimeSent OBJECT-TYPE
3610
MAX-ACCESS read-only
3613
"The value of sysUpTime at the time this event
3614
entry last generated an event. If this entry has
3615
not generated any events, this value will be
3617
::= { eventEntry 5 }
3619
eventOwner OBJECT-TYPE
3621
MAX-ACCESS read-create
3624
"The entity that configured this entry and is therefore
3625
using the resources assigned to it.
3627
If this object contains a string starting with 'monitor'
3628
and has associated entries in the log table, all connected
3629
management stations should retrieve those log entries,
3630
as they may have significance to all management stations
3631
connected to this device"
3632
::= { eventEntry 6 }
3634
eventStatus OBJECT-TYPE
3636
MAX-ACCESS read-create
3639
"The status of this event entry.
3641
If this object is not equal to valid(1), all associated
3642
log entries shall be deleted by the agent."
3643
::= { eventEntry 7 }
3646
logTable OBJECT-TYPE
3647
SYNTAX SEQUENCE OF LogEntry
3648
MAX-ACCESS not-accessible
3651
"A list of events that have been logged."
3654
logEntry OBJECT-TYPE
3656
MAX-ACCESS not-accessible
3659
"A set of data describing an event that has been
3660
logged. For example, an instance of the logDescription
3661
object might be named logDescription.6.47"
3662
INDEX { logEventIndex, logIndex }
3665
LogEntry ::= SEQUENCE {
3666
logEventIndex Integer32,
3669
logDescription DisplayString
3672
logEventIndex OBJECT-TYPE
3673
SYNTAX Integer32 (1..65535)
3674
MAX-ACCESS read-only
3677
"The event entry that generated this log
3678
entry. The log identified by a particular
3679
value of this index is associated with the same
3680
eventEntry as identified by the same value
3684
logIndex OBJECT-TYPE
3685
SYNTAX Integer32 (1..2147483647)
3686
MAX-ACCESS read-only
3689
"An index that uniquely identifies an entry
3690
in the log table amongst those generated by the
3691
same eventEntries. These indexes are
3692
assigned beginning with 1 and increase by one
3693
with each new log entry. The association
3694
between values of logIndex and logEntries
3695
is fixed for the lifetime of each logEntry.
3696
The agent may choose to delete the oldest
3697
instances of logEntry as required because of
3698
lack of memory. It is an implementation-specific
3699
matter as to when this deletion may occur."
3704
MAX-ACCESS read-only
3707
"The value of sysUpTime when this log entry was created."
3710
logDescription OBJECT-TYPE
3711
SYNTAX DisplayString (SIZE (0..255))
3712
MAX-ACCESS read-only
3715
"An implementation dependent description of the
3716
event that activated this log entry."
3719
-- Remote Network Monitoring Traps
3721
rmonEventsV2 OBJECT-IDENTITY
3723
DESCRIPTION "Definition point for RMON notifications."
3726
risingAlarm NOTIFICATION-TYPE
3727
OBJECTS { alarmIndex, alarmVariable, alarmSampleType,
3728
alarmValue, alarmRisingThreshold }
3731
"The SNMP trap that is generated when an alarm
3732
entry crosses its rising threshold and generates
3733
an event that is configured for sending SNMP
3735
::= { rmonEventsV2 1 }
3737
fallingAlarm NOTIFICATION-TYPE
3738
OBJECTS { alarmIndex, alarmVariable, alarmSampleType,
3739
alarmValue, alarmFallingThreshold }
3742
"The SNMP trap that is generated when an alarm
3743
entry crosses its falling threshold and generates
3744
an event that is configured for sending SNMP
3746
::= { rmonEventsV2 2 }
3748
-- Conformance information
3750
rmonCompliances OBJECT IDENTIFIER ::= { rmonConformance 9 }
3751
rmonGroups OBJECT IDENTIFIER ::= { rmonConformance 10 }
3753
-- Compliance Statements
3754
rmonCompliance MODULE-COMPLIANCE
3757
"The requirements for conformance to the RMON MIB. At least
3758
one of the groups in this module must be implemented to
3759
conform to the RMON MIB. Implementations of this MIB
3760
must also implement the system group of MIB-II [16] and the
3762
MODULE -- this module
3764
GROUP rmonEtherStatsGroup
3766
"The RMON Ethernet Statistics Group is optional."
3768
GROUP rmonHistoryControlGroup
3770
"The RMON History Control Group is optional."
3772
GROUP rmonEthernetHistoryGroup
3774
"The RMON Ethernet History Group is optional."
3776
GROUP rmonAlarmGroup
3778
"The RMON Alarm Group is optional."
3782
"The RMON Host Group is mandatory when the
3783
rmonHostTopNGroup is implemented."
3785
GROUP rmonHostTopNGroup
3787
"The RMON Host Top N Group is optional."
3789
GROUP rmonMatrixGroup
3791
"The RMON Matrix Group is optional."
3793
GROUP rmonFilterGroup
3795
"The RMON Filter Group is mandatory when the
3796
rmonPacketCaptureGroup is implemented."
3798
GROUP rmonPacketCaptureGroup
3800
"The RMON Packet Capture Group is optional."
3802
GROUP rmonEventGroup
3804
"The RMON Event Group is mandatory when the
3805
rmonAlarmGroup is implemented."
3806
::= { rmonCompliances 1 }
3808
rmonEtherStatsGroup OBJECT-GROUP
3810
etherStatsIndex, etherStatsDataSource,
3811
etherStatsDropEvents, etherStatsOctets, etherStatsPkts,
3812
etherStatsBroadcastPkts, etherStatsMulticastPkts,
3813
etherStatsCRCAlignErrors, etherStatsUndersizePkts,
3814
etherStatsOversizePkts, etherStatsFragments,
3815
etherStatsJabbers, etherStatsCollisions,
3816
etherStatsPkts64Octets, etherStatsPkts65to127Octets,
3817
etherStatsPkts128to255Octets,
3818
etherStatsPkts256to511Octets,
3819
etherStatsPkts512to1023Octets,
3820
etherStatsPkts1024to1518Octets,
3821
etherStatsOwner, etherStatsStatus
3825
"The RMON Ethernet Statistics Group."
3826
::= { rmonGroups 1 }
3828
rmonHistoryControlGroup OBJECT-GROUP
3830
historyControlIndex, historyControlDataSource,
3831
historyControlBucketsRequested,
3832
historyControlBucketsGranted, historyControlInterval,
3833
historyControlOwner, historyControlStatus
3837
"The RMON History Control Group."
3838
::= { rmonGroups 2 }
3840
rmonEthernetHistoryGroup OBJECT-GROUP
3842
etherHistoryIndex, etherHistorySampleIndex,
3843
etherHistoryIntervalStart, etherHistoryDropEvents,
3844
etherHistoryOctets, etherHistoryPkts,
3845
etherHistoryBroadcastPkts, etherHistoryMulticastPkts,
3846
etherHistoryCRCAlignErrors, etherHistoryUndersizePkts,
3847
etherHistoryOversizePkts, etherHistoryFragments,
3848
etherHistoryJabbers, etherHistoryCollisions,
3849
etherHistoryUtilization
3853
"The RMON Ethernet History Group."
3854
::= { rmonGroups 3 }
3856
rmonAlarmGroup OBJECT-GROUP
3858
alarmIndex, alarmInterval, alarmVariable,
3859
alarmSampleType, alarmValue, alarmStartupAlarm,
3860
alarmRisingThreshold, alarmFallingThreshold,
3861
alarmRisingEventIndex, alarmFallingEventIndex,
3862
alarmOwner, alarmStatus
3866
"The RMON Alarm Group."
3867
::= { rmonGroups 4 }
3869
rmonHostGroup OBJECT-GROUP
3871
hostControlIndex, hostControlDataSource,
3872
hostControlTableSize, hostControlLastDeleteTime,
3873
hostControlOwner, hostControlStatus,
3874
hostAddress, hostCreationOrder, hostIndex,
3875
hostInPkts, hostOutPkts, hostInOctets,
3876
hostOutOctets, hostOutErrors, hostOutBroadcastPkts,
3877
hostOutMulticastPkts, hostTimeAddress,
3878
hostTimeCreationOrder, hostTimeIndex,
3879
hostTimeInPkts, hostTimeOutPkts, hostTimeInOctets,
3880
hostTimeOutOctets, hostTimeOutErrors,
3881
hostTimeOutBroadcastPkts, hostTimeOutMulticastPkts
3885
"The RMON Host Group."
3886
::= { rmonGroups 5 }
3888
rmonHostTopNGroup OBJECT-GROUP
3890
hostTopNControlIndex, hostTopNHostIndex,
3891
hostTopNRateBase, hostTopNTimeRemaining,
3892
hostTopNDuration, hostTopNRequestedSize,
3893
hostTopNGrantedSize, hostTopNStartTime,
3894
hostTopNOwner, hostTopNStatus,
3895
hostTopNReport, hostTopNIndex,
3896
hostTopNAddress, hostTopNRate
3900
"The RMON Host Top 'N' Group."
3901
::= { rmonGroups 6 }
3903
rmonMatrixGroup OBJECT-GROUP
3905
matrixControlIndex, matrixControlDataSource,
3906
matrixControlTableSize, matrixControlLastDeleteTime,
3907
matrixControlOwner, matrixControlStatus,
3908
matrixSDSourceAddress, matrixSDDestAddress,
3909
matrixSDIndex, matrixSDPkts,
3910
matrixSDOctets, matrixSDErrors,
3911
matrixDSSourceAddress, matrixDSDestAddress,
3912
matrixDSIndex, matrixDSPkts,
3913
matrixDSOctets, matrixDSErrors
3917
"The RMON Matrix Group."
3918
::= { rmonGroups 7 }
3920
rmonFilterGroup OBJECT-GROUP
3923
filterIndex, filterChannelIndex, filterPktDataOffset,
3924
filterPktData, filterPktDataMask,
3925
filterPktDataNotMask, filterPktStatus,
3926
filterPktStatusMask, filterPktStatusNotMask,
3927
filterOwner, filterStatus,
3928
channelIndex, channelIfIndex, channelAcceptType,
3929
channelDataControl, channelTurnOnEventIndex,
3930
channelTurnOffEventIndex, channelEventIndex,
3931
channelEventStatus, channelMatches,
3932
channelDescription, channelOwner, channelStatus
3936
"The RMON Filter Group."
3937
::= { rmonGroups 8 }
3939
rmonPacketCaptureGroup OBJECT-GROUP
3941
bufferControlIndex, bufferControlChannelIndex,
3942
bufferControlFullStatus, bufferControlFullAction,
3943
bufferControlCaptureSliceSize,
3944
bufferControlDownloadSliceSize,
3945
bufferControlDownloadOffset,
3946
bufferControlMaxOctetsRequested,
3947
bufferControlMaxOctetsGranted,
3948
bufferControlCapturedPackets,
3949
bufferControlTurnOnTime,
3950
bufferControlOwner, bufferControlStatus,
3951
captureBufferControlIndex, captureBufferIndex,
3952
captureBufferPacketID, captureBufferPacketData,
3953
captureBufferPacketLength, captureBufferPacketTime,
3954
captureBufferPacketStatus
3958
"The RMON Packet Capture Group."
3959
::= { rmonGroups 9 }
3961
rmonEventGroup OBJECT-GROUP
3963
eventIndex, eventDescription, eventType,
3964
eventCommunity, eventLastTimeSent,
3965
eventOwner, eventStatus,
3966
logEventIndex, logIndex, logTime,
3971
"The RMON Event Group."
3972
::= { rmonGroups 10 }
3974
rmonNotificationGroup NOTIFICATION-GROUP
3975
NOTIFICATIONS { risingAlarm, fallingAlarm }
3978
"The RMON Notification Group."
3979
::= { rmonGroups 11 }