idnits 2.17.1 draft-ietf-rmonmib-rmonmib-02.txt: ** The Abstract section seems to be numbered Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Cannot find the required boilerplate sections (Copyright, IPR, etc.) in this document. Expected boilerplate is as follows today (2024-04-20) according to https://trustee.ietf.org/license-info : IETF Trust Legal Provisions of 28-dec-2009, Section 6.a: This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 2: Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 3: This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing document type: Expected "INTERNET-DRAFT" in the upper left hand corner of the first page ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories. == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 2 longer pages, the longest (page 19) being 59 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an Abstract section. (A line matching the expected section header was found, but with an unexpected indentation: ' 2. Abstract' ) ** The document seems to lack an Introduction section. ** The document seems to lack a Security Considerations section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The document seems to lack an Authors' Addresses Section. ** There are 344 instances of too long lines in the document, the longest one being 7 characters in excess of 72. ** The abstract seems to contain references ([2], [3], [4], [5], [6], [7], [4,6], [8], [9], [10], [1]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == Line 1370 has weird spacing: '... and had e...' -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (June 17, 1994) is 10900 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? '1' on line 4011 looks like a reference -- Missing reference section? '2' on line 4017 looks like a reference -- Missing reference section? '3' on line 4022 looks like a reference -- Missing reference section? '4' on line 4028 looks like a reference -- Missing reference section? '5' on line 4034 looks like a reference -- Missing reference section? '6' on line 4040 looks like a reference -- Missing reference section? '9' on line 4058 looks like a reference -- Missing reference section? '10' on line 4063 looks like a reference -- Missing reference section? '7' on line 4046 looks like a reference -- Missing reference section? '8' on line 4052 looks like a reference Summary: 15 errors (**), 0 flaws (~~), 3 warnings (==), 12 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Draft Remote Network Monitoring MIB June 17, 1994 3 Remote Network Monitoring Management Information Base 4 6 June 17, 1994 8 Steven Waldbusser 10 Carnegie Mellon University 11 5000 Forbes Ave. 12 Pittsburgh, PA 15213 14 waldbusser@cmu.edu 16 1. Status of this Memo 18 This document is an Internet-Draft. Internet-Drafts are 19 working documents of the Internet Engineering Task Force 20 (IETF), its areas, and its working groups. Note that other 21 groups may also distribute working documents as Internet- 22 Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six 25 months. Internet-Drafts may be updated, replaced, or 26 obsoleted by other documents at any time. It is not 27 appropriate to use Internet-Drafts as reference material or to 28 cite them other than as a ``working draft'' or ``work in 29 progress.'' 31 To learn the current status of any Internet-Draft, please 32 check the 1id-abstracts.txt listing contained in the 33 Internet-Drafts Shadow Directories on ds.internic.net, 34 nic.nordu.net, venera.isi.edu, or munnari.oz.au. 36 2. Abstract 38 This memo defines an experimental portion of the Management 39 Information Base (MIB) for use with network management 40 protocols in TCP/IP-based internets. In particular, it 41 defines objects for managing remote network monitoring 42 devices. 44 This memo does not specify a standard for the Internet 45 community. 47 3. The Network Management Framework 49 The Internet-standard Network Management Framework consists of 50 three components. They are: 52 RFC 1155[1] which defines the SMI, the mechanisms used for 53 describing and naming objects for the purpose of management. 54 RFC 1212[2] defines a more concise description mechanism, 55 which is wholly consistent with the SMI. 57 RFC 1213[3] which defines MIB-II, the core set of managed 58 objects for the Internet suite of protocols. 60 RFC 1157[4] which defines the SNMP, the protocol used for 61 network access to managed objects. 63 The Framework permits new objects to be defined for the 64 purpose of experimentation and evaluation. 66 Managed objects are accessed via a virtual information store, 67 termed the Management Information Base or MIB. Within a given 68 MIB module, objects are defined using RFC 1212's OBJECT-TYPE 69 macro. At a minimum, each object has a name, a syntax, an 70 access-level, and an implementation-status. 72 The name is an object identifier, an administratively assigned 73 name, which specifies an object type. The object type 74 together with an object instance serves to uniquely identify a 75 specific instantiation of the object. For human convenience, 76 we often use a textual string, termed the object descriptor, 77 to also refer to the object type. 79 The syntax of an object type defines the abstract data 80 structure corresponding to that object type. The ASN.1[5] 81 language is used for this purpose. However, RFC 1155 82 purposely restricts the ASN.1 constructs which may be used. 83 These restrictions are explicitly made for simplicity. 85 The access-level of an object type defines whether it makes 86 "protocol sense" to read and/or write the value of an instance 87 of the object type. (This access-level is independent of any 88 administrative authorization policy.) 90 The implementation-status of an object type indicates whether 91 the object is mandatory, optional, obsolete, or deprecated. 93 4. Overview 95 Remote network monitoring devices are instruments that exist 96 for the purpose of managing a network. Often these remote 97 probes are stand-alone devices and devote significant internal 98 resources for the sole purpose of managing a network. An 99 organization may employ many of these devices, one per network 100 segment, to manage its internet. In addition, these devices 101 may be used for a network management service provider to 102 access a client network, often geographically remote. 104 The objects defined in this document are intended as an 105 interface between an RMON agent and an RMON management 106 application and is not intended for direct manipulation by 107 humans. While some users may tolerate the direct display of 108 some of these objects, few will tolerate the complexity of 109 manually manipulating objects to accomplish row creation. 110 These functions should be handled by the management 111 application. 113 While many of the objects in this document are suitable for 114 the management of any type of network, there are some which 115 are specific to managing Ethernet networks. The design of 116 this MIB allows similar objects to be defined for other 117 network types. It is intended that future versions of this 118 document will define extensions for other network types such 119 as Token Ring and FDDI. 121 4.1. Remote Network Management Goals 123 o Offline Operation 124 There are sometimes conditions when a management 125 station will not be in constant contact with its 126 remote monitoring devices. This is sometimes by 127 design in an attempt to lower communications costs 128 (especially when communicating over a WAN or 129 dialup link), or by accident as network failures 130 affect the communications between the management 131 station and the probe. 133 For this reason, this MIB allows a probe to be 134 configured to perform diagnostics and to collect 135 statistics continuously, even when communication with 136 the management station may not be possible or 137 efficient. The probe may then attempt to notify 138 the management station when an exceptional condition 139 occurs. Thus, even in circumstances where 140 communication between management station and probe is 141 not continuous, fault, performance, and configuration 142 information may be continuously accumulated and 143 communicated to the management station conveniently 144 and efficiently. 146 o Proactive Monitoring 147 Given the resources available on the monitor, it 148 is potentially helpful for it continuously to run 149 diagnostics and to log network performance. The 150 monitor is always available at the onset of any 151 failure. It can notify the management station of the 152 failure and can store historical statistical 153 information about the failure. This historical 154 information can be played back by the management 155 station in an attempt to perform further diagnosis 156 into the cause of the problem. 158 o Problem Detection and Reporting 159 The monitor can be configured to recognize 160 conditions, most notably error conditions, and 161 continuously to check for them. When one of these 162 conditions occurs, the event may be logged, and 163 management stations may be notified in a number of 164 ways. 166 o Value Added Data 167 Because a remote monitoring device represents a 168 network resource dedicated exclusively to network 169 management functions, and because it is located 170 directly on the monitored portion of the network, the 171 remote network monitoring device has the opportunity 172 to add significant value to the data it collects. 173 For instance, by highlighting those hosts on the 174 network that generate the most traffic or errors, the 175 probe can give the management station precisely the 176 information it needs to solve a class of problems. 178 o Multiple Managers 179 An organization may have multiple management stations 180 for different units of the organization, for different 181 functions (e.g. engineering and operations), and in an 182 attempt to provide disaster recovery. Because 183 environments with multiple management stations are 184 common, the remote network monitoring device has to 185 deal with more than own management station, 186 potentially using its resources concurrently. 188 4.2. Textual Conventions 190 Two new data types are introduced as a textual convention in 191 this MIB document. These textual conventions enhance the 192 readability of the specification and can ease comparison with 193 other specifications if appropriate. It should be noted that 194 the introduction of the these textual conventions has no 195 effect on either the syntax nor the semantics of any managed 196 objects. The use of these is merely an artifact of the 197 explanatory method used. Objects defined in terms of one of 198 these methods are always encoded by means of the rules that 199 define the primitive type. Hence, no changes to the SMI or 200 the SNMP are necessary to accommodate these textual 201 conventions which are adopted merely for the convenience of 202 readers and writers in pursuit of the elusive goal of clear, 203 concise, and unambiguous MIB documents. 205 The new data types are: OwnerString and EntryStatus. 207 4.3. Structure of MIB 209 The objects are arranged into the following groups: 211 - ethernet statistics 213 - history control 215 - ethernet history 217 - alarm 219 - host 221 - hostTopN 223 - matrix 225 - filter 226 - packet capture 228 - event 230 These groups are the basic unit of conformance. If a remote 231 monitoring device implements a group, then it must implement 232 all objects in that group. For example, a managed agent that 233 implements the host group must implement the hostControlTable, 234 the hostTable and the hostTimeTable. 236 All groups in this MIB are optional. Implementations of this 237 MIB must also implement the system and interfaces group of 238 MIB-II [6]. MIB-II may also mandate the implementation of 239 additional groups. 241 These groups are defined to provide a means of assigning 242 object identifiers, and to provide a method for managed agents 243 to know which objects they must implement. 245 4.3.1. The Ethernet Statistics Group 247 The ethernet statistics group contains statistics measured by 248 the probe for each monitored Ethernet interface on this 249 device. This group consists of the etherStatsTable. In the 250 future other groups will be defined for other media types 251 including Token Ring and FDDI. These groups should follow the 252 same model as the ethernet statistics group. 254 4.3.2. The History Control Group 256 The history control group controls the periodic statistical 257 sampling of data from various types of networks. This group 258 consists of the historyControlTable. 260 4.3.3. The Ethernet History Group 262 The ethernet history group records periodic statistical 263 samples from an ethernet network and stores them for later 264 retrieval. This group consists of the etherHistoryTable. In 265 the future, other groups will be defined for other media types 266 including Token Ring and FDDI. 268 4.3.4. The Alarm Group 270 The alarm group periodically takes statistical samples from 271 variables in the probe and compares them to previously 272 configured thresholds. If the monitored variable crosses a 273 threshold, an event is generated. A hysteresis mechanism is 274 implemented to limit the generation of alarms. This group 275 consists of the alarmTable and requires the implementation of 276 the event group. 278 4.3.5. The Host Group 280 The host group contains statistics associated with each host 281 discovered on the network. This group discovers hosts on the 282 network by keeping a list of source and destination MAC 283 Addresses seen in good packets promiscuously received from the 284 network. This group consists of the hostControlTable, the 285 hostTable, and the hostTimeTable. 287 4.3.6. The HostTopN Group 289 The hostTopN group is used to prepare reports that describe 290 the hosts that top a list ordered by one of their statistics. 291 The available statistics are samples of one of their base 292 statistics over an interval specified by the management 293 station. Thus, these statistics are rate based. The 294 management station also selects how many such hosts are 295 reported. This group consists of the hostTopNControlTable and 296 the hostTopNTable, and requires the implementation of the host 297 group. 299 4.3.7. The Matrix Group 301 The matrix group stores statistics for conversations between 302 sets of two addresses. As the device detects a new 303 conversation, it creates a new entry in its tables. This 304 group consists of the matrixControlTable, the matrixSDTable 305 and the matrixDSTable. 307 4.3.8. The Filter Group 309 The filter group allows packets to be matched by a filter 310 equation. These matched packets form a data stream that may 311 be captured or may generate events. This group consists of 312 the filterTable and the channelTable. 314 4.3.9. The Packet Capture Group 316 The Packet Capture group allows packets to be captured after 317 they flow through a channel. This group consists of the 318 bufferControlTable and the captureBufferTable, and requires 319 the implementation of the filter group. 321 4.3.10. The Event Group 323 The event group controls the generation and notification of 324 events from this device. This group consists of the 325 eventTable and the logTable. 327 5. Control of Remote Network Monitoring Devices 329 Due to the complex nature of the available functions in these 330 devices, the functions often need user configuration. In many 331 cases, the function requires parameters to be set up for a 332 data collection operation. The operation can proceed only 333 after these parameters are fully set up. 335 Many functional groups in this MIB have one or more tables in 336 which to set up control parameters, and one or more data 337 tables in which to place the results of the operation. The 338 control tables are typically read-write in nature, while the 339 data tables are typically read-only. Because the parameters 340 in the control table often describe resulting data in the data 341 table, many of the parameters can be modified only when the 342 control entry is invalid. Thus, the method for modifying 343 these parameters is to invalidate the control entry, causing 344 its deletion and the deletion of any associated data entries, 345 and then create a new control entry with the proper 346 parameters. Deleting the control entry also gives a 347 convenient method for reclaiming the resources used by the 348 associated data. 350 Some objects in this MIB provide a mechanism to execute an 351 action on the remote monitoring device. These objects may 352 execute an action as a result of a change in the state of the 353 object. For those objects in this MIB, a request to set an 354 object to the same value as it currently holds would thus 355 cause no action to occur. 357 To facilitate control by multiple managers, resources have to 358 be shared among the managers. These resources are typically 359 the memory and computation resources that a function requires. 361 5.1. Resource Sharing Among Multiple Management Stations 363 When multiple management stations wish to use functions that 364 compete for a finite amount of resources on a device, a method 365 to facilitate this sharing of resources is required. 366 Potential conflicts include: 368 o Two management stations wish to simultaneously use 369 resources that together would exceed the capability of 370 the device. 372 o A management station uses a significant amount of 373 resources for a long period of time. 374 o A management station uses resources and then crashes, 375 forgetting to free the resources so others may 376 use them. 378 A mechanism is provided for each management station initiated 379 function in this MIB to avoid these conflicts and to help 380 resolve them when they occur. Each function has a label 381 identifying the initiator (owner) of the function. This label 382 is set by the initiator to provide for the following 383 possibilities: 385 o A management station may recognize resources it owns 386 and no longer needs. 387 o A network operator can find the management station that 388 owns the resource and negotiate for it to be freed. 389 o A network operator may decide to unilaterally free 390 resources another network operator has reserved. 391 o Upon initialization, a management station may recognize 392 resources it had reserved in the past. With this 393 information it may free the resources if it no longer 394 needs them. 396 Management stations and probes should support any format of 397 the owner string dictated by the local policy of the 398 organization. It is suggested that this name contain one or 399 more of the following: IP address, management station name, 400 network manager's name, location, or phone number. This 401 information will help users to share the resources more 402 effectively. 404 There is often default functionality that the device wishes to 405 set up. The resources associated with this functionality are 406 then owned by the device itself. In this case, the device 407 will set the relevant owner object to a string starting with 408 'monitor'. Indiscriminate modification of the monitor-owned 409 configuration by network management stations is discouraged. 410 In fact, a network management station should only modify these 411 objects under the direction of the administrator of the probe, 412 often the network administrator. 414 When a network management station wishes to utilize a function 415 in a monitor, it is encouraged to first scan the control table 416 of that function to find an instance with similar parameters 417 to share. This is especially true for those instances owned 418 by the monitor, which can be assumed to change infrequently. 419 If a management station decides to share an instance owned by 420 another management station, it should understand that the 421 management station that owns the instance may indiscriminately 422 modify or delete it. 424 5.2. Row Addition Among Multiple Management Stations 426 The addition of new rows is achieved using the method 427 described in [9]. In this MIB, rows are often added to a 428 table in order to configure a function. This configuration 429 usually involves parameters that control the operation of the 430 function. The agent must check these parameters to make sure 431 they are appropriate given restrictions defined in this MIB as 432 well as any implementation specific restrictions such as lack 433 of resources. The agent implementor may be confused as to 434 when to check these parameters and when to signal to the 435 management station that the parameters are invalid. There are 436 two opportunities: 438 o When the management station sets each parameter object. 440 o When the management station sets the entry status object 441 to valid. 443 If the latter is chosen, it would be unclear to the management 444 station which of the several parameters was invalid and caused 445 the badValue error to be emitted. Thus, wherever possible, 446 the implementor should choose the former as it will provide 447 more information to the management station. 449 A problem can arise when multiple management stations attempt 450 to set configuration information simultaneously using SNMP. 451 When this involves the addition of a new conceptual row in the 452 same control table, the managers may collide, attempting to 453 create the same entry. To guard against these collisions, 454 each such control entry contains a status object with special 455 semantics that help to arbitrate among the managers. If an 456 attempt is made with the row addition mechanism to create such 457 a status object and that object already exists, an error is 458 returned. When more than one manager simultaneously attempts 459 to create the same conceptual row, only the first will 460 succeed. The others will receive an error. 462 Some tables in this MIB reference other tables within this 463 MIB. When creating or deleting entries in these tables, it is 464 generally allowable for dangling references to exist. There 465 is no defined order for creating or deleting entries in these 466 tables. 468 6. Conventions 470 The following conventions are used throughout the RMON MIB and 471 its companion documents. 473 Good Packets 475 Good packets are error-free packets that have a valid frame 476 length. For example, on Ethernet, good packets are error-free 477 packets that are between 64 octets long and 1518 octets long. 478 They follow the form defined in IEEE 802.3 section 3.2.all. 480 Bad Packets 482 Bad packets are packets that have proper framing and are 483 therefore recognized as packets, but contain errors withing 484 the packet or have an invalid length. For example, on 485 Ethernet, bad packets have a valid preamble and SFD, but have 486 a bad CRC, or are either shorter than 64 octets or longer than 487 1518 octets. 489 7. Definitions 491 RFCxxxx-MIB DEFINITIONS ::= BEGIN 493 IMPORTS 494 Counter FROM RFC1155-SMI 495 DisplayString FROM RFC1158-MIB 496 mib-2 FROM RFC1213-MIB 497 OBJECT-TYPE FROM RFC-1212 498 TRAP-TYPE FROM RFC-1215; 500 -- This MIB module uses the extended OBJECT-TYPE macro as 501 -- defined in [9]. 503 -- Remote Network Monitoring MIB 505 rmon OBJECT IDENTIFIER ::= { mib-2 16 } 507 -- textual conventions 509 OwnerString ::= DisplayString 510 -- This data type is used to model an administratively 511 -- assigned name of the owner of a resource. This information 512 -- is taken from the NVT ASCII character set. It is suggested 513 -- that this name contain one or more of the following: 514 -- IP address, management station name, network manager's 515 -- name, location, or phone number. 516 -- In some cases the agent itself will be the owner of 517 -- an entry. In these cases, this string shall be set 518 -- to a string starting with 'monitor'. 519 -- 520 -- SNMP access control is articulated entirely in terms of the 521 -- contents of MIB views; access to a particular SNMP object 522 -- instance depends only upon its presence or absence in a 523 -- particular MIB view and never upon its value or the value of 524 -- related object instances. Thus, objects of this type afford 525 -- resolution of resource contention only among cooperating 526 -- managers; they realize no access control function with 527 -- respect to uncooperative parties. 528 -- 529 -- By convention, objects with this syntax are declared as 530 -- having 531 -- 532 -- SIZE (0..127) 534 EntryStatus ::= INTEGER 535 { valid(1), 536 createRequest(2), 537 underCreation(3), 538 invalid(4) 539 } 540 -- The status of a table entry. 541 -- 542 -- Setting this object to the value invalid(4) has the 543 -- effect of invalidating the corresponding entry. 544 -- That is, it effectively disassociates the mapping 545 -- identified with said entry. 546 -- It is an implementation-specific matter as to whether 547 -- the agent removes an invalidated entry from the table. 548 -- Accordingly, management stations must be prepared to 549 -- receive tabular information from agents that corresponds 550 -- to entries currently not in use. Proper 551 -- interpretation of such entries requires examination 552 -- of the relevant EntryStatus object. 553 -- 554 -- An existing instance of this object cannot be set to 555 -- createRequest(2). This object may only be set to 556 -- createRequest(2) when this instance is created. When 557 -- this object is created, the agent may wish to create 558 -- supplemental object instances with default values 559 -- to complete a conceptual row in this table. Because the 560 -- creation of these default objects is entirely at the option 561 -- of the agent, the manager must not assume that any will be 562 -- created, but may make use of any that are created. 563 -- Immediately after completing the create operation, the agent 564 -- must set this object to underCreation(3). 565 -- 566 -- Entries shall exist in the underCreation(3) state until 567 -- the management station is finished configuring the entry 568 -- and sets this object to valid(1) or aborts, setting this 569 -- object to invalid(4). If the agent determines that an 570 -- entry has been in the underCreation(3) state for an 571 -- abnormally long time, it may decide that the management 572 -- station has crashed. If the agent makes this decision, 573 -- it may set this object to invalid(4) to reclaim the 574 -- entry. A prudent agent will understand that the 575 -- management station may need to wait for human input 576 -- and will allow for that possibility in its 577 -- determination of this abnormally long period. 579 statistics OBJECT IDENTIFIER ::= { rmon 1 } 580 history OBJECT IDENTIFIER ::= { rmon 2 } 581 alarm OBJECT IDENTIFIER ::= { rmon 3 } 582 hosts OBJECT IDENTIFIER ::= { rmon 4 } 583 hostTopN OBJECT IDENTIFIER ::= { rmon 5 } 584 matrix OBJECT IDENTIFIER ::= { rmon 6 } 585 filter OBJECT IDENTIFIER ::= { rmon 7 } 586 capture OBJECT IDENTIFIER ::= { rmon 8 } 587 event OBJECT IDENTIFIER ::= { rmon 9 } 589 -- The Ethernet Statistics Group 590 -- 591 -- Implementation of the Ethernet Statistics group is optional. 592 -- 593 -- The ethernet statistics group contains statistics measured by the 594 -- probe for each monitored interface on this device. These 595 statistics 596 -- take the form of free running counters that start from zero when a 597 -- valid entry is created. 598 -- 599 -- This group currently has statistics defined only for 600 -- Ethernet interfaces. Each etherStatsEntry contains statistics 601 -- for one Ethernet interface. The probe must create one 602 -- etherStats entry for each monitored Ethernet interface 603 -- on the device. 605 etherStatsTable OBJECT-TYPE 606 SYNTAX SEQUENCE OF EtherStatsEntry 607 ACCESS not-accessible 608 STATUS mandatory 609 DESCRIPTION 610 "A list of Ethernet statistics entries." 611 ::= { statistics 1 } 613 etherStatsEntry OBJECT-TYPE 614 SYNTAX EtherStatsEntry 615 ACCESS not-accessible 616 STATUS mandatory 617 DESCRIPTION 618 "A collection of statistics kept for a particular 619 Ethernet interface. As an example, an instance of the 620 etherStatsPkts object might be named etherStatsPkts.1" 621 INDEX { etherStatsIndex } 622 ::= { etherStatsTable 1 } 624 EtherStatsEntry ::= SEQUENCE { 625 etherStatsIndex INTEGER (1..65535), 626 etherStatsDataSource OBJECT IDENTIFIER, 627 etherStatsDropEvents Counter, 628 etherStatsOctets Counter, 629 etherStatsPkts Counter, 630 etherStatsBroadcastPkts Counter, 631 etherStatsMulticastPkts Counter, 632 etherStatsCRCAlignErrors Counter, 633 etherStatsUndersizePkts Counter, 634 etherStatsOversizePkts Counter, 635 etherStatsFragments Counter, 636 etherStatsJabbers Counter, 637 etherStatsCollisions Counter, 638 etherStatsPkts64Octets Counter, 639 etherStatsPkts65to127Octets Counter, 640 etherStatsPkts128to255Octets Counter, 641 etherStatsPkts256to511Octets Counter, 642 etherStatsPkts512to1023Octets Counter, 643 etherStatsPkts1024to1518Octets Counter, 644 etherStatsOwner OwnerString, 645 etherStatsStatus EntryStatus 646 } 648 etherStatsIndex OBJECT-TYPE 649 SYNTAX INTEGER (1..65535) 650 ACCESS read-only 651 STATUS mandatory 652 DESCRIPTION 653 "The value of this object uniquely identifies this 654 etherStats entry." 655 ::= { etherStatsEntry 1 } 657 etherStatsDataSource OBJECT-TYPE 658 SYNTAX OBJECT IDENTIFIER 659 ACCESS read-write 660 STATUS mandatory 661 DESCRIPTION 662 "This object identifies the source of the data that 663 this etherStats entry is configured to analyze. This 664 source can be any ethernet interface on this device. 665 In order to identify a particular interface, this object 666 shall identify the instance of the ifIndex object, 667 defined in [4,6], for the desired interface. For example, 668 if an entry were to receive data from interface #1, 669 this object would be set to ifIndex.1. 671 The statistics in this group reflect all packets 672 on the local network segment attached to the identified 673 interface. 675 An agent may or may not be able to tell if fundamental 676 changes to the media of the interface have occurred and 677 necessitate an invalidation of this entry. For example, a 678 hot-pluggable ethernet card could be pulled out and replaced 679 by a token-ring card. In such a case, if the agent has such 680 knowledge of the change, it is recommended that it invalidate 681 this entry. 683 This object may not be modified if the associated 684 etherStatsStatus object is equal to valid(1)." 685 ::= { etherStatsEntry 2 } 687 etherStatsDropEvents OBJECT-TYPE 688 SYNTAX Counter 689 ACCESS read-only 690 STATUS mandatory 691 DESCRIPTION 692 "The total number of events in which packets 693 were dropped by the probe due to lack of resources. 694 Note that this number is not necessarily the number of 695 packets dropped; it is just the number of times this 696 condition has been detected." 697 ::= { etherStatsEntry 3 } 699 etherStatsOctets OBJECT-TYPE 700 SYNTAX Counter 701 ACCESS read-only 702 STATUS mandatory 703 DESCRIPTION 704 "The total number of octets of data (including 705 those in bad packets) received on the 706 network (excluding framing bits but including 707 FCS octets). 709 This object can be used as a reasonable estimate of ethernet 710 utilization. If greater precision is desired, the 711 etherStatsPkts and etherStatsOctets objects should be 712 sampled before and after a common interval. The differences 713 in the sampled values are Pkts and Octets, respectively, and 714 the number of seconds in the interval is Interval. These 715 values are used to calculate the Utilization as follows: 717 Pkts * (9.6 + 6.4) + (Octets * .8) 718 Utilization = ------------------------------------- 719 Interval * 10,000 721 The result of this equation is the value Utilization which 722 is the percent utilization of the ethernet segment on a 723 scale of 0 to 100 percent." 724 ::= { etherStatsEntry 4 } 726 etherStatsPkts OBJECT-TYPE 727 SYNTAX Counter 728 ACCESS read-only 729 STATUS mandatory 730 DESCRIPTION 731 "The total number of packets (including error packets, 732 broadcast packets, and multicast packets) received." 733 ::= { etherStatsEntry 5 } 735 etherStatsBroadcastPkts OBJECT-TYPE 736 SYNTAX Counter 737 ACCESS read-only 738 STATUS mandatory 739 DESCRIPTION 740 "The total number of good packets received that were 741 directed to the broadcast address. Note that this 742 does not include multicast packets." 743 ::= { etherStatsEntry 6 } 745 etherStatsMulticastPkts OBJECT-TYPE 746 SYNTAX Counter 747 ACCESS read-only 748 STATUS mandatory 749 DESCRIPTION 750 "The total number of good packets received that were 751 directed to a multicast address. Note that this number 752 does not include packets directed to the broadcast 753 address." 754 ::= { etherStatsEntry 7 } 756 etherStatsCRCAlignErrors OBJECT-TYPE 757 SYNTAX Counter 758 ACCESS read-only 759 STATUS mandatory 760 DESCRIPTION 761 "The total number of packets received that 762 had a length (excluding framing bits, but 763 including FCS octets) of between 64 and 1518 764 octets, inclusive, but but had either a bad 765 Frame Check Sequence (FCS) with an integral 766 number of octets (FCS Error) or a bad FCS with 767 a non-integral number of octets (Alignment Error)." 768 ::= { etherStatsEntry 8 } 770 etherStatsUndersizePkts OBJECT-TYPE 771 SYNTAX Counter 772 ACCESS read-only 773 STATUS mandatory 774 DESCRIPTION 775 "The total number of packets received that were 776 less than 64 octets long (excluding framing bits, 777 but including FCS octets) and were otherwise well 778 formed." 779 ::= { etherStatsEntry 9 } 781 etherStatsOversizePkts OBJECT-TYPE 782 SYNTAX Counter 783 ACCESS read-only 784 STATUS mandatory 785 DESCRIPTION 786 "The total number of packets received that were 787 longer than 1518 octets (excluding framing bits, 788 but including FCS octets) and were otherwise 789 well formed." 790 ::= { etherStatsEntry 10 } 792 etherStatsFragments OBJECT-TYPE 793 SYNTAX Counter 794 ACCESS read-only 795 STATUS mandatory 796 DESCRIPTION 797 "The total number of packets received that were less than 798 64 octets in length (excluding framing bits but including 799 FCS octets) and had either a bad Frame Check Sequence 800 (FCS) with an integral number of octets (FCS Error) or a 801 bad FCS with a non-integral number of octets (Alignment 802 Error). 804 Note that it is entirely normal for etherStatsFragments to 805 increment. This is because it counts both runts (which are 806 normal occurrences due to collisions) and noise hits." 807 ::= { etherStatsEntry 11 } 809 etherStatsJabbers OBJECT-TYPE 810 SYNTAX Counter 811 ACCESS read-only 812 STATUS mandatory 813 DESCRIPTION 814 "The total number of packets received that were 815 longer than 1518 octets (excluding framing bits, 816 but including FCS octets), and had either a bad 817 Frame Check Sequence (FCS) with an integral number 818 of octets (FCS Error) or a bad FCS with a non-integral 819 number of octets (Alignment Error). 821 Note that this definition of jabber is different 822 than the definition in IEEE-802.3 section 8.2.1.5 823 (10BASE5) and section 10.3.1.4 (10BASE2). These 824 documents define jabber as the condition where any 825 packet exceeds 20 ms. The allowed range to detect 826 jabber is between 20 ms and 150 ms." 827 ::= { etherStatsEntry 12 } 829 etherStatsCollisions OBJECT-TYPE 830 SYNTAX Counter 831 ACCESS read-only 832 STATUS mandatory 833 DESCRIPTION 834 "The best estimate of the total number of collisions 835 on this Ethernet segment. 837 The value returned will depend on the location of the 838 RMON probe. Section 8.2.1.3 (10BASE-5) and section 839 10.3.1.3 (10BASE-2) of IEEE standard 802.3 states that a 840 station must detect a collision, in the receive mode, if 841 three or more stations are transmitting simultaneously. A 842 repeater port must detect a collision when two or more 843 stations are transmitting simultaneously. Thus a probe 844 placed on a repeater port could record more collisions 845 than a probe connected to a station on the same segment 846 would. 848 Probe location plays a much smaller role when considering 849 10BASE-T. 14.2.1.4 (10BASE-T) of IEEE standard 802.3 850 defines a collision as the simultaneous presence of signals 851 on the DO and RD circuits (transmitting and receiving 852 at the same time). A 10BASE-T station can only detect 853 collisions when it is transmitting. Thus probes placed on 854 a station and a repeater, should report the same number of 855 collisions. 857 Note also that an RMON probe inside a repeater should 858 ideally report collisions between the repeater and one or 859 more other hosts (transmit collisions as defined by IEEE 860 802.3k) plus receiver collisions observed on any coax 861 segments to which the repeater is connected." 862 ::= { etherStatsEntry 13 } 864 etherStatsPkts64Octets OBJECT-TYPE 865 SYNTAX Counter 866 ACCESS read-only 867 STATUS mandatory 868 DESCRIPTION 869 "The total number of packets (including error 870 packets) received that were 64 octets in length 871 (excluding framing bits but including FCS octets)." 872 ::= { etherStatsEntry 14 } 874 etherStatsPkts65to127Octets OBJECT-TYPE 875 SYNTAX Counter 876 ACCESS read-only 877 STATUS mandatory 878 DESCRIPTION 879 "The total number of packets (including error 880 packets) received that were between 881 65 and 127 octets in length inclusive 882 (excluding framing bits but including FCS octets)." 883 ::= { etherStatsEntry 15 } 885 etherStatsPkts128to255Octets OBJECT-TYPE 886 SYNTAX Counter 887 ACCESS read-only 888 STATUS mandatory 889 DESCRIPTION 890 "The total number of packets (including error 891 packets) received that were between 892 128 and 255 octets in length inclusive 893 (excluding framing bits but including FCS octets)." 894 ::= { etherStatsEntry 16 } 896 etherStatsPkts256to511Octets OBJECT-TYPE 897 SYNTAX Counter 898 ACCESS read-only 899 STATUS mandatory 900 DESCRIPTION 901 "The total number of packets (including error 902 packets) received that were between 903 256 and 511 octets in length inclusive 904 (excluding framing bits but including FCS octets)." 905 ::= { etherStatsEntry 17 } 907 etherStatsPkts512to1023Octets OBJECT-TYPE 908 SYNTAX Counter 909 ACCESS read-only 910 STATUS mandatory 911 DESCRIPTION 912 "The total number of packets (including error 913 packets) received that were between 914 512 and 1023 octets in length inclusive 915 (excluding framing bits but including FCS octets)." 916 ::= { etherStatsEntry 18 } 918 etherStatsPkts1024to1518Octets OBJECT-TYPE 919 SYNTAX Counter 920 ACCESS read-only 921 STATUS mandatory 922 DESCRIPTION 923 "The total number of packets (including error 924 packets) received that were between 925 1024 and 1518 octets in length inclusive 926 (excluding framing bits but including FCS octets)." 927 ::= { etherStatsEntry 19 } 929 etherStatsOwner OBJECT-TYPE 930 SYNTAX OwnerString 931 ACCESS read-write 932 STATUS mandatory 933 DESCRIPTION 934 "The entity that configured this entry and is therefore 935 using the resources assigned to it." 936 ::= { etherStatsEntry 20 } 938 etherStatsStatus OBJECT-TYPE 939 SYNTAX EntryStatus 940 ACCESS read-write 941 STATUS mandatory 942 DESCRIPTION 943 "The status of this etherStats entry." 944 ::= { etherStatsEntry 21 } 946 -- The History Control Group 948 -- Implementation of the History Control group is optional. 949 -- 950 -- The history control group controls the periodic statistical 951 -- sampling of data from various types of networks. The 952 -- historyControl table stores configuration entries that each 953 -- define an interface, polling period, and other parameters. 954 -- Once samples are taken, their data is stored in an entry 955 -- in a media-specific table. Each such entry defines one 956 -- sample, and is associated with the historyControlEntry that 957 -- caused the sample to be taken. 958 -- 959 -- If the probe keeps track of the time of day, it should start 960 -- the first sample of the history at a time such that 961 -- when the next hour of the day begins, a sample is 962 -- started at that instant. This tends to make more 963 -- user-friendly reports, and enables comparison of reports 964 -- from different probes that have relatively accurate time 965 -- of day. 966 -- 967 -- The monitor is encouraged to add two history control entries 968 -- per monitored interface upon initialization that describe a short 969 -- term and a long term polling period. Suggested parameters are 30 970 -- seconds for the short term polling period and 30 minutes for 971 -- the long term period. 973 historyControlTable OBJECT-TYPE 974 SYNTAX SEQUENCE OF HistoryControlEntry 975 ACCESS not-accessible 976 STATUS mandatory 977 DESCRIPTION 978 "A list of history control entries." 979 ::= { history 1 } 981 historyControlEntry OBJECT-TYPE 982 SYNTAX HistoryControlEntry 983 ACCESS not-accessible 984 STATUS mandatory 985 DESCRIPTION 986 "A list of parameters that set up a periodic sampling of 987 statistics. As an example, an instance of the 988 historyControlInterval object might be named 989 historyControlInterval.2" 990 INDEX { historyControlIndex } 991 ::= { historyControlTable 1 } 993 HistoryControlEntry ::= SEQUENCE { 994 historyControlIndex INTEGER (1..65535), 995 historyControlDataSource OBJECT IDENTIFIER, 996 historyControlBucketsRequested INTEGER (1..65535), 997 historyControlBucketsGranted INTEGER (1..65535), 998 historyControlInterval INTEGER (1..3600), 999 historyControlOwner OwnerString, 1000 historyControlStatus EntryStatus 1001 } 1003 historyControlIndex OBJECT-TYPE 1004 SYNTAX INTEGER (1..65535) 1005 ACCESS read-only 1006 STATUS mandatory 1007 DESCRIPTION 1008 "An index that uniquely identifies an entry in the 1009 historyControl table. Each such entry defines a 1010 set of samples at a particular interval for an 1011 interface on the device." 1012 ::= { historyControlEntry 1 } 1014 historyControlDataSource OBJECT-TYPE 1015 SYNTAX OBJECT IDENTIFIER 1016 ACCESS read-write 1017 STATUS mandatory 1018 DESCRIPTION 1019 "This object identifies the source of the data for 1020 which historical data was collected and 1021 placed in a media-specific table on behalf of this 1022 historyControlEntry. This source can be any 1023 interface on this device. In order to identify 1024 a particular interface, this object shall identify 1025 the instance of the ifIndex object, defined 1026 in [4,6], for the desired interface. For example, 1027 if an entry were to receive data from interface #1, 1028 this object would be set to ifIndex.1. 1030 The statistics in this group reflect all packets 1031 on the local network segment attached to the identified 1032 interface. 1034 An agent may or may not be able to tell if fundamental 1035 changes to the media of the interface have occurred and 1036 necessitate an invalidation of this entry. For example, a 1037 hot-pluggable ethernet card could be pulled out and replaced 1038 by a token-ring card. In such a case, if the agent has such 1039 knowledge of the change, it is recommended that it invalidate 1040 this entry. 1042 This object may not be modified if the associated 1043 historyControlStatus object is equal to valid(1)." 1044 ::= { historyControlEntry 2 } 1046 historyControlBucketsRequested OBJECT-TYPE 1047 SYNTAX INTEGER (1..65535) 1048 ACCESS read-write 1049 STATUS mandatory 1050 DESCRIPTION 1051 "The requested number of discrete time intervals 1052 over which data is to be saved in the part of the 1053 media-specific table associated with this 1054 historyControl entry. 1056 When this object is created or modified, the probe 1057 should set historyControlBucketsGranted as closely to 1058 this object as is possible for the particular probe 1059 implementation and available resources." 1060 DEFVAL { 50 } 1061 ::= { historyControlEntry 3 } 1063 historyControlBucketsGranted OBJECT-TYPE 1064 SYNTAX INTEGER (1..65535) 1065 ACCESS read-only 1066 STATUS mandatory 1067 DESCRIPTION 1068 "The number of discrete sampling intervals 1069 over which data shall be saved in the part of 1070 the media-specific table associated with this 1071 historyControl entry. 1073 When the associated historyControlBucketsRequested 1074 object is created or modified, the probe 1075 should set this object as closely to the requested 1076 value as is possible for the particular 1077 probe implementation and available resources. The 1078 probe must not lower this value except as a result 1079 of a modification to the associated 1080 historyControlBucketsRequested object. 1082 There will be times when the actual number of 1083 buckets associated with this entry is less than 1084 the value of this object. In this case, at the 1085 end of each sampling interval, a new bucket will 1086 be added to the media-specific table. 1088 When the number of buckets reaches the value of 1089 this object and a new bucket is to be added to the 1090 media-specific table, the oldest bucket associated 1091 with this historyControlEntry shall be deleted by 1092 the agent so that the new bucket can be added. 1094 When the value of this object changes to a value less 1095 than the current value, entries are deleted 1096 from the media-specific table associated with this 1097 historyControlEntry. Enough of the oldest of these 1098 entries shall be deleted by the agent so that their 1099 number remains less than or equal to the new value of 1100 this object. 1102 When the value of this object changes to a value greater 1103 than the current value, the number of associated media- 1104 specific entries may be allowed to grow." 1105 ::= { historyControlEntry 4 } 1107 historyControlInterval OBJECT-TYPE 1108 SYNTAX INTEGER (1..3600) 1109 ACCESS read-write 1110 STATUS mandatory 1111 DESCRIPTION 1112 "The interval in seconds over which the data is 1113 sampled for each bucket in the part of the 1114 media-specific table associated with this 1115 historyControl entry. This interval can 1116 be set to any number of seconds between 1 and 1117 3600 (1 hour). 1119 Because the counters in a bucket may overflow at their 1120 maximum value with no indication, a prudent manager will 1121 take into account the possibility of overflow in any of 1122 the associated counters. It is important to consider the 1123 minimum time in which any counter could overflow on a 1124 particular media type and set the historyControlInterval 1125 object to a value less than this interval. This is 1126 typically most important for the 'octets' counter in any 1127 media-specific table. For example, on an Ethernet 1128 network, the etherHistoryOctets counter could overflow 1129 in about one hour at the Ethernet's maximum 1130 utilization. 1132 This object may not be modified if the associated 1133 historyControlStatus object is equal to valid(1)." 1134 DEFVAL { 1800 } 1135 ::= { historyControlEntry 5 } 1137 historyControlOwner OBJECT-TYPE 1138 SYNTAX OwnerString 1139 ACCESS read-write 1140 STATUS mandatory 1141 DESCRIPTION 1142 "The entity that configured this entry and is therefore 1143 using the resources assigned to it." 1144 ::= { historyControlEntry 6 } 1146 historyControlStatus OBJECT-TYPE 1147 SYNTAX EntryStatus 1148 ACCESS read-write 1149 STATUS mandatory 1150 DESCRIPTION 1151 "The status of this historyControl entry. 1153 Each instance of the media-specific table associated 1154 with this historyControlEntry will be deleted by the agent 1155 if this historyControlEntry is not equal to valid(1)." 1156 ::= { historyControlEntry 7 } 1158 -- The Ethernet History Group 1160 -- Implementation of the Ethernet History group is optional. 1161 -- 1162 -- The ethernet history group records periodic statistical samples 1163 -- from a network and stores them for later retrieval. 1164 -- Once samples are taken, their data is stored in an entry 1165 -- in a media-specific table. Each such entry defines one 1166 -- sample, and is associated with the historyControlEntry that 1167 -- caused the sample to be taken. This group defines the 1168 -- etherHistoryTable, for Ethernet networks. 1169 -- 1171 etherHistoryTable OBJECT-TYPE 1172 SYNTAX SEQUENCE OF EtherHistoryEntry 1173 ACCESS not-accessible 1174 STATUS mandatory 1175 DESCRIPTION 1176 "A list of Ethernet history entries." 1177 ::= { history 2 } 1179 etherHistoryEntry OBJECT-TYPE 1180 SYNTAX EtherHistoryEntry 1181 ACCESS not-accessible 1182 STATUS mandatory 1183 DESCRIPTION 1184 "An historical sample of Ethernet statistics on a particular 1185 Ethernet interface. This sample is associated with the 1186 historyControlEntry which set up the parameters for 1187 a regular collection of these samples. As an example, an 1188 instance of the etherHistoryPkts object might be named 1189 etherHistoryPkts.2.89" 1190 INDEX { etherHistoryIndex , etherHistorySampleIndex } 1191 ::= { etherHistoryTable 1 } 1193 EtherHistoryEntry ::= SEQUENCE { 1194 etherHistoryIndex INTEGER (1..65535), 1195 etherHistorySampleIndex INTEGER (1..2147483647), 1196 etherHistoryIntervalStart TimeTicks, 1197 etherHistoryDropEvents Counter, 1198 etherHistoryOctets Counter, 1199 etherHistoryPkts Counter, 1200 etherHistoryBroadcastPkts Counter, 1201 etherHistoryMulticastPkts Counter, 1202 etherHistoryCRCAlignErrors Counter, 1203 etherHistoryUndersizePkts Counter, 1204 etherHistoryOversizePkts Counter, 1205 etherHistoryFragments Counter, 1206 etherHistoryJabbers Counter, 1207 etherHistoryCollisions Counter, 1208 etherHistoryUtilization INTEGER (0..10000) 1209 } 1211 etherHistoryIndex OBJECT-TYPE 1212 SYNTAX INTEGER (1..65535) 1213 ACCESS read-only 1214 STATUS mandatory 1215 DESCRIPTION 1216 "The history of which this entry is a part. The 1217 history identified by a particular value of this 1218 index is the same history as identified 1219 by the same value of historyControlIndex." 1220 ::= { etherHistoryEntry 1 } 1222 etherHistorySampleIndex OBJECT-TYPE 1223 SYNTAX INTEGER (1..2147483647) 1224 ACCESS read-only 1225 STATUS mandatory 1226 DESCRIPTION 1227 "An index that uniquely identifies the particular 1228 sample this entry represents among all samples 1229 associated with the same historyControlEntry. 1230 This index starts at 1 and increases by one 1231 as each new sample is taken." 1232 ::= { etherHistoryEntry 2 } 1234 etherHistoryIntervalStart OBJECT-TYPE 1235 SYNTAX TimeTicks 1236 ACCESS read-only 1237 STATUS mandatory 1238 DESCRIPTION 1239 "The value of sysUpTime at the start of the interval 1240 over which this sample was measured. If the probe 1241 keeps track of the time of day, it should start 1242 the first sample of the history at a time such that 1243 when the next hour of the day begins, a sample is 1244 started at that instant. Note that following this 1245 rule may require the probe to delay collecting the 1246 first sample of the history, as each sample must be 1247 of the same interval. Also note that the sample which 1248 is currently being collected is not accessible in this 1249 table until the end of its interval." 1250 ::= { etherHistoryEntry 3 } 1252 etherHistoryDropEvents OBJECT-TYPE 1253 SYNTAX Counter 1254 ACCESS read-only 1255 STATUS mandatory 1256 DESCRIPTION 1257 "The total number of events in which packets 1258 were dropped by the probe due to lack of resources 1259 during this sampling interval. Note that this number 1260 is not necessarily the number of packets dropped, it 1261 is just the number of times this condition has been 1262 detected." 1263 ::= { etherHistoryEntry 4 } 1265 etherHistoryOctets OBJECT-TYPE 1266 SYNTAX Counter 1267 ACCESS read-only 1268 STATUS mandatory 1269 DESCRIPTION 1270 "The total number of octets of data (including 1271 those in bad packets) received on the 1272 network (excluding framing bits but including 1273 FCS octets)." 1274 ::= { etherHistoryEntry 5 } 1276 etherHistoryPkts OBJECT-TYPE 1277 SYNTAX Counter 1278 ACCESS read-only 1279 STATUS mandatory 1280 DESCRIPTION 1281 "The number of packets (including error packets) 1282 received during this sampling interval." 1283 ::= { etherHistoryEntry 6 } 1285 etherHistoryBroadcastPkts OBJECT-TYPE 1286 SYNTAX Counter 1287 ACCESS read-only 1288 STATUS mandatory 1289 DESCRIPTION 1290 "The number of good packets received during this 1291 sampling interval that were directed to the 1292 broadcast address." 1294 ::= { etherHistoryEntry 7 } 1296 etherHistoryMulticastPkts OBJECT-TYPE 1297 SYNTAX Counter 1298 ACCESS read-only 1299 STATUS mandatory 1300 DESCRIPTION 1301 "The number of good packets received during this 1302 sampling interval that were directed to a 1303 multicast address. Note that this number does not 1304 include packets addressed to the broadcast address." 1305 ::= { etherHistoryEntry 8 } 1307 etherHistoryCRCAlignErrors OBJECT-TYPE 1308 SYNTAX Counter 1309 ACCESS read-only 1310 STATUS mandatory 1311 DESCRIPTION 1312 "The number of packets received during this 1313 sampling interval that had a length (excluding 1314 framing bits but including FCS octets) between 1315 64 and 1518 octets, inclusive, but had either a bad Frame 1316 Check Sequence (FCS) with an integral number of octets 1317 (FCS Error) or a bad FCS with a non-integral number 1318 of octets (Alignment Error)." 1319 ::= { etherHistoryEntry 9 } 1321 etherHistoryUndersizePkts OBJECT-TYPE 1322 SYNTAX Counter 1323 ACCESS read-only 1324 STATUS mandatory 1325 DESCRIPTION 1326 "The number of packets received during this 1327 sampling interval that were less than 64 octets 1328 long (excluding framing bits but including FCS 1329 octets) and were otherwise well formed." 1330 ::= { etherHistoryEntry 10 } 1332 etherHistoryOversizePkts OBJECT-TYPE 1333 SYNTAX Counter 1334 ACCESS read-only 1335 STATUS mandatory 1336 DESCRIPTION 1337 "The number of packets received during this 1338 sampling interval that were longer than 1518 1340 octets (excluding framing bits but including 1341 FCS octets) but were otherwise well formed." 1342 ::= { etherHistoryEntry 11 } 1344 etherHistoryFragments OBJECT-TYPE 1345 SYNTAX Counter 1346 ACCESS read-only 1347 STATUS mandatory 1348 DESCRIPTION 1349 "The total number of packets received during this 1350 sampling interval that were less than 64 octets in 1351 length (excluding framing bits but including FCS 1352 octets) had either a bad Frame Check Sequence (FCS) 1353 with an integral number of octets (FCS Error) or a bad 1354 FCS with a non-integral number of octets (Alignment 1355 Error). 1357 Note that it is entirely normal for etherHistoryFragments to 1358 increment. This is because it counts both runts (which are 1359 normal occurrences due to collisions) and noise hits." 1360 ::= { etherHistoryEntry 12 } 1362 etherHistoryJabbers OBJECT-TYPE 1363 SYNTAX Counter 1364 ACCESS read-only 1365 STATUS mandatory 1366 DESCRIPTION 1367 "The number of packets received during this 1368 sampling interval that were longer than 1518 octets 1369 (excluding framing bits but including FCS octets), 1370 and had either a bad Frame Check Sequence (FCS) 1371 with an integral number of octets (FCS Error) or 1372 a bad FCS with a non-integral number of octets 1373 (Alignment Error). 1375 Note that this definition of jabber is different 1376 than the definition in IEEE-802.3 section 8.2.1.5 1377 (10BASE5) and section 10.3.1.4 (10BASE2). These 1378 documents define jabber as the condition where any 1379 packet exceeds 20 ms. The allowed range to detect 1380 jabber is between 20 ms and 150 ms." 1381 ::= { etherHistoryEntry 13 } 1383 etherHistoryCollisions OBJECT-TYPE 1384 SYNTAX Counter 1385 ACCESS read-only 1386 STATUS mandatory 1387 DESCRIPTION 1388 "The best estimate of the total number of collisions 1389 on this Ethernet segment during this sampling 1390 interval. 1392 The value returned will depend on the location of the 1393 RMON probe. Section 8.2.1.3 (10BASE-5) and section 1394 10.3.1.3 (10BASE-2) of IEEE standard 802.3 states that a 1395 station must detect a collision, in the receive mode, if 1396 three or more stations are transmitting simultaneously. A 1397 repeater port must detect a collision when two or more 1398 stations are transmitting simultaneously. Thus a probe 1399 placed on a repeater port could record more collisions 1400 than a probe connected to a station on the same segment 1401 would. 1403 Probe location plays a much smaller role when considering 1404 10BASE-T. 14.2.1.4 (10BASE-T) of IEEE standard 802.3 1405 defines a collision as the simultaneous presence of signals 1406 on the DO and RD circuits (transmitting and receiving 1407 at the same time). A 10BASE-T station can only detect 1408 collisions when it is transmitting. Thus probes placed on 1409 a station and a repeater, should report the same number of 1410 collisions. 1412 Note also that an RMON probe inside a repeater should 1413 ideally report collisions between the repeater and one or 1414 more other hosts (transmit collisions as defined by IEEE 1415 802.3k) plus receiver collisions observed on any coax 1416 segments to which the repeater is connected." 1417 ::= { etherHistoryEntry 14 } 1419 etherHistoryUtilization OBJECT-TYPE 1420 SYNTAX INTEGER (0..10000) 1421 ACCESS read-only 1422 STATUS mandatory 1423 DESCRIPTION 1424 "The best estimate of the mean physical layer 1425 network utilization on this interface during this 1426 sampling interval, in hundredths of a percent." 1427 ::= { etherHistoryEntry 15 } 1429 -- The Alarm Group 1431 -- Implementation of the Alarm group is optional. 1432 -- 1433 -- The Alarm Group requires the implementation of the Event group. 1434 -- 1435 -- The Alarm group periodically takes statistical samples from 1436 -- variables in the probe and compares them to thresholds that have 1437 -- been configured. The alarm table stores configuration 1438 -- entries that each define a variable, polling period, and 1439 -- threshold parameters. If a sample is found to cross the 1440 -- threshold values, an event is generated. Only variables that 1441 -- resolve to an ASN.1 primitive type of INTEGER (INTEGER, Counter, 1442 -- Gauge, or TimeTicks) may be monitored in this way. 1443 -- 1444 -- This function has a hysteresis mechanism to limit the generation 1445 -- of events. This mechanism generates one event as a threshold 1446 -- is crossed in the appropriate direction. No more events are 1447 -- generated for that threshold until the opposite threshold is 1448 -- crossed. 1449 -- 1450 -- In the case of a sampling a deltaValue, a probe may implement 1451 -- this mechanism with more precision if it takes a delta sample 1452 -- twice per period, each time comparing the sum of the latest two 1453 -- samples to the threshold. This allows the detection of threshold 1454 -- crossings that span the sampling boundary. Note that this does 1455 -- not require any special configuration of the threshold value. 1456 -- It is suggested that probes implement this more precise algorithm. 1458 alarmTable OBJECT-TYPE 1459 SYNTAX SEQUENCE OF AlarmEntry 1460 ACCESS not-accessible 1461 STATUS mandatory 1462 DESCRIPTION 1463 "A list of alarm entries." 1464 ::= { alarm 1 } 1466 alarmEntry OBJECT-TYPE 1467 SYNTAX AlarmEntry 1468 ACCESS not-accessible 1469 STATUS mandatory 1470 DESCRIPTION 1471 "A list of parameters that set up a periodic checking 1472 for alarm conditions. For example, an instance of the 1473 alarmValue object might be named alarmValue.8" 1475 INDEX { alarmIndex } 1476 ::= { alarmTable 1 } 1478 AlarmEntry ::= SEQUENCE { 1479 alarmIndex INTEGER (1..65535), 1480 alarmInterval INTEGER, 1481 alarmVariable OBJECT IDENTIFIER, 1482 alarmSampleType INTEGER, 1483 alarmValue INTEGER, 1484 alarmStartupAlarm INTEGER, 1485 alarmRisingThreshold INTEGER, 1486 alarmFallingThreshold INTEGER, 1487 alarmRisingEventIndex INTEGER (0..65535), 1488 alarmFallingEventIndex INTEGER (0..65535), 1489 alarmOwner OwnerString, 1490 alarmStatus EntryStatus 1491 } 1493 alarmIndex OBJECT-TYPE 1494 SYNTAX INTEGER (1..65535) 1495 ACCESS read-only 1496 STATUS mandatory 1497 DESCRIPTION 1498 "An index that uniquely identifies an entry in the 1499 alarm table. Each such entry defines a 1500 diagnostic sample at a particular interval 1501 for an object on the device." 1502 ::= { alarmEntry 1 } 1504 alarmInterval OBJECT-TYPE 1505 SYNTAX INTEGER 1506 ACCESS read-write 1507 STATUS mandatory 1508 DESCRIPTION 1509 "The interval in seconds over which the data is 1510 sampled and compared with the rising and falling 1511 thresholds. When setting this variable, care 1512 should be given to ensure that the variable being 1513 monitored will not exceed 2^31 - 1 and roll 1514 over the alarmValue object during the interval. 1516 This object may not be modified if the associated 1517 alarmStatus object is equal to valid(1)." 1518 ::= { alarmEntry 2 } 1520 alarmVariable OBJECT-TYPE 1521 SYNTAX OBJECT IDENTIFIER 1522 ACCESS read-write 1523 STATUS mandatory 1524 DESCRIPTION 1525 "The object identifier of the particular variable to be 1526 sampled. Only variables that resolve to an ASN.1 primitive 1527 type of INTEGER (INTEGER, Counter, Gauge, or TimeTicks) 1528 may be sampled. 1530 Because SNMP access control is articulated entirely 1531 in terms of the contents of MIB views, no access 1532 control mechanism exists that can restrict the value of 1533 this object to identify only those objects that exist 1534 in a particular MIB view. Because there is thus no 1535 acceptable means of restricting the read access that 1536 could be obtained through the alarm mechanism, the 1537 probe must only grant write access to this object in 1538 those views that have read access to all objects on 1539 the probe. 1541 During a set operation, if the supplied variable name is 1542 not available in the selected MIB view, a badValue error 1543 must be returned. If at any time the variable name of 1544 an established alarmEntry is no longer available in the 1545 selected MIB view, the probe must change the status of 1546 this alarmEntry to invalid(4). 1548 This object may not be modified if the associated 1549 alarmStatus object is equal to valid(1)." 1550 ::= { alarmEntry 3 } 1552 alarmSampleType OBJECT-TYPE 1553 SYNTAX INTEGER { 1554 absoluteValue(1), 1555 deltaValue(2) 1556 } 1557 ACCESS read-write 1558 STATUS mandatory 1559 DESCRIPTION 1560 "The method of sampling the selected variable and 1561 calculating the value to be compared against the 1562 thresholds. If the value of this object is 1563 absoluteValue(1), the value of the selected variable 1564 will be compared directly with the thresholds at the 1565 end of the sampling interval. If the value of this 1566 object is deltaValue(2), the value of the selected 1567 variable at the last sample will be subtracted from 1568 the current value, and the difference compared with 1569 the thresholds. 1571 This object may not be modified if the associated 1572 alarmStatus object is equal to valid(1)." 1573 ::= { alarmEntry 4 } 1575 alarmValue OBJECT-TYPE 1576 SYNTAX INTEGER 1577 ACCESS read-only 1578 STATUS mandatory 1579 DESCRIPTION 1580 "The value of the statistic during the last sampling 1581 period. The value during the current sampling period 1582 is not made available until the period is completed." 1583 ::= { alarmEntry 5 } 1585 alarmStartupAlarm OBJECT-TYPE 1586 SYNTAX INTEGER { 1587 risingAlarm(1), 1588 fallingAlarm(2), 1589 risingOrFallingAlarm(3) 1590 } 1591 ACCESS read-write 1592 STATUS mandatory 1593 DESCRIPTION 1594 "The alarm that may be sent when this entry is first 1595 set to valid. If the first sample after this entry 1596 becomes valid is greater than or equal to the 1597 risingThreshold and alarmStartupAlarm is equal to 1598 risingAlarm(1) or risingOrFallingAlarm(3), then a single 1599 rising alarm will be generated. If the first sample 1600 after this entry becomes valid is less than or equal 1601 to the fallingThreshold and alarmStartupAlarm is equal 1602 to fallingAlarm(2) or risingOrFallingAlarm(3), then a 1603 single falling alarm will be generated. 1605 This object may not be modified if the associated 1606 alarmStatus object is equal to valid(1)." 1607 ::= { alarmEntry 6 } 1609 alarmRisingThreshold OBJECT-TYPE 1610 SYNTAX INTEGER 1611 ACCESS read-write 1612 STATUS mandatory 1613 DESCRIPTION 1614 "A threshold for the sampled statistic. When the current 1615 sampled value is greater than or equal to this threshold, 1616 and the value at the last sampling interval was less than 1617 this threshold, a single event will be generated. 1618 A single event will also be generated if the first 1619 sample after this entry becomes valid is greater than or 1620 equal to this threshold and the associated 1621 alarmStartupAlarm is equal to risingAlarm(1) or 1622 risingOrFallingAlarm(3). 1624 After a rising event is generated, another such event 1625 will not be generated until the sampled value 1626 falls below this threshold and reaches the 1627 alarmFallingThreshold. 1629 This object may not be modified if the associated 1630 alarmStatus object is equal to valid(1)." 1631 ::= { alarmEntry 7 } 1633 alarmFallingThreshold OBJECT-TYPE 1634 SYNTAX INTEGER 1635 ACCESS read-write 1636 STATUS mandatory 1637 DESCRIPTION 1638 "A threshold for the sampled statistic. When the current 1639 sampled value is less than or equal to this threshold, 1640 and the value at the last sampling interval was greater than 1641 this threshold, a single event will be generated. 1642 A single event will also be generated if the first 1643 sample after this entry becomes valid is less than or 1644 equal to this threshold and the associated 1645 alarmStartupAlarm is equal to fallingAlarm(2) or 1646 risingOrFallingAlarm(3). 1648 After a falling event is generated, another such event 1649 will not be generated until the sampled value 1650 rises above this threshold and reaches the 1651 alarmRisingThreshold. 1653 This object may not be modified if the associated 1654 alarmStatus object is equal to valid(1)." 1656 ::= { alarmEntry 8 } 1658 alarmRisingEventIndex OBJECT-TYPE 1659 SYNTAX INTEGER (0..65535) 1660 ACCESS read-write 1661 STATUS mandatory 1662 DESCRIPTION 1663 "The index of the eventEntry that is 1664 used when a rising threshold is crossed. The 1665 eventEntry identified by a particular value of 1666 this index is the same as identified by the same value 1667 of the eventIndex object. If there is no 1668 corresponding entry in the eventTable, then 1669 no association exists. In particular, if this value 1670 is zero, no associated event will be generated, as 1671 zero is not a valid event index. 1673 This object may not be modified if the associated 1674 alarmStatus object is equal to valid(1)." 1675 ::= { alarmEntry 9 } 1677 alarmFallingEventIndex OBJECT-TYPE 1678 SYNTAX INTEGER (0..65535) 1679 ACCESS read-write 1680 STATUS mandatory 1681 DESCRIPTION 1682 "The index of the eventEntry that is 1683 used when a falling threshold is crossed. The 1684 eventEntry identified by a particular value of 1685 this index is the same as identified by the same value 1686 of the eventIndex object. If there is no 1687 corresponding entry in the eventTable, then 1688 no association exists. In particular, if this value 1689 is zero, no associated event will be generated, as 1690 zero is not a valid event index. 1692 This object may not be modified if the associated 1693 alarmStatus object is equal to valid(1)." 1694 ::= { alarmEntry 10 } 1696 alarmOwner OBJECT-TYPE 1697 SYNTAX OwnerString 1698 ACCESS read-write 1699 STATUS mandatory 1700 DESCRIPTION 1701 "The entity that configured this entry and is therefore 1702 using the resources assigned to it." 1703 ::= { alarmEntry 11 } 1705 alarmStatus OBJECT-TYPE 1706 SYNTAX EntryStatus 1707 ACCESS read-write 1708 STATUS mandatory 1709 DESCRIPTION 1710 "The status of this alarm entry." 1711 ::= { alarmEntry 12 } 1713 -- The Host Group 1715 -- Implementation of the Host group is optional. 1716 -- 1717 -- The host group discovers new hosts on the network by 1718 -- keeping a list of source and destination MAC Addresses seen 1719 -- in good packets. For each of these addresses, the host group 1720 -- keeps a set of statistics. The hostControlTable controls 1721 -- which interfaces this function is performed on, and contains 1722 -- some information about the process. On behalf of each 1723 -- hostControlEntry, data is collected on an interface and placed 1724 -- in both the hostTable and the hostTimeTable. If the 1725 -- monitoring device finds itself short of resources, it may 1726 -- delete entries as needed. It is suggested that the device 1727 -- delete the least recently used entries first. 1729 -- The hostTable contains entries for each address discovered on 1730 -- a particular interface. Each entry contains statistical 1731 -- data about that host. This table is indexed by the 1732 -- MAC address of the host, through which a random access 1733 -- may be achieved. 1735 -- The hostTimeTable contains data in the same format as the 1736 -- hostTable, and must contain the same set of hosts, but is 1737 -- indexed using hostTimeCreationOrder rather than hostAddress. 1738 -- The hostTimeCreationOrder is an integer which reflects 1739 -- the relative order in which a particular entry was discovered 1740 -- and thus inserted into the table. As this order, and thus 1741 -- the index, is among those entries currently in the table, 1742 -- the index for a particular entry may change if an 1743 -- (earlier) entry is deleted. Thus the association between 1744 -- hostTimeCreationOrder and hostTimeEntry may be broken at 1745 -- any time. 1747 -- The hostTimeTable has two important uses. The first is the 1748 -- fast download of this potentially large table. Because the 1749 -- index of this table runs from 1 to the size of the table, 1750 -- inclusive, its values are predictable. This allows very 1751 -- efficient packing of variables into SNMP PDU's and allows 1752 -- a table transfer to have multiple packets outstanding. 1753 -- These benefits increase transfer rates tremendously. 1755 -- The second use of the hostTimeTable is the efficient discovery 1756 -- by the management station of new entries added to the table. 1757 -- After the management station has downloaded the entire table, 1758 -- it knows that new entries will be added immediately after the 1759 -- end of the current table. It can thus detect new entries there 1760 -- and retrieve them easily. 1762 -- Because the association between hostTimeCreationOrder and 1763 -- hostTimeEntry may be broken at any time, the management 1764 -- station must monitor the related hostControlLastDeleteTime 1765 -- object. When the management station thus detects a deletion, 1766 -- it must assume that any such associations have been broken, 1767 -- and invalidate any it has stored locally. This includes 1768 -- restarting any download of the hostTimeTable that may have been 1769 -- in progress, as well as rediscovering the end of the 1770 -- hostTimeTable so that it may detect new entries. If the 1771 -- management station does not detect the broken association, 1772 -- it may continue to refer to a particular host by its 1773 -- creationOrder while unwittingly retrieving the data associated 1774 -- with another host entirely. If this happens while downloading 1775 -- the host table, the management station may fail to download 1776 -- all of the entries in the table. 1778 hostControlTable OBJECT-TYPE 1779 SYNTAX SEQUENCE OF HostControlEntry 1780 ACCESS not-accessible 1781 STATUS mandatory 1782 DESCRIPTION 1783 "A list of host table control entries." 1784 ::= { hosts 1 } 1786 hostControlEntry OBJECT-TYPE 1787 SYNTAX HostControlEntry 1788 ACCESS not-accessible 1789 STATUS mandatory 1790 DESCRIPTION 1791 "A list of parameters that set up the discovery of hosts 1792 on a particular interface and the collection of statistics 1793 about these hosts. For example, an instance of the 1794 hostControlTableSize object might be named 1795 hostControlTableSize.1" 1796 INDEX { hostControlIndex } 1797 ::= { hostControlTable 1 } 1799 HostControlEntry ::= SEQUENCE { 1800 hostControlIndex INTEGER (1..65535), 1801 hostControlDataSource OBJECT IDENTIFIER, 1802 hostControlTableSize INTEGER, 1803 hostControlLastDeleteTime TimeTicks, 1804 hostControlOwner OwnerString, 1805 hostControlStatus EntryStatus 1806 } 1808 hostControlIndex OBJECT-TYPE 1809 SYNTAX INTEGER (1..65535) 1810 ACCESS read-only 1811 STATUS mandatory 1812 DESCRIPTION 1813 "An index that uniquely identifies an entry in the 1814 hostControl table. Each such entry defines 1815 a function that discovers hosts on a particular interface 1816 and places statistics about them in the hostTable and 1817 the hostTimeTable on behalf of this hostControlEntry." 1818 ::= { hostControlEntry 1 } 1820 hostControlDataSource OBJECT-TYPE 1821 SYNTAX OBJECT IDENTIFIER 1822 ACCESS read-write 1823 STATUS mandatory 1824 DESCRIPTION 1825 "This object identifies the source of the data for 1826 this instance of the host function. This source 1827 can be any interface on this device. In order 1828 to identify a particular interface, this object shall 1829 identify the instance of the ifIndex object, defined 1830 in [4,6], for the desired interface. For example, 1831 if an entry were to receive data from interface #1, 1832 this object would be set to ifIndex.1. 1834 The statistics in this group reflect all packets 1835 on the local network segment attached to the identified 1836 interface. 1838 An agent may or may not be able to tell if fundamental 1839 changes to the media of the interface have occurred and 1840 necessitate an invalidation of this entry. For example, a 1841 hot-pluggable ethernet card could be pulled out and replaced 1842 by a token-ring card. In such a case, if the agent has such 1843 knowledge of the change, it is recommended that it invalidate 1844 this entry. 1846 This object may not be modified if the associated 1847 hostControlStatus object is equal to valid(1)." 1848 ::= { hostControlEntry 2 } 1850 hostControlTableSize OBJECT-TYPE 1851 SYNTAX INTEGER 1852 ACCESS read-only 1853 STATUS mandatory 1854 DESCRIPTION 1855 "The number of hostEntries in the hostTable and the 1856 hostTimeTable associated with this hostControlEntry." 1857 ::= { hostControlEntry 3 } 1859 hostControlLastDeleteTime OBJECT-TYPE 1860 SYNTAX TimeTicks 1861 ACCESS read-only 1862 STATUS mandatory 1863 DESCRIPTION 1864 "The value of sysUpTime when the last entry 1865 was deleted from the portion of the hostTable 1866 associated with this hostControlEntry. If no 1867 deletions have occurred, this value shall be zero." 1868 ::= { hostControlEntry 4 } 1870 hostControlOwner OBJECT-TYPE 1871 SYNTAX OwnerString 1872 ACCESS read-write 1873 STATUS mandatory 1874 DESCRIPTION 1875 "The entity that configured this entry and is therefore 1876 using the resources assigned to it." 1877 ::= { hostControlEntry 5 } 1879 hostControlStatus OBJECT-TYPE 1880 SYNTAX EntryStatus 1881 ACCESS read-write 1882 STATUS mandatory 1883 DESCRIPTION 1884 "The status of this hostControl entry. 1886 If this object is not equal to valid(1), all associated 1887 entries in the hostTable, hostTimeTable, and the 1888 hostTopNTable shall be deleted by the agent." 1889 ::= { hostControlEntry 6 } 1891 hostTable OBJECT-TYPE 1892 SYNTAX SEQUENCE OF HostEntry 1893 ACCESS not-accessible 1894 STATUS mandatory 1895 DESCRIPTION 1896 "A list of host entries." 1897 ::= { hosts 2 } 1899 hostEntry OBJECT-TYPE 1900 SYNTAX HostEntry 1901 ACCESS not-accessible 1902 STATUS mandatory 1903 DESCRIPTION 1904 "A collection of statistics for a particular host that has 1905 been discovered on an interface of this device. For example, 1906 an instance of the hostOutBroadcastPkts object might be 1907 named hostOutBroadcastPkts.1.6.8.0.32.27.3.176" 1908 INDEX { hostIndex, hostAddress } 1909 ::= { hostTable 1 } 1911 HostEntry ::= SEQUENCE { 1912 hostAddress OCTET STRING, 1913 hostCreationOrder INTEGER (1..65535), 1914 hostIndex INTEGER (1..65535), 1915 hostInPkts Counter, 1916 hostOutPkts Counter, 1917 hostInOctets Counter, 1918 hostOutOctets Counter, 1919 hostOutErrors Counter, 1920 hostOutBroadcastPkts Counter, 1921 hostOutMulticastPkts Counter 1922 } 1924 hostAddress OBJECT-TYPE 1925 SYNTAX OCTET STRING 1926 ACCESS read-only 1927 STATUS mandatory 1928 DESCRIPTION 1929 "The physical address of this host." 1930 ::= { hostEntry 1 } 1932 hostCreationOrder OBJECT-TYPE 1933 SYNTAX INTEGER (1..65535) 1934 ACCESS read-only 1935 STATUS mandatory 1936 DESCRIPTION 1937 "An index that defines the relative ordering of 1938 the creation time of hosts captured for a 1939 particular hostControlEntry. This index shall 1940 be between 1 and N, where N is the value of 1941 the associated hostControlTableSize. The ordering 1942 of the indexes is based on the order of each entry's 1943 insertion into the table, in which entries added earlier 1944 have a lower index value than entries added later. 1946 It is important to note that the order for a 1947 particular entry may change as an (earlier) entry 1948 is deleted from the table. Because this order may 1949 change, management stations should make use of the 1950 hostControlLastDeleteTime variable in the 1951 hostControlEntry associated with the relevant 1952 portion of the hostTable. By observing 1953 this variable, the management station may detect 1954 the circumstances where a previous association 1955 between a value of hostCreationOrder 1956 and a hostEntry may no longer hold." 1957 ::= { hostEntry 2 } 1959 hostIndex OBJECT-TYPE 1960 SYNTAX INTEGER (1..65535) 1961 ACCESS read-only 1962 STATUS mandatory 1963 DESCRIPTION 1964 "The set of collected host statistics of which 1965 this entry is a part. The set of hosts 1966 identified by a particular value of this 1967 index is associated with the hostControlEntry 1968 as identified by the same value of hostControlIndex." 1969 ::= { hostEntry 3 } 1971 hostInPkts OBJECT-TYPE 1972 SYNTAX Counter 1973 ACCESS read-only 1974 STATUS mandatory 1975 DESCRIPTION 1976 "The number of packets without errors transmitted to this 1977 address since it was added to the hostTable." 1978 ::= { hostEntry 4 } 1980 hostOutPkts OBJECT-TYPE 1981 SYNTAX Counter 1982 ACCESS read-only 1983 STATUS mandatory 1984 DESCRIPTION 1985 "The number of packets including errors transmitted by this 1986 address since it was added to the hostTable." 1987 ::= { hostEntry 5 } 1989 hostInOctets OBJECT-TYPE 1990 SYNTAX Counter 1991 ACCESS read-only 1992 STATUS mandatory 1993 DESCRIPTION 1994 "The number of octets transmitted to this address since 1995 it was added to the hostTable (excluding framing 1996 bits but including FCS octets), except for those 1997 octets in packets that contained errors." 1998 ::= { hostEntry 6 } 2000 hostOutOctets OBJECT-TYPE 2001 SYNTAX Counter 2002 ACCESS read-only 2003 STATUS mandatory 2004 DESCRIPTION 2005 "The number of octets transmitted by this address since 2006 it was added to the hostTable (excluding framing 2007 bits but including FCS octets), including those 2008 octets in packets that contained errors." 2009 ::= { hostEntry 7 } 2011 hostOutErrors OBJECT-TYPE 2012 SYNTAX Counter 2013 ACCESS read-only 2014 STATUS mandatory 2015 DESCRIPTION 2016 "The number of error packets transmitted by this address 2017 since this host was added to the hostTable." 2018 ::= { hostEntry 8 } 2020 hostOutBroadcastPkts OBJECT-TYPE 2021 SYNTAX Counter 2022 ACCESS read-only 2023 STATUS mandatory 2024 DESCRIPTION 2025 "The number of good packets transmitted by this 2026 address that were directed to the broadcast address 2027 since this host was added to the hostTable." 2028 ::= { hostEntry 9 } 2030 hostOutMulticastPkts OBJECT-TYPE 2031 SYNTAX Counter 2032 ACCESS read-only 2033 STATUS mandatory 2034 DESCRIPTION 2035 "The number of good packets transmitted by this 2036 address that were directed to a multicast address 2037 since this host was added to the hostTable. 2038 Note that this number does not include packets 2039 directed to the broadcast address." 2040 ::= { hostEntry 10 } 2042 -- host Time Table 2044 hostTimeTable OBJECT-TYPE 2045 SYNTAX SEQUENCE OF HostTimeEntry 2046 ACCESS not-accessible 2047 STATUS mandatory 2048 DESCRIPTION 2049 "A list of time-ordered host table entries." 2050 ::= { hosts 3 } 2052 hostTimeEntry OBJECT-TYPE 2053 SYNTAX HostTimeEntry 2054 ACCESS not-accessible 2055 STATUS mandatory 2056 DESCRIPTION 2057 "A collection of statistics for a particular host that has 2058 been discovered on an interface of this device. This 2059 collection includes the relative ordering of the creation 2060 time of this object. For example, an instance of the 2061 hostTimeOutBroadcastPkts object might be named 2062 hostTimeOutBroadcastPkts.1.687" 2063 INDEX { hostTimeIndex, hostTimeCreationOrder } 2064 ::= { hostTimeTable 1 } 2066 HostTimeEntry ::= SEQUENCE { 2067 hostTimeAddress OCTET STRING, 2068 hostTimeCreationOrder INTEGER (1..65535), 2069 hostTimeIndex INTEGER (1..65535), 2070 hostTimeInPkts Counter, 2071 hostTimeOutPkts Counter, 2072 hostTimeInOctets Counter, 2073 hostTimeOutOctets Counter, 2074 hostTimeOutErrors Counter, 2075 hostTimeOutBroadcastPkts Counter, 2076 hostTimeOutMulticastPkts Counter 2077 } 2079 hostTimeAddress OBJECT-TYPE 2080 SYNTAX OCTET STRING 2081 ACCESS read-only 2082 STATUS mandatory 2083 DESCRIPTION 2084 "The physical address of this host." 2085 ::= { hostTimeEntry 1 } 2087 hostTimeCreationOrder OBJECT-TYPE 2088 SYNTAX INTEGER (1..65535) 2089 ACCESS read-only 2090 STATUS mandatory 2091 DESCRIPTION 2092 "An index that uniquely identifies an entry in 2093 the hostTime table among those entries associated 2094 with the same hostControlEntry. This index shall 2095 be between 1 and N, where N is the value of 2096 the associated hostControlTableSize. The ordering 2097 of the indexes is based on the order of each entry's 2098 insertion into the table, in which entries added earlier 2099 have a lower index value than entries added later. 2100 Thus the management station has the ability to 2101 learn of new entries added to this table without 2102 downloading the entire table. 2104 It is important to note that the index for a 2105 particular entry may change as an (earlier) entry 2106 is deleted from the table. Because this order may 2107 change, management stations should make use of the 2108 hostControlLastDeleteTime variable in the 2109 hostControlEntry associated with the relevant 2110 portion of the hostTimeTable. By observing 2111 this variable, the management station may detect 2112 the circumstances where a download of the table 2113 may have missed entries, and where a previous 2114 association between a value of hostTimeCreationOrder 2115 and a hostTimeEntry may no longer hold." 2116 ::= { hostTimeEntry 2 } 2118 hostTimeIndex OBJECT-TYPE 2119 SYNTAX INTEGER (1..65535) 2120 ACCESS read-only 2121 STATUS mandatory 2122 DESCRIPTION 2123 "The set of collected host statistics of which 2124 this entry is a part. The set of hosts 2125 identified by a particular value of this 2126 index is associated with the hostControlEntry 2127 as identified by the same value of hostControlIndex." 2128 ::= { hostTimeEntry 3 } 2130 hostTimeInPkts OBJECT-TYPE 2131 SYNTAX Counter 2132 ACCESS read-only 2133 STATUS mandatory 2134 DESCRIPTION 2135 "The number of packets without errors transmitted to this 2136 address since it was added to the hostTimeTable." 2137 ::= { hostTimeEntry 4 } 2139 hostTimeOutPkts OBJECT-TYPE 2140 SYNTAX Counter 2141 ACCESS read-only 2142 STATUS mandatory 2143 DESCRIPTION 2144 "The number of packets including errors transmitted by this 2145 address since it was added to the hostTimeTable." 2146 ::= { hostTimeEntry 5 } 2148 hostTimeInOctets OBJECT-TYPE 2149 SYNTAX Counter 2150 ACCESS read-only 2151 STATUS mandatory 2152 DESCRIPTION 2153 "The number of octets transmitted to this address since 2154 it was added to the hostTimeTable (excluding framing 2155 bits but including FCS octets), except for those 2156 octets in packets that contained errors." 2157 ::= { hostTimeEntry 6 } 2159 hostTimeOutOctets OBJECT-TYPE 2160 SYNTAX Counter 2161 ACCESS read-only 2162 STATUS mandatory 2163 DESCRIPTION 2164 "The number of octets transmitted by this address since 2165 it was added to the hostTimeTable (excluding framing 2166 bits but including FCS octets), including those 2167 octets in packets that contained errors." 2168 ::= { hostTimeEntry 7 } 2170 hostTimeOutErrors OBJECT-TYPE 2171 SYNTAX Counter 2172 ACCESS read-only 2173 STATUS mandatory 2174 DESCRIPTION 2175 "The number of error packets transmitted by this address 2176 since this host was added to the hostTimeTable." 2177 ::= { hostTimeEntry 8 } 2179 hostTimeOutBroadcastPkts OBJECT-TYPE 2180 SYNTAX Counter 2181 ACCESS read-only 2182 STATUS mandatory 2183 DESCRIPTION 2184 "The number of good packets transmitted by this 2185 address that were directed to the broadcast address 2186 since this host was added to the hostTimeTable." 2187 ::= { hostTimeEntry 9 } 2189 hostTimeOutMulticastPkts OBJECT-TYPE 2190 SYNTAX Counter 2191 ACCESS read-only 2192 STATUS mandatory 2193 DESCRIPTION 2194 "The number of good packets transmitted by this 2195 address that were directed to a multicast address 2196 since this host was added to the hostTimeTable. 2197 Note that this number does not include packets directed 2198 to the broadcast address." 2199 ::= { hostTimeEntry 10 } 2201 -- The Host Top "N" Group 2203 -- Implementation of the Host Top N group is optional. 2204 -- 2205 -- The Host Top N group requires the implementation of the host 2206 -- group. 2207 -- 2208 -- The Host Top N group is used to prepare reports that describe 2209 -- the hosts that top a list ordered by one of their statistics. 2210 -- The available statistics are samples of one of their 2211 -- base statistics, over an interval specified by the management 2212 -- station. Thus, these statistics are rate based. The management 2213 -- station also selects how many such hosts are reported. 2215 -- The hostTopNControlTable is used to initiate the generation of 2216 -- such a report. The management station may select the parameters 2217 -- of such a report, such as which interface, which statistic, 2218 -- how many hosts, and the start and stop times of the sampling. 2219 -- When the report is prepared, entries are created in the 2220 -- hostTopNTable associated with the relevant hostTopNControlEntry. 2221 -- These entries are static for each report after it has been 2222 -- prepared. 2224 hostTopNControlTable OBJECT-TYPE 2225 SYNTAX SEQUENCE OF HostTopNControlEntry 2226 ACCESS not-accessible 2227 STATUS mandatory 2228 DESCRIPTION 2229 "A list of top N host control entries." 2230 ::= { hostTopN 1 } 2232 hostTopNControlEntry OBJECT-TYPE 2233 SYNTAX HostTopNControlEntry 2234 ACCESS not-accessible 2235 STATUS mandatory 2236 DESCRIPTION 2237 "A set of parameters that control the creation of a report 2238 of the top N hosts according to several metrics. For 2239 example, an instance of the hostTopNDuration object might 2240 be named hostTopNDuration.3" 2241 INDEX { hostTopNControlIndex } 2242 ::= { hostTopNControlTable 1 } 2244 HostTopNControlEntry ::= SEQUENCE { 2245 hostTopNControlIndex INTEGER (1..65535), 2246 hostTopNHostIndex INTEGER (1..65535), 2247 hostTopNRateBase INTEGER, 2248 hostTopNTimeRemaining INTEGER, 2249 hostTopNDuration INTEGER, 2250 hostTopNRequestedSize INTEGER, 2251 hostTopNGrantedSize INTEGER, 2252 hostTopNStartTime TimeTicks, 2253 hostTopNOwner OwnerString, 2254 hostTopNStatus EntryStatus 2255 } 2257 hostTopNControlIndex OBJECT-TYPE 2258 SYNTAX INTEGER (1..65535) 2259 ACCESS read-only 2260 STATUS mandatory 2261 DESCRIPTION 2262 "An index that uniquely identifies an entry 2263 in the hostTopNControl table. Each such 2264 entry defines one top N report prepared for 2265 one interface." 2266 ::= { hostTopNControlEntry 1 } 2268 hostTopNHostIndex OBJECT-TYPE 2269 SYNTAX INTEGER (1..65535) 2270 ACCESS read-write 2271 STATUS mandatory 2272 DESCRIPTION 2273 "The host table for which a top N report will be prepared 2274 on behalf of this entry. The host table identified by a 2275 particular value of this index is associated with the same 2276 host table as identified by the same value of 2277 hostIndex. 2279 This object may not be modified if the associated 2280 hostTopNStatus object is equal to valid(1)." 2281 ::= { hostTopNControlEntry 2 } 2283 hostTopNRateBase OBJECT-TYPE 2284 SYNTAX INTEGER { 2285 hostTopNInPkts(1), 2286 hostTopNOutPkts(2), 2287 hostTopNInOctets(3), 2288 hostTopNOutOctets(4), 2289 hostTopNOutErrors(5), 2290 hostTopNOutBroadcastPkts(6), 2291 hostTopNOutMulticastPkts(7) 2292 } 2293 ACCESS read-write 2294 STATUS mandatory 2295 DESCRIPTION 2296 "The variable for each host that the hostTopNRate 2297 variable is based upon. 2299 This object may not be modified if the associated 2300 hostTopNStatus object is equal to valid(1)." 2301 ::= { hostTopNControlEntry 3 } 2303 hostTopNTimeRemaining OBJECT-TYPE 2304 SYNTAX INTEGER 2305 ACCESS read-write 2306 STATUS mandatory 2307 DESCRIPTION 2308 "The number of seconds left in the report currently being 2309 collected. When this object is modified by the management 2310 station, a new collection is started, possibly aborting 2311 a currently running report. The new value is used 2312 as the requested duration of this report, which is 2313 loaded into the associated hostTopNDuration object. 2315 When this object is set to a non-zero value, any 2316 associated hostTopNEntries shall be made 2317 inaccessible by the monitor. While the value of this 2318 object is non-zero, it decrements by one per second until 2319 it reaches zero. During this time, all associated 2320 hostTopNEntries shall remain inaccessible. At the time 2321 that this object decrements to zero, the report is made 2322 accessible in the hostTopNTable. Thus, the hostTopN 2323 table needs to be created only at the end of the collection 2324 interval." 2325 DEFVAL { 0 } 2326 ::= { hostTopNControlEntry 4 } 2328 hostTopNDuration OBJECT-TYPE 2329 SYNTAX INTEGER 2330 ACCESS read-only 2331 STATUS mandatory 2332 DESCRIPTION 2333 "The number of seconds that this report has collected 2334 during the last sampling interval, or if this 2335 report is currently being collected, the number 2336 of seconds that this report is being collected 2337 during this sampling interval. 2339 When the associated hostTopNTimeRemaining object is set, 2340 this object shall be set by the probe to the same value 2341 and shall not be modified until the next time 2342 the hostTopNTimeRemaining is set. 2344 This value shall be zero if no reports have been 2345 requested for this hostTopNControlEntry." 2346 DEFVAL { 0 } 2347 ::= { hostTopNControlEntry 5 } 2349 hostTopNRequestedSize OBJECT-TYPE 2350 SYNTAX INTEGER 2351 ACCESS read-write 2352 STATUS mandatory 2353 DESCRIPTION 2354 "The maximum number of hosts requested for the top N 2355 table. 2357 When this object is created or modified, the probe 2358 should set hostTopNGrantedSize as closely to this 2359 object as is possible for the particular probe 2360 implementation and available resources." 2361 DEFVAL { 10 } 2362 ::= { hostTopNControlEntry 6 } 2364 hostTopNGrantedSize OBJECT-TYPE 2365 SYNTAX INTEGER 2366 ACCESS read-only 2367 STATUS mandatory 2368 DESCRIPTION 2369 "The maximum number of hosts in the top N table. 2371 When the associated hostTopNRequestedSize object is 2372 created or modified, the probe should set this 2373 object as closely to the requested value as is possible 2374 for the particular implementation and available 2375 resources. The probe must not lower this value except 2376 as a result of a set to the associated 2377 hostTopNRequestedSize object. 2379 Hosts with the highest value of hostTopNRate shall be 2380 placed in this table in decreasing order of this rate 2381 until there is no more room or until there are no more 2382 hosts." 2383 ::= { hostTopNControlEntry 7 } 2385 hostTopNStartTime OBJECT-TYPE 2386 SYNTAX TimeTicks 2387 ACCESS read-only 2388 STATUS mandatory 2389 DESCRIPTION 2390 "The value of sysUpTime when this top N report was 2391 last started. In other words, this is the time that 2392 the associated hostTopNTimeRemaining object was 2393 modified to start the requested report." 2394 ::= { hostTopNControlEntry 8 } 2396 hostTopNOwner OBJECT-TYPE 2397 SYNTAX OwnerString 2398 ACCESS read-write 2399 STATUS mandatory 2400 DESCRIPTION 2401 "The entity that configured this entry and is therefore 2402 using the resources assigned to it." 2403 ::= { hostTopNControlEntry 9 } 2405 hostTopNStatus OBJECT-TYPE 2406 SYNTAX EntryStatus 2407 ACCESS read-write 2408 STATUS mandatory 2409 DESCRIPTION 2410 "The status of this hostTopNControl entry. 2412 If this object is not equal to valid(1), all associated 2413 hostTopNEntries shall be deleted by the agent." 2414 ::= { hostTopNControlEntry 10 } 2416 hostTopNTable OBJECT-TYPE 2417 SYNTAX SEQUENCE OF HostTopNEntry 2418 ACCESS not-accessible 2419 STATUS mandatory 2420 DESCRIPTION 2421 "A list of top N host entries." 2422 ::= { hostTopN 2 } 2424 hostTopNEntry OBJECT-TYPE 2425 SYNTAX HostTopNEntry 2426 ACCESS not-accessible 2427 STATUS mandatory 2428 DESCRIPTION 2429 "A set of statistics for a host that is part of a top N 2430 report. For example, an instance of the hostTopNRate 2431 object might be named hostTopNRate.3.10" 2432 INDEX { hostTopNReport, hostTopNIndex } 2433 ::= { hostTopNTable 1 } 2435 HostTopNEntry ::= SEQUENCE { 2436 hostTopNReport INTEGER (1..65535), 2437 hostTopNIndex INTEGER (1..65535), 2438 hostTopNAddress OCTET STRING, 2439 hostTopNRate INTEGER 2440 } 2442 hostTopNReport OBJECT-TYPE 2443 SYNTAX INTEGER (1..65535) 2444 ACCESS read-only 2445 STATUS mandatory 2446 DESCRIPTION 2447 "This object identifies the top N report of which 2448 this entry is a part. The set of hosts 2449 identified by a particular value of this 2450 object is part of the same report as identified 2451 by the same value of the hostTopNControlIndex object." 2452 ::= { hostTopNEntry 1 } 2454 hostTopNIndex OBJECT-TYPE 2455 SYNTAX INTEGER (1..65535) 2456 ACCESS read-only 2457 STATUS mandatory 2458 DESCRIPTION 2459 "An index that uniquely identifies an entry in 2460 the hostTopN table among those in the same report. 2461 This index is between 1 and N, where N is the 2462 number of entries in this table. Increasing values 2463 of hostTopNIndex shall be assigned to entries with 2464 decreasing values of hostTopNRate until index N 2465 is assigned to the entry with the lowest value of 2466 hostTopNRate or there are no more hostTopNEntries." 2467 ::= { hostTopNEntry 2 } 2469 hostTopNAddress OBJECT-TYPE 2470 SYNTAX OCTET STRING 2471 ACCESS read-only 2472 STATUS mandatory 2473 DESCRIPTION 2474 "The physical address of this host." 2475 ::= { hostTopNEntry 3 } 2477 hostTopNRate OBJECT-TYPE 2478 SYNTAX INTEGER 2479 ACCESS read-only 2480 STATUS mandatory 2481 DESCRIPTION 2482 "The amount of change in the selected variable 2483 during this sampling interval. The selected 2484 variable is this host's instance of the object 2485 selected by hostTopNRateBase." 2486 ::= { hostTopNEntry 4 } 2488 -- The Matrix Group 2490 -- Implementation of the Matrix group is optional. 2491 -- 2492 -- The Matrix group consists of the matrixControlTable, matrixSDTable 2493 -- and the matrixDSTable. These tables store statistics for a 2494 -- particular conversation between two addresses. As the device 2495 -- detects a new conversation, including those to a non-unicast 2496 -- address, it creates a new entry in both of the matrix tables. 2497 -- It must only create new entries based on information 2498 -- received in good packets. If the monitoring device finds 2499 -- itself short of resources, it may delete entries as needed. 2500 -- It is suggested that the device delete the least recently used 2501 -- entries first. 2503 matrixControlTable OBJECT-TYPE 2504 SYNTAX SEQUENCE OF MatrixControlEntry 2505 ACCESS not-accessible 2506 STATUS mandatory 2507 DESCRIPTION 2508 "A list of information entries for the 2509 traffic matrix on each interface." 2510 ::= { matrix 1 } 2512 matrixControlEntry OBJECT-TYPE 2513 SYNTAX MatrixControlEntry 2514 ACCESS not-accessible 2515 STATUS mandatory 2516 DESCRIPTION 2517 "Information about a traffic matrix on a particular 2518 interface. For example, an instance of the 2519 matrixControlLastDeleteTime object might be named 2520 matrixControlLastDeleteTime.1" 2521 INDEX { matrixControlIndex } 2522 ::= { matrixControlTable 1 } 2524 MatrixControlEntry ::= SEQUENCE { 2525 matrixControlIndex INTEGER (1..65535), 2526 matrixControlDataSource OBJECT IDENTIFIER, 2527 matrixControlTableSize INTEGER, 2528 matrixControlLastDeleteTime TimeTicks, 2529 matrixControlOwner OwnerString, 2530 matrixControlStatus EntryStatus 2531 } 2532 matrixControlIndex OBJECT-TYPE 2533 SYNTAX INTEGER (1..65535) 2534 ACCESS read-only 2535 STATUS mandatory 2536 DESCRIPTION 2537 "An index that uniquely identifies an entry in the 2538 matrixControl table. Each such entry defines 2539 a function that discovers conversations on a particular 2540 interface and places statistics about them in the 2541 matrixSDTable and the matrixDSTable on behalf of this 2542 matrixControlEntry." 2543 ::= { matrixControlEntry 1 } 2545 matrixControlDataSource OBJECT-TYPE 2546 SYNTAX OBJECT IDENTIFIER 2547 ACCESS read-write 2548 STATUS mandatory 2549 DESCRIPTION 2550 "This object identifies the source of 2551 the data from which this entry creates a traffic matrix. 2552 This source can be any interface on this device. In 2553 order to identify a particular interface, this object 2554 shall identify the instance of the ifIndex object, 2555 defined in [4,6], for the desired interface. For 2556 example, if an entry were to receive data from 2557 interface #1, this object would be set to ifIndex.1. 2559 The statistics in this group reflect all packets 2560 on the local network segment attached to the identified 2561 interface. 2563 An agent may or may not be able to tell if fundamental 2564 changes to the media of the interface have occurred and 2565 necessitate an invalidation of this entry. For example, a 2566 hot-pluggable ethernet card could be pulled out and replaced 2567 by a token-ring card. In such a case, if the agent has such 2568 knowledge of the change, it is recommended that it invalidate 2569 this entry. 2571 This object may not be modified if the associated 2572 matrixControlStatus object is equal to valid(1)." 2573 ::= { matrixControlEntry 2 } 2575 matrixControlTableSize OBJECT-TYPE 2576 SYNTAX INTEGER 2577 ACCESS read-only 2578 STATUS mandatory 2579 DESCRIPTION 2580 "The number of matrixSDEntries in the matrixSDTable 2581 for this interface. This must also be the value of 2582 the number of entries in the matrixDSTable for this 2583 interface." 2584 ::= { matrixControlEntry 3 } 2586 matrixControlLastDeleteTime OBJECT-TYPE 2587 SYNTAX TimeTicks 2588 ACCESS read-only 2589 STATUS mandatory 2590 DESCRIPTION 2591 "The value of sysUpTime when the last entry 2592 was deleted from the portion of the matrixSDTable 2593 or matrixDSTable associated with this matrixControlEntry. 2594 If no deletions have occurred, this value shall be 2595 zero." 2596 ::= { matrixControlEntry 4 } 2598 matrixControlOwner OBJECT-TYPE 2599 SYNTAX OwnerString 2600 ACCESS read-write 2601 STATUS mandatory 2602 DESCRIPTION 2603 "The entity that configured this entry and is therefore 2604 using the resources assigned to it." 2605 ::= { matrixControlEntry 5 } 2607 matrixControlStatus OBJECT-TYPE 2608 SYNTAX EntryStatus 2609 ACCESS read-write 2610 STATUS mandatory 2611 DESCRIPTION 2612 "The status of this matrixControl entry. 2614 If this object is not equal to valid(1), all associated 2615 entries in the matrixSDTable and the matrixDSTable 2616 shall be deleted by the agent." 2617 ::= { matrixControlEntry 6 } 2619 matrixSDTable OBJECT-TYPE 2620 SYNTAX SEQUENCE OF MatrixSDEntry 2621 ACCESS not-accessible 2622 STATUS mandatory 2623 DESCRIPTION 2624 "A list of traffic matrix entries indexed by 2625 source and destination MAC address." 2626 ::= { matrix 2 } 2628 matrixSDEntry OBJECT-TYPE 2629 SYNTAX MatrixSDEntry 2630 ACCESS not-accessible 2631 STATUS mandatory 2632 DESCRIPTION 2633 "A collection of statistics for communications between 2634 two addresses on a particular interface. For example, 2635 an instance of the matrixSDPkts object might be named 2636 matrixSDPkts.1.6.8.0.32.27.3.176.6.8.0.32.10.8.113" 2637 INDEX { matrixSDIndex, 2638 matrixSDSourceAddress, matrixSDDestAddress } 2639 ::= { matrixSDTable 1 } 2641 MatrixSDEntry ::= SEQUENCE { 2642 matrixSDSourceAddress OCTET STRING, 2643 matrixSDDestAddress OCTET STRING, 2644 matrixSDIndex INTEGER (1..65535), 2645 matrixSDPkts Counter, 2646 matrixSDOctets Counter, 2647 matrixSDErrors Counter 2648 } 2650 matrixSDSourceAddress OBJECT-TYPE 2651 SYNTAX OCTET STRING 2652 ACCESS read-only 2653 STATUS mandatory 2654 DESCRIPTION 2655 "The source physical address." 2656 ::= { matrixSDEntry 1 } 2658 matrixSDDestAddress OBJECT-TYPE 2659 SYNTAX OCTET STRING 2660 ACCESS read-only 2661 STATUS mandatory 2662 DESCRIPTION 2663 "The destination physical address." 2664 ::= { matrixSDEntry 2 } 2666 matrixSDIndex OBJECT-TYPE 2667 SYNTAX INTEGER (1..65535) 2668 ACCESS read-only 2669 STATUS mandatory 2670 DESCRIPTION 2671 "The set of collected matrix statistics of which 2672 this entry is a part. The set of matrix statistics 2673 identified by a particular value of this index 2674 is associated with the same matrixControlEntry 2675 as identified by the same value of matrixControlIndex." 2676 ::= { matrixSDEntry 3 } 2678 matrixSDPkts OBJECT-TYPE 2679 SYNTAX Counter 2680 ACCESS read-only 2681 STATUS mandatory 2682 DESCRIPTION 2683 "The number of packets transmitted from the source 2684 address to the destination address (this number includes 2685 error packets)." 2686 ::= { matrixSDEntry 4 } 2688 matrixSDOctets OBJECT-TYPE 2689 SYNTAX Counter 2690 ACCESS read-only 2691 STATUS mandatory 2692 DESCRIPTION 2693 "The number of octets (excluding framing bits but 2694 including FCS octets) contained in all packets 2695 transmitted from the source address to the 2696 destination address." 2697 ::= { matrixSDEntry 5 } 2699 matrixSDErrors OBJECT-TYPE 2700 SYNTAX Counter 2701 ACCESS read-only 2702 STATUS mandatory 2703 DESCRIPTION 2704 "The number of error packets transmitted from 2705 the source address to the destination address." 2706 ::= { matrixSDEntry 6 } 2708 -- Traffic matrix tables from destination to source 2710 matrixDSTable OBJECT-TYPE 2711 SYNTAX SEQUENCE OF MatrixDSEntry 2712 ACCESS not-accessible 2713 STATUS mandatory 2714 DESCRIPTION 2715 "A list of traffic matrix entries indexed by 2716 destination and source MAC address." 2717 ::= { matrix 3 } 2719 matrixDSEntry OBJECT-TYPE 2720 SYNTAX MatrixDSEntry 2721 ACCESS not-accessible 2722 STATUS mandatory 2723 DESCRIPTION 2724 "A collection of statistics for communications between 2725 two addresses on a particular interface. For example, 2726 an instance of the matrixSDPkts object might be named 2727 matrixSDPkts.1.6.8.0.32.10.8.113.6.8.0.32.27.3.176" 2728 INDEX { matrixDSIndex, 2729 matrixDSDestAddress, matrixDSSourceAddress } 2730 ::= { matrixDSTable 1 } 2732 MatrixDSEntry ::= SEQUENCE { 2733 matrixDSSourceAddress OCTET STRING, 2734 matrixDSDestAddress OCTET STRING, 2735 matrixDSIndex INTEGER (1..65535), 2736 matrixDSPkts Counter, 2737 matrixDSOctets Counter, 2738 matrixDSErrors Counter 2739 } 2741 matrixDSSourceAddress OBJECT-TYPE 2742 SYNTAX OCTET STRING 2743 ACCESS read-only 2744 STATUS mandatory 2745 DESCRIPTION 2746 "The source physical address." 2747 ::= { matrixDSEntry 1 } 2749 matrixDSDestAddress OBJECT-TYPE 2750 SYNTAX OCTET STRING 2751 ACCESS read-only 2752 STATUS mandatory 2753 DESCRIPTION 2754 "The destination physical address." 2755 ::= { matrixDSEntry 2 } 2757 matrixDSIndex OBJECT-TYPE 2758 SYNTAX INTEGER (1..65535) 2759 ACCESS read-only 2760 STATUS mandatory 2761 DESCRIPTION 2762 "The set of collected matrix statistics of which 2763 this entry is a part. The set of matrix statistics 2764 identified by a particular value of this index 2765 is associated with the same matrixControlEntry 2766 as identified by the same value of matrixControlIndex." 2767 ::= { matrixDSEntry 3 } 2769 matrixDSPkts OBJECT-TYPE 2770 SYNTAX Counter 2771 ACCESS read-only 2772 STATUS mandatory 2773 DESCRIPTION 2774 "The number of packets transmitted from the source 2775 address to the destination address (this number includes 2776 error packets)." 2777 ::= { matrixDSEntry 4 } 2779 matrixDSOctets OBJECT-TYPE 2780 SYNTAX Counter 2781 ACCESS read-only 2782 STATUS mandatory 2783 DESCRIPTION 2784 "The number of octets (excluding framing bits 2785 but including FCS octets) contained in all packets 2786 transmitted from the source address to the 2787 destination address." 2788 ::= { matrixDSEntry 5 } 2790 matrixDSErrors OBJECT-TYPE 2791 SYNTAX Counter 2792 ACCESS read-only 2793 STATUS mandatory 2794 DESCRIPTION 2795 "The number of error packets transmitted from 2796 the source address to the destination address." 2797 ::= { matrixDSEntry 6 } 2799 -- The Filter Group 2801 -- Implementation of the Filter group is optional. 2802 -- 2803 -- The Filter group allows packets to be captured with an 2804 -- arbitrary filter expression. A logical data and 2805 -- event stream or "channel" is formed by the packets 2806 -- that match the filter expression. 2807 -- 2808 -- This filter mechanism allows the creation of an arbitrary 2809 -- logical expression with which to filter packets. Each 2810 -- filter associated with a channel is OR'ed with the others. 2811 -- Within a filter, any bits checked in the data and status are 2812 -- AND'ed with respect to other bits in the same filter. The 2813 -- NotMask also allows for checking for inequality. Finally, 2814 -- the channelAcceptType object allows for inversion of the 2815 -- whole equation. 2816 -- 2817 -- If a management station wishes to recieve a trap to alert it 2818 -- that new packets have been captured and are available for 2819 -- download, it is recommended that it set up an alarm entry that 2820 -- monitors the value of the relevant channelMatches instance. 2821 -- 2822 -- The channel can be turned on or off, and can also 2823 -- generate events when packets pass through it. 2825 filterTable OBJECT-TYPE 2826 SYNTAX SEQUENCE OF FilterEntry 2827 ACCESS not-accessible 2828 STATUS mandatory 2829 DESCRIPTION 2830 "A list of packet filter entries." 2831 ::= { filter 1 } 2833 filterEntry OBJECT-TYPE 2834 SYNTAX FilterEntry 2835 ACCESS not-accessible 2836 STATUS mandatory 2837 DESCRIPTION 2838 "A set of parameters for a packet filter applied on a 2839 particular interface. As an example, an instance of the 2840 filterPktData object might be named filterPktData.12" 2841 INDEX { filterIndex } 2842 ::= { filterTable 1 } 2844 FilterEntry ::= SEQUENCE { 2845 filterIndex INTEGER (1..65535), 2846 filterChannelIndex INTEGER (1..65535), 2847 filterPktDataOffset INTEGER, 2848 filterPktData OCTET STRING, 2849 filterPktDataMask OCTET STRING, 2850 filterPktDataNotMask OCTET STRING, 2851 filterPktStatus INTEGER, 2852 filterPktStatusMask INTEGER, 2853 filterPktStatusNotMask INTEGER, 2854 filterOwner OwnerString, 2855 filterStatus EntryStatus 2856 } 2858 filterIndex OBJECT-TYPE 2859 SYNTAX INTEGER (1..65535) 2860 ACCESS read-only 2861 STATUS mandatory 2862 DESCRIPTION 2863 "An index that uniquely identifies an entry 2864 in the filter table. Each such entry defines 2865 one filter that is to be applied to every packet 2866 received on an interface." 2867 ::= { filterEntry 1 } 2869 filterChannelIndex OBJECT-TYPE 2870 SYNTAX INTEGER (1..65535) 2871 ACCESS read-write 2872 STATUS mandatory 2873 DESCRIPTION 2874 "This object identifies the channel of which this filter 2875 is a part. The filters identified by a particular value 2876 of this object are associated with the same channel as 2877 identified by the same value of the channelIndex object." 2878 ::= { filterEntry 2 } 2880 filterPktDataOffset OBJECT-TYPE 2881 SYNTAX INTEGER 2882 ACCESS read-write 2883 STATUS mandatory 2884 DESCRIPTION 2885 "The offset from the beginning of each packet where 2886 a match of packet data will be attempted. This offset 2887 is measured from the point in the physical layer 2888 packet after the framing bits, if any. For example, 2889 in an Ethernet frame, this point is at the beginning of 2890 the destination MAC address. 2892 This object may not be modified if the associated 2893 filterStatus object is equal to valid(1)." 2894 DEFVAL { 0 } 2895 ::= { filterEntry 3 } 2897 filterPktData OBJECT-TYPE 2898 SYNTAX OCTET STRING 2899 ACCESS read-write 2900 STATUS mandatory 2901 DESCRIPTION 2902 "The data that is to be matched with the input packet. 2903 For each packet received, this filter and the accompanying 2904 filterPktDataMask and filterPktDataNotMask will be 2905 adjusted for the offset. The only bits relevant to this 2906 match algorithm are those that have the corresponding 2907 filterPktDataMask bit equal to one. The following three 2908 rules are then applied to every packet: 2910 (1) If the packet is too short and does not have data 2911 corresponding to part of the filterPktData, the packet 2912 will fail this data match. 2914 (2) For each relevant bit from the packet with the 2915 corresponding filterPktDataNotMask bit set to zero, if 2916 the bit from the packet is not equal to the corresponding 2917 bit from the filterPktData, then the packet will fail 2918 this data match. 2920 (3) If for every relevant bit from the packet with the 2921 corresponding filterPktDataNotMask bit set to one, the 2922 bit from the packet is equal to the corresponding bit 2923 from the filterPktData, then the packet will fail this 2924 data match. 2926 Any packets that have not failed any of the three matches 2927 above have passed this data match. In particular, a zero 2928 length filter will match any packet. 2930 This object may not be modified if the associated 2931 filterStatus object is equal to valid(1)." 2932 ::= { filterEntry 4 } 2934 filterPktDataMask OBJECT-TYPE 2935 SYNTAX OCTET STRING 2936 ACCESS read-write 2937 STATUS mandatory 2938 DESCRIPTION 2939 "The mask that is applied to the match process. 2940 After adjusting this mask for the offset, only those 2941 bits in the received packet that correspond to bits set 2942 in this mask are relevant for further processing by the 2943 match algorithm. The offset is applied to filterPktDataMask 2944 in the same way it is applied to the filter. For the 2945 purposes of the matching algorithm, if the associated 2946 filterPktData object is longer than this mask, this mask is 2947 conceptually extended with '1' bits until it reaches the 2948 length of the filterPktData object. 2950 This object may not be modified if the associated 2951 filterStatus object is equal to valid(1)." 2952 ::= { filterEntry 5 } 2954 filterPktDataNotMask OBJECT-TYPE 2955 SYNTAX OCTET STRING 2956 ACCESS read-write 2957 STATUS mandatory 2958 DESCRIPTION 2959 "The inversion mask that is applied to the match 2960 process. After adjusting this mask for the offset, 2961 those relevant bits in the received packet that correspond 2962 to bits cleared in this mask must all be equal to their 2963 corresponding bits in the filterPktData object for the packet 2964 to be accepted. In addition, at least one of those relevant 2965 bits in the received packet that correspond to bits set in 2966 this mask must be different to its corresponding bit in the 2967 filterPktData object. 2969 For the purposes of the matching algorithm, if the associated 2970 filterPktData object is longer than this mask, this mask is 2971 conceptually extended with '0' bits until it reaches the 2972 length of the filterPktData object. 2974 This object may not be modified if the associated 2975 filterStatus object is equal to valid(1)." 2976 ::= { filterEntry 6 } 2978 filterPktStatus OBJECT-TYPE 2979 SYNTAX INTEGER 2980 ACCESS read-write 2981 STATUS mandatory 2982 DESCRIPTION 2983 "The status that is to be matched with the input packet. 2984 The only bits relevant to this match algorithm are those that 2985 have the corresponding filterPktStatusMask bit equal to one. 2986 The following two rules are then applied to every packet: 2988 (1) For each relevant bit from the packet status with the 2989 corresponding filterPktStatusNotMask bit set to zero, if 2990 the bit from the packet status is not equal to the 2991 corresponding bit from the filterPktStatus, then the 2992 packet will fail this status match. 2994 (2) If for every relevant bit from the packet status with the 2995 corresponding filterPktStatusNotMask bit set to one, the 2996 bit from the packet status is equal to the corresponding 2997 bit from the filterPktStatus, then the packet will fail 2998 this status match. 3000 Any packets that have not failed either of the two matches 3001 above have passed this status match. In particular, a zero 3002 length status filter will match any packet's status. 3004 The value of the packet status is a sum. This sum 3005 initially takes the value zero. Then, for each 3006 error, E, that has been discovered in this packet, 3007 2 raised to a value representing E is added to the sum. 3008 The errors and the bits that represent them are dependent 3009 on the media type of the interface that this channel 3010 is receiving packets from. 3012 The errors defined for a packet captured off of an 3013 Ethernet interface are as follows: 3015 bit # Error 3016 0 Packet is longer than 1518 octets 3017 1 Packet is shorter than 64 octets 3018 2 Packet experienced a CRC or Alignment error 3020 For example, an Ethernet fragment would have a 3021 value of 6 (2^1 + 2^2). 3023 As this MIB is expanded to new media types, this object 3024 will have other media-specific errors defined. 3026 For the purposes of this status matching algorithm, if the 3027 packet status is longer than this filterPktStatus object, 3028 this object is conceptually extended with '0' bits until it 3029 reaches the size of the packet status. 3031 This object may not be modified if the associated 3032 filterStatus object is equal to valid(1)." 3033 ::= { filterEntry 7 } 3035 filterPktStatusMask OBJECT-TYPE 3036 SYNTAX INTEGER 3037 ACCESS read-write 3038 STATUS mandatory 3039 DESCRIPTION 3040 "The mask that is applied to the status match process. 3041 Only those bits in the received packet that correspond to 3042 bits set in this mask are relevant for further processing 3043 by the status match algorithm. For the purposes 3044 of the matching algorithm, if the associated filterPktStatus 3045 object is longer than this mask, this mask is conceptually 3046 extended with '1' bits until it reaches the size of the 3047 filterPktStatus. In addition, if a packet status is longer 3048 than this mask, this mask is conceptually extended with '0' 3049 bits until it reaches the size of the packet status. 3051 This object may not be modified if the associated 3052 filterStatus object is equal to valid(1)." 3053 ::= { filterEntry 8 } 3055 filterPktStatusNotMask OBJECT-TYPE 3056 SYNTAX INTEGER 3057 ACCESS read-write 3058 STATUS mandatory 3059 DESCRIPTION 3060 "The inversion mask that is applied to the status match 3061 process. Those relevant bits in the received packet status 3062 that correspond to bits cleared in this mask must all be 3063 equal to their corresponding bits in the filterPktStatus 3064 object for the packet to be accepted. In addition, at least 3065 one of those relevant bits in the received packet status 3066 that correspond to bits set in this mask must be different 3067 to its corresponding bit in the filterPktStatus object for 3068 the packet to be accepted. 3070 For the purposes of the matching algorithm, if the associated 3071 filterPktStatus object or a packet status is longer than this 3072 mask, this mask is conceptually extended with '0' bits until 3073 it reaches the longer of the lengths of the filterPktStatus 3074 object and the packet status. 3076 This object may not be modified if the associated 3077 filterStatus object is equal to valid(1)." 3078 ::= { filterEntry 9 } 3080 filterOwner OBJECT-TYPE 3081 SYNTAX OwnerString 3082 ACCESS read-write 3083 STATUS mandatory 3084 DESCRIPTION 3085 "The entity that configured this entry and is therefore 3086 using the resources assigned to it." 3087 ::= { filterEntry 10 } 3089 filterStatus OBJECT-TYPE 3090 SYNTAX EntryStatus 3091 ACCESS read-write 3092 STATUS mandatory 3093 DESCRIPTION 3094 "The status of this filter entry." 3095 ::= { filterEntry 11 } 3097 channelTable OBJECT-TYPE 3098 SYNTAX SEQUENCE OF ChannelEntry 3099 ACCESS not-accessible 3100 STATUS mandatory 3101 DESCRIPTION 3102 "A list of packet channel entries." 3103 ::= { filter 2 } 3105 channelEntry OBJECT-TYPE 3106 SYNTAX ChannelEntry 3107 ACCESS not-accessible 3108 STATUS mandatory 3109 DESCRIPTION 3110 "A set of parameters for a packet channel applied on a 3111 particular interface. As an example, an instance of the 3112 channelMatches object might be named channelMatches.3" 3113 INDEX { channelIndex } 3114 ::= { channelTable 1 } 3116 ChannelEntry ::= SEQUENCE { 3117 channelIndex INTEGER (1..65535), 3118 channelIfIndex INTEGER (1..65535), 3119 channelAcceptType INTEGER, 3120 channelDataControl INTEGER, 3121 channelTurnOnEventIndex INTEGER (0..65535), 3122 channelTurnOffEventIndex INTEGER (0..65535), 3123 channelEventIndex INTEGER (0..65535), 3124 channelEventStatus INTEGER, 3125 channelMatches Counter, 3126 channelDescription DisplayString (SIZE (0..127)), 3127 channelOwner OwnerString, 3128 channelStatus EntryStatus 3129 } 3131 channelIndex OBJECT-TYPE 3132 SYNTAX INTEGER (1..65535) 3133 ACCESS read-only 3134 STATUS mandatory 3135 DESCRIPTION 3136 "An index that uniquely identifies an entry 3137 in the channel table. Each such 3138 entry defines one channel, a logical data 3139 and event stream." 3140 ::= { channelEntry 1 } 3142 channelIfIndex OBJECT-TYPE 3143 SYNTAX INTEGER (1..65535) 3144 ACCESS read-write 3145 STATUS mandatory 3146 DESCRIPTION 3147 "The value of this object uniquely identifies the 3148 interface on this remote network monitoring device to which 3149 the associated filters are applied to allow data into this 3150 channel. The interface identified by a particular value 3151 of this object is the same interface as identified by the 3152 same value of the ifIndex object, defined in [4,6]. 3154 The filters in this group are applied to all packets on 3155 the local network segment attached to the identified 3156 interface. 3158 An agent may or may not be able to tell if fundamental 3159 changes to the media of the interface have occurred and 3160 necessitate an invalidation of this entry. For example, a 3161 hot-pluggable ethernet card could be pulled out and replaced 3162 by a token-ring card. In such a case, if the agent has such 3163 knowledge of the change, it is recommended that it invalidate 3164 this entry. 3166 This object may not be modified if the associated 3167 channelStatus object is equal to valid(1)." 3168 ::= { channelEntry 2 } 3170 channelAcceptType OBJECT-TYPE 3171 SYNTAX INTEGER { 3172 acceptMatched(1), 3173 acceptFailed(2) 3174 } 3175 ACCESS read-write 3176 STATUS mandatory 3177 DESCRIPTION 3178 "This object controls the action of the filters 3179 associated with this channel. If this object is equal 3180 to acceptMatched(1), packets will be accepted to this 3181 channel if they are accepted by both the packet data and 3182 packet status matches of an associated filter. If 3183 this object is equal to acceptFailed(2), packets will 3184 be accepted to this channel only if they fail either 3185 the packet data match or the packet status match of 3186 each of the associated filters. 3188 In particular, a channel with no associated filters will 3189 match no packets if set to acceptMatched(1) case and will 3190 match all packets in the acceptFailed(2) case. 3192 This object may not be modified if the associated 3193 channelStatus object is equal to valid(1)." 3194 ::= { channelEntry 3 } 3196 channelDataControl OBJECT-TYPE 3197 SYNTAX INTEGER { 3198 on(1), 3199 off(2) 3200 } 3201 ACCESS read-write 3202 STATUS mandatory 3203 DESCRIPTION 3204 "This object controls the flow of data through this channel. 3205 If this object is on(1), data, status and events flow 3206 through this channel. If this object is off(2), data, 3207 status and events will not flow through this channel." 3208 DEFVAL { off } 3209 ::= { channelEntry 4 } 3211 channelTurnOnEventIndex OBJECT-TYPE 3212 SYNTAX INTEGER (0..65535) 3213 ACCESS read-write 3214 STATUS mandatory 3215 DESCRIPTION 3216 "The value of this object identifies the event 3217 that is configured to turn the associated 3218 channelDataControl from off to on when the event is 3219 generated. The event identified by a particular value 3220 of this object is the same event as identified by the 3221 same value of the eventIndex object. If there is no 3222 corresponding entry in the eventTable, then no 3223 association exists. In fact, if no event is intended 3224 for this channel, channelTurnOnEventIndex must be 3225 set to zero, a non-existent event index. 3227 This object may not be modified if the associated 3228 channelStatus object is equal to valid(1)." 3229 ::= { channelEntry 5 } 3231 channelTurnOffEventIndex OBJECT-TYPE 3232 SYNTAX INTEGER (0..65535) 3233 ACCESS read-write 3234 STATUS mandatory 3235 DESCRIPTION 3236 "The value of this object identifies the event 3237 that is configured to turn the associated 3238 channelDataControl from on to off when the event is 3239 generated. The event identified by a particular value 3240 of this object is the same event as identified by the 3241 same value of the eventIndex object. If there is no 3242 corresponding entry in the eventTable, then no 3243 association exists. In fact, if no event is intended 3244 for this channel, channelTurnOffEventIndex must be 3245 set to zero, a non-existent event index. 3247 This object may not be modified if the associated 3248 channelStatus object is equal to valid(1)." 3249 ::= { channelEntry 6 } 3251 channelEventIndex OBJECT-TYPE 3252 SYNTAX INTEGER (0..65535) 3253 ACCESS read-write 3254 STATUS mandatory 3255 DESCRIPTION 3256 "The value of this object identifies the event 3257 that is configured to be generated when the 3258 associated channelDataControl is on and a packet 3259 is matched. The event identified by a particular value 3260 of this object is the same event as identified by the 3261 same value of the eventIndex object. If there is no 3262 corresponding entry in the eventTable, then no 3263 association exists. In fact, if no event is intended 3264 for this channel, channelEventIndex must be 3265 set to zero, a non-existent event index. 3267 This object may not be modified if the associated 3268 channelStatus object is equal to valid(1)." 3269 ::= { channelEntry 7 } 3271 channelEventStatus OBJECT-TYPE 3272 SYNTAX INTEGER { 3273 eventReady(1), 3274 eventFired(2), 3275 eventAlwaysReady(3) 3276 } 3277 ACCESS read-write 3278 STATUS mandatory 3279 DESCRIPTION 3280 "The event status of this channel. 3282 If this channel is configured to generate events 3283 when packets are matched, a means of controlling 3284 the flow of those events is often needed. When 3285 this object is equal to eventReady(1), a single 3286 event may be generated, after which this object 3287 will be set by the probe to eventFired(2). While 3288 in the eventFired(2) state, no events will be 3289 generated until the object is modified to 3290 eventReady(1) (or eventAlwaysReady(3)). The 3291 management station can thus easily respond to a 3292 notification of an event by re-enabling this object. 3294 If the management station wishes to disable this 3295 flow control and allow events to be generated 3296 at will, this object may be set to 3297 eventAlwaysReady(3). Disabling the flow control 3298 is discouraged as it can result in high network 3299 traffic or other performance problems." 3300 DEFVAL { eventReady } 3301 ::= { channelEntry 8 } 3303 channelMatches OBJECT-TYPE 3304 SYNTAX Counter 3305 ACCESS read-only 3306 STATUS mandatory 3307 DESCRIPTION 3308 "The number of times this channel has matched a packet. 3309 Note that this object is updated even when 3310 channelDataControl is set to off." 3311 ::= { channelEntry 9 } 3313 channelDescription OBJECT-TYPE 3314 SYNTAX DisplayString (SIZE (0..127)) 3315 ACCESS read-write 3316 STATUS mandatory 3317 DESCRIPTION 3318 "A comment describing this channel." 3319 ::= { channelEntry 10 } 3321 channelOwner OBJECT-TYPE 3322 SYNTAX OwnerString 3323 ACCESS read-write 3324 STATUS mandatory 3325 DESCRIPTION 3326 "The entity that configured this entry and is therefore 3327 using the resources assigned to it." 3328 ::= { channelEntry 11 } 3330 channelStatus OBJECT-TYPE 3331 SYNTAX EntryStatus 3332 ACCESS read-write 3333 STATUS mandatory 3334 DESCRIPTION 3335 "The status of this channel entry." 3336 ::= { channelEntry 12 } 3338 -- The Packet Capture Group 3340 -- Implementation of the Packet Capture group is optional. 3341 -- 3342 -- The Packet Capture Group requires implementation of the 3343 -- Filter Group. 3344 -- 3345 -- The Packet Capture group allows packets to be captured 3346 -- upon a filter match. The bufferControlTable controls 3347 -- the captured packets output from a channel that is 3348 -- associated with it. The captured packets are placed 3349 -- in entries in the captureBufferTable. These entries are 3350 -- associated with the bufferControlEntry on whose behalf they 3351 -- were stored. 3353 bufferControlTable OBJECT-TYPE 3354 SYNTAX SEQUENCE OF BufferControlEntry 3355 ACCESS not-accessible 3356 STATUS mandatory 3357 DESCRIPTION 3358 "A list of buffers control entries." 3359 ::= { capture 1 } 3361 bufferControlEntry OBJECT-TYPE 3362 SYNTAX BufferControlEntry 3363 ACCESS not-accessible 3364 STATUS mandatory 3365 DESCRIPTION 3366 "A set of parameters that control the collection of a stream 3367 of packets that have matched filters. As an example, an 3368 instance of the bufferControlCaptureSliceSize object might 3369 be named bufferControlCaptureSliceSize.3" 3370 INDEX { bufferControlIndex } 3371 ::= { bufferControlTable 1 } 3373 BufferControlEntry ::= SEQUENCE { 3374 bufferControlIndex INTEGER (1..65535), 3375 bufferControlChannelIndex INTEGER (1..65535), 3376 bufferControlFullStatus INTEGER, 3377 bufferControlFullAction INTEGER, 3378 bufferControlCaptureSliceSize INTEGER, 3379 bufferControlDownloadSliceSize INTEGER, 3380 bufferControlDownloadOffset INTEGER, 3381 bufferControlMaxOctetsRequested INTEGER, 3382 bufferControlMaxOctetsGranted INTEGER, 3383 bufferControlCapturedPackets INTEGER, 3384 bufferControlTurnOnTime TimeTicks, 3385 bufferControlOwner OwnerString, 3386 bufferControlStatus EntryStatus 3387 } 3389 bufferControlIndex OBJECT-TYPE 3390 SYNTAX INTEGER (1..65535) 3391 ACCESS read-only 3392 STATUS mandatory 3393 DESCRIPTION 3394 "An index that uniquely identifies an entry 3395 in the bufferControl table. The value of this 3396 index shall never be zero. Each such 3397 entry defines one set of packets that is 3398 captured and controlled by one or more filters." 3399 ::= { bufferControlEntry 1 } 3401 bufferControlChannelIndex OBJECT-TYPE 3402 SYNTAX INTEGER (1..65535) 3403 ACCESS read-write 3404 STATUS mandatory 3405 DESCRIPTION 3406 "An index that identifies the channel that is the 3407 source of packets for this bufferControl table. 3408 The channel identified by a particular value of this 3409 index is the same as identified by the same value of 3410 the channelIndex object. 3412 This object may not be modified if the associated 3413 bufferControlStatus object is equal to valid(1)." 3414 ::= { bufferControlEntry 2 } 3416 bufferControlFullStatus OBJECT-TYPE 3417 SYNTAX INTEGER { 3418 spaceAvailable(1), 3419 full(2) 3420 } 3421 ACCESS read-only 3422 STATUS mandatory 3423 DESCRIPTION 3424 "This object shows whether the buffer has room to 3425 accept new packets or if it is full. 3427 If the status is spaceAvailable(1), the buffer is 3428 accepting new packets normally. If the status is 3429 full(2) and the associated bufferControlFullAction 3430 object is wrapWhenFull, the buffer is accepting new 3431 packets by deleting enough of the oldest packets 3432 to make room for new ones as they arrive. Otherwise, 3433 if the status is full(2) and the 3434 bufferControlFullAction object is lockWhenFull, 3435 then the buffer has stopped collecting packets. 3437 When this object is set to full(2) the probe must 3438 not later set it to spaceAvailable(1) except in the 3439 case of a significant gain in resources such as 3440 an increase of bufferControlOctetsGranted. In 3441 particular, the wrap-mode action of deleting old 3442 packets to make room for newly arrived packets 3443 must not affect the value of this object." 3444 ::= { bufferControlEntry 3 } 3446 bufferControlFullAction OBJECT-TYPE 3447 SYNTAX INTEGER { 3448 lockWhenFull(1), 3449 wrapWhenFull(2) -- FIFO 3450 } 3451 ACCESS read-write 3452 STATUS mandatory 3453 DESCRIPTION 3454 "Controls the action of the buffer when it 3455 reaches the full status. When in the lockWhenFull(1) 3456 state a packet is added to the buffer that 3457 fills the buffer, the bufferControlFullStatus will 3458 be set to full(2) and this buffer will stop capturing 3459 packets." 3460 ::= { bufferControlEntry 4 } 3462 bufferControlCaptureSliceSize OBJECT-TYPE 3463 SYNTAX INTEGER 3464 ACCESS read-write 3465 STATUS mandatory 3466 DESCRIPTION 3467 "The maximum number of octets of each packet 3468 that will be saved in this capture buffer. 3469 For example, if a 1500 octet packet is received by 3470 the probe and this object is set to 500, then only 3471 500 octets of the packet will be stored in the 3472 associated capture buffer. If this variable is set 3473 to 0, the capture buffer will save as many octets 3474 as is possible. 3476 This object may not be modified if the associated 3477 bufferControlStatus object is equal to valid(1)." 3478 DEFVAL { 100 } 3479 ::= { bufferControlEntry 5 } 3481 bufferControlDownloadSliceSize OBJECT-TYPE 3482 SYNTAX INTEGER 3483 ACCESS read-write 3484 STATUS mandatory 3485 DESCRIPTION 3486 "The maximum number of octets of each packet 3487 in this capture buffer that will be returned in 3488 an SNMP retrieval of that packet. For example, 3489 if 500 octets of a packet have been stored in the 3490 associated capture buffer, the associated 3491 bufferControlDownloadOffset is 0, and this 3492 object is set to 100, then the captureBufferPacket 3493 object that contains the packet will contain only 3494 the first 100 octets of the packet. 3496 A prudent manager will take into account possible 3497 interoperability or fragmentation problems that may 3498 occur if the download slice size is set too large. 3499 In particular, conformant SNMP implementations are not 3500 required to accept messages whose length exceeds 484 3501 octets, although they are encouraged to support larger 3502 datagrams whenever feasible." 3503 DEFVAL { 100 } 3504 ::= { bufferControlEntry 6 } 3506 bufferControlDownloadOffset OBJECT-TYPE 3507 SYNTAX INTEGER 3508 ACCESS read-write 3509 STATUS mandatory 3510 DESCRIPTION 3511 "The offset of the first octet of each packet 3512 in this capture buffer that will be returned in 3513 an SNMP retrieval of that packet. For example, 3514 if 500 octets of a packet have been stored in the 3515 associated capture buffer and this object is set to 3516 100, then the captureBufferPacket object that 3517 contains the packet will contain bytes starting 3518 100 octets into the packet." 3519 DEFVAL { 0 } 3520 ::= { bufferControlEntry 7 } 3522 bufferControlMaxOctetsRequested OBJECT-TYPE 3523 SYNTAX INTEGER 3524 ACCESS read-write 3525 STATUS mandatory 3526 DESCRIPTION 3527 "The requested maximum number of octets to be 3528 saved in this captureBuffer, including any 3529 implementation-specific overhead. If this variable 3530 is set to -1, the capture buffer will save as many 3531 octets as is possible. 3533 When this object is created or modified, the probe 3534 should set bufferControlMaxOctetsGranted as closely 3535 to this object as is possible for the particular probe 3536 implementation and available resources. However, if 3537 the object has the special value of -1, the probe 3538 must set bufferControlMaxOctetsGranted to -1." 3539 DEFVAL { -1 } 3540 ::= { bufferControlEntry 8 } 3542 bufferControlMaxOctetsGranted OBJECT-TYPE 3543 SYNTAX INTEGER 3544 ACCESS read-only 3545 STATUS mandatory 3546 DESCRIPTION 3547 "The maximum number of octets that can be 3548 saved in this captureBuffer, including overhead. 3549 If this variable is -1, the capture buffer will save 3550 as many octets as possible. 3552 When the bufferControlMaxOctetsRequested object is 3553 created or modified, the probe should set this object 3554 as closely to the requested value as is possible for the 3555 particular probe implementation and available resources. 3556 However, if the request object has the special value 3557 of -1, the probe must set this object to -1. 3558 The probe must not lower this value except as a result of 3559 a modification to the associated 3560 bufferControlMaxOctetsRequested object. 3562 When this maximum number of octets is reached 3563 and a new packet is to be added to this 3564 capture buffer and the corresponding 3565 bufferControlFullAction is set to wrapWhenFull(2), 3566 enough of the oldest packets associated with this 3567 capture buffer shall be deleted by the agent so 3568 that the new packet can be added. If the corresponding 3569 bufferControlFullAction is set to lockWhenFull(1), 3570 the new packet shall be discarded. In either case, 3571 the probe must set bufferControlFullStatus to 3572 full(2). 3574 When the value of this object changes to a value less 3575 than the current value, entries are deleted from 3576 the captureBufferTable associated with this 3577 bufferControlEntry. Enough of the 3578 oldest of these captureBufferEntries shall be 3579 deleted by the agent so that the number of octets 3580 used remains less than or equal to the new value of 3581 this object. 3583 When the value of this object changes to a value greater 3584 than the current value, the number of associated 3585 captureBufferEntries may be allowed to grow." 3586 ::= { bufferControlEntry 9 } 3588 bufferControlCapturedPackets OBJECT-TYPE 3589 SYNTAX INTEGER 3590 ACCESS read-only 3591 STATUS mandatory 3592 DESCRIPTION 3593 "The number of packets currently in this captureBuffer." 3594 ::= { bufferControlEntry 10 } 3596 bufferControlTurnOnTime OBJECT-TYPE 3597 SYNTAX TimeTicks 3598 ACCESS read-only 3599 STATUS mandatory 3600 DESCRIPTION 3601 "The value of sysUpTime when this capture buffer was 3602 first turned on." 3603 ::= { bufferControlEntry 11 } 3605 bufferControlOwner OBJECT-TYPE 3606 SYNTAX OwnerString 3607 ACCESS read-write 3608 STATUS mandatory 3609 DESCRIPTION 3610 "The entity that configured this entry and is therefore 3611 using the resources assigned to it." 3612 ::= { bufferControlEntry 12 } 3614 bufferControlStatus OBJECT-TYPE 3615 SYNTAX EntryStatus 3616 ACCESS read-write 3617 STATUS mandatory 3618 DESCRIPTION 3619 "The status of this buffer Control Entry." 3620 ::= { bufferControlEntry 13 } 3622 captureBufferTable OBJECT-TYPE 3623 SYNTAX SEQUENCE OF CaptureBufferEntry 3624 ACCESS not-accessible 3625 STATUS mandatory 3626 DESCRIPTION 3627 "A list of packets captured off of a channel." 3628 ::= { capture 2 } 3630 captureBufferEntry OBJECT-TYPE 3631 SYNTAX CaptureBufferEntry 3632 ACCESS not-accessible 3633 STATUS mandatory 3634 DESCRIPTION 3635 "A packet captured off of an attached network. As an 3636 example, an instance of the captureBufferPacketData 3637 object might be named captureBufferPacketData.3.1783" 3638 INDEX { captureBufferControlIndex, captureBufferIndex } 3639 ::= { captureBufferTable 1 } 3641 CaptureBufferEntry ::= SEQUENCE { 3642 captureBufferControlIndex INTEGER (1..65535), 3643 captureBufferIndex INTEGER (1..2147483647), 3644 captureBufferPacketID INTEGER, 3645 captureBufferPacketData OCTET STRING, 3646 captureBufferPacketLength INTEGER, 3647 captureBufferPacketTime INTEGER, 3648 captureBufferPacketStatus INTEGER 3649 } 3651 captureBufferControlIndex OBJECT-TYPE 3652 SYNTAX INTEGER (1..65535) 3653 ACCESS read-only 3654 STATUS mandatory 3655 DESCRIPTION 3656 "The index of the bufferControlEntry with which 3657 this packet is associated." 3658 ::= { captureBufferEntry 1 } 3660 captureBufferIndex OBJECT-TYPE 3661 SYNTAX INTEGER (1..2147483647) 3662 ACCESS read-only 3663 STATUS mandatory 3664 DESCRIPTION 3665 "An index that uniquely identifies an entry 3666 in the captureBuffer table associated with a 3667 particular bufferControlEntry. This index will 3668 start at 1 and increase by one for each new packet 3669 added with the same captureBufferControlIndex. 3671 Should this value reach 2147483647, the next packet 3672 added with the same captureBufferControlIndex shall 3673 cause this value to wrap around to 1." 3674 ::= { captureBufferEntry 2 } 3676 captureBufferPacketID OBJECT-TYPE 3677 SYNTAX INTEGER 3678 ACCESS read-only 3679 STATUS mandatory 3680 DESCRIPTION 3681 "An index that describes the order of packets 3682 that are received on a particular interface. 3683 The packetID of a packet captured on an 3684 interface is defined to be greater than the 3685 packetID's of all packets captured previously on 3686 the same interface. As the captureBufferPacketID 3687 object has a maximum positive value of 2^31 - 1, 3688 any captureBufferPacketID object shall have the 3689 value of the associated packet's packetID mod 2^31." 3690 ::= { captureBufferEntry 3 } 3692 captureBufferPacketData OBJECT-TYPE 3693 SYNTAX OCTET STRING 3694 ACCESS read-only 3695 STATUS mandatory 3696 DESCRIPTION 3697 "The data inside the packet, starting at the beginning 3698 of the packet plus any offset specified in the 3699 associated bufferControlDownloadOffset, including any 3700 link level headers. The length of the data in this object 3701 is the minimum of the length of the captured packet minus 3702 the offset, the length of the associated 3703 bufferControlCaptureSliceSize minus the offset, and the 3704 associated bufferControlDownloadSliceSize. If this minimum 3705 is less than zero, this object shall have a length of zero." 3706 ::= { captureBufferEntry 4 } 3708 captureBufferPacketLength OBJECT-TYPE 3709 SYNTAX INTEGER 3710 ACCESS read-only 3711 STATUS mandatory 3712 DESCRIPTION 3713 "The actual length (off the wire) of the packet stored 3714 in this entry, including FCS octets." 3715 ::= { captureBufferEntry 5 } 3717 captureBufferPacketTime OBJECT-TYPE 3718 SYNTAX INTEGER 3719 ACCESS read-only 3720 STATUS mandatory 3721 DESCRIPTION 3722 "The number of milliseconds that had passed since 3723 this capture buffer was first turned on when this 3724 packet was captured." 3725 ::= { captureBufferEntry 6 } 3727 captureBufferPacketStatus OBJECT-TYPE 3728 SYNTAX INTEGER 3729 ACCESS read-only 3730 STATUS mandatory 3731 DESCRIPTION 3732 "A value which indicates the error status of this packet. 3734 The value of this object is defined in the same way as 3735 filterPktStatus. The value is a sum. This sum 3736 initially takes the value zero. Then, for each 3737 error, E, that has been discovered in this packet, 3738 2 raised to a value representing E is added to the sum. 3740 The errors defined for a packet captured off of an 3741 Ethernet interface are as follows: 3743 bit # Error 3744 0 Packet is longer than 1518 octets 3745 1 Packet is shorter than 64 octets 3746 2 Packet experienced a CRC or Alignment error 3747 3 First packet in this capture buffer after 3748 it was detected that some packets were 3749 not processed correctly. 3750 4 Packet's order in buffer is only approximate 3751 (May only be set for packets sent from 3752 the probe) 3754 For example, an Ethernet fragment would have a 3755 value of 6 (2^1 + 2^2). 3757 As this MIB is expanded to new media types, this object 3758 will have other media-specific errors defined." 3759 ::= { captureBufferEntry 7 } 3761 -- The Event Group 3763 -- Implementation of the Event group is optional. 3764 -- 3765 -- The Event group controls the generation and notification 3766 -- of events from this device. Each entry in the eventTable 3767 -- describes the parameters of the event that can be triggered. 3768 -- Each event entry is fired by an associated condition located 3769 -- elsewhere in the MIB. An event entry may also be associated 3770 -- with a function elsewhere in the MIB that will be executed 3771 -- when the event is generated. For example, a channel may 3772 -- be turned on or off by the firing of an event. 3773 -- 3774 -- Each eventEntry may optionally specify that a log entry 3775 -- be created on its behalf whenever the event occurs. 3776 -- Each entry may also specify that notification should 3777 -- occur by way of SNMP trap messages. In this case, the 3778 -- community for the trap message is given in the associated 3779 -- eventCommunity object. The enterprise and specific trap 3780 -- fields of the trap are determined by the condition that 3781 -- triggered the event. Two traps are defined: risingAlarm and 3782 -- fallingAlarm. If the eventTable is triggered by a condition 3783 -- specified elsewhere, the enterprise and specific trap fields 3784 -- must be specified for traps generated for that condition. 3786 eventTable OBJECT-TYPE 3787 SYNTAX SEQUENCE OF EventEntry 3788 ACCESS not-accessible 3789 STATUS mandatory 3790 DESCRIPTION 3791 "A list of events to be generated." 3792 ::= { event 1 } 3794 eventEntry OBJECT-TYPE 3795 SYNTAX EventEntry 3796 ACCESS not-accessible 3797 STATUS mandatory 3798 DESCRIPTION 3799 "A set of parameters that describe an event to be generated 3800 when certain conditions are met. As an example, an instance 3801 of the eventLastTimeSent object might be named 3802 eventLastTimeSent.6" 3803 INDEX { eventIndex } 3804 ::= { eventTable 1 } 3806 EventEntry ::= SEQUENCE { 3807 eventIndex INTEGER (1..65535), 3808 eventDescription DisplayString (SIZE (0..127)), 3809 eventType INTEGER, 3810 eventCommunity OCTET STRING (SIZE (0..127)), 3811 eventLastTimeSent TimeTicks, 3812 eventOwner OwnerString, 3813 eventStatus EntryStatus 3814 } 3816 eventIndex OBJECT-TYPE 3817 SYNTAX INTEGER (1..65535) 3818 ACCESS read-only 3819 STATUS mandatory 3820 DESCRIPTION 3821 "An index that uniquely identifies an entry in the 3822 event table. Each such entry defines one event that 3823 is to be generated when the appropriate conditions 3824 occur." 3825 ::= { eventEntry 1 } 3827 eventDescription OBJECT-TYPE 3828 SYNTAX DisplayString (SIZE (0..127)) 3829 ACCESS read-write 3830 STATUS mandatory 3831 DESCRIPTION 3832 "A comment describing this event entry." 3833 ::= { eventEntry 2 } 3835 eventType OBJECT-TYPE 3836 SYNTAX INTEGER { 3837 none(1), 3838 log(2), 3839 snmp-trap(3), -- send an SNMP trap 3840 log-and-trap(4) 3841 } 3842 ACCESS read-write 3843 STATUS mandatory 3844 DESCRIPTION 3845 "The type of notification that the probe will make 3846 about this event. In the case of log, an entry is 3847 made in the log table for each event. In the case of 3848 snmp-trap, an SNMP trap is sent to one or more 3849 management stations." 3850 ::= { eventEntry 3 } 3852 eventCommunity OBJECT-TYPE 3853 SYNTAX OCTET STRING (SIZE (0..127)) 3854 ACCESS read-write 3855 STATUS mandatory 3856 DESCRIPTION 3857 "If an SNMP trap is to be sent, it will be sent to 3858 the SNMP community specified by this octet string. 3859 In the future this table will be extended to include 3860 the party security mechanism. This object shall be 3861 set to a string of length zero if it is intended that 3862 that mechanism be used to specify the destination of 3863 the trap." 3864 ::= { eventEntry 4 } 3866 eventLastTimeSent OBJECT-TYPE 3867 SYNTAX TimeTicks 3868 ACCESS read-only 3869 STATUS mandatory 3870 DESCRIPTION 3871 "The value of sysUpTime at the time this event 3872 entry last generated an event. If this entry has 3873 not generated any events, this value will be 3874 zero." 3875 ::= { eventEntry 5 } 3877 eventOwner OBJECT-TYPE 3878 SYNTAX OwnerString 3879 ACCESS read-write 3880 STATUS mandatory 3881 DESCRIPTION 3882 "The entity that configured this entry and is therefore 3883 using the resources assigned to it. 3885 If this object contains a string starting with 'monitor' 3886 and has associated entries in the log table, all connected 3887 management stations should retrieve those log entries, 3888 as they may have significance to all management stations 3889 connected to this device" 3890 ::= { eventEntry 6 } 3892 eventStatus OBJECT-TYPE 3893 SYNTAX EntryStatus 3894 ACCESS read-write 3895 STATUS mandatory 3896 DESCRIPTION 3897 "The status of this event entry. 3899 If this object is not equal to valid(1), all associated 3900 log entries shall be deleted by the agent." 3901 ::= { eventEntry 7 } 3903 -- 3904 logTable OBJECT-TYPE 3905 SYNTAX SEQUENCE OF LogEntry 3906 ACCESS not-accessible 3907 STATUS mandatory 3908 DESCRIPTION 3909 "A list of events that have been logged." 3910 ::= { event 2 } 3912 logEntry OBJECT-TYPE 3913 SYNTAX LogEntry 3914 ACCESS not-accessible 3915 STATUS mandatory 3916 DESCRIPTION 3917 "A set of data describing an event that has been 3918 logged. For example, an instance of the logDescription 3919 object might be named logDescription.6.47" 3920 INDEX { logEventIndex, logIndex } 3921 ::= { logTable 1 } 3923 LogEntry ::= SEQUENCE { 3924 logEventIndex INTEGER (1..65535), 3925 logIndex INTEGER (1..2147483647), 3926 logTime TimeTicks, 3927 logDescription DisplayString (SIZE (0..255)) 3928 } 3930 logEventIndex OBJECT-TYPE 3931 SYNTAX INTEGER (1..65535) 3932 ACCESS read-only 3933 STATUS mandatory 3934 DESCRIPTION 3935 "The event entry that generated this log 3936 entry. The log identified by a particular 3937 value of this index is associated with the same 3938 eventEntry as identified by the same value 3939 of eventIndex." 3940 ::= { logEntry 1 } 3942 logIndex OBJECT-TYPE 3943 SYNTAX INTEGER (1..2147483647) 3944 ACCESS read-only 3945 STATUS mandatory 3946 DESCRIPTION 3947 "An index that uniquely identifies an entry 3948 in the log table amongst those generated by the 3949 same eventEntries. These indexes are 3950 assigned beginning with 1 and increase by one 3951 with each new log entry. The association 3952 between values of logIndex and logEntries 3953 is fixed for the lifetime of each logEntry. 3954 The agent may choose to delete the oldest 3955 instances of logEntry as required because of 3956 lack of memory. It is an implementation-specific 3957 matter as to when this deletion may occur." 3958 ::= { logEntry 2 } 3960 logTime OBJECT-TYPE 3961 SYNTAX TimeTicks 3962 ACCESS read-only 3963 STATUS mandatory 3964 DESCRIPTION 3965 "The value of sysUpTime when this log entry was created." 3966 ::= { logEntry 3 } 3968 logDescription OBJECT-TYPE 3969 SYNTAX DisplayString (SIZE (0..255)) 3970 ACCESS read-only 3971 STATUS mandatory 3972 DESCRIPTION 3973 "An implementation dependent description of the 3974 event that activated this log entry." 3975 ::= { logEntry 4 } 3977 -- These definitions use the TRAP-TYPE macro as defined in [10] 3979 -- Remote Network Monitoring Traps 3981 risingAlarm TRAP-TYPE 3982 ENTERPRISE rmon 3983 VARIABLES { alarmIndex, alarmVariable, alarmSampleType, 3984 alarmValue, alarmRisingThreshold } 3985 DESCRIPTION 3986 "The SNMP trap that is generated when an alarm 3987 entry crosses its rising threshold and generates 3988 an event that is configured for sending SNMP 3989 traps." 3990 ::= 1 3992 fallingAlarm TRAP-TYPE 3993 ENTERPRISE rmon 3994 VARIABLES { alarmIndex, alarmVariable, alarmSampleType, 3995 alarmValue, alarmFallingThreshold } 3996 DESCRIPTION 3997 "The SNMP trap that is generated when an alarm 3998 entry crosses its falling threshold and generates 3999 an event that is configured for sending SNMP 4000 traps." 4001 ::= 2 4003 END 4004 8. Acknowledgments 4006 This document was produced by the IETF Remote Network 4007 Monitoring Working Group. 4009 9. References 4011 [1] V. Cerf, IAB Recommendations for the Development of 4012 Internet Network Management Standards. Internet Working 4013 Group Request for Comments 1052. Network Information 4014 Center, SRI International, Menlo Park, California, 4015 (April, 1988). 4017 [2] V. Cerf, Report of the Second Ad Hoc Network Management 4018 Review Group, Internet Working Group Request for Comments 4019 1109. Network Information Center, SRI International, 4020 Menlo Park, California, (August, 1989). 4022 [3] M.T. Rose and K. McCloghrie, Structure and Identification 4023 of Management Information for TCP/IP-based internets, 4024 Internet Working Group Request for Comments 1155. 4025 Network Information Center, SRI International, Menlo 4026 Park, California, (May, 1990). 4028 [4] K. McCloghrie and M.T. Rose, Management Information Base 4029 for Network Management of TCP/IP-based internets, 4030 Internet Working Group Request for Comments 1156. 4031 Network Information Center, SRI International, Menlo 4032 Park, California, (May, 1990). 4034 [5] J.D. Case, M.S. Fedor, M.L. Schoffstall, and J.R. Davin, 4035 Simple Network Management Protocol, Internet Working 4036 Group Request for Comments 1157. Network Information 4037 Center, SRI International, Menlo Park, California, (May, 4038 1990). 4040 [6] M.T. Rose (editor), Management Information Base for 4041 Network Management of TCP/IP-based internets: MIB-II, 4042 Internet Working Group Request for Comments 1158. 4043 Network Information Center, SRI International, Menlo 4044 Park, California, (May, 1990). 4046 [7] Information processing systems - Open Systems 4047 Interconnection - Specification of Abstract Syntax 4048 Notation One (ASN.1), International Organization for 4049 Standardization. International Standard 8824, (December, 4050 1987). 4052 [8] Information processing systems - Open Systems 4053 Interconnection - Specification of Basic Encoding Rules 4054 for Abstract Notation One (ASN.1), International 4055 Organization for Standardization. International Standard 4056 8825, (December, 1987). 4058 [9] M.T. Rose, K. McCloghrie, Editors, Concise MIB 4059 Definitions, Internet Working Group Request for Comments 4060 1212. Network Information Center, SRI International, 4061 Menlo Park, California, (March, 1991). 4063 [10] M.T. Rose, Editor, A Convention for Defining Traps for 4064 use with the SNMP, Internet Working Group Request for 4065 Comments 1215. Network Information Center, SRI 4066 International, Menlo Park, California, (March, 1991). 4068 Table of Contents 4070 1 Status of this Memo ................................... 1 4071 2 Abstract .............................................. 1 4072 3 The Network Management Framework ...................... 3 4073 4 Overview .............................................. 4 4074 4.1 Remote Network Management Goals ..................... 4 4075 4.2 Textual Conventions ................................. 6 4076 4.3 Structure of MIB .................................... 6 4077 4.3.1 The Ethernet Statistics Group ..................... 7 4078 4.3.2 The History Control Group ......................... 7 4079 4.3.3 The Ethernet History Group ........................ 7 4080 4.3.4 The Alarm Group ................................... 8 4081 4.3.5 The Host Group .................................... 8 4082 4.3.6 The HostTopN Group ................................ 8 4083 4.3.7 The Matrix Group .................................. 8 4084 4.3.8 The Filter Group .................................. 8 4085 4.3.9 The Packet Capture Group .......................... 9 4086 4.3.10 The Event Group .................................. 9 4087 5 Control of Remote Network Monitoring Devices .......... 10 4088 5.1 Resource Sharing Among Multiple Management Sta- 4089 tions .............................................. 10 4090 5.2 Row Addition Among Multiple Management Stations ..... 12 4091 6 Conventions ........................................... 14 4092 7 Definitions ........................................... 15 4093 8 Acknowledgments ....................................... 98 4094 9 References ............................................ 99