1RMON-MIB DEFINITIONS ::= BEGIN 2 3 IMPORTS 4 MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY, 5 NOTIFICATION-TYPE, mib-2, Counter32, 6 Integer32, TimeTicks FROM SNMPv2-SMI 7 8 TEXTUAL-CONVENTION, DisplayString FROM SNMPv2-TC 9 10 MODULE-COMPLIANCE, OBJECT-GROUP, 11 NOTIFICATION-GROUP FROM SNMPv2-CONF; 12 13 14-- Remote Network Monitoring MIB 15 16rmonMibModule MODULE-IDENTITY 17 LAST-UPDATED "200005110000Z" -- 11 May, 2000 18 ORGANIZATION "IETF RMON MIB Working Group" 19 CONTACT-INFO 20 "Steve Waldbusser 21 Phone: +1-650-948-6500 22 Fax: +1-650-745-0671 23 Email: waldbusser@nextbeacon.com" 24 DESCRIPTION 25 "Remote network monitoring devices, often called 26 monitors or probes, are instruments that exist for 27 the purpose of managing a network. This MIB defines 28 objects for managing remote network monitoring devices." 29 30 REVISION "200005110000Z" -- 11 May, 2000 31 DESCRIPTION 32 "Reformatted into SMIv2 format. 33 34 This version published as RFC 2819." 35 36 REVISION "199502010000Z" -- 1 Feb, 1995 37 DESCRIPTION 38 "Bug fixes, clarifications and minor changes based on 39 implementation experience, published as RFC1757 [18]. 40 41 Two changes were made to object definitions: 42 43 1) A new status bit has been defined for the 44 captureBufferPacketStatus object, indicating that the 45 packet order within the capture buffer may not be identical to 46 the packet order as received off the wire. This bit may only 47 be used for packets transmitted by the probe. Older NMS 48 applications can safely ignore this status bit, which might be 49 used by newer agents. 50 51 2) The packetMatch trap has been removed. This trap was never 52 actually 'approved' and was not added to this document along 53 with the risingAlarm and fallingAlarm traps. The packetMatch 54 trap could not be throttled, which could cause disruption of 55 normal network traffic under some circumstances. An NMS should 56 configure a risingAlarm threshold on the appropriate 57 channelMatches instance if a trap is desired for a packetMatch 58 event. Note that logging of packetMatch events is still 59 supported--only trap generation for such events has been 60 removed. 61 62 In addition, several clarifications to individual object 63 definitions have been added to assist agent and NMS 64 implementors: 65 66 - global definition of 'good packets' and 'bad packets' 67 68 - more detailed text governing conceptual row creation and 69 modification 70 71 - instructions for probes relating to interface changes and 72 disruptions 73 74 - clarification of some ethernet counter definitions 75 76 - recommended formula for calculating network utilization 77 78 - clarification of channel and captureBuffer behavior for some 79 unusual conditions 80 81 - examples of proper instance naming for each table" 82 83 REVISION "199111010000Z" -- 1 Nov, 1991 84 DESCRIPTION 85 "The original version of this MIB, published as RFC1271." 86 ::= { rmonConformance 8 } 87 88 rmon OBJECT IDENTIFIER ::= { mib-2 16 } 89 90 91 -- textual conventions 92 93OwnerString ::= TEXTUAL-CONVENTION 94 STATUS current 95 96 DESCRIPTION 97 "This data type is used to model an administratively 98 assigned name of the owner of a resource. Implementations 99 must accept values composed of well-formed NVT ASCII 100 sequences. In addition, implementations should accept 101 values composed of well-formed UTF-8 sequences. 102 103 It is suggested that this name contain one or more of 104 the following: IP address, management station name, 105 network manager's name, location, or phone number. 106 In some cases the agent itself will be the owner of 107 an entry. In these cases, this string shall be set 108 to a string starting with 'monitor'. 109 110 SNMP access control is articulated entirely in terms 111 of the contents of MIB views; access to a particular 112 SNMP object instance depends only upon its presence 113 or absence in a particular MIB view and never upon 114 its value or the value of related object instances. 115 Thus, objects of this type afford resolution of 116 resource contention only among cooperating 117 managers; they realize no access control function 118 with respect to uncooperative parties." 119 SYNTAX OCTET STRING (SIZE (0..127)) 120 121EntryStatus ::= TEXTUAL-CONVENTION 122 STATUS current 123 DESCRIPTION 124 "The status of a table entry. 125 126 Setting this object to the value invalid(4) has the 127 effect of invalidating the corresponding entry. 128 That is, it effectively disassociates the mapping 129 identified with said entry. 130 It is an implementation-specific matter as to whether 131 the agent removes an invalidated entry from the table. 132 Accordingly, management stations must be prepared to 133 receive tabular information from agents that corresponds 134 to entries currently not in use. Proper 135 interpretation of such entries requires examination 136 of the relevant EntryStatus object. 137 138 An existing instance of this object cannot be set to 139 createRequest(2). This object may only be set to 140 createRequest(2) when this instance is created. When 141 this object is created, the agent may wish to create 142 supplemental object instances with default values 143 to complete a conceptual row in this table. Because the 144 creation of these default objects is entirely at the option 145 of the agent, the manager must not assume that any will be 146 created, but may make use of any that are created. 147 Immediately after completing the create operation, the agent 148 must set this object to underCreation(3). 149 150 When in the underCreation(3) state, an entry is allowed to 151 exist in a possibly incomplete, possibly inconsistent state, 152 usually to allow it to be modified in multiple PDUs. When in 153 this state, an entry is not fully active. 154 Entries shall exist in the underCreation(3) state until 155 the management station is finished configuring the entry 156 and sets this object to valid(1) or aborts, setting this 157 object to invalid(4). If the agent determines that an 158 entry has been in the underCreation(3) state for an 159 abnormally long time, it may decide that the management 160 station has crashed. If the agent makes this decision, 161 it may set this object to invalid(4) to reclaim the 162 entry. A prudent agent will understand that the 163 management station may need to wait for human input 164 and will allow for that possibility in its 165 determination of this abnormally long period. 166 167 An entry in the valid(1) state is fully configured and 168 consistent and fully represents the configuration or 169 operation such a row is intended to represent. For 170 example, it could be a statistical function that is 171 configured and active, or a filter that is available 172 in the list of filters processed by the packet capture 173 process. 174 175 A manager is restricted to changing the state of an entry in 176 the following ways: 177 178 To: valid createRequest underCreation invalid 179 From: 180 valid OK NO OK OK 181 createRequest N/A N/A N/A N/A 182 underCreation OK NO OK OK 183 invalid NO NO NO OK 184 nonExistent NO OK NO OK 185 186 In the table above, it is not applicable to move the state 187 from the createRequest state to any other state because the 188 manager will never find the variable in that state. The 189 nonExistent state is not a value of the enumeration, rather 190 it means that the entryStatus variable does not exist at all. 191 192 An agent may allow an entryStatus variable to change state in 193 additional ways, so long as the semantics of the states are 194 followed. This allowance is made to ease the implementation of 195 the agent and is made despite the fact that managers should 196 never exercise these additional state transitions." 197 SYNTAX INTEGER { 198 valid(1), 199 createRequest(2), 200 underCreation(3), 201 invalid(4) 202 } 203 204 statistics OBJECT IDENTIFIER ::= { rmon 1 } 205 history OBJECT IDENTIFIER ::= { rmon 2 } 206 alarm OBJECT IDENTIFIER ::= { rmon 3 } 207 hosts OBJECT IDENTIFIER ::= { rmon 4 } 208 hostTopN OBJECT IDENTIFIER ::= { rmon 5 } 209 matrix OBJECT IDENTIFIER ::= { rmon 6 } 210 filter OBJECT IDENTIFIER ::= { rmon 7 } 211 capture OBJECT IDENTIFIER ::= { rmon 8 } 212 event OBJECT IDENTIFIER ::= { rmon 9 } 213 rmonConformance OBJECT IDENTIFIER ::= { rmon 20 } 214 215-- The Ethernet Statistics Group 216-- 217-- Implementation of the Ethernet Statistics group is optional. 218-- Consult the MODULE-COMPLIANCE macro for the authoritative 219-- conformance information for this MIB. 220-- 221-- The ethernet statistics group contains statistics measured by the 222-- probe for each monitored interface on this device. These 223-- statistics take the form of free running counters that start from 224-- zero when a valid entry is created. 225-- 226-- This group currently has statistics defined only for 227-- Ethernet interfaces. Each etherStatsEntry contains statistics 228-- for one Ethernet interface. The probe must create one 229-- etherStats entry for each monitored Ethernet interface 230-- on the device. 231 232etherStatsTable OBJECT-TYPE 233 SYNTAX SEQUENCE OF EtherStatsEntry 234 MAX-ACCESS not-accessible 235 STATUS current 236 DESCRIPTION 237 "A list of Ethernet statistics entries." 238 ::= { statistics 1 } 239 240etherStatsEntry OBJECT-TYPE 241 SYNTAX EtherStatsEntry 242 MAX-ACCESS not-accessible 243 STATUS current 244 DESCRIPTION 245 "A collection of statistics kept for a particular 246 Ethernet interface. As an example, an instance of the 247 etherStatsPkts object might be named etherStatsPkts.1" 248 INDEX { etherStatsIndex } 249 ::= { etherStatsTable 1 } 250 251EtherStatsEntry ::= SEQUENCE { 252 etherStatsIndex Integer32, 253 etherStatsDataSource OBJECT IDENTIFIER, 254 etherStatsDropEvents Counter32, 255 etherStatsOctets Counter32, 256 etherStatsPkts Counter32, 257 etherStatsBroadcastPkts Counter32, 258 etherStatsMulticastPkts Counter32, 259 etherStatsCRCAlignErrors Counter32, 260 etherStatsUndersizePkts Counter32, 261 etherStatsOversizePkts Counter32, 262 etherStatsFragments Counter32, 263 etherStatsJabbers Counter32, 264 etherStatsCollisions Counter32, 265 etherStatsPkts64Octets Counter32, 266 etherStatsPkts65to127Octets Counter32, 267 etherStatsPkts128to255Octets Counter32, 268 etherStatsPkts256to511Octets Counter32, 269 etherStatsPkts512to1023Octets Counter32, 270 etherStatsPkts1024to1518Octets Counter32, 271 etherStatsOwner OwnerString, 272 etherStatsStatus EntryStatus 273} 274 275etherStatsIndex OBJECT-TYPE 276 SYNTAX Integer32 (1..65535) 277 MAX-ACCESS read-only 278 STATUS current 279 DESCRIPTION 280 "The value of this object uniquely identifies this 281 etherStats entry." 282 ::= { etherStatsEntry 1 } 283 284etherStatsDataSource OBJECT-TYPE 285 SYNTAX OBJECT IDENTIFIER 286 MAX-ACCESS read-create 287 STATUS current 288 289 DESCRIPTION 290 "This object identifies the source of the data that 291 this etherStats entry is configured to analyze. This 292 source can be any ethernet interface on this device. 293 In order to identify a particular interface, this object 294 shall identify the instance of the ifIndex object, 295 defined in RFC 2233 [17], for the desired interface. 296 For example, if an entry were to receive data from 297 interface #1, this object would be set to ifIndex.1. 298 299 The statistics in this group reflect all packets 300 on the local network segment attached to the identified 301 interface. 302 303 An agent may or may not be able to tell if fundamental 304 changes to the media of the interface have occurred and 305 necessitate an invalidation of this entry. For example, a 306 hot-pluggable ethernet card could be pulled out and replaced 307 by a token-ring card. In such a case, if the agent has such 308 knowledge of the change, it is recommended that it 309 invalidate this entry. 310 311 This object may not be modified if the associated 312 etherStatsStatus object is equal to valid(1)." 313 ::= { etherStatsEntry 2 } 314 315etherStatsDropEvents OBJECT-TYPE 316 SYNTAX Counter32 317 MAX-ACCESS read-only 318 STATUS current 319 DESCRIPTION 320 "The total number of events in which packets 321 were dropped by the probe due to lack of resources. 322 Note that this number is not necessarily the number of 323 packets dropped; it is just the number of times this 324 condition has been detected." 325 ::= { etherStatsEntry 3 } 326 327etherStatsOctets OBJECT-TYPE 328 SYNTAX Counter32 329 UNITS "Octets" 330 MAX-ACCESS read-only 331 STATUS current 332 DESCRIPTION 333 "The total number of octets of data (including 334 those in bad packets) received on the 335 network (excluding framing bits but including 336 FCS octets). 337 338 This object can be used as a reasonable estimate of 339 10-Megabit ethernet utilization. If greater precision is 340 desired, the etherStatsPkts and etherStatsOctets objects 341 should be sampled before and after a common interval. The 342 differences in the sampled values are Pkts and Octets, 343 respectively, and the number of seconds in the interval is 344 Interval. These values are used to calculate the Utilization 345 as follows: 346 347 Pkts * (9.6 + 6.4) + (Octets * .8) 348 Utilization = ------------------------------------- 349 Interval * 10,000 350 351 The result of this equation is the value Utilization which 352 is the percent utilization of the ethernet segment on a 353 scale of 0 to 100 percent." 354 ::= { etherStatsEntry 4 } 355 356etherStatsPkts OBJECT-TYPE 357 SYNTAX Counter32 358 UNITS "Packets" 359 MAX-ACCESS read-only 360 STATUS current 361 DESCRIPTION 362 "The total number of packets (including bad packets, 363 broadcast packets, and multicast packets) received." 364 ::= { etherStatsEntry 5 } 365 366etherStatsBroadcastPkts OBJECT-TYPE 367 SYNTAX Counter32 368 UNITS "Packets" 369 MAX-ACCESS read-only 370 STATUS current 371 DESCRIPTION 372 "The total number of good packets received that were 373 directed to the broadcast address. Note that this 374 does not include multicast packets." 375 ::= { etherStatsEntry 6 } 376 377etherStatsMulticastPkts OBJECT-TYPE 378 SYNTAX Counter32 379 UNITS "Packets" 380 MAX-ACCESS read-only 381 STATUS current 382 DESCRIPTION 383 "The total number of good packets received that were 384 directed to a multicast address. Note that this number 385 does not include packets directed to the broadcast 386 address." 387 ::= { etherStatsEntry 7 } 388 389etherStatsCRCAlignErrors OBJECT-TYPE 390 SYNTAX Counter32 391 UNITS "Packets" 392 MAX-ACCESS read-only 393 STATUS current 394 DESCRIPTION 395 "The total number of packets received that 396 had a length (excluding framing bits, but 397 including FCS octets) of between 64 and 1518 398 octets, inclusive, but had either a bad 399 Frame Check Sequence (FCS) with an integral 400 number of octets (FCS Error) or a bad FCS with 401 a non-integral number of octets (Alignment Error)." 402 ::= { etherStatsEntry 8 } 403 404etherStatsUndersizePkts OBJECT-TYPE 405 SYNTAX Counter32 406 UNITS "Packets" 407 MAX-ACCESS read-only 408 STATUS current 409 DESCRIPTION 410 "The total number of packets received that were 411 less than 64 octets long (excluding framing bits, 412 but including FCS octets) and were otherwise well 413 formed." 414 ::= { etherStatsEntry 9 } 415 416etherStatsOversizePkts OBJECT-TYPE 417 SYNTAX Counter32 418 UNITS "Packets" 419 MAX-ACCESS read-only 420 STATUS current 421 DESCRIPTION 422 "The total number of packets received that were 423 longer than 1518 octets (excluding framing bits, 424 but including FCS octets) and were otherwise 425 well formed." 426 ::= { etherStatsEntry 10 } 427 428etherStatsFragments OBJECT-TYPE 429 SYNTAX Counter32 430 UNITS "Packets" 431 MAX-ACCESS read-only 432 STATUS current 433 DESCRIPTION 434 "The total number of packets received that were less than 435 64 octets in length (excluding framing bits but including 436 FCS octets) and had either a bad Frame Check Sequence 437 (FCS) with an integral number of octets (FCS Error) or a 438 bad FCS with a non-integral number of octets (Alignment 439 Error). 440 441 Note that it is entirely normal for etherStatsFragments to 442 increment. This is because it counts both runts (which are 443 normal occurrences due to collisions) and noise hits." 444 ::= { etherStatsEntry 11 } 445 446etherStatsJabbers OBJECT-TYPE 447 SYNTAX Counter32 448 UNITS "Packets" 449 MAX-ACCESS read-only 450 STATUS current 451 DESCRIPTION 452 "The total number of packets received that were 453 longer than 1518 octets (excluding framing bits, 454 but including FCS octets), and had either a bad 455 Frame Check Sequence (FCS) with an integral number 456 of octets (FCS Error) or a bad FCS with a non-integral 457 number of octets (Alignment Error). 458 459 Note that this definition of jabber is different 460 than the definition in IEEE-802.3 section 8.2.1.5 461 (10BASE5) and section 10.3.1.4 (10BASE2). These 462 documents define jabber as the condition where any 463 packet exceeds 20 ms. The allowed range to detect 464 jabber is between 20 ms and 150 ms." 465 ::= { etherStatsEntry 12 } 466 467etherStatsCollisions OBJECT-TYPE 468 SYNTAX Counter32 469 UNITS "Collisions" 470 MAX-ACCESS read-only 471 STATUS current 472 DESCRIPTION 473 "The best estimate of the total number of collisions 474 on this Ethernet segment. 475 476 The value returned will depend on the location of the 477 RMON probe. Section 8.2.1.3 (10BASE-5) and section 478 10.3.1.3 (10BASE-2) of IEEE standard 802.3 states that a 479 station must detect a collision, in the receive mode, if 480 three or more stations are transmitting simultaneously. A 481 repeater port must detect a collision when two or more 482 stations are transmitting simultaneously. Thus a probe 483 placed on a repeater port could record more collisions 484 than a probe connected to a station on the same segment 485 would. 486 487 Probe location plays a much smaller role when considering 488 10BASE-T. 14.2.1.4 (10BASE-T) of IEEE standard 802.3 489 defines a collision as the simultaneous presence of signals 490 on the DO and RD circuits (transmitting and receiving 491 at the same time). A 10BASE-T station can only detect 492 collisions when it is transmitting. Thus probes placed on 493 a station and a repeater, should report the same number of 494 collisions. 495 496 Note also that an RMON probe inside a repeater should 497 ideally report collisions between the repeater and one or 498 more other hosts (transmit collisions as defined by IEEE 499 802.3k) plus receiver collisions observed on any coax 500 segments to which the repeater is connected." 501 ::= { etherStatsEntry 13 } 502 503etherStatsPkts64Octets OBJECT-TYPE 504 SYNTAX Counter32 505 UNITS "Packets" 506 MAX-ACCESS read-only 507 STATUS current 508 DESCRIPTION 509 "The total number of packets (including bad 510 packets) received that were 64 octets in length 511 (excluding framing bits but including FCS octets)." 512 ::= { etherStatsEntry 14 } 513 514etherStatsPkts65to127Octets OBJECT-TYPE 515 SYNTAX Counter32 516 UNITS "Packets" 517 MAX-ACCESS read-only 518 STATUS current 519 DESCRIPTION 520 "The total number of packets (including bad 521 packets) received that were between 522 65 and 127 octets in length inclusive 523 (excluding framing bits but including FCS octets)." 524 ::= { etherStatsEntry 15 } 525 526etherStatsPkts128to255Octets OBJECT-TYPE 527 SYNTAX Counter32 528 UNITS "Packets" 529 MAX-ACCESS read-only 530 531 STATUS current 532 DESCRIPTION 533 "The total number of packets (including bad 534 packets) received that were between 535 128 and 255 octets in length inclusive 536 (excluding framing bits but including FCS octets)." 537 ::= { etherStatsEntry 16 } 538 539etherStatsPkts256to511Octets OBJECT-TYPE 540 SYNTAX Counter32 541 UNITS "Packets" 542 MAX-ACCESS read-only 543 STATUS current 544 DESCRIPTION 545 "The total number of packets (including bad 546 packets) received that were between 547 256 and 511 octets in length inclusive 548 (excluding framing bits but including FCS octets)." 549 ::= { etherStatsEntry 17 } 550 551etherStatsPkts512to1023Octets OBJECT-TYPE 552 SYNTAX Counter32 553 UNITS "Packets" 554 MAX-ACCESS read-only 555 STATUS current 556 DESCRIPTION 557 "The total number of packets (including bad 558 packets) received that were between 559 512 and 1023 octets in length inclusive 560 (excluding framing bits but including FCS octets)." 561 ::= { etherStatsEntry 18 } 562 563etherStatsPkts1024to1518Octets OBJECT-TYPE 564 SYNTAX Counter32 565 UNITS "Packets" 566 MAX-ACCESS read-only 567 STATUS current 568 DESCRIPTION 569 "The total number of packets (including bad 570 packets) received that were between 571 1024 and 1518 octets in length inclusive 572 (excluding framing bits but including FCS octets)." 573 ::= { etherStatsEntry 19 } 574 575etherStatsOwner OBJECT-TYPE 576 SYNTAX OwnerString 577 MAX-ACCESS read-create 578 STATUS current 579 580 DESCRIPTION 581 "The entity that configured this entry and is therefore 582 using the resources assigned to it." 583 ::= { etherStatsEntry 20 } 584 585etherStatsStatus OBJECT-TYPE 586 SYNTAX EntryStatus 587 MAX-ACCESS read-create 588 STATUS current 589 DESCRIPTION 590 "The status of this etherStats entry." 591 ::= { etherStatsEntry 21 } 592 593-- The History Control Group 594 595-- Implementation of the History Control group is optional. 596-- Consult the MODULE-COMPLIANCE macro for the authoritative 597-- conformance information for this MIB. 598-- 599-- The history control group controls the periodic statistical 600-- sampling of data from various types of networks. The 601-- historyControlTable stores configuration entries that each 602-- define an interface, polling period, and other parameters. 603-- Once samples are taken, their data is stored in an entry 604-- in a media-specific table. Each such entry defines one 605-- sample, and is associated with the historyControlEntry that 606-- caused the sample to be taken. Each counter in the 607-- etherHistoryEntry counts the same event as its similarly-named 608-- counterpart in the etherStatsEntry, except that each value here 609-- is a cumulative sum during a sampling period. 610-- 611-- If the probe keeps track of the time of day, it should start 612-- the first sample of the history at a time such that 613-- when the next hour of the day begins, a sample is 614-- started at that instant. This tends to make more 615-- user-friendly reports, and enables comparison of reports 616-- from different probes that have relatively accurate time 617-- of day. 618-- 619-- The probe is encouraged to add two history control entries 620-- per monitored interface upon initialization that describe a short 621-- term and a long term polling period. Suggested parameters are 30 622-- seconds for the short term polling period and 30 minutes for 623-- the long term period. 624 625historyControlTable OBJECT-TYPE 626 SYNTAX SEQUENCE OF HistoryControlEntry 627 MAX-ACCESS not-accessible 628 629 STATUS current 630 DESCRIPTION 631 "A list of history control entries." 632 ::= { history 1 } 633 634historyControlEntry OBJECT-TYPE 635 SYNTAX HistoryControlEntry 636 MAX-ACCESS not-accessible 637 STATUS current 638 DESCRIPTION 639 "A list of parameters that set up a periodic sampling of 640 statistics. As an example, an instance of the 641 historyControlInterval object might be named 642 historyControlInterval.2" 643 INDEX { historyControlIndex } 644 ::= { historyControlTable 1 } 645 646HistoryControlEntry ::= SEQUENCE { 647 historyControlIndex Integer32, 648 historyControlDataSource OBJECT IDENTIFIER, 649 historyControlBucketsRequested Integer32, 650 historyControlBucketsGranted Integer32, 651 historyControlInterval Integer32, 652 historyControlOwner OwnerString, 653 historyControlStatus EntryStatus 654} 655 656historyControlIndex OBJECT-TYPE 657 SYNTAX Integer32 (1..65535) 658 MAX-ACCESS read-only 659 STATUS current 660 DESCRIPTION 661 "An index that uniquely identifies an entry in the 662 historyControl table. Each such entry defines a 663 set of samples at a particular interval for an 664 interface on the device." 665 ::= { historyControlEntry 1 } 666 667historyControlDataSource OBJECT-TYPE 668 SYNTAX OBJECT IDENTIFIER 669 MAX-ACCESS read-create 670 STATUS current 671 DESCRIPTION 672 "This object identifies the source of the data for 673 which historical data was collected and 674 placed in a media-specific table on behalf of this 675 historyControlEntry. This source can be any 676 interface on this device. In order to identify 677 a particular interface, this object shall identify 678 the instance of the ifIndex object, defined 679 in RFC 2233 [17], for the desired interface. 680 For example, if an entry were to receive data from 681 interface #1, this object would be set to ifIndex.1. 682 683 The statistics in this group reflect all packets 684 on the local network segment attached to the identified 685 interface. 686 687 An agent may or may not be able to tell if fundamental 688 changes to the media of the interface have occurred and 689 necessitate an invalidation of this entry. For example, a 690 hot-pluggable ethernet card could be pulled out and replaced 691 by a token-ring card. In such a case, if the agent has such 692 knowledge of the change, it is recommended that it 693 invalidate this entry. 694 695 This object may not be modified if the associated 696 historyControlStatus object is equal to valid(1)." 697 ::= { historyControlEntry 2 } 698 699historyControlBucketsRequested OBJECT-TYPE 700 SYNTAX Integer32 (1..65535) 701 MAX-ACCESS read-create 702 STATUS current 703 DESCRIPTION 704 "The requested number of discrete time intervals 705 over which data is to be saved in the part of the 706 media-specific table associated with this 707 historyControlEntry. 708 709 When this object is created or modified, the probe 710 should set historyControlBucketsGranted as closely to 711 this object as is possible for the particular probe 712 implementation and available resources." 713 DEFVAL { 50 } 714 ::= { historyControlEntry 3 } 715 716historyControlBucketsGranted OBJECT-TYPE 717 SYNTAX Integer32 (1..65535) 718 MAX-ACCESS read-only 719 STATUS current 720 DESCRIPTION 721 "The number of discrete sampling intervals 722 over which data shall be saved in the part of 723 the media-specific table associated with this 724 historyControlEntry. 725 726 When the associated historyControlBucketsRequested 727 object is created or modified, the probe 728 should set this object as closely to the requested 729 value as is possible for the particular 730 probe implementation and available resources. The 731 probe must not lower this value except as a result 732 of a modification to the associated 733 historyControlBucketsRequested object. 734 735 There will be times when the actual number of 736 buckets associated with this entry is less than 737 the value of this object. In this case, at the 738 end of each sampling interval, a new bucket will 739 be added to the media-specific table. 740 741 When the number of buckets reaches the value of 742 this object and a new bucket is to be added to the 743 media-specific table, the oldest bucket associated 744 with this historyControlEntry shall be deleted by 745 the agent so that the new bucket can be added. 746 747 When the value of this object changes to a value less 748 than the current value, entries are deleted 749 from the media-specific table associated with this 750 historyControlEntry. Enough of the oldest of these 751 entries shall be deleted by the agent so that their 752 number remains less than or equal to the new value of 753 this object. 754 755 When the value of this object changes to a value greater 756 than the current value, the number of associated media- 757 specific entries may be allowed to grow." 758 ::= { historyControlEntry 4 } 759 760historyControlInterval OBJECT-TYPE 761 SYNTAX Integer32 (1..3600) 762 UNITS "Seconds" 763 MAX-ACCESS read-create 764 STATUS current 765 DESCRIPTION 766 "The interval in seconds over which the data is 767 sampled for each bucket in the part of the 768 media-specific table associated with this 769 historyControlEntry. This interval can 770 be set to any number of seconds between 1 and 771 3600 (1 hour). 772 773 Because the counters in a bucket may overflow at their 774 maximum value with no indication, a prudent manager will 775 take into account the possibility of overflow in any of 776 the associated counters. It is important to consider the 777 minimum time in which any counter could overflow on a 778 particular media type and set the historyControlInterval 779 object to a value less than this interval. This is 780 typically most important for the 'octets' counter in any 781 media-specific table. For example, on an Ethernet 782 network, the etherHistoryOctets counter could overflow 783 in about one hour at the Ethernet's maximum 784 utilization. 785 786 This object may not be modified if the associated 787 historyControlStatus object is equal to valid(1)." 788 DEFVAL { 1800 } 789 ::= { historyControlEntry 5 } 790 791historyControlOwner OBJECT-TYPE 792 SYNTAX OwnerString 793 MAX-ACCESS read-create 794 STATUS current 795 DESCRIPTION 796 "The entity that configured this entry and is therefore 797 using the resources assigned to it." 798 ::= { historyControlEntry 6 } 799 800historyControlStatus OBJECT-TYPE 801 SYNTAX EntryStatus 802 MAX-ACCESS read-create 803 STATUS current 804 DESCRIPTION 805 "The status of this historyControl entry. 806 807 Each instance of the media-specific table associated 808 with this historyControlEntry will be deleted by the agent 809 if this historyControlEntry is not equal to valid(1)." 810 ::= { historyControlEntry 7 } 811 812-- The Ethernet History Group 813 814-- Implementation of the Ethernet History group is optional. 815-- Consult the MODULE-COMPLIANCE macro for the authoritative 816-- conformance information for this MIB. 817-- 818-- The Ethernet History group records periodic statistical samples 819-- from a network and stores them for later retrieval. 820-- Once samples are taken, their data is stored in an entry 821-- in a media-specific table. Each such entry defines one 822-- sample, and is associated with the historyControlEntry that 823-- caused the sample to be taken. This group defines the 824-- etherHistoryTable, for Ethernet networks. 825-- 826 827etherHistoryTable OBJECT-TYPE 828 SYNTAX SEQUENCE OF EtherHistoryEntry 829 MAX-ACCESS not-accessible 830 STATUS current 831 DESCRIPTION 832 "A list of Ethernet history entries." 833 ::= { history 2 } 834 835etherHistoryEntry OBJECT-TYPE 836 SYNTAX EtherHistoryEntry 837 MAX-ACCESS not-accessible 838 STATUS current 839 DESCRIPTION 840 "An historical sample of Ethernet statistics on a particular 841 Ethernet interface. This sample is associated with the 842 historyControlEntry which set up the parameters for 843 a regular collection of these samples. As an example, an 844 instance of the etherHistoryPkts object might be named 845 etherHistoryPkts.2.89" 846 INDEX { etherHistoryIndex , etherHistorySampleIndex } 847 ::= { etherHistoryTable 1 } 848 849EtherHistoryEntry ::= SEQUENCE { 850 etherHistoryIndex Integer32, 851 etherHistorySampleIndex Integer32, 852 etherHistoryIntervalStart TimeTicks, 853 etherHistoryDropEvents Counter32, 854 etherHistoryOctets Counter32, 855 etherHistoryPkts Counter32, 856 etherHistoryBroadcastPkts Counter32, 857 etherHistoryMulticastPkts Counter32, 858 etherHistoryCRCAlignErrors Counter32, 859 etherHistoryUndersizePkts Counter32, 860 etherHistoryOversizePkts Counter32, 861 etherHistoryFragments Counter32, 862 etherHistoryJabbers Counter32, 863 etherHistoryCollisions Counter32, 864 etherHistoryUtilization Integer32 865} 866 867etherHistoryIndex OBJECT-TYPE 868 SYNTAX Integer32 (1..65535) 869 MAX-ACCESS read-only 870 STATUS current 871 DESCRIPTION 872 "The history of which this entry is a part. The 873 history identified by a particular value of this 874 index is the same history as identified 875 by the same value of historyControlIndex." 876 ::= { etherHistoryEntry 1 } 877 878etherHistorySampleIndex OBJECT-TYPE 879 SYNTAX Integer32 (1..2147483647) 880 MAX-ACCESS read-only 881 STATUS current 882 DESCRIPTION 883 "An index that uniquely identifies the particular 884 sample this entry represents among all samples 885 associated with the same historyControlEntry. 886 This index starts at 1 and increases by one 887 as each new sample is taken." 888 ::= { etherHistoryEntry 2 } 889 890etherHistoryIntervalStart OBJECT-TYPE 891 SYNTAX TimeTicks 892 MAX-ACCESS read-only 893 STATUS current 894 DESCRIPTION 895 "The value of sysUpTime at the start of the interval 896 over which this sample was measured. If the probe 897 keeps track of the time of day, it should start 898 the first sample of the history at a time such that 899 when the next hour of the day begins, a sample is 900 started at that instant. Note that following this 901 rule may require the probe to delay collecting the 902 first sample of the history, as each sample must be 903 of the same interval. Also note that the sample which 904 is currently being collected is not accessible in this 905 table until the end of its interval." 906 ::= { etherHistoryEntry 3 } 907 908etherHistoryDropEvents OBJECT-TYPE 909 SYNTAX Counter32 910 MAX-ACCESS read-only 911 STATUS current 912 DESCRIPTION 913 "The total number of events in which packets 914 were dropped by the probe due to lack of resources 915 during this sampling interval. Note that this number 916 is not necessarily the number of packets dropped, it 917 is just the number of times this condition has been 918 detected." 919 ::= { etherHistoryEntry 4 } 920 921etherHistoryOctets OBJECT-TYPE 922 SYNTAX Counter32 923 UNITS "Octets" 924 MAX-ACCESS read-only 925 STATUS current 926 DESCRIPTION 927 "The total number of octets of data (including 928 those in bad packets) received on the 929 network (excluding framing bits but including 930 FCS octets)." 931 ::= { etherHistoryEntry 5 } 932 933etherHistoryPkts OBJECT-TYPE 934 SYNTAX Counter32 935 UNITS "Packets" 936 MAX-ACCESS read-only 937 STATUS current 938 DESCRIPTION 939 "The number of packets (including bad packets) 940 received during this sampling interval." 941 ::= { etherHistoryEntry 6 } 942 943etherHistoryBroadcastPkts OBJECT-TYPE 944 SYNTAX Counter32 945 UNITS "Packets" 946 MAX-ACCESS read-only 947 STATUS current 948 DESCRIPTION 949 "The number of good packets received during this 950 sampling interval that were directed to the 951 broadcast address." 952 ::= { etherHistoryEntry 7 } 953 954etherHistoryMulticastPkts OBJECT-TYPE 955 SYNTAX Counter32 956 UNITS "Packets" 957 MAX-ACCESS read-only 958 STATUS current 959 DESCRIPTION 960 "The number of good packets received during this 961 sampling interval that were directed to a 962 multicast address. Note that this number does not 963 include packets addressed to the broadcast address." 964 ::= { etherHistoryEntry 8 } 965 966etherHistoryCRCAlignErrors OBJECT-TYPE 967 SYNTAX Counter32 968 UNITS "Packets" 969 MAX-ACCESS read-only 970 STATUS current 971 DESCRIPTION 972 "The number of packets received during this 973 sampling interval that had a length (excluding 974 framing bits but including FCS octets) between 975 64 and 1518 octets, inclusive, but had either a bad Frame 976 Check Sequence (FCS) with an integral number of octets 977 (FCS Error) or a bad FCS with a non-integral number 978 of octets (Alignment Error)." 979 ::= { etherHistoryEntry 9 } 980 981etherHistoryUndersizePkts OBJECT-TYPE 982 SYNTAX Counter32 983 UNITS "Packets" 984 MAX-ACCESS read-only 985 STATUS current 986 DESCRIPTION 987 "The number of packets received during this 988 sampling interval that were less than 64 octets 989 long (excluding framing bits but including FCS 990 octets) and were otherwise well formed." 991 ::= { etherHistoryEntry 10 } 992 993etherHistoryOversizePkts OBJECT-TYPE 994 SYNTAX Counter32 995 UNITS "Packets" 996 MAX-ACCESS read-only 997 STATUS current 998 DESCRIPTION 999 "The number of packets received during this 1000 sampling interval that were longer than 1518 1001 octets (excluding framing bits but including 1002 FCS octets) but were otherwise well formed." 1003 ::= { etherHistoryEntry 11 } 1004 1005etherHistoryFragments OBJECT-TYPE 1006 SYNTAX Counter32 1007 UNITS "Packets" 1008 MAX-ACCESS read-only 1009 STATUS current 1010 DESCRIPTION 1011 "The total number of packets received during this 1012 sampling interval that were less than 64 octets in 1013 length (excluding framing bits but including FCS 1014 octets) had either a bad Frame Check Sequence (FCS) 1015 with an integral number of octets (FCS Error) or a bad 1016 FCS with a non-integral number of octets (Alignment 1017 Error). 1018 1019 Note that it is entirely normal for etherHistoryFragments to 1020 increment. This is because it counts both runts (which are 1021 normal occurrences due to collisions) and noise hits." 1022 ::= { etherHistoryEntry 12 } 1023 1024etherHistoryJabbers OBJECT-TYPE 1025 SYNTAX Counter32 1026 UNITS "Packets" 1027 MAX-ACCESS read-only 1028 STATUS current 1029 DESCRIPTION 1030 "The number of packets received during this 1031 sampling interval that were longer than 1518 octets 1032 (excluding framing bits but including FCS octets), 1033 and had either a bad Frame Check Sequence (FCS) 1034 with an integral number of octets (FCS Error) or 1035 a bad FCS with a non-integral number of octets 1036 (Alignment Error). 1037 1038 Note that this definition of jabber is different 1039 than the definition in IEEE-802.3 section 8.2.1.5 1040 (10BASE5) and section 10.3.1.4 (10BASE2). These 1041 documents define jabber as the condition where any 1042 packet exceeds 20 ms. The allowed range to detect 1043 jabber is between 20 ms and 150 ms." 1044 ::= { etherHistoryEntry 13 } 1045 1046etherHistoryCollisions OBJECT-TYPE 1047 SYNTAX Counter32 1048 UNITS "Collisions" 1049 MAX-ACCESS read-only 1050 STATUS current 1051 DESCRIPTION 1052 "The best estimate of the total number of collisions 1053 on this Ethernet segment during this sampling 1054 interval. 1055 1056 The value returned will depend on the location of the 1057 RMON probe. Section 8.2.1.3 (10BASE-5) and section 1058 10.3.1.3 (10BASE-2) of IEEE standard 802.3 states that a 1059 station must detect a collision, in the receive mode, if 1060 three or more stations are transmitting simultaneously. A 1061 repeater port must detect a collision when two or more 1062 stations are transmitting simultaneously. Thus a probe 1063 placed on a repeater port could record more collisions 1064 than a probe connected to a station on the same segment 1065 would. 1066 1067 Probe location plays a much smaller role when considering 1068 10BASE-T. 14.2.1.4 (10BASE-T) of IEEE standard 802.3 1069 defines a collision as the simultaneous presence of signals 1070 on the DO and RD circuits (transmitting and receiving 1071 at the same time). A 10BASE-T station can only detect 1072 collisions when it is transmitting. Thus probes placed on 1073 a station and a repeater, should report the same number of 1074 collisions. 1075 1076 Note also that an RMON probe inside a repeater should 1077 ideally report collisions between the repeater and one or 1078 more other hosts (transmit collisions as defined by IEEE 1079 802.3k) plus receiver collisions observed on any coax 1080 segments to which the repeater is connected." 1081 ::= { etherHistoryEntry 14 } 1082 1083etherHistoryUtilization OBJECT-TYPE 1084 SYNTAX Integer32 (0..10000) 1085 MAX-ACCESS read-only 1086 STATUS current 1087 DESCRIPTION 1088 "The best estimate of the mean physical layer 1089 network utilization on this interface during this 1090 sampling interval, in hundredths of a percent." 1091 ::= { etherHistoryEntry 15 } 1092 1093-- The Alarm Group 1094 1095-- Implementation of the Alarm group is optional. The Alarm Group 1096-- requires the implementation of the Event group. 1097-- Consult the MODULE-COMPLIANCE macro for the authoritative 1098-- conformance information for this MIB. 1099-- 1100-- The Alarm group periodically takes statistical samples from 1101-- variables in the probe and compares them to thresholds that have 1102-- been configured. The alarm table stores configuration 1103-- entries that each define a variable, polling period, and 1104-- threshold parameters. If a sample is found to cross the 1105-- threshold values, an event is generated. Only variables that 1106-- resolve to an ASN.1 primitive type of INTEGER (INTEGER, Integer32, 1107-- Counter32, Counter64, Gauge32, or TimeTicks) may be monitored in 1108-- this way. 1109-- 1110-- This function has a hysteresis mechanism to limit the generation 1111-- of events. This mechanism generates one event as a threshold 1112-- is crossed in the appropriate direction. No more events are 1113-- generated for that threshold until the opposite threshold is 1114-- crossed. 1115-- 1116-- In the case of a sampling a deltaValue, a probe may implement 1117-- this mechanism with more precision if it takes a delta sample 1118-- twice per period, each time comparing the sum of the latest two 1119-- samples to the threshold. This allows the detection of threshold 1120-- crossings that span the sampling boundary. Note that this does 1121-- not require any special configuration of the threshold value. 1122-- It is suggested that probes implement this more precise algorithm. 1123 1124alarmTable OBJECT-TYPE 1125 SYNTAX SEQUENCE OF AlarmEntry 1126 MAX-ACCESS not-accessible 1127 STATUS current 1128 DESCRIPTION 1129 "A list of alarm entries." 1130 ::= { alarm 1 } 1131 1132alarmEntry OBJECT-TYPE 1133 SYNTAX AlarmEntry 1134 MAX-ACCESS not-accessible 1135 STATUS current 1136 DESCRIPTION 1137 "A list of parameters that set up a periodic checking 1138 for alarm conditions. For example, an instance of the 1139 alarmValue object might be named alarmValue.8" 1140 INDEX { alarmIndex } 1141 ::= { alarmTable 1 } 1142 1143AlarmEntry ::= SEQUENCE { 1144 alarmIndex Integer32, 1145 alarmInterval Integer32, 1146 alarmVariable OBJECT IDENTIFIER, 1147 alarmSampleType INTEGER, 1148 alarmValue Integer32, 1149 alarmStartupAlarm INTEGER, 1150 alarmRisingThreshold Integer32, 1151 alarmFallingThreshold Integer32, 1152 alarmRisingEventIndex Integer32, 1153 alarmFallingEventIndex Integer32, 1154 alarmOwner OwnerString, 1155 alarmStatus EntryStatus 1156} 1157 1158alarmIndex OBJECT-TYPE 1159 SYNTAX Integer32 (1..65535) 1160 MAX-ACCESS read-only 1161 STATUS current 1162 DESCRIPTION 1163 "An index that uniquely identifies an entry in the 1164 alarm table. Each such entry defines a 1165 diagnostic sample at a particular interval 1166 for an object on the device." 1167 ::= { alarmEntry 1 } 1168 1169alarmInterval OBJECT-TYPE 1170 SYNTAX Integer32 1171 UNITS "Seconds" 1172 MAX-ACCESS read-create 1173 STATUS current 1174 DESCRIPTION 1175 "The interval in seconds over which the data is 1176 sampled and compared with the rising and falling 1177 thresholds. When setting this variable, care 1178 should be taken in the case of deltaValue 1179 sampling - the interval should be set short enough 1180 that the sampled variable is very unlikely to 1181 increase or decrease by more than 2^31 - 1 during 1182 a single sampling interval. 1183 1184 This object may not be modified if the associated 1185 alarmStatus object is equal to valid(1)." 1186 ::= { alarmEntry 2 } 1187 1188alarmVariable OBJECT-TYPE 1189 SYNTAX OBJECT IDENTIFIER 1190 MAX-ACCESS read-create 1191 STATUS current 1192 DESCRIPTION 1193 "The object identifier of the particular variable to be 1194 sampled. Only variables that resolve to an ASN.1 primitive 1195 type of INTEGER (INTEGER, Integer32, Counter32, Counter64, 1196 Gauge, or TimeTicks) may be sampled. 1197 1198 Because SNMP access control is articulated entirely 1199 in terms of the contents of MIB views, no access 1200 control mechanism exists that can restrict the value of 1201 this object to identify only those objects that exist 1202 in a particular MIB view. Because there is thus no 1203 acceptable means of restricting the read access that 1204 could be obtained through the alarm mechanism, the 1205 probe must only grant write access to this object in 1206 those views that have read access to all objects on 1207 the probe. 1208 1209 During a set operation, if the supplied variable name is 1210 not available in the selected MIB view, a badValue error 1211 must be returned. If at any time the variable name of 1212 an established alarmEntry is no longer available in the 1213 selected MIB view, the probe must change the status of 1214 this alarmEntry to invalid(4). 1215 1216 This object may not be modified if the associated 1217 alarmStatus object is equal to valid(1)." 1218 ::= { alarmEntry 3 } 1219 1220alarmSampleType OBJECT-TYPE 1221 SYNTAX INTEGER { 1222 absoluteValue(1), 1223 deltaValue(2) 1224 } 1225 MAX-ACCESS read-create 1226 STATUS current 1227 DESCRIPTION 1228 "The method of sampling the selected variable and 1229 calculating the value to be compared against the 1230 thresholds. If the value of this object is 1231 absoluteValue(1), the value of the selected variable 1232 will be compared directly with the thresholds at the 1233 end of the sampling interval. If the value of this 1234 object is deltaValue(2), the value of the selected 1235 variable at the last sample will be subtracted from 1236 the current value, and the difference compared with 1237 the thresholds. 1238 1239 This object may not be modified if the associated 1240 alarmStatus object is equal to valid(1)." 1241 ::= { alarmEntry 4 } 1242 1243alarmValue OBJECT-TYPE 1244 SYNTAX Integer32 1245 MAX-ACCESS read-only 1246 STATUS current 1247 DESCRIPTION 1248 "The value of the statistic during the last sampling 1249 period. For example, if the sample type is deltaValue, 1250 this value will be the difference between the samples 1251 at the beginning and end of the period. If the sample 1252 type is absoluteValue, this value will be the sampled 1253 value at the end of the period. 1254 This is the value that is compared with the rising and 1255 falling thresholds. 1256 1257 The value during the current sampling period is not 1258 made available until the period is completed and will 1259 remain available until the next period completes." 1260 ::= { alarmEntry 5 } 1261 1262alarmStartupAlarm OBJECT-TYPE 1263 SYNTAX INTEGER { 1264 risingAlarm(1), 1265 fallingAlarm(2), 1266 risingOrFallingAlarm(3) 1267 } 1268 MAX-ACCESS read-create 1269 STATUS current 1270 DESCRIPTION 1271 "The alarm that may be sent when this entry is first 1272 set to valid. If the first sample after this entry 1273 becomes valid is greater than or equal to the 1274 risingThreshold and alarmStartupAlarm is equal to 1275 risingAlarm(1) or risingOrFallingAlarm(3), then a single 1276 rising alarm will be generated. If the first sample 1277 after this entry becomes valid is less than or equal 1278 to the fallingThreshold and alarmStartupAlarm is equal 1279 to fallingAlarm(2) or risingOrFallingAlarm(3), then a 1280 single falling alarm will be generated. 1281 1282 This object may not be modified if the associated 1283 alarmStatus object is equal to valid(1)." 1284 ::= { alarmEntry 6 } 1285 1286alarmRisingThreshold OBJECT-TYPE 1287 SYNTAX Integer32 1288 MAX-ACCESS read-create 1289 STATUS current 1290 DESCRIPTION 1291 "A threshold for the sampled statistic. When the current 1292 sampled value is greater than or equal to this threshold, 1293 and the value at the last sampling interval was less than 1294 this threshold, a single event will be generated. 1295 A single event will also be generated if the first 1296 sample after this entry becomes valid is greater than or 1297 equal to this threshold and the associated 1298 alarmStartupAlarm is equal to risingAlarm(1) or 1299 risingOrFallingAlarm(3). 1300 1301 After a rising event is generated, another such event 1302 will not be generated until the sampled value 1303 falls below this threshold and reaches the 1304 alarmFallingThreshold. 1305 1306 This object may not be modified if the associated 1307 alarmStatus object is equal to valid(1)." 1308 ::= { alarmEntry 7 } 1309 1310alarmFallingThreshold OBJECT-TYPE 1311 SYNTAX Integer32 1312 MAX-ACCESS read-create 1313 STATUS current 1314 DESCRIPTION 1315 "A threshold for the sampled statistic. When the current 1316 sampled value is less than or equal to this threshold, 1317 and the value at the last sampling interval was greater than 1318 this threshold, a single event will be generated. 1319 A single event will also be generated if the first 1320 sample after this entry becomes valid is less than or 1321 equal to this threshold and the associated 1322 alarmStartupAlarm is equal to fallingAlarm(2) or 1323 risingOrFallingAlarm(3). 1324 1325 After a falling event is generated, another such event 1326 will not be generated until the sampled value 1327 rises above this threshold and reaches the 1328 alarmRisingThreshold. 1329 1330 This object may not be modified if the associated 1331 alarmStatus object is equal to valid(1)." 1332 ::= { alarmEntry 8 } 1333 1334alarmRisingEventIndex OBJECT-TYPE 1335 SYNTAX Integer32 (0..65535) 1336 MAX-ACCESS read-create 1337 STATUS current 1338 DESCRIPTION 1339 "The index of the eventEntry that is 1340 used when a rising threshold is crossed. The 1341 eventEntry identified by a particular value of 1342 this index is the same as identified by the same value 1343 of the eventIndex object. If there is no 1344 corresponding entry in the eventTable, then 1345 no association exists. In particular, if this value 1346 is zero, no associated event will be generated, as 1347 zero is not a valid event index. 1348 1349 This object may not be modified if the associated 1350 alarmStatus object is equal to valid(1)." 1351 ::= { alarmEntry 9 } 1352 1353alarmFallingEventIndex OBJECT-TYPE 1354 SYNTAX Integer32 (0..65535) 1355 MAX-ACCESS read-create 1356 STATUS current 1357 DESCRIPTION 1358 "The index of the eventEntry that is 1359 used when a falling threshold is crossed. The 1360 eventEntry identified by a particular value of 1361 this index is the same as identified by the same value 1362 of the eventIndex object. If there is no 1363 corresponding entry in the eventTable, then 1364 no association exists. In particular, if this value 1365 is zero, no associated event will be generated, as 1366 zero is not a valid event index. 1367 1368 This object may not be modified if the associated 1369 alarmStatus object is equal to valid(1)." 1370 ::= { alarmEntry 10 } 1371 1372alarmOwner OBJECT-TYPE 1373 SYNTAX OwnerString 1374 MAX-ACCESS read-create 1375 STATUS current 1376 DESCRIPTION 1377 "The entity that configured this entry and is therefore 1378 using the resources assigned to it." 1379 ::= { alarmEntry 11 } 1380 1381alarmStatus OBJECT-TYPE 1382 SYNTAX EntryStatus 1383 MAX-ACCESS read-create 1384 STATUS current 1385 DESCRIPTION 1386 "The status of this alarm entry." 1387 ::= { alarmEntry 12 } 1388 1389-- The Host Group 1390 1391-- Implementation of the Host group is optional. 1392-- Consult the MODULE-COMPLIANCE macro for the authoritative 1393-- conformance information for this MIB. 1394-- 1395-- The host group discovers new hosts on the network by 1396-- keeping a list of source and destination MAC Addresses seen 1397-- in good packets. For each of these addresses, the host group 1398-- keeps a set of statistics. The hostControlTable controls 1399-- which interfaces this function is performed on, and contains 1400-- some information about the process. On behalf of each 1401-- hostControlEntry, data is collected on an interface and placed 1402-- in both the hostTable and the hostTimeTable. If the 1403-- monitoring device finds itself short of resources, it may 1404-- delete entries as needed. It is suggested that the device 1405-- delete the least recently used entries first. 1406 1407-- The hostTable contains entries for each address discovered on 1408-- a particular interface. Each entry contains statistical 1409-- data about that host. This table is indexed by the 1410-- MAC address of the host, through which a random access 1411-- may be achieved. 1412 1413-- The hostTimeTable contains data in the same format as the 1414-- hostTable, and must contain the same set of hosts, but is 1415-- indexed using hostTimeCreationOrder rather than hostAddress. 1416-- The hostTimeCreationOrder is an integer which reflects 1417-- the relative order in which a particular entry was discovered 1418-- and thus inserted into the table. As this order, and thus 1419-- the index, is among those entries currently in the table, 1420-- the index for a particular entry may change if an 1421-- (earlier) entry is deleted. Thus the association between 1422-- hostTimeCreationOrder and hostTimeEntry may be broken at 1423-- any time. 1424 1425-- The hostTimeTable has two important uses. The first is the 1426-- fast download of this potentially large table. Because the 1427-- index of this table runs from 1 to the size of the table, 1428-- inclusive, its values are predictable. This allows very 1429-- efficient packing of variables into SNMP PDU's and allows 1430-- a table transfer to have multiple packets outstanding. 1431-- These benefits increase transfer rates tremendously. 1432 1433-- The second use of the hostTimeTable is the efficient discovery 1434-- by the management station of new entries added to the table. 1435-- After the management station has downloaded the entire table, 1436-- it knows that new entries will be added immediately after the 1437-- end of the current table. It can thus detect new entries there 1438-- and retrieve them easily. 1439 1440-- Because the association between hostTimeCreationOrder and 1441-- hostTimeEntry may be broken at any time, the management 1442-- station must monitor the related hostControlLastDeleteTime 1443-- object. When the management station thus detects a deletion, 1444-- it must assume that any such associations have been broken, 1445-- and invalidate any it has stored locally. This includes 1446-- restarting any download of the hostTimeTable that may have been 1447-- in progress, as well as rediscovering the end of the 1448-- hostTimeTable so that it may detect new entries. If the 1449-- management station does not detect the broken association, 1450-- it may continue to refer to a particular host by its 1451-- creationOrder while unwittingly retrieving the data associated 1452-- with another host entirely. If this happens while downloading 1453-- the host table, the management station may fail to download 1454-- all of the entries in the table. 1455 1456 1457hostControlTable OBJECT-TYPE 1458 SYNTAX SEQUENCE OF HostControlEntry 1459 MAX-ACCESS not-accessible 1460 STATUS current 1461 DESCRIPTION 1462 "A list of host table control entries." 1463 ::= { hosts 1 } 1464 1465hostControlEntry OBJECT-TYPE 1466 SYNTAX HostControlEntry 1467 MAX-ACCESS not-accessible 1468 STATUS current 1469 DESCRIPTION 1470 "A list of parameters that set up the discovery of hosts 1471 on a particular interface and the collection of statistics 1472 about these hosts. For example, an instance of the 1473 hostControlTableSize object might be named 1474 hostControlTableSize.1" 1475 INDEX { hostControlIndex } 1476 ::= { hostControlTable 1 } 1477 1478HostControlEntry ::= SEQUENCE { 1479 1480 hostControlIndex Integer32, 1481 hostControlDataSource OBJECT IDENTIFIER, 1482 hostControlTableSize Integer32, 1483 hostControlLastDeleteTime TimeTicks, 1484 hostControlOwner OwnerString, 1485 hostControlStatus EntryStatus 1486} 1487 1488hostControlIndex OBJECT-TYPE 1489 SYNTAX Integer32 (1..65535) 1490 MAX-ACCESS read-only 1491 STATUS current 1492 DESCRIPTION 1493 "An index that uniquely identifies an entry in the 1494 hostControl table. Each such entry defines 1495 a function that discovers hosts on a particular interface 1496 and places statistics about them in the hostTable and 1497 the hostTimeTable on behalf of this hostControlEntry." 1498 ::= { hostControlEntry 1 } 1499 1500hostControlDataSource OBJECT-TYPE 1501 SYNTAX OBJECT IDENTIFIER 1502 MAX-ACCESS read-create 1503 STATUS current 1504 DESCRIPTION 1505 "This object identifies the source of the data for 1506 this instance of the host function. This source 1507 can be any interface on this device. In order 1508 to identify a particular interface, this object shall 1509 identify the instance of the ifIndex object, defined 1510 in RFC 2233 [17], for the desired interface. 1511 For example, if an entry were to receive data from 1512 interface #1, this object would be set to ifIndex.1. 1513 1514 The statistics in this group reflect all packets 1515 on the local network segment attached to the identified 1516 interface. 1517 1518 An agent may or may not be able to tell if fundamental 1519 changes to the media of the interface have occurred and 1520 necessitate an invalidation of this entry. For example, a 1521 hot-pluggable ethernet card could be pulled out and replaced 1522 by a token-ring card. In such a case, if the agent has such 1523 knowledge of the change, it is recommended that it 1524 invalidate this entry. 1525 1526 This object may not be modified if the associated 1527 hostControlStatus object is equal to valid(1)." 1528 ::= { hostControlEntry 2 } 1529 1530hostControlTableSize OBJECT-TYPE 1531 SYNTAX Integer32 1532 MAX-ACCESS read-only 1533 STATUS current 1534 DESCRIPTION 1535 "The number of hostEntries in the hostTable and the 1536 hostTimeTable associated with this hostControlEntry." 1537 ::= { hostControlEntry 3 } 1538 1539hostControlLastDeleteTime OBJECT-TYPE 1540 SYNTAX TimeTicks 1541 MAX-ACCESS read-only 1542 STATUS current 1543 DESCRIPTION 1544 "The value of sysUpTime when the last entry 1545 was deleted from the portion of the hostTable 1546 associated with this hostControlEntry. If no 1547 deletions have occurred, this value shall be zero." 1548 ::= { hostControlEntry 4 } 1549 1550hostControlOwner OBJECT-TYPE 1551 SYNTAX OwnerString 1552 MAX-ACCESS read-create 1553 STATUS current 1554 DESCRIPTION 1555 "The entity that configured this entry and is therefore 1556 using the resources assigned to it." 1557 ::= { hostControlEntry 5 } 1558 1559hostControlStatus OBJECT-TYPE 1560 SYNTAX EntryStatus 1561 MAX-ACCESS read-create 1562 STATUS current 1563 DESCRIPTION 1564 "The status of this hostControl entry. 1565 1566 If this object is not equal to valid(1), all associated 1567 entries in the hostTable, hostTimeTable, and the 1568 hostTopNTable shall be deleted by the agent." 1569 ::= { hostControlEntry 6 } 1570 1571hostTable OBJECT-TYPE 1572 SYNTAX SEQUENCE OF HostEntry 1573 MAX-ACCESS not-accessible 1574 STATUS current 1575 DESCRIPTION 1576 "A list of host entries." 1577 ::= { hosts 2 } 1578 1579hostEntry OBJECT-TYPE 1580 SYNTAX HostEntry 1581 MAX-ACCESS not-accessible 1582 STATUS current 1583 DESCRIPTION 1584 "A collection of statistics for a particular host that has 1585 been discovered on an interface of this device. For example, 1586 an instance of the hostOutBroadcastPkts object might be 1587 named hostOutBroadcastPkts.1.6.8.0.32.27.3.176" 1588 INDEX { hostIndex, hostAddress } 1589 ::= { hostTable 1 } 1590 1591HostEntry ::= SEQUENCE { 1592 hostAddress OCTET STRING, 1593 hostCreationOrder Integer32, 1594 hostIndex Integer32, 1595 hostInPkts Counter32, 1596 hostOutPkts Counter32, 1597 hostInOctets Counter32, 1598 hostOutOctets Counter32, 1599 hostOutErrors Counter32, 1600 hostOutBroadcastPkts Counter32, 1601 hostOutMulticastPkts Counter32 1602} 1603 1604hostAddress OBJECT-TYPE 1605 SYNTAX OCTET STRING 1606 MAX-ACCESS read-only 1607 STATUS current 1608 DESCRIPTION 1609 "The physical address of this host." 1610 ::= { hostEntry 1 } 1611 1612hostCreationOrder OBJECT-TYPE 1613 SYNTAX Integer32 (1..65535) 1614 MAX-ACCESS read-only 1615 STATUS current 1616 DESCRIPTION 1617 "An index that defines the relative ordering of 1618 the creation time of hosts captured for a 1619 particular hostControlEntry. This index shall 1620 be between 1 and N, where N is the value of 1621 the associated hostControlTableSize. The ordering 1622 of the indexes is based on the order of each entry's 1623 insertion into the table, in which entries added earlier 1624 have a lower index value than entries added later. 1625 1626 It is important to note that the order for a 1627 particular entry may change as an (earlier) entry 1628 is deleted from the table. Because this order may 1629 change, management stations should make use of the 1630 hostControlLastDeleteTime variable in the 1631 hostControlEntry associated with the relevant 1632 portion of the hostTable. By observing 1633 this variable, the management station may detect 1634 the circumstances where a previous association 1635 between a value of hostCreationOrder 1636 and a hostEntry may no longer hold." 1637 ::= { hostEntry 2 } 1638 1639hostIndex OBJECT-TYPE 1640 SYNTAX Integer32 (1..65535) 1641 MAX-ACCESS read-only 1642 STATUS current 1643 DESCRIPTION 1644 "The set of collected host statistics of which 1645 this entry is a part. The set of hosts 1646 identified by a particular value of this 1647 index is associated with the hostControlEntry 1648 as identified by the same value of hostControlIndex." 1649 ::= { hostEntry 3 } 1650 1651hostInPkts OBJECT-TYPE 1652 SYNTAX Counter32 1653 UNITS "Packets" 1654 MAX-ACCESS read-only 1655 STATUS current 1656 DESCRIPTION 1657 "The number of good packets transmitted to this 1658 address since it was added to the hostTable." 1659 ::= { hostEntry 4 } 1660 1661hostOutPkts OBJECT-TYPE 1662 SYNTAX Counter32 1663 UNITS "Packets" 1664 MAX-ACCESS read-only 1665 STATUS current 1666 DESCRIPTION 1667 "The number of packets, including bad packets, transmitted 1668 by this address since it was added to the hostTable." 1669 ::= { hostEntry 5 } 1670 1671hostInOctets OBJECT-TYPE 1672 SYNTAX Counter32 1673 UNITS "Octets" 1674 MAX-ACCESS read-only 1675 STATUS current 1676 DESCRIPTION 1677 "The number of octets transmitted to this address since 1678 it was added to the hostTable (excluding framing 1679 bits but including FCS octets), except for those 1680 octets in bad packets." 1681 ::= { hostEntry 6 } 1682 1683hostOutOctets OBJECT-TYPE 1684 SYNTAX Counter32 1685 UNITS "Octets" 1686 MAX-ACCESS read-only 1687 STATUS current 1688 DESCRIPTION 1689 "The number of octets transmitted by this address since 1690 it was added to the hostTable (excluding framing 1691 bits but including FCS octets), including those 1692 octets in bad packets." 1693 ::= { hostEntry 7 } 1694 1695hostOutErrors OBJECT-TYPE 1696 SYNTAX Counter32 1697 UNITS "Packets" 1698 MAX-ACCESS read-only 1699 STATUS current 1700 DESCRIPTION 1701 "The number of bad packets transmitted by this address 1702 since this host was added to the hostTable." 1703 ::= { hostEntry 8 } 1704 1705hostOutBroadcastPkts OBJECT-TYPE 1706 SYNTAX Counter32 1707 UNITS "Packets" 1708 MAX-ACCESS read-only 1709 STATUS current 1710 DESCRIPTION 1711 "The number of good packets transmitted by this 1712 address that were directed to the broadcast address 1713 since this host was added to the hostTable." 1714 ::= { hostEntry 9 } 1715 1716hostOutMulticastPkts OBJECT-TYPE 1717 SYNTAX Counter32 1718 UNITS "Packets" 1719 MAX-ACCESS read-only 1720 STATUS current 1721 DESCRIPTION 1722 "The number of good packets transmitted by this 1723 address that were directed to a multicast address 1724 since this host was added to the hostTable. 1725 Note that this number does not include packets 1726 directed to the broadcast address." 1727 ::= { hostEntry 10 } 1728 1729-- host Time Table 1730 1731hostTimeTable OBJECT-TYPE 1732 SYNTAX SEQUENCE OF HostTimeEntry 1733 MAX-ACCESS not-accessible 1734 STATUS current 1735 DESCRIPTION 1736 "A list of time-ordered host table entries." 1737 ::= { hosts 3 } 1738 1739hostTimeEntry OBJECT-TYPE 1740 SYNTAX HostTimeEntry 1741 MAX-ACCESS not-accessible 1742 STATUS current 1743 DESCRIPTION 1744 "A collection of statistics for a particular host that has 1745 been discovered on an interface of this device. This 1746 collection includes the relative ordering of the creation 1747 time of this object. For example, an instance of the 1748 hostTimeOutBroadcastPkts object might be named 1749 hostTimeOutBroadcastPkts.1.687" 1750 INDEX { hostTimeIndex, hostTimeCreationOrder } 1751 ::= { hostTimeTable 1 } 1752 1753HostTimeEntry ::= SEQUENCE { 1754 hostTimeAddress OCTET STRING, 1755 hostTimeCreationOrder Integer32, 1756 hostTimeIndex Integer32, 1757 hostTimeInPkts Counter32, 1758 hostTimeOutPkts Counter32, 1759 hostTimeInOctets Counter32, 1760 hostTimeOutOctets Counter32, 1761 hostTimeOutErrors Counter32, 1762 hostTimeOutBroadcastPkts Counter32, 1763 hostTimeOutMulticastPkts Counter32 1764} 1765 1766hostTimeAddress OBJECT-TYPE 1767 SYNTAX OCTET STRING 1768 MAX-ACCESS read-only 1769 STATUS current 1770 DESCRIPTION 1771 "The physical address of this host." 1772 ::= { hostTimeEntry 1 } 1773 1774hostTimeCreationOrder OBJECT-TYPE 1775 SYNTAX Integer32 (1..65535) 1776 MAX-ACCESS read-only 1777 STATUS current 1778 DESCRIPTION 1779 "An index that uniquely identifies an entry in 1780 the hostTime table among those entries associated 1781 with the same hostControlEntry. This index shall 1782 be between 1 and N, where N is the value of 1783 the associated hostControlTableSize. The ordering 1784 of the indexes is based on the order of each entry's 1785 insertion into the table, in which entries added earlier 1786 have a lower index value than entries added later. 1787 Thus the management station has the ability to 1788 learn of new entries added to this table without 1789 downloading the entire table. 1790 1791 It is important to note that the index for a 1792 particular entry may change as an (earlier) entry 1793 is deleted from the table. Because this order may 1794 change, management stations should make use of the 1795 hostControlLastDeleteTime variable in the 1796 hostControlEntry associated with the relevant 1797 portion of the hostTimeTable. By observing 1798 this variable, the management station may detect 1799 the circumstances where a download of the table 1800 may have missed entries, and where a previous 1801 association between a value of hostTimeCreationOrder 1802 and a hostTimeEntry may no longer hold." 1803 ::= { hostTimeEntry 2 } 1804 1805hostTimeIndex OBJECT-TYPE 1806 SYNTAX Integer32 (1..65535) 1807 MAX-ACCESS read-only 1808 STATUS current 1809 DESCRIPTION 1810 "The set of collected host statistics of which 1811 this entry is a part. The set of hosts 1812 identified by a particular value of this 1813 index is associated with the hostControlEntry 1814 as identified by the same value of hostControlIndex." 1815 ::= { hostTimeEntry 3 } 1816 1817hostTimeInPkts OBJECT-TYPE 1818 SYNTAX Counter32 1819 UNITS "Packets" 1820 MAX-ACCESS read-only 1821 STATUS current 1822 DESCRIPTION 1823 "The number of good packets transmitted to this 1824 address since it was added to the hostTimeTable." 1825 ::= { hostTimeEntry 4 } 1826 1827hostTimeOutPkts OBJECT-TYPE 1828 SYNTAX Counter32 1829 UNITS "Packets" 1830 MAX-ACCESS read-only 1831 STATUS current 1832 DESCRIPTION 1833 "The number of packets, including bad packets, transmitted 1834 by this address since it was added to the hostTimeTable." 1835 ::= { hostTimeEntry 5 } 1836 1837hostTimeInOctets OBJECT-TYPE 1838 SYNTAX Counter32 1839 UNITS "Octets" 1840 MAX-ACCESS read-only 1841 STATUS current 1842 DESCRIPTION 1843 "The number of octets transmitted to this address since 1844 it was added to the hostTimeTable (excluding framing 1845 bits but including FCS octets), except for those 1846 octets in bad packets." 1847 ::= { hostTimeEntry 6 } 1848 1849hostTimeOutOctets OBJECT-TYPE 1850 SYNTAX Counter32 1851 UNITS "Octets" 1852 MAX-ACCESS read-only 1853 STATUS current 1854 DESCRIPTION 1855 "The number of octets transmitted by this address since 1856 it was added to the hostTimeTable (excluding framing 1857 bits but including FCS octets), including those 1858 octets in bad packets." 1859 ::= { hostTimeEntry 7 } 1860 1861hostTimeOutErrors OBJECT-TYPE 1862 SYNTAX Counter32 1863 UNITS "Packets" 1864 MAX-ACCESS read-only 1865 STATUS current 1866 DESCRIPTION 1867 "The number of bad packets transmitted by this address 1868 since this host was added to the hostTimeTable." 1869 ::= { hostTimeEntry 8 } 1870 1871hostTimeOutBroadcastPkts OBJECT-TYPE 1872 SYNTAX Counter32 1873 UNITS "Packets" 1874 MAX-ACCESS read-only 1875 STATUS current 1876 DESCRIPTION 1877 "The number of good packets transmitted by this 1878 address that were directed to the broadcast address 1879 since this host was added to the hostTimeTable." 1880 ::= { hostTimeEntry 9 } 1881 1882hostTimeOutMulticastPkts OBJECT-TYPE 1883 SYNTAX Counter32 1884 UNITS "Packets" 1885 MAX-ACCESS read-only 1886 STATUS current 1887 DESCRIPTION 1888 "The number of good packets transmitted by this 1889 address that were directed to a multicast address 1890 since this host was added to the hostTimeTable. 1891 Note that this number does not include packets directed 1892 to the broadcast address." 1893 ::= { hostTimeEntry 10 } 1894 1895-- The Host Top "N" Group 1896 1897-- Implementation of the Host Top N group is optional. The Host Top N 1898-- group requires the implementation of the host group. 1899-- Consult the MODULE-COMPLIANCE macro for the authoritative 1900-- conformance information for this MIB. 1901-- 1902-- The Host Top N group is used to prepare reports that describe 1903-- the hosts that top a list ordered by one of their statistics. 1904-- The available statistics are samples of one of their 1905-- base statistics, over an interval specified by the management 1906-- station. Thus, these statistics are rate based. The management 1907-- station also selects how many such hosts are reported. 1908 1909-- The hostTopNControlTable is used to initiate the generation of 1910-- such a report. The management station may select the parameters 1911-- of such a report, such as which interface, which statistic, 1912-- how many hosts, and the start and stop times of the sampling. 1913-- When the report is prepared, entries are created in the 1914-- hostTopNTable associated with the relevant hostTopNControlEntry. 1915-- These entries are static for each report after it has been 1916-- prepared. 1917 1918hostTopNControlTable OBJECT-TYPE 1919 SYNTAX SEQUENCE OF HostTopNControlEntry 1920 MAX-ACCESS not-accessible 1921 STATUS current 1922 DESCRIPTION 1923 "A list of top N host control entries." 1924 ::= { hostTopN 1 } 1925 1926hostTopNControlEntry OBJECT-TYPE 1927 SYNTAX HostTopNControlEntry 1928 MAX-ACCESS not-accessible 1929 STATUS current 1930 DESCRIPTION 1931 "A set of parameters that control the creation of a report 1932 of the top N hosts according to several metrics. For 1933 example, an instance of the hostTopNDuration object might 1934 be named hostTopNDuration.3" 1935 INDEX { hostTopNControlIndex } 1936 ::= { hostTopNControlTable 1 } 1937 1938HostTopNControlEntry ::= SEQUENCE { 1939 hostTopNControlIndex Integer32, 1940 hostTopNHostIndex Integer32, 1941 hostTopNRateBase INTEGER, 1942 hostTopNTimeRemaining Integer32, 1943 hostTopNDuration Integer32, 1944 hostTopNRequestedSize Integer32, 1945 hostTopNGrantedSize Integer32, 1946 hostTopNStartTime TimeTicks, 1947 hostTopNOwner OwnerString, 1948 hostTopNStatus EntryStatus 1949} 1950 1951hostTopNControlIndex OBJECT-TYPE 1952 SYNTAX Integer32 (1..65535) 1953 MAX-ACCESS read-only 1954 STATUS current 1955 DESCRIPTION 1956 "An index that uniquely identifies an entry 1957 in the hostTopNControl table. Each such 1958 entry defines one top N report prepared for 1959 one interface." 1960 ::= { hostTopNControlEntry 1 } 1961 1962hostTopNHostIndex OBJECT-TYPE 1963 SYNTAX Integer32 (1..65535) 1964 MAX-ACCESS read-create 1965 STATUS current 1966 DESCRIPTION 1967 "The host table for which a top N report will be prepared 1968 on behalf of this entry. The host table identified by a 1969 particular value of this index is associated with the same 1970 host table as identified by the same value of 1971 hostIndex. 1972 1973 This object may not be modified if the associated 1974 hostTopNStatus object is equal to valid(1)." 1975 ::= { hostTopNControlEntry 2 } 1976 1977hostTopNRateBase OBJECT-TYPE 1978 SYNTAX INTEGER { 1979 hostTopNInPkts(1), 1980 hostTopNOutPkts(2), 1981 hostTopNInOctets(3), 1982 hostTopNOutOctets(4), 1983 hostTopNOutErrors(5), 1984 hostTopNOutBroadcastPkts(6), 1985 hostTopNOutMulticastPkts(7) 1986 } 1987 MAX-ACCESS read-create 1988 STATUS current 1989 DESCRIPTION 1990 "The variable for each host that the hostTopNRate 1991 variable is based upon. 1992 1993 This object may not be modified if the associated 1994 hostTopNStatus object is equal to valid(1)." 1995 ::= { hostTopNControlEntry 3 } 1996 1997hostTopNTimeRemaining OBJECT-TYPE 1998 SYNTAX Integer32 1999 UNITS "Seconds" 2000 MAX-ACCESS read-create 2001 STATUS current 2002 DESCRIPTION 2003 "The number of seconds left in the report currently being 2004 collected. When this object is modified by the management 2005 station, a new collection is started, possibly aborting 2006 a currently running report. The new value is used 2007 as the requested duration of this report, which is 2008 loaded into the associated hostTopNDuration object. 2009 2010 When this object is set to a non-zero value, any 2011 associated hostTopNEntries shall be made 2012 inaccessible by the monitor. While the value of this 2013 object is non-zero, it decrements by one per second until 2014 it reaches zero. During this time, all associated 2015 hostTopNEntries shall remain inaccessible. At the time 2016 that this object decrements to zero, the report is made 2017 accessible in the hostTopNTable. Thus, the hostTopN 2018 table needs to be created only at the end of the collection 2019 interval." 2020 DEFVAL { 0 } 2021 ::= { hostTopNControlEntry 4 } 2022 2023hostTopNDuration OBJECT-TYPE 2024 SYNTAX Integer32 2025 UNITS "Seconds" 2026 MAX-ACCESS read-only 2027 STATUS current 2028 DESCRIPTION 2029 "The number of seconds that this report has collected 2030 during the last sampling interval, or if this 2031 report is currently being collected, the number 2032 of seconds that this report is being collected 2033 during this sampling interval. 2034 2035 When the associated hostTopNTimeRemaining object is set, 2036 this object shall be set by the probe to the same value 2037 and shall not be modified until the next time 2038 the hostTopNTimeRemaining is set. 2039 2040 This value shall be zero if no reports have been 2041 requested for this hostTopNControlEntry." 2042 DEFVAL { 0 } 2043 ::= { hostTopNControlEntry 5 } 2044 2045hostTopNRequestedSize OBJECT-TYPE 2046 SYNTAX Integer32 2047 MAX-ACCESS read-create 2048 STATUS current 2049 DESCRIPTION 2050 "The maximum number of hosts requested for the top N 2051 table. 2052 2053 When this object is created or modified, the probe 2054 should set hostTopNGrantedSize as closely to this 2055 object as is possible for the particular probe 2056 implementation and available resources." 2057 DEFVAL { 10 } 2058 ::= { hostTopNControlEntry 6 } 2059 2060hostTopNGrantedSize OBJECT-TYPE 2061 SYNTAX Integer32 2062 MAX-ACCESS read-only 2063 STATUS current 2064 DESCRIPTION 2065 "The maximum number of hosts in the top N table. 2066 2067 When the associated hostTopNRequestedSize object is 2068 created or modified, the probe should set this 2069 object as closely to the requested value as is possible 2070 for the particular implementation and available 2071 resources. The probe must not lower this value except 2072 as a result of a set to the associated 2073 hostTopNRequestedSize object. 2074 2075 Hosts with the highest value of hostTopNRate shall be 2076 placed in this table in decreasing order of this rate 2077 until there is no more room or until there are no more 2078 hosts." 2079 ::= { hostTopNControlEntry 7 } 2080 2081hostTopNStartTime OBJECT-TYPE 2082 SYNTAX TimeTicks 2083 MAX-ACCESS read-only 2084 STATUS current 2085 DESCRIPTION 2086 "The value of sysUpTime when this top N report was 2087 last started. In other words, this is the time that 2088 the associated hostTopNTimeRemaining object was 2089 modified to start the requested report." 2090 ::= { hostTopNControlEntry 8 } 2091 2092hostTopNOwner OBJECT-TYPE 2093 SYNTAX OwnerString 2094 MAX-ACCESS read-create 2095 STATUS current 2096 DESCRIPTION 2097 "The entity that configured this entry and is therefore 2098 using the resources assigned to it." 2099 ::= { hostTopNControlEntry 9 } 2100 2101hostTopNStatus OBJECT-TYPE 2102 SYNTAX EntryStatus 2103 MAX-ACCESS read-create 2104 STATUS current 2105 DESCRIPTION 2106 "The status of this hostTopNControl entry. 2107 2108 If this object is not equal to valid(1), all associated 2109 hostTopNEntries shall be deleted by the agent." 2110 ::= { hostTopNControlEntry 10 } 2111 2112hostTopNTable OBJECT-TYPE 2113 SYNTAX SEQUENCE OF HostTopNEntry 2114 MAX-ACCESS not-accessible 2115 STATUS current 2116 DESCRIPTION 2117 "A list of top N host entries." 2118 ::= { hostTopN 2 } 2119 2120hostTopNEntry OBJECT-TYPE 2121 SYNTAX HostTopNEntry 2122 MAX-ACCESS not-accessible 2123 STATUS current 2124 DESCRIPTION 2125 "A set of statistics for a host that is part of a top N 2126 report. For example, an instance of the hostTopNRate 2127 object might be named hostTopNRate.3.10" 2128 INDEX { hostTopNReport, hostTopNIndex } 2129 ::= { hostTopNTable 1 } 2130 2131HostTopNEntry ::= SEQUENCE { 2132 hostTopNReport Integer32, 2133 hostTopNIndex Integer32, 2134 hostTopNAddress OCTET STRING, 2135 hostTopNRate Integer32 2136} 2137 2138hostTopNReport OBJECT-TYPE 2139 SYNTAX Integer32 (1..65535) 2140 MAX-ACCESS read-only 2141 STATUS current 2142 DESCRIPTION 2143 "This object identifies the top N report of which 2144 this entry is a part. The set of hosts 2145 identified by a particular value of this 2146 object is part of the same report as identified 2147 by the same value of the hostTopNControlIndex object." 2148 ::= { hostTopNEntry 1 } 2149 2150hostTopNIndex OBJECT-TYPE 2151 SYNTAX Integer32 (1..65535) 2152 MAX-ACCESS read-only 2153 STATUS current 2154 DESCRIPTION 2155 "An index that uniquely identifies an entry in 2156 the hostTopN table among those in the same report. 2157 This index is between 1 and N, where N is the 2158 number of entries in this table. Increasing values 2159 of hostTopNIndex shall be assigned to entries with 2160 decreasing values of hostTopNRate until index N 2161 is assigned to the entry with the lowest value of 2162 hostTopNRate or there are no more hostTopNEntries." 2163 ::= { hostTopNEntry 2 } 2164 2165hostTopNAddress OBJECT-TYPE 2166 SYNTAX OCTET STRING 2167 MAX-ACCESS read-only 2168 STATUS current 2169 DESCRIPTION 2170 "The physical address of this host." 2171 ::= { hostTopNEntry 3 } 2172 2173hostTopNRate OBJECT-TYPE 2174 SYNTAX Integer32 2175 MAX-ACCESS read-only 2176 STATUS current 2177 DESCRIPTION 2178 "The amount of change in the selected variable 2179 during this sampling interval. The selected 2180 variable is this host's instance of the object 2181 selected by hostTopNRateBase." 2182 ::= { hostTopNEntry 4 } 2183 2184-- The Matrix Group 2185 2186-- Implementation of the Matrix group is optional. 2187-- Consult the MODULE-COMPLIANCE macro for the authoritative 2188-- conformance information for this MIB. 2189-- 2190-- The Matrix group consists of the matrixControlTable, matrixSDTable 2191-- and the matrixDSTable. These tables store statistics for a 2192-- particular conversation between two addresses. As the device 2193-- detects a new conversation, including those to a non-unicast 2194-- address, it creates a new entry in both of the matrix tables. 2195-- It must only create new entries based on information 2196-- received in good packets. If the monitoring device finds 2197-- itself short of resources, it may delete entries as needed. 2198-- It is suggested that the device delete the least recently used 2199-- entries first. 2200 2201matrixControlTable OBJECT-TYPE 2202 SYNTAX SEQUENCE OF MatrixControlEntry 2203 MAX-ACCESS not-accessible 2204 STATUS current 2205 DESCRIPTION 2206 "A list of information entries for the 2207 traffic matrix on each interface." 2208 ::= { matrix 1 } 2209 2210matrixControlEntry OBJECT-TYPE 2211 SYNTAX MatrixControlEntry 2212 MAX-ACCESS not-accessible 2213 STATUS current 2214 DESCRIPTION 2215 "Information about a traffic matrix on a particular 2216 interface. For example, an instance of the 2217 matrixControlLastDeleteTime object might be named 2218 matrixControlLastDeleteTime.1" 2219 INDEX { matrixControlIndex } 2220 ::= { matrixControlTable 1 } 2221 2222MatrixControlEntry ::= SEQUENCE { 2223 matrixControlIndex Integer32, 2224 matrixControlDataSource OBJECT IDENTIFIER, 2225 matrixControlTableSize Integer32, 2226 matrixControlLastDeleteTime TimeTicks, 2227 matrixControlOwner OwnerString, 2228 matrixControlStatus EntryStatus 2229} 2230 2231matrixControlIndex OBJECT-TYPE 2232 SYNTAX Integer32 (1..65535) 2233 MAX-ACCESS read-only 2234 STATUS current 2235 DESCRIPTION 2236 "An index that uniquely identifies an entry in the 2237 matrixControl table. Each such entry defines 2238 a function that discovers conversations on a particular 2239 interface and places statistics about them in the 2240 matrixSDTable and the matrixDSTable on behalf of this 2241 matrixControlEntry." 2242 ::= { matrixControlEntry 1 } 2243 2244matrixControlDataSource OBJECT-TYPE 2245 SYNTAX OBJECT IDENTIFIER 2246 MAX-ACCESS read-create 2247 STATUS current 2248 DESCRIPTION 2249 "This object identifies the source of 2250 the data from which this entry creates a traffic matrix. 2251 This source can be any interface on this device. In 2252 order to identify a particular interface, this object 2253 shall identify the instance of the ifIndex object, 2254 defined in RFC 2233 [17], for the desired 2255 interface. For example, if an entry were to receive data 2256 from interface #1, this object would be set to ifIndex.1. 2257 2258 The statistics in this group reflect all packets 2259 on the local network segment attached to the identified 2260 interface. 2261 2262 An agent may or may not be able to tell if fundamental 2263 changes to the media of the interface have occurred and 2264 necessitate an invalidation of this entry. For example, a 2265 hot-pluggable ethernet card could be pulled out and replaced 2266 by a token-ring card. In such a case, if the agent has such 2267 knowledge of the change, it is recommended that it 2268 invalidate this entry. 2269 2270 This object may not be modified if the associated 2271 matrixControlStatus object is equal to valid(1)." 2272 ::= { matrixControlEntry 2 } 2273 2274matrixControlTableSize OBJECT-TYPE 2275 SYNTAX Integer32 2276 MAX-ACCESS read-only 2277 STATUS current 2278 DESCRIPTION 2279 "The number of matrixSDEntries in the matrixSDTable 2280 for this interface. This must also be the value of 2281 the number of entries in the matrixDSTable for this 2282 interface." 2283 ::= { matrixControlEntry 3 } 2284 2285matrixControlLastDeleteTime OBJECT-TYPE 2286 SYNTAX TimeTicks 2287 MAX-ACCESS read-only 2288 STATUS current 2289 DESCRIPTION 2290 "The value of sysUpTime when the last entry 2291 was deleted from the portion of the matrixSDTable 2292 or matrixDSTable associated with this matrixControlEntry. 2293 If no deletions have occurred, this value shall be 2294 zero." 2295 ::= { matrixControlEntry 4 } 2296 2297matrixControlOwner OBJECT-TYPE 2298 SYNTAX OwnerString 2299 MAX-ACCESS read-create 2300 STATUS current 2301 DESCRIPTION 2302 "The entity that configured this entry and is therefore 2303 using the resources assigned to it." 2304 ::= { matrixControlEntry 5 } 2305 2306matrixControlStatus OBJECT-TYPE 2307 SYNTAX EntryStatus 2308 MAX-ACCESS read-create 2309 STATUS current 2310 DESCRIPTION 2311 "The status of this matrixControl entry. 2312 If this object is not equal to valid(1), all associated 2313 entries in the matrixSDTable and the matrixDSTable 2314 shall be deleted by the agent." 2315 ::= { matrixControlEntry 6 } 2316 2317matrixSDTable OBJECT-TYPE 2318 SYNTAX SEQUENCE OF MatrixSDEntry 2319 MAX-ACCESS not-accessible 2320 STATUS current 2321 DESCRIPTION 2322 "A list of traffic matrix entries indexed by 2323 source and destination MAC address." 2324 ::= { matrix 2 } 2325 2326matrixSDEntry OBJECT-TYPE 2327 SYNTAX MatrixSDEntry 2328 MAX-ACCESS not-accessible 2329 STATUS current 2330 DESCRIPTION 2331 "A collection of statistics for communications between 2332 two addresses on a particular interface. For example, 2333 an instance of the matrixSDPkts object might be named 2334 matrixSDPkts.1.6.8.0.32.27.3.176.6.8.0.32.10.8.113" 2335 INDEX { matrixSDIndex, 2336 matrixSDSourceAddress, matrixSDDestAddress } 2337 ::= { matrixSDTable 1 } 2338 2339MatrixSDEntry ::= SEQUENCE { 2340 matrixSDSourceAddress OCTET STRING, 2341 matrixSDDestAddress OCTET STRING, 2342 matrixSDIndex Integer32, 2343 matrixSDPkts Counter32, 2344 matrixSDOctets Counter32, 2345 matrixSDErrors Counter32 2346} 2347 2348matrixSDSourceAddress OBJECT-TYPE 2349 SYNTAX OCTET STRING 2350 MAX-ACCESS read-only 2351 STATUS current 2352 DESCRIPTION 2353 "The source physical address." 2354 ::= { matrixSDEntry 1 } 2355 2356matrixSDDestAddress OBJECT-TYPE 2357 SYNTAX OCTET STRING 2358 MAX-ACCESS read-only 2359 STATUS current 2360 DESCRIPTION 2361 "The destination physical address." 2362 ::= { matrixSDEntry 2 } 2363 2364matrixSDIndex OBJECT-TYPE 2365 SYNTAX Integer32 (1..65535) 2366 MAX-ACCESS read-only 2367 STATUS current 2368 DESCRIPTION 2369 "The set of collected matrix statistics of which 2370 this entry is a part. The set of matrix statistics 2371 identified by a particular value of this index 2372 is associated with the same matrixControlEntry 2373 as identified by the same value of matrixControlIndex." 2374 ::= { matrixSDEntry 3 } 2375 2376matrixSDPkts OBJECT-TYPE 2377 SYNTAX Counter32 2378 UNITS "Packets" 2379 MAX-ACCESS read-only 2380 STATUS current 2381 DESCRIPTION 2382 "The number of packets transmitted from the source 2383 address to the destination address (this number includes 2384 bad packets)." 2385 ::= { matrixSDEntry 4 } 2386 2387matrixSDOctets OBJECT-TYPE 2388 SYNTAX Counter32 2389 UNITS "Octets" 2390 MAX-ACCESS read-only 2391 STATUS current 2392 DESCRIPTION 2393 "The number of octets (excluding framing bits but 2394 including FCS octets) contained in all packets 2395 transmitted from the source address to the 2396 destination address." 2397 ::= { matrixSDEntry 5 } 2398 2399matrixSDErrors OBJECT-TYPE 2400 SYNTAX Counter32 2401 UNITS "Packets" 2402 MAX-ACCESS read-only 2403 STATUS current 2404 DESCRIPTION 2405 "The number of bad packets transmitted from 2406 the source address to the destination address." 2407 ::= { matrixSDEntry 6 } 2408 2409-- Traffic matrix tables from destination to source 2410 2411matrixDSTable OBJECT-TYPE 2412 SYNTAX SEQUENCE OF MatrixDSEntry 2413 MAX-ACCESS not-accessible 2414 STATUS current 2415 DESCRIPTION 2416 "A list of traffic matrix entries indexed by 2417 destination and source MAC address." 2418 ::= { matrix 3 } 2419 2420matrixDSEntry OBJECT-TYPE 2421 SYNTAX MatrixDSEntry 2422 MAX-ACCESS not-accessible 2423 STATUS current 2424 DESCRIPTION 2425 "A collection of statistics for communications between 2426 two addresses on a particular interface. For example, 2427 an instance of the matrixSDPkts object might be named 2428 matrixSDPkts.1.6.8.0.32.10.8.113.6.8.0.32.27.3.176" 2429 INDEX { matrixDSIndex, 2430 matrixDSDestAddress, matrixDSSourceAddress } 2431 ::= { matrixDSTable 1 } 2432 2433MatrixDSEntry ::= SEQUENCE { 2434 matrixDSSourceAddress OCTET STRING, 2435 matrixDSDestAddress OCTET STRING, 2436 matrixDSIndex Integer32, 2437 matrixDSPkts Counter32, 2438 matrixDSOctets Counter32, 2439 matrixDSErrors Counter32 2440} 2441 2442matrixDSSourceAddress OBJECT-TYPE 2443 SYNTAX OCTET STRING 2444 MAX-ACCESS read-only 2445 STATUS current 2446 DESCRIPTION 2447 "The source physical address." 2448 ::= { matrixDSEntry 1 } 2449 2450matrixDSDestAddress OBJECT-TYPE 2451 SYNTAX OCTET STRING 2452 MAX-ACCESS read-only 2453 STATUS current 2454 DESCRIPTION 2455 "The destination physical address." 2456 ::= { matrixDSEntry 2 } 2457 2458matrixDSIndex OBJECT-TYPE 2459 SYNTAX Integer32 (1..65535) 2460 MAX-ACCESS read-only 2461 STATUS current 2462 DESCRIPTION 2463 "The set of collected matrix statistics of which 2464 this entry is a part. The set of matrix statistics 2465 identified by a particular value of this index 2466 is associated with the same matrixControlEntry 2467 as identified by the same value of matrixControlIndex." 2468 ::= { matrixDSEntry 3 } 2469 2470matrixDSPkts OBJECT-TYPE 2471 SYNTAX Counter32 2472 UNITS "Packets" 2473 MAX-ACCESS read-only 2474 STATUS current 2475 DESCRIPTION 2476 "The number of packets transmitted from the source 2477 address to the destination address (this number includes 2478 bad packets)." 2479 ::= { matrixDSEntry 4 } 2480 2481matrixDSOctets OBJECT-TYPE 2482 SYNTAX Counter32 2483 UNITS "Octets" 2484 MAX-ACCESS read-only 2485 STATUS current 2486 DESCRIPTION 2487 "The number of octets (excluding framing bits 2488 but including FCS octets) contained in all packets 2489 transmitted from the source address to the 2490 destination address." 2491 ::= { matrixDSEntry 5 } 2492 2493matrixDSErrors OBJECT-TYPE 2494 SYNTAX Counter32 2495 UNITS "Packets" 2496 MAX-ACCESS read-only 2497 STATUS current 2498 DESCRIPTION 2499 "The number of bad packets transmitted from 2500 the source address to the destination address." 2501 ::= { matrixDSEntry 6 } 2502 2503-- The Filter Group 2504 2505-- Implementation of the Filter group is optional. 2506-- Consult the MODULE-COMPLIANCE macro for the authoritative 2507-- conformance information for this MIB. 2508-- 2509-- The Filter group allows packets to be captured with an 2510-- arbitrary filter expression. A logical data and 2511-- event stream or "channel" is formed by the packets 2512-- that match the filter expression. 2513-- 2514-- This filter mechanism allows the creation of an arbitrary 2515-- logical expression with which to filter packets. Each 2516-- filter associated with a channel is OR'ed with the others. 2517-- Within a filter, any bits checked in the data and status are 2518-- AND'ed with respect to other bits in the same filter. The 2519-- NotMask also allows for checking for inequality. Finally, 2520-- the channelAcceptType object allows for inversion of the 2521-- whole equation. 2522-- 2523-- If a management station wishes to receive a trap to alert it 2524-- that new packets have been captured and are available for 2525-- download, it is recommended that it set up an alarm entry that 2526-- monitors the value of the relevant channelMatches instance. 2527-- 2528-- The channel can be turned on or off, and can also 2529-- generate events when packets pass through it. 2530 2531filterTable OBJECT-TYPE 2532 SYNTAX SEQUENCE OF FilterEntry 2533 MAX-ACCESS not-accessible 2534 STATUS current 2535 DESCRIPTION 2536 "A list of packet filter entries." 2537 ::= { filter 1 } 2538 2539filterEntry OBJECT-TYPE 2540 SYNTAX FilterEntry 2541 MAX-ACCESS not-accessible 2542 STATUS current 2543 DESCRIPTION 2544 "A set of parameters for a packet filter applied on a 2545 particular interface. As an example, an instance of the 2546 filterPktData object might be named filterPktData.12" 2547 INDEX { filterIndex } 2548 ::= { filterTable 1 } 2549 2550FilterEntry ::= SEQUENCE { 2551 filterIndex Integer32, 2552 filterChannelIndex Integer32, 2553 filterPktDataOffset Integer32, 2554 filterPktData OCTET STRING, 2555 filterPktDataMask OCTET STRING, 2556 filterPktDataNotMask OCTET STRING, 2557 filterPktStatus Integer32, 2558 filterPktStatusMask Integer32, 2559 filterPktStatusNotMask Integer32, 2560 filterOwner OwnerString, 2561 filterStatus EntryStatus 2562} 2563 2564filterIndex OBJECT-TYPE 2565 SYNTAX Integer32 (1..65535) 2566 MAX-ACCESS read-only 2567 STATUS current 2568 DESCRIPTION 2569 "An index that uniquely identifies an entry 2570 in the filter table. Each such entry defines 2571 one filter that is to be applied to every packet 2572 received on an interface." 2573 ::= { filterEntry 1 } 2574 2575filterChannelIndex OBJECT-TYPE 2576 SYNTAX Integer32 (1..65535) 2577 MAX-ACCESS read-create 2578 STATUS current 2579 DESCRIPTION 2580 "This object identifies the channel of which this filter 2581 is a part. The filters identified by a particular value 2582 of this object are associated with the same channel as 2583 identified by the same value of the channelIndex object." 2584 ::= { filterEntry 2 } 2585 2586filterPktDataOffset OBJECT-TYPE 2587 SYNTAX Integer32 2588 UNITS "Octets" 2589 MAX-ACCESS read-create 2590 STATUS current 2591 DESCRIPTION 2592 "The offset from the beginning of each packet where 2593 a match of packet data will be attempted. This offset 2594 is measured from the point in the physical layer 2595 packet after the framing bits, if any. For example, 2596 in an Ethernet frame, this point is at the beginning of 2597 the destination MAC address. 2598 2599 This object may not be modified if the associated 2600 filterStatus object is equal to valid(1)." 2601 DEFVAL { 0 } 2602 2603 ::= { filterEntry 3 } 2604 2605filterPktData OBJECT-TYPE 2606 SYNTAX OCTET STRING 2607 MAX-ACCESS read-create 2608 STATUS current 2609 DESCRIPTION 2610 "The data that is to be matched with the input packet. 2611 For each packet received, this filter and the accompanying 2612 filterPktDataMask and filterPktDataNotMask will be 2613 adjusted for the offset. The only bits relevant to this 2614 match algorithm are those that have the corresponding 2615 filterPktDataMask bit equal to one. The following three 2616 rules are then applied to every packet: 2617 2618 (1) If the packet is too short and does not have data 2619 corresponding to part of the filterPktData, the packet 2620 will fail this data match. 2621 2622 (2) For each relevant bit from the packet with the 2623 corresponding filterPktDataNotMask bit set to zero, if 2624 the bit from the packet is not equal to the corresponding 2625 bit from the filterPktData, then the packet will fail 2626 this data match. 2627 2628 (3) If for every relevant bit from the packet with the 2629 corresponding filterPktDataNotMask bit set to one, the 2630 bit from the packet is equal to the corresponding bit 2631 from the filterPktData, then the packet will fail this 2632 data match. 2633 2634 Any packets that have not failed any of the three matches 2635 above have passed this data match. In particular, a zero 2636 length filter will match any packet. 2637 2638 This object may not be modified if the associated 2639 filterStatus object is equal to valid(1)." 2640 ::= { filterEntry 4 } 2641 2642filterPktDataMask OBJECT-TYPE 2643 SYNTAX OCTET STRING 2644 MAX-ACCESS read-create 2645 STATUS current 2646 DESCRIPTION 2647 "The mask that is applied to the match process. 2648 After adjusting this mask for the offset, only those 2649 bits in the received packet that correspond to bits set 2650 in this mask are relevant for further processing by the 2651 match algorithm. The offset is applied to filterPktDataMask 2652 in the same way it is applied to the filter. For the 2653 purposes of the matching algorithm, if the associated 2654 filterPktData object is longer than this mask, this mask is 2655 conceptually extended with '1' bits until it reaches the 2656 length of the filterPktData object. 2657 2658 This object may not be modified if the associated 2659 filterStatus object is equal to valid(1)." 2660 ::= { filterEntry 5 } 2661 2662filterPktDataNotMask OBJECT-TYPE 2663 SYNTAX OCTET STRING 2664 MAX-ACCESS read-create 2665 STATUS current 2666 DESCRIPTION 2667 "The inversion mask that is applied to the match 2668 process. After adjusting this mask for the offset, 2669 those relevant bits in the received packet that correspond 2670 to bits cleared in this mask must all be equal to their 2671 corresponding bits in the filterPktData object for the packet 2672 to be accepted. In addition, at least one of those relevant 2673 bits in the received packet that correspond to bits set in 2674 this mask must be different to its corresponding bit in the 2675 filterPktData object. 2676 2677 For the purposes of the matching algorithm, if the associated 2678 filterPktData object is longer than this mask, this mask is 2679 conceptually extended with '0' bits until it reaches the 2680 length of the filterPktData object. 2681 2682 This object may not be modified if the associated 2683 filterStatus object is equal to valid(1)." 2684 ::= { filterEntry 6 } 2685 2686filterPktStatus OBJECT-TYPE 2687 SYNTAX Integer32 2688 MAX-ACCESS read-create 2689 STATUS current 2690 DESCRIPTION 2691 "The status that is to be matched with the input packet. 2692 The only bits relevant to this match algorithm are those that 2693 have the corresponding filterPktStatusMask bit equal to one. 2694 The following two rules are then applied to every packet: 2695 2696 (1) For each relevant bit from the packet status with the 2697 corresponding filterPktStatusNotMask bit set to zero, if 2698 the bit from the packet status is not equal to the 2699 corresponding bit from the filterPktStatus, then the 2700 packet will fail this status match. 2701 2702 (2) If for every relevant bit from the packet status with the 2703 corresponding filterPktStatusNotMask bit set to one, the 2704 bit from the packet status is equal to the corresponding 2705 bit from the filterPktStatus, then the packet will fail 2706 this status match. 2707 2708 Any packets that have not failed either of the two matches 2709 above have passed this status match. In particular, a zero 2710 length status filter will match any packet's status. 2711 2712 The value of the packet status is a sum. This sum 2713 initially takes the value zero. Then, for each 2714 error, E, that has been discovered in this packet, 2715 2 raised to a value representing E is added to the sum. 2716 The errors and the bits that represent them are dependent 2717 on the media type of the interface that this channel 2718 is receiving packets from. 2719 2720 The errors defined for a packet captured off of an 2721 Ethernet interface are as follows: 2722 2723 bit # Error 2724 0 Packet is longer than 1518 octets 2725 1 Packet is shorter than 64 octets 2726 2 Packet experienced a CRC or Alignment error 2727 2728 For example, an Ethernet fragment would have a 2729 value of 6 (2^1 + 2^2). 2730 2731 As this MIB is expanded to new media types, this object 2732 will have other media-specific errors defined. 2733 2734 For the purposes of this status matching algorithm, if the 2735 packet status is longer than this filterPktStatus object, 2736 this object is conceptually extended with '0' bits until it 2737 reaches the size of the packet status. 2738 2739 This object may not be modified if the associated 2740 filterStatus object is equal to valid(1)." 2741 ::= { filterEntry 7 } 2742 2743filterPktStatusMask OBJECT-TYPE 2744 SYNTAX Integer32 2745 MAX-ACCESS read-create 2746 STATUS current 2747 DESCRIPTION 2748 "The mask that is applied to the status match process. 2749 Only those bits in the received packet that correspond to 2750 bits set in this mask are relevant for further processing 2751 by the status match algorithm. For the purposes 2752 of the matching algorithm, if the associated filterPktStatus 2753 object is longer than this mask, this mask is conceptually 2754 extended with '1' bits until it reaches the size of the 2755 filterPktStatus. In addition, if a packet status is longer 2756 than this mask, this mask is conceptually extended with '0' 2757 bits until it reaches the size of the packet status. 2758 2759 This object may not be modified if the associated 2760 filterStatus object is equal to valid(1)." 2761 ::= { filterEntry 8 } 2762 2763filterPktStatusNotMask OBJECT-TYPE 2764 SYNTAX Integer32 2765 MAX-ACCESS read-create 2766 STATUS current 2767 DESCRIPTION 2768 "The inversion mask that is applied to the status match 2769 process. Those relevant bits in the received packet status 2770 that correspond to bits cleared in this mask must all be 2771 equal to their corresponding bits in the filterPktStatus 2772 object for the packet to be accepted. In addition, at least 2773 one of those relevant bits in the received packet status 2774 that correspond to bits set in this mask must be different 2775 to its corresponding bit in the filterPktStatus object for 2776 the packet to be accepted. 2777 2778 For the purposes of the matching algorithm, if the associated 2779 filterPktStatus object or a packet status is longer than this 2780 mask, this mask is conceptually extended with '0' bits until 2781 it reaches the longer of the lengths of the filterPktStatus 2782 object and the packet status. 2783 2784 This object may not be modified if the associated 2785 filterStatus object is equal to valid(1)." 2786 ::= { filterEntry 9 } 2787 2788filterOwner OBJECT-TYPE 2789 SYNTAX OwnerString 2790 MAX-ACCESS read-create 2791 STATUS current 2792 DESCRIPTION 2793 "The entity that configured this entry and is therefore 2794 using the resources assigned to it." 2795 ::= { filterEntry 10 } 2796 2797filterStatus OBJECT-TYPE 2798 SYNTAX EntryStatus 2799 MAX-ACCESS read-create 2800 STATUS current 2801 DESCRIPTION 2802 "The status of this filter entry." 2803 ::= { filterEntry 11 } 2804 2805channelTable OBJECT-TYPE 2806 SYNTAX SEQUENCE OF ChannelEntry 2807 MAX-ACCESS not-accessible 2808 STATUS current 2809 DESCRIPTION 2810 "A list of packet channel entries." 2811 ::= { filter 2 } 2812 2813channelEntry OBJECT-TYPE 2814 SYNTAX ChannelEntry 2815 MAX-ACCESS not-accessible 2816 STATUS current 2817 DESCRIPTION 2818 "A set of parameters for a packet channel applied on a 2819 particular interface. As an example, an instance of the 2820 channelMatches object might be named channelMatches.3" 2821 INDEX { channelIndex } 2822 ::= { channelTable 1 } 2823 2824ChannelEntry ::= SEQUENCE { 2825 channelIndex Integer32, 2826 channelIfIndex Integer32, 2827 channelAcceptType INTEGER, 2828 channelDataControl INTEGER, 2829 channelTurnOnEventIndex Integer32, 2830 channelTurnOffEventIndex Integer32, 2831 channelEventIndex Integer32, 2832 channelEventStatus INTEGER, 2833 channelMatches Counter32, 2834 channelDescription DisplayString, 2835 channelOwner OwnerString, 2836 channelStatus EntryStatus 2837} 2838 2839channelIndex OBJECT-TYPE 2840 SYNTAX Integer32 (1..65535) 2841 MAX-ACCESS read-only 2842 STATUS current 2843 DESCRIPTION 2844 "An index that uniquely identifies an entry in the channel 2845 table. Each such entry defines one channel, a logical 2846 data and event stream. 2847 2848 It is suggested that before creating a channel, an 2849 application should scan all instances of the 2850 filterChannelIndex object to make sure that there are no 2851 pre-existing filters that would be inadvertently be linked 2852 to the channel." 2853 ::= { channelEntry 1 } 2854 2855channelIfIndex OBJECT-TYPE 2856 SYNTAX Integer32 (1..65535) 2857 MAX-ACCESS read-create 2858 STATUS current 2859 DESCRIPTION 2860 "The value of this object uniquely identifies the 2861 interface on this remote network monitoring device to which 2862 the associated filters are applied to allow data into this 2863 channel. The interface identified by a particular value 2864 of this object is the same interface as identified by the 2865 same value of the ifIndex object, defined in RFC 2233 [17]. 2866 2867 The filters in this group are applied to all packets on 2868 the local network segment attached to the identified 2869 interface. 2870 2871 An agent may or may not be able to tell if fundamental 2872 changes to the media of the interface have occurred and 2873 necessitate an invalidation of this entry. For example, a 2874 hot-pluggable ethernet card could be pulled out and replaced 2875 by a token-ring card. In such a case, if the agent has such 2876 knowledge of the change, it is recommended that it 2877 invalidate this entry. 2878 2879 This object may not be modified if the associated 2880 channelStatus object is equal to valid(1)." 2881 ::= { channelEntry 2 } 2882 2883channelAcceptType OBJECT-TYPE 2884 SYNTAX INTEGER { 2885 acceptMatched(1), 2886 acceptFailed(2) 2887 } 2888 MAX-ACCESS read-create 2889 STATUS current 2890 DESCRIPTION 2891 "This object controls the action of the filters 2892 associated with this channel. If this object is equal 2893 to acceptMatched(1), packets will be accepted to this 2894 channel if they are accepted by both the packet data and 2895 packet status matches of an associated filter. If 2896 this object is equal to acceptFailed(2), packets will 2897 be accepted to this channel only if they fail either 2898 the packet data match or the packet status match of 2899 each of the associated filters. 2900 2901 In particular, a channel with no associated filters will 2902 match no packets if set to acceptMatched(1) case and will 2903 match all packets in the acceptFailed(2) case. 2904 2905 This object may not be modified if the associated 2906 channelStatus object is equal to valid(1)." 2907 ::= { channelEntry 3 } 2908 2909channelDataControl OBJECT-TYPE 2910 SYNTAX INTEGER { 2911 on(1), 2912 off(2) 2913 } 2914 MAX-ACCESS read-create 2915 STATUS current 2916 DESCRIPTION 2917 "This object controls the flow of data through this channel. 2918 If this object is on(1), data, status and events flow 2919 through this channel. If this object is off(2), data, 2920 status and events will not flow through this channel." 2921 DEFVAL { off } 2922 ::= { channelEntry 4 } 2923 2924channelTurnOnEventIndex OBJECT-TYPE 2925 SYNTAX Integer32 (0..65535) 2926 MAX-ACCESS read-create 2927 STATUS current 2928 DESCRIPTION 2929 "The value of this object identifies the event 2930 that is configured to turn the associated 2931 channelDataControl from off to on when the event is 2932 generated. The event identified by a particular value 2933 of this object is the same event as identified by the 2934 same value of the eventIndex object. If there is no 2935 corresponding entry in the eventTable, then no 2936 association exists. In fact, if no event is intended 2937 for this channel, channelTurnOnEventIndex must be 2938 set to zero, a non-existent event index. 2939 2940 This object may not be modified if the associated 2941 channelStatus object is equal to valid(1)." 2942 ::= { channelEntry 5 } 2943 2944channelTurnOffEventIndex OBJECT-TYPE 2945 SYNTAX Integer32 (0..65535) 2946 MAX-ACCESS read-create 2947 STATUS current 2948 DESCRIPTION 2949 "The value of this object identifies the event 2950 that is configured to turn the associated 2951 channelDataControl from on to off when the event is 2952 generated. The event identified by a particular value 2953 of this object is the same event as identified by the 2954 same value of the eventIndex object. If there is no 2955 corresponding entry in the eventTable, then no 2956 association exists. In fact, if no event is intended 2957 for this channel, channelTurnOffEventIndex must be 2958 set to zero, a non-existent event index. 2959 2960 This object may not be modified if the associated 2961 channelStatus object is equal to valid(1)." 2962 ::= { channelEntry 6 } 2963 2964channelEventIndex OBJECT-TYPE 2965 SYNTAX Integer32 (0..65535) 2966 MAX-ACCESS read-create 2967 STATUS current 2968 DESCRIPTION 2969 "The value of this object identifies the event 2970 that is configured to be generated when the 2971 associated channelDataControl is on and a packet 2972 is matched. The event identified by a particular value 2973 of this object is the same event as identified by the 2974 same value of the eventIndex object. If there is no 2975 corresponding entry in the eventTable, then no 2976 association exists. In fact, if no event is intended 2977 for this channel, channelEventIndex must be 2978 set to zero, a non-existent event index. 2979 2980 This object may not be modified if the associated 2981 channelStatus object is equal to valid(1)." 2982 ::= { channelEntry 7 } 2983 2984channelEventStatus OBJECT-TYPE 2985 SYNTAX INTEGER { 2986 eventReady(1), 2987 eventFired(2), 2988 eventAlwaysReady(3) 2989 } 2990 MAX-ACCESS read-create 2991 STATUS current 2992 DESCRIPTION 2993 "The event status of this channel. 2994 2995 If this channel is configured to generate events 2996 when packets are matched, a means of controlling 2997 the flow of those events is often needed. When 2998 this object is equal to eventReady(1), a single 2999 event may be generated, after which this object 3000 will be set by the probe to eventFired(2). While 3001 in the eventFired(2) state, no events will be 3002 generated until the object is modified to 3003 eventReady(1) (or eventAlwaysReady(3)). The 3004 management station can thus easily respond to a 3005 notification of an event by re-enabling this object. 3006 3007 If the management station wishes to disable this 3008 flow control and allow events to be generated 3009 at will, this object may be set to 3010 eventAlwaysReady(3). Disabling the flow control 3011 is discouraged as it can result in high network 3012 traffic or other performance problems." 3013 DEFVAL { eventReady } 3014 ::= { channelEntry 8 } 3015 3016channelMatches OBJECT-TYPE 3017 SYNTAX Counter32 3018 UNITS "Packets" 3019 MAX-ACCESS read-only 3020 STATUS current 3021 DESCRIPTION 3022 "The number of times this channel has matched a packet. 3023 Note that this object is updated even when 3024 channelDataControl is set to off." 3025 ::= { channelEntry 9 } 3026 3027channelDescription OBJECT-TYPE 3028 SYNTAX DisplayString (SIZE (0..127)) 3029 MAX-ACCESS read-create 3030 STATUS current 3031 DESCRIPTION 3032 "A comment describing this channel." 3033 ::= { channelEntry 10 } 3034 3035channelOwner OBJECT-TYPE 3036 SYNTAX OwnerString 3037 MAX-ACCESS read-create 3038 STATUS current 3039 DESCRIPTION 3040 "The entity that configured this entry and is therefore 3041 using the resources assigned to it." 3042 ::= { channelEntry 11 } 3043 3044channelStatus OBJECT-TYPE 3045 SYNTAX EntryStatus 3046 MAX-ACCESS read-create 3047 STATUS current 3048 DESCRIPTION 3049 "The status of this channel entry." 3050 ::= { channelEntry 12 } 3051 3052-- The Packet Capture Group 3053 3054-- Implementation of the Packet Capture group is optional. The Packet 3055-- Capture Group requires implementation of the Filter Group. 3056-- Consult the MODULE-COMPLIANCE macro for the authoritative 3057-- conformance information for this MIB. 3058-- 3059-- The Packet Capture group allows packets to be captured 3060-- upon a filter match. The bufferControlTable controls 3061-- the captured packets output from a channel that is 3062-- associated with it. The captured packets are placed 3063-- in entries in the captureBufferTable. These entries are 3064-- associated with the bufferControlEntry on whose behalf they 3065-- were stored. 3066 3067bufferControlTable OBJECT-TYPE 3068 SYNTAX SEQUENCE OF BufferControlEntry 3069 MAX-ACCESS not-accessible 3070 STATUS current 3071 DESCRIPTION 3072 "A list of buffers control entries." 3073 ::= { capture 1 } 3074 3075bufferControlEntry OBJECT-TYPE 3076 SYNTAX BufferControlEntry 3077 MAX-ACCESS not-accessible 3078 STATUS current 3079 DESCRIPTION 3080 "A set of parameters that control the collection of a stream 3081 of packets that have matched filters. As an example, an 3082 instance of the bufferControlCaptureSliceSize object might 3083 be named bufferControlCaptureSliceSize.3" 3084 3085 INDEX { bufferControlIndex } 3086 ::= { bufferControlTable 1 } 3087 3088BufferControlEntry ::= SEQUENCE { 3089 bufferControlIndex Integer32, 3090 bufferControlChannelIndex Integer32, 3091 bufferControlFullStatus INTEGER, 3092 bufferControlFullAction INTEGER, 3093 bufferControlCaptureSliceSize Integer32, 3094 bufferControlDownloadSliceSize Integer32, 3095 bufferControlDownloadOffset Integer32, 3096 bufferControlMaxOctetsRequested Integer32, 3097 bufferControlMaxOctetsGranted Integer32, 3098 bufferControlCapturedPackets Integer32, 3099 bufferControlTurnOnTime TimeTicks, 3100 bufferControlOwner OwnerString, 3101 bufferControlStatus EntryStatus 3102} 3103 3104bufferControlIndex OBJECT-TYPE 3105 SYNTAX Integer32 (1..65535) 3106 MAX-ACCESS read-only 3107 STATUS current 3108 DESCRIPTION 3109 "An index that uniquely identifies an entry 3110 in the bufferControl table. The value of this 3111 index shall never be zero. Each such 3112 entry defines one set of packets that is 3113 captured and controlled by one or more filters." 3114 ::= { bufferControlEntry 1 } 3115 3116bufferControlChannelIndex OBJECT-TYPE 3117 SYNTAX Integer32 (1..65535) 3118 MAX-ACCESS read-create 3119 STATUS current 3120 DESCRIPTION 3121 "An index that identifies the channel that is the 3122 source of packets for this bufferControl table. 3123 The channel identified by a particular value of this 3124 index is the same as identified by the same value of 3125 the channelIndex object. 3126 3127 This object may not be modified if the associated 3128 bufferControlStatus object is equal to valid(1)." 3129 ::= { bufferControlEntry 2 } 3130 3131bufferControlFullStatus OBJECT-TYPE 3132 SYNTAX INTEGER { 3133 spaceAvailable(1), 3134 full(2) 3135 } 3136 MAX-ACCESS read-only 3137 STATUS current 3138 DESCRIPTION 3139 "This object shows whether the buffer has room to 3140 accept new packets or if it is full. 3141 3142 If the status is spaceAvailable(1), the buffer is 3143 accepting new packets normally. If the status is 3144 full(2) and the associated bufferControlFullAction 3145 object is wrapWhenFull, the buffer is accepting new 3146 packets by deleting enough of the oldest packets 3147 to make room for new ones as they arrive. Otherwise, 3148 if the status is full(2) and the 3149 bufferControlFullAction object is lockWhenFull, 3150 then the buffer has stopped collecting packets. 3151 3152 When this object is set to full(2) the probe must 3153 not later set it to spaceAvailable(1) except in the 3154 case of a significant gain in resources such as 3155 an increase of bufferControlOctetsGranted. In 3156 particular, the wrap-mode action of deleting old 3157 packets to make room for newly arrived packets 3158 must not affect the value of this object." 3159 ::= { bufferControlEntry 3 } 3160 3161bufferControlFullAction OBJECT-TYPE 3162 SYNTAX INTEGER { 3163 lockWhenFull(1), 3164 wrapWhenFull(2) -- FIFO 3165 } 3166 MAX-ACCESS read-create 3167 STATUS current 3168 DESCRIPTION 3169 "Controls the action of the buffer when it 3170 reaches the full status. When in the lockWhenFull(1) 3171 state and a packet is added to the buffer that 3172 fills the buffer, the bufferControlFullStatus will 3173 be set to full(2) and this buffer will stop capturing 3174 packets." 3175 ::= { bufferControlEntry 4 } 3176 3177bufferControlCaptureSliceSize OBJECT-TYPE 3178 SYNTAX Integer32 3179 UNITS "Octets" 3180 MAX-ACCESS read-create 3181 STATUS current 3182 DESCRIPTION 3183 "The maximum number of octets of each packet 3184 that will be saved in this capture buffer. 3185 For example, if a 1500 octet packet is received by 3186 the probe and this object is set to 500, then only 3187 500 octets of the packet will be stored in the 3188 associated capture buffer. If this variable is set 3189 to 0, the capture buffer will save as many octets 3190 as is possible. 3191 3192 This object may not be modified if the associated 3193 bufferControlStatus object is equal to valid(1)." 3194 DEFVAL { 100 } 3195 ::= { bufferControlEntry 5 } 3196 3197bufferControlDownloadSliceSize OBJECT-TYPE 3198 SYNTAX Integer32 3199 UNITS "Octets" 3200 MAX-ACCESS read-create 3201 STATUS current 3202 DESCRIPTION 3203 "The maximum number of octets of each packet 3204 in this capture buffer that will be returned in 3205 an SNMP retrieval of that packet. For example, 3206 if 500 octets of a packet have been stored in the 3207 associated capture buffer, the associated 3208 bufferControlDownloadOffset is 0, and this 3209 object is set to 100, then the captureBufferPacket 3210 object that contains the packet will contain only 3211 the first 100 octets of the packet. 3212 3213 A prudent manager will take into account possible 3214 interoperability or fragmentation problems that may 3215 occur if the download slice size is set too large. 3216 In particular, conformant SNMP implementations are not 3217 required to accept messages whose length exceeds 484 3218 octets, although they are encouraged to support larger 3219 datagrams whenever feasible." 3220 DEFVAL { 100 } 3221 ::= { bufferControlEntry 6 } 3222 3223bufferControlDownloadOffset OBJECT-TYPE 3224 SYNTAX Integer32 3225 UNITS "Octets" 3226 MAX-ACCESS read-create 3227 STATUS current 3228 DESCRIPTION 3229 "The offset of the first octet of each packet 3230 in this capture buffer that will be returned in 3231 an SNMP retrieval of that packet. For example, 3232 if 500 octets of a packet have been stored in the 3233 associated capture buffer and this object is set to 3234 100, then the captureBufferPacket object that 3235 contains the packet will contain bytes starting 3236 100 octets into the packet." 3237 DEFVAL { 0 } 3238 ::= { bufferControlEntry 7 } 3239 3240bufferControlMaxOctetsRequested OBJECT-TYPE 3241 SYNTAX Integer32 3242 UNITS "Octets" 3243 MAX-ACCESS read-create 3244 STATUS current 3245 DESCRIPTION 3246 "The requested maximum number of octets to be 3247 saved in this captureBuffer, including any 3248 implementation-specific overhead. If this variable 3249 is set to -1, the capture buffer will save as many 3250 octets as is possible. 3251 3252 When this object is created or modified, the probe 3253 should set bufferControlMaxOctetsGranted as closely 3254 to this object as is possible for the particular probe 3255 implementation and available resources. However, if 3256 the object has the special value of -1, the probe 3257 must set bufferControlMaxOctetsGranted to -1." 3258 DEFVAL { -1 } 3259 ::= { bufferControlEntry 8 } 3260 3261bufferControlMaxOctetsGranted OBJECT-TYPE 3262 SYNTAX Integer32 3263 UNITS "Octets" 3264 MAX-ACCESS read-only 3265 STATUS current 3266 DESCRIPTION 3267 "The maximum number of octets that can be 3268 saved in this captureBuffer, including overhead. 3269 If this variable is -1, the capture buffer will save 3270 as many octets as possible. 3271 3272 When the bufferControlMaxOctetsRequested object is 3273 created or modified, the probe should set this object 3274 as closely to the requested value as is possible for the 3275 particular probe implementation and available resources. 3276 However, if the request object has the special value 3277 of -1, the probe must set this object to -1. 3278 3279 The probe must not lower this value except as a result of 3280 a modification to the associated 3281 bufferControlMaxOctetsRequested object. 3282 3283 When this maximum number of octets is reached 3284 and a new packet is to be added to this 3285 capture buffer and the corresponding 3286 bufferControlFullAction is set to wrapWhenFull(2), 3287 enough of the oldest packets associated with this 3288 capture buffer shall be deleted by the agent so 3289 that the new packet can be added. If the corresponding 3290 bufferControlFullAction is set to lockWhenFull(1), 3291 the new packet shall be discarded. In either case, 3292 the probe must set bufferControlFullStatus to 3293 full(2). 3294 3295 When the value of this object changes to a value less 3296 than the current value, entries are deleted from 3297 the captureBufferTable associated with this 3298 bufferControlEntry. Enough of the 3299 oldest of these captureBufferEntries shall be 3300 deleted by the agent so that the number of octets 3301 used remains less than or equal to the new value of 3302 this object. 3303 3304 When the value of this object changes to a value greater 3305 than the current value, the number of associated 3306 captureBufferEntries may be allowed to grow." 3307 ::= { bufferControlEntry 9 } 3308 3309bufferControlCapturedPackets OBJECT-TYPE 3310 SYNTAX Integer32 3311 UNITS "Packets" 3312 MAX-ACCESS read-only 3313 STATUS current 3314 DESCRIPTION 3315 "The number of packets currently in this captureBuffer." 3316 ::= { bufferControlEntry 10 } 3317 3318bufferControlTurnOnTime OBJECT-TYPE 3319 SYNTAX TimeTicks 3320 MAX-ACCESS read-only 3321 STATUS current 3322 DESCRIPTION 3323 "The value of sysUpTime when this capture buffer was 3324 first turned on." 3325 ::= { bufferControlEntry 11 } 3326 3327bufferControlOwner OBJECT-TYPE 3328 SYNTAX OwnerString 3329 MAX-ACCESS read-create 3330 STATUS current 3331 DESCRIPTION 3332 "The entity that configured this entry and is therefore 3333 using the resources assigned to it." 3334 ::= { bufferControlEntry 12 } 3335 3336bufferControlStatus OBJECT-TYPE 3337 SYNTAX EntryStatus 3338 MAX-ACCESS read-create 3339 STATUS current 3340 DESCRIPTION 3341 "The status of this buffer Control Entry." 3342 ::= { bufferControlEntry 13 } 3343 3344captureBufferTable OBJECT-TYPE 3345 SYNTAX SEQUENCE OF CaptureBufferEntry 3346 MAX-ACCESS not-accessible 3347 STATUS current 3348 DESCRIPTION 3349 "A list of packets captured off of a channel." 3350 ::= { capture 2 } 3351 3352captureBufferEntry OBJECT-TYPE 3353 SYNTAX CaptureBufferEntry 3354 MAX-ACCESS not-accessible 3355 STATUS current 3356 DESCRIPTION 3357 "A packet captured off of an attached network. As an 3358 example, an instance of the captureBufferPacketData 3359 object might be named captureBufferPacketData.3.1783" 3360 INDEX { captureBufferControlIndex, captureBufferIndex } 3361 ::= { captureBufferTable 1 } 3362 3363CaptureBufferEntry ::= SEQUENCE { 3364 captureBufferControlIndex Integer32, 3365 captureBufferIndex Integer32, 3366 captureBufferPacketID Integer32, 3367 captureBufferPacketData OCTET STRING, 3368 captureBufferPacketLength Integer32, 3369 captureBufferPacketTime Integer32, 3370 captureBufferPacketStatus Integer32 3371} 3372 3373captureBufferControlIndex OBJECT-TYPE 3374 SYNTAX Integer32 (1..65535) 3375 MAX-ACCESS read-only 3376 STATUS current 3377 DESCRIPTION 3378 "The index of the bufferControlEntry with which 3379 this packet is associated." 3380 ::= { captureBufferEntry 1 } 3381 3382captureBufferIndex OBJECT-TYPE 3383 SYNTAX Integer32 (1..2147483647) 3384 MAX-ACCESS read-only 3385 STATUS current 3386 DESCRIPTION 3387 "An index that uniquely identifies an entry 3388 in the captureBuffer table associated with a 3389 particular bufferControlEntry. This index will 3390 start at 1 and increase by one for each new packet 3391 added with the same captureBufferControlIndex. 3392 3393 Should this value reach 2147483647, the next packet 3394 added with the same captureBufferControlIndex shall 3395 cause this value to wrap around to 1." 3396 ::= { captureBufferEntry 2 } 3397 3398captureBufferPacketID OBJECT-TYPE 3399 SYNTAX Integer32 3400 MAX-ACCESS read-only 3401 STATUS current 3402 DESCRIPTION 3403 "An index that describes the order of packets 3404 that are received on a particular interface. 3405 The packetID of a packet captured on an 3406 interface is defined to be greater than the 3407 packetID's of all packets captured previously on 3408 the same interface. As the captureBufferPacketID 3409 object has a maximum positive value of 2^31 - 1, 3410 any captureBufferPacketID object shall have the 3411 value of the associated packet's packetID mod 2^31." 3412 ::= { captureBufferEntry 3 } 3413 3414captureBufferPacketData OBJECT-TYPE 3415 SYNTAX OCTET STRING 3416 MAX-ACCESS read-only 3417 STATUS current 3418 DESCRIPTION 3419 "The data inside the packet, starting at the beginning 3420 of the packet plus any offset specified in the 3421 associated bufferControlDownloadOffset, including any 3422 link level headers. The length of the data in this object 3423 is the minimum of the length of the captured packet minus 3424 the offset, the length of the associated 3425 bufferControlCaptureSliceSize minus the offset, and the 3426 associated bufferControlDownloadSliceSize. If this minimum 3427 is less than zero, this object shall have a length of zero." 3428 ::= { captureBufferEntry 4 } 3429 3430captureBufferPacketLength OBJECT-TYPE 3431 SYNTAX Integer32 3432 UNITS "Octets" 3433 MAX-ACCESS read-only 3434 STATUS current 3435 DESCRIPTION 3436 "The actual length (off the wire) of the packet stored 3437 in this entry, including FCS octets." 3438 ::= { captureBufferEntry 5 } 3439 3440captureBufferPacketTime OBJECT-TYPE 3441 SYNTAX Integer32 3442 UNITS "Milliseconds" 3443 MAX-ACCESS read-only 3444 STATUS current 3445 DESCRIPTION 3446 "The number of milliseconds that had passed since 3447 this capture buffer was first turned on when this 3448 packet was captured." 3449 ::= { captureBufferEntry 6 } 3450 3451captureBufferPacketStatus OBJECT-TYPE 3452 SYNTAX Integer32 3453 MAX-ACCESS read-only 3454 STATUS current 3455 DESCRIPTION 3456 "A value which indicates the error status of this packet. 3457 3458 The value of this object is defined in the same way as 3459 filterPktStatus. The value is a sum. This sum 3460 initially takes the value zero. Then, for each 3461 error, E, that has been discovered in this packet, 3462 2 raised to a value representing E is added to the sum. 3463 3464 The errors defined for a packet captured off of an 3465 Ethernet interface are as follows: 3466 3467 bit # Error 3468 0 Packet is longer than 1518 octets 3469 1 Packet is shorter than 64 octets 3470 2 Packet experienced a CRC or Alignment error 3471 3 First packet in this capture buffer after 3472 it was detected that some packets were 3473 not processed correctly. 3474 4 Packet's order in buffer is only approximate 3475 (May only be set for packets sent from 3476 the probe) 3477 3478 For example, an Ethernet fragment would have a 3479 value of 6 (2^1 + 2^2). 3480 3481 As this MIB is expanded to new media types, this object 3482 will have other media-specific errors defined." 3483 ::= { captureBufferEntry 7 } 3484 3485-- The Event Group 3486 3487-- Implementation of the Event group is optional. 3488-- Consult the MODULE-COMPLIANCE macro for the authoritative 3489-- conformance information for this MIB. 3490-- 3491-- The Event group controls the generation and notification 3492-- of events from this device. Each entry in the eventTable 3493-- describes the parameters of the event that can be triggered. 3494-- Each event entry is fired by an associated condition located 3495-- elsewhere in the MIB. An event entry may also be associated 3496-- with a function elsewhere in the MIB that will be executed 3497-- when the event is generated. For example, a channel may 3498-- be turned on or off by the firing of an event. 3499-- 3500-- Each eventEntry may optionally specify that a log entry 3501-- be created on its behalf whenever the event occurs. 3502-- Each entry may also specify that notification should 3503-- occur by way of SNMP trap messages. In this case, the 3504-- community for the trap message is given in the associated 3505-- eventCommunity object. The enterprise and specific trap 3506-- fields of the trap are determined by the condition that 3507-- triggered the event. Two traps are defined: risingAlarm and 3508-- fallingAlarm. If the eventTable is triggered by a condition 3509-- specified elsewhere, the enterprise and specific trap fields 3510-- must be specified for traps generated for that condition. 3511 3512eventTable OBJECT-TYPE 3513 SYNTAX SEQUENCE OF EventEntry 3514 MAX-ACCESS not-accessible 3515 STATUS current 3516 DESCRIPTION 3517 "A list of events to be generated." 3518 ::= { event 1 } 3519 3520eventEntry OBJECT-TYPE 3521 SYNTAX EventEntry 3522 MAX-ACCESS not-accessible 3523 STATUS current 3524 DESCRIPTION 3525 "A set of parameters that describe an event to be generated 3526 when certain conditions are met. As an example, an instance 3527 of the eventLastTimeSent object might be named 3528 eventLastTimeSent.6" 3529 INDEX { eventIndex } 3530 ::= { eventTable 1 } 3531 3532EventEntry ::= SEQUENCE { 3533 eventIndex Integer32, 3534 eventDescription DisplayString, 3535 eventType INTEGER, 3536 eventCommunity OCTET STRING, 3537 eventLastTimeSent TimeTicks, 3538 eventOwner OwnerString, 3539 eventStatus EntryStatus 3540} 3541 3542eventIndex OBJECT-TYPE 3543 SYNTAX Integer32 (1..65535) 3544 MAX-ACCESS read-only 3545 STATUS current 3546 DESCRIPTION 3547 "An index that uniquely identifies an entry in the 3548 event table. Each such entry defines one event that 3549 is to be generated when the appropriate conditions 3550 occur." 3551 ::= { eventEntry 1 } 3552 3553eventDescription OBJECT-TYPE 3554 SYNTAX DisplayString (SIZE (0..127)) 3555 MAX-ACCESS read-create 3556 STATUS current 3557 DESCRIPTION 3558 "A comment describing this event entry." 3559 ::= { eventEntry 2 } 3560 3561eventType OBJECT-TYPE 3562 SYNTAX INTEGER { 3563 none(1), 3564 log(2), 3565 snmptrap(3), -- send an SNMP trap 3566 logandtrap(4) 3567 } 3568 MAX-ACCESS read-create 3569 STATUS current 3570 DESCRIPTION 3571 "The type of notification that the probe will make 3572 about this event. In the case of log, an entry is 3573 made in the log table for each event. In the case of 3574 snmp-trap, an SNMP trap is sent to one or more 3575 management stations." 3576 ::= { eventEntry 3 } 3577 3578eventCommunity OBJECT-TYPE 3579 SYNTAX OCTET STRING (SIZE (0..127)) 3580 MAX-ACCESS read-create 3581 STATUS current 3582 DESCRIPTION 3583 "If an SNMP trap is to be sent, it will be sent to 3584 the SNMP community specified by this octet string." 3585 ::= { eventEntry 4 } 3586 3587eventLastTimeSent OBJECT-TYPE 3588 SYNTAX TimeTicks 3589 MAX-ACCESS read-only 3590 STATUS current 3591 DESCRIPTION 3592 "The value of sysUpTime at the time this event 3593 entry last generated an event. If this entry has 3594 not generated any events, this value will be 3595 zero." 3596 ::= { eventEntry 5 } 3597 3598eventOwner OBJECT-TYPE 3599 SYNTAX OwnerString 3600 MAX-ACCESS read-create 3601 STATUS current 3602 DESCRIPTION 3603 "The entity that configured this entry and is therefore 3604 using the resources assigned to it. 3605 3606 If this object contains a string starting with 'monitor' 3607 and has associated entries in the log table, all connected 3608 management stations should retrieve those log entries, 3609 as they may have significance to all management stations 3610 connected to this device" 3611 ::= { eventEntry 6 } 3612 3613eventStatus OBJECT-TYPE 3614 SYNTAX EntryStatus 3615 MAX-ACCESS read-create 3616 STATUS current 3617 DESCRIPTION 3618 "The status of this event entry. 3619 3620 If this object is not equal to valid(1), all associated 3621 log entries shall be deleted by the agent." 3622 ::= { eventEntry 7 } 3623 3624-- 3625logTable OBJECT-TYPE 3626 SYNTAX SEQUENCE OF LogEntry 3627 MAX-ACCESS not-accessible 3628 STATUS current 3629 DESCRIPTION 3630 "A list of events that have been logged." 3631 ::= { event 2 } 3632 3633logEntry OBJECT-TYPE 3634 SYNTAX LogEntry 3635 MAX-ACCESS not-accessible 3636 STATUS current 3637 DESCRIPTION 3638 "A set of data describing an event that has been 3639 logged. For example, an instance of the logDescription 3640 object might be named logDescription.6.47" 3641 INDEX { logEventIndex, logIndex } 3642 ::= { logTable 1 } 3643 3644LogEntry ::= SEQUENCE { 3645 logEventIndex Integer32, 3646 logIndex Integer32, 3647 logTime TimeTicks, 3648 logDescription DisplayString 3649} 3650 3651logEventIndex OBJECT-TYPE 3652 SYNTAX Integer32 (1..65535) 3653 MAX-ACCESS read-only 3654 STATUS current 3655 DESCRIPTION 3656 "The event entry that generated this log 3657 entry. The log identified by a particular 3658 value of this index is associated with the same 3659 eventEntry as identified by the same value 3660 of eventIndex." 3661 ::= { logEntry 1 } 3662 3663logIndex OBJECT-TYPE 3664 SYNTAX Integer32 (1..2147483647) 3665 MAX-ACCESS read-only 3666 STATUS current 3667 DESCRIPTION 3668 "An index that uniquely identifies an entry 3669 in the log table amongst those generated by the 3670 same eventEntries. These indexes are 3671 assigned beginning with 1 and increase by one 3672 with each new log entry. The association 3673 between values of logIndex and logEntries 3674 is fixed for the lifetime of each logEntry. 3675 The agent may choose to delete the oldest 3676 instances of logEntry as required because of 3677 lack of memory. It is an implementation-specific 3678 matter as to when this deletion may occur." 3679 ::= { logEntry 2 } 3680 3681logTime OBJECT-TYPE 3682 SYNTAX TimeTicks 3683 MAX-ACCESS read-only 3684 STATUS current 3685 DESCRIPTION 3686 "The value of sysUpTime when this log entry was created." 3687 ::= { logEntry 3 } 3688 3689logDescription OBJECT-TYPE 3690 SYNTAX DisplayString (SIZE (0..255)) 3691 MAX-ACCESS read-only 3692 STATUS current 3693 DESCRIPTION 3694 "An implementation dependent description of the 3695 event that activated this log entry." 3696 ::= { logEntry 4 } 3697 3698-- Remote Network Monitoring Traps 3699 3700rmonEventsV2 OBJECT-IDENTITY 3701 STATUS current 3702 DESCRIPTION "Definition point for RMON notifications." 3703 ::= { rmon 0 } 3704 3705risingAlarm NOTIFICATION-TYPE 3706 OBJECTS { alarmIndex, alarmVariable, alarmSampleType, 3707 alarmValue, alarmRisingThreshold } 3708 STATUS current 3709 DESCRIPTION 3710 "The SNMP trap that is generated when an alarm 3711 entry crosses its rising threshold and generates 3712 an event that is configured for sending SNMP 3713 traps." 3714 ::= { rmonEventsV2 1 } 3715 3716fallingAlarm NOTIFICATION-TYPE 3717 OBJECTS { alarmIndex, alarmVariable, alarmSampleType, 3718 alarmValue, alarmFallingThreshold } 3719 STATUS current 3720 DESCRIPTION 3721 "The SNMP trap that is generated when an alarm 3722 entry crosses its falling threshold and generates 3723 an event that is configured for sending SNMP 3724 traps." 3725 ::= { rmonEventsV2 2 } 3726 3727-- Conformance information 3728 3729rmonCompliances OBJECT IDENTIFIER ::= { rmonConformance 9 } 3730rmonGroups OBJECT IDENTIFIER ::= { rmonConformance 10 } 3731 3732-- Compliance Statements 3733rmonCompliance MODULE-COMPLIANCE 3734 STATUS current 3735 DESCRIPTION 3736 "The requirements for conformance to the RMON MIB. At least 3737 one of the groups in this module must be implemented to 3738 conform to the RMON MIB. Implementations of this MIB 3739 must also implement the system group of MIB-II [16] and the 3740 IF-MIB [17]." 3741 MODULE -- this module 3742 3743 GROUP rmonEtherStatsGroup 3744 DESCRIPTION 3745 "The RMON Ethernet Statistics Group is optional." 3746 3747 GROUP rmonHistoryControlGroup 3748 DESCRIPTION 3749 "The RMON History Control Group is optional." 3750 3751 GROUP rmonEthernetHistoryGroup 3752 DESCRIPTION 3753 "The RMON Ethernet History Group is optional." 3754 3755 GROUP rmonAlarmGroup 3756 DESCRIPTION 3757 "The RMON Alarm Group is optional." 3758 3759 GROUP rmonHostGroup 3760 DESCRIPTION 3761 "The RMON Host Group is mandatory when the 3762 rmonHostTopNGroup is implemented." 3763 3764 GROUP rmonHostTopNGroup 3765 DESCRIPTION 3766 "The RMON Host Top N Group is optional." 3767 3768 GROUP rmonMatrixGroup 3769 DESCRIPTION 3770 "The RMON Matrix Group is optional." 3771 3772 GROUP rmonFilterGroup 3773 DESCRIPTION 3774 "The RMON Filter Group is mandatory when the 3775 rmonPacketCaptureGroup is implemented." 3776 3777 GROUP rmonPacketCaptureGroup 3778 DESCRIPTION 3779 "The RMON Packet Capture Group is optional." 3780 3781 GROUP rmonEventGroup 3782 DESCRIPTION 3783 "The RMON Event Group is mandatory when the 3784 rmonAlarmGroup is implemented." 3785 ::= { rmonCompliances 1 } 3786 3787 rmonEtherStatsGroup OBJECT-GROUP 3788 OBJECTS { 3789 etherStatsIndex, etherStatsDataSource, 3790 etherStatsDropEvents, etherStatsOctets, etherStatsPkts, 3791 etherStatsBroadcastPkts, etherStatsMulticastPkts, 3792 etherStatsCRCAlignErrors, etherStatsUndersizePkts, 3793 etherStatsOversizePkts, etherStatsFragments, 3794 etherStatsJabbers, etherStatsCollisions, 3795 etherStatsPkts64Octets, etherStatsPkts65to127Octets, 3796 etherStatsPkts128to255Octets, 3797 etherStatsPkts256to511Octets, 3798 etherStatsPkts512to1023Octets, 3799 etherStatsPkts1024to1518Octets, 3800 etherStatsOwner, etherStatsStatus 3801 } 3802 STATUS current 3803 DESCRIPTION 3804 "The RMON Ethernet Statistics Group." 3805 ::= { rmonGroups 1 } 3806 3807 rmonHistoryControlGroup OBJECT-GROUP 3808 OBJECTS { 3809 historyControlIndex, historyControlDataSource, 3810 historyControlBucketsRequested, 3811 historyControlBucketsGranted, historyControlInterval, 3812 historyControlOwner, historyControlStatus 3813 } 3814 STATUS current 3815 DESCRIPTION 3816 "The RMON History Control Group." 3817 ::= { rmonGroups 2 } 3818 3819 rmonEthernetHistoryGroup OBJECT-GROUP 3820 OBJECTS { 3821 etherHistoryIndex, etherHistorySampleIndex, 3822 etherHistoryIntervalStart, etherHistoryDropEvents, 3823 etherHistoryOctets, etherHistoryPkts, 3824 etherHistoryBroadcastPkts, etherHistoryMulticastPkts, 3825 etherHistoryCRCAlignErrors, etherHistoryUndersizePkts, 3826 etherHistoryOversizePkts, etherHistoryFragments, 3827 etherHistoryJabbers, etherHistoryCollisions, 3828 etherHistoryUtilization 3829 } 3830 STATUS current 3831 DESCRIPTION 3832 "The RMON Ethernet History Group." 3833 ::= { rmonGroups 3 } 3834 3835 rmonAlarmGroup OBJECT-GROUP 3836 OBJECTS { 3837 alarmIndex, alarmInterval, alarmVariable, 3838 alarmSampleType, alarmValue, alarmStartupAlarm, 3839 alarmRisingThreshold, alarmFallingThreshold, 3840 alarmRisingEventIndex, alarmFallingEventIndex, 3841 alarmOwner, alarmStatus 3842 } 3843 STATUS current 3844 DESCRIPTION 3845 "The RMON Alarm Group." 3846 ::= { rmonGroups 4 } 3847 3848 rmonHostGroup OBJECT-GROUP 3849 OBJECTS { 3850 hostControlIndex, hostControlDataSource, 3851 hostControlTableSize, hostControlLastDeleteTime, 3852 hostControlOwner, hostControlStatus, 3853 hostAddress, hostCreationOrder, hostIndex, 3854 hostInPkts, hostOutPkts, hostInOctets, 3855 hostOutOctets, hostOutErrors, hostOutBroadcastPkts, 3856 hostOutMulticastPkts, hostTimeAddress, 3857 hostTimeCreationOrder, hostTimeIndex, 3858 hostTimeInPkts, hostTimeOutPkts, hostTimeInOctets, 3859 hostTimeOutOctets, hostTimeOutErrors, 3860 hostTimeOutBroadcastPkts, hostTimeOutMulticastPkts 3861 } 3862 STATUS current 3863 DESCRIPTION 3864 "The RMON Host Group." 3865 ::= { rmonGroups 5 } 3866 3867 rmonHostTopNGroup OBJECT-GROUP 3868 OBJECTS { 3869 hostTopNControlIndex, hostTopNHostIndex, 3870 hostTopNRateBase, hostTopNTimeRemaining, 3871 hostTopNDuration, hostTopNRequestedSize, 3872 hostTopNGrantedSize, hostTopNStartTime, 3873 hostTopNOwner, hostTopNStatus, 3874 hostTopNReport, hostTopNIndex, 3875 hostTopNAddress, hostTopNRate 3876 } 3877 STATUS current 3878 DESCRIPTION 3879 "The RMON Host Top 'N' Group." 3880 ::= { rmonGroups 6 } 3881 3882 rmonMatrixGroup OBJECT-GROUP 3883 OBJECTS { 3884 matrixControlIndex, matrixControlDataSource, 3885 matrixControlTableSize, matrixControlLastDeleteTime, 3886 matrixControlOwner, matrixControlStatus, 3887 matrixSDSourceAddress, matrixSDDestAddress, 3888 matrixSDIndex, matrixSDPkts, 3889 matrixSDOctets, matrixSDErrors, 3890 matrixDSSourceAddress, matrixDSDestAddress, 3891 matrixDSIndex, matrixDSPkts, 3892 matrixDSOctets, matrixDSErrors 3893 } 3894 STATUS current 3895 DESCRIPTION 3896 "The RMON Matrix Group." 3897 ::= { rmonGroups 7 } 3898 3899 rmonFilterGroup OBJECT-GROUP 3900 OBJECTS { 3901 filterIndex, filterChannelIndex, filterPktDataOffset, 3902 filterPktData, filterPktDataMask, 3903 filterPktDataNotMask, filterPktStatus, 3904 filterPktStatusMask, filterPktStatusNotMask, 3905 filterOwner, filterStatus, 3906 channelIndex, channelIfIndex, channelAcceptType, 3907 channelDataControl, channelTurnOnEventIndex, 3908 channelTurnOffEventIndex, channelEventIndex, 3909 channelEventStatus, channelMatches, 3910 channelDescription, channelOwner, channelStatus 3911 } 3912 STATUS current 3913 DESCRIPTION 3914 "The RMON Filter Group." 3915 ::= { rmonGroups 8 } 3916 3917 rmonPacketCaptureGroup OBJECT-GROUP 3918 OBJECTS { 3919 bufferControlIndex, bufferControlChannelIndex, 3920 bufferControlFullStatus, bufferControlFullAction, 3921 bufferControlCaptureSliceSize, 3922 bufferControlDownloadSliceSize, 3923 bufferControlDownloadOffset, 3924 bufferControlMaxOctetsRequested, 3925 bufferControlMaxOctetsGranted, 3926 bufferControlCapturedPackets, 3927 bufferControlTurnOnTime, 3928 bufferControlOwner, bufferControlStatus, 3929 captureBufferControlIndex, captureBufferIndex, 3930 captureBufferPacketID, captureBufferPacketData, 3931 captureBufferPacketLength, captureBufferPacketTime, 3932 captureBufferPacketStatus 3933 } 3934 STATUS current 3935 DESCRIPTION 3936 "The RMON Packet Capture Group." 3937 ::= { rmonGroups 9 } 3938 3939 rmonEventGroup OBJECT-GROUP 3940 OBJECTS { 3941 eventIndex, eventDescription, eventType, 3942 eventCommunity, eventLastTimeSent, 3943 eventOwner, eventStatus, 3944 logEventIndex, logIndex, logTime, 3945 logDescription 3946 } 3947 STATUS current 3948 DESCRIPTION 3949 "The RMON Event Group." 3950 ::= { rmonGroups 10 } 3951 3952 rmonNotificationGroup NOTIFICATION-GROUP 3953 NOTIFICATIONS { risingAlarm, fallingAlarm } 3954 STATUS current 3955 DESCRIPTION 3956 "The RMON Notification Group." 3957 ::= { rmonGroups 11 } 3958END 3959