1 RFC1271-MIB DEFINITIONS ::= BEGIN
4 Counter FROM RFC1155-SMI
5 mib-2, DisplayString FROM RFC1213-MIB
6 OBJECT-TYPE FROM RFC-1212;
8 -- This MIB module uses the extended OBJECT-TYPE macro as
12 -- Remote Network Monitoring MIB
14 rmon OBJECT IDENTIFIER ::= { mib-2 16 }
17 -- textual conventions
19 OwnerString ::= DisplayString
20 -- This data type is used to model an administratively
21 -- assigned name of the owner of a resource. This
22 -- information is taken from the NVT ASCII character set.
23 -- It is suggested that this name contain one or more
25 -- IP address, management station name, network manager's
26 -- name, location, or phone number.
27 -- In some cases the agent itself will be the owner of
28 -- an entry. In these cases, this string shall be set
29 -- to a string starting with 'monitor'.
32 -- SNMP access control is articulated entirely in terms of
33 -- the contents of MIB views; access to a particular SNMP
34 -- object instance depends only upon its presence or
35 -- absence in a particular MIB view and never upon its
36 -- value or the value of related object instances. Thus,
37 -- objects of this type afford resolution of resource
38 -- contention only among cooperating managers; they
39 -- realize no access control function with respect
40 -- to uncooperative parties.
42 -- By convention, objects with this syntax are declared
48 EntryStatus ::= INTEGER
55 -- The status of a table entry.
57 -- Setting this object to the value invalid(4) has the
58 -- effect of invalidating the corresponding entry.
59 -- That is, it effectively disassociates the mapping
60 -- identified with said entry.
61 -- It is an implementation-specific matter as to whether
62 -- the agent removes an invalidated entry from the table.
63 -- Accordingly, management stations must be prepared to
64 -- receive tabular information from agents that corresponds
65 -- to entries currently not in use. Proper
66 -- interpretation of such entries requires examination
67 -- of the relevant EntryStatus object.
69 -- An existing instance of this object cannot be set to
70 -- createRequest(2). This object may only be set to
71 -- createRequest(2) when this instance is created. When
72 -- this object is created, the agent may wish to create
73 -- supplemental object instances to complete a conceptual
74 -- row in this table. Immediately after completing the
75 -- create operation, the agent must set this object to
78 -- Entries shall exist in the underCreation(3) state until
80 -- the management station is finished configuring the
81 -- entry and sets this object to valid(1) or aborts,
82 -- setting this object to invalid(4). If the agent
83 -- determines that an entry has been in the
84 -- underCreation(3) state for an abnormally long time,
85 -- it may decide that the management station has
86 -- crashed. If the agent makes this decision,
87 -- it may set this object to invalid(4) to reclaim the
88 -- entry. A prudent agent will understand that the
89 -- management station may need to wait for human input
90 -- and will allow for that possibility in its
91 -- determination of this abnormally long period.
94 statistics OBJECT IDENTIFIER ::= { rmon 1 }
95 history OBJECT IDENTIFIER ::= { rmon 2 }
96 alarm OBJECT IDENTIFIER ::= { rmon 3 }
97 hosts OBJECT IDENTIFIER ::= { rmon 4 }
98 hostTopN OBJECT IDENTIFIER ::= { rmon 5 }
99 matrix OBJECT IDENTIFIER ::= { rmon 6 }
100 filter OBJECT IDENTIFIER ::= { rmon 7 }
101 capture OBJECT IDENTIFIER ::= { rmon 8 }
102 event OBJECT IDENTIFIER ::= { rmon 9 }
105 -- The Statistics Group
107 -- Implementation of the Statistics group is optional.
109 -- The statistics group contains statistics measured by the
110 -- probe for each monitored interface on this device. These
111 -- statistics take the form of free running counters that
112 -- start from zero when a valid entry is created.
114 -- This group currently has statistics defined only for
115 -- Ethernet interfaces. Each etherStatsEntry contains
116 -- statistics for one Ethernet interface. The probe must
117 -- create one etherStats entry for each monitored Ethernet
118 -- interface on the device.
120 etherStatsTable OBJECT-TYPE
121 SYNTAX SEQUENCE OF EtherStatsEntry
122 ACCESS not-accessible
125 "A list of Ethernet statistics entries."
128 etherStatsEntry OBJECT-TYPE
129 SYNTAX EtherStatsEntry
130 ACCESS not-accessible
133 "A collection of statistics kept for a particular
135 INDEX { etherStatsIndex }
136 ::= { etherStatsTable 1 }
138 EtherStatsEntry ::= SEQUENCE {
139 etherStatsIndex INTEGER (1..65535),
140 etherStatsDataSource OBJECT IDENTIFIER,
141 etherStatsDropEvents Counter,
142 etherStatsOctets Counter,
143 etherStatsPkts Counter,
144 etherStatsBroadcastPkts Counter,
145 etherStatsMulticastPkts Counter,
146 etherStatsCRCAlignErrors Counter,
147 etherStatsUndersizePkts Counter,
148 etherStatsOversizePkts Counter,
149 etherStatsFragments Counter,
150 etherStatsJabbers Counter,
151 etherStatsCollisions Counter,
152 etherStatsPkts64Octets Counter,
153 etherStatsPkts65to127Octets Counter,
154 etherStatsPkts128to255Octets Counter,
155 etherStatsPkts256to511Octets Counter,
156 etherStatsPkts512to1023Octets Counter,
157 etherStatsPkts1024to1518Octets Counter,
158 etherStatsOwner OwnerString,
159 etherStatsStatus INTEGER
162 etherStatsIndex OBJECT-TYPE
163 SYNTAX INTEGER (1..65535)
167 "The value of this object uniquely identifies this
169 ::= { etherStatsEntry 1 }
171 etherStatsDataSource OBJECT-TYPE
172 SYNTAX OBJECT IDENTIFIER
176 "This object identifies the source of the data that
177 this etherStats entry is configured to analyze. This
178 source can be any ethernet interface on this device.
179 In order to identify a particular interface, this
180 object shall identify the instance of the ifIndex
181 object, defined in [4,6], for the desired interface.
182 For example, if an entry were to receive data from
183 interface #1, this object would be set to ifIndex.1.
185 The statistics in this group reflect all packets
186 on the local network segment attached to the
187 identified interface.
189 This object may not be modified if the associated
190 etherStatsStatus object is equal to valid(1)."
191 ::= { etherStatsEntry 2 }
193 etherStatsDropEvents OBJECT-TYPE
198 "The total number of events in which packets
199 were dropped by the probe due to lack of resources.
200 Note that this number is not necessarily the number of
201 packets dropped; it is just the number of times this
202 condition has been detected."
203 ::= { etherStatsEntry 3 }
205 etherStatsOctets OBJECT-TYPE
210 "The total number of octets of data (including
211 those in bad packets) received on the
212 network (excluding framing bits but including
214 ::= { etherStatsEntry 4 }
216 etherStatsPkts OBJECT-TYPE
221 "The total number of packets (including error packets)
223 ::= { etherStatsEntry 5 }
225 etherStatsBroadcastPkts OBJECT-TYPE
230 "The total number of good packets received that were
231 directed to the broadcast address."
232 ::= { etherStatsEntry 6 }
234 etherStatsMulticastPkts OBJECT-TYPE
239 "The total number of good packets received that were
240 directed to a multicast address. Note that this
241 number does not include packets directed to the
243 ::= { etherStatsEntry 7 }
245 etherStatsCRCAlignErrors OBJECT-TYPE
250 "The total number of packets received that
251 had a length (excluding framing bits, but
252 including FCS octets) of between 64 and 1518
253 octets, inclusive, but were not an integral number
254 of octets in length or had a bad Frame Check
256 ::= { etherStatsEntry 8 }
258 etherStatsUndersizePkts OBJECT-TYPE
263 "The total number of packets received that were
264 less than 64 octets long (excluding framing bits,
265 but including FCS octets) and were otherwise well
267 ::= { etherStatsEntry 9 }
269 etherStatsOversizePkts OBJECT-TYPE
274 "The total number of packets received that were
275 longer than 1518 octets (excluding framing bits,
276 but including FCS octets) and were otherwise
278 ::= { etherStatsEntry 10 }
280 etherStatsFragments OBJECT-TYPE
285 "The total number of packets received that were not an
286 integral number of octets in length or that had a bad
287 Frame Check Sequence (FCS), and were less than 64
288 octets in length (excluding framing bits but
289 including FCS octets)."
290 ::= { etherStatsEntry 11 }
292 etherStatsJabbers OBJECT-TYPE
297 "The total number of packets received that were
298 longer than 1518 octets (excluding framing bits,
299 but including FCS octets), and were not an
300 integral number of octets in length or had
301 a bad Frame Check Sequence (FCS)."
302 ::= { etherStatsEntry 12 }
304 etherStatsCollisions OBJECT-TYPE
309 "The best estimate of the total number of collisions
310 on this Ethernet segment."
311 ::= { etherStatsEntry 13 }
313 etherStatsPkts64Octets OBJECT-TYPE
318 "The total number of packets (including error
319 packets) received that were 64 octets in length
320 (excluding framing bits but including FCS octets)."
321 ::= { etherStatsEntry 14 }
323 etherStatsPkts65to127Octets OBJECT-TYPE
328 "The total number of packets (including error
329 packets) received that were between
330 65 and 127 octets in length inclusive
331 (excluding framing bits but including FCS octets)."
332 ::= { etherStatsEntry 15 }
334 etherStatsPkts128to255Octets OBJECT-TYPE
339 "The total number of packets (including error
340 packets) received that were between
341 128 and 255 octets in length inclusive
342 (excluding framing bits but including FCS octets)."
343 ::= { etherStatsEntry 16 }
345 etherStatsPkts256to511Octets OBJECT-TYPE
350 "The total number of packets (including error
351 packets) received that were between
352 256 and 511 octets in length inclusive
353 (excluding framing bits but including FCS octets)."
354 ::= { etherStatsEntry 17 }
356 etherStatsPkts512to1023Octets OBJECT-TYPE
361 "The total number of packets (including error
362 packets) received that were between
363 512 and 1023 octets in length inclusive
364 (excluding framing bits but including FCS octets)."
365 ::= { etherStatsEntry 18 }
367 etherStatsPkts1024to1518Octets OBJECT-TYPE
372 "The total number of packets (including error
373 packets) received that were between
374 1024 and 1518 octets in length inclusive
375 (excluding framing bits but including FCS octets)."
376 ::= { etherStatsEntry 19 }
378 etherStatsOwner OBJECT-TYPE
383 "The entity that configured this entry and is
384 therefore using the resources assigned to it."
385 ::= { etherStatsEntry 20 }
387 etherStatsStatus OBJECT-TYPE
392 "The status of this etherStats entry."
393 ::= { etherStatsEntry 21 }
398 -- Implementation of the History group is optional.
400 -- The history group records periodic statistical samples from
401 -- a network and stores them for later retrieval. The
402 -- historyControl table stores configuration entries that each
403 -- define an interface, polling period, and other parameters.
404 -- Once samples are taken, their data is stored in an entry
405 -- in a media-specific table. Each such entry defines one
406 -- sample, and is associated with the historyControlEntry that
407 -- caused the sample to be taken. Currently the only media-
408 -- specific table defined is the etherHistoryTable, for
409 -- Ethernet networks.
411 -- If the probe keeps track of the time of day, it should
412 -- start the first sample of the history at a time such that
413 -- when the next hour of the day begins, a sample is
414 -- started at that instant. This tends to make more
416 -- user-friendly reports, and enables comparison of reports
417 -- from different probes that have relatively accurate time
420 -- The monitor is encouraged to add two history control entries
421 -- per monitored interface upon initialization that describe
422 -- a short term and a long term polling period. Suggested
423 -- parameters are 30 seconds for the short term polling
424 -- period and 30 minutes for the long term period.
426 historyControlTable OBJECT-TYPE
427 SYNTAX SEQUENCE OF HistoryControlEntry
428 ACCESS not-accessible
431 "A list of history control entries."
434 historyControlEntry OBJECT-TYPE
435 SYNTAX HistoryControlEntry
436 ACCESS not-accessible
439 "A list of parameters that set up a periodic
440 sampling of statistics."
441 INDEX { historyControlIndex }
442 ::= { historyControlTable 1 }
444 HistoryControlEntry ::= SEQUENCE {
445 historyControlIndex INTEGER (1..65535),
446 historyControlDataSource OBJECT IDENTIFIER,
447 historyControlBucketsRequested INTEGER (1..65535),
448 historyControlBucketsGranted INTEGER (1..65535),
449 historyControlInterval INTEGER (1..3600),
450 historyControlOwner OwnerString,
451 historyControlStatus INTEGER
454 historyControlIndex OBJECT-TYPE
455 SYNTAX INTEGER (1..65535)
459 "An index that uniquely identifies an entry in the
460 historyControl table. Each such entry defines a
461 set of samples at a particular interval for an
462 interface on the device."
463 ::= { historyControlEntry 1 }
465 historyControlDataSource OBJECT-TYPE
466 SYNTAX OBJECT IDENTIFIER
470 "This object identifies the source of the data for
471 which historical data was collected and
472 placed in a media-specific table on behalf of this
473 historyControlEntry. This source can be any
474 interface on this device. In order to identify
475 a particular interface, this object shall identify
476 the instance of the ifIndex object, defined
477 in [4,6], for the desired interface. For example,
478 if an entry were to receive data from interface #1,
479 this object would be set to ifIndex.1.
481 The statistics in this group reflect all packets
482 on the local network segment attached to the
483 identified interface.
485 This object may not be modified if the associated
486 historyControlStatus object is equal to valid(1)."
487 ::= { historyControlEntry 2 }
489 historyControlBucketsRequested OBJECT-TYPE
490 SYNTAX INTEGER (1..65535)
494 "The requested number of discrete time intervals
495 over which data is to be saved in the part of the
496 media-specific table associated with this
497 historyControl entry.
499 When this object is created or modified, the probe
500 should set historyControlBucketsGranted as closely to
501 this object as is possible for the particular probe
502 implementation and available resources."
504 ::= { historyControlEntry 3 }
506 historyControlBucketsGranted OBJECT-TYPE
507 SYNTAX INTEGER (1..65535)
511 "The number of discrete sampling intervals
512 over which data shall be saved in the part of
513 the media-specific table associated with this
514 historyControl entry.
516 When the associated historyControlBucketsRequested
517 object is created or modified, the probe
518 should set this object as closely to the requested
519 value as is possible for the particular
520 probe implementation and available resources. The
521 probe must not lower this value except as a result
522 of a modification to the associated
523 historyControlBucketsRequested object.
525 There will be times when the actual number of
526 buckets associated with this entry is less than
527 the value of this object. In this case, at the
528 end of each sampling interval, a new bucket will
529 be added to the media-specific table.
531 When the number of buckets reaches the value of
532 this object and a new bucket is to be added to the
533 media-specific table, the oldest bucket associated
534 with this historyControlEntry shall be deleted by
535 the agent so that the new bucket can be added.
537 When the value of this object changes to a value less
538 than the current value, entries are deleted
539 from the media-specific table associated with this
540 historyControlEntry. Enough of the oldest of these
541 entries shall be deleted by the agent so that their
542 number remains less than or equal to the new value of
545 When the value of this object changes to a value
546 greater than the current value, the number of
547 associated media-specific entries may be allowed
549 ::= { historyControlEntry 4 }
551 historyControlInterval OBJECT-TYPE
552 SYNTAX INTEGER (1..3600)
556 "The interval in seconds over which the data is
557 sampled for each bucket in the part of the
558 media-specific table associated with this
559 historyControl entry. This interval can
560 be set to any number of seconds between 1 and
563 Because the counters in a bucket may overflow at their
564 maximum value with no indication, a prudent manager
565 will take into account the possibility of overflow
566 in any of the associated counters. It is important
567 to consider the minimum time in which any counter
568 could overflow on a particular media type and set
569 the historyControlInterval object to a value less
570 than this interval. This is typically most
571 important for the 'octets' counter in any
572 media-specific table. For example, on an Ethernet
573 network, the etherHistoryOctets counter could overflow
574 in about one hour at the Ethernet's maximum
577 This object may not be modified if the associated
578 historyControlStatus object is equal to valid(1)."
580 ::= { historyControlEntry 5 }
582 historyControlOwner OBJECT-TYPE
587 "The entity that configured this entry and is therefore
588 using the resources assigned to it."
589 ::= { historyControlEntry 6 }
591 historyControlStatus OBJECT-TYPE
596 "The status of this historyControl entry.
598 Each instance of the media-specific table associated
599 with this historyControlEntry will be deleted by the
600 agent if this historyControlEntry is not equal to
602 ::= { historyControlEntry 7 }
605 -- Ether History table
607 etherHistoryTable OBJECT-TYPE
608 SYNTAX SEQUENCE OF EtherHistoryEntry
609 ACCESS not-accessible
612 "A list of Ethernet history entries."
615 etherHistoryEntry OBJECT-TYPE
616 SYNTAX EtherHistoryEntry
617 ACCESS not-accessible
620 "An historical sample of Ethernet statistics on a
621 particular Ethernet interface. This sample is
622 associated with the historyControlEntry which set
623 up the parameters for a regular collection of these
625 INDEX { etherHistoryIndex , etherHistorySampleIndex }
626 ::= { etherHistoryTable 1 }
628 EtherHistoryEntry ::= SEQUENCE {
629 etherHistoryIndex INTEGER (1..65535),
630 etherHistorySampleIndex INTEGER,
631 etherHistoryIntervalStart TimeTicks,
632 etherHistoryDropEvents Counter,
633 etherHistoryOctets Counter,
634 etherHistoryPkts Counter,
635 etherHistoryBroadcastPkts Counter,
636 etherHistoryMulticastPkts Counter,
637 etherHistoryCRCAlignErrors Counter,
638 etherHistoryUndersizePkts Counter,
639 etherHistoryOversizePkts Counter,
640 etherHistoryFragments Counter,
641 etherHistoryJabbers Counter,
642 etherHistoryCollisions Counter,
643 etherHistoryUtilization INTEGER (0..10000)
646 etherHistoryIndex OBJECT-TYPE
647 SYNTAX INTEGER (1..65535)
651 "The history of which this entry is a part. The
652 history identified by a particular value of this
653 index is the same history as identified
654 by the same value of historyControlIndex."
655 ::= { etherHistoryEntry 1 }
657 etherHistorySampleIndex OBJECT-TYPE
662 "An index that uniquely identifies the particular
663 sample this entry represents among all samples
664 associated with the same historyControlEntry.
665 This index starts at 1 and increases by one
666 as each new sample is taken."
667 ::= { etherHistoryEntry 2 }
669 etherHistoryIntervalStart OBJECT-TYPE
674 "The value of sysUpTime at the start of the interval
675 over which this sample was measured. If the probe
676 keeps track of the time of day, it should start
677 the first sample of the history at a time such that
678 when the next hour of the day begins, a sample is
679 started at that instant. Note that following this
680 rule may require the probe to delay collecting the
681 first sample of the history, as each sample must be
682 of the same interval. Also note that the sample which
683 is currently being collected is not accessible in this
684 table until the end of its interval."
685 ::= { etherHistoryEntry 3 }
687 etherHistoryDropEvents OBJECT-TYPE
692 "The total number of events in which packets
693 were dropped by the probe due to lack of resources
694 during this interval. Note that this number is not
695 necessarily the number of packets dropped, it is just
696 the number of times this condition has been detected."
697 ::= { etherHistoryEntry 4 }
699 etherHistoryOctets OBJECT-TYPE
704 "The total number of octets of data (including
705 those in bad packets) received on the
706 network (excluding framing bits but including
708 ::= { etherHistoryEntry 5 }
710 etherHistoryPkts OBJECT-TYPE
715 "The number of packets (including error packets)
716 received during this sampling interval."
717 ::= { etherHistoryEntry 6 }
719 etherHistoryBroadcastPkts OBJECT-TYPE
724 "The number of good packets received during this
725 sampling interval that were directed to the
727 ::= { etherHistoryEntry 7 }
729 etherHistoryMulticastPkts OBJECT-TYPE
734 "The number of good packets received during this
735 sampling interval that were directed to a
736 multicast address. Note that this number does not
737 include packets addressed to the broadcast address."
738 ::= { etherHistoryEntry 8 }
740 etherHistoryCRCAlignErrors OBJECT-TYPE
745 "The number of packets received during this
746 sampling interval that had a length (excluding
747 framing bits but including FCS octets) between
748 64 and 1518 octets, inclusive, but were not an
749 integral number of octets in length or had a
750 bad Frame Check Sequence (FCS)."
751 ::= { etherHistoryEntry 9 }
753 etherHistoryUndersizePkts OBJECT-TYPE
758 "The number of packets received during this
759 interval that were less than 64 octets long
760 (excluding framing bits but including FCS
761 octets) and were otherwise well formed."
762 ::= { etherHistoryEntry 10 }
764 etherHistoryOversizePkts OBJECT-TYPE
769 "The number of packets received during this
770 interval that were longer than 1518 octets
771 (excluding framing bits but including FCS
772 octets) but were otherwise well formed."
773 ::= { etherHistoryEntry 11 }
775 etherHistoryFragments OBJECT-TYPE
780 "The total number of packets received during this
781 sampling interval that were not an integral
782 number of octets in length or that
783 had a bad Frame Check Sequence (FCS), and
784 were less than 64 octets in length (excluding
785 framing bits but including FCS octets)."
786 ::= { etherHistoryEntry 12 }
788 etherHistoryJabbers OBJECT-TYPE
793 "The number of packets received during this
794 interval that were longer than 1518 octets
795 (excluding framing bits but including FCS octets),
796 and were not an integral number of octets in
797 length or had a bad Frame Check Sequence (FCS)."
798 ::= { etherHistoryEntry 13 }
800 etherHistoryCollisions OBJECT-TYPE
805 "The best estimate of the total number of collisions
806 on this Ethernet segment during this interval."
807 ::= { etherHistoryEntry 14 }
809 etherHistoryUtilization OBJECT-TYPE
810 SYNTAX INTEGER (0..10000)
814 "The best estimate of the mean physical layer
815 network utilization on this interface during this
816 interval, in hundredths of a percent."
817 ::= { etherHistoryEntry 15 }
822 -- Implementation of the Alarm group is optional.
824 -- The Alarm Group requires the implementation of the Event
827 -- The Alarm group periodically takes statistical samples from
828 -- variables in the probe and compares them to thresholds
829 -- that have been configured. The alarm table stores
830 -- configuration entries that each define a variable,
831 -- polling period, and threshold parameters. If a sample is
832 -- found to cross the threshold values, an event is
833 -- generated. Only variables that resolve to an ASN.1
834 -- primitive type of INTEGER (INTEGER, Counter,
835 -- Gauge, or TimeTicks) may be monitored in this way.
837 -- This function has a hysteresis mechanism to limit the
838 -- generation of events. This mechanism generates one event
839 -- as a threshold is crossed in the appropriate direction.
840 -- No more events are generated for that threshold until the
841 -- opposite threshold is crossed.
843 -- In the case of a sampling a deltaValue, a probe may
844 -- implement this mechanism with more precision if it takes
845 -- a delta sample twice per period, each time comparing the
846 -- sum of the latest two samples to the threshold. This
847 -- allows the detection of threshold crossings
849 -- that span the sampling boundary. Note that this does not
850 -- require any special configuration of the threshold value.
851 -- It is suggested that probes implement this more precise
854 alarmTable OBJECT-TYPE
855 SYNTAX SEQUENCE OF AlarmEntry
856 ACCESS not-accessible
859 "A list of alarm entries."
862 alarmEntry OBJECT-TYPE
864 ACCESS not-accessible
867 "A list of parameters that set up a periodic checking
868 for alarm conditions."
872 AlarmEntry ::= SEQUENCE {
873 alarmIndex INTEGER (1..65535),
874 alarmInterval INTEGER,
875 alarmVariable OBJECT IDENTIFIER,
876 alarmSampleType INTEGER,
878 alarmStartupAlarm INTEGER,
879 alarmRisingThreshold INTEGER,
880 alarmFallingThreshold INTEGER,
881 alarmRisingEventIndex INTEGER (1..65535),
882 alarmFallingEventIndex INTEGER (1..65535),
883 alarmOwner OwnerString,
887 alarmIndex OBJECT-TYPE
888 SYNTAX INTEGER (1..65535)
892 "An index that uniquely identifies an entry in the
893 alarm table. Each such entry defines a
894 diagnostic sample at a particular interval
895 for an object on the device."
898 alarmInterval OBJECT-TYPE
903 "The interval in seconds over which the data is
904 sampled and compared with the rising and falling
905 thresholds. When setting this variable, care
906 should be given to ensure that the variable being
907 monitored will not exceed 2^31 - 1 and roll
908 over the alarmValue object during the interval.
910 This object may not be modified if the associated
911 alarmStatus object is equal to valid(1)."
914 alarmVariable OBJECT-TYPE
915 SYNTAX OBJECT IDENTIFIER
919 "The object identifier of the particular variable to
920 be sampled. Only variables that resolve to an ASN.1
921 primitive type of INTEGER (INTEGER, Counter, Gauge,
922 or TimeTicks) may be sampled.
924 Because SNMP access control is articulated entirely
925 in terms of the contents of MIB views, no access
926 control mechanism exists that can restrict the value of
927 this object to identify only those objects that exist
928 in a particular MIB view. Because there is thus no
929 acceptable means of restricting the read access that
930 could be obtained through the alarm mechanism, the
931 probe must only grant write access to this object in
932 those views that have read access to all objects on
935 During a set operation, if the supplied variable
936 name is not available in the selected MIB view, a
937 badValue error must be returned. If at any time
938 the variable name of an established alarmEntry is
939 no longer available in the selected MIB view, the
940 probe must change the status of this alarmEntry
943 This object may not be modified if the associated
944 alarmStatus object is equal to valid(1)."
947 alarmSampleType OBJECT-TYPE
955 "The method of sampling the selected variable and
956 calculating the value to be compared against the
957 thresholds. If the value of this object is
958 absoluteValue(1), the value of the selected variable
959 will be compared directly with the thresholds at the
960 end of the sampling interval. If the value of this
961 object is deltaValue(2), the value of the selected
962 variable at the last sample will be subtracted from
963 the current value, and the difference compared with
966 This object may not be modified if the associated
967 alarmStatus object is equal to valid(1)."
970 alarmValue OBJECT-TYPE
975 "The value of the statistic during the last sampling
976 period. The value during the current sampling period
977 is not made available until the period is completed."
980 alarmStartupAlarm OBJECT-TYPE
984 risingOrFallingAlarm(3)
989 "The alarm that may be sent when this entry is first
990 set to valid. If the first sample after this entry
991 becomes valid is greater than or equal to the
992 risingThreshold and alarmStartupAlarm is equal to
993 risingAlarm(1) or risingOrFallingAlarm(3), then a
994 single rising alarm will be generated. If the first
995 sample after this entry becomes valid is less than
996 or equal to the fallingThreshold and
997 alarmStartupAlarm is equal to fallingAlarm(2) or
998 risingOrFallingAlarm(3), then a single falling
999 alarm will be generated.
1001 This object may not be modified if the associated
1002 alarmStatus object is equal to valid(1)."
1003 ::= { alarmEntry 6 }
1005 alarmRisingThreshold OBJECT-TYPE
1010 "A threshold for the sampled statistic. When the
1011 current sampled value is greater than or equal to
1012 this threshold, and the value at the last sampling
1013 interval was less than this threshold, a single
1014 event will be generated.
1015 A single event will also be generated if the first
1016 sample after this entry becomes valid is greater
1017 than or equal to this threshold and the associated
1018 alarmStartupAlarm is equal to risingAlarm(1) or
1019 risingOrFallingAlarm(3).
1021 After a rising event is generated, another such event
1022 will not be generated until the sampled value
1023 falls below this threshold and reaches the
1024 alarmFallingThreshold.
1026 This object may not be modified if the associated
1027 alarmStatus object is equal to valid(1)."
1028 ::= { alarmEntry 7 }
1030 alarmFallingThreshold OBJECT-TYPE
1035 "A threshold for the sampled statistic. When the
1036 current sampled value is less than or equal to
1037 this threshold, and the value at the last sampling
1038 interval was greater than this threshold, a single
1039 event will be generated.
1040 A single event will also be generated if the first
1041 sample after this entry becomes valid is less than or
1042 equal to this threshold and the associated
1043 alarmStartupAlarm is equal to fallingAlarm(2) or
1044 risingOrFallingAlarm(3).
1046 After a falling event is generated, another such event
1047 will not be generated until the sampled value
1048 rises above this threshold and reaches the
1049 alarmRisingThreshold.
1051 This object may not be modified if the associated
1052 alarmStatus object is equal to valid(1)."
1053 ::= { alarmEntry 8 }
1055 alarmRisingEventIndex OBJECT-TYPE
1056 SYNTAX INTEGER (0..65535)
1060 "The index of the eventEntry that is
1061 used when a rising threshold is crossed. The
1062 eventEntry identified by a particular value of
1063 this index is the same as identified by the same value
1064 of the eventIndex object. If there is no
1065 corresponding entry in the eventTable, then
1066 no association exists. In particular, if this value
1067 is zero, no associated event will be generated, as
1068 zero is not a valid event index.
1070 This object may not be modified if the associated
1071 alarmStatus object is equal to valid(1)."
1072 ::= { alarmEntry 9 }
1074 alarmFallingEventIndex OBJECT-TYPE
1075 SYNTAX INTEGER (0..65535)
1079 "The index of the eventEntry that is
1080 used when a falling threshold is crossed. The
1081 eventEntry identified by a particular value of
1082 this index is the same as identified by the same value
1083 of the eventIndex object. If there is no
1084 corresponding entry in the eventTable, then
1085 no association exists. In particular, if this value
1086 is zero, no associated event will be generated, as
1087 zero is not a valid event index.
1089 This object may not be modified if the associated
1090 alarmStatus object is equal to valid(1)."
1091 ::= { alarmEntry 10 }
1093 alarmOwner OBJECT-TYPE
1098 "The entity that configured this entry and is
1099 therefore using the resources assigned to it."
1100 ::= { alarmEntry 11 }
1102 alarmStatus OBJECT-TYPE
1107 "The status of this alarm entry."
1108 ::= { alarmEntry 12 }
1113 -- Implementation of the Host group is optional.
1115 -- The host group discovers new hosts on the network by
1116 -- keeping a list of source and destination MAC Addresses seen
1117 -- in good packets. For each of these addresses, the host
1118 -- group keeps a set of statistics. The hostControlTable
1119 -- controls which interfaces this function is performed on,
1120 -- and contains some information about the process. On
1121 -- behalf of each hostControlEntry, data is collected on an
1122 -- interface and placed both the hostTable and the
1123 -- hostTimeTable. If the monitoring device finds itself
1124 -- short of resources, it may delete entries as needed. It
1125 -- is suggested that the device delete the least recently
1126 -- used entries first.
1128 -- The hostTable contains entries for each address
1129 -- discovered on a particular interface. Each entry
1130 -- contains statistical data about that host. This table
1131 -- is indexed by the MAC address of the host, through
1132 -- which a random access may be achieved.
1134 -- The hostTimeTable contains data in the same format as the
1135 -- hostTable, and must contain the same set of hosts, but is
1136 -- indexed using hostTimeCreationOrder rather than hostAddress.
1137 -- The hostTimeCreationOrder is an integer which reflects
1138 -- the relative order in which a particular entry was
1140 -- discovered and thus inserted into the table. As this
1141 -- order, and thus index, is among those entries currently
1142 -- in the table, the index for a particular entry may change
1143 -- if an (earlier) entry is deleted. Thus the association
1144 -- between hostTimeCreationOrder and hostTimeEntry may be
1145 -- broken at any time.
1147 -- The hostTimeTable has two important uses. The first is the
1148 -- fast download of this potentially large table. Because the
1149 -- index of this table runs from 1 to the size of the table,
1150 -- inclusive, its values are predictable. This allows very
1151 -- efficient packing of variables into SNMP PDU's and allows
1152 -- a table transfer to have multiple packets outstanding.
1153 -- These benefits increase transfer rates tremendously.
1155 -- The second use of the hostTimeTable is the efficient
1156 -- discovery by the management station of new entries added
1157 -- to the table. After the management station has
1158 -- downloaded the entire table, it knows that new entries
1159 -- will be added immediately after the end of the current
1160 -- table. It can thus detect new entries there
1161 -- and retrieve them easily.
1163 -- Because the association between hostTimeCreationOrder and
1164 -- hostTimeEntry may be broken at any time, the management
1165 -- station must monitor the related hostControlLastDeleteTime
1166 -- object. When the management station thus detects a deletion,
1167 -- it must assume that any such associations have been broken,
1168 -- and invalidate any it has stored locally. This includes
1169 -- restarting any download of the hostTimeTable that may have
1170 -- been in progress, as well as rediscovering the end of the
1171 -- hostTimeTable so that it may detect new entries. If the
1172 -- management station does not detect the broken association,
1173 -- it may continue to refer to a particular host by its
1174 -- creationOrder while unwittingly retrieving the data
1175 -- associated with another host entirely. If this happens
1176 -- while downloading the host table, the management station
1177 -- may fail to download all of the entries in the table.
1180 hostControlTable OBJECT-TYPE
1181 SYNTAX SEQUENCE OF HostControlEntry
1182 ACCESS not-accessible
1185 "A list of host table control entries."
1188 hostControlEntry OBJECT-TYPE
1189 SYNTAX HostControlEntry
1190 ACCESS not-accessible
1193 "A list of parameters that set up the discovery of
1194 hosts on a particular interface and the collection
1195 of statistics about these hosts."
1196 INDEX { hostControlIndex }
1197 ::= { hostControlTable 1 }
1199 HostControlEntry ::= SEQUENCE {
1200 hostControlIndex INTEGER (1..65535),
1201 hostControlDataSource OBJECT IDENTIFIER,
1202 hostControlTableSize INTEGER,
1203 hostControlLastDeleteTime TimeTicks,
1204 hostControlOwner OwnerString,
1205 hostControlStatus INTEGER
1208 hostControlIndex OBJECT-TYPE
1209 SYNTAX INTEGER (1..65535)
1213 "An index that uniquely identifies an entry in the
1214 hostControl table. Each such entry defines
1215 a function that discovers hosts on a particular
1216 interface and places statistics about them in the
1217 hostTable and the hostTimeTable on behalf of this
1219 ::= { hostControlEntry 1 }
1221 hostControlDataSource OBJECT-TYPE
1222 SYNTAX OBJECT IDENTIFIER
1226 "This object identifies the source of the data for
1227 this instance of the host function. This source
1228 can be any interface on this device. In order
1229 to identify a particular interface, this object shall
1230 identify the instance of the ifIndex object, defined
1231 in [4,6], for the desired interface. For example,
1232 if an entry were to receive data from interface #1,
1233 this object would be set to ifIndex.1.
1235 The statistics in this group reflect all packets
1236 on the local network segment attached to the
1237 identified interface.
1239 This object may not be modified if the associated
1240 hostControlStatus object is equal to valid(1)."
1241 ::= { hostControlEntry 2 }
1243 hostControlTableSize OBJECT-TYPE
1248 "The number of hostEntries in the hostTable and the
1249 hostTimeTable associated with this hostControlEntry."
1250 ::= { hostControlEntry 3 }
1252 hostControlLastDeleteTime OBJECT-TYPE
1257 "The value of sysUpTime when the last entry
1258 was deleted from the portion of the hostTable
1259 associated with this hostControlEntry. If no
1260 deletions have occurred, this value shall be zero."
1261 ::= { hostControlEntry 4 }
1263 hostControlOwner OBJECT-TYPE
1268 "The entity that configured this entry and is
1269 therefore using the resources assigned to it."
1270 ::= { hostControlEntry 5 }
1272 hostControlStatus OBJECT-TYPE
1277 "The status of this hostControl entry.
1279 If this object is not equal to valid(1), all
1280 associated entries in the hostTable,
1281 hostTimeTable, and the hostTopNTable shall be
1282 deleted by the agent."
1283 ::= { hostControlEntry 6 }
1285 hostTable OBJECT-TYPE
1286 SYNTAX SEQUENCE OF HostEntry
1287 ACCESS not-accessible
1290 "A list of host entries."
1293 hostEntry OBJECT-TYPE
1295 ACCESS not-accessible
1298 "A collection of statistics for a particular host
1299 that has been discovered on an interface of this
1301 INDEX { hostIndex, hostAddress }
1304 HostEntry ::= SEQUENCE {
1305 hostAddress OCTET STRING,
1306 hostCreationOrder INTEGER (1..65535),
1307 hostIndex INTEGER (1..65535),
1309 hostOutPkts Counter,
1310 hostInOctets Counter,
1311 hostOutOctets Counter,
1312 hostOutErrors Counter,
1313 hostOutBroadcastPkts Counter,
1314 hostOutMulticastPkts Counter
1317 hostAddress OBJECT-TYPE
1322 "The physical address of this host."
1325 hostCreationOrder OBJECT-TYPE
1326 SYNTAX INTEGER (1..65535)
1330 "An index that defines the relative ordering of
1331 the creation time of hosts captured for a
1332 particular hostControlEntry. This index shall
1333 be between 1 and N, where N is the value of
1334 the associated hostControlTableSize. The ordering
1335 of the indexes is based on the order of each entry's
1336 insertion into the table, in which entries added
1337 earlier have a lower index value than entries added
1340 It is important to note that the order for a
1341 particular entry may change as an (earlier) entry
1342 is deleted from the table. Because this order may
1343 change, management stations should make use of the
1344 hostControlLastDeleteTime variable in the
1345 hostControlEntry associated with the relevant
1346 portion of the hostTable. By observing
1347 this variable, the management station may detect
1348 the circumstances where a previous association
1349 between a value of hostCreationOrder
1350 and a hostEntry may no longer hold."
1353 hostIndex OBJECT-TYPE
1354 SYNTAX INTEGER (1..65535)
1358 "The set of collected host statistics of which
1359 this entry is a part. The set of hosts
1360 identified by a particular value of this
1361 index is associated with the hostControlEntry
1362 as identified by the same value of hostControlIndex."
1365 hostInPkts OBJECT-TYPE
1370 "The number of packets without errors transmitted to
1371 this address since it was added to the hostTable."
1374 hostOutPkts OBJECT-TYPE
1379 "The number of packets including errors transmitted
1380 by this address since it was added to the hostTable."
1383 hostInOctets OBJECT-TYPE
1388 "The number of octets transmitted to this address
1389 since it was added to the hostTable (excluding
1390 framing bits but including FCS octets), except for
1391 those octets in packets that contained errors."
1394 hostOutOctets OBJECT-TYPE
1399 "The number of octets transmitted by this address
1400 since it was added to the hostTable (excluding
1401 framing bits but including FCS octets), including
1402 those octets in packets that contained errors."
1405 hostOutErrors OBJECT-TYPE
1410 "The number of error packets transmitted by this
1411 address since this host was added to the hostTable."
1414 hostOutBroadcastPkts OBJECT-TYPE
1419 "The number of good packets transmitted by this
1420 address that were directed to the broadcast address
1421 since this host was added to the hostTable."
1424 hostOutMulticastPkts OBJECT-TYPE
1429 "The number of good packets transmitted by this
1430 address that were directed to a multicast address
1431 since this host was added to the hostTable.
1432 Note that this number does not include packets
1433 directed to the broadcast address."
1434 ::= { hostEntry 10 }
1439 hostTimeTable OBJECT-TYPE
1440 SYNTAX SEQUENCE OF HostTimeEntry
1441 ACCESS not-accessible
1444 "A list of time-ordered host table entries."
1447 hostTimeEntry OBJECT-TYPE
1448 SYNTAX HostTimeEntry
1449 ACCESS not-accessible
1452 "A collection of statistics for a particular host
1453 that has been discovered on an interface of this
1454 device. This collection includes the relative
1455 ordering of the creation time of this object."
1456 INDEX { hostTimeIndex, hostTimeCreationOrder }
1457 ::= { hostTimeTable 1 }
1459 HostTimeEntry ::= SEQUENCE {
1460 hostTimeAddress OCTET STRING,
1461 hostTimeCreationOrder INTEGER (1..65535),
1462 hostTimeIndex INTEGER (1..65535),
1463 hostTimeInPkts Counter,
1464 hostTimeOutPkts Counter,
1465 hostTimeInOctets Counter,
1466 hostTimeOutOctets Counter,
1467 hostTimeOutErrors Counter,
1468 hostTimeOutBroadcastPkts Counter,
1469 hostTimeOutMulticastPkts Counter
1472 hostTimeAddress OBJECT-TYPE
1477 "The physical address of this host."
1478 ::= { hostTimeEntry 1 }
1480 hostTimeCreationOrder OBJECT-TYPE
1481 SYNTAX INTEGER (1..65535)
1485 "An index that uniquely identifies an entry in
1486 the hostTime table among those entries associated
1487 with the same hostControlEntry. This index shall
1488 be between 1 and N, where N is the value of
1489 the associated hostControlTableSize. The ordering
1490 of the indexes is based on the order of each entry's
1491 insertion into the table, in which entries added
1492 earlier have a lower index value than entries added
1493 later. Thus the management station has the ability
1494 to learn of new entries added to this table without
1495 downloading the entire table.
1497 It is important to note that the index for a
1498 particular entry may change as an (earlier) entry
1499 is deleted from the table. Because this order may
1500 change, management stations should make use of the
1501 hostControlLastDeleteTime variable in the
1502 hostControlEntry associated with the relevant
1503 portion of the hostTimeTable. By observing
1504 this variable, the management station may detect
1505 the circumstances where a download of the table
1506 may have missed entries, and where a previous
1507 association between a value of hostTimeCreationOrder
1508 and a hostTimeEntry may no longer hold."
1509 ::= { hostTimeEntry 2 }
1511 hostTimeIndex OBJECT-TYPE
1512 SYNTAX INTEGER (1..65535)
1516 "The set of collected host statistics of which
1517 this entry is a part. The set of hosts
1518 identified by a particular value of this
1519 index is associated with the hostControlEntry
1520 as identified by the same value of hostControlIndex."
1521 ::= { hostTimeEntry 3 }
1523 hostTimeInPkts OBJECT-TYPE
1528 "The number of packets without errors transmitted to
1529 this address since it was added to the hostTimeTable."
1530 ::= { hostTimeEntry 4 }
1532 hostTimeOutPkts OBJECT-TYPE
1537 "The number of packets including errors transmitted
1538 by this address since it was added to the
1540 ::= { hostTimeEntry 5 }
1542 hostTimeInOctets OBJECT-TYPE
1547 "The number of octets transmitted to this address
1548 since it was added to the hostTimeTable (excluding
1549 framing bits but including FCS octets), except for
1550 those octets in packets that contained errors."
1551 ::= { hostTimeEntry 6 }
1553 hostTimeOutOctets OBJECT-TYPE
1558 "The number of octets transmitted by this address since
1559 it was added to the hostTimeTable (excluding framing
1560 bits but including FCS octets), including those
1561 octets in packets that contained errors."
1562 ::= { hostTimeEntry 7 }
1564 hostTimeOutErrors OBJECT-TYPE
1569 "The number of error packets transmitted by this
1570 address since this host was added to the
1572 ::= { hostTimeEntry 8 }
1574 hostTimeOutBroadcastPkts OBJECT-TYPE
1579 "The number of good packets transmitted by this
1580 address that were directed to the broadcast address
1581 since this host was added to the hostTimeTable."
1582 ::= { hostTimeEntry 9 }
1584 hostTimeOutMulticastPkts OBJECT-TYPE
1589 "The number of good packets transmitted by this
1590 address that were directed to a multicast address
1591 since this host was added to the hostTimeTable.
1592 Note that this number does not include packets
1593 directed to the broadcast address."
1594 ::= { hostTimeEntry 10 }
1597 -- The Host Top "N" Group
1599 -- Implementation of the Host Top N group is optional.
1601 -- The Host Top N group requires the implementation of the
1604 -- The Host Top N group is used to prepare reports that
1605 -- describe the hosts that top a list ordered by one of
1606 -- their statistics. The available statistics are samples
1607 -- of one of their base statistics, over an interval
1608 -- specified by the management station. Thus, these
1609 -- statistics are rate based. The management
1610 -- station also selects how many such hosts are reported.
1612 -- The hostTopNControlTable is used to initiate the generation
1613 -- of such a report. The management station may select the
1614 -- parameters of such a report, such as which interface,
1615 -- which statistic, how many hosts, and the start and stop
1616 -- times of the sampling. When the report is prepared,
1617 -- entries are created in the hostTopNTable associated with
1618 -- the relevant hostTopNControlEntry. These entries are
1620 -- static for each report after it has been prepared.
1622 hostTopNControlTable OBJECT-TYPE
1623 SYNTAX SEQUENCE OF HostTopNControlEntry
1624 ACCESS not-accessible
1627 "A list of top N host control entries."
1630 hostTopNControlEntry OBJECT-TYPE
1631 SYNTAX HostTopNControlEntry
1632 ACCESS not-accessible
1635 "A set of parameters that control the creation of a
1636 report of the top N hosts according to several
1638 INDEX { hostTopNControlIndex }
1639 ::= { hostTopNControlTable 1 }
1641 HostTopNControlEntry ::= SEQUENCE {
1642 hostTopNControlIndex INTEGER (1..65535),
1643 hostTopNHostIndex INTEGER (1..65535),
1644 hostTopNRateBase INTEGER,
1645 hostTopNTimeRemaining INTEGER,
1646 hostTopNDuration INTEGER,
1647 hostTopNRequestedSize INTEGER,
1648 hostTopNGrantedSize INTEGER,
1649 hostTopNStartTime TimeTicks,
1650 hostTopNOwner OwnerString,
1651 hostTopNStatus INTEGER
1654 hostTopNControlIndex OBJECT-TYPE
1655 SYNTAX INTEGER (1..65535)
1659 "An index that uniquely identifies an entry
1660 in the hostTopNControl table. Each such
1661 entry defines one top N report prepared for
1663 ::= { hostTopNControlEntry 1 }
1665 hostTopNHostIndex OBJECT-TYPE
1666 SYNTAX INTEGER (1..65535)
1670 "The host table for which a top N report will be
1671 prepared on behalf of this entry. The host table
1672 identified by a particular value of this index is
1673 associated with the same host table as identified
1674 by the same value of hostIndex.
1676 This object may not be modified if the associated
1677 hostTopNStatus object is equal to valid(1)."
1678 ::= { hostTopNControlEntry 2 }
1680 hostTopNRateBase OBJECT-TYPE
1684 hostTopNInOctets(3),
1685 hostTopNOutOctets(4),
1686 hostTopNOutErrors(5),
1687 hostTopNOutBroadcastPkts(6),
1688 hostTopNOutMulticastPkts(7)
1693 "The variable for each host that the hostTopNRate
1694 variable is based upon.
1696 This object may not be modified if the associated
1697 hostTopNStatus object is equal to valid(1)."
1698 ::= { hostTopNControlEntry 3 }
1700 hostTopNTimeRemaining OBJECT-TYPE
1705 "The number of seconds left in the report currently
1706 being collected. When this object is modified by
1707 the management station, a new collection is started,
1708 possibly aborting a currently running report. The
1709 new value is used as the requested duration of this
1710 report, which is loaded into the associated
1711 hostTopNDuration object.
1713 When this object is set to a non-zero value, any
1714 associated hostTopNEntries shall be made
1715 inaccessible by the monitor. While the value of this
1716 object is non-zero, it decrements by one per second
1717 until it reaches zero. During this time, all
1718 associated hostTopNEntries shall remain
1719 inaccessible. At the time that this object
1720 decrements to zero, the report is made
1721 accessible in the hostTopNTable. Thus, the hostTopN
1722 table needs to be created only at the end of the
1723 collection interval."
1725 ::= { hostTopNControlEntry 4 }
1727 hostTopNDuration OBJECT-TYPE
1732 "The number of seconds that this report has collected
1733 during the last sampling interval, or if this
1734 report is currently being collected, the number
1735 of seconds that this report is being collected
1736 during this sampling interval.
1738 When the associated hostTopNTimeRemaining object is
1739 set, this object shall be set by the probe to the
1740 same value and shall not be modified until the next
1741 time the hostTopNTimeRemaining is set.
1743 This value shall be zero if no reports have been
1744 requested for this hostTopNControlEntry."
1746 ::= { hostTopNControlEntry 5 }
1748 hostTopNRequestedSize OBJECT-TYPE
1753 "The maximum number of hosts requested for the top N
1756 When this object is created or modified, the probe
1757 should set hostTopNGrantedSize as closely to this
1758 object as is possible for the particular probe
1759 implementation and available resources."
1761 ::= { hostTopNControlEntry 6 }
1763 hostTopNGrantedSize OBJECT-TYPE
1768 "The maximum number of hosts in the top N table.
1770 When the associated hostTopNRequestedSize object is
1771 created or modified, the probe should set this
1772 object as closely to the requested value as is
1773 possible for the particular implementation and
1774 available resources. The probe must not lower this
1775 value except as a result of a set to the associated
1776 hostTopNRequestedSize object.
1778 Hosts with the highest value of hostTopNRate shall be
1779 placed in this table in decreasing order of this rate
1780 until there is no more room or until there are no more
1782 ::= { hostTopNControlEntry 7 }
1784 hostTopNStartTime OBJECT-TYPE
1789 "The value of sysUpTime when this top N report was
1790 last started. In other words, this is the time that
1791 the associated hostTopNTimeRemaining object was
1792 modified to start the requested report."
1793 ::= { hostTopNControlEntry 8 }
1795 hostTopNOwner OBJECT-TYPE
1800 "The entity that configured this entry and is
1801 therefore using the resources assigned to it."
1802 ::= { hostTopNControlEntry 9 }
1804 hostTopNStatus OBJECT-TYPE
1809 "The status of this hostTopNControl entry.
1810 If this object is not equal to valid(1), all
1811 associated hostTopNEntries shall be deleted by
1813 ::= { hostTopNControlEntry 10 }
1815 hostTopNTable OBJECT-TYPE
1816 SYNTAX SEQUENCE OF HostTopNEntry
1817 ACCESS not-accessible
1820 "A list of top N host entries."
1823 hostTopNEntry OBJECT-TYPE
1824 SYNTAX HostTopNEntry
1825 ACCESS not-accessible
1828 "A set of statistics for a host that is part of a
1830 INDEX { hostTopNReport, hostTopNIndex }
1831 ::= { hostTopNTable 1 }
1833 HostTopNEntry ::= SEQUENCE {
1834 hostTopNReport INTEGER (1..65535),
1835 hostTopNIndex INTEGER (1..65535),
1836 hostTopNAddress OCTET STRING,
1837 hostTopNRate INTEGER
1840 hostTopNReport OBJECT-TYPE
1841 SYNTAX INTEGER (1..65535)
1845 "This object identifies the top N report of which
1846 this entry is a part. The set of hosts
1847 identified by a particular value of this
1848 object is part of the same report as identified
1849 by the same value of the hostTopNControlIndex object."
1850 ::= { hostTopNEntry 1 }
1852 hostTopNIndex OBJECT-TYPE
1853 SYNTAX INTEGER (1..65535)
1857 "An index that uniquely identifies an entry in
1858 the hostTopN table among those in the same report.
1859 This index is between 1 and N, where N is the
1860 number of entries in this table. Increasing values
1861 of hostTopNIndex shall be assigned to entries with
1862 decreasing values of hostTopNRate until index N
1863 is assigned to the entry with the lowest value of
1864 hostTopNRate or there are no more hostTopNEntries."
1865 ::= { hostTopNEntry 2 }
1867 hostTopNAddress OBJECT-TYPE
1872 "The physical address of this host."
1873 ::= { hostTopNEntry 3 }
1875 hostTopNRate OBJECT-TYPE
1880 "The amount of change in the selected variable
1881 during this sampling interval. The selected
1882 variable is this host's instance of the object
1883 selected by hostTopNRateBase."
1884 ::= { hostTopNEntry 4 }
1889 -- Implementation of the Matrix group is optional.
1891 -- The Matrix group consists of the matrixControlTable,
1892 -- matrixSDTable and the matrixDSTable. These tables
1893 -- store statistics for a particular conversation between
1894 -- two addresses. As the device detects a new conversation,
1895 -- including those to a non-unicast address, it creates a
1896 -- new entry in both of the matrix tables.
1897 -- It must only create new entries based on information
1898 -- received in good packets. If the monitoring device finds
1899 -- itself short of resources, it may delete entries as needed.
1900 -- It is suggested that the device delete the least recently
1901 -- used entries first.
1903 matrixControlTable OBJECT-TYPE
1904 SYNTAX SEQUENCE OF MatrixControlEntry
1905 ACCESS not-accessible
1908 "A list of information entries for the
1909 traffic matrix on each interface."
1912 matrixControlEntry OBJECT-TYPE
1913 SYNTAX MatrixControlEntry
1914 ACCESS not-accessible
1917 "Information about a traffic matrix on a
1918 particular interface."
1919 INDEX { matrixControlIndex }
1920 ::= { matrixControlTable 1 }
1922 MatrixControlEntry ::= SEQUENCE {
1923 matrixControlIndex INTEGER (1..65535),
1924 matrixControlDataSource OBJECT IDENTIFIER,
1925 matrixControlTableSize INTEGER,
1926 matrixControlLastDeleteTime TimeTicks,
1927 matrixControlOwner OwnerString,
1928 matrixControlStatus INTEGER
1931 matrixControlIndex OBJECT-TYPE
1932 SYNTAX INTEGER (1..65535)
1936 "An index that uniquely identifies an entry in the
1937 matrixControl table. Each such entry defines
1938 a function that discovers conversations on a particular
1939 interface and places statistics about them in the
1940 matrixSDTable and the matrixDSTable on behalf of this
1941 matrixControlEntry."
1942 ::= { matrixControlEntry 1 }
1944 matrixControlDataSource OBJECT-TYPE
1945 SYNTAX OBJECT IDENTIFIER
1949 "This object identifies the source of
1950 the data from which this entry creates a traffic matrix.
1951 This source can be any interface on this device. In
1952 order to identify a particular interface, this object
1953 shall identify the instance of the ifIndex object,
1954 defined in [4,6], for the desired interface. For
1955 example, if an entry were to receive data from
1956 interface #1, this object would be set to ifIndex.1.
1958 The statistics in this group reflect all packets
1959 on the local network segment attached to the
1960 identified interface.
1962 This object may not be modified if the associated
1963 matrixControlStatus object is equal to valid(1)."
1964 ::= { matrixControlEntry 2 }
1966 matrixControlTableSize OBJECT-TYPE
1971 "The number of matrixSDEntries in the matrixSDTable
1972 for this interface. This must also be the value of
1973 the number of entries in the matrixDSTable for this
1975 ::= { matrixControlEntry 3 }
1977 matrixControlLastDeleteTime OBJECT-TYPE
1982 "The value of sysUpTime when the last entry
1983 was deleted from the portion of the matrixSDTable
1984 or matrixDSTable associated with this
1986 If no deletions have occurred, this value shall be
1988 ::= { matrixControlEntry 4 }
1990 matrixControlOwner OBJECT-TYPE
1995 "The entity that configured this entry and is
1996 therefore using the resources assigned to it."
1997 ::= { matrixControlEntry 5 }
1999 matrixControlStatus OBJECT-TYPE
2004 "The status of this matrixControl entry.
2006 If this object is not equal to valid(1), all
2007 associated entries in the matrixSDTable and the
2008 matrixDSTable shall be deleted by the agent."
2009 ::= { matrixControlEntry 6 }
2011 matrixSDTable OBJECT-TYPE
2012 SYNTAX SEQUENCE OF MatrixSDEntry
2013 ACCESS not-accessible
2016 "A list of traffic matrix entries indexed by
2017 source and destination MAC address."
2020 matrixSDEntry OBJECT-TYPE
2021 SYNTAX MatrixSDEntry
2022 ACCESS not-accessible
2025 "A collection of statistics for communications between
2026 two addresses on a particular interface."
2027 INDEX { matrixSDIndex,
2028 matrixSDSourceAddress, matrixSDDestAddress }
2029 ::= { matrixSDTable 1 }
2031 MatrixSDEntry ::= SEQUENCE {
2032 matrixSDSourceAddress OCTET STRING,
2033 matrixSDDestAddress OCTET STRING,
2034 matrixSDIndex INTEGER (1..65535),
2035 matrixSDPkts Counter,
2036 matrixSDOctets Counter,
2037 matrixSDErrors Counter
2040 matrixSDSourceAddress OBJECT-TYPE
2045 "The source physical address."
2046 ::= { matrixSDEntry 1 }
2048 matrixSDDestAddress OBJECT-TYPE
2053 "The destination physical address."
2054 ::= { matrixSDEntry 2 }
2056 matrixSDIndex OBJECT-TYPE
2057 SYNTAX INTEGER (1..65535)
2061 "The set of collected matrix statistics of which
2062 this entry is a part. The set of matrix statistics
2063 identified by a particular value of this index
2064 is associated with the same matrixControlEntry
2065 as identified by the same value of matrixControlIndex."
2066 ::= { matrixSDEntry 3 }
2068 matrixSDPkts OBJECT-TYPE
2073 "The number of packets transmitted from the source
2074 address to the destination address (this number
2075 includes error packets)."
2076 ::= { matrixSDEntry 4 }
2078 matrixSDOctets OBJECT-TYPE
2083 "The number of octets (excluding framing bits but
2084 including FCS octets) contained in all packets
2085 transmitted from the source address to the
2086 destination address."
2087 ::= { matrixSDEntry 5 }
2089 matrixSDErrors OBJECT-TYPE
2094 "The number of error packets transmitted from
2095 the source address to the destination address."
2096 ::= { matrixSDEntry 6 }
2099 -- Traffic matrix tables from destination to source
2101 matrixDSTable OBJECT-TYPE
2102 SYNTAX SEQUENCE OF MatrixDSEntry
2103 ACCESS not-accessible
2106 "A list of traffic matrix entries indexed by
2107 destination and source MAC address."
2110 matrixDSEntry OBJECT-TYPE
2111 SYNTAX MatrixDSEntry
2112 ACCESS not-accessible
2115 "A collection of statistics for communications between
2116 two address on a particular interface."
2117 INDEX { matrixDSIndex,
2118 matrixDSDestAddress, matrixDSSourceAddress }
2119 ::= { matrixDSTable 1 }
2121 MatrixDSEntry ::= SEQUENCE {
2122 matrixDSSourceAddress OCTET STRING,
2123 matrixDSDestAddress OCTET STRING,
2124 matrixDSIndex INTEGER (1..65535),
2125 matrixDSPkts Counter,
2126 matrixDSOctets Counter,
2127 matrixDSErrors Counter
2130 matrixDSSourceAddress OBJECT-TYPE
2135 "The source physical address."
2136 ::= { matrixDSEntry 1 }
2138 matrixDSDestAddress OBJECT-TYPE
2143 "The destination physical address."
2144 ::= { matrixDSEntry 2 }
2146 matrixDSIndex OBJECT-TYPE
2147 SYNTAX INTEGER (1..65535)
2151 "The set of collected matrix statistics of which
2152 this entry is a part. The set of matrix statistics
2153 identified by a particular value of this index
2154 is associated with the same matrixControlEntry
2155 as identified by the same value of matrixControlIndex."
2156 ::= { matrixDSEntry 3 }
2158 matrixDSPkts OBJECT-TYPE
2163 "The number of packets transmitted from the source
2164 address to the destination address (this number
2165 includes error packets)."
2166 ::= { matrixDSEntry 4 }
2168 matrixDSOctets OBJECT-TYPE
2173 "The number of octets (excluding framing bits
2174 but including FCS octets) contained in all packets
2175 transmitted from the source address to the
2176 destination address."
2177 ::= { matrixDSEntry 5 }
2179 matrixDSErrors OBJECT-TYPE
2184 "The number of error packets transmitted from
2185 the source address to the destination address."
2186 ::= { matrixDSEntry 6 }
2191 -- Implementation of the Filter group is optional.
2194 -- The Filter group allows packets to be captured with an
2195 -- arbitrary filter expression. A logical data and
2196 -- event stream or "channel" is formed by the packets
2197 -- that match the filter expression.
2199 -- This filter mechanism allows the creation of an arbitrary
2200 -- logical expression with which to filter packets. Each
2201 -- filter associated with a channel is OR'ed with the others.
2202 -- Within a filter, any bits checked in the data and status are
2203 -- AND'ed with respect to other bits in the same filter. The
2204 -- NotMask also allows for checking for inequality. Finally,
2205 -- the channelAcceptType object allows for inversion of the
2208 -- The channel can be turned on or off, and can also
2209 -- generate events when packets pass through it.
2211 filterTable OBJECT-TYPE
2212 SYNTAX SEQUENCE OF FilterEntry
2213 ACCESS not-accessible
2216 "A list of packet filter entries."
2219 filterEntry OBJECT-TYPE
2221 ACCESS not-accessible
2224 "A set of parameters for a packet filter applied on a
2225 particular interface."
2226 INDEX { filterIndex }
2227 ::= { filterTable 1 }
2229 FilterEntry ::= SEQUENCE {
2230 filterIndex INTEGER (1..65535),
2231 filterChannelIndex INTEGER (1..65535),
2232 filterPktDataOffset INTEGER,
2233 filterPktData OCTET STRING,
2234 filterPktDataMask OCTET STRING,
2235 filterPktDataNotMask OCTET STRING,
2236 filterPktStatus INTEGER,
2237 filterPktStatusMask INTEGER,
2238 filterPktStatusNotMask INTEGER,
2239 filterOwner OwnerString,
2240 filterStatus INTEGER
2243 filterIndex OBJECT-TYPE
2244 SYNTAX INTEGER (1..65535)
2248 "An index that uniquely identifies an entry
2249 in the filter table. Each such entry defines
2250 one filter that is to be applied to every packet
2251 received on an interface."
2252 ::= { filterEntry 1 }
2254 filterChannelIndex OBJECT-TYPE
2255 SYNTAX INTEGER (1..65535)
2259 "This object identifies the channel of which this
2260 filter is a part. The filters identified by a
2261 particular value of this object are associated
2262 with the same channel as identified by the same
2263 value of the channelIndex object."
2264 ::= { filterEntry 2 }
2266 filterPktDataOffset OBJECT-TYPE
2271 "The offset from the beginning of each packet where
2272 a match of packet data will be attempted. This offset
2273 is measured from the point in the physical layer
2274 packet after the framing bits, if any. For example,
2275 in an Ethernet frame, this point is at the beginning
2276 of the destination MAC address.
2278 This object may not be modified if the associated
2279 filterStatus object is equal to valid(1)."
2281 ::= { filterEntry 3 }
2283 filterPktData OBJECT-TYPE
2288 "The data that is to be matched with the input packet.
2289 For each packet received, this filter and the
2290 accompanying filterPktDataMask and
2291 filterPktDataNotMask will be adjusted for the
2292 offset. The only bits relevant to this
2293 match algorithm are those that have the corresponding
2294 filterPktDataMask bit equal to one. The following
2295 three rules are then applied to every packet:
2297 (1) If the packet is too short and does not have data
2298 corresponding to part of the filterPktData, the
2299 packet will fail this data match.
2301 (2) For each relevant bit from the packet with the
2302 corresponding filterPktDataNotMask bit set to
2303 zero, if the bit from the packet is not equal to
2304 the corresponding bit from the filterPktData,
2305 then the packet will fail this data match.
2307 (3) If for every relevant bit from the packet with the
2308 corresponding filterPktDataNotMask bit set to one,
2309 the bit from the packet is equal to the
2310 corresponding bit from the filterPktData, then
2311 the packet will fail this data match.
2313 Any packets that have not failed any of the three
2314 matches above have passed this data match.
2316 This object may not be modified if the associated
2317 filterStatus object is equal to valid(1)."
2318 ::= { filterEntry 4 }
2320 filterPktDataMask OBJECT-TYPE
2325 "The mask that is applied to the match process.
2326 After adjusting this mask for the offset, only those
2327 bits in the received packet that correspond to bits
2328 set in this mask are relevant for further processing
2329 by the match algorithm. The offset is applied to
2330 filterPktDataMask in the same way it is applied to
2331 the filter. For the purposes of the matching
2332 algorithm, if the associated filterPktData object
2333 is longer than this mask, this mask is conceptually
2334 extended with '1' bits until it reaches the
2335 length of the filterPktData object.
2336 This object may not be modified if the associated
2337 filterStatus object is equal to valid(1)."
2338 ::= { filterEntry 5 }
2340 filterPktDataNotMask OBJECT-TYPE
2345 "The inversion mask that is applied to the match
2346 process. After adjusting this mask for the offset,
2347 those relevant bits in the received packet that
2348 correspond to bits cleared in this mask must all
2349 be equal to their corresponding bits in the
2350 filterPktData object for the packet to be accepted.
2351 In addition, at least one of those relevant
2352 bits in the received packet that correspond to bits
2353 set in this mask must be different to its
2354 corresponding bit in the filterPktData object.
2356 For the purposes of the matching algorithm, if
2357 the associated filterPktData object is longer than
2358 this mask, this mask is conceptually extended with
2359 '0' bits until it reaches the length of the
2360 filterPktData object.
2362 This object may not be modified if the associated
2363 filterStatus object is equal to valid(1)."
2364 ::= { filterEntry 6 }
2366 filterPktStatus OBJECT-TYPE
2371 "The status that is to be matched with the input
2372 packet. The only bits relevant to this match
2373 algorithm are those that have the corresponding
2374 filterPktStatusMask bit equal to one.
2376 The following two rules are then applied to every
2379 (1) For each relevant bit from the packet status
2380 with the corresponding filterPktStatusNotMask
2381 bit set to zero, if the bit from the packet
2382 status is not equal to the corresponding bit
2383 from the filterPktStatus, then the packet will
2384 fail this status match.
2386 (2) If for every relevant bit from the packet status
2387 with the corresponding filterPktStatusNotMask
2388 bit set to one, the bit from the packet status
2389 is equal to the corresponding bit from the
2390 filterPktStatus, then the packet will fail
2393 Any packets that have not failed either of the two
2394 matches above have passed this status match.
2396 The value of the packet status is a sum. This sum
2397 initially takes the value zero. Then, for each
2398 error, E, that has been discovered in this packet,
2399 2 raised to a value representing E is added to the sum.
2400 The errors and the bits that represent them are
2401 dependent on the media type of the interface that
2402 this channel is receiving packets from.
2404 The errors defined for a packet captured off of an
2405 Ethernet interface are as follows:
2408 0 Packet is longer than 1518 octets
2409 1 Packet is shorter than 64 octets
2410 2 Packet experienced a CRC or Alignment
2413 For example, an Ethernet fragment would have a
2414 value of 6 (2^1 + 2^2).
2416 As this MIB is expanded to new media types, this
2417 object will have other media-specific errors defined.
2419 For the purposes of this status matching algorithm, if
2420 the packet status is longer than this
2421 object, filterPktStatus this object is conceptually
2422 extended with '0' bits until it reaches the size of
2425 This object may not be modified if the associated
2426 filterStatus object is equal to valid(1)."
2427 ::= { filterEntry 7 }
2429 filterPktStatusMask OBJECT-TYPE
2434 "The mask that is applied to the status match process.
2435 Only those bits in the received packet that correspond
2436 to bits set in this mask are relevant for further
2437 processing by the status match algorithm. For the
2438 purposes of the matching algorithm, if the
2439 associated filterPktStatus object is longer than
2440 this mask, this mask is conceptually extended with
2441 '1' bits until it reaches the size of the
2442 filterPktStatus. In addition, if a packet status is
2443 longer than this mask, this mask is conceptually
2444 extended with '0' bits until it reaches the size of
2447 This object may not be modified if the associated
2448 filterStatus object is equal to valid(1)."
2449 ::= { filterEntry 8 }
2451 filterPktStatusNotMask OBJECT-TYPE
2456 "The inversion mask that is applied to the status match
2457 process. Those relevant bits in the received packet
2458 status that correspond to bits cleared in this mask
2459 must all be equal to their corresponding bits in the
2460 filterPktStatus object for the packet to be accepted.
2461 In addition, at least one of those relevant bits in the
2462 received packet status that correspond to bits set in
2463 this mask must be different to its corresponding bit
2464 in the filterPktStatus object for the packet to be
2467 For the purposes of the matching algorithm, if the
2468 associated filterPktStatus object or a packet status
2469 is longer than this mask, this mask is conceptually
2470 extended with '0' bits until it reaches the longer of
2471 the lengths of the filterPktStatus object and the
2474 This object may not be modified if the associated
2475 filterStatus object is equal to valid(1)."
2476 ::= { filterEntry 9 }
2478 filterOwner OBJECT-TYPE
2483 "The entity that configured this entry and is
2484 therefore using the resources assigned to it."
2485 ::= { filterEntry 10 }
2487 filterStatus OBJECT-TYPE
2492 "The status of this filter entry."
2493 ::= { filterEntry 11 }
2495 channelTable OBJECT-TYPE
2496 SYNTAX SEQUENCE OF ChannelEntry
2497 ACCESS not-accessible
2500 "A list of packet channel entries."
2503 channelEntry OBJECT-TYPE
2505 ACCESS not-accessible
2508 "A set of parameters for a packet channel applied on a
2509 particular interface."
2510 INDEX { channelIndex }
2511 ::= { channelTable 1 }
2513 ChannelEntry ::= SEQUENCE {
2514 channelIndex INTEGER (1..65535),
2515 channelIfIndex INTEGER (1..65535),
2516 channelAcceptType INTEGER,
2517 channelDataControl INTEGER,
2518 channelTurnOnEventIndex INTEGER (0..65535),
2519 channelTurnOffEventIndex INTEGER (0..65535),
2520 channelEventIndex INTEGER (0..65535),
2521 channelEventStatus INTEGER,
2522 channelMatches Counter,
2523 channelDescription DisplayString (SIZE (0..127)),
2524 channelOwner OwnerString,
2525 channelStatus INTEGER
2528 channelIndex OBJECT-TYPE
2529 SYNTAX INTEGER (1..65535)
2533 "An index that uniquely identifies an entry
2534 in the channel table. Each such
2535 entry defines one channel, a logical data
2537 ::= { channelEntry 1 }
2539 channelIfIndex OBJECT-TYPE
2540 SYNTAX INTEGER (1..65535)
2544 "The value of this object uniquely identifies the
2545 interface on this remote network monitoring device
2546 to which the associated filters are applied to allow
2547 data into this channel. The interface identified by
2548 a particular value of this object is the same
2549 interface as identified by the same value of the
2550 ifIndex object, defined in [4,6]. The filters in
2551 this group are applied to all packets on the local
2552 network segment attached to the identified
2555 This object may not be modified if the associated
2556 channelStatus object is equal to valid(1)."
2557 ::= { channelEntry 2 }
2559 channelAcceptType OBJECT-TYPE
2567 "This object controls the action of the filters
2568 associated with this channel. If this object is equal
2569 to acceptMatched(1), packets will be accepted to this
2570 channel if they are accepted by both the packet data
2571 and packet status matches of an associated filter. If
2572 this object is equal to acceptFailed(2), packets will
2573 be accepted to this channel only if they fail either
2574 the packet data match or the packet status match of
2575 each of the associated filters.
2576 This object may not be modified if the associated
2577 channelStatus object is equal to valid(1)."
2578 ::= { channelEntry 3 }
2580 channelDataControl OBJECT-TYPE
2588 "This object controls the flow of data through this
2589 channel. If this object is on(1), data, status and
2590 events flow through this channel. If this object is
2591 off(2), data, status and events will not flow through
2594 ::= { channelEntry 4 }
2596 channelTurnOnEventIndex OBJECT-TYPE
2597 SYNTAX INTEGER (0..65535)
2601 "The value of this object identifies the event
2602 that is configured to turn the associated
2603 channelDataControl from off to on when the event is
2604 generated. The event identified by a particular value
2605 of this object is the same event as identified by the
2606 same value of the eventIndex object. If there is no
2607 corresponding entry in the eventTable, then no
2608 association exists. In fact, if no event is intended
2609 for this channel, channelTurnOnEventIndex must be
2610 set to zero, a non-existent event index.
2612 This object may not be modified if the associated
2613 channelStatus object is equal to valid(1)."
2614 ::= { channelEntry 5 }
2616 channelTurnOffEventIndex OBJECT-TYPE
2617 SYNTAX INTEGER (0..65535)
2621 "The value of this object identifies the event
2622 that is configured to turn the associated
2623 channelDataControl from on to off when the event is
2624 generated. The event identified by a particular value
2625 of this object is the same event as identified by the
2626 same value of the eventIndex object. If there is no
2627 corresponding entry in the eventTable, then no
2628 association exists. In fact, if no event is intended
2629 for this channel, channelTurnOffEventIndex must be
2630 set to zero, a non-existent event index.
2632 This object may not be modified if the associated
2633 channelStatus object is equal to valid(1)."
2634 ::= { channelEntry 6 }
2636 channelEventIndex OBJECT-TYPE
2637 SYNTAX INTEGER (0..65535)
2641 "The value of this object identifies the event
2642 that is configured to be generated when the
2643 associated channelDataControl is on and a packet
2644 is matched. The event identified by a particular value
2645 of this object is the same event as identified by the
2646 same value of the eventIndex object. If there is no
2647 corresponding entry in the eventTable, then no
2648 association exists. In fact, if no event is intended
2649 for this channel, channelEventIndex must be
2650 set to zero, a non-existent event index.
2652 This object may not be modified if the associated
2653 channelStatus object is equal to valid(1)."
2654 ::= { channelEntry 7 }
2656 channelEventStatus OBJECT-TYPE
2665 "The event status of this channel.
2667 If this channel is configured to generate events
2668 when packets are matched, a means of controlling
2669 the flow of those events is often needed. When
2670 this object is equal to eventReady(1), a single
2671 event may be generated, after which this object
2672 will be set by the probe to eventFired(2). While
2673 in the eventFired(2) state, no events will be
2674 generated until the object is modified to
2675 eventReady(1) (or eventAlwaysReady(3)). The
2676 management station can thus easily respond to a
2677 notification of an event by re-enabling this object.
2679 If the management station wishes to disable this
2680 flow control and allow events to be generated
2681 at will, this object may be set to
2682 eventAlwaysReady(3). Disabling the flow control
2683 is discouraged as it can result in high network
2684 traffic or other performance problems."
2685 DEFVAL { eventReady }
2686 ::= { channelEntry 8 }
2688 channelMatches OBJECT-TYPE
2693 "The number of times this channel has matched a packet.
2694 Note that this object is updated even when
2695 channelDataControl is set to off."
2696 ::= { channelEntry 9 }
2698 channelDescription OBJECT-TYPE
2699 SYNTAX DisplayString (SIZE (0..127))
2703 "A comment describing this channel."
2704 ::= { channelEntry 10 }
2706 channelOwner OBJECT-TYPE
2711 "The entity that configured this entry and is therefore
2712 using the resources assigned to it."
2713 ::= { channelEntry 11 }
2715 channelStatus OBJECT-TYPE
2720 "The status of this channel entry."
2721 ::= { channelEntry 12 }
2724 -- The Packet Capture Group
2726 -- Implementation of the Packet Capture group is optional.
2728 -- The Packet Capture Group requires implementation of the
2731 -- The Packet Capture group allows packets to be captured
2732 -- upon a filter match. The bufferControlTable controls
2733 -- the captured packets output from a channel that is
2734 -- associated with it. The captured packets are placed
2735 -- in entries in the captureBufferTable. These entries are
2736 -- associated with the bufferControlEntry on whose behalf they
2739 bufferControlTable OBJECT-TYPE
2740 SYNTAX SEQUENCE OF BufferControlEntry
2741 ACCESS not-accessible
2744 "A list of buffers control entries."
2747 bufferControlEntry OBJECT-TYPE
2748 SYNTAX BufferControlEntry
2749 ACCESS not-accessible
2752 "A set of parameters that control the collection of
2753 a stream of packets that have matched filters."
2754 INDEX { bufferControlIndex }
2755 ::= { bufferControlTable 1 }
2757 BufferControlEntry ::= SEQUENCE {
2758 bufferControlIndex INTEGER (1..65535),
2759 bufferControlChannelIndex INTEGER (1..65535),
2760 bufferControlFullStatus INTEGER,
2761 bufferControlFullAction INTEGER,
2762 bufferControlCaptureSliceSize INTEGER,
2763 bufferControlDownloadSliceSize INTEGER,
2764 bufferControlDownloadOffset INTEGER,
2765 bufferControlMaxOctetsRequested INTEGER,
2766 bufferControlMaxOctetsGranted INTEGER,
2767 bufferControlCapturedPackets INTEGER,
2768 bufferControlTurnOnTime TimeTicks,
2769 bufferControlOwner OwnerString,
2770 bufferControlStatus INTEGER
2773 bufferControlIndex OBJECT-TYPE
2774 SYNTAX INTEGER (1..65535)
2778 "An index that uniquely identifies an entry
2779 in the bufferControl table. The value of this
2780 index shall never be zero. Each such
2781 entry defines one set of packets that is
2782 captured and controlled by one or more filters."
2783 ::= { bufferControlEntry 1 }
2785 bufferControlChannelIndex OBJECT-TYPE
2786 SYNTAX INTEGER (1..65535)
2790 "An index that identifies the channel that is the
2791 source of packets for this bufferControl table.
2792 The channel identified by a particular value of this
2793 index is the same as identified by the same value of
2794 the channelIndex object.
2796 This object may not be modified if the associated
2797 bufferControlStatus object is equal to valid(1)."
2798 ::= { bufferControlEntry 2 }
2800 bufferControlFullStatus OBJECT-TYPE
2808 "This object shows whether the buffer has room to
2809 accept new packets or if it is full.
2811 If the status is spaceAvailable(1), the buffer is
2812 accepting new packets normally. If the status is
2813 full(2) and the associated bufferControlFullAction
2814 object is wrapWhenFull, the buffer is accepting new
2815 packets by deleting enough of the oldest packets
2816 to make room for new ones as they arrive. Otherwise,
2817 if the status is full(2) and the
2818 bufferControlFullAction object is lockWhenFull,
2819 then the buffer has stopped collecting packets.
2821 When this object is set to full(2) the probe must
2822 not later set it to spaceAvailable(1) except in the
2823 case of a significant gain in resources such as
2824 an increase of bufferControlOctetsGranted. In
2825 particular, the wrap-mode action of deleting old
2826 packets to make room for newly arrived packets
2827 must not affect the value of this object."
2828 ::= { bufferControlEntry 3 }
2830 bufferControlFullAction OBJECT-TYPE
2833 wrapWhenFull(2) -- FIFO
2838 "Controls the action of the buffer when it
2839 reaches the full status. When in the lockWhenFull(1)
2840 state a packet is added to the buffer that
2841 fills the buffer, the bufferControlFullStatus will
2842 be set to full(2) and this buffer will stop capturing
2844 ::= { bufferControlEntry 4 }
2846 bufferControlCaptureSliceSize OBJECT-TYPE
2851 "The maximum number of octets of each packet
2852 that will be saved in this capture buffer.
2853 For example, if a 1500 octet packet is received by
2854 the probe and this object is set to 500, then only
2855 500 octets of the packet will be stored in the
2856 associated capture buffer. If this variable is set
2857 to 0, the capture buffer will save as many octets
2860 This object may not be modified if the associated
2861 bufferControlStatus object is equal to valid(1)."
2863 ::= { bufferControlEntry 5 }
2865 bufferControlDownloadSliceSize OBJECT-TYPE
2870 "The maximum number of octets of each packet
2871 in this capture buffer that will be returned in
2872 an SNMP retrieval of that packet. For example,
2873 if 500 octets of a packet have been stored in the
2874 associated capture buffer, the associated
2875 bufferControlDownloadOffset is 0, and this
2876 object is set to 100, then the captureBufferPacket
2877 object that contains the packet will contain only
2878 the first 100 octets of the packet.
2880 A prudent manager will take into account possible
2881 interoperability or fragmentation problems that may
2882 occur if the download slice size is set too large.
2883 In particular, conformant SNMP implementations are not
2884 required to accept messages whose length exceeds 484
2885 octets, although they are encouraged to support larger
2886 datagrams whenever feasible."
2888 ::= { bufferControlEntry 6 }
2890 bufferControlDownloadOffset OBJECT-TYPE
2895 "The offset of the first octet of each packet
2896 in this capture buffer that will be returned in
2897 an SNMP retrieval of that packet. For example,
2898 if 500 octets of a packet have been stored in the
2899 associated capture buffer and this object is set to
2900 100, then the captureBufferPacket object that
2901 contains the packet will contain bytes starting
2902 100 octets into the packet."
2904 ::= { bufferControlEntry 7 }
2906 bufferControlMaxOctetsRequested OBJECT-TYPE
2911 "The requested maximum number of octets to be
2912 saved in this captureBuffer, including any
2913 implementation-specific overhead. If this variable
2914 is set to -1, the capture buffer will save as many
2915 octets as is possible.
2917 When this object is created or modified, the probe
2918 should set bufferControlMaxOctetsGranted as closely
2919 to this object as is possible for the particular probe
2920 implementation and available resources. However, if
2921 the object has the special value of -1, the probe
2922 must set bufferControlMaxOctetsGranted to -1."
2924 ::= { bufferControlEntry 8 }
2926 bufferControlMaxOctetsGranted OBJECT-TYPE
2931 "The maximum number of octets that can be
2932 saved in this captureBuffer, including overhead.
2933 If this variable is -1, the capture buffer will save
2934 as many octets as possible.
2936 When the bufferControlMaxOctetsRequested object is
2937 created or modified, the probe should set this object
2938 as closely to the requested value as is possible for
2939 the particular probe implementation and available
2940 resources. However, if the request object has the
2941 special value of -1, the probe must set this object
2942 to -1. The probe must not lower this value except
2943 as a result of a modification to the associated
2944 bufferControlMaxOctetsRequested object.
2946 When this maximum number of octets is reached
2947 and a new packet is to be added to this
2948 capture buffer and the corresponding
2949 bufferControlFullAction is set to wrapWhenFull(2),
2950 enough of the oldest packets associated with this
2951 capture buffer shall be deleted by the agent so
2952 that the new packet can be added. If the
2953 corresponding bufferControlFullAction is set to
2954 lockWhenFull(1), the new packet shall be discarded.
2955 In either case, the probe must set
2956 bufferControlFullStatus to full(2).
2958 When the value of this object changes to a value less
2959 than the current value, entries are deleted from
2960 the captureBufferTable associated with this
2961 bufferControlEntry. Enough of the
2962 oldest of these captureBufferEntries shall be
2963 deleted by the agent so that the number of octets
2964 used remains less than or equal to the new value of
2967 When the value of this object changes to a value greater
2968 than the current value, the number of associated
2969 captureBufferEntries may be allowed to grow."
2970 ::= { bufferControlEntry 9 }
2972 bufferControlCapturedPackets OBJECT-TYPE
2977 "The number of packets currently in this captureBuffer."
2978 ::= { bufferControlEntry 10 }
2980 bufferControlTurnOnTime OBJECT-TYPE
2985 "The value of sysUpTime when this capture buffer was
2987 ::= { bufferControlEntry 11 }
2989 bufferControlOwner OBJECT-TYPE
2994 "The entity that configured this entry and is therefore
2995 using the resources assigned to it."
2996 ::= { bufferControlEntry 12 }
2998 bufferControlStatus OBJECT-TYPE
3003 "The status of this buffer Control Entry."
3004 ::= { bufferControlEntry 13 }
3006 captureBufferTable OBJECT-TYPE
3007 SYNTAX SEQUENCE OF CaptureBufferEntry
3008 ACCESS not-accessible
3011 "A list of packets captured off of a channel."
3014 captureBufferEntry OBJECT-TYPE
3015 SYNTAX CaptureBufferEntry
3016 ACCESS not-accessible
3019 "A packet captured off of an attached network."
3020 INDEX { captureBufferControlIndex, captureBufferIndex }
3021 ::= { captureBufferTable 1 }
3023 CaptureBufferEntry ::= SEQUENCE {
3024 captureBufferControlIndex INTEGER (1..65535),
3025 captureBufferIndex INTEGER,
3026 captureBufferPacketID INTEGER,
3027 captureBufferPacketData OCTET STRING,
3028 captureBufferPacketLength INTEGER,
3029 captureBufferPacketTime INTEGER,
3030 captureBufferPacketStatus INTEGER
3033 captureBufferControlIndex OBJECT-TYPE
3034 SYNTAX INTEGER (1..65535)
3038 "The index of the bufferControlEntry with which
3039 this packet is associated."
3040 ::= { captureBufferEntry 1 }
3042 captureBufferIndex OBJECT-TYPE
3047 "An index that uniquely identifies an entry
3048 in the captureBuffer table associated with a
3049 particular bufferControlEntry. This index will
3050 start at 1 and increase by one for each new packet
3051 added with the same captureBufferControlIndex."
3052 ::= { captureBufferEntry 2 }
3054 captureBufferPacketID OBJECT-TYPE
3059 "An index that describes the order of packets
3060 that are received on a particular interface.
3061 The packetID of a packet captured on an
3062 interface is defined to be greater than the
3063 packetID's of all packets captured previously on
3064 the same interface. As the captureBufferPacketID
3065 object has a maximum positive value of 2^31 - 1,
3066 any captureBufferPacketID object shall have the
3067 value of the associated packet's packetID mod 2^31."
3068 ::= { captureBufferEntry 3 }
3070 captureBufferPacketData OBJECT-TYPE
3075 "The data inside the packet, starting at the beginning
3076 of the packet plus any offset specified in the
3077 associated bufferControlDownloadOffset, including any
3078 link level headers. The length of the data in this
3079 object is the minimum of the length of the captured
3080 packet minus the offset, the length of the associated
3081 bufferControlCaptureSliceSize minus the offset, and the
3082 associated bufferControlDownloadSliceSize. If this
3083 minimum is less than zero, this object shall have a
3085 ::= { captureBufferEntry 4 }
3087 captureBufferPacketLength OBJECT-TYPE
3092 "The actual length (off the wire) of the packet stored
3093 in this entry, including FCS octets."
3094 ::= { captureBufferEntry 5 }
3096 captureBufferPacketTime OBJECT-TYPE
3101 "The number of milliseconds that had passed since
3102 this capture buffer was first turned on when this
3103 packet was captured."
3104 ::= { captureBufferEntry 6 }
3106 captureBufferPacketStatus OBJECT-TYPE
3111 "A value which indicates the error status of this
3114 The value of this object is defined in the same way as
3115 filterPacketStatus. The value is a sum. This sum
3116 initially takes the value zero. Then, for each
3117 error, E, that has been discovered in this packet,
3118 2 raised to a value representing E is added to the sum.
3120 The errors defined for a packet captured off of an
3121 Ethernet interface are as follows:
3124 0 Packet is longer than 1518 octets
3125 1 Packet is shorter than 64 octets
3126 2 Packet experienced a CRC or Alignment
3128 3 First packet in this capture buffer after
3129 it was detected that some packets were
3130 not processed correctly.
3132 For example, an Ethernet fragment would have a
3133 value of 6 (2^1 + 2^2).
3135 As this MIB is expanded to new media types, this object
3136 will have other media-specific errors defined."
3137 ::= { captureBufferEntry 7 }
3142 -- Implementation of the Event group is optional.
3144 -- The Event group controls the generation and notification
3145 -- of events from this device. Each entry in the eventTable
3146 -- describes the parameters of the event that can be triggered.
3147 -- Each event entry is fired by an associated condition located
3148 -- elsewhere in the MIB. An event entry may also be associated
3149 -- with a function elsewhere in the MIB that will be executed
3150 -- when the event is generated. For example, a channel may
3151 -- be turned on or off by the firing of an event.
3153 -- Each eventEntry may optionally specify that a log entry
3155 -- be created on its behalf whenever the event occurs.
3156 -- Each entry may also specify that notification should
3157 -- occur by way of SNMP trap messages. In this case, the
3158 -- community for the trap message is given in the associated
3159 -- eventCommunity object. The enterprise and specific trap
3160 -- fields of the trap are determined by the condition that
3161 -- triggered the event. Three traps are defined in a companion
3162 -- document: risingAlarm, fallingAlarm, and packetMatch.
3163 -- If the eventTable is triggered by a condition specified
3164 -- elsewhere, the enterprise and specific trap fields
3165 -- must be specified for traps generated for that condition.
3167 eventTable OBJECT-TYPE
3168 SYNTAX SEQUENCE OF EventEntry
3169 ACCESS not-accessible
3172 "A list of events to be generated."
3175 eventEntry OBJECT-TYPE
3177 ACCESS not-accessible
3180 "A set of parameters that describe an event to be
3181 generated when certain conditions are met."
3182 INDEX { eventIndex }
3183 ::= { eventTable 1 }
3185 EventEntry ::= SEQUENCE {
3186 eventIndex INTEGER (1..65535),
3187 eventDescription DisplayString (SIZE (0..127)),
3189 eventCommunity OCTET STRING (SIZE (0..127)),
3190 eventLastTimeSent TimeTicks,
3191 eventOwner OwnerString,
3195 eventIndex OBJECT-TYPE
3196 SYNTAX INTEGER (1..65535)
3200 "An index that uniquely identifies an entry in the
3201 event table. Each such entry defines one event that
3202 is to be generated when the appropriate conditions
3204 ::= { eventEntry 1 }
3206 eventDescription OBJECT-TYPE
3207 SYNTAX DisplayString (SIZE (0..127))
3211 "A comment describing this event entry."
3212 ::= { eventEntry 2 }
3214 eventType OBJECT-TYPE
3218 snmp-trap(3), -- send an SNMP trap
3224 "The type of notification that the probe will make
3225 about this event. In the case of log, an entry is
3226 made in the log table for each event. In the case of
3227 snmp-trap, an SNMP trap is sent to one or more
3228 management stations."
3229 ::= { eventEntry 3 }
3231 eventCommunity OBJECT-TYPE
3232 SYNTAX OCTET STRING (SIZE (0..127))
3236 "If an SNMP trap is to be sent, it will be sent to
3237 the SNMP community specified by this octet string.
3238 In the future this table will be extended to include
3239 the party security mechanism. This object shall be
3240 set to a string of length zero if it is intended that
3241 that mechanism be used to specify the destination of
3243 ::= { eventEntry 4 }
3245 eventLastTimeSent OBJECT-TYPE
3250 "The value of sysUpTime at the time this event
3251 entry last generated an event. If this entry has
3252 not generated any events, this value will be
3254 ::= { eventEntry 5 }
3256 eventOwner OBJECT-TYPE
3261 "The entity that configured this entry and is therefore
3262 using the resources assigned to it.
3264 If this object contains a string starting with 'monitor'
3265 and has associated entries in the log table, all
3266 connected management stations should retrieve those
3267 log entries, as they may have significance to all
3268 management stations connected to this device"
3269 ::= { eventEntry 6 }
3271 eventStatus OBJECT-TYPE
3276 "The status of this event entry.
3278 If this object is not equal to valid(1), all associated
3279 log entries shall be deleted by the agent."
3280 ::= { eventEntry 7 }
3283 logTable OBJECT-TYPE
3284 SYNTAX SEQUENCE OF LogEntry
3285 ACCESS not-accessible
3288 "A list of events that have been logged."
3291 logEntry OBJECT-TYPE
3293 ACCESS not-accessible
3296 "A set of data describing an event that has been
3298 INDEX { logEventIndex, logIndex }
3301 LogEntry ::= SEQUENCE {
3302 logEventIndex INTEGER (1..65535),
3305 logDescription DisplayString (SIZE (0..255))
3308 logEventIndex OBJECT-TYPE
3309 SYNTAX INTEGER (1..65535)
3313 "The event entry that generated this log
3314 entry. The log identified by a particular
3315 value of this index is associated with the same
3316 eventEntry as identified by the same value
3320 logIndex OBJECT-TYPE
3325 "An index that uniquely identifies an entry
3326 in the log table amongst those generated by the
3327 same eventEntries. These indexes are
3328 assigned beginning with 1 and increase by one
3329 with each new log entry. The association
3330 between values of logIndex and logEntries
3331 is fixed for the lifetime of each logEntry.
3332 The agent may choose to delete the oldest
3333 instances of logEntry as required because of
3334 lack of memory. It is an implementation-specific
3335 matter as to when this deletion may occur."
3343 "The value of sysUpTime when this log entry was
3347 logDescription OBJECT-TYPE
3348 SYNTAX DisplayString (SIZE (0..255))
3352 "An implementation dependent description of the
3353 event that activated this log entry."
projects / platform / upstream / libsmi.git / blob