idnits 2.17.1 draft-ietf-rmonmib-rmon2-v2-02.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3667, Section 5.1 on line 18. -- Found old boilerplate from RFC 3978, Section 5.5 on line 6562. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 6574. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 6581. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 6587. ** The document claims conformance with section 10 of RFC 2026, but uses some RFC 3978/3979 boilerplate. As RFC 3978/3979 replaces section 10 of RFC 2026, you should not claim conformance with it if you have changed to using RFC 3978/3979 boilerplate. ** The document seems to lack an RFC 3978 Section 5.1 IPR Disclosure Acknowledgement -- however, there's a paragraph with a matching beginning. Boilerplate error? ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. ** The document uses RFC 3667 boilerplate or RFC 3978-like boilerplate instead of verbatim RFC 3978 boilerplate. After 6 May 2005, submission of drafts without verbatim RFC 3978 boilerplate is not accepted. The following non-3978 patterns matched text found in the document. That text should be removed or replaced: By submitting this Internet-Draft, I certify that any applicable patent or other IPR claims of which I am aware have been disclosed, or will be disclosed, and any of which I become aware will be disclosed, in accordance with RFC 3668. 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 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** 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.) ** There are 5 instances of too long lines in the document, the longest one being 3 characters in excess of 72. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. RFC 2119 keyword, line 4365: '...ryObjectVariable SHOULD be checked for...' RFC 2119 keyword, line 6072: '...iable, the agent MUST ensure that usrH...' RFC 2119 keyword, line 6077: '...reason, an agent SHOULD check the acce...' -- The abstract seems to indicate that this document obsoletes RFC2021, but the header doesn't have an 'Obsoletes:' line to match this. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 4086 has weird spacing: '...ticular probe...' == Line 4524 has weird spacing: '... field octet...' == Line 4778 has weird spacing: '...se code bps...' == Line 5013 has weird spacing: '... octets cont...' == Line 5022 has weird spacing: '... octets cont...' == (5 more instances...) -- 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 (October 6, 2004) is 7140 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. 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: 'RFC 1513' is mentioned on line 686, but not defined == Missing Reference: 'RFC1906' is mentioned on line 5019, but not defined ** Obsolete undefined reference: RFC 1906 (Obsoleted by RFC 3417) == Unused Reference: 'RFC3411' is defined on line 6517, but no explicit reference was found in the text == Unused Reference: 'RFC1513' is defined on line 6526, but no explicit reference was found in the text Summary: 13 errors (**), 0 flaws (~~), 12 warnings (==), 9 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Remote Network Monitoring 3 Management Information Base 4 Version 2 5 7 October 6, 2004 9 Steven Waldbusser 11 waldbusser@nextbeacon.com 13 Status of this Memo 15 By submitting this Internet-Draft, I certify that any applicable 16 patent or other IPR claims of which I am aware have been disclosed, 17 and any of which I become aware will be disclosed, in accordance with 18 RFC 3668. 20 This document is an Internet-Draft and is in full 21 conformance with all provisions of Section 10 of RFC2026. 23 Internet-Drafts are working documents of the Internet 24 Engineering Task Force (IETF), its areas, and its working 25 groups. Note that other groups may also distribute working 26 documents as Internet-Drafts. 28 Internet-Drafts are draft documents valid for a maximum of 29 six months and may be updated, replaced, or obsoleted by 30 other documents at any time. It is inappropriate to use 31 Internet- Drafts as reference material or to cite them 32 other than as "work in progress". 34 The list of current Internet-Drafts can be accessed at 35 http://www.ietf.org/ietf/1id-abstracts.txt 37 The list of Internet-Draft Shadow Directories can be 38 accessed at http://www.ietf.org/shadow.html. 40 Distribution of this document is unlimited. Please send 41 comments to the RMON WG mailing list . 43 Copyright Notice 45 Copyright (C) The Internet Society (2004). 47 Abstract 49 This document defines a portion of the Management 50 Information Base (MIB) for use with network management 51 protocols in TCP/IP-based internets. In particular, it 52 defines objects for managing remote network monitoring 53 devices. 55 This document obsoletes RFC 2021 and the RMON2-MIB module 56 contained in this memo obsoletes the RMON2-MIB module at 57 RFC3273 level. 59 XXX Note To RFC Editor: 60 Please replace the module at: 61 ftp://ftp.rfc-editor.org/in-notes/mibs/current.mibs/rmon2.mib 62 with the RMON2-MIB module in this document 63 XXX 65 Table of Contents 67 1 The Internet-Standard Management Framework ............ 3 68 2 Overview .............................................. 4 69 2.1 Remote Network Management Goals ..................... 4 70 2.2 Structure of MIB .................................... 6 71 3 Control of Remote Network Monitoring Devices .......... 8 72 3.1 Resource Sharing Among Multiple Management Sta- 73 tions .............................................. 8 74 3.2 Row Addition Among Multiple Management Stations ..... 10 75 4 Conventions ........................................... 12 76 5 RMON 2 Conventions .................................... 13 77 5.1 Usage of the term Application Level ................. 13 78 5.2 Protocol Directory and Limited Extensibility ........ 13 79 5.3 Errors in packets ................................... 14 80 6 Definitions ........................................... 14 81 7 Security Considerations ............................... 140 82 8 Appendix - TimeFilter Implementation Notes ............ 142 83 9 Changes since RFC 2021 ................................ 148 84 10 Acknowledgments ...................................... 150 85 11 Author's Address ..................................... 150 86 12 References ........................................... 151 87 12.1 Normative References ............................... 151 88 12.2 Informative References ............................. 151 89 13 Full Copyright Statement ............................. 152 91 1. The Internet-Standard Management Framework 93 For a detailed overview of the documents that describe the 94 current Internet-Standard Management Framework, please 95 refer to section 7 of RFC 3410 [RFC3410]. 97 Managed objects are accessed via a virtual information 98 store, termed the Management Information Base or MIB. MIB 99 objects are generally accessed through the Simple Network 100 Management Protocol (SNMP). Objects in the MIB are defined 101 using the mechanisms defined in the Structure of Management 102 Information (SMI). This memo specifies a MIB module that 103 is compliant to the SMIv2, which is described in STD 58, 104 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, 105 RFC 2580 [RFC2580]. 107 2. Overview 109 The RMON2 MIB defines objects that provide RMON analysis up to 110 the application layer. 112 Remote network monitoring devices, often called monitors or 113 probes, are instruments that exist for the purpose of managing 114 a network. Often these remote probes are stand-alone devices 115 and devote significant internal resources for the sole purpose 116 of managing a network. An organization may employ many of 117 these devices, one per network segment, to manage its 118 internet. In addition, these devices may be used for a 119 network management service provider to access a client 120 network, often geographically remote. 122 The objects defined in this document are intended as an 123 interface between an RMON agent and an RMON management 124 application and are not intended for direct manipulation by 125 humans. While some users may tolerate the direct display of 126 some of these objects, few will tolerate the complexity of 127 manually manipulating objects to accomplish row creation. 128 These functions should be handled by the management 129 application. 131 2.1. Remote Network Management Goals 133 o Offline Operation 134 There are sometimes conditions when a management 135 station will not be in constant contact with its 136 remote monitoring devices. This is sometimes by 137 design in an attempt to lower communications costs 138 (especially when communicating over a WAN or 139 dialup link), or by accident as network failures 140 affect the communications between the management 141 station and the probe. 143 For this reason, this MIB allows a probe to be 144 configured to perform diagnostics and to collect 145 statistics continuously, even when communication with 146 the management station may not be possible or 147 efficient. The probe may then attempt to notify 148 the management station when an exceptional condition 149 occurs. Thus, even in circumstances where 150 communication between management station and probe is 151 not continuous, fault, performance, and configuration 152 information may be continuously accumulated and 153 communicated to the management station conveniently 154 and efficiently. 156 o Proactive Monitoring 157 Given the resources available on the monitor, it 158 is potentially helpful for it continuously to run 159 diagnostics and to log network performance. The 160 monitor is always available at the onset of any 161 failure. It can notify the management station of the 162 failure and can store historical statistical 163 information about the failure. This historical 164 information can be played back by the management 165 station in an attempt to perform further diagnosis 166 into the cause of the problem. 168 o Problem Detection and Reporting 169 The monitor can be configured to recognize 170 conditions, most notably error conditions, and 171 continuously to check for them. When one of these 172 conditions occurs, the event may be logged, and 173 management stations may be notified in a number of 174 ways. 176 o Value Added Data 177 Because a remote monitoring device represents a 178 network resource dedicated exclusively to network 179 management functions, and because it is located 180 directly on the monitored portion of the network, the 181 remote network monitoring device has the opportunity 182 to add significant value to the data it collects. 183 For instance, by highlighting those hosts on the 184 network that generate the most traffic or errors, the 185 probe can give the management station precisely the 186 information it needs to solve a class of problems. 188 o Multiple Managers 189 An organization may have multiple management stations 190 for different units of the organization, for different 191 functions (e.g. engineering and operations), and in an 192 attempt to provide disaster recovery. Because 193 environments with multiple management stations are 194 common, the remote network monitoring device has to 195 deal with more than own management station, 196 potentially using its resources concurrently. 198 2.2. Structure of MIB 200 The objects are arranged into the following groups: 202 - protocol directory 204 - protocol distribution 206 - address mapping 208 - network layer host 210 - network layer matrix 212 - application layer host 214 - application layer matrix 216 - user history 218 - probe configuration 220 These groups are the basic units of conformance. If a remote 221 monitoring device implements a group, then it must implement 222 all objects in that group. For example, a managed agent that 223 implements the network layer matrix group must implement the 224 nlMatrixSDTable and the nlMatrixDSTable. 226 Implementations of this MIB must also implement the IF-MIB 227 [RFC2863]. 229 These groups are defined to provide a means of assigning 230 object identifiers, and to provide a method for managed agents 231 to know which objects they must implement. 233 This document also contains enhancements to tables defined in 234 the RMON MIB [RFC2819]. These enhancements include: 236 1) Adding the DroppedFrames and LastCreateTime 237 conventions to each table defined in the RMON MIB. 239 2) Augmenting the RMON filter table with a mechanism 240 that allows filtering based on an offset from the 241 beginning of a particular protocol, even if the 242 protocol headers are variable length. 244 3) Augmenting the RMON filter and capture status bits 245 with additional bits for WAN media and generic media. 246 These bits are defined here as: 248 Bit Definition 249 6 For WAN media, this bit is set for packets 250 coming from one direction and cleared for 251 packets coming from the other direction. 252 It is an implementation specific matter 253 as to which bit is assigned to which 254 direction, but it must be consistent for 255 all packets received by the agent, and if 256 the agent knows which end of the link is 257 "local" and which end is "network", the bit 258 should be set for packets from the "local" 259 side and should be cleared for packets from 260 the "network" side. 262 7 For any media, this bit is set for any packet 263 with a physical layer error. This bit may be 264 set in addition to other media-specific bits 265 that denote the same condition. 267 8 For any media, this bit is set for any packet 268 that is too short for the media. This bit may 269 be set in addition to other media-specific 270 bits that denote the same condition. 271 9 For any media, this bit is set for any packet 272 that is too long for the media. This bit may 273 be set in addition to other media-specific bits 274 that denote the same condition. 276 These enhancements are implemented by RMON-2 probes that also 277 implement RMON and do not add any requirements to probes that 278 are compliant to just RMON. 280 3. Control of Remote Network Monitoring Devices 282 Due to the complex nature of the available functions in these 283 devices, the functions often need user configuration. In many 284 cases, the function requires parameters to be set up for a 285 data collection operation. The operation can proceed only 286 after these parameters are fully set up. 288 Many functional groups in this MIB have one or more tables in 289 which to set up control parameters, and one or more data 290 tables in which to place the results of the operation. The 291 control tables are typically read/write in nature, while the 292 data tables are typically read/only. Because the parameters 293 in the control table often describe resulting data in the data 294 table, many of the parameters can be modified only when the 295 control entry is not active. Thus, the method for modifying 296 these parameters is to de-activate the entry, perform the SNMP 297 Set operations to modify the entry, and then re-activate the 298 entry. Deleting the control entry causes the deletion of any 299 associated data entries, which also gives a convenient method 300 for reclaiming the resources used by the associated data. 302 Some objects in this MIB provide a mechanism to execute an 303 action on the remote monitoring device. These objects may 304 execute an action as a result of a change in the state of the 305 object. For those objects in this MIB, a request to set an 306 object to the same value as it currently holds would thus 307 cause no action to occur. 309 To facilitate control by multiple managers, resources have to 310 be shared among the managers. These resources are typically 311 the memory and computation resources that a function requires. 313 3.1. Resource Sharing Among Multiple Management Stations 315 When multiple management stations wish to use functions that 316 compete for a finite amount of resources on a device, a method 317 to facilitate this sharing of resources is required. 318 Potential conflicts include: 320 o Two management stations wish to simultaneously use 321 resources that together would exceed the capability of 322 the device. 323 o A management station uses a significant amount of 324 resources for a long period of time. 325 o A management station uses resources and then crashes, 326 forgetting to free the resources so others may 327 use them. 329 The OwnerString mechanism is provided for each management 330 station initiated function in this MIB to avoid these 331 conflicts and to help resolve them when they occur. Each 332 function has a label identifying the initiator (owner) of the 333 function. This label is set by the initiator to provide for 334 the following possibilities: 336 o A management station may recognize resources it owns 337 and no longer needs. 338 o A network operator can find the management station that 339 owns the resource and negotiate for it to be freed. 340 o A network operator may decide to unilaterally free 341 resources another network operator has reserved. 342 o Upon initialization, a management station may recognize 343 resources it had reserved in the past. With this 344 information it may free the resources if it no longer 345 needs them. 347 Management stations and probes should support any format of 348 the owner string dictated by the local policy of the 349 organization. It is suggested that this name contain one or 350 more of the following: IP address, management station name, 351 network manager's name, location, or phone number. This 352 information will help users to share the resources more 353 effectively. 355 There is often default functionality that the device or the 356 administrator of the probe (often the network administrator) 357 wishes to set up. The resources associated with this 358 functionality are then owned by the device itself or by the 359 network administrator, and are intended to be long-lived. In 360 this case, the device or the administrator will set the 361 relevant owner object to a string starting with 'monitor'. 362 Indiscriminate modification of the monitor-owned configuration 363 by network management stations is discouraged. In fact, a 364 network management station should only modify these objects 365 under the direction of the administrator of the probe. 367 Resources on a probe are scarce and are typically allocated 368 when control rows are created by an application. Since many 369 applications may be using a probe simultaneously, 370 indiscriminate allocation of resources to particular 371 applications is very likely to cause resource shortages in the 372 probe. 374 When a network management station wishes to utilize a function 375 in a monitor, it is encouraged to first scan the control table 376 of that function to find an instance with similar parameters 377 to share. This is especially true for those instances owned 378 by the monitor, which can be assumed to change infrequently. 379 If a management station decides to share an instance owned by 380 another management station, it should understand that the 381 management station that owns the instance may indiscriminately 382 modify or delete it. 384 It should be noted that a management application should have 385 the most trust in a monitor-owned row because it should be 386 changed very infrequently. A row owned by the management 387 application is less long-lived because a network administrator 388 is more likely to re-assign resources from a row that is in 389 use by one user than from a monitor-owned row that is 390 potentially in use by many users. A row owned by another 391 application would be even less long-lived because the other 392 application may delete or modify that row completely at its 393 discretion. 395 3.2. Row Addition Among Multiple Management Stations 397 The addition of new rows is achieved using the RowStatus 398 Textual Convention [RFC2579]. In this MIB, rows are often 399 added to a table in order to configure a function. This 400 configuration usually involves parameters that control the 401 operation of the function. The agent must check these 402 parameters to make sure they are appropriate given 403 restrictions defined in this MIB as well as any implementation 404 specific restrictions such as lack of resources. The agent 405 implementor may be confused as to when to check these 406 parameters and when to signal to the management station that 407 the parameters are invalid. There are two opportunities: 409 o When the management station sets each parameter object. 411 o When the management station sets the row status object 412 to active. 414 If the latter is chosen, it would be unclear to the management 415 station which of the several parameters was invalid and caused 416 the badValue error to be emitted. Thus, wherever possible, 417 the implementor should choose the former as it will provide 418 more information to the management station. 420 A problem can arise when multiple management stations attempt 421 to set configuration information simultaneously using SNMP. 422 When this involves the addition of a new conceptual row in the 423 same control table, the managers may collide, attempting to 424 create the same entry. To guard against these collisions, 425 each such control entry contains a status object with special 426 semantics that help to arbitrate among the managers. If an 427 attempt is made with the row addition mechanism to create such 428 a status object and that object already exists, an error is 429 returned. When more than one manager simultaneously attempts 430 to create the same conceptual row, only the first will 431 succeed. The others will receive an error. 433 In the RMON MIB [RFC2819], the EntryStatus textual convention 434 was introduced to provide this mutual exclusion function. 435 Since then, this function was added to the SNMP framework as 436 the RowStatus textual convention. The RowStatus textual 437 convention is used for the definition of all new tables. 439 When a manager wishes to create a new control entry, it needs 440 to choose an index for that row. It may choose this index in 441 a variety of ways, hopefully minimizing the chances that the 442 index is in use by another manager. If the index is in use, 443 the mechanism mentioned previously will guard against 444 collisions. Examples of schemes to choose index values 445 include random selection or scanning the control table looking 446 for the first unused index. Because index values may be any 447 valid value in the range and they are chosen by the manager, 448 the agent must allow a row to be created with any unused index 449 value if it has the resources to create a new row. 451 Some tables in this MIB reference other tables within this 452 MIB. When creating or deleting entries in these tables, it is 453 generally allowable for dangling references to exist. There 454 is no defined order for creating or deleting entries in these 455 tables. 457 4. Conventions 459 The following conventions are used throughout the RMON MIB and 460 its companion documents. 462 Good Packets 464 Good packets are error-free packets that have a valid frame 465 length. For example, on Ethernet, good packets are error-free 466 packets that are between 64 octets long and 1518 octets long. 467 They follow the form defined in IEEE 802.3 section 3.2.all. 469 Bad Packets 471 Bad packets are packets that have proper framing and are 472 therefore recognized as packets, but contain errors within the 473 packet or have an invalid length. For example, on Ethernet, 474 bad packets have a valid preamble and SFD, but have a bad CRC, 475 or are either shorter than 64 octets or longer than 1518 476 octets. 478 5. RMON 2 Conventions 480 The following practices and conventions are introduced in the 481 RMON 2 MIB. 483 5.1. Usage of the term Application Level 485 There are many cases in this MIB where the term Application 486 Level is used to describe a class of protocols or a 487 capability. This does not typically mean a protocol that is 488 an OSI Layer 7 protocol. Rather, it is used to identify a 489 class of protocols that is not limited to MAC-layer and 490 network-layer protocols, but can also include transport, 491 session, presentation, and application-layer protocols. 493 5.2. Protocol Directory and Limited Extensibility 495 Every RMON 2 implementation will have the capability to parse 496 certain types of packets and identify their protocol type at 497 multiple levels. The protocol directory presents an inventory 498 of those protocol types the probe is capable of monitoring, 499 and allows the addition, deletion, and configuration of 500 protocol types in this list. 502 One concept deserves special attention: the "limited 503 extensibility" of the protocol directory table. The RMON 2 504 model is that protocols are detected by static software that 505 has been written at implementation time. Therefore, as a 506 matter of configuration, an implementation does not have the 507 ability to suddenly learn how to parse new packet types. 508 However, an implementation may be written such that the 509 software knows where the demultiplexing field is for a 510 particular protocol, and can be written in such a way that the 511 decoding of the next layer up is table-driven. This works 512 when the code has been written to accomodate it and can be 513 extended no more than one level higher. This extensibility is 514 called "limited extensibility" to highlight these limitations. 515 However, this can be a very useful tool. 517 For example, suppose that an implementation has C code that 518 understands how to decode IP packets on any of several 519 ethernet encapsulations, and also knows how to interpret the 520 IP protocol field to recognize UDP packets and how to decode 521 the UDP port number fields. That implementation may be table- 522 driven so that among the many different UDP port numbers 523 possible, it is configured to recognize 161 as SNMP, port 53 524 as DNS, and port 69 as TFTP. The limited extensibility of the 525 protocol directory table would allow an SNMP operation to 526 create an entry that would create an additional table mapping 527 for UDP that would recognize UDP port 123 as NTP and begin 528 counting such packets. 530 This limited extensibility is an option that an implementation 531 can choose to allow or disallow for any protocol that has 532 child protocols. 534 5.3. Errors in packets 536 Packets with link-level errors are not counted anywhere in 537 this MIB because most variables in this MIB requires the 538 decoding of the contents of the packet, which is meaningless 539 if there is a link-level error. 541 Packets in which protocol errors are detected are counted for 542 all protocols below the layer in which the error was 543 encountered. The implication of this is that packets in which 544 errors are detected at the network-layer are not counted 545 anywhere in this MIB, while packets with errors detected at 546 the transport layer may have network-layer statistics counted. 548 6. Definitions 550 RMON2-MIB DEFINITIONS ::= BEGIN 551 IMPORTS 552 MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32, 553 Gauge32, IpAddress, TimeTicks, mib-2 FROM SNMPv2-SMI 554 TEXTUAL-CONVENTION, RowStatus, DisplayString, TimeStamp 555 FROM SNMPv2-TC 556 MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF 557 ifIndex FROM IF-MIB 558 OwnerString, statistics, history, hosts, 559 matrix, filter, etherStatsEntry, historyControlEntry, 560 hostControlEntry, matrixControlEntry, filterEntry, 561 channelEntry FROM RMON-MIB 562 tokenRing, tokenRingMLStatsEntry, tokenRingPStatsEntry, 563 ringStationControlEntry, sourceRoutingStatsEntry 564 FROM TOKEN-RING-RMON-MIB; 565 -- Remote Network Monitoring MIB 567 rmon MODULE-IDENTITY 568 LAST-UPDATED "200410051500Z" -- October 5, 2004 569 ORGANIZATION "IETF RMON MIB Working Group" 570 CONTACT-INFO 571 "Author: 572 Steve Waldbusser 573 Phone: +1-650-948-6500 574 Fax : +1-650-745-0671 575 Email: waldbusser@nextbeacon.com 577 Working Group Chair: 578 Andy Bierman 579 Cisco Systems, Inc. 580 Postal: 170 West Tasman Drive 581 San Jose, CA USA 95134 582 Tel: +1 408 527-3711 583 E-mail: abierman@cisco.com 585 Working Group Mailing List: 586 To subscribe send email to: " 587 DESCRIPTION 588 "The MIB module for managing remote monitoring 589 device implementations. This MIB module 590 extends the architecture introduced in the original 591 RMON MIB as specified in RFC 2819. 593 Copyright (C) The Internet Society (2004). This version of 594 this MIB module is part of RFC yyyy; see the RFC itself for 595 full legal notices." 597 REVISION "200410051500Z" -- October 5, 2004 598 DESCRIPTION 599 "This version updates the proposed-standard version of the 600 RMON2 MIB (published as RFC 2021) by adding 2 new enumerations 601 to the nlMatrixTopNControlRateBase object and 4 new 602 enumerations to the alMatrixTopNControlRateBase object. These 603 new enumerations support the creation of high capacity topN 604 reports in the High Capacity RMON MIB [RFC3273]. 606 Additionally, the following object have been deprecated as 607 they have not had enough independent implementations to 608 demonstrate interoperability to meet the requirements of a 609 Draft Standard: 611 probeDownloadFile 612 probeDownloadTFTPServer 613 probeDownloadAction 614 probeDownloadStatus 615 serialMode 616 serialProtocol 617 serialTimeout 618 serialModemInitString 619 serialModemHangUpString 620 serialModemConnectResp 621 serialModemNoConnectResp 622 serialDialoutTimeout 623 serialStatus 624 serialConnectDestIpAddress 625 serialConnectType 626 serialConnectDialString 627 serialConnectSwitchConnectSeq 628 serialConnectSwitchDisconnectSeq 629 serialConnectSwitchResetSeq 630 serialConnectOwner 631 serialConnectStatus 632 netConfigIPAddress 633 netConfigSubnetMask 634 netConfigStatus 635 netDefaultGateway 636 tokenRingMLStats2DroppedFrames 637 tokenRingMLStats2CreateTime 638 tokenRingPStats2DroppedFrames 639 tokenRingPStats2CreateTime 640 ringStationControl2DroppedFrames 641 ringStationControl2CreateTime 642 sourceRoutingStats2DroppedFrames 643 sourceRoutingStats2CreateTime 645 In addition, two corrections were made. The LastCreateTime 646 Textual Convention had been defined with a base type of 647 another textual convention which isn't allowed in SMIv2. The 648 definition has been modified to use TimeTicks as the base 649 type. 651 Further, the SerialConfigEntry SEQUENCE definition included 652 sub-typing information that is not allowed in SMIv2. This 653 information has been deleted. Ranges were added to a number of 654 objects and textual-conventions to constrain their maximum 655 (and sometimes minimum) sizes: 656 ControlString 657 protocolDirID 658 protocolDirParameters 659 addressMapNetworkAddress 660 nlHostAddress 661 nlMatrixSDSourceAddress 662 nlMatrixSDDestAddress 663 nlMatrixDSSourceAddress 664 nlMatrixDSDestAddress 665 nlMatrixTopNSourceAddress 666 nlMatrixTopNDestAddress 667 alHostEntry 668 alMatrixSDEntry 669 alMatrixDSEntry 670 alMatrixTopNSourceAddress 671 alMatrixTopNDestAddress 672 " 674 REVISION "200207080000Z" -- 08 July, 2002 675 DESCRIPTION 676 "Added new enumerations to support the High-Capacity RMON 677 MIB as defined in RFC 3273. Also fixed some typos and add 678 clarifications." 680 REVISION "199605270000Z" -- 27 May, 1996 681 DESCRIPTION 682 "Original version. Published as RFC 2021." 683 ::= { mib-2 16 } 685 -- { rmon 1 } through { rmon 10 } are defined in RMON and 686 -- the Token Ring RMON MIB [RFC 1513] 688 protocolDir OBJECT IDENTIFIER ::= { rmon 11 } 689 protocolDist OBJECT IDENTIFIER ::= { rmon 12 } 690 addressMap OBJECT IDENTIFIER ::= { rmon 13 } 691 nlHost OBJECT IDENTIFIER ::= { rmon 14 } 692 nlMatrix OBJECT IDENTIFIER ::= { rmon 15 } 693 alHost OBJECT IDENTIFIER ::= { rmon 16 } 694 alMatrix OBJECT IDENTIFIER ::= { rmon 17 } 695 usrHistory OBJECT IDENTIFIER ::= { rmon 18 } 696 probeConfig OBJECT IDENTIFIER ::= { rmon 19 } 697 rmonConformance OBJECT IDENTIFIER ::= { rmon 20 } 699 -- Textual Conventions 701 ZeroBasedCounter32 ::= TEXTUAL-CONVENTION 702 STATUS current 703 DESCRIPTION 704 "This TC describes an object which counts events with the 705 following semantics: objects of this type will be set to 706 zero(0) on creation and will thereafter count appropriate 707 events, wrapping back to zero(0) when the value 2^32 is 708 reached. 710 Provided that an application discovers the new object within 711 the minimum time to wrap it can use the initial value as a 712 delta since it last polled the table of which this object is 713 part. It is important for a management station to be aware of 714 this minimum time and the actual time between polls, and to 715 discard data if the actual time is too long or there is no 716 defined minimum time. 718 Typically this TC is used in tables where the INDEX space is 719 constantly changing and/or the TimeFilter mechanism is in use." 720 SYNTAX Gauge32 722 LastCreateTime ::= TEXTUAL-CONVENTION 723 STATUS current 724 DESCRIPTION 725 "This TC describes an object that stores the value of the 726 sysUpTime object at the last time its entry was created. 728 This can be used for polling applications to determine that an 729 entry has been deleted and re-created between polls, causing 730 an otherwise undetectable discontinuity in the data. 732 If sysUpTime is reset to zero as a result of a re- 733 initialization of the network management (sub)system, then 734 the values of all LastCreateTime objects are also reset. 735 However, after approximately 497 days without a re- 736 initialization, the sysUpTime object will reach 2^^32-1 and 737 then increment around to zero; in this case, existing values 738 of TimeStamp objects do not change. This can lead to 739 ambiguities in the value of TimeStamp objects." 740 SYNTAX TimeTicks 742 TimeFilter ::= TEXTUAL-CONVENTION 743 STATUS current 744 DESCRIPTION 745 "To be used for the index to a table. Allows an application 746 to download only those rows changed since a particular time. 747 A row is considered changed if the value of any object in the 748 row changes or if the row is created or deleted. 750 When sysUpTime is equal to zero, this table shall be empty. 752 One entry exists for each past value of sysUpTime, except that 753 the whole table is purged should sysUpTime wrap. 755 As this basic row is updated new conceptual rows are created 756 (which still share the now updated object values with all 757 other instances). The number of instances which are created 758 is determined by the value of sysUpTime at which the basic row 759 was last updated. One instance will exist for each value of 760 sysUpTime at the last update time for the row. A new 761 timeMark instance is created for each new sysUpTime value. 762 Each new conceptual row will be associated with the timeMark 763 instance which was created at the value of sysUpTime with 764 which the conceptual row is to be associated. 766 By definition all conceptual rows were updated at or after 767 time zero and so at least one conceptual row (associated with 768 timeMark.0) must exist for each underlying (basic) row. 770 See the appendix for further discussion of this variable. 772 Consider the following fooTable: 774 fooTable ... 775 INDEX { fooTimeMark, fooIndex } 777 FooEntry { 778 fooTimeMark TimeFilter 779 fooIndex INTEGER, 780 fooCounts Counter 781 } 783 Should there be two basic rows in this table (fooIndex == 1, 784 fooIndex == 2) and row 1 was updated most recently at time 6, 785 while row 2 was updated most recently at time 8, and both rows 786 had been updated on several earlier occasions such that the 787 current values were 5 and 9 respectively then the following 788 fooCounts instances would exist. 790 fooCounts.0.1 5 791 fooCounts.0.2 9 792 fooCounts.1.1 5 793 fooCounts.1.2 9 794 fooCounts.2.1 5 795 fooCounts.2.2 9 796 fooCounts.3.1 5 797 fooCounts.3.2 9 798 fooCounts.4.1 5 799 fooCounts.4.2 9 800 fooCounts.5.1 5 801 fooCounts.5.2 9 802 fooCounts.6.1 5 803 fooCounts.6.2 9 804 fooCounts.7.2 9 -- note that row 1 doesn't exist for 805 fooCounts.8.2 9 -- times 7 and 8" 806 SYNTAX TimeTicks 808 DataSource ::= TEXTUAL-CONVENTION 809 STATUS current 810 DESCRIPTION 811 "Identifies the source of the data that the associated 812 function is configured to analyze. This source can be any 813 interface on this device. 815 In order to identify a particular interface, this 816 object shall identify the instance of the ifIndex 817 object, defined in [RFC2863], for the desired interface. 819 For example, if an entry were to receive data from 820 interface #1, this object would be set to ifIndex.1." 821 SYNTAX OBJECT IDENTIFIER 823 -- 824 -- Protocol Directory Group 825 -- 826 -- Lists the inventory of protocols the probe has the capability of 827 -- monitoring and allows the addition, deletion, and configuration of 828 -- entries in this list. 830 protocolDirLastChange OBJECT-TYPE 831 SYNTAX TimeStamp 832 MAX-ACCESS read-only 833 STATUS current 834 DESCRIPTION 835 "The value of sysUpTime at the time the protocol directory 836 was last modified, either through insertions or deletions, 837 or through modifications of either the 838 protocolDirAddressMapConfig, protocolDirHostConfig, or 839 protocolDirMatrixConfig." 840 ::= { protocolDir 1 } 842 protocolDirTable OBJECT-TYPE 843 SYNTAX SEQUENCE OF ProtocolDirEntry 844 MAX-ACCESS not-accessible 845 STATUS current 846 DESCRIPTION 847 "This table lists the protocols that this agent has the 848 capability to decode and count. There is one entry in this 849 table for each such protocol. These protocols represent 850 different network layer, transport layer, and higher-layer 851 protocols. The agent should boot up with this table 852 preconfigured with those protocols that it knows about and 853 wishes to monitor. Implementations are strongly encouraged to 854 support protocols higher than the network layer (at least for 855 the protocol distribution group), even for implementations 856 that don't support the application layer groups." 857 ::= { protocolDir 2 } 859 protocolDirEntry OBJECT-TYPE 860 SYNTAX ProtocolDirEntry 861 MAX-ACCESS not-accessible 862 STATUS current 863 DESCRIPTION 864 "A conceptual row in the protocolDirTable. 866 An example of the indexing of this entry is 867 protocolDirLocalIndex.8.0.0.0.1.0.0.8.0.2.0.0, which is the 868 encoding of a length of 8, followed by 8 subids encoding the 869 protocolDirID of 1.2048, followed by a length of 2 and the 870 2 subids encoding zero-valued parameters. 872 Note that some combinations of index values may result in an 873 index that exceeds 128 sub-identifiers in length which exceeds 874 the maximum for the SNMP protocol. Implementations should take 875 care to avoid such combinations." 876 INDEX { protocolDirID, protocolDirParameters } 877 ::= { protocolDirTable 1 } 879 ProtocolDirEntry ::= SEQUENCE { 880 protocolDirID OCTET STRING, 881 protocolDirParameters OCTET STRING, 882 protocolDirLocalIndex Integer32, 883 protocolDirDescr DisplayString, 884 protocolDirType BITS, 885 protocolDirAddressMapConfig INTEGER, 886 protocolDirHostConfig INTEGER, 887 protocolDirMatrixConfig INTEGER, 888 protocolDirOwner OwnerString, 889 protocolDirStatus RowStatus 890 } 892 protocolDirID OBJECT-TYPE 893 SYNTAX OCTET STRING (SIZE (4..128)) 894 MAX-ACCESS not-accessible 895 STATUS current 896 DESCRIPTION 897 "A unique identifier for a particular protocol. Standard 898 identifiers will be defined in a manner such that they 899 can often be used as specifications for new protocols - i.e. 900 a tree-structured assignment mechanism that matches the 901 protocol encapsulation `tree' and which has algorithmic 902 assignment mechanisms for certain subtrees. See RFC 2074 for 903 more details. 905 Despite the algorithmic mechanism, the probe will only place 906 entries in here for those protocols it chooses to collect. In 907 other words, it need not populate this table with all of the 908 possible ethernet protocol types, nor need it create them on 909 the fly when it sees them. Whether or not it does these 910 things is a matter of product definition (cost/benefit, 911 usability), and is up to the designer of the product. 913 If an entry is written to this table with a protocolDirID that 914 the agent doesn't understand, either directly or 915 algorithmically, the SET request will be rejected with an 916 inconsistentName or badValue (for SNMPv1) error." 917 ::= { protocolDirEntry 1 } 919 protocolDirParameters OBJECT-TYPE 920 SYNTAX OCTET STRING (SIZE (1..32)) 921 MAX-ACCESS not-accessible 922 STATUS current 923 DESCRIPTION 924 "A set of parameters for the associated protocolDirID. 925 See the associated RMON2 Protocol Identifiers document 926 for a description of the possible parameters. There 927 will be one octet in this string for each sub-identifier in 928 the protocolDirID, and the parameters will appear here in the 929 same order as the associated sub-identifiers appear in the 930 protocolDirID. 932 Every node in the protocolDirID tree has a different, optional 933 set of parameters defined (that is, the definition of 934 parameters for a node is optional). The proper parameter 935 value for each node is included in this string. Note that the 936 inclusion of a parameter value in this string for each node is 937 not optional - what is optional is that a node may have no 938 parameters defined, in which case the parameter field for that 939 node will be zero." 940 ::= { protocolDirEntry 2 } 942 protocolDirLocalIndex OBJECT-TYPE 943 SYNTAX Integer32 (1..2147483647) 944 MAX-ACCESS read-only 945 STATUS current 946 DESCRIPTION 947 "The locally arbitrary, but unique identifier associated 948 with this protocolDir entry. 950 The value for each supported protocol must remain constant at 951 least from one re-initialization of the entity's network 952 management system to the next re-initialization, except that 953 if a protocol is deleted and re-created, it must be re-created 954 with a new value that has not been used since the last 955 re-initialization. 957 The specific value is meaningful only within a given SNMP 958 entity. A protocolDirLocalIndex must not be re-used until the 959 next agent restart in the event the protocol directory entry 960 is deleted." 961 ::= { protocolDirEntry 3 } 963 protocolDirDescr OBJECT-TYPE 964 SYNTAX DisplayString (SIZE (1..64)) 965 MAX-ACCESS read-create 966 STATUS current 967 DESCRIPTION 968 "A textual description of the protocol encapsulation. 969 A probe may choose to describe only a subset of the 970 entire encapsulation (e.g. only the highest layer). 972 This object is intended for human consumption only. 974 This object may not be modified if the associated 975 protocolDirStatus object is equal to active(1)." 976 ::= { protocolDirEntry 4 } 978 protocolDirType OBJECT-TYPE 979 SYNTAX BITS { 980 extensible(0), 981 addressRecognitionCapable(1) 982 } 983 MAX-ACCESS read-only 984 STATUS current 985 DESCRIPTION 986 "This object describes 2 attributes of this protocol 987 directory entry. 989 The presence or absence of the `extensible' bit describes 990 whether or not this protocol directory entry can be extended 991 by the user by creating protocol directory entries which are 992 children of this protocol. 994 An example of an entry that will often allow extensibility is 995 `ip.udp'. The probe may automatically populate some children 996 of this node such as `ip.udp.snmp' and `ip.udp.dns'. 997 A probe administrator or user may also populate additional 998 children via remote SNMP requests that create entries in this 999 table. When a child node is added for a protocol for which the 1000 probe has no built in support, extending a parent node (for 1001 which the probe does have built in support), 1002 that child node is not extendible. This is termed `limited 1003 extensibility'. 1005 When a child node is added through this extensibility 1006 mechanism, the values of protocolDirLocalIndex and 1007 protocolDirType shall be assigned by the agent. 1009 The other objects in the entry will be assigned by the 1010 manager who is creating the new entry. 1012 This object also describes whether or not this agent can 1013 recognize addresses for this protocol, should it be a network 1014 level protocol. That is, while a probe may be able to 1015 recognize packets of a particular network layer protocol and 1016 count them, it takes additional logic to be able to recognize 1017 the addresses in this protocol and to populate network layer 1018 or application layer tables with the addresses in this 1019 protocol. If this bit is set, the agent will recognize 1020 network layer addresses for this protoocl and populate the 1021 network and application layer host and matrix tables with 1022 these protocols. 1024 Note that when an entry is created, the agent will supply 1025 values for the bits that match the capabilities of the agent 1026 with respect to this protocol. Note that since row creations 1027 usually exercise the limited extensibility feature, these 1028 bits will usually be set to zero." 1029 ::= { protocolDirEntry 5 } 1031 protocolDirAddressMapConfig OBJECT-TYPE 1032 SYNTAX INTEGER { 1033 notSupported(1), 1034 supportedOff(2), 1035 supportedOn(3) 1036 } 1037 MAX-ACCESS read-create 1038 STATUS current 1039 DESCRIPTION 1040 "This object describes and configures the probe's support for 1041 address mapping for this protocol. When the probe creates 1042 entries in this table for all protocols that it understands, 1043 it will set the entry to notSupported(1) if it doesn't have 1044 the capability to perform address mapping for the protocol or 1045 if this protocol is not a network-layer protocol. When 1046 an entry is created in this table by a management operation as 1047 part of the limited extensibility feature, the probe must set 1048 this value to notSupported(1), because limited extensibility 1049 of the protocolDirTable does not extend to interpreting 1050 addresses of the extended protocols. 1052 If the value of this object is notSupported(1), the probe 1053 will not perform address mapping for this protocol and 1054 shall not allow this object to be changed to any other value. 1055 If the value of this object is supportedOn(3), the probe 1056 supports address mapping for this protocol and is configured 1057 to perform address mapping for this protocol for all 1058 addressMappingControlEntries and all interfaces. 1059 If the value of this object is supportedOff(2), the probe 1060 supports address mapping for this protocol but is configured 1061 to not perform address mapping for this protocol for any 1062 addressMappingControlEntries and all interfaces. 1063 Whenever this value changes from supportedOn(3) to 1064 supportedOff(2), the probe shall delete all related entries in 1065 the addressMappingTable." 1066 ::= { protocolDirEntry 6 } 1068 protocolDirHostConfig OBJECT-TYPE 1069 SYNTAX INTEGER { 1070 notSupported(1), 1071 supportedOff(2), 1072 supportedOn(3) 1073 } 1074 MAX-ACCESS read-create 1075 STATUS current 1076 DESCRIPTION 1077 "This object describes and configures the probe's support for 1078 the network layer and application layer host tables for this 1079 protocol. When the probe creates entries in this table for 1080 all protocols that it understands, it will set the entry to 1081 notSupported(1) if it doesn't have the capability to track the 1082 nlHostTable for this protocol or if the alHostTable is 1083 implemented but doesn't have the capability to track this 1084 protocol. Note that if the alHostTable is implemented, the 1085 probe may only support a protocol if it is supported in both 1086 the nlHostTable and the alHostTable. 1088 If the associated protocolDirType object has the 1089 addressRecognitionCapable bit set, then this is a network 1090 layer protocol for which the probe recognizes addresses, and 1091 thus the probe will populate the nlHostTable and alHostTable 1092 with addresses it discovers for this protocol. 1094 If the value of this object is notSupported(1), the probe 1095 will not track the nlHostTable or alHostTable for this 1096 protocol and shall not allow this object to be changed to any 1097 other value. If the value of this object is supportedOn(3), 1098 the probe supports tracking of the nlHostTable and alHostTable 1099 for this protocol and is configured to track both tables 1100 for this protocol for all control entries and all interfaces. 1101 If the value of this object is supportedOff(2), the probe 1102 supports tracking of the nlHostTable and alHostTable for this 1103 protocol but is configured to not track these tables 1104 for any control entries or interfaces. 1105 Whenever this value changes from supportedOn(3) to 1106 supportedOff(2), the probe shall delete all related entries in 1107 the nlHostTable and alHostTable. 1109 Note that since each alHostEntry references 2 protocol 1110 directory entries, one for the network address and one for the 1111 type of the highest protocol recognized, that an entry will 1112 only be created in that table if this value is supportedOn(3) 1113 for both protocols." 1114 ::= { protocolDirEntry 7 } 1116 protocolDirMatrixConfig OBJECT-TYPE 1117 SYNTAX INTEGER { 1118 notSupported(1), 1119 supportedOff(2), 1120 supportedOn(3) 1121 } 1122 MAX-ACCESS read-create 1123 STATUS current 1124 DESCRIPTION 1125 "This object describes and configures the probe's support for 1126 the network layer and application layer matrix tables for this 1127 protocol. When the probe creates entries in this table for 1128 all protocols that it understands, it will set the entry to 1129 notSupported(1) if it doesn't have the capability to track the 1130 nlMatrixTables for this protocol or if the alMatrixTables are 1131 implemented but don't have the capability to track this 1132 protocol. Note that if the alMatrix tables are implemented, 1133 the probe may only support a protocol if it is supported in 1134 the the both of the nlMatrixTables and both of the 1135 alMatrixTables. 1137 If the associated protocolDirType object has the 1138 addressRecognitionCapable bit set, then this is a network 1139 layer protocol for which the probe recognizes addresses, and 1140 thus the probe will populate both of the nlMatrixTables and 1141 both of the alMatrixTables with addresses it discovers for 1142 this protocol. 1144 If the value of this object is notSupported(1), the probe 1145 will not track either of the nlMatrixTables or the 1146 alMatrixTables for this protocol and shall not allow this 1147 object to be changed to any other value. If the value of this 1148 object is supportedOn(3), the probe supports tracking of both 1149 of the nlMatrixTables and (if implemented) both of the 1150 alMatrixTables for this protocol and is configured to track 1151 these tables for this protocol for all control entries and all 1152 interfaces. If the value of this object is supportedOff(2), 1153 the probe supports tracking of both of the nlMatrixTables and 1154 (if implemented) both of the alMatrixTables for this protocol 1155 but is configured to not track these tables for this 1156 protocol for any control entries or interfaces. 1157 Whenever this value changes from supportedOn(3) to 1158 supportedOff(2), the probe shall delete all related entries in 1159 the nlMatrixTables and the alMatrixTables. 1161 Note that since each alMatrixEntry references 2 protocol 1162 directory entries, one for the network address and one for the 1163 type of the highest protocol recognized, that an entry will 1164 only be created in that table if this value is supportedOn(3) 1165 for both protocols." 1166 ::= { protocolDirEntry 8 } 1168 protocolDirOwner OBJECT-TYPE 1169 SYNTAX OwnerString 1170 MAX-ACCESS read-create 1171 STATUS current 1172 DESCRIPTION 1173 "The entity that configured this entry and is 1174 therefore using the resources assigned to it." 1175 ::= { protocolDirEntry 9 } 1177 protocolDirStatus OBJECT-TYPE 1178 SYNTAX RowStatus 1179 MAX-ACCESS read-create 1180 STATUS current 1181 DESCRIPTION 1182 "The status of this protocol directory entry. 1184 An entry may not exist in the active state unless all 1185 objects in the entry have an appropriate value. 1187 If this object is not equal to active(1), all associated 1188 entries in the nlHostTable, nlMatrixSDTable, nlMatrixDSTable, 1189 alHostTable, alMatrixSDTable, and alMatrixDSTable shall be 1190 deleted." 1191 ::= { protocolDirEntry 10 } 1193 -- 1194 -- Protocol Distribution Group (protocolDist) 1195 -- 1196 -- Collects the relative amounts of octets and packets for the 1197 -- different protocols detected on a network segment. 1198 -- protocolDistControlTable, 1199 -- protocolDistStatsTable 1201 protocolDistControlTable OBJECT-TYPE 1202 SYNTAX SEQUENCE OF ProtocolDistControlEntry 1203 MAX-ACCESS not-accessible 1204 STATUS current 1205 DESCRIPTION 1206 "Controls the setup of protocol type distribution statistics 1207 tables. 1209 Implementations are encouraged to add an entry per monitored 1210 interface upon initialization so that a default collection 1211 of protocol statistics is available. 1213 Rationale: 1214 This table controls collection of very basic statistics 1215 for any or all of the protocols detected on a given interface. 1216 An NMS can use this table to quickly determine bandwidth 1217 allocation utilized by different protocols. 1219 A media-specific statistics collection could also 1220 be configured (e.g. etherStats, trPStats) to easily obtain 1221 total frame, octet, and droppedEvents for the same 1222 interface." 1223 ::= { protocolDist 1 } 1225 protocolDistControlEntry OBJECT-TYPE 1226 SYNTAX ProtocolDistControlEntry 1227 MAX-ACCESS not-accessible 1228 STATUS current 1229 DESCRIPTION 1230 "A conceptual row in the protocolDistControlTable. 1232 An example of the indexing of this entry is 1233 protocolDistControlDroppedFrames.7" 1234 INDEX { protocolDistControlIndex } 1235 ::= { protocolDistControlTable 1 } 1237 ProtocolDistControlEntry ::= SEQUENCE { 1238 protocolDistControlIndex Integer32, 1239 protocolDistControlDataSource DataSource, 1240 protocolDistControlDroppedFrames Counter32, 1241 protocolDistControlCreateTime LastCreateTime, 1242 protocolDistControlOwner OwnerString, 1243 protocolDistControlStatus RowStatus 1244 } 1246 protocolDistControlIndex OBJECT-TYPE 1247 SYNTAX Integer32 (1..65535) 1248 MAX-ACCESS not-accessible 1249 STATUS current 1250 DESCRIPTION 1251 "A unique index for this protocolDistControlEntry." 1252 ::= { protocolDistControlEntry 1 } 1254 protocolDistControlDataSource OBJECT-TYPE 1255 SYNTAX DataSource 1256 MAX-ACCESS read-create 1257 STATUS current 1258 DESCRIPTION 1259 "The source of data for the this protocol distribution. 1261 The statistics in this group reflect all packets 1262 on the local network segment attached to the 1263 identified interface. 1265 This object may not be modified if the associated 1266 protocolDistControlStatus object is equal to active(1)." 1267 ::= { protocolDistControlEntry 2 } 1269 protocolDistControlDroppedFrames OBJECT-TYPE 1270 SYNTAX Counter32 1271 MAX-ACCESS read-only 1272 STATUS current 1273 DESCRIPTION 1274 "The total number of frames which were received by the probe 1275 and therefore not accounted for in the *StatsDropEvents, but 1276 for which the probe chose not to count for this entry for 1277 whatever reason. Most often, this event occurs when the probe 1278 is out of some resources and decides to shed load from this 1279 collection. 1281 This count does not include packets that were not counted 1282 because they had MAC-layer errors. 1284 Note that, unlike the dropEvents counter, this number is the 1285 exact number of frames dropped." 1286 ::= { protocolDistControlEntry 3 } 1288 protocolDistControlCreateTime OBJECT-TYPE 1289 SYNTAX LastCreateTime 1290 MAX-ACCESS read-only 1291 STATUS current 1292 DESCRIPTION 1293 "The value of sysUpTime when this control entry was last 1294 activated. This can be used by the management station to 1295 ensure that the table has not been deleted and recreated 1296 between polls." 1297 ::= { protocolDistControlEntry 4 } 1299 protocolDistControlOwner OBJECT-TYPE 1300 SYNTAX OwnerString 1301 MAX-ACCESS read-create 1302 STATUS current 1303 DESCRIPTION 1304 "The entity that configured this entry and is 1305 therefore using the resources assigned to it." 1306 ::= { protocolDistControlEntry 5 } 1308 protocolDistControlStatus OBJECT-TYPE 1309 SYNTAX RowStatus 1310 MAX-ACCESS read-create 1311 STATUS current 1312 DESCRIPTION 1313 "The status of this row. 1315 An entry may not exist in the active state unless all 1316 objects in the entry have an appropriate value. 1318 If this object is not equal to active(1), all associated 1319 entries in the protocolDistStatsTable shall be deleted." 1320 ::= { protocolDistControlEntry 6 } 1322 -- per interface protocol distribution statistics table 1323 protocolDistStatsTable OBJECT-TYPE 1324 SYNTAX SEQUENCE OF ProtocolDistStatsEntry 1325 MAX-ACCESS not-accessible 1326 STATUS current 1327 DESCRIPTION 1328 "An entry is made in this table for every protocol in the 1329 protocolDirTable which has been seen in at least one packet. 1330 Counters are updated in this table for every protocol type 1331 that is encountered when parsing a packet, but no counters are 1332 updated for packets with MAC-layer errors. 1334 Note that if a protocolDirEntry is deleted, all associated 1335 entries in this table are removed." 1336 ::= { protocolDist 2 } 1338 protocolDistStatsEntry OBJECT-TYPE 1339 SYNTAX ProtocolDistStatsEntry 1340 MAX-ACCESS not-accessible 1341 STATUS current 1342 DESCRIPTION 1343 "A conceptual row in the protocolDistStatsTable. 1345 The index is composed of the protocolDistControlIndex of the 1346 associated protocolDistControlEntry followed by the 1347 protocolDirLocalIndex of the associated protocol that this 1348 entry represents. In other words, the index identifies the 1349 protocol distribution an entry is a part of as well as the 1350 particular protocol that it represents. 1352 An example of the indexing of this entry is 1353 protocolDistStatsPkts.1.18" 1354 INDEX { protocolDistControlIndex, protocolDirLocalIndex } 1355 ::= { protocolDistStatsTable 1 } 1357 ProtocolDistStatsEntry ::= SEQUENCE { 1358 protocolDistStatsPkts ZeroBasedCounter32, 1359 protocolDistStatsOctets ZeroBasedCounter32 1360 } 1362 protocolDistStatsPkts OBJECT-TYPE 1363 SYNTAX ZeroBasedCounter32 1364 MAX-ACCESS read-only 1365 STATUS current 1366 DESCRIPTION 1367 "The number of packets without errors received of this 1368 protocol type. Note that this is the number of link-layer 1369 packets, so if a single network-layer packet is fragmented 1370 into several link-layer frames, this counter is incremented 1371 several times." 1372 ::= { protocolDistStatsEntry 1 } 1374 protocolDistStatsOctets OBJECT-TYPE 1375 SYNTAX ZeroBasedCounter32 1376 MAX-ACCESS read-only 1377 STATUS current 1378 DESCRIPTION 1379 "The number of octets in packets received of this protocol 1380 type since it was added to the protocolDistStatsTable 1381 (excluding framing bits but including FCS octets), except for 1382 those octets in packets that contained errors. 1384 Note this doesn't count just those octets in the particular 1385 protocol frames, but includes the entire packet that contained 1386 the protocol." 1387 ::= { protocolDistStatsEntry 2 } 1389 -- 1390 -- Address Map Group (addressMap) 1391 -- 1392 -- Lists MAC address to network address bindings discovered by the 1393 -- probe and what interface they were last seen on. 1394 -- addressMapControlTable 1395 -- addressMapTable 1397 addressMapInserts OBJECT-TYPE 1398 SYNTAX Counter32 1399 MAX-ACCESS read-only 1400 STATUS current 1401 DESCRIPTION 1402 "The number of times an address mapping entry has been 1403 inserted into the addressMapTable. If an entry is inserted, 1404 then deleted, and then inserted, this counter will be 1405 incremented by 2. 1407 Note that the table size can be determined by subtracting 1408 addressMapDeletes from addressMapInserts." 1409 ::= { addressMap 1 } 1411 addressMapDeletes OBJECT-TYPE 1412 SYNTAX Counter32 1413 MAX-ACCESS read-only 1414 STATUS current 1415 DESCRIPTION 1416 "The number of times an address mapping entry has been 1417 deleted from the addressMapTable (for any reason). If 1418 an entry is deleted, then inserted, and then deleted, this 1419 counter will be incremented by 2. 1421 Note that the table size can be determined by subtracting 1422 addressMapDeletes from addressMapInserts." 1423 ::= { addressMap 2 } 1425 addressMapMaxDesiredEntries OBJECT-TYPE 1426 SYNTAX Integer32 (-1..2147483647) 1427 MAX-ACCESS read-write 1428 STATUS current 1429 DESCRIPTION 1430 "The maximum number of entries that are desired in the 1431 addressMapTable. The probe will not create more than 1432 this number of entries in the table, but may choose to create 1433 fewer entries in this table for any reason including the lack 1434 of resources. 1436 If this object is set to a value less than the current number 1437 of entries, enough entries are chosen in an 1438 implementation-dependent manner and deleted so that the number 1439 of entries in the table equals the value of this object. 1441 If this value is set to -1, the probe may create any number 1442 of entries in this table. 1444 This object may be used to control how resources are allocated 1445 on the probe for the various RMON functions." 1446 ::= { addressMap 3 } 1448 addressMapControlTable OBJECT-TYPE 1449 SYNTAX SEQUENCE OF AddressMapControlEntry 1450 MAX-ACCESS not-accessible 1451 STATUS current 1452 DESCRIPTION 1453 "A table to control the collection of network layer address to 1454 physical address to interface mappings. 1456 Note that this is not like the typical RMON 1457 controlTable and dataTable in which each entry creates 1458 its own data table. Each entry in this table enables the 1459 discovery of addresses on a new interface and the placement 1460 of address mappings into the central addressMapTable. 1462 Implementations are encouraged to add an entry per monitored 1463 interface upon initialization so that a default collection 1464 of address mappings is available." 1465 ::= { addressMap 4 } 1467 addressMapControlEntry OBJECT-TYPE 1468 SYNTAX AddressMapControlEntry 1469 MAX-ACCESS not-accessible 1470 STATUS current 1471 DESCRIPTION 1472 "A conceptual row in the addressMapControlTable. 1474 An example of the indexing of this entry is 1475 addressMapControlDroppedFrames.1" 1476 INDEX { addressMapControlIndex } 1477 ::= { addressMapControlTable 1 } 1479 AddressMapControlEntry ::= SEQUENCE { 1480 addressMapControlIndex Integer32, 1481 addressMapControlDataSource DataSource, 1482 addressMapControlDroppedFrames Counter32, 1483 addressMapControlOwner OwnerString, 1484 addressMapControlStatus RowStatus 1485 } 1487 addressMapControlIndex OBJECT-TYPE 1488 SYNTAX Integer32 (1..65535) 1489 MAX-ACCESS not-accessible 1490 STATUS current 1491 DESCRIPTION 1492 "A unique index for this entry in the addressMapControlTable." 1493 ::= { addressMapControlEntry 1 } 1495 addressMapControlDataSource OBJECT-TYPE 1496 SYNTAX DataSource 1497 MAX-ACCESS read-create 1498 STATUS current 1499 DESCRIPTION 1500 "The source of data for this addressMapControlEntry." 1501 ::= { addressMapControlEntry 2 } 1503 addressMapControlDroppedFrames OBJECT-TYPE 1504 SYNTAX Counter32 1505 MAX-ACCESS read-only 1506 STATUS current 1507 DESCRIPTION 1508 "The total number of frames which were received by the probe 1509 and therefore not accounted for in the *StatsDropEvents, but 1510 for which the probe chose not to count for this entry for 1511 whatever reason. Most often, this event occurs when the probe 1512 is out of some resources and decides to shed load from this 1513 collection. 1515 This count does not include packets that were not counted 1516 because they had MAC-layer errors. 1518 Note that, unlike the dropEvents counter, this number is the 1519 exact number of frames dropped." 1520 ::= { addressMapControlEntry 3 } 1522 addressMapControlOwner OBJECT-TYPE 1523 SYNTAX OwnerString 1524 MAX-ACCESS read-create 1525 STATUS current 1526 DESCRIPTION 1527 "The entity that configured this entry and is 1528 therefore using the resources assigned to it." 1529 ::= { addressMapControlEntry 4 } 1531 addressMapControlStatus OBJECT-TYPE 1532 SYNTAX RowStatus 1533 MAX-ACCESS read-create 1534 STATUS current 1535 DESCRIPTION 1536 "The status of this addressMap control entry. 1538 An entry may not exist in the active state unless all 1539 objects in the entry have an appropriate value. 1541 If this object is not equal to active(1), all associated 1542 entries in the addressMapTable shall be deleted." 1543 ::= { addressMapControlEntry 5 } 1545 addressMapTable OBJECT-TYPE 1546 SYNTAX SEQUENCE OF AddressMapEntry 1547 MAX-ACCESS not-accessible 1548 STATUS current 1549 DESCRIPTION 1550 "A table of network layer address to physical address to 1551 interface mappings. 1553 The probe will add entries to this table based on the source 1554 MAC and network addresses seen in packets without MAC-level 1555 errors. The probe will populate this table for all protocols 1556 in the protocol directory table whose value of 1557 protocolDirAddressMapConfig is equal to supportedOn(3), and 1558 will delete any entries whose protocolDirEntry is deleted or 1559 has a protocolDirAddressMapConfig value of supportedOff(2)." 1560 ::= { addressMap 5 } 1562 addressMapEntry OBJECT-TYPE 1563 SYNTAX AddressMapEntry 1564 MAX-ACCESS not-accessible 1565 STATUS current 1566 DESCRIPTION 1567 "A conceptual row in the addressMapTable. 1569 The protocolDirLocalIndex in the index identifies the network 1570 layer protocol of the addressMapNetworkAddress. 1572 An example of the indexing of this entry is 1573 addressMapSource.783495.18.4.128.2.6.6.11.1.3.6.1.2.1.2.2.1.1.1. 1575 Note that some combinations of index values may result in an 1576 index that exceeds 128 sub-identifiers in length which exceeds 1577 the maximum for the SNMP protocol. Implementations should take 1578 care to avoid such combinations." 1579 INDEX { addressMapTimeMark, protocolDirLocalIndex, 1580 addressMapNetworkAddress, addressMapSource } 1581 ::= { addressMapTable 1 } 1583 AddressMapEntry ::= SEQUENCE { 1584 addressMapTimeMark TimeFilter, 1585 addressMapNetworkAddress OCTET STRING, 1586 addressMapSource OBJECT IDENTIFIER, 1587 addressMapPhysicalAddress OCTET STRING, 1588 addressMapLastChange TimeStamp 1589 } 1591 addressMapTimeMark OBJECT-TYPE 1592 SYNTAX TimeFilter 1593 MAX-ACCESS not-accessible 1594 STATUS current 1595 DESCRIPTION 1596 "A TimeFilter for this entry. See the TimeFilter textual 1597 convention to see how this works." 1598 ::= { addressMapEntry 1 } 1600 addressMapNetworkAddress OBJECT-TYPE 1601 SYNTAX OCTET STRING (SIZE (1..255)) 1602 MAX-ACCESS not-accessible 1603 STATUS current 1604 DESCRIPTION 1605 "The network address for this relation. 1607 This is represented as an octet string with 1608 specific semantics and length as identified 1609 by the protocolDirLocalIndex component of the 1610 index. 1612 For example, if the protocolDirLocalIndex indicates an 1613 encapsulation of ip, this object is encoded as a length 1614 octet of 4, followed by the 4 octets of the ip address, 1615 in network byte order." 1616 ::= { addressMapEntry 2 } 1618 addressMapSource OBJECT-TYPE 1619 SYNTAX OBJECT IDENTIFIER 1620 MAX-ACCESS not-accessible 1621 STATUS current 1622 DESCRIPTION 1623 "The interface or port on which the associated network 1624 address was most recently seen. 1626 If this address mapping was discovered on an interface, this 1627 object shall identify the instance of the ifIndex 1628 object, defined in [RFC2863], for the desired interface. 1629 For example, if an entry were to receive data from 1630 interface #1, this object would be set to ifIndex.1. 1632 If this address mapping was discovered on a port, this 1633 object shall identify the instance of the rptrGroupPortIndex 1634 object, defined in [RFC2108], for the desired port. 1635 For example, if an entry were to receive data from 1636 group #1, port #1, this object would be set to 1637 rptrGroupPortIndex.1.1. 1639 Note that while the dataSource associated with this entry 1640 may only point to index objects, this object may at times 1641 point to repeater port objects. This situation occurs when 1642 the dataSource points to an interface which is a locally 1643 attached repeater and the agent has additional information 1644 about the source port of traffic seen on that repeater." 1645 ::= { addressMapEntry 3 } 1647 addressMapPhysicalAddress OBJECT-TYPE 1648 SYNTAX OCTET STRING 1649 MAX-ACCESS read-only 1650 STATUS current 1651 DESCRIPTION 1652 "The last source physical address on which the associated 1653 network address was seen. If the protocol of the associated 1654 network address was encapsulated inside of a network-level or 1655 higher protocol, this will be the address of the next-lower 1656 protocol with the addressRecognitionCapable bit enabled and 1657 will be formatted as specified for that protocol." 1658 ::= { addressMapEntry 4 } 1660 addressMapLastChange OBJECT-TYPE 1661 SYNTAX TimeStamp 1662 MAX-ACCESS read-only 1663 STATUS current 1664 DESCRIPTION 1665 "The value of sysUpTime at the time this entry was last 1666 created or the values of the physical address changed. 1668 This can be used to help detect duplicate address problems, in 1669 which case this object will be updated frequently." 1670 ::= { addressMapEntry 5 } 1672 -- 1673 -- Network Layer Host Group 1674 -- 1675 -- Counts the amount of traffic sent from and to each network address 1676 -- discovered by the probe. 1677 -- Note that while the hlHostControlTable also has objects that 1678 -- control an optional alHostTable, implementation of the alHostTable is 1679 -- not required to fully implement this group. 1681 hlHostControlTable OBJECT-TYPE 1682 SYNTAX SEQUENCE OF HlHostControlEntry 1683 MAX-ACCESS not-accessible 1684 STATUS current 1685 DESCRIPTION 1686 "A list of higher layer (i.e. non-MAC) host table control entries. 1688 These entries will enable the collection of the network and 1689 application level host tables indexed by network addresses. 1690 Both the network and application level host tables are 1691 controlled by this table is so that they will both be created 1692 and deleted at the same time, further increasing the ease with 1693 which they can be implemented as a single datastore (note that 1694 if an implementation stores application layer host records in 1695 memory, it can derive network layer host records from them). 1697 Entries in the nlHostTable will be created on behalf of each 1698 entry in this table. Additionally, if this probe implements 1699 the alHostTable, entries in the alHostTable will be created on 1700 behalf of each entry in this table. 1702 Implementations are encouraged to add an entry per monitored 1703 interface upon initialization so that a default collection 1704 of host statistics is available." 1705 ::= { nlHost 1 } 1707 hlHostControlEntry OBJECT-TYPE 1708 SYNTAX HlHostControlEntry 1709 MAX-ACCESS not-accessible 1710 STATUS current 1711 DESCRIPTION 1712 "A conceptual row in the hlHostControlTable. 1714 An example of the indexing of this entry is 1715 hlHostControlNlDroppedFrames.1" 1716 INDEX { hlHostControlIndex } 1717 ::= { hlHostControlTable 1 } 1719 HlHostControlEntry ::= SEQUENCE { 1720 hlHostControlIndex Integer32, 1721 hlHostControlDataSource DataSource, 1722 hlHostControlNlDroppedFrames Counter32, 1723 hlHostControlNlInserts Counter32, 1724 hlHostControlNlDeletes Counter32, 1725 hlHostControlNlMaxDesiredEntries Integer32, 1726 hlHostControlAlDroppedFrames Counter32, 1727 hlHostControlAlInserts Counter32, 1728 hlHostControlAlDeletes Counter32, 1729 hlHostControlAlMaxDesiredEntries Integer32, 1730 hlHostControlOwner OwnerString, 1731 hlHostControlStatus RowStatus 1732 } 1734 hlHostControlIndex OBJECT-TYPE 1735 SYNTAX Integer32 (1..65535) 1736 MAX-ACCESS not-accessible 1737 STATUS current 1738 DESCRIPTION 1739 "An index that uniquely identifies an entry in the 1740 hlHostControlTable. Each such entry defines 1741 a function that discovers hosts on a particular 1742 interface and places statistics about them in the 1743 nlHostTable, and optionally in the alHostTable, on 1744 behalf of this hlHostControlEntry." 1745 ::= { hlHostControlEntry 1 } 1747 hlHostControlDataSource OBJECT-TYPE 1748 SYNTAX DataSource 1749 MAX-ACCESS read-create 1750 STATUS current 1751 DESCRIPTION 1752 "The source of data for the associated host tables. 1754 The statistics in this group reflect all packets 1755 on the local network segment attached to the 1756 identified interface. 1758 This object may not be modified if the associated 1759 hlHostControlStatus object is equal to active(1)." 1760 ::= { hlHostControlEntry 2 } 1762 hlHostControlNlDroppedFrames OBJECT-TYPE 1763 SYNTAX Counter32 1764 MAX-ACCESS read-only 1765 STATUS current 1766 DESCRIPTION 1767 "The total number of frames which were received by the probe 1768 and therefore not accounted for in the *StatsDropEvents, but 1769 for which the probe chose not to count for the associated 1770 nlHost entries for whatever reason. Most often, this event 1771 occurs when the probe is out of some resources and decides to 1772 shed load from this collection. 1774 This count does not include packets that were not counted 1775 because they had MAC-layer errors. 1777 Note that if the nlHostTable is inactive because no protocols 1778 are enabled in the protocol directory, this value should be 0. 1780 Note that, unlike the dropEvents counter, this number is the 1781 exact number of frames dropped." 1782 ::= { hlHostControlEntry 3 } 1784 hlHostControlNlInserts OBJECT-TYPE 1785 SYNTAX Counter32 1786 MAX-ACCESS read-only 1787 STATUS current 1788 DESCRIPTION 1789 "The number of times an nlHost entry has been 1790 inserted into the nlHost table. If an entry is inserted, then 1791 deleted, and then inserted, this counter will be incremented 1792 by 2. 1794 To allow for efficient implementation strategies, agents may 1795 delay updating this object for short periods of time. For 1796 example, an implementation strategy may allow internal 1797 data structures to differ from those visible via SNMP for 1798 short periods of time. This counter may reflect the internal 1799 data structures for those short periods of time. 1801 Note that the table size can be determined by subtracting 1802 hlHostControlNlDeletes from hlHostControlNlInserts." 1803 ::= { hlHostControlEntry 4 } 1805 hlHostControlNlDeletes OBJECT-TYPE 1806 SYNTAX Counter32 1807 MAX-ACCESS read-only 1808 STATUS current 1809 DESCRIPTION 1810 "The number of times an nlHost entry has been 1811 deleted from the nlHost table (for any reason). If an entry 1812 is deleted, then inserted, and then deleted, this counter will 1813 be incremented by 2. 1815 To allow for efficient implementation strategies, agents may 1816 delay updating this object for short periods of time. For 1817 example, an implementation strategy may allow internal 1818 data structures to differ from those visible via SNMP for 1819 short periods of time. This counter may reflect the internal 1820 data structures for those short periods of time. 1822 Note that the table size can be determined by subtracting 1823 hlHostControlNlDeletes from hlHostControlNlInserts." 1824 ::= { hlHostControlEntry 5 } 1826 hlHostControlNlMaxDesiredEntries OBJECT-TYPE 1827 SYNTAX Integer32 (-1..2147483647) 1828 MAX-ACCESS read-create 1829 STATUS current 1830 DESCRIPTION 1831 "The maximum number of entries that are desired in the 1832 nlHostTable on behalf of this control entry. The probe will 1833 not create more than this number of associated entries in the 1834 table, but may choose to create fewer entries in this table 1835 for any reason including the lack of resources. 1837 If this object is set to a value less than the current number 1838 of entries, enough entries are chosen in an 1839 implementation-dependent manner and deleted so that the number 1840 of entries in the table equals the value of this object. 1842 If this value is set to -1, the probe may create any number 1843 of entries in this table. If the associated 1844 hlHostControlStatus object is equal to `active', this 1845 object may not be modified. 1847 This object may be used to control how resources are allocated 1848 on the probe for the various RMON functions." 1849 ::= { hlHostControlEntry 6 } 1851 hlHostControlAlDroppedFrames OBJECT-TYPE 1852 SYNTAX Counter32 1853 MAX-ACCESS read-only 1854 STATUS current 1855 DESCRIPTION 1856 "The total number of frames which were received by the probe 1857 and therefore not accounted for in the *StatsDropEvents, but 1858 for which the probe chose not to count for the associated 1859 alHost entries for whatever reason. Most often, this event 1860 occurs when the probe is out of some resources and decides to 1861 shed load from this collection. 1863 This count does not include packets that were not counted 1864 because they had MAC-layer errors. 1866 Note that if the alHostTable is not implemented or is inactive 1867 because no protocols are enabled in the protocol directory, 1868 this value should be 0. 1870 Note that, unlike the dropEvents counter, this number is the 1871 exact number of frames dropped." 1872 ::= { hlHostControlEntry 7 } 1874 hlHostControlAlInserts OBJECT-TYPE 1875 SYNTAX Counter32 1876 MAX-ACCESS read-only 1877 STATUS current 1878 DESCRIPTION 1879 "The number of times an alHost entry has been 1880 inserted into the alHost table. If an entry is inserted, then 1881 deleted, and then inserted, this counter will be incremented 1882 by 2. 1884 To allow for efficient implementation strategies, agents may 1885 delay updating this object for short periods of time. For 1886 example, an implementation strategy may allow internal 1887 data structures to differ from those visible via SNMP for 1888 short periods of time. This counter may reflect the internal 1889 data structures for those short periods of time. 1891 Note that the table size can be determined by subtracting 1892 hlHostControlAlDeletes from hlHostControlAlInserts." 1893 ::= { hlHostControlEntry 8 } 1895 hlHostControlAlDeletes OBJECT-TYPE 1896 SYNTAX Counter32 1897 MAX-ACCESS read-only 1898 STATUS current 1899 DESCRIPTION 1900 "The number of times an alHost entry has been 1901 deleted from the alHost table (for any reason). If an entry 1902 is deleted, then inserted, and then deleted, this counter will 1903 be incremented by 2. 1905 To allow for efficient implementation strategies, agents may 1906 delay updating this object for short periods of time. For 1907 example, an implementation strategy may allow internal 1908 data structures to differ from those visible via SNMP for 1909 short periods of time. This counter may reflect the internal 1910 data structures for those short periods of time. 1912 Note that the table size can be determined by subtracting 1913 hlHostControlAlDeletes from hlHostControlAlInserts." 1914 ::= { hlHostControlEntry 9 } 1916 hlHostControlAlMaxDesiredEntries OBJECT-TYPE 1917 SYNTAX Integer32 (-1..2147483647) 1918 MAX-ACCESS read-create 1919 STATUS current 1920 DESCRIPTION 1921 "The maximum number of entries that are desired in the alHost 1922 table on behalf of this control entry. The probe will not 1923 create more than this number of associated entries in the 1924 table, but may choose to create fewer entries in this table 1925 for any reason including the lack of resources. 1927 If this object is set to a value less than the current number 1928 of entries, enough entries are chosen in an 1929 implementation-dependent manner and deleted so that the number 1930 of entries in the table equals the value of this object. 1932 If this value is set to -1, the probe may create any number 1933 of entries in this table. If the associated 1934 hlHostControlStatus object is equal to `active', this 1935 object may not be modified. 1937 This object may be used to control how resources are allocated 1938 on the probe for the various RMON functions." 1939 ::= { hlHostControlEntry 10 } 1941 hlHostControlOwner OBJECT-TYPE 1942 SYNTAX OwnerString 1943 MAX-ACCESS read-create 1944 STATUS current 1945 DESCRIPTION 1946 "The entity that configured this entry and is 1947 therefore using the resources assigned to it." 1948 ::= { hlHostControlEntry 11 } 1950 hlHostControlStatus OBJECT-TYPE 1951 SYNTAX RowStatus 1952 MAX-ACCESS read-create 1953 STATUS current 1954 DESCRIPTION 1955 "The status of this hlHostControlEntry. 1957 An entry may not exist in the active state unless all 1958 objects in the entry have an appropriate value. 1960 If this object is not equal to active(1), all associated 1961 entries in the nlHostTable and alHostTable shall be deleted." 1962 ::= { hlHostControlEntry 12 } 1964 nlHostTable OBJECT-TYPE 1965 SYNTAX SEQUENCE OF NlHostEntry 1966 MAX-ACCESS not-accessible 1967 STATUS current 1968 DESCRIPTION 1969 "A collection of statistics for a particular network layer 1970 address that has been discovered on an interface of this 1971 device. 1973 The probe will populate this table for all network layer 1974 protocols in the protocol directory table whose value of 1975 protocolDirHostConfig is equal to supportedOn(3), and 1976 will delete any entries whose protocolDirEntry is deleted or 1977 has a protocolDirHostConfig value of supportedOff(2). 1979 The probe will add to this table all addresses seen 1980 as the source or destination address in all packets with no 1981 MAC errors, and will increment octet and packet counts in the 1982 table for all packets with no MAC errors." 1983 ::= { nlHost 2 } 1985 nlHostEntry OBJECT-TYPE 1986 SYNTAX NlHostEntry 1987 MAX-ACCESS not-accessible 1988 STATUS current 1989 DESCRIPTION 1990 "A conceptual row in the nlHostTable. 1992 The hlHostControlIndex value in the index identifies the 1993 hlHostControlEntry on whose behalf this entry was created. 1994 The protocolDirLocalIndex value in the index identifies the 1995 network layer protocol of the nlHostAddress. 1997 An example of the indexing of this entry is 1998 nlHostOutPkts.1.783495.18.4.128.2.6.6. 2000 Note that some combinations of index values may result in an 2001 index that exceeds 128 sub-identifiers in length which exceeds 2002 the maximum for the SNMP protocol. Implementations should take 2003 care to avoid such combinations." 2004 INDEX { hlHostControlIndex, nlHostTimeMark, 2005 protocolDirLocalIndex, nlHostAddress } 2006 ::= { nlHostTable 1 } 2008 NlHostEntry ::= SEQUENCE { 2009 nlHostTimeMark TimeFilter, 2010 nlHostAddress OCTET STRING, 2011 nlHostInPkts ZeroBasedCounter32, 2012 nlHostOutPkts ZeroBasedCounter32, 2013 nlHostInOctets ZeroBasedCounter32, 2014 nlHostOutOctets ZeroBasedCounter32, 2015 nlHostOutMacNonUnicastPkts ZeroBasedCounter32, 2016 nlHostCreateTime LastCreateTime 2017 } 2019 nlHostTimeMark OBJECT-TYPE 2020 SYNTAX TimeFilter 2021 MAX-ACCESS not-accessible 2022 STATUS current 2023 DESCRIPTION 2024 "A TimeFilter for this entry. See the TimeFilter textual 2025 convention to see how this works." 2026 ::= { nlHostEntry 1 } 2028 nlHostAddress OBJECT-TYPE 2029 SYNTAX OCTET STRING (SIZE (1..255)) 2030 MAX-ACCESS not-accessible 2031 STATUS current 2032 DESCRIPTION 2033 "The network address for this nlHostEntry. 2035 This is represented as an octet string with 2036 specific semantics and length as identified 2037 by the protocolDirLocalIndex component of the index. 2039 For example, if the protocolDirLocalIndex indicates an 2040 encapsulation of ip, this object is encoded as a length 2041 octet of 4, followed by the 4 octets of the ip address, 2042 in network byte order." 2043 ::= { nlHostEntry 2 } 2045 nlHostInPkts OBJECT-TYPE 2046 SYNTAX ZeroBasedCounter32 2047 MAX-ACCESS read-only 2048 STATUS current 2049 DESCRIPTION 2050 "The number of packets without errors transmitted to 2051 this address since it was added to the nlHostTable. Note that 2052 this is the number of link-layer packets, so if a single 2053 network-layer packet is fragmented into several link-layer 2054 frames, this counter is incremented several times." 2055 ::= { nlHostEntry 3 } 2057 nlHostOutPkts OBJECT-TYPE 2058 SYNTAX ZeroBasedCounter32 2059 MAX-ACCESS read-only 2060 STATUS current 2061 DESCRIPTION 2062 "The number of packets without errors transmitted by 2063 this address since it was added to the nlHostTable. Note that 2064 this is the number of link-layer packets, so if a single 2065 network-layer packet is fragmented into several link-layer 2066 frames, this counter is incremented several times." 2067 ::= { nlHostEntry 4 } 2069 nlHostInOctets OBJECT-TYPE 2070 SYNTAX ZeroBasedCounter32 2071 MAX-ACCESS read-only 2072 STATUS current 2073 DESCRIPTION 2074 "The number of octets transmitted to this address 2075 since it was added to the nlHostTable (excluding 2076 framing bits but including FCS octets), excluding 2077 those octets in packets that contained errors. 2079 Note this doesn't count just those octets in the particular 2080 protocol frames, but includes the entire packet that contained 2081 the protocol." 2082 ::= { nlHostEntry 5 } 2084 nlHostOutOctets OBJECT-TYPE 2085 SYNTAX ZeroBasedCounter32 2086 MAX-ACCESS read-only 2087 STATUS current 2088 DESCRIPTION 2089 "The number of octets transmitted by this address 2090 since it was added to the nlHostTable (excluding 2091 framing bits but including FCS octets), excluding 2092 those octets in packets that contained errors. 2094 Note this doesn't count just those octets in the particular 2095 protocol frames, but includes the entire packet that contained 2096 the protocol." 2097 ::= { nlHostEntry 6 } 2099 nlHostOutMacNonUnicastPkts OBJECT-TYPE 2100 SYNTAX ZeroBasedCounter32 2101 MAX-ACCESS read-only 2102 STATUS current 2103 DESCRIPTION 2104 "The number of packets without errors transmitted by this 2105 address that were directed to any MAC broadcast addresses 2106 or to any MAC multicast addresses since this host was 2107 added to the nlHostTable. Note that this is the number of 2108 link-layer packets, so if a single network-layer packet is 2109 fragmented into several link-layer frames, this counter is 2110 incremented several times." 2111 ::= { nlHostEntry 7 } 2113 nlHostCreateTime OBJECT-TYPE 2114 SYNTAX LastCreateTime 2115 MAX-ACCESS read-only 2116 STATUS current 2117 DESCRIPTION 2118 "The value of sysUpTime when this entry was last activated. 2119 This can be used by the management station to ensure that the 2120 entry has not been deleted and recreated between polls." 2121 ::= { nlHostEntry 8 } 2123 -- 2124 -- Network Layer Matrix Group 2125 -- 2126 -- Counts the amount of traffic sent between each pair of network 2127 -- addresses discovered by the probe. 2128 -- Note that while the hlMatrixControlTable also has objects that 2129 -- control optional alMatrixTables, implementation of the 2130 -- alMatrixTables is not required to fully implement this group. 2132 hlMatrixControlTable OBJECT-TYPE 2133 SYNTAX SEQUENCE OF HlMatrixControlEntry 2134 MAX-ACCESS not-accessible 2135 STATUS current 2136 DESCRIPTION 2137 "A list of higher layer (i.e. non-MAC) matrix control entries. 2139 These entries will enable the collection of the network and 2140 application level matrix tables containing conversation 2141 statistics indexed by pairs of network addresses. 2142 Both the network and application level matrix tables are 2143 controlled by this table is so that they will both be created 2144 and deleted at the same time, further increasing the ease with 2145 which they can be implemented as a single datastore (note that 2146 if an implementation stores application layer matrix records 2147 in memory, it can derive network layer matrix records from 2148 them). 2150 Entries in the nlMatrixSDTable and nlMatrixDSTable will be 2151 created on behalf of each entry in this table. Additionally, 2152 if this probe implements the alMatrix tables, entries in the 2153 alMatrix tables will be created on behalf of each entry in 2154 this table." 2155 ::= { nlMatrix 1 } 2157 hlMatrixControlEntry OBJECT-TYPE 2158 SYNTAX HlMatrixControlEntry 2159 MAX-ACCESS not-accessible 2160 STATUS current 2161 DESCRIPTION 2162 "A conceptual row in the hlMatrixControlTable. 2164 An example of indexing of this entry is 2165 hlMatrixControlNlDroppedFrames.1" 2166 INDEX { hlMatrixControlIndex } 2167 ::= { hlMatrixControlTable 1 } 2169 HlMatrixControlEntry ::= SEQUENCE { 2170 hlMatrixControlIndex Integer32, 2171 hlMatrixControlDataSource DataSource, 2172 hlMatrixControlNlDroppedFrames Counter32, 2173 hlMatrixControlNlInserts Counter32, 2174 hlMatrixControlNlDeletes Counter32, 2175 hlMatrixControlNlMaxDesiredEntries Integer32, 2176 hlMatrixControlAlDroppedFrames Counter32, 2177 hlMatrixControlAlInserts Counter32, 2178 hlMatrixControlAlDeletes Counter32, 2179 hlMatrixControlAlMaxDesiredEntries Integer32, 2180 hlMatrixControlOwner OwnerString, 2181 hlMatrixControlStatus RowStatus 2182 } 2184 hlMatrixControlIndex OBJECT-TYPE 2185 SYNTAX Integer32 (1..65535) 2186 MAX-ACCESS not-accessible 2187 STATUS current 2188 DESCRIPTION 2189 "An index that uniquely identifies an entry in the 2190 hlMatrixControlTable. Each such entry defines 2191 a function that discovers conversations on a particular 2192 interface and places statistics about them in the 2193 nlMatrixSDTable and the nlMatrixDSTable, and optionally the 2194 alMatrixSDTable and alMatrixDSTable, on behalf of this 2195 hlMatrixControlEntry." 2196 ::= { hlMatrixControlEntry 1 } 2198 hlMatrixControlDataSource OBJECT-TYPE 2199 SYNTAX DataSource 2200 MAX-ACCESS read-create 2201 STATUS current 2202 DESCRIPTION 2203 "The source of the data for the associated matrix tables. 2205 The statistics in this group reflect all packets 2206 on the local network segment attached to the 2207 identified interface. 2209 This object may not be modified if the associated 2210 hlMatrixControlStatus object is equal to active(1)." 2211 ::= { hlMatrixControlEntry 2 } 2213 hlMatrixControlNlDroppedFrames OBJECT-TYPE 2214 SYNTAX Counter32 2215 MAX-ACCESS read-only 2216 STATUS current 2217 DESCRIPTION 2218 "The total number of frames which were received by the probe 2219 and therefore not accounted for in the *StatsDropEvents, but 2220 for which the probe chose not to count for this entry for 2221 whatever reason. Most often, this event occurs when the probe 2222 is out of some resources and decides to shed load from this 2223 collection. 2225 This count does not include packets that were not counted 2226 because they had MAC-layer errors. 2228 Note that if the nlMatrixTables are inactive because no 2229 protocols are enabled in the protocol directory, this value 2230 should be 0. 2232 Note that, unlike the dropEvents counter, this number is the 2233 exact number of frames dropped." 2234 ::= { hlMatrixControlEntry 3 } 2236 hlMatrixControlNlInserts OBJECT-TYPE 2237 SYNTAX Counter32 2238 MAX-ACCESS read-only 2239 STATUS current 2240 DESCRIPTION 2241 "The number of times an nlMatrix entry has been 2242 inserted into the nlMatrix tables. If an entry is inserted, 2243 then deleted, and then inserted, this counter will be 2244 incremented by 2. The addition of a conversation into both 2245 the nlMatrixSDTable and nlMatrixDSTable shall be counted as 2246 two insertions (even though every addition into one table must 2247 be accompanied by an insertion into the other). 2249 To allow for efficient implementation strategies, agents may 2250 delay updating this object for short periods of time. For 2251 example, an implementation strategy may allow internal 2252 data structures to differ from those visible via SNMP for 2253 short periods of time. This counter may reflect the internal 2254 data structures for those short periods of time. 2256 Note that the sum of then nlMatrixSDTable and nlMatrixDSTable 2257 sizes can be determined by subtracting 2258 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 2260 ::= { hlMatrixControlEntry 4 } 2262 hlMatrixControlNlDeletes OBJECT-TYPE 2263 SYNTAX Counter32 2264 MAX-ACCESS read-only 2265 STATUS current 2266 DESCRIPTION 2267 "The number of times an nlMatrix entry has been 2268 deleted from the nlMatrix tables (for any reason). If an 2269 entry is deleted, then inserted, and then deleted, this 2270 counter will be incremented by 2. The deletion of a 2271 conversation from both the nlMatrixSDTable and nlMatrixDSTable 2272 shall be counted as two deletions (even though every deletion 2273 from one table must be accompanied by a deletion from the 2274 other). 2276 To allow for efficient implementation strategies, agents may 2277 delay updating this object for short periods of time. For 2278 example, an implementation strategy may allow internal 2279 data structures to differ from those visible via SNMP for 2280 short periods of time. This counter may reflect the internal 2281 data structures for those short periods of time. 2283 Note that the table size can be determined by subtracting 2284 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 2285 ::= { hlMatrixControlEntry 5 } 2287 hlMatrixControlNlMaxDesiredEntries OBJECT-TYPE 2288 SYNTAX Integer32 (-1..2147483647) 2289 MAX-ACCESS read-create 2290 STATUS current 2291 DESCRIPTION 2292 "The maximum number of entries that are desired in the 2293 nlMatrix tables on behalf of this control entry. The probe 2294 will not create more than this number of associated entries in 2295 the table, but may choose to create fewer entries in this 2296 table for any reason including the lack of resources. 2298 If this object is set to a value less than the current number 2299 of entries, enough entries are chosen in an 2300 implementation-dependent manner and deleted so that the number 2301 of entries in the table equals the value of this object. 2303 If this value is set to -1, the probe may create any number 2304 of entries in this table. If the associated 2305 hlMatrixControlStatus object is equal to `active', this 2306 object may not be modified. 2308 This object may be used to control how resources are allocated 2309 on the probe for the various RMON functions." 2310 ::= { hlMatrixControlEntry 6 } 2312 hlMatrixControlAlDroppedFrames OBJECT-TYPE 2313 SYNTAX Counter32 2314 MAX-ACCESS read-only 2315 STATUS current 2316 DESCRIPTION 2317 "The total number of frames which were received by the probe 2318 and therefore not accounted for in the *StatsDropEvents, but 2319 for which the probe chose not to count for this entry for 2320 whatever reason. Most often, this event occurs when the probe 2321 is out of some resources and decides to shed load from this 2322 collection. 2324 This count does not include packets that were not counted 2325 because they had MAC-layer errors. 2327 Note that if the alMatrixTables are not implemented or are 2328 inactive because no protocols are enabled in the protocol 2329 directory, this value should be 0. 2331 Note that, unlike the dropEvents counter, this number is the 2332 exact number of frames dropped." 2333 ::= { hlMatrixControlEntry 7 } 2335 hlMatrixControlAlInserts OBJECT-TYPE 2336 SYNTAX Counter32 2337 MAX-ACCESS read-only 2338 STATUS current 2339 DESCRIPTION 2340 "The number of times an alMatrix entry has been 2341 inserted into the alMatrix tables. If an entry is inserted, 2342 then deleted, and then inserted, this counter will be 2343 incremented by 2. The addition of a conversation into both 2344 the alMatrixSDTable and alMatrixDSTable shall be counted as 2345 two insertions (even though every addition into one table must 2346 be accompanied by an insertion into the other). 2348 To allow for efficient implementation strategies, agents may 2349 delay updating this object for short periods of time. For 2350 example, an implementation strategy may allow internal 2351 data structures to differ from those visible via SNMP for 2352 short periods of time. This counter may reflect the internal 2353 data structures for those short periods of time. 2355 Note that the table size can be determined by subtracting 2356 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 2357 ::= { hlMatrixControlEntry 8 } 2359 hlMatrixControlAlDeletes OBJECT-TYPE 2360 SYNTAX Counter32 2361 MAX-ACCESS read-only 2362 STATUS current 2363 DESCRIPTION 2364 "The number of times an alMatrix entry has been 2365 deleted from the alMatrix tables. If an entry is deleted, 2366 then inserted, and then deleted, this counter will be 2367 incremented by 2. The deletion of a conversation from both 2368 the alMatrixSDTable and alMatrixDSTable shall be counted as 2369 two deletions (even though every deletion from one table must 2370 be accompanied by a deletion from the other). 2372 To allow for efficient implementation strategies, agents may 2373 delay updating this object for short periods of time. For 2374 example, an implementation strategy may allow internal 2375 data structures to differ from those visible via SNMP for 2376 short periods of time. This counter may reflect the internal 2377 data structures for those short periods of time. 2379 Note that the table size can be determined by subtracting 2380 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 2381 ::= { hlMatrixControlEntry 9 } 2383 hlMatrixControlAlMaxDesiredEntries OBJECT-TYPE 2384 SYNTAX Integer32 (-1..2147483647) 2385 MAX-ACCESS read-create 2386 STATUS current 2387 DESCRIPTION 2388 "The maximum number of entries that are desired in the 2389 alMatrix tables on behalf of this control entry. The probe 2390 will not create more than this number of associated entries in 2391 the table, but may choose to create fewer entries in this 2392 table for any reason including the lack of resources. 2394 If this object is set to a value less than the current number 2395 of entries, enough entries are chosen in an 2396 implementation-dependent manner and deleted so that the number 2397 of entries in the table equals the value of this object. 2399 If this value is set to -1, the probe may create any number 2400 of entries in this table. If the associated 2401 hlMatrixControlStatus object is equal to `active', this 2402 object may not be modified. 2404 This object may be used to control how resources are allocated 2405 on the probe for the various RMON functions." 2406 ::= { hlMatrixControlEntry 10 } 2408 hlMatrixControlOwner OBJECT-TYPE 2409 SYNTAX OwnerString 2410 MAX-ACCESS read-create 2411 STATUS current 2412 DESCRIPTION 2413 "The entity that configured this entry and is 2414 therefore using the resources assigned to it." 2415 ::= { hlMatrixControlEntry 11 } 2417 hlMatrixControlStatus OBJECT-TYPE 2418 SYNTAX RowStatus 2419 MAX-ACCESS read-create 2420 STATUS current 2421 DESCRIPTION 2422 "The status of this hlMatrixControlEntry. 2424 An entry may not exist in the active state unless all 2425 objects in the entry have an appropriate value. 2427 If this object is not equal to active(1), all 2428 associated entries in the nlMatrixSDTable, 2429 nlMatrixDSTable, alMatrixSDTable, and the alMatrixDSTable 2430 shall be deleted by the agent." 2431 ::= { hlMatrixControlEntry 12 } 2433 nlMatrixSDTable OBJECT-TYPE 2434 SYNTAX SEQUENCE OF NlMatrixSDEntry 2435 MAX-ACCESS not-accessible 2436 STATUS current 2437 DESCRIPTION 2438 "A list of traffic matrix entries which collect statistics for 2439 conversations between two network-level addresses. This table 2440 is indexed first by the source address and then by the 2441 destination address to make it convenient to collect all 2442 conversations from a particular address. 2444 The probe will populate this table for all network layer 2445 protocols in the protocol directory table whose value of 2446 protocolDirMatrixConfig is equal to supportedOn(3), and 2447 will delete any entries whose protocolDirEntry is deleted or 2448 has a protocolDirMatrixConfig value of supportedOff(2). 2450 The probe will add to this table all pairs of addresses 2451 seen in all packets with no MAC errors, and will increment 2452 octet and packet counts in the table for all packets with no 2453 MAC errors. 2455 Further, this table will only contain entries that have a 2456 corresponding entry in the nlMatrixDSTable with the same 2457 source address and destination address." 2458 ::= { nlMatrix 2 } 2460 nlMatrixSDEntry OBJECT-TYPE 2461 SYNTAX NlMatrixSDEntry 2462 MAX-ACCESS not-accessible 2463 STATUS current 2464 DESCRIPTION 2465 "A conceptual row in the nlMatrixSDTable. 2467 The hlMatrixControlIndex value in the index identifies the 2468 hlMatrixControlEntry on whose behalf this entry was created. 2469 The protocolDirLocalIndex value in the index identifies the 2470 network layer protocol of the nlMatrixSDSourceAddress and 2471 nlMatrixSDDestAddress. 2473 An example of the indexing of this table is 2474 nlMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7. 2476 Note that some combinations of index values may result in an 2477 index that exceeds 128 sub-identifiers in length which exceeds 2478 the maximum for the SNMP protocol. Implementations should take 2479 care to avoid such combinations." 2480 INDEX { hlMatrixControlIndex, nlMatrixSDTimeMark, 2481 protocolDirLocalIndex, 2482 nlMatrixSDSourceAddress, nlMatrixSDDestAddress } 2483 ::= { nlMatrixSDTable 1 } 2485 NlMatrixSDEntry ::= SEQUENCE { 2486 nlMatrixSDTimeMark TimeFilter, 2487 nlMatrixSDSourceAddress OCTET STRING, 2488 nlMatrixSDDestAddress OCTET STRING, 2489 nlMatrixSDPkts ZeroBasedCounter32, 2490 nlMatrixSDOctets ZeroBasedCounter32, 2491 nlMatrixSDCreateTime LastCreateTime 2492 } 2494 nlMatrixSDTimeMark OBJECT-TYPE 2495 SYNTAX TimeFilter 2496 MAX-ACCESS not-accessible 2497 STATUS current 2498 DESCRIPTION 2499 "A TimeFilter for this entry. See the TimeFilter textual 2500 convention to see how this works." 2501 ::= { nlMatrixSDEntry 1 } 2503 nlMatrixSDSourceAddress OBJECT-TYPE 2504 SYNTAX OCTET STRING (SIZE (1..255)) 2505 MAX-ACCESS not-accessible 2506 STATUS current 2507 DESCRIPTION 2508 "The network source address for this nlMatrixSDEntry. 2510 This is represented as an octet string with 2511 specific semantics and length as identified 2512 by the protocolDirLocalIndex component of the index. 2514 For example, if the protocolDirLocalIndex indicates an 2515 encapsulation of ip, this object is encoded as a length 2516 octet of 4, followed by the 4 octets of the ip address, 2517 in network byte order." 2518 ::= { nlMatrixSDEntry 2 } 2520 nlMatrixSDDestAddress OBJECT-TYPE 2521 SYNTAX OCTET STRING (SIZE (1..255)) 2522 MAX-ACCESS not-accessible 2523 STATUS current 2524 DESCRIPTION 2525 "The network destination address for this 2526 nlMatrixSDEntry. 2528 This is represented as an octet string with 2529 specific semantics and length as identified 2530 by the protocolDirLocalIndex component of the index. 2532 For example, if the protocolDirLocalIndex indicates an 2533 encapsulation of ip, this object is encoded as a length 2534 octet of 4, followed by the 4 octets of the ip address, 2535 in network byte order." 2536 ::= { nlMatrixSDEntry 3 } 2538 nlMatrixSDPkts OBJECT-TYPE 2539 SYNTAX ZeroBasedCounter32 2540 MAX-ACCESS read-only 2541 STATUS current 2542 DESCRIPTION 2543 "The number of packets without errors transmitted from the 2544 source address to the destination address since this entry was 2545 added to the nlMatrixSDTable. Note that this is the number of 2546 link-layer packets, so if a single network-layer packet is 2547 fragmented into several link-layer frames, this counter is 2548 incremented several times." 2549 ::= { nlMatrixSDEntry 4 } 2551 nlMatrixSDOctets OBJECT-TYPE 2552 SYNTAX ZeroBasedCounter32 2553 MAX-ACCESS read-only 2554 STATUS current 2555 DESCRIPTION 2556 "The number of octets transmitted from the source address to 2557 the destination address since this entry was added to the 2558 nlMatrixSDTable (excluding framing bits but 2559 including FCS octets), excluding those octets in packets that 2560 contained errors. 2562 Note this doesn't count just those octets in the particular 2563 protocol frames, but includes the entire packet that contained 2564 the protocol." 2565 ::= { nlMatrixSDEntry 5 } 2567 nlMatrixSDCreateTime OBJECT-TYPE 2568 SYNTAX LastCreateTime 2569 MAX-ACCESS read-only 2570 STATUS current 2571 DESCRIPTION 2572 "The value of sysUpTime when this entry was last activated. 2573 This can be used by the management station to ensure that the 2574 entry has not been deleted and recreated between polls." 2576 ::= { nlMatrixSDEntry 6 } 2578 -- Traffic matrix tables from destination to source 2580 nlMatrixDSTable OBJECT-TYPE 2581 SYNTAX SEQUENCE OF NlMatrixDSEntry 2582 MAX-ACCESS not-accessible 2583 STATUS current 2584 DESCRIPTION 2585 "A list of traffic matrix entries which collect statistics for 2586 conversations between two network-level addresses. This table 2587 is indexed first by the destination address and then by the 2588 source address to make it convenient to collect all 2589 conversations to a particular address. 2591 The probe will populate this table for all network layer 2592 protocols in the protocol directory table whose value of 2593 protocolDirMatrixConfig is equal to supportedOn(3), and 2594 will delete any entries whose protocolDirEntry is deleted or 2595 has a protocolDirMatrixConfig value of supportedOff(2). 2597 The probe will add to this table all pairs of addresses 2598 seen in all packets with no MAC errors, and will increment 2599 octet and packet counts in the table for all packets with no 2600 MAC errors. 2602 Further, this table will only contain entries that have a 2603 corresponding entry in the nlMatrixSDTable with the same 2604 source address and destination address." 2605 ::= { nlMatrix 3 } 2607 nlMatrixDSEntry OBJECT-TYPE 2608 SYNTAX NlMatrixDSEntry 2609 MAX-ACCESS not-accessible 2610 STATUS current 2611 DESCRIPTION 2612 "A conceptual row in the nlMatrixDSTable. 2614 The hlMatrixControlIndex value in the index identifies the 2615 hlMatrixControlEntry on whose behalf this entry was created. 2616 The protocolDirLocalIndex value in the index identifies the 2617 network layer protocol of the nlMatrixDSSourceAddress and 2618 nlMatrixDSDestAddress. 2620 An example of the indexing of this table is 2621 nlMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6. 2623 Note that some combinations of index values may result in an 2624 index that exceeds 128 sub-identifiers in length which exceeds 2625 the maximum for the SNMP protocol. Implementations should take 2626 care to avoid such combinations." 2627 INDEX { hlMatrixControlIndex, nlMatrixDSTimeMark, 2628 protocolDirLocalIndex, 2629 nlMatrixDSDestAddress, nlMatrixDSSourceAddress } 2630 ::= { nlMatrixDSTable 1 } 2632 NlMatrixDSEntry ::= SEQUENCE { 2633 nlMatrixDSTimeMark TimeFilter, 2634 nlMatrixDSSourceAddress OCTET STRING, 2635 nlMatrixDSDestAddress OCTET STRING, 2636 nlMatrixDSPkts ZeroBasedCounter32, 2637 nlMatrixDSOctets ZeroBasedCounter32, 2638 nlMatrixDSCreateTime LastCreateTime 2639 } 2641 nlMatrixDSTimeMark OBJECT-TYPE 2642 SYNTAX TimeFilter 2643 MAX-ACCESS not-accessible 2644 STATUS current 2645 DESCRIPTION 2646 "A TimeFilter for this entry. See the TimeFilter textual 2647 convention to see how this works." 2648 ::= { nlMatrixDSEntry 1 } 2650 nlMatrixDSSourceAddress OBJECT-TYPE 2651 SYNTAX OCTET STRING (SIZE (1..255)) 2652 MAX-ACCESS not-accessible 2653 STATUS current 2654 DESCRIPTION 2655 "The network source address for this nlMatrixDSEntry. 2657 This is represented as an octet string with 2658 specific semantics and length as identified 2659 by the protocolDirLocalIndex component of the index. 2661 For example, if the protocolDirLocalIndex indicates an 2662 encapsulation of ip, this object is encoded as a length 2663 octet of 4, followed by the 4 octets of the ip address, 2664 in network byte order." 2666 ::= { nlMatrixDSEntry 2 } 2668 nlMatrixDSDestAddress OBJECT-TYPE 2669 SYNTAX OCTET STRING (SIZE (1..255)) 2670 MAX-ACCESS not-accessible 2671 STATUS current 2672 DESCRIPTION 2673 "The network destination address for this 2674 nlMatrixDSEntry. 2676 This is represented as an octet string with 2677 specific semantics and length as identified 2678 by the protocolDirLocalIndex component of the index. 2680 For example, if the protocolDirLocalIndex indicates an 2681 encapsulation of ip, this object is encoded as a length 2682 octet of 4, followed by the 4 octets of the ip address, 2683 in network byte order." 2684 ::= { nlMatrixDSEntry 3 } 2686 nlMatrixDSPkts OBJECT-TYPE 2687 SYNTAX ZeroBasedCounter32 2688 MAX-ACCESS read-only 2689 STATUS current 2690 DESCRIPTION 2691 "The number of packets without errors transmitted from the 2692 source address to the destination address since this entry was 2693 added to the nlMatrixDSTable. Note that this is the number of 2694 link-layer packets, so if a single network-layer packet is 2695 fragmented into several link-layer frames, this counter is 2696 incremented several times." 2697 ::= { nlMatrixDSEntry 4 } 2699 nlMatrixDSOctets OBJECT-TYPE 2700 SYNTAX ZeroBasedCounter32 2701 MAX-ACCESS read-only 2702 STATUS current 2703 DESCRIPTION 2704 "The number of octets transmitted from the source address 2705 to the destination address since this entry was added to the 2706 nlMatrixDSTable (excluding framing bits but 2707 including FCS octets), excluding those octets in packets that 2708 contained errors. 2710 Note this doesn't count just those octets in the particular 2711 protocol frames, but includes the entire packet that contained 2712 the protocol." 2713 ::= { nlMatrixDSEntry 5 } 2715 nlMatrixDSCreateTime OBJECT-TYPE 2716 SYNTAX LastCreateTime 2717 MAX-ACCESS read-only 2718 STATUS current 2719 DESCRIPTION 2720 "The value of sysUpTime when this entry was last activated. 2721 This can be used by the management station to ensure that the 2722 entry has not been deleted and recreated between polls." 2723 ::= { nlMatrixDSEntry 6 } 2725 nlMatrixTopNControlTable OBJECT-TYPE 2726 SYNTAX SEQUENCE OF NlMatrixTopNControlEntry 2727 MAX-ACCESS not-accessible 2728 STATUS current 2729 DESCRIPTION 2730 "A set of parameters that control the creation of a 2731 report of the top N matrix entries according to 2732 a selected metric." 2733 ::= { nlMatrix 4 } 2735 nlMatrixTopNControlEntry OBJECT-TYPE 2736 SYNTAX NlMatrixTopNControlEntry 2737 MAX-ACCESS not-accessible 2738 STATUS current 2739 DESCRIPTION 2740 "A conceptual row in the nlMatrixTopNControlTable. 2742 An example of the indexing of this table is 2743 nlMatrixTopNControlDuration.3" 2744 INDEX { nlMatrixTopNControlIndex } 2745 ::= { nlMatrixTopNControlTable 1 } 2747 NlMatrixTopNControlEntry ::= SEQUENCE { 2748 nlMatrixTopNControlIndex Integer32, 2749 nlMatrixTopNControlMatrixIndex Integer32, 2750 nlMatrixTopNControlRateBase INTEGER, 2751 nlMatrixTopNControlTimeRemaining Integer32, 2752 nlMatrixTopNControlGeneratedReports Counter32, 2753 nlMatrixTopNControlDuration Integer32, 2754 nlMatrixTopNControlRequestedSize Integer32, 2755 nlMatrixTopNControlGrantedSize Integer32, 2756 nlMatrixTopNControlStartTime TimeStamp, 2757 nlMatrixTopNControlOwner OwnerString, 2758 nlMatrixTopNControlStatus RowStatus 2759 } 2761 nlMatrixTopNControlIndex OBJECT-TYPE 2762 SYNTAX Integer32 (1..65535) 2763 MAX-ACCESS not-accessible 2764 STATUS current 2765 DESCRIPTION 2766 "An index that uniquely identifies an entry 2767 in the nlMatrixTopNControlTable. Each such 2768 entry defines one top N report prepared for 2769 one interface." 2770 ::= { nlMatrixTopNControlEntry 1 } 2772 nlMatrixTopNControlMatrixIndex OBJECT-TYPE 2773 SYNTAX Integer32 (1..65535) 2774 MAX-ACCESS read-create 2775 STATUS current 2776 DESCRIPTION 2777 "The nlMatrix[SD/DS] table for which a top N report will be 2778 prepared on behalf of this entry. The nlMatrix[SD/DS] table 2779 is identified by the value of the hlMatrixControlIndex 2780 for that table - that value is used here to identify the 2781 particular table. 2783 This object may not be modified if the associated 2784 nlMatrixTopNControlStatus object is equal to active(1)." 2785 ::= { nlMatrixTopNControlEntry 2 } 2787 nlMatrixTopNControlRateBase OBJECT-TYPE 2788 SYNTAX INTEGER { 2789 nlMatrixTopNPkts(1), 2790 nlMatrixTopNOctets(2), 2791 nlMatrixTopNHighCapacityPkts(3), 2792 nlMatrixTopNHighCapacityOctets(4) 2793 } 2794 MAX-ACCESS read-create 2795 STATUS current 2796 DESCRIPTION 2797 "The variable for each nlMatrix[SD/DS] entry that the 2798 nlMatrixTopNEntries are sorted by, as well as a control 2799 for the table that the results will be reported in. 2801 This object may not be modified if the associated 2802 nlMatrixTopNControlStatus object is equal to active(1). 2804 If this value is less than or equal to 2, when the report 2805 is prepared, entries are created in the nlMatrixTopNTable 2806 associated with this object. 2807 If this value is greater than or equal to 3, when the report 2808 is prepared, entries are created in the 2809 nlMatrixTopNHighCapacityTable associated with this object." 2810 ::= { nlMatrixTopNControlEntry 3 } 2812 nlMatrixTopNControlTimeRemaining OBJECT-TYPE 2813 SYNTAX Integer32 (0..2147483647) 2814 MAX-ACCESS read-create 2815 STATUS current 2816 DESCRIPTION 2817 "The number of seconds left in the report currently 2818 being collected. When this object is modified by 2819 the management station, a new collection is started, 2820 possibly aborting a currently running report. The 2821 new value is used as the requested duration of this 2822 report, and is immediately loaded into the associated 2823 nlMatrixTopNControlDuration object. 2824 When the report finishes, the probe will automatically 2825 start another collection with the same initial value 2826 of nlMatrixTopNControlTimeRemaining. Thus the management 2827 station may simply read the resulting reports repeatedly, 2828 checking the startTime and duration each time to ensure that a 2829 report was not missed or that the report parameters were not 2830 changed. 2832 While the value of this object is non-zero, it decrements 2833 by one per second until it reaches zero. At the time 2834 that this object decrements to zero, the report is made 2835 accessible in the nlMatrixTopNTable, overwriting any report 2836 that may be there. 2838 When this object is modified by the management station, any 2839 associated entries in the nlMatrixTopNTable shall be deleted. 2841 (Note that this is a different algorithm than the one used in 2842 the hostTopNTable)." 2843 DEFVAL { 1800 } 2844 ::= { nlMatrixTopNControlEntry 4 } 2846 nlMatrixTopNControlGeneratedReports OBJECT-TYPE 2847 SYNTAX Counter32 2848 MAX-ACCESS read-only 2849 STATUS current 2850 DESCRIPTION 2851 "The number of reports that have been generated by this entry." 2852 ::= { nlMatrixTopNControlEntry 5 } 2854 nlMatrixTopNControlDuration OBJECT-TYPE 2855 SYNTAX Integer32 2856 MAX-ACCESS read-only 2857 STATUS current 2858 DESCRIPTION 2859 "The number of seconds that this report has collected 2860 during the last sampling interval. 2862 When the associated nlMatrixTopNControlTimeRemaining object is 2863 set, this object shall be set by the probe to the 2864 same value and shall not be modified until the next 2865 time the nlMatrixTopNControlTimeRemaining is set. 2867 This value shall be zero if no reports have been 2868 requested for this nlMatrixTopNControlEntry." 2869 ::= { nlMatrixTopNControlEntry 6 } 2871 nlMatrixTopNControlRequestedSize OBJECT-TYPE 2872 SYNTAX Integer32 (0..2147483647) 2873 MAX-ACCESS read-create 2874 STATUS current 2875 DESCRIPTION 2876 "The maximum number of matrix entries requested for this report. 2878 When this object is created or modified, the probe 2879 should set nlMatrixTopNControlGrantedSize as closely to this 2880 object as is possible for the particular probe 2881 implementation and available resources." 2882 DEFVAL { 150 } 2883 ::= { nlMatrixTopNControlEntry 7 } 2885 nlMatrixTopNControlGrantedSize OBJECT-TYPE 2886 SYNTAX Integer32 (0..2147483647) 2887 MAX-ACCESS read-only 2888 STATUS current 2889 DESCRIPTION 2890 "The maximum number of matrix entries in this report. 2892 When the associated nlMatrixTopNControlRequestedSize object is 2893 created or modified, the probe should set this 2894 object as closely to the requested value as is 2895 possible for the particular implementation and 2896 available resources. The probe must not lower this 2897 value except as a result of a set to the associated 2898 nlMatrixTopNControlRequestedSize object. 2900 If the value of nlMatrixTopNControlRateBase is equal to 2901 nlMatrixTopNPkts, when the next topN report is generated, 2902 matrix entries with the highest value of nlMatrixTopNPktRate 2903 shall be placed in this table in decreasing order of this rate 2904 until there is no more room or until there are no more 2905 matrix entries. 2907 If the value of nlMatrixTopNControlRateBase is equal to 2908 nlMatrixTopNOctets, when the next topN report is generated, 2909 matrix entries with the highest value of nlMatrixTopNOctetRate 2910 shall be placed in this table in decreasing order of this rate 2911 until there is no more room or until there are no more 2912 matrix entries. 2914 It is an implementation-specific matter how entries with the 2915 same value of nlMatrixTopNPktRate or nlMatrixTopNOctetRate are 2916 sorted. It is also an implementation-specific matter as to 2917 whether or not zero-valued entries are available." 2918 ::= { nlMatrixTopNControlEntry 8 } 2920 nlMatrixTopNControlStartTime OBJECT-TYPE 2921 SYNTAX TimeStamp 2922 MAX-ACCESS read-only 2923 STATUS current 2924 DESCRIPTION 2925 "The value of sysUpTime when this top N report was 2926 last started. In other words, this is the time that 2927 the associated nlMatrixTopNControlTimeRemaining object was 2928 modified to start the requested report or the time 2929 the report was last automatically (re)started. 2931 This object may be used by the management station to 2932 determine if a report was missed or not." 2933 ::= { nlMatrixTopNControlEntry 9 } 2935 nlMatrixTopNControlOwner OBJECT-TYPE 2936 SYNTAX OwnerString 2937 MAX-ACCESS read-create 2938 STATUS current 2939 DESCRIPTION 2940 "The entity that configured this entry and is 2941 therefore using the resources assigned to it." 2942 ::= { nlMatrixTopNControlEntry 10 } 2944 nlMatrixTopNControlStatus OBJECT-TYPE 2945 SYNTAX RowStatus 2946 MAX-ACCESS read-create 2947 STATUS current 2948 DESCRIPTION 2949 "The status of this nlMatrixTopNControlEntry. 2951 An entry may not exist in the active state unless all 2952 objects in the entry have an appropriate value. 2954 If this object is not equal to active(1), all 2955 associated entries in the nlMatrixTopNTable shall be deleted 2956 by the agent." 2957 ::= { nlMatrixTopNControlEntry 11 } 2959 nlMatrixTopNTable OBJECT-TYPE 2960 SYNTAX SEQUENCE OF NlMatrixTopNEntry 2961 MAX-ACCESS not-accessible 2962 STATUS current 2963 DESCRIPTION 2964 "A set of statistics for those network layer matrix entries 2965 that have counted the highest number of octets or packets." 2966 ::= { nlMatrix 5 } 2968 nlMatrixTopNEntry OBJECT-TYPE 2969 SYNTAX NlMatrixTopNEntry 2970 MAX-ACCESS not-accessible 2971 STATUS current 2972 DESCRIPTION 2973 "A conceptual row in the nlMatrixTopNTable. 2975 The nlMatrixTopNControlIndex value in the index identifies the 2976 nlMatrixTopNControlEntry on whose behalf this entry was 2977 created. 2979 An example of the indexing of this table is 2980 nlMatrixTopNPktRate.3.10" 2981 INDEX { nlMatrixTopNControlIndex, nlMatrixTopNIndex } 2982 ::= { nlMatrixTopNTable 1 } 2984 NlMatrixTopNEntry ::= SEQUENCE { 2985 nlMatrixTopNIndex Integer32, 2986 nlMatrixTopNProtocolDirLocalIndex Integer32, 2987 nlMatrixTopNSourceAddress OCTET STRING, 2988 nlMatrixTopNDestAddress OCTET STRING, 2989 nlMatrixTopNPktRate Gauge32, 2990 nlMatrixTopNReversePktRate Gauge32, 2991 nlMatrixTopNOctetRate Gauge32, 2992 nlMatrixTopNReverseOctetRate Gauge32 2993 } 2995 nlMatrixTopNIndex OBJECT-TYPE 2996 SYNTAX Integer32 (1..65535) 2997 MAX-ACCESS not-accessible 2998 STATUS current 2999 DESCRIPTION 3000 "An index that uniquely identifies an entry in 3001 the nlMatrixTopNTable among those in the same report. 3002 This index is between 1 and N, where N is the 3003 number of entries in this report. 3005 If the value of nlMatrixTopNControlRateBase is equal to 3006 nlMatrixTopNPkts, increasing values of nlMatrixTopNIndex shall 3007 be assigned to entries with decreasing values of 3008 nlMatrixTopNPktRate until index N is assigned or there are no 3009 more nlMatrixTopNEntries. 3011 If the value of nlMatrixTopNControlRateBase is equal to 3012 nlMatrixTopNOctets, increasing values of nlMatrixTopNIndex 3013 shall be assigned to entries with decreasing values of 3014 nlMatrixTopNOctetRate until index N is assigned or there are 3015 no more nlMatrixTopNEntries." 3016 ::= { nlMatrixTopNEntry 1 } 3018 nlMatrixTopNProtocolDirLocalIndex OBJECT-TYPE 3019 SYNTAX Integer32 (1..2147483647) 3020 MAX-ACCESS read-only 3021 STATUS current 3022 DESCRIPTION 3023 "The protocolDirLocalIndex of the network layer protocol of 3024 this entry's network address." 3025 ::= { nlMatrixTopNEntry 2 } 3027 nlMatrixTopNSourceAddress OBJECT-TYPE 3028 SYNTAX OCTET STRING (SIZE (1..255)) 3029 MAX-ACCESS read-only 3030 STATUS current 3031 DESCRIPTION 3032 "The network layer address of the source host in this 3033 conversation. 3035 This is represented as an octet string with 3036 specific semantics and length as identified 3037 by the associated nlMatrixTopNProtocolDirLocalIndex. 3039 For example, if the protocolDirLocalIndex indicates an 3040 encapsulation of ip, this object is encoded as a length 3041 octet of 4, followed by the 4 octets of the ip address, 3042 in network byte order." 3043 ::= { nlMatrixTopNEntry 3 } 3045 nlMatrixTopNDestAddress OBJECT-TYPE 3046 SYNTAX OCTET STRING (SIZE (1..255)) 3047 MAX-ACCESS read-only 3048 STATUS current 3049 DESCRIPTION 3050 "The network layer address of the destination host in this 3051 conversation. 3053 This is represented as an octet string with 3054 specific semantics and length as identified 3055 by the associated nlMatrixTopNProtocolDirLocalIndex. 3057 For example, if the nlMatrixTopNProtocolDirLocalIndex 3058 indicates an encapsulation of ip, this object is encoded as a 3059 length octet of 4, followed by the 4 octets of the ip address, 3060 in network byte order." 3061 ::= { nlMatrixTopNEntry 4 } 3063 nlMatrixTopNPktRate OBJECT-TYPE 3064 SYNTAX Gauge32 3065 MAX-ACCESS read-only 3066 STATUS current 3067 DESCRIPTION 3068 "The number of packets seen from the source host 3069 to the destination host during this sampling interval, counted 3070 using the rules for counting the nlMatrixSDPkts object. 3071 If the value of nlMatrixTopNControlRateBase is 3072 nlMatrixTopNPkts, this variable will be used to sort this 3073 report." 3074 ::= { nlMatrixTopNEntry 5 } 3076 nlMatrixTopNReversePktRate OBJECT-TYPE 3077 SYNTAX Gauge32 3078 MAX-ACCESS read-only 3079 STATUS current 3080 DESCRIPTION 3081 "The number of packets seen from the destination host to the 3082 source host during this sampling interval, counted 3083 using the rules for counting the nlMatrixSDPkts object (note 3084 that the corresponding nlMatrixSDPkts object selected is the 3085 one whose source address is equal to nlMatrixTopNDestAddress 3086 and whose destination address is equal to 3087 nlMatrixTopNSourceAddress.) 3089 Note that if the value of nlMatrixTopNControlRateBase is equal 3090 to nlMatrixTopNPkts, the sort of topN entries is based 3091 entirely on nlMatrixTopNPktRate, and not on the value of this 3092 object." 3093 ::= { nlMatrixTopNEntry 6 } 3095 nlMatrixTopNOctetRate OBJECT-TYPE 3096 SYNTAX Gauge32 3097 MAX-ACCESS read-only 3098 STATUS current 3099 DESCRIPTION 3100 "The number of octets seen from the source host 3101 to the destination host during this sampling interval, counted 3102 using the rules for counting the nlMatrixSDOctets object. If 3103 the value of nlMatrixTopNControlRateBase is 3104 nlMatrixTopNOctets, this variable will be used to sort this 3105 report." 3106 ::= { nlMatrixTopNEntry 7 } 3108 nlMatrixTopNReverseOctetRate OBJECT-TYPE 3109 SYNTAX Gauge32 3110 MAX-ACCESS read-only 3111 STATUS current 3112 DESCRIPTION 3113 "The number of octets seen from the destination host to the 3114 source host during this sampling interval, counted 3115 using the rules for counting the nlMatrixDSOctets object (note 3116 that the corresponding nlMatrixSDOctets object selected is the 3117 one whose source address is equal to nlMatrixTopNDestAddress 3118 and whose destination address is equal to 3119 nlMatrixTopNSourceAddress.) 3121 Note that if the value of nlMatrixTopNControlRateBase is equal 3122 to nlMatrixTopNOctets, the sort of topN entries is based 3123 entirely on nlMatrixTopNOctetRate, and not on the value of 3124 this object." 3125 ::= { nlMatrixTopNEntry 8 } 3127 -- Application Layer Functions 3128 -- 3129 -- The application layer host, matrix, and matrixTopN functions report 3130 -- on protocol usage at the network layer or higher. Note that the 3131 -- use of the term application layer does not imply that only 3132 -- application-layer protocols are counted, rather it means that 3133 -- protocols up to and including the application layer are supported. 3135 -- 3136 -- Application Layer Host Group 3137 -- 3138 -- Counts the amount of traffic, by protocol, sent from and to each 3139 -- network address discovered by the probe. 3140 -- Implementation of this group requires implementation of the Network 3141 -- Layer Host Group. 3143 alHostTable OBJECT-TYPE 3144 SYNTAX SEQUENCE OF AlHostEntry 3145 MAX-ACCESS not-accessible 3146 STATUS current 3147 DESCRIPTION 3148 "A collection of statistics for a particular protocol from a 3149 particular network address that has been discovered on an 3150 interface of this device. 3152 The probe will populate this table for all protocols in the 3153 protocol directory table whose value of 3154 protocolDirHostConfig is equal to supportedOn(3), and 3155 will delete any entries whose protocolDirEntry is deleted or 3156 has a protocolDirHostConfig value of supportedOff(2). 3158 The probe will add to this table all addresses 3159 seen as the source or destination address in all packets with 3160 no MAC errors, and will increment octet and packet counts in 3161 the table for all packets with no MAC errors. Further, 3162 entries will only be added to this table if their address 3163 exists in the nlHostTable and will be deleted from this table 3164 if their address is deleted from the nlHostTable." 3165 ::= { alHost 1 } 3167 alHostEntry OBJECT-TYPE 3168 SYNTAX AlHostEntry 3169 MAX-ACCESS not-accessible 3170 STATUS current 3171 DESCRIPTION 3172 "A conceptual row in the alHostTable. 3174 The hlHostControlIndex value in the index identifies the 3175 hlHostControlEntry on whose behalf this entry was created. 3176 The first protocolDirLocalIndex value in the index identifies 3177 the network layer protocol of the address. 3178 The nlHostAddress value in the index identifies the network 3179 layer address of this entry. 3180 The second protocolDirLocalIndex value in the index identifies 3181 the protocol that is counted by this entry. 3183 An example of the indexing in this entry is 3184 alHostOutPkts.1.783495.18.4.128.2.6.6.34. 3186 Note that some combinations of index values may result in an 3187 index that exceeds 128 sub-identifiers in length which exceeds 3188 the maximum for the SNMP protocol. Implementations should take 3189 care to avoid such combinations." 3190 INDEX { hlHostControlIndex, alHostTimeMark, 3191 protocolDirLocalIndex, nlHostAddress, 3192 protocolDirLocalIndex } 3193 ::= { alHostTable 1 } 3195 AlHostEntry ::= SEQUENCE { 3196 alHostTimeMark TimeFilter, 3197 alHostInPkts ZeroBasedCounter32, 3198 alHostOutPkts ZeroBasedCounter32, 3199 alHostInOctets ZeroBasedCounter32, 3200 alHostOutOctets ZeroBasedCounter32, 3201 alHostCreateTime LastCreateTime 3202 } 3204 alHostTimeMark OBJECT-TYPE 3205 SYNTAX TimeFilter 3206 MAX-ACCESS not-accessible 3207 STATUS current 3208 DESCRIPTION 3209 "A TimeFilter for this entry. See the TimeFilter textual 3210 convention to see how this works." 3211 ::= { alHostEntry 1 } 3213 alHostInPkts OBJECT-TYPE 3214 SYNTAX ZeroBasedCounter32 3215 MAX-ACCESS read-only 3216 STATUS current 3217 DESCRIPTION 3218 "The number of packets of this protocol type without errors 3219 transmitted to this address since it was added to the 3220 alHostTable. Note that this is the number of link-layer 3221 packets, so if a single network-layer packet is fragmented 3222 into several link-layer frames, this counter is incremented 3223 several times." 3224 ::= { alHostEntry 2 } 3226 alHostOutPkts OBJECT-TYPE 3227 SYNTAX ZeroBasedCounter32 3228 MAX-ACCESS read-only 3229 STATUS current 3230 DESCRIPTION 3231 "The number of packets of this protocol type without errors 3232 transmitted by this address since it was added to the 3233 alHostTable. Note that this is the number of link-layer 3234 packets, so if a single network-layer packet is fragmented 3235 into several link-layer frames, this counter is incremented 3236 several times." 3237 ::= { alHostEntry 3 } 3239 alHostInOctets OBJECT-TYPE 3240 SYNTAX ZeroBasedCounter32 3241 MAX-ACCESS read-only 3242 STATUS current 3243 DESCRIPTION 3244 "The number of octets transmitted to this address 3245 of this protocol type since it was added to the 3246 alHostTable (excluding framing bits but including 3247 FCS octets), excluding those octets in packets that 3248 contained errors. 3250 Note this doesn't count just those octets in the particular 3251 protocol frames, but includes the entire packet that contained 3252 the protocol." 3253 ::= { alHostEntry 4 } 3255 alHostOutOctets OBJECT-TYPE 3256 SYNTAX ZeroBasedCounter32 3257 MAX-ACCESS read-only 3258 STATUS current 3259 DESCRIPTION 3260 "The number of octets transmitted by this address 3261 of this protocol type since it was added to the 3262 alHostTable (excluding framing bits but including 3263 FCS octets), excluding those octets in packets that 3264 contained errors. 3266 Note this doesn't count just those octets in the particular 3267 protocol frames, but includes the entire packet that contained 3268 the protocol." 3269 ::= { alHostEntry 5 } 3271 alHostCreateTime OBJECT-TYPE 3272 SYNTAX LastCreateTime 3273 MAX-ACCESS read-only 3274 STATUS current 3275 DESCRIPTION 3276 "The value of sysUpTime when this entry was last activated. 3277 This can be used by the management station to ensure that the 3278 entry has not been deleted and recreated between polls." 3279 ::= { alHostEntry 6 } 3281 -- 3282 -- Application Layer Matrix Group 3283 -- 3284 -- Counts the amount of traffic, by protocol, sent between each pair 3285 -- of network addresses discovered by the probe. 3286 -- Implementation of this group requires implementation of the Network 3287 -- Layer Matrix Group. 3289 alMatrixSDTable OBJECT-TYPE 3290 SYNTAX SEQUENCE OF AlMatrixSDEntry 3291 MAX-ACCESS not-accessible 3292 STATUS current 3293 DESCRIPTION 3294 "A list of application traffic matrix entries which collect 3295 statistics for conversations of a particular protocol between 3296 two network-level addresses. This table is indexed first by 3297 the source address and then by the destination address to make 3298 it convenient to collect all statistics from a particular 3299 address. 3301 The probe will populate this table for all protocols in the 3302 protocol directory table whose value of 3303 protocolDirMatrixConfig is equal to supportedOn(3), and 3304 will delete any entries whose protocolDirEntry is deleted or 3305 has a protocolDirMatrixConfig value of supportedOff(2). 3307 The probe will add to this table all pairs of addresses for 3308 all protocols seen in all packets with no MAC errors, and will 3309 increment octet and packet counts in the table for all packets 3310 with no MAC errors. Further, entries will only be added to 3311 this table if their address pair exists in the nlMatrixSDTable 3312 and will be deleted from this table if the address pair is 3313 deleted from the nlMatrixSDTable." 3314 ::= { alMatrix 1 } 3316 alMatrixSDEntry OBJECT-TYPE 3317 SYNTAX AlMatrixSDEntry 3318 MAX-ACCESS not-accessible 3319 STATUS current 3320 DESCRIPTION 3321 "A conceptual row in the alMatrixSDTable. 3323 The hlMatrixControlIndex value in the index identifies the 3324 hlMatrixControlEntry on whose behalf this entry was created. 3325 The first protocolDirLocalIndex value in the index identifies 3326 the network layer protocol of the nlMatrixSDSourceAddress and 3327 nlMatrixSDDestAddress. 3328 The nlMatrixSDSourceAddress value in the index identifies the 3329 network layer address of the source host in this conversation. 3330 The nlMatrixSDDestAddress value in the index identifies the 3331 network layer address of the destination host in this 3332 conversation. 3333 The second protocolDirLocalIndex value in the index identifies 3334 the protocol that is counted by this entry. 3336 An example of the indexing of this entry is 3337 alMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7.34. 3339 Note that some combinations of index values may result in an 3340 index that exceeds 128 sub-identifiers in length which exceeds 3341 the maximum for the SNMP protocol. Implementations should take 3342 care to avoid such combinations." 3343 INDEX { hlMatrixControlIndex, alMatrixSDTimeMark, 3344 protocolDirLocalIndex, 3345 nlMatrixSDSourceAddress, nlMatrixSDDestAddress, 3346 protocolDirLocalIndex } 3347 ::= { alMatrixSDTable 1 } 3349 AlMatrixSDEntry ::= SEQUENCE { 3350 alMatrixSDTimeMark TimeFilter, 3351 alMatrixSDPkts ZeroBasedCounter32, 3352 alMatrixSDOctets ZeroBasedCounter32, 3353 alMatrixSDCreateTime LastCreateTime 3354 } 3356 alMatrixSDTimeMark OBJECT-TYPE 3357 SYNTAX TimeFilter 3358 MAX-ACCESS not-accessible 3359 STATUS current 3360 DESCRIPTION 3361 "A TimeFilter for this entry. See the TimeFilter textual 3362 convention to see how this works." 3363 ::= { alMatrixSDEntry 1 } 3365 alMatrixSDPkts OBJECT-TYPE 3366 SYNTAX ZeroBasedCounter32 3367 MAX-ACCESS read-only 3368 STATUS current 3369 DESCRIPTION 3370 "The number of packets of this protocol type without errors 3371 transmitted from the source address to the destination address 3372 since this entry was added to the alMatrixSDTable. Note that 3373 this is the number of link-layer packets, so if a single 3374 network-layer packet is fragmented into several link-layer 3375 frames, this counter is incremented several times." 3376 ::= { alMatrixSDEntry 2 } 3378 alMatrixSDOctets OBJECT-TYPE 3379 SYNTAX ZeroBasedCounter32 3380 MAX-ACCESS read-only 3381 STATUS current 3382 DESCRIPTION 3383 "The number of octets in packets of this protocol type 3384 transmitted from the source address to the destination address 3385 since this entry was added to the alMatrixSDTable (excluding 3386 framing bits but including FCS octets), excluding those octets 3387 in packets that contained errors. 3389 Note this doesn't count just those octets in the particular 3390 protocol frames, but includes the entire packet that contained 3391 the protocol." 3392 ::= { alMatrixSDEntry 3 } 3394 alMatrixSDCreateTime OBJECT-TYPE 3395 SYNTAX LastCreateTime 3396 MAX-ACCESS read-only 3397 STATUS current 3398 DESCRIPTION 3399 "The value of sysUpTime when this entry was last activated. 3400 This can be used by the management station to ensure that the 3401 entry has not been deleted and recreated between polls." 3402 ::= { alMatrixSDEntry 4 } 3404 -- Traffic matrix tables from destination to source 3406 alMatrixDSTable OBJECT-TYPE 3407 SYNTAX SEQUENCE OF AlMatrixDSEntry 3408 MAX-ACCESS not-accessible 3409 STATUS current 3410 DESCRIPTION 3411 "A list of application traffic matrix entries which collect 3412 statistics for conversations of a particular protocol between 3413 two network-level addresses. This table is indexed first by 3414 the destination address and then by the source address to make 3415 it convenient to collect all statistics to a particular 3416 address. 3418 The probe will populate this table for all protocols in the 3419 protocol directory table whose value of 3420 protocolDirMatrixConfig is equal to supportedOn(3), and 3421 will delete any entries whose protocolDirEntry is deleted or 3422 has a protocolDirMatrixConfig value of supportedOff(2). 3424 The probe will add to this table all pairs of addresses for 3425 all protocols seen in all packets with no MAC errors, and will 3426 increment octet and packet counts in the table for all packets 3427 with no MAC errors. Further, entries will only be added to 3428 this table if their address pair exists in the nlMatrixDSTable 3429 and will be deleted from this table if the address pair is 3430 deleted from the nlMatrixDSTable." 3431 ::= { alMatrix 2 } 3433 alMatrixDSEntry OBJECT-TYPE 3434 SYNTAX AlMatrixDSEntry 3435 MAX-ACCESS not-accessible 3436 STATUS current 3437 DESCRIPTION 3438 "A conceptual row in the alMatrixDSTable. 3440 The hlMatrixControlIndex value in the index identifies the 3441 hlMatrixControlEntry on whose behalf this entry was created. 3442 The first protocolDirLocalIndex value in the index identifies 3443 the network layer protocol of the alMatrixDSSourceAddress and 3444 alMatrixDSDestAddress. 3445 The nlMatrixDSDestAddress value in the index identifies the 3446 network layer address of the destination host in this 3447 conversation. 3448 The nlMatrixDSSourceAddress value in the index identifies the 3449 network layer address of the source host in this conversation. 3450 The second protocolDirLocalIndex value in the index identifies 3451 the protocol that is counted by this entry. 3453 An example of the indexing of this entry is 3454 alMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6.34. 3456 Note that some combinations of index values may result in an 3457 index that exceeds 128 sub-identifiers in length which exceeds 3458 the maximum for the SNMP protocol. Implementations should take 3459 care to avoid such combinations." 3460 INDEX { hlMatrixControlIndex, alMatrixDSTimeMark, 3461 protocolDirLocalIndex, 3462 nlMatrixDSDestAddress, nlMatrixDSSourceAddress, 3463 protocolDirLocalIndex } 3464 ::= { alMatrixDSTable 1 } 3466 AlMatrixDSEntry ::= SEQUENCE { 3467 alMatrixDSTimeMark TimeFilter, 3468 alMatrixDSPkts ZeroBasedCounter32, 3469 alMatrixDSOctets ZeroBasedCounter32, 3470 alMatrixDSCreateTime LastCreateTime 3471 } 3473 alMatrixDSTimeMark OBJECT-TYPE 3474 SYNTAX TimeFilter 3475 MAX-ACCESS not-accessible 3476 STATUS current 3477 DESCRIPTION 3478 "A TimeFilter for this entry. See the TimeFilter textual 3479 convention to see how this works." 3480 ::= { alMatrixDSEntry 1 } 3482 alMatrixDSPkts OBJECT-TYPE 3483 SYNTAX ZeroBasedCounter32 3484 MAX-ACCESS read-only 3485 STATUS current 3486 DESCRIPTION 3487 "The number of packets of this protocol type without errors 3488 transmitted from the source address to the destination address 3489 since this entry was added to the alMatrixDSTable. Note that 3490 this is the number of link-layer packets, so if a single 3491 network-layer packet is fragmented into several link-layer 3492 frames, this counter is incremented several times." 3493 ::= { alMatrixDSEntry 2 } 3495 alMatrixDSOctets OBJECT-TYPE 3496 SYNTAX ZeroBasedCounter32 3497 MAX-ACCESS read-only 3498 STATUS current 3499 DESCRIPTION 3500 "The number of octets in packets of this protocol type 3501 transmitted from the source address to the destination address 3502 since this entry was added to the alMatrixDSTable (excluding 3503 framing bits but including FCS octets), excluding those octets 3504 in packets that contained errors. 3506 Note this doesn't count just those octets in the particular 3507 protocol frames, but includes the entire packet that contained 3508 the protocol." 3509 ::= { alMatrixDSEntry 3 } 3511 alMatrixDSCreateTime OBJECT-TYPE 3512 SYNTAX LastCreateTime 3513 MAX-ACCESS read-only 3514 STATUS current 3515 DESCRIPTION 3516 "The value of sysUpTime when this entry was last activated. 3517 This can be used by the management station to ensure that the 3518 entry has not been deleted and recreated between polls." 3519 ::= { alMatrixDSEntry 4 } 3521 alMatrixTopNControlTable OBJECT-TYPE 3522 SYNTAX SEQUENCE OF AlMatrixTopNControlEntry 3523 MAX-ACCESS not-accessible 3524 STATUS current 3525 DESCRIPTION 3526 "A set of parameters that control the creation of a 3527 report of the top N matrix entries according to 3528 a selected metric." 3529 ::= { alMatrix 3 } 3531 alMatrixTopNControlEntry OBJECT-TYPE 3532 SYNTAX AlMatrixTopNControlEntry 3533 MAX-ACCESS not-accessible 3534 STATUS current 3535 DESCRIPTION 3536 "A conceptual row in the alMatrixTopNControlTable. 3538 An example of the indexing of this table is 3539 alMatrixTopNControlDuration.3" 3540 INDEX { alMatrixTopNControlIndex } 3541 ::= { alMatrixTopNControlTable 1 } 3543 AlMatrixTopNControlEntry ::= SEQUENCE { 3544 alMatrixTopNControlIndex Integer32, 3545 alMatrixTopNControlMatrixIndex Integer32, 3546 alMatrixTopNControlRateBase INTEGER, 3547 alMatrixTopNControlTimeRemaining Integer32, 3548 alMatrixTopNControlGeneratedReports Counter32, 3549 alMatrixTopNControlDuration Integer32, 3550 alMatrixTopNControlRequestedSize Integer32, 3551 alMatrixTopNControlGrantedSize Integer32, 3552 alMatrixTopNControlStartTime TimeStamp, 3553 alMatrixTopNControlOwner OwnerString, 3554 alMatrixTopNControlStatus RowStatus 3555 } 3557 alMatrixTopNControlIndex OBJECT-TYPE 3558 SYNTAX Integer32 (1..65535) 3559 MAX-ACCESS not-accessible 3560 STATUS current 3561 DESCRIPTION 3562 "An index that uniquely identifies an entry 3563 in the alMatrixTopNControlTable. Each such 3564 entry defines one top N report prepared for 3565 one interface." 3566 ::= { alMatrixTopNControlEntry 1 } 3568 alMatrixTopNControlMatrixIndex OBJECT-TYPE 3569 SYNTAX Integer32 (1..65535) 3570 MAX-ACCESS read-create 3571 STATUS current 3572 DESCRIPTION 3573 "The alMatrix[SD/DS] table for which a top N report will be 3574 prepared on behalf of this entry. The alMatrix[SD/DS] table 3575 is identified by the value of the hlMatrixControlIndex 3576 for that table - that value is used here to identify the 3577 particular table. 3579 This object may not be modified if the associated 3580 alMatrixTopNControlStatus object is equal to active(1)." 3581 ::= { alMatrixTopNControlEntry 2 } 3583 alMatrixTopNControlRateBase OBJECT-TYPE 3584 SYNTAX INTEGER { 3585 alMatrixTopNTerminalsPkts(1), 3586 alMatrixTopNTerminalsOctets(2), 3587 alMatrixTopNAllPkts(3), 3588 alMatrixTopNAllOctets(4), 3589 alMatrixTopNTerminalsHighCapacityPkts(5), 3590 alMatrixTopNTerminalsHighCapacityOctets(6), 3591 alMatrixTopNAllHighCapacityPkts(7), 3592 alMatrixTopNAllHighCapacityOctets(8) 3593 } 3594 MAX-ACCESS read-create 3595 STATUS current 3596 DESCRIPTION 3597 "The variable for each alMatrix[SD/DS] entry that the 3598 alMatrixTopNEntries are sorted by, as well as the 3599 selector of the view of the matrix table that will be 3600 used, as well as a control for the table that the results 3601 will be reported in. 3603 The values alMatrixTopNTerminalsPkts, 3604 alMatrixTopNTerminalsOctets, 3605 alMatrixTopNTerminalsHighCapacityPkts, and 3606 alMatrixTopNTerminalsHighCapacityOctets cause collection 3607 only from protocols that have no child protocols that are 3608 counted. The values alMatrixTopNAllPkts, 3609 alMatrixTopNAllOctets, alMatrixTopNAllHighCapacityPkts, and 3610 alMatrixTopNAllHighCapacityOctets cause collection from all 3611 alMatrix entries. 3613 This object may not be modified if the associated 3614 alMatrixTopNControlStatus object is equal to active(1)." 3615 ::= { alMatrixTopNControlEntry 3 } 3617 alMatrixTopNControlTimeRemaining OBJECT-TYPE 3618 SYNTAX Integer32 (0..2147483647) 3619 MAX-ACCESS read-create 3620 STATUS current 3621 DESCRIPTION 3622 "The number of seconds left in the report currently 3623 being collected. When this object is modified by 3624 the management station, a new collection is started, 3625 possibly aborting a currently running report. The 3626 new value is used as the requested duration of this 3627 report, and is immediately loaded into the associated 3628 alMatrixTopNControlDuration object. 3629 When the report finishes, the probe will automatically 3630 start another collection with the same initial value 3631 of alMatrixTopNControlTimeRemaining. Thus the management 3632 station may simply read the resulting reports repeatedly, 3633 checking the startTime and duration each time to ensure that a 3634 report was not missed or that the report parameters were not 3635 changed. 3637 While the value of this object is non-zero, it decrements 3638 by one per second until it reaches zero. At the time 3639 that this object decrements to zero, the report is made 3640 accessible in the alMatrixTopNTable, overwriting any report 3641 that may be there. 3643 When this object is modified by the management station, any 3644 associated entries in the alMatrixTopNTable shall be deleted. 3646 (Note that this is a different algorithm than the one used in 3647 the hostTopNTable)." 3648 DEFVAL { 1800 } 3649 ::= { alMatrixTopNControlEntry 4 } 3651 alMatrixTopNControlGeneratedReports OBJECT-TYPE 3652 SYNTAX Counter32 3653 MAX-ACCESS read-only 3654 STATUS current 3655 DESCRIPTION 3656 "The number of reports that have been generated by this entry." 3657 ::= { alMatrixTopNControlEntry 5 } 3659 alMatrixTopNControlDuration OBJECT-TYPE 3660 SYNTAX Integer32 3661 MAX-ACCESS read-only 3662 STATUS current 3663 DESCRIPTION 3664 "The number of seconds that this report has collected 3665 during the last sampling interval. 3667 When the associated alMatrixTopNControlTimeRemaining object 3668 is set, this object shall be set by the probe to the 3669 same value and shall not be modified until the next 3670 time the alMatrixTopNControlTimeRemaining is set. 3672 This value shall be zero if no reports have been 3673 requested for this alMatrixTopNControlEntry." 3674 ::= { alMatrixTopNControlEntry 6 } 3676 alMatrixTopNControlRequestedSize OBJECT-TYPE 3677 SYNTAX Integer32 (0..2147483647) 3678 MAX-ACCESS read-create 3679 STATUS current 3680 DESCRIPTION 3681 "The maximum number of matrix entries requested for this report. 3683 When this object is created or modified, the probe 3684 should set alMatrixTopNControlGrantedSize as closely to this 3685 object as is possible for the particular probe 3686 implementation and available resources." 3687 DEFVAL { 150 } 3688 ::= { alMatrixTopNControlEntry 7 } 3690 alMatrixTopNControlGrantedSize OBJECT-TYPE 3691 SYNTAX Integer32 (0..2147483647) 3692 MAX-ACCESS read-only 3693 STATUS current 3694 DESCRIPTION 3695 "The maximum number of matrix entries in this report. 3697 When the associated alMatrixTopNControlRequestedSize object 3698 is created or modified, the probe should set this 3699 object as closely to the requested value as is 3700 possible for the particular implementation and 3701 available resources. The probe must not lower this 3702 value except as a result of a set to the associated 3703 alMatrixTopNControlRequestedSize object. 3705 If the value of alMatrixTopNControlRateBase is equal to 3706 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, when the 3707 next topN report is generated, matrix entries with the highest 3708 value of alMatrixTopNPktRate shall be placed in this table in 3709 decreasing order of this rate until there is no more room or 3710 until there are no more matrix entries. 3712 If the value of alMatrixTopNControlRateBase is equal to 3713 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, when the 3714 next topN report is generated, matrix entries with the highest 3715 value of alMatrixTopNOctetRate shall be placed in this table 3716 in decreasing order of this rate until there is no more room 3717 or until there are no more matrix entries. 3719 It is an implementation-specific matter how entries with the 3720 same value of alMatrixTopNPktRate or alMatrixTopNOctetRate are 3721 sorted. It is also an implementation-specific matter as to 3722 whether or not zero-valued entries are available." 3723 ::= { alMatrixTopNControlEntry 8 } 3725 alMatrixTopNControlStartTime OBJECT-TYPE 3726 SYNTAX TimeStamp 3727 MAX-ACCESS read-only 3728 STATUS current 3729 DESCRIPTION 3730 "The value of sysUpTime when this top N report was 3731 last started. In other words, this is the time that 3732 the associated alMatrixTopNControlTimeRemaining object 3733 was modified to start the requested report or the time 3734 the report was last automatically (re)started. 3736 This object may be used by the management station to 3737 determine if a report was missed or not." 3738 ::= { alMatrixTopNControlEntry 9 } 3740 alMatrixTopNControlOwner OBJECT-TYPE 3741 SYNTAX OwnerString 3742 MAX-ACCESS read-create 3743 STATUS current 3744 DESCRIPTION 3745 "The entity that configured this entry and is 3746 therefore using the resources assigned to it." 3747 ::= { alMatrixTopNControlEntry 10 } 3749 alMatrixTopNControlStatus OBJECT-TYPE 3750 SYNTAX RowStatus 3751 MAX-ACCESS read-create 3752 STATUS current 3753 DESCRIPTION 3754 "The status of this alMatrixTopNControlEntry. 3756 An entry may not exist in the active state unless all 3757 objects in the entry have an appropriate value. 3759 If this object is not equal to active(1), all 3760 associated entries in the alMatrixTopNTable shall be 3761 deleted by the agent." 3762 ::= { alMatrixTopNControlEntry 11 } 3764 alMatrixTopNTable OBJECT-TYPE 3765 SYNTAX SEQUENCE OF AlMatrixTopNEntry 3766 MAX-ACCESS not-accessible 3767 STATUS current 3768 DESCRIPTION 3769 "A set of statistics for those application layer matrix 3770 entries that have counted the highest number of octets or 3771 packets." 3772 ::= { alMatrix 4 } 3774 alMatrixTopNEntry OBJECT-TYPE 3775 SYNTAX AlMatrixTopNEntry 3776 MAX-ACCESS not-accessible 3777 STATUS current 3778 DESCRIPTION 3779 "A conceptual row in the alMatrixTopNTable. 3781 The alMatrixTopNControlIndex value in the index identifies 3782 the alMatrixTopNControlEntry on whose behalf this entry was 3783 created. 3785 An example of the indexing of this table is 3786 alMatrixTopNPktRate.3.10" 3787 INDEX { alMatrixTopNControlIndex, alMatrixTopNIndex } 3788 ::= { alMatrixTopNTable 1 } 3790 AlMatrixTopNEntry ::= SEQUENCE { 3791 alMatrixTopNIndex Integer32, 3792 alMatrixTopNProtocolDirLocalIndex Integer32, 3793 alMatrixTopNSourceAddress OCTET STRING, 3794 alMatrixTopNDestAddress OCTET STRING, 3795 alMatrixTopNAppProtocolDirLocalIndex Integer32, 3796 alMatrixTopNPktRate Gauge32, 3797 alMatrixTopNReversePktRate Gauge32, 3798 alMatrixTopNOctetRate Gauge32, 3799 alMatrixTopNReverseOctetRate Gauge32 3800 } 3802 alMatrixTopNIndex OBJECT-TYPE 3803 SYNTAX Integer32 (1..65535) 3804 MAX-ACCESS not-accessible 3805 STATUS current 3806 DESCRIPTION 3807 "An index that uniquely identifies an entry in 3808 the alMatrixTopNTable among those in the same report. 3809 This index is between 1 and N, where N is the 3810 number of entries in this report. 3812 If the value of alMatrixTopNControlRateBase is equal to 3813 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, increasing 3814 values of alMatrixTopNIndex shall be assigned to entries with 3815 decreasing values of alMatrixTopNPktRate until index N is 3816 assigned or there are no more alMatrixTopNEntries. 3818 If the value of alMatrixTopNControlRateBase is equal to 3819 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, 3820 increasing values of alMatrixTopNIndex shall be assigned to 3821 entries with decreasing values of alMatrixTopNOctetRate until 3822 index N is assigned or there are no more alMatrixTopNEntries." 3823 ::= { alMatrixTopNEntry 1 } 3825 alMatrixTopNProtocolDirLocalIndex OBJECT-TYPE 3826 SYNTAX Integer32 (1..2147483647) 3827 MAX-ACCESS read-only 3828 STATUS current 3829 DESCRIPTION 3830 "The protocolDirLocalIndex of the network layer protocol of 3831 this entry's network address." 3832 ::= { alMatrixTopNEntry 2 } 3834 alMatrixTopNSourceAddress OBJECT-TYPE 3835 SYNTAX OCTET STRING (SIZE (1..255)) 3836 MAX-ACCESS read-only 3837 STATUS current 3838 DESCRIPTION 3839 "The network layer address of the source host in this 3840 conversation. 3842 This is represented as an octet string with 3843 specific semantics and length as identified 3844 by the associated alMatrixTopNProtocolDirLocalIndex. 3846 For example, if the alMatrixTopNProtocolDirLocalIndex 3847 indicates an encapsulation of ip, this object is encoded as a 3848 length octet of 4, followed by the 4 octets of the ip address, 3849 in network byte order." 3850 ::= { alMatrixTopNEntry 3 } 3852 alMatrixTopNDestAddress OBJECT-TYPE 3853 SYNTAX OCTET STRING (SIZE (1..255)) 3854 MAX-ACCESS read-only 3855 STATUS current 3856 DESCRIPTION 3857 "The network layer address of the destination host in this 3858 conversation. 3860 This is represented as an octet string with 3861 specific semantics and length as identified 3862 by the associated alMatrixTopNProtocolDirLocalIndex. 3864 For example, if the alMatrixTopNProtocolDirLocalIndex 3865 indicates an encapsulation of ip, this object is encoded as a 3866 length octet of 4, followed by the 4 octets of the ip address, 3867 in network byte order." 3868 ::= { alMatrixTopNEntry 4 } 3870 alMatrixTopNAppProtocolDirLocalIndex OBJECT-TYPE 3871 SYNTAX Integer32 (1..2147483647) 3872 MAX-ACCESS read-only 3873 STATUS current 3874 DESCRIPTION 3875 "The type of the protocol counted by this matrix entry." 3876 ::= { alMatrixTopNEntry 5 } 3878 alMatrixTopNPktRate OBJECT-TYPE 3879 SYNTAX Gauge32 3880 MAX-ACCESS read-only 3881 STATUS current 3882 DESCRIPTION 3883 "The number of packets seen of this protocol from the source 3884 host to the destination host during this sampling interval, 3885 counted using the rules for counting the alMatrixSDPkts 3886 object. 3888 If the value of alMatrixTopNControlRateBase is 3889 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, this 3890 variable will be used to sort this report." 3891 ::= { alMatrixTopNEntry 6 } 3893 alMatrixTopNReversePktRate OBJECT-TYPE 3894 SYNTAX Gauge32 3895 MAX-ACCESS read-only 3896 STATUS current 3897 DESCRIPTION 3898 "The number of packets seen of this protocol from the 3899 destination host to the source host during this sampling 3900 interval, counted using the rules for counting the 3901 alMatrixDSPkts object (note that the corresponding 3902 alMatrixSDPkts object selected is the one whose source address 3903 is equal to alMatrixTopNDestAddress and whose destination 3904 address is equal to alMatrixTopNSourceAddress.) 3906 Note that if the value of alMatrixTopNControlRateBase is equal 3907 to alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, the sort 3908 of topN entries is based entirely on alMatrixTopNPktRate, and 3909 not on the value of this object." 3910 ::= { alMatrixTopNEntry 7 } 3912 alMatrixTopNOctetRate OBJECT-TYPE 3913 SYNTAX Gauge32 3914 MAX-ACCESS read-only 3915 STATUS current 3916 DESCRIPTION 3917 "The number of octets seen of this protocol from the source 3918 host to the destination host during this sampling interval, 3919 counted using the rules for counting the alMatrixSDOctets 3920 object. 3922 If the value of alMatrixTopNControlRateBase is 3923 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, this 3924 variable will be used to sort this report." 3925 ::= { alMatrixTopNEntry 8 } 3927 alMatrixTopNReverseOctetRate OBJECT-TYPE 3928 SYNTAX Gauge32 3929 MAX-ACCESS read-only 3930 STATUS current 3931 DESCRIPTION 3932 "The number of octets seen of this protocol from the 3933 destination host to the source host during this sampling 3934 interval, counted using the rules for counting the 3935 alMatrixDSOctets object (note that the corresponding 3936 alMatrixSDOctets object selected is the one whose source 3937 address is equal to alMatrixTopNDestAddress and whose 3938 destination address is equal to alMatrixTopNSourceAddress.) 3940 Note that if the value of alMatrixTopNControlRateBase is equal 3941 to alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, the 3942 sort of topN entries is based entirely on 3943 alMatrixTopNOctetRate, and not on the value of this object." 3944 ::= { alMatrixTopNEntry 9 } 3946 -- 3947 -- User History Collection Group (usrHistory) 3948 -- 3949 -- The usrHistory group combines mechanisms seen in the alarm and 3950 -- history groups to provide user-specified history collection, 3951 -- utilizing two additional control tables and one additional data 3952 -- table. This function has traditionally been done by NMS 3953 -- applications, via periodic polling. The usrHistory group allows 3954 -- this task to be offloaded to an RMON probe. 3955 -- 3956 -- Data (an ASN.1 INTEGER based object) is collected in the same 3957 -- manner as any history data table (e.g. etherHistoryTable) except 3958 -- that the user specifies the MIB instances to be collected. Objects 3959 -- are collected in bucket-groups, with the intent that all MIB 3960 -- instances in the same bucket-group are collected as atomically as 3961 -- possible by the RMON probe. 3962 -- 3963 -- The usrHistoryControlTable is a one-dimensional read-create table. 3964 -- Each row configures a collection of user history buckets, much 3965 -- the same as a historyControlEntry, except that the creation of a 3966 -- row in this table will cause one or more associated instances in 3967 -- the usrHistoryObjectTable to be created. The user specifies the 3968 -- number of bucket elements (rows in the usrHistoryObjectTable) 3969 -- requested, as well as the number of buckets requested. 3970 -- 3971 -- The usrHistoryObjectTable is a 2-d read-write table. 3972 -- Each row configures a single MIB instance to be collected. 3973 -- All rows with the same major index constitute a bucket-group. 3974 -- 3975 -- The usrHistoryTable is a 3-d read-only table containing 3976 -- the data of associated usrHistoryControlEntries. Each 3977 -- entry represents the value of a single MIB instance 3978 -- during a specific sampling interval (or the rate of 3979 -- change during the interval). 3980 -- 3981 -- A sample value is stored in two objects - an absolute value and 3982 -- a status object. This allows numbers from -(2G-1) to +4G to be 3983 -- stored. The status object also indicates whether a sample is 3984 -- valid. This allows data collection to continue if periodic 3985 -- retrieval of a particular instance fails for any reason. 3986 -- 3987 -- Row Creation Order Relationships 3988 -- 3989 -- The static nature of the usrHistoryObjectTable creates 3990 -- some row creation/modification issues. The rows in this 3991 -- table need to be set before the associated 3992 -- usrHistoryControlEntry can be activated. 3993 -- 3994 -- Note that the usrHistoryObject entries associated with a 3995 -- particular usrHistoryControlEntry are not required to 3996 -- be active before the control entry is activated. However, 3997 -- the usrHistory data entries associated with an inactive 3998 -- usrHistoryObject entry will be inactive (i.e. 3999 -- usrHistoryValStatus == valueNotAvailable). 4000 -- 4001 usrHistoryControlTable OBJECT-TYPE 4002 SYNTAX SEQUENCE OF UsrHistoryControlEntry 4003 MAX-ACCESS not-accessible 4004 STATUS current 4005 DESCRIPTION 4006 "A list of data-collection configuration entries." 4007 ::= { usrHistory 1 } 4009 usrHistoryControlEntry OBJECT-TYPE 4010 SYNTAX UsrHistoryControlEntry 4011 MAX-ACCESS not-accessible 4012 STATUS current 4013 DESCRIPTION 4014 "A list of parameters that set up a group of user-defined 4015 MIB objects to be sampled periodically (called a 4016 bucket-group). 4018 For example, an instance of usrHistoryControlInterval 4019 might be named usrHistoryControlInterval.1" 4020 INDEX { usrHistoryControlIndex } 4021 ::= { usrHistoryControlTable 1 } 4023 UsrHistoryControlEntry ::= SEQUENCE { 4024 usrHistoryControlIndex Integer32, 4025 usrHistoryControlObjects Integer32, 4026 usrHistoryControlBucketsRequested Integer32, 4027 usrHistoryControlBucketsGranted Integer32, 4028 usrHistoryControlInterval Integer32, 4029 usrHistoryControlOwner OwnerString, 4030 usrHistoryControlStatus RowStatus 4031 } 4033 usrHistoryControlIndex OBJECT-TYPE 4034 SYNTAX Integer32 (1..65535) 4035 MAX-ACCESS not-accessible 4036 STATUS current 4037 DESCRIPTION 4038 "An index that uniquely identifies an entry in the 4039 usrHistoryControlTable. Each such entry defines a 4040 set of samples at a particular interval for a specified 4041 set of MIB instances available from the managed system." 4042 ::= { usrHistoryControlEntry 1 } 4044 usrHistoryControlObjects OBJECT-TYPE 4045 SYNTAX Integer32 (1..65535) 4046 MAX-ACCESS read-create 4047 STATUS current 4048 DESCRIPTION 4049 "The number of MIB objects to be collected 4050 in the portion of usrHistoryTable associated with this 4051 usrHistoryControlEntry. 4053 This object may not be modified if the associated instance 4054 of usrHistoryControlStatus is equal to active(1)." 4055 ::= { usrHistoryControlEntry 2 } 4057 usrHistoryControlBucketsRequested OBJECT-TYPE 4058 SYNTAX Integer32 (1..65535) 4059 MAX-ACCESS read-create 4060 STATUS current 4061 DESCRIPTION 4062 "The requested number of discrete time intervals 4063 over which data is to be saved in the part of the 4064 usrHistoryTable associated with this usrHistoryControlEntry. 4066 When this object is created or modified, the probe 4067 should set usrHistoryControlBucketsGranted as closely to 4068 this object as is possible for the particular probe 4069 implementation and available resources." 4070 DEFVAL { 50 } 4071 ::= { usrHistoryControlEntry 3 } 4073 usrHistoryControlBucketsGranted OBJECT-TYPE 4074 SYNTAX Integer32 (1..65535) 4075 MAX-ACCESS read-only 4076 STATUS current 4077 DESCRIPTION 4078 "The number of discrete sampling intervals 4079 over which data shall be saved in the part of 4080 the usrHistoryTable associated with this 4081 usrHistoryControlEntry. 4083 When the associated usrHistoryControlBucketsRequested 4084 object is created or modified, the probe should set 4085 this object as closely to the requested value as is 4086 possible for the particular probe implementation and 4087 available resources. The probe must not lower this 4088 value except as a result of a modification to the associated 4089 usrHistoryControlBucketsRequested object. 4091 The associated usrHistoryControlBucketsRequested object 4092 should be set before or at the same time as this object 4093 to allow the probe to accurately estimate the resources 4094 required for this usrHistoryControlEntry. 4096 There will be times when the actual number of buckets 4097 associated with this entry is less than the value of 4098 this object. In this case, at the end of each sampling 4099 interval, a new bucket will be added to the usrHistoryTable. 4101 When the number of buckets reaches the value of this object 4102 and a new bucket is to be added to the usrHistoryTable, 4103 the oldest bucket associated with this usrHistoryControlEntry 4104 shall be deleted by the agent so that the new bucket can be 4105 added. 4107 When the value of this object changes to a value less than 4108 the current value, entries are deleted from the 4109 usrHistoryTable associated with this usrHistoryControlEntry. 4110 Enough of the oldest of these entries shall be deleted by the 4111 agent so that their number remains less than or equal to the 4112 new value of this object. 4114 When the value of this object changes to a value greater 4115 than the current value, the number of associated usrHistory 4116 entries may be allowed to grow." 4117 ::= { usrHistoryControlEntry 4 } 4119 usrHistoryControlInterval OBJECT-TYPE 4120 SYNTAX Integer32 (1..2147483647) 4121 MAX-ACCESS read-create 4122 STATUS current 4123 DESCRIPTION 4124 "The interval in seconds over which the data is 4125 sampled for each bucket in the part of the usrHistory 4126 table associated with this usrHistoryControlEntry. 4128 Because the counters in a bucket may overflow at their 4129 maximum value with no indication, a prudent manager will 4130 take into account the possibility of overflow in any of 4131 the associated counters. It is important to consider the 4132 minimum time in which any counter could overflow on a 4133 particular media type and set the usrHistoryControlInterval 4134 object to a value less than this interval. 4136 This object may not be modified if the associated 4137 usrHistoryControlStatus object is equal to active(1)." 4138 DEFVAL { 1800 } 4139 ::= { usrHistoryControlEntry 5 } 4141 usrHistoryControlOwner OBJECT-TYPE 4142 SYNTAX OwnerString 4143 MAX-ACCESS read-create 4144 STATUS current 4145 DESCRIPTION 4146 "The entity that configured this entry and is 4147 therefore using the resources assigned to it." 4148 ::= { usrHistoryControlEntry 6 } 4150 usrHistoryControlStatus OBJECT-TYPE 4151 SYNTAX RowStatus 4152 MAX-ACCESS read-create 4153 STATUS current 4154 DESCRIPTION 4155 "The status of this variable history control entry. 4157 An entry may not exist in the active state unless all 4158 objects in the entry have an appropriate value. 4160 If this object is not equal to active(1), all associated 4161 entries in the usrHistoryTable shall be deleted." 4162 ::= { usrHistoryControlEntry 7 } 4164 -- Object table 4166 usrHistoryObjectTable OBJECT-TYPE 4167 SYNTAX SEQUENCE OF UsrHistoryObjectEntry 4168 MAX-ACCESS not-accessible 4169 STATUS current 4170 DESCRIPTION 4171 "A list of data-collection configuration entries." 4172 ::= { usrHistory 2 } 4174 usrHistoryObjectEntry OBJECT-TYPE 4175 SYNTAX UsrHistoryObjectEntry 4176 MAX-ACCESS not-accessible 4177 STATUS current 4178 DESCRIPTION 4179 "A list of MIB instances to be sampled periodically. 4181 Entries in this table are created when an associated 4182 usrHistoryControlObjects object is created. 4184 The usrHistoryControlIndex value in the index is 4185 that of the associated usrHistoryControlEntry. 4187 For example, an instance of usrHistoryObjectVariable might be 4188 usrHistoryObjectVariable.1.3" 4189 INDEX { usrHistoryControlIndex, usrHistoryObjectIndex } 4190 ::= { usrHistoryObjectTable 1 } 4192 UsrHistoryObjectEntry ::= SEQUENCE { 4193 usrHistoryObjectIndex Integer32, 4194 usrHistoryObjectVariable OBJECT IDENTIFIER, 4195 usrHistoryObjectSampleType INTEGER 4196 } 4198 usrHistoryObjectIndex OBJECT-TYPE 4199 SYNTAX Integer32 (1..65535) 4200 MAX-ACCESS not-accessible 4201 STATUS current 4202 DESCRIPTION 4203 "An index used to uniquely identify an entry in the 4204 usrHistoryObject table. Each such entry defines a 4205 MIB instance to be collected periodically." 4206 ::= { usrHistoryObjectEntry 1 } 4208 usrHistoryObjectVariable OBJECT-TYPE 4209 SYNTAX OBJECT IDENTIFIER 4210 MAX-ACCESS read-create 4211 STATUS current 4212 DESCRIPTION 4213 "The object identifier of the particular variable to be 4214 sampled. 4216 Only variables that resolve to an ASN.1 primitive type of 4217 Integer32 (Integer32, Counter, Gauge, or TimeTicks) may be 4218 sampled. 4220 Because SNMP access control is articulated entirely in terms 4221 of the contents of MIB views, no access control mechanism 4222 exists that can restrict the value of this object to identify 4223 only those objects that exist in a particular MIB view. 4224 Because there is thus no acceptable means of restricting the 4225 read access that could be obtained through the user history 4226 mechanism, the probe must only grant write access to this 4227 object in those views that have read access to all objects on 4228 the probe. 4230 During a set operation, if the supplied variable name is not 4231 available in the selected MIB view, a badValue error must be 4232 returned. 4234 This object may not be modified if the associated 4235 usrHistoryControlStatus object is equal to active(1)." 4236 ::= { usrHistoryObjectEntry 2 } 4238 usrHistoryObjectSampleType OBJECT-TYPE 4239 SYNTAX INTEGER { 4240 absoluteValue(1), 4241 deltaValue(2) 4242 } 4243 MAX-ACCESS read-create 4244 STATUS current 4245 DESCRIPTION 4246 "The method of sampling the selected variable for storage in 4247 the usrHistoryTable. 4249 If the value of this object is absoluteValue(1), the value of 4250 the selected variable will be copied directly into the history 4251 bucket. 4253 If the value of this object is deltaValue(2), the value of the 4254 selected variable at the last sample will be subtracted from 4255 the current value, and the difference will be stored in the 4256 history bucket. If the associated usrHistoryObjectVariable 4257 instance could not be obtained at the previous sample 4258 interval, then a delta sample is not possible, and the value 4259 of the associated usrHistoryValStatus object for this interval 4260 will be valueNotAvailable(1). 4262 This object may not be modified if the associated 4263 usrHistoryControlStatus object is equal to active(1)." 4264 ::= { usrHistoryObjectEntry 3 } 4266 -- data table 4268 usrHistoryTable OBJECT-TYPE 4269 SYNTAX SEQUENCE OF UsrHistoryEntry 4270 MAX-ACCESS not-accessible 4271 STATUS current 4272 DESCRIPTION 4273 "A list of user defined history entries." 4274 ::= { usrHistory 3 } 4276 usrHistoryEntry OBJECT-TYPE 4277 SYNTAX UsrHistoryEntry 4278 MAX-ACCESS not-accessible 4279 STATUS current 4280 DESCRIPTION 4281 "A historical sample of user-defined variables. This sample 4282 is associated with the usrHistoryControlEntry which set up the 4283 parameters for a regular collection of these samples. 4285 The usrHistoryControlIndex value in the index identifies the 4286 usrHistoryControlEntry on whose behalf this entry was created. 4287 The usrHistoryObjectIndex value in the index identifies the 4288 usrHistoryObjectEntry on whose behalf this entry was created. 4290 For example, an instance of usrHistoryAbsValue, which represents 4291 the 14th sample of a variable collected as specified by 4292 usrHistoryControlEntry.1 and usrHistoryObjectEntry.1.5, 4293 would be named usrHistoryAbsValue.1.14.5" 4294 INDEX { usrHistoryControlIndex, usrHistorySampleIndex, 4295 usrHistoryObjectIndex } 4296 ::= { usrHistoryTable 1 } 4298 UsrHistoryEntry ::= SEQUENCE { 4299 usrHistorySampleIndex Integer32, 4300 usrHistoryIntervalStart TimeStamp, 4301 usrHistoryIntervalEnd TimeStamp, 4302 usrHistoryAbsValue Gauge32, 4303 usrHistoryValStatus INTEGER 4304 } 4306 usrHistorySampleIndex OBJECT-TYPE 4307 SYNTAX Integer32 (1..2147483647) 4308 MAX-ACCESS not-accessible 4309 STATUS current 4310 DESCRIPTION 4311 "An index that uniquely identifies the particular sample this 4312 entry represents among all samples associated with the same 4313 usrHistoryControlEntry. This index starts at 1 and increases 4314 by one as each new sample is taken." 4316 ::= { usrHistoryEntry 1 } 4318 usrHistoryIntervalStart OBJECT-TYPE 4319 SYNTAX TimeStamp 4320 MAX-ACCESS read-only 4321 STATUS current 4322 DESCRIPTION 4323 "The value of sysUpTime at the start of the interval over 4324 which this sample was measured. If the probe keeps track of 4325 the time of day, it should start the first sample of the 4326 history at a time such that when the next hour of the day 4327 begins, a sample is started at that instant. 4329 Note that following this rule may require the probe to delay 4330 collecting the first sample of the history, as each sample 4331 must be of the same interval. Also note that the sample which 4332 is currently being collected is not accessible in this table 4333 until the end of its interval." 4334 ::= { usrHistoryEntry 2 } 4336 usrHistoryIntervalEnd OBJECT-TYPE 4337 SYNTAX TimeStamp 4338 MAX-ACCESS read-only 4339 STATUS current 4340 DESCRIPTION 4341 "The value of sysUpTime at the end of the interval over which 4342 this sample was measured." 4343 ::= { usrHistoryEntry 3 } 4345 usrHistoryAbsValue OBJECT-TYPE 4346 SYNTAX Gauge32 4347 MAX-ACCESS read-only 4348 STATUS current 4349 DESCRIPTION 4350 "The absolute value (i.e. unsigned value) of the 4351 user-specified statistic during the last sampling period. The 4352 value during the current sampling period is not made available 4353 until the period is completed. 4355 To obtain the true value for this sampling interval, the 4356 associated instance of usrHistoryValStatus must be checked, 4357 and usrHistoryAbsValue adjusted as necessary. 4359 If the MIB instance could not be accessed during the sampling 4360 interval, then this object will have a value of zero and the 4361 associated instance of usrHistoryValStatus will be set to 4362 'valueNotAvailable(1)'. 4364 The access control check prescribed in the definition of 4365 usrHistoryObjectVariable SHOULD be checked for each sampling 4366 interval. If this check determines that access should not be 4367 allowed, then this object will have a value of zero and the 4368 associated instance of usrHistoryValStatus will be set to 4369 'valueNotAvailable(1)'." 4370 ::= { usrHistoryEntry 4 } 4372 usrHistoryValStatus OBJECT-TYPE 4373 SYNTAX INTEGER { 4374 valueNotAvailable(1), 4375 valuePositive(2), 4376 valueNegative(3) 4377 } 4378 MAX-ACCESS read-only 4379 STATUS current 4380 DESCRIPTION 4381 "This object indicates the validity and sign of the data in 4382 the associated instance of usrHistoryAbsValue. 4384 If the MIB instance could not be accessed during the sampling 4385 interval, then 'valueNotAvailable(1)' will be returned. 4387 If the sample is valid and actual value of the sample is 4388 greater than or equal to zero then 'valuePositive(2)' is 4389 returned. 4391 If the sample is valid and the actual value of the sample is 4392 less than zero, 'valueNegative(3)' will be returned. The 4393 associated instance of usrHistoryAbsValue should be multiplied 4394 by -1 to obtain the true sample value." 4395 ::= { usrHistoryEntry 5 } 4397 -- The Probe Configuration Group 4398 -- 4399 -- This group controls the configuration of various operating 4400 -- parameters of the probe. 4402 ControlString ::= TEXTUAL-CONVENTION 4403 STATUS current 4404 DESCRIPTION 4405 "This data type is used to communicate with a modem or a 4406 serial data switch. A ControlString contains embedded 4407 commands to control how the device will interact with the 4408 remote device through the serial interface. Commands are 4409 represented as two character sequences beginning with 4410 the `^' character. 4412 The following commands are recognized by the device (note 4413 that command characters are case sensitive): 4415 ^s Send string that follows which is terminated by the 4416 next command or the end of string. 4417 ^c Delay for the number of seconds that follows. Toss 4418 out any data received rather than storing it in a 4419 buffer for parsing. 4420 ^t Set timeout to the value represented by the decimal 4421 digits that follow. The default timeout is 20 4422 seconds. Note that this timeout may be overridden 4423 by a smaller serialTimeout configured for the 4424 associated serial interface (see serialConfigTable). 4425 ^w Wait for the reply string that follows which is 4426 terminated by the next command or the end of string. 4427 Partial and case insensitive matching is applied, ie. 4428 if the reply string (any case combination) is found 4429 anywhere in the received string, then the a match is 4430 found. If the current timeout elapses without a match, 4431 then the remaining control string is ignored. 4432 ^! The ^ character. 4433 ^d Delay the number of seconds specified by the decimal 4434 digits that follow. 4435 ^b Send break for the number of milliseconds specified by 4436 the decimal digits that follow. If no digits follow, 4437 break will be enforced for 250 milliseconds by default. 4439 The following ASCII control characters may be inserted into 4440 the `^s' send string or the `^w' reply string: 4442 ^@ 0x00 4443 ^A 0x01 4444 .. 4445 ^M 0x0D 4446 .. 4447 ^Z 0x1A 4448 ^[ 0x1B 4449 ^ 0x1C 4450 ^] 0x1D 4451 ^^ 0x1E 4452 ^_ 0x1F 4454 Binary data may also be inserted into the data stream. The 4455 control sequence for each byte of binary data is ^0x##, where 4456 ## is the hexadecimal representation of the data byte. Two 4457 ASCII characters (0-9, a-f, A-F) must follow the `^0x' 4458 control prefix. For example, `^0x0D^0x0A' is interpreted as a 4459 carriage return followed by a line feed." 4460 SYNTAX OCTET STRING (SIZE (0..255)) 4462 probeCapabilities OBJECT-TYPE 4463 SYNTAX BITS { 4464 etherStats(0), 4465 historyControl(1), 4466 etherHistory(2), 4467 alarm(3), 4468 hosts(4), 4469 hostTopN(5), 4470 matrix(6), 4471 filter(7), 4472 capture(8), 4473 event(9), 4474 tokenRingMLStats(10), 4475 tokenRingPStats(11), 4476 tokenRingMLHistory(12), 4477 tokenRingPHistory(13), 4478 ringStation(14), 4479 ringStationOrder(15), 4480 ringStationConfig(16), 4481 sourceRouting(17), 4482 protocolDirectory(18), 4483 protocolDistribution(19), 4484 addressMapping(20), 4485 nlHost(21), 4486 nlMatrix(22), 4487 alHost(23), 4488 alMatrix(24), 4489 usrHistory(25), 4490 probeConfig(26) 4491 } 4492 MAX-ACCESS read-only 4493 STATUS current 4494 DESCRIPTION 4495 "An indication of the RMON MIB groups supported 4496 on at least one interface by this probe." 4497 ::= { probeConfig 1 } 4499 probeSoftwareRev OBJECT-TYPE 4500 SYNTAX DisplayString (SIZE(0..15)) 4501 MAX-ACCESS read-only 4502 STATUS current 4503 DESCRIPTION 4504 "The software revision of this device. This string will have 4505 a zero length if the revision is unknown." 4506 ::= { probeConfig 2 } 4508 probeHardwareRev OBJECT-TYPE 4509 SYNTAX DisplayString (SIZE(0..31)) 4510 MAX-ACCESS read-only 4511 STATUS current 4512 DESCRIPTION 4513 "The hardware revision of this device. This string will have 4514 a zero length if the revision is unknown." 4515 ::= { probeConfig 3 } 4517 probeDateTime OBJECT-TYPE 4518 SYNTAX OCTET STRING (SIZE (0 | 8 | 11)) 4519 MAX-ACCESS read-write 4520 STATUS current 4521 DESCRIPTION 4522 "Probe's current date and time. 4524 field octets contents range 4525 ----- ------ -------- ----- 4526 1 1-2 year 0..65536 4527 2 3 month 1..12 4528 3 4 day 1..31 4529 4 5 hour 0..23 4530 5 6 minutes 0..59 4531 6 7 seconds 0..60 4532 (use 60 for leap-second) 4533 7 8 deci-seconds 0..9 4534 8 9 direction from UTC '+' / '-' 4535 9 10 hours from UTC 0..11 4536 10 11 minutes from UTC 0..59 4538 For example, Tuesday May 26, 1992 at 1:30:15 PM 4539 EDT would be displayed as: 4541 1992-5-26,13:30:15.0,-4:0 4543 Note that if only local time is known, then 4544 timezone information (fields 8-10) is not 4545 present, and if no time information is known, the null 4546 string is returned." 4547 ::= { probeConfig 4 } 4549 probeResetControl OBJECT-TYPE 4550 SYNTAX INTEGER { 4551 running(1), 4552 warmBoot(2), 4553 coldBoot(3) 4554 } 4555 MAX-ACCESS read-write 4556 STATUS current 4557 DESCRIPTION 4558 "Setting this object to warmBoot(2) causes the device to 4559 restart the application software with current configuration 4560 parameters saved in non-volatile memory. Setting this 4561 object to coldBoot(3) causes the device to reinitialize 4562 configuration parameters in non-volatile memory to default 4563 values and restart the application software. When the device 4564 is running normally, this variable has a value of 4565 running(1)." 4566 ::= { probeConfig 5 } 4568 -- The following download objects do not restrict an implementation 4569 -- from implementing additional download mechanisms (controlled in an 4570 -- implementation-specific manner). Further, in the case where the RMON 4571 -- agent shares a processor with other types of systems, the 4572 -- implementation is not required to download those non-RMON functions 4573 -- with this mechanism. 4575 probeDownloadFile OBJECT-TYPE 4576 SYNTAX DisplayString (SIZE(0..127)) 4577 MAX-ACCESS read-write 4578 STATUS deprecated 4579 DESCRIPTION 4580 "The file name to be downloaded from the TFTP server when a 4581 download is next requested via this MIB. This value is set to 4582 the zero length string when no file name has been specified. 4584 This object has been deprecated as it has not had enough 4585 independent implementations to demonstrate interoperability to 4586 meet the requirements of a Draft Standard." 4587 ::= { probeConfig 6 } 4589 probeDownloadTFTPServer OBJECT-TYPE 4590 SYNTAX IpAddress 4591 MAX-ACCESS read-write 4592 STATUS deprecated 4593 DESCRIPTION 4594 "The IP address of the TFTP server that contains the boot 4595 image to load when a download is next requested via this MIB. 4596 This value is set to `0.0.0.0' when no IP address has been 4597 specified. 4599 This object has been deprecated as it has not had enough 4600 independent implementations to demonstrate interoperability to 4601 meet the requirements of a Draft Standard." 4602 ::= { probeConfig 7 } 4604 probeDownloadAction OBJECT-TYPE 4605 SYNTAX INTEGER { 4606 notDownloading(1), 4607 downloadToPROM(2), 4608 downloadToRAM(3) 4609 } 4610 MAX-ACCESS read-write 4611 STATUS deprecated 4612 DESCRIPTION 4613 "When this object is set to downloadToRAM(3) or 4614 downloadToPROM(2), the device will discontinue its 4615 normal operation and begin download of the image specified 4616 by probeDownloadFile from the server specified by 4617 probeDownloadTFTPServer using the TFTP protocol. If 4618 downloadToRAM(3) is specified, the new image is copied 4619 to RAM only (the old image remains unaltered in the flash 4620 EPROM). If downloadToPROM(2) is specified 4621 the new image is written to the flash EPROM 4622 memory after its checksum has been verified to be correct. 4623 When the download process is completed, the device will 4624 warm boot to restart the newly loaded application. 4625 When the device is not downloading, this object will have 4626 a value of notDownloading(1). 4628 This object has been deprecated as it has not had enough 4629 independent implementations to demonstrate interoperability to 4630 meet the requirements of a Draft Standard." 4632 ::= { probeConfig 8 } 4634 probeDownloadStatus OBJECT-TYPE 4635 SYNTAX INTEGER { 4636 downloadSuccess(1), 4637 downloadStatusUnknown(2), 4638 downloadGeneralError(3), 4639 downloadNoResponseFromServer(4), 4640 downloadChecksumError(5), 4641 downloadIncompatibleImage(6), 4642 downloadTftpFileNotFound(7), 4643 downloadTftpAccessViolation(8) 4644 } 4645 MAX-ACCESS read-only 4646 STATUS deprecated 4647 DESCRIPTION 4648 "The status of the last download procedure, if any. This 4649 object will have a value of downloadStatusUnknown(2) if no 4650 download process has been performed. 4652 This object has been deprecated as it has not had enough 4653 independent implementations to demonstrate interoperability to 4654 meet the requirements of a Draft Standard." 4655 ::= { probeConfig 9 } 4657 serialConfigTable OBJECT-TYPE 4658 SYNTAX SEQUENCE OF SerialConfigEntry 4659 MAX-ACCESS not-accessible 4660 STATUS deprecated 4661 DESCRIPTION 4662 "A table of serial interface configuration entries. This data 4663 will be stored in non-volatile memory and preserved across 4664 probe resets or power loss. 4666 This table has been deprecated as it has not had enough 4667 independent implementations to demonstrate interoperability to 4668 meet the requirements of a Draft Standard." 4669 ::= { probeConfig 10 } 4671 serialConfigEntry OBJECT-TYPE 4672 SYNTAX SerialConfigEntry 4673 MAX-ACCESS not-accessible 4674 STATUS deprecated 4675 DESCRIPTION 4676 "A set of configuration parameters for a particular 4677 serial interface on this device. If the device has no serial 4678 interfaces, this table is empty. 4680 The index is composed of the ifIndex assigned to this serial 4681 line interface." 4682 INDEX { ifIndex } 4683 ::= { serialConfigTable 1 } 4685 SerialConfigEntry ::= SEQUENCE { 4686 serialMode INTEGER, 4687 serialProtocol INTEGER, 4688 serialTimeout Integer32, 4689 serialModemInitString ControlString, 4690 serialModemHangUpString ControlString, 4691 serialModemConnectResp DisplayString, 4692 serialModemNoConnectResp DisplayString, 4693 serialDialoutTimeout Integer32, 4694 serialStatus RowStatus 4695 } 4697 serialMode OBJECT-TYPE 4698 SYNTAX INTEGER { 4699 direct(1), 4700 modem(2) 4701 } 4702 MAX-ACCESS read-create 4703 STATUS deprecated 4704 DESCRIPTION 4705 "The type of incoming connection to expect on this serial 4706 interface." 4707 DEFVAL { direct } 4708 ::= { serialConfigEntry 1 } 4710 serialProtocol OBJECT-TYPE 4711 SYNTAX INTEGER { 4712 other(1), 4713 slip(2), 4714 ppp(3) 4715 } 4716 MAX-ACCESS read-create 4717 STATUS deprecated 4718 DESCRIPTION 4719 "The type of data link encapsulation to be used on this 4720 serial interface." 4721 DEFVAL { slip } 4722 ::= { serialConfigEntry 2 } 4724 serialTimeout OBJECT-TYPE 4725 SYNTAX Integer32 (1..65535) 4726 MAX-ACCESS read-create 4727 STATUS deprecated 4728 DESCRIPTION 4729 "This timeout value is used when the Management Station has 4730 initiated the conversation over the serial link. This variable 4731 represents the number of seconds of inactivity allowed before 4732 terminating the connection on this serial interface. Use the 4733 serialDialoutTimeout in the case where the probe has initiated 4734 the connection for the purpose of sending a trap." 4735 DEFVAL { 300 } 4736 ::= { serialConfigEntry 3 } 4738 serialModemInitString OBJECT-TYPE 4739 SYNTAX ControlString (SIZE (0..255)) 4740 MAX-ACCESS read-create 4741 STATUS deprecated 4742 DESCRIPTION 4743 "A control string which controls how a modem attached to this 4744 serial interface should be initialized. The initialization 4745 is performed once during startup and again after each 4746 connection is terminated if the associated serialMode has the 4747 value of modem(2). 4749 A control string that is appropriate for a wide variety of 4750 modems is: '^s^MATE0Q0V1X4 S0=1 S2=43^M'." 4751 ::= { serialConfigEntry 4 } 4753 serialModemHangUpString OBJECT-TYPE 4754 SYNTAX ControlString (SIZE (0..255)) 4755 MAX-ACCESS read-create 4756 STATUS deprecated 4757 DESCRIPTION 4758 "A control string which specifies how to disconnect a modem 4759 connection on this serial interface. This object is only 4760 meaningful if the associated serialMode has the value 4761 of modem(2). 4762 A control string that is appropriate for a wide variety of 4763 modems is: '^d2^s+++^d2^sATH0^M^d2'." 4764 ::= { serialConfigEntry 5 } 4766 serialModemConnectResp OBJECT-TYPE 4767 SYNTAX DisplayString (SIZE (0..255)) 4768 MAX-ACCESS read-create 4769 STATUS deprecated 4770 DESCRIPTION 4771 "An ASCII string containing substrings that describe the 4772 expected modem connection response code and associated bps 4773 rate. The substrings are delimited by the first character 4774 in the string, for example: 4775 /CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 4776 CONNECT 4800/4800/CONNECT 9600/9600 4777 will be interpreted as: 4778 response code bps rate 4779 CONNECT 300 4780 CONNECT 1200 1200 4781 CONNECT 2400 2400 4782 CONNECT 4800 4800 4783 CONNECT 9600 9600 4784 The agent will use the information in this string to adjust 4785 the bps rate of this serial interface once a modem connection 4786 is established. 4788 A value that is appropriate for a wide variety of modems is: 4789 '/CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 4790 CONNECT 4800/4800/CONNECT 9600/9600/CONNECT 14400/14400/ 4791 CONNECT 19200/19200/CONNECT 38400/38400/'." 4792 ::= { serialConfigEntry 6 } 4794 serialModemNoConnectResp OBJECT-TYPE 4795 SYNTAX DisplayString (SIZE (0..255)) 4796 MAX-ACCESS read-create 4797 STATUS deprecated 4798 DESCRIPTION 4799 "An ASCII string containing response codes that may be 4800 generated by a modem to report the reason why a connection 4801 attempt has failed. The response codes are delimited by 4802 the first character in the string, for example: 4803 /NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/ 4804 If one of these response codes is received via this serial 4805 interface while attempting to make a modem connection, 4806 the agent will issue the hang up command as specified by 4807 serialModemHangUpString. 4809 A value that is appropriate for a wide variety of modems is: 4810 '/NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/'." 4811 ::= { serialConfigEntry 7 } 4813 serialDialoutTimeout OBJECT-TYPE 4814 SYNTAX Integer32 (1..65535) 4815 MAX-ACCESS read-create 4816 STATUS deprecated 4817 DESCRIPTION 4818 "This timeout value is used when the probe initiates the 4819 serial connection with the intention of contacting a 4820 management station. This variable represents the number 4821 of seconds of inactivity allowed before terminating the 4822 connection on this serial interface." 4823 DEFVAL { 20 } 4824 ::= { serialConfigEntry 8 } 4826 serialStatus OBJECT-TYPE 4827 SYNTAX RowStatus 4828 MAX-ACCESS read-create 4829 STATUS deprecated 4830 DESCRIPTION 4831 "The status of this serialConfigEntry. 4833 An entry may not exist in the active state unless all 4834 objects in the entry have an appropriate value." 4835 ::= { serialConfigEntry 9 } 4837 netConfigTable OBJECT-TYPE 4838 SYNTAX SEQUENCE OF NetConfigEntry 4839 MAX-ACCESS not-accessible 4840 STATUS deprecated 4841 DESCRIPTION 4842 "A table of netConfigEntries. 4844 This table has been deprecated as it has not had enough 4845 independent implementations to demonstrate interoperability to 4846 meet the requirements of a Draft Standard." 4847 ::= { probeConfig 11 } 4849 netConfigEntry OBJECT-TYPE 4850 SYNTAX NetConfigEntry 4851 MAX-ACCESS not-accessible 4852 STATUS deprecated 4853 DESCRIPTION 4854 "A set of configuration parameters for a particular 4855 network interface on this device. If the device has no network 4856 interface, this table is empty. 4858 The index is composed of the ifIndex assigned to the 4859 corresponding interface." 4860 INDEX { ifIndex } 4861 ::= { netConfigTable 1 } 4863 NetConfigEntry ::= SEQUENCE { 4864 netConfigIPAddress IpAddress, 4865 netConfigSubnetMask IpAddress, 4866 netConfigStatus RowStatus 4867 } 4869 netConfigIPAddress OBJECT-TYPE 4870 SYNTAX IpAddress 4871 MAX-ACCESS read-create 4872 STATUS deprecated 4873 DESCRIPTION 4874 "The IP address of this Net interface. The default value 4875 for this object is 0.0.0.0. If either the netConfigIPAddress 4876 or netConfigSubnetMask are 0.0.0.0, then when the device 4877 boots, it may use BOOTP to try to figure out what these 4878 values should be. If BOOTP fails, before the device 4879 can talk on the network, this value must be configured 4880 (e.g., through a terminal attached to the device). If BOOTP is 4881 used, care should be taken to not send BOOTP broadcasts too 4882 frequently and to eventually send very infrequently if no 4883 replies are received." 4884 ::= { netConfigEntry 1 } 4886 netConfigSubnetMask OBJECT-TYPE 4887 SYNTAX IpAddress 4888 MAX-ACCESS read-create 4889 STATUS deprecated 4890 DESCRIPTION 4891 "The subnet mask of this Net interface. The default value 4892 for this object is 0.0.0.0. If either the netConfigIPAddress 4893 or netConfigSubnetMask are 0.0.0.0, then when the device 4894 boots, it may use BOOTP to try to figure out what these 4895 values should be. If BOOTP fails, before the device 4896 can talk on the network, this value must be configured 4897 (e.g., through a terminal attached to the device). If BOOTP is 4898 used, care should be taken to not send BOOTP broadcasts too 4899 frequently and to eventually send very infrequently if no 4900 replies are received." 4901 ::= { netConfigEntry 2 } 4903 netConfigStatus OBJECT-TYPE 4904 SYNTAX RowStatus 4905 MAX-ACCESS read-create 4906 STATUS deprecated 4907 DESCRIPTION 4908 "The status of this netConfigEntry. 4910 An entry may not exist in the active state unless all 4911 objects in the entry have an appropriate value." 4912 ::= { netConfigEntry 3 } 4914 netDefaultGateway OBJECT-TYPE 4915 SYNTAX IpAddress 4916 MAX-ACCESS read-write 4917 STATUS deprecated 4918 DESCRIPTION 4919 "The IP Address of the default gateway. If this value is 4920 undefined or unknown, it shall have the value 0.0.0.0." 4921 ::= { probeConfig 12 } 4923 -- Trap Destination Table 4924 -- 4925 -- This table defines the destination addresses for traps generated 4926 -- from the device. This table maps a community to one or more trap 4927 -- destination entries. 4928 -- 4929 -- The same trap will be sent to all destinations specified in the 4930 -- entries that have the same trapDestCommunity as the eventCommunity 4931 -- (as defined by RMON MIB), as long as no access control mechanism 4932 -- (e.g., VACM) prohibits sending to one or mor of the destinations. 4933 -- Information in this table will be stored in non-volatile memory. 4934 -- If the device has gone through a hard restart, this information 4935 -- will be reset to its default state. 4937 trapDestTable OBJECT-TYPE 4938 SYNTAX SEQUENCE OF TrapDestEntry 4939 MAX-ACCESS not-accessible 4940 STATUS deprecated 4941 DESCRIPTION 4942 "A list of trap destination entries." 4943 ::= { probeConfig 13 } 4945 trapDestEntry OBJECT-TYPE 4946 SYNTAX TrapDestEntry 4947 MAX-ACCESS not-accessible 4948 STATUS deprecated 4949 DESCRIPTION 4950 "This entry includes a destination IP address to which to send 4951 traps for this community." 4952 INDEX { trapDestIndex } 4953 ::= { trapDestTable 1 } 4955 TrapDestEntry ::= SEQUENCE { 4956 trapDestIndex Integer32, 4957 trapDestCommunity OCTET STRING, 4958 trapDestProtocol INTEGER, 4959 trapDestAddress OCTET STRING, 4960 trapDestOwner OwnerString, 4961 trapDestStatus RowStatus 4962 } 4964 trapDestIndex OBJECT-TYPE 4965 SYNTAX Integer32 (1..65535) 4966 MAX-ACCESS not-accessible 4967 STATUS deprecated 4968 DESCRIPTION 4969 "A value that uniquely identifies this trapDestEntry." 4970 ::= { trapDestEntry 1 } 4972 trapDestCommunity OBJECT-TYPE 4973 SYNTAX OCTET STRING (SIZE(0..127)) 4974 MAX-ACCESS read-create 4975 STATUS deprecated 4976 DESCRIPTION 4977 "A community to which this destination address belongs. 4978 This entry is associated with any eventEntries in the RMON 4979 MIB whose value of eventCommunity is equal to the value of 4980 this object. Every time an associated event entry sends a 4981 trap due to an event, that trap will be sent to each 4982 address in the trapDestTable with a trapDestCommunity equal to 4983 eventCommunity, as long as no access control mechanism 4984 precludes it (e.g., VACM). 4986 This object may not be modified if the associated 4987 trapDestStatus object is equal to active(1)." 4988 ::= { trapDestEntry 2 } 4990 trapDestProtocol OBJECT-TYPE 4991 SYNTAX INTEGER { 4992 ip(1), 4993 ipx(2) 4994 } 4995 MAX-ACCESS read-create 4996 STATUS deprecated 4997 DESCRIPTION 4998 "The protocol with which to send this trap." 4999 ::= { trapDestEntry 3 } 5001 trapDestAddress OBJECT-TYPE 5002 SYNTAX OCTET STRING 5003 MAX-ACCESS read-create 5004 STATUS deprecated 5005 DESCRIPTION 5006 "The address to send traps on behalf of this entry. 5008 If the associated trapDestProtocol object is equal to ip(1), 5009 the encoding of this object is the same as the snmpUDPAddress 5010 textual convention in [RFC1906]: 5011 -- for a SnmpUDPAddress of length 6: 5012 -- 5013 -- octets contents encoding 5014 -- 1-4 IP-address network-byte order 5015 -- 5-6 UDP-port network-byte order 5017 If the associated trapDestProtocol object is equal to ipx(2), 5018 the encoding of this object is the same as the snmpIPXAddress 5019 textual convention in [RFC1906]: 5020 -- for a SnmpIPXAddress of length 12: 5021 -- 5022 -- octets contents encoding 5023 -- 1-4 network-number network-byte order 5024 -- 5-10 physical-address network-byte order 5025 -- 11-12 socket-number network-byte order 5027 This object may not be modified if the associated 5028 trapDestStatus object is equal to active(1)." 5029 ::= { trapDestEntry 4 } 5031 trapDestOwner OBJECT-TYPE 5032 SYNTAX OwnerString 5033 MAX-ACCESS read-create 5034 STATUS deprecated 5035 DESCRIPTION 5036 "The entity that configured this entry and is 5037 therefore using the resources assigned to it." 5039 ::= { trapDestEntry 5 } 5041 trapDestStatus OBJECT-TYPE 5042 SYNTAX RowStatus 5043 MAX-ACCESS read-create 5044 STATUS deprecated 5045 DESCRIPTION 5046 "The status of this trap destination entry. 5048 An entry may not exist in the active state unless all 5049 objects in the entry have an appropriate value." 5050 ::= { trapDestEntry 6 } 5052 -- Serial Connection Table 5053 -- 5054 -- The device may communicate with a management station using 5055 -- SLIP. In order for the device to send traps via SLIP, it must 5056 -- be able to initiate a connection over the serial interface. The 5057 -- serialConnectionTable stores the parameters for such connection 5058 -- initiation. 5060 serialConnectionTable OBJECT-TYPE 5061 SYNTAX SEQUENCE OF SerialConnectionEntry 5062 MAX-ACCESS not-accessible 5063 STATUS deprecated 5064 DESCRIPTION 5065 "A list of serialConnectionEntries. 5067 This table has been deprecated as it has not had enough 5068 independent implementations to demonstrate interoperability to 5069 meet the requirements of a Draft Standard." 5070 ::= { probeConfig 14 } 5072 serialConnectionEntry OBJECT-TYPE 5073 SYNTAX SerialConnectionEntry 5074 MAX-ACCESS not-accessible 5075 STATUS deprecated 5076 DESCRIPTION 5077 "Configuration for a SLIP link over a serial line." 5078 INDEX { serialConnectIndex } 5079 ::= { serialConnectionTable 1 } 5081 SerialConnectionEntry ::= SEQUENCE { 5082 serialConnectIndex Integer32, 5083 serialConnectDestIpAddress IpAddress, 5084 serialConnectType INTEGER, 5085 serialConnectDialString ControlString, 5086 serialConnectSwitchConnectSeq ControlString, 5087 serialConnectSwitchDisconnectSeq ControlString, 5088 serialConnectSwitchResetSeq ControlString, 5089 serialConnectOwner OwnerString, 5090 serialConnectStatus RowStatus 5091 } 5093 serialConnectIndex OBJECT-TYPE 5094 SYNTAX Integer32 (1..65535) 5095 MAX-ACCESS not-accessible 5096 STATUS deprecated 5097 DESCRIPTION 5098 "A value that uniquely identifies this serialConnection 5099 entry." 5100 ::= { serialConnectionEntry 1 } 5102 serialConnectDestIpAddress OBJECT-TYPE 5103 SYNTAX IpAddress 5104 MAX-ACCESS read-create 5105 STATUS deprecated 5106 DESCRIPTION 5107 "The IP Address that can be reached at the other end of this 5108 serial connection. 5109 This object may not be modified if the associated 5110 serialConnectStatus object is equal to active(1)." 5111 ::= { serialConnectionEntry 2 } 5113 serialConnectType OBJECT-TYPE 5114 SYNTAX INTEGER { 5115 direct(1), 5116 modem(2), 5117 switch(3), 5118 modemSwitch(4) 5119 } 5120 MAX-ACCESS read-create 5121 STATUS deprecated 5122 DESCRIPTION 5123 "The type of outgoing connection to make. If this object 5124 has the value direct(1), then a direct serial connection 5125 is assumed. If this object has the value modem(2), 5126 then serialConnectDialString will be used to make a modem 5127 connection. If this object has the value switch(3), 5128 then serialConnectSwitchConnectSeq will be used to establish 5129 the connection over a serial data switch, and 5130 serialConnectSwitchDisconnectSeq will be used to terminate 5131 the connection. If this object has the value 5132 modem-switch(4), then a modem connection will be made first 5133 followed by the switch connection. 5135 This object may not be modified if the associated 5136 serialConnectStatus object is equal to active(1)." 5137 DEFVAL { direct } 5138 ::= { serialConnectionEntry 3 } 5140 serialConnectDialString OBJECT-TYPE 5141 SYNTAX ControlString (SIZE(0..255)) 5142 MAX-ACCESS read-create 5143 STATUS deprecated 5144 DESCRIPTION 5145 "A control string which specifies how to dial the phone 5146 number in order to establish a modem connection. The 5147 string should include dialing prefix and suffix. For 5148 example: ``^s^MATD9,888-1234^M'' will instruct the Probe 5149 to send a carriage return followed by the dialing prefix 5150 ``ATD'', the phone number ``9,888-1234'', and a carriage 5151 return as the dialing suffix. 5152 This object may not be modified if the associated 5153 serialConnectStatus object is equal to active(1)." 5154 ::= { serialConnectionEntry 4 } 5156 serialConnectSwitchConnectSeq OBJECT-TYPE 5157 SYNTAX ControlString (SIZE(0..255)) 5158 MAX-ACCESS read-create 5159 STATUS deprecated 5160 DESCRIPTION 5161 "A control string which specifies how to establish a 5162 data switch connection. 5163 This object may not be modified if the associated 5164 serialConnectStatus object is equal to active(1)." 5165 ::= { serialConnectionEntry 5 } 5167 serialConnectSwitchDisconnectSeq OBJECT-TYPE 5168 SYNTAX ControlString (SIZE(0..255)) 5169 MAX-ACCESS read-create 5170 STATUS deprecated 5171 DESCRIPTION 5172 "A control string which specifies how to terminate a 5173 data switch connection. 5174 This object may not be modified if the associated 5175 serialConnectStatus object is equal to active(1)." 5176 ::= { serialConnectionEntry 6 } 5178 serialConnectSwitchResetSeq OBJECT-TYPE 5179 SYNTAX ControlString (SIZE(0..255)) 5180 MAX-ACCESS read-create 5181 STATUS deprecated 5182 DESCRIPTION 5183 "A control string which specifies how to reset a data 5184 switch in the event of a timeout. 5185 This object may not be modified if the associated 5186 serialConnectStatus object is equal to active(1)." 5187 ::= { serialConnectionEntry 7 } 5189 serialConnectOwner OBJECT-TYPE 5190 SYNTAX OwnerString 5191 MAX-ACCESS read-create 5192 STATUS deprecated 5193 DESCRIPTION 5194 "The entity that configured this entry and is 5195 therefore using the resources assigned to it." 5196 ::= { serialConnectionEntry 8 } 5198 serialConnectStatus OBJECT-TYPE 5199 SYNTAX RowStatus 5200 MAX-ACCESS read-create 5201 STATUS deprecated 5202 DESCRIPTION 5203 "The status of this serialConnectionEntry. 5205 If the manager attempts to set this object to active(1) when 5206 the serialConnectType is set to modem(2) or modem-switch(4) 5207 and the serialConnectDialString is a zero-length string or 5208 cannot be correctly parsed as a ConnectString, the set 5209 request will be rejected with badValue(3). 5211 If the manager attempts to set this object to active(1) when 5212 the serialConnectType is set to switch(3) or modem-switch(4) 5213 and the serialConnectSwitchConnectSeq, 5214 the serialConnectSwitchDisconnectSeq, or 5215 the serialConnectSwitchResetSeq are zero-length strings 5216 or cannot be correctly parsed as ConnectStrings, the set 5217 request will be rejected with badValue(3). 5219 An entry may not exist in the active state unless all 5220 objects in the entry have an appropriate value." 5221 ::= { serialConnectionEntry 9 } 5223 -- 5224 -- Extensions to the RMON 1 MIB for RMON 2 devices 5225 -- 5226 -- These extensions include the standard LastCreateTime Textual 5227 -- Convention for all control tables, as well as an augmentation of 5228 -- the filter entry that provides variable-length offsets into 5229 -- packets. 5231 -- Each of the following, except for filterDroppedFrames, is a 5232 -- read-only object which, if implemented, automatically appears when 5233 -- the RMON1 row it is associated with is created. 5235 etherStats2Table OBJECT-TYPE 5236 SYNTAX SEQUENCE OF EtherStats2Entry 5237 MAX-ACCESS not-accessible 5238 STATUS current 5239 DESCRIPTION 5240 "Contains the RMON-2 augmentations to RMON-1." 5241 ::= { statistics 4 } 5243 etherStats2Entry OBJECT-TYPE 5244 SYNTAX EtherStats2Entry 5245 MAX-ACCESS not-accessible 5246 STATUS current 5247 DESCRIPTION 5248 "Contains the RMON-2 augmentations to RMON-1." 5249 AUGMENTS { etherStatsEntry } 5250 ::= { etherStats2Table 1 } 5252 EtherStats2Entry ::= SEQUENCE { 5253 etherStatsDroppedFrames Counter32, 5254 etherStatsCreateTime LastCreateTime 5255 } 5257 etherStatsDroppedFrames OBJECT-TYPE 5258 SYNTAX Counter32 5259 MAX-ACCESS read-only 5260 STATUS current 5261 DESCRIPTION 5262 "The total number of frames which were received by the probe 5263 and therefore not accounted for in the *StatsDropEvents, but 5264 for which the probe chose not to count for this entry for 5265 whatever reason. Most often, this event occurs when the probe 5266 is out of some resources and decides to shed load from this 5267 collection. 5269 This count does not include packets that were not counted 5270 because they had MAC-layer errors. 5272 Note that, unlike the dropEvents counter, this number is the 5273 exact number of frames dropped." 5274 ::= { etherStats2Entry 1 } 5276 etherStatsCreateTime OBJECT-TYPE 5277 SYNTAX LastCreateTime 5278 MAX-ACCESS read-only 5279 STATUS current 5280 DESCRIPTION 5281 "The value of sysUpTime when this control entry was last 5282 activated. This can be used by the management station to 5283 ensure that the table has not been deleted and recreated 5284 between polls." 5285 ::= { etherStats2Entry 2 } 5287 historyControl2Table OBJECT-TYPE 5288 SYNTAX SEQUENCE OF HistoryControl2Entry 5289 MAX-ACCESS not-accessible 5290 STATUS current 5291 DESCRIPTION 5292 "Contains the RMON-2 augmentations to RMON-1." 5293 ::= { history 5 } 5295 historyControl2Entry OBJECT-TYPE 5296 SYNTAX HistoryControl2Entry 5297 MAX-ACCESS not-accessible 5298 STATUS current 5299 DESCRIPTION 5300 "Contains the RMON-2 augmentations to RMON-1." 5301 AUGMENTS { historyControlEntry } 5302 ::= { historyControl2Table 1 } 5304 HistoryControl2Entry ::= SEQUENCE { 5305 historyControlDroppedFrames Counter32 5306 } 5307 historyControlDroppedFrames OBJECT-TYPE 5308 SYNTAX Counter32 5309 MAX-ACCESS read-only 5310 STATUS current 5311 DESCRIPTION 5312 "The total number of frames which were received by the probe 5313 and therefore not accounted for in the *StatsDropEvents, but 5314 for which the probe chose not to count for this entry for 5315 whatever reason. Most often, this event occurs when the probe 5316 is out of some resources and decides to shed load from this 5317 collection. 5319 This count does not include packets that were not counted 5320 because they had MAC-layer errors. 5322 Note that, unlike the dropEvents counter, this number is the 5323 exact number of frames dropped." 5324 ::= { historyControl2Entry 1 } 5326 hostControl2Table OBJECT-TYPE 5327 SYNTAX SEQUENCE OF HostControl2Entry 5328 MAX-ACCESS not-accessible 5329 STATUS current 5330 DESCRIPTION 5331 "Contains the RMON-2 augmentations to RMON-1." 5332 ::= { hosts 4 } 5334 hostControl2Entry OBJECT-TYPE 5335 SYNTAX HostControl2Entry 5336 MAX-ACCESS not-accessible 5337 STATUS current 5338 DESCRIPTION 5339 "Contains the RMON-2 augmentations to RMON-1." 5340 AUGMENTS { hostControlEntry } 5341 ::= { hostControl2Table 1 } 5343 HostControl2Entry ::= SEQUENCE { 5344 hostControlDroppedFrames Counter32, 5345 hostControlCreateTime LastCreateTime 5346 } 5348 hostControlDroppedFrames OBJECT-TYPE 5349 SYNTAX Counter32 5350 MAX-ACCESS read-only 5351 STATUS current 5352 DESCRIPTION 5353 "The total number of frames which were received by the probe 5354 and therefore not accounted for in the *StatsDropEvents, but 5355 for which the probe chose not to count for this entry for 5356 whatever reason. Most often, this event occurs when the probe 5357 is out of some resources and decides to shed load from this 5358 collection. 5360 This count does not include packets that were not counted 5361 because they had MAC-layer errors. 5363 Note that, unlike the dropEvents counter, this number is the 5364 exact number of frames dropped." 5365 ::= { hostControl2Entry 1 } 5367 hostControlCreateTime OBJECT-TYPE 5368 SYNTAX LastCreateTime 5369 MAX-ACCESS read-only 5370 STATUS current 5371 DESCRIPTION 5372 "The value of sysUpTime when this control entry was last 5373 activated. This can be used by the management station to 5374 ensure that the table has not been deleted and recreated 5375 between polls." 5376 ::= { hostControl2Entry 2 } 5378 matrixControl2Table OBJECT-TYPE 5379 SYNTAX SEQUENCE OF MatrixControl2Entry 5380 MAX-ACCESS not-accessible 5381 STATUS current 5382 DESCRIPTION 5383 "Contains the RMON-2 augmentations to RMON-1." 5384 ::= { matrix 4 } 5386 matrixControl2Entry OBJECT-TYPE 5387 SYNTAX MatrixControl2Entry 5388 MAX-ACCESS not-accessible 5389 STATUS current 5390 DESCRIPTION 5391 "Contains the RMON-2 augmentations to RMON-1." 5392 AUGMENTS { matrixControlEntry } 5393 ::= { matrixControl2Table 1 } 5395 MatrixControl2Entry ::= SEQUENCE { 5396 matrixControlDroppedFrames Counter32, 5397 matrixControlCreateTime LastCreateTime 5398 } 5400 matrixControlDroppedFrames OBJECT-TYPE 5401 SYNTAX Counter32 5402 MAX-ACCESS read-only 5403 STATUS current 5404 DESCRIPTION 5405 "The total number of frames which were received by the probe 5406 and therefore not accounted for in the *StatsDropEvents, but 5407 for which the probe chose not to count for this entry for 5408 whatever reason. Most often, this event occurs when the probe 5409 is out of some resources and decides to shed load from this 5410 collection. 5412 This count does not include packets that were not counted 5413 because they had MAC-layer errors. 5415 Note that, unlike the dropEvents counter, this number is the 5416 exact number of frames dropped." 5417 ::= { matrixControl2Entry 1 } 5419 matrixControlCreateTime OBJECT-TYPE 5420 SYNTAX LastCreateTime 5421 MAX-ACCESS read-only 5422 STATUS current 5423 DESCRIPTION 5424 "The value of sysUpTime when this control entry was last 5425 activated. This can be used by the management station to 5426 ensure that the table has not been deleted and recreated 5427 between polls." 5428 ::= { matrixControl2Entry 2 } 5430 channel2Table OBJECT-TYPE 5431 SYNTAX SEQUENCE OF Channel2Entry 5432 MAX-ACCESS not-accessible 5433 STATUS current 5434 DESCRIPTION 5435 "Contains the RMON-2 augmentations to RMON-1." 5436 ::= { filter 3 } 5438 channel2Entry OBJECT-TYPE 5439 SYNTAX Channel2Entry 5440 MAX-ACCESS not-accessible 5441 STATUS current 5442 DESCRIPTION 5443 "Contains the RMON-2 augmentations to RMON-1." 5444 AUGMENTS { channelEntry } 5445 ::= { channel2Table 1 } 5447 Channel2Entry ::= SEQUENCE { 5448 channelDroppedFrames Counter32, 5449 channelCreateTime LastCreateTime 5450 } 5452 channelDroppedFrames OBJECT-TYPE 5453 SYNTAX Counter32 5454 MAX-ACCESS read-only 5455 STATUS current 5456 DESCRIPTION 5457 "The total number of frames which were received by the probe 5458 and therefore not accounted for in the *StatsDropEvents, but 5459 for which the probe chose not to count for this entry for 5460 whatever reason. Most often, this event occurs when the probe 5461 is out of some resources and decides to shed load from this 5462 collection. 5464 This count does not include packets that were not counted 5465 because they had MAC-layer errors. 5467 Note that, unlike the dropEvents counter, this number is the 5468 exact number of frames dropped." 5469 ::= { channel2Entry 1 } 5471 channelCreateTime OBJECT-TYPE 5472 SYNTAX LastCreateTime 5473 MAX-ACCESS read-only 5474 STATUS current 5475 DESCRIPTION 5476 "The value of sysUpTime when this control entry was last 5477 activated. This can be used by the management station to 5478 ensure that the table has not been deleted and recreated 5479 between polls." 5480 ::= { channel2Entry 2 } 5482 tokenRingMLStats2Table OBJECT-TYPE 5483 SYNTAX SEQUENCE OF TokenRingMLStats2Entry 5484 MAX-ACCESS not-accessible 5485 STATUS deprecated 5486 DESCRIPTION 5487 "Contains the RMON-2 augmentations to RMON-1. 5489 This table has been deprecated as it has not had enough 5490 independent implementations to demonstrate interoperability to 5491 meet the requirements of a Draft Standard." 5492 ::= { statistics 5 } 5494 tokenRingMLStats2Entry OBJECT-TYPE 5495 SYNTAX TokenRingMLStats2Entry 5496 MAX-ACCESS not-accessible 5497 STATUS deprecated 5498 DESCRIPTION 5499 "Contains the RMON-2 augmentations to RMON-1." 5500 AUGMENTS { tokenRingMLStatsEntry } 5501 ::= { tokenRingMLStats2Table 1 } 5503 TokenRingMLStats2Entry ::= SEQUENCE { 5504 tokenRingMLStatsDroppedFrames Counter32, 5505 tokenRingMLStatsCreateTime LastCreateTime 5506 } 5508 tokenRingMLStatsDroppedFrames OBJECT-TYPE 5509 SYNTAX Counter32 5510 MAX-ACCESS read-only 5511 STATUS deprecated 5512 DESCRIPTION 5513 "The total number of frames which were received by the probe 5514 and therefore not accounted for in the *StatsDropEvents, but 5515 for which the probe chose not to count for this entry for 5516 whatever reason. Most often, this event occurs when the probe 5517 is out of some resources and decides to shed load from this 5518 collection. 5520 This count does not include packets that were not counted 5521 because they had MAC-layer errors. 5523 Note that, unlike the dropEvents counter, this number is the 5524 exact number of frames dropped." 5525 ::= { tokenRingMLStats2Entry 1 } 5527 tokenRingMLStatsCreateTime OBJECT-TYPE 5528 SYNTAX LastCreateTime 5529 MAX-ACCESS read-only 5530 STATUS deprecated 5531 DESCRIPTION 5532 "The value of sysUpTime when this control entry was last activated. 5533 This can be used by the management station to ensure that the 5534 table has not been deleted and recreated between polls." 5535 ::= { tokenRingMLStats2Entry 2 } 5537 tokenRingPStats2Table OBJECT-TYPE 5538 SYNTAX SEQUENCE OF TokenRingPStats2Entry 5539 MAX-ACCESS not-accessible 5540 STATUS deprecated 5541 DESCRIPTION 5542 "Contains the RMON-2 augmentations to RMON-1. 5544 This table has been deprecated as it has not had enough 5545 independent implementations to demonstrate interoperability to 5546 meet the requirements of a Draft Standard." 5547 ::= { statistics 6 } 5549 tokenRingPStats2Entry OBJECT-TYPE 5550 SYNTAX TokenRingPStats2Entry 5551 MAX-ACCESS not-accessible 5552 STATUS deprecated 5553 DESCRIPTION 5554 "Contains the RMON-2 augmentations to RMON-1." 5555 AUGMENTS { tokenRingPStatsEntry } 5556 ::= { tokenRingPStats2Table 1 } 5558 TokenRingPStats2Entry ::= SEQUENCE { 5559 tokenRingPStatsDroppedFrames Counter32, 5560 tokenRingPStatsCreateTime LastCreateTime 5561 } 5563 tokenRingPStatsDroppedFrames OBJECT-TYPE 5564 SYNTAX Counter32 5565 MAX-ACCESS read-only 5566 STATUS deprecated 5567 DESCRIPTION 5568 "The total number of frames which were received by the probe 5569 and therefore not accounted for in the *StatsDropEvents, but 5570 for which the probe chose not to count for this entry for 5571 whatever reason. Most often, this event occurs when the probe 5572 is out of some resources and decides to shed load from this 5573 collection. 5575 This count does not include packets that were not counted 5576 because they had MAC-layer errors. 5578 Note that, unlike the dropEvents counter, this number is the 5579 exact number of frames dropped." 5580 ::= { tokenRingPStats2Entry 1 } 5582 tokenRingPStatsCreateTime OBJECT-TYPE 5583 SYNTAX LastCreateTime 5584 MAX-ACCESS read-only 5585 STATUS deprecated 5586 DESCRIPTION 5587 "The value of sysUpTime when this control entry was last activated. 5588 This can be used by the management station to ensure that the 5589 table has not been deleted and recreated between polls." 5590 ::= { tokenRingPStats2Entry 2 } 5592 ringStationControl2Table OBJECT-TYPE 5593 SYNTAX SEQUENCE OF RingStationControl2Entry 5594 MAX-ACCESS not-accessible 5595 STATUS deprecated 5596 DESCRIPTION 5597 "Contains the RMON-2 augmentations to RMON-1. 5599 This table has been deprecated as it has not had enough 5600 independent implementations to demonstrate interoperability to 5601 meet the requirements of a Draft Standard." 5602 ::= { tokenRing 7 } 5604 ringStationControl2Entry OBJECT-TYPE 5605 SYNTAX RingStationControl2Entry 5606 MAX-ACCESS not-accessible 5607 STATUS deprecated 5608 DESCRIPTION 5609 "Contains the RMON-2 augmentations to RMON-1." 5610 AUGMENTS { ringStationControlEntry } 5611 ::= { ringStationControl2Table 1 } 5613 RingStationControl2Entry ::= SEQUENCE { 5614 ringStationControlDroppedFrames Counter32, 5615 ringStationControlCreateTime LastCreateTime 5616 } 5618 ringStationControlDroppedFrames OBJECT-TYPE 5619 SYNTAX Counter32 5620 MAX-ACCESS read-only 5621 STATUS deprecated 5622 DESCRIPTION 5623 "The total number of frames which were received by the probe 5624 and therefore not accounted for in the *StatsDropEvents, but 5625 for which the probe chose not to count for this entry for 5626 whatever reason. Most often, this event occurs when the probe 5627 is out of some resources and decides to shed load from this 5628 collection. 5630 This count does not include packets that were not counted 5631 because they had MAC-layer errors. 5633 Note that, unlike the dropEvents counter, this number is the 5634 exact number of frames dropped." 5635 ::= { ringStationControl2Entry 1 } 5637 ringStationControlCreateTime OBJECT-TYPE 5638 SYNTAX LastCreateTime 5639 MAX-ACCESS read-only 5640 STATUS deprecated 5641 DESCRIPTION 5642 "The value of sysUpTime when this control entry was last activated. 5643 This can be used by the management station to ensure that the 5644 table has not been deleted and recreated between polls." 5645 ::= { ringStationControl2Entry 2 } 5647 sourceRoutingStats2Table OBJECT-TYPE 5648 SYNTAX SEQUENCE OF SourceRoutingStats2Entry 5649 MAX-ACCESS not-accessible 5650 STATUS deprecated 5651 DESCRIPTION 5652 "Contains the RMON-2 augmentations to RMON-1. 5654 This table has been deprecated as it has not had enough 5655 independent implementations to demonstrate interoperability to 5656 meet the requirements of a Draft Standard." 5657 ::= { tokenRing 8 } 5659 sourceRoutingStats2Entry OBJECT-TYPE 5660 SYNTAX SourceRoutingStats2Entry 5661 MAX-ACCESS not-accessible 5662 STATUS deprecated 5663 DESCRIPTION 5664 "Contains the RMON-2 augmentations to RMON-1." 5665 AUGMENTS { sourceRoutingStatsEntry } 5666 ::= { sourceRoutingStats2Table 1 } 5668 SourceRoutingStats2Entry ::= SEQUENCE { 5669 sourceRoutingStatsDroppedFrames Counter32, 5670 sourceRoutingStatsCreateTime LastCreateTime 5671 } 5673 sourceRoutingStatsDroppedFrames OBJECT-TYPE 5674 SYNTAX Counter32 5675 MAX-ACCESS read-only 5676 STATUS deprecated 5677 DESCRIPTION 5678 "The total number of frames which were received by the probe 5679 and therefore not accounted for in the *StatsDropEvents, but 5680 for which the probe chose not to count for this entry for 5681 whatever reason. Most often, this event occurs when the probe 5682 is out of some resources and decides to shed load from this 5683 collection. 5685 This count does not include packets that were not counted 5686 because they had MAC-layer errors. 5688 Note that, unlike the dropEvents counter, this number is the 5689 exact number of frames dropped." 5690 ::= { sourceRoutingStats2Entry 1 } 5692 sourceRoutingStatsCreateTime OBJECT-TYPE 5693 SYNTAX LastCreateTime 5694 MAX-ACCESS read-only 5695 STATUS deprecated 5696 DESCRIPTION 5697 "The value of sysUpTime when this control entry was last activated. 5698 This can be used by the management station to ensure that the 5699 table has not been deleted and recreated between polls." 5700 ::= { sourceRoutingStats2Entry 2 } 5702 filter2Table OBJECT-TYPE 5703 SYNTAX SEQUENCE OF Filter2Entry 5704 MAX-ACCESS not-accessible 5705 STATUS current 5706 DESCRIPTION 5707 "Provides a variable-length packet filter feature to the 5708 RMON-1 filter table." 5709 ::= { filter 4 } 5711 filter2Entry OBJECT-TYPE 5712 SYNTAX Filter2Entry 5713 MAX-ACCESS not-accessible 5714 STATUS current 5715 DESCRIPTION 5716 "Provides a variable-length packet filter feature to the 5717 RMON-1 filter table." 5718 AUGMENTS { filterEntry } 5719 ::= { filter2Table 1 } 5721 Filter2Entry ::= SEQUENCE { 5722 filterProtocolDirDataLocalIndex Integer32, 5723 filterProtocolDirLocalIndex Integer32 5724 } 5726 filterProtocolDirDataLocalIndex OBJECT-TYPE 5727 SYNTAX Integer32 (0..2147483647) 5728 MAX-ACCESS read-create 5729 STATUS current 5730 DESCRIPTION 5731 "When this object is set to a non-zero value, the filter that 5732 it is associated with performs the following operations on 5733 every packet: 5735 1) - If the packet doesn't match the protocol directory entry 5736 identified by this object, discard the packet and exit 5737 (i.e., discard the packet if it is not of the identified 5738 protocol). 5739 2) - If the associated filterProtocolDirLocalIndex is non-zero 5740 and the packet doesn't match the protocol directory 5741 entry identified by that object, discard the packet and 5742 exit 5743 3) - If the packet matches, perform the regular filter 5744 algorithm as if the beginning of this named protocol is 5745 the beginning of the packet, potentially applying the 5746 filterOffset value to move further into the packet." 5747 DEFVAL { 0 } 5748 ::= { filter2Entry 1 } 5750 filterProtocolDirLocalIndex OBJECT-TYPE 5751 SYNTAX Integer32 (0..2147483647) 5752 MAX-ACCESS read-create 5753 STATUS current 5754 DESCRIPTION 5755 "When this object is set to a non-zero value, the filter that 5756 it is associated with will discard the packet if the packet 5757 doesn't match this protocol directory entry." 5759 DEFVAL { 0 } 5760 ::= { filter2Entry 2 } 5762 -- Conformance Macros 5764 rmon2MIBCompliances OBJECT IDENTIFIER ::= { rmonConformance 1 } 5765 rmon2MIBGroups OBJECT IDENTIFIER ::= { rmonConformance 2 } 5767 rmon2MIBCompliance MODULE-COMPLIANCE 5768 STATUS current 5769 DESCRIPTION 5770 "Describes the requirements for conformance to 5771 the RMON2 MIB" 5772 MODULE -- this module 5773 MANDATORY-GROUPS { protocolDirectoryGroup, 5774 protocolDistributionGroup, 5775 addressMapGroup, 5776 nlHostGroup, 5777 nlMatrixGroup, 5778 usrHistoryGroup, 5779 probeInformationGroup } 5781 OBJECT nlMatrixTopNControlRateBase 5782 SYNTAX INTEGER { 5783 nlMatrixTopNPkts(1), 5784 nlMatrixTopNOctets(2) 5785 } 5786 DESCRIPTION 5787 "Conformance to RMON2 requires only support for these 5788 values of nlMatrixTopNControlRateBase." 5790 GROUP rmon1EnhancementGroup 5791 DESCRIPTION 5792 "The rmon1EnhancementGroup is mandatory for systems 5793 which implement RMON [RFC2819]" 5794 GROUP rmon1EthernetEnhancementGroup 5795 DESCRIPTION 5796 "The rmon1EthernetEnhancementGroup is optional and is 5797 appropriate for systems that implement the Ethernet 5798 group of RMON [RFC2819]" 5799 ::= { rmon2MIBCompliances 1 } 5801 rmon2MIBApplicationLayerCompliance MODULE-COMPLIANCE 5802 STATUS current 5803 DESCRIPTION 5804 "Describes the requirements for conformance to 5805 the RMON2 MIB with Application Layer Enhancements." 5806 MODULE -- this module 5807 MANDATORY-GROUPS { protocolDirectoryGroup, 5808 protocolDistributionGroup, 5809 addressMapGroup, 5810 nlHostGroup, 5811 nlMatrixGroup, 5812 alHostGroup, 5813 alMatrixGroup, 5814 usrHistoryGroup, 5815 probeInformationGroup } 5817 OBJECT nlMatrixTopNControlRateBase 5818 SYNTAX INTEGER { 5819 nlMatrixTopNPkts(1), 5820 nlMatrixTopNOctets(2) 5821 } 5822 DESCRIPTION 5823 "Conformance to RMON2 requires only support for these 5824 values of nlMatrixTopNControlRateBase." 5826 OBJECT alMatrixTopNControlRateBase 5827 SYNTAX INTEGER { 5828 alMatrixTopNTerminalsPkts(1), 5829 alMatrixTopNTerminalsOctets(2), 5830 alMatrixTopNAllPkts(3), 5831 alMatrixTopNAllOctets(4) 5832 } 5833 DESCRIPTION 5834 "Conformance to RMON2 requires only support for these 5835 values of alMatrixTopNControlRateBase." 5837 GROUP rmon1EnhancementGroup 5838 DESCRIPTION 5839 "The rmon1EnhancementGroup is mandatory for systems 5840 which implement RMON [RFC2819]" 5841 GROUP rmon1EthernetEnhancementGroup 5842 DESCRIPTION 5843 "The rmon1EthernetEnhancementGroup is optional and is 5844 appropriate for systems that implement the Ethernet 5845 group of RMON [RFC2819]" 5846 ::= { rmon2MIBCompliances 2 } 5848 protocolDirectoryGroup OBJECT-GROUP 5849 OBJECTS { protocolDirLastChange, 5850 protocolDirLocalIndex, protocolDirDescr, 5851 protocolDirType, protocolDirAddressMapConfig, 5852 protocolDirHostConfig, protocolDirMatrixConfig, 5853 protocolDirOwner, protocolDirStatus } 5854 STATUS current 5855 DESCRIPTION 5856 "Lists the inventory of protocols the probe has the capability 5857 of monitoring and allows the addition, deletion, and 5858 configuration of entries in this list." 5859 ::= { rmon2MIBGroups 1 } 5861 protocolDistributionGroup OBJECT-GROUP 5862 OBJECTS { protocolDistControlDataSource, 5863 protocolDistControlDroppedFrames, 5864 protocolDistControlCreateTime, 5865 protocolDistControlOwner, protocolDistControlStatus, 5866 protocolDistStatsPkts, protocolDistStatsOctets } 5867 STATUS current 5868 DESCRIPTION 5869 "Collects the relative amounts of octets and packets for the 5870 different protocols detected on a network segment." 5871 ::= { rmon2MIBGroups 2 } 5873 addressMapGroup OBJECT-GROUP 5874 OBJECTS { addressMapInserts, addressMapDeletes, 5875 addressMapMaxDesiredEntries, 5876 addressMapControlDataSource, 5877 addressMapControlDroppedFrames, 5878 addressMapControlOwner, addressMapControlStatus, 5879 addressMapPhysicalAddress, 5880 addressMapLastChange } 5881 STATUS current 5882 DESCRIPTION 5883 "Lists MAC address to network address bindings discovered by 5884 the probe and what interface they were last seen on." 5885 ::= { rmon2MIBGroups 3 } 5887 nlHostGroup OBJECT-GROUP 5888 OBJECTS { hlHostControlDataSource, 5889 hlHostControlNlDroppedFrames, hlHostControlNlInserts, 5890 hlHostControlNlDeletes, 5891 hlHostControlNlMaxDesiredEntries, 5892 hlHostControlAlDroppedFrames, hlHostControlAlInserts, 5893 hlHostControlAlDeletes, 5894 hlHostControlAlMaxDesiredEntries, hlHostControlOwner, 5895 hlHostControlStatus, nlHostInPkts, nlHostOutPkts, 5896 nlHostInOctets, nlHostOutOctets, 5897 nlHostOutMacNonUnicastPkts, nlHostCreateTime } 5898 STATUS current 5899 DESCRIPTION 5900 "Counts the amount of traffic sent from and to each network 5901 address discovered by the probe. Note that while the 5902 hlHostControlTable also has objects that control an optional 5903 alHostTable, implementation of the alHostTable is not required 5904 to fully implement this group." 5905 ::= { rmon2MIBGroups 4 } 5907 nlMatrixGroup OBJECT-GROUP 5908 OBJECTS { hlMatrixControlDataSource, 5909 hlMatrixControlNlDroppedFrames, 5910 hlMatrixControlNlInserts, hlMatrixControlNlDeletes, 5911 hlMatrixControlNlMaxDesiredEntries, 5912 hlMatrixControlAlDroppedFrames, 5913 hlMatrixControlAlInserts, hlMatrixControlAlDeletes, 5914 hlMatrixControlAlMaxDesiredEntries, 5915 hlMatrixControlOwner, hlMatrixControlStatus, 5916 nlMatrixSDPkts, nlMatrixSDOctets, nlMatrixSDCreateTime, 5917 nlMatrixDSPkts, nlMatrixDSOctets, nlMatrixDSCreateTime, 5918 nlMatrixTopNControlMatrixIndex, 5919 nlMatrixTopNControlRateBase, 5920 nlMatrixTopNControlTimeRemaining, 5921 nlMatrixTopNControlGeneratedReports, 5922 nlMatrixTopNControlDuration, 5923 nlMatrixTopNControlRequestedSize, 5924 nlMatrixTopNControlGrantedSize, 5925 nlMatrixTopNControlStartTime, 5926 nlMatrixTopNControlOwner, nlMatrixTopNControlStatus, 5927 nlMatrixTopNProtocolDirLocalIndex, 5928 nlMatrixTopNSourceAddress, nlMatrixTopNDestAddress, 5929 nlMatrixTopNPktRate, nlMatrixTopNReversePktRate, 5930 nlMatrixTopNOctetRate, nlMatrixTopNReverseOctetRate } 5931 STATUS current 5932 DESCRIPTION 5933 "Counts the amount of traffic sent between each pair of 5934 network addresses discovered by the probe. Note that while the 5935 hlMatrixControlTable also has objects that control optional 5936 alMatrixTables, implementation of the alMatrixTables is not 5937 required to fully implement this group." 5939 ::= { rmon2MIBGroups 5 } 5941 alHostGroup OBJECT-GROUP 5942 OBJECTS { alHostInPkts, alHostOutPkts, 5943 alHostInOctets, alHostOutOctets, alHostCreateTime } 5944 STATUS current 5945 DESCRIPTION 5946 "Counts the amount of traffic, by protocol, sent from and to 5947 each network address discovered by the probe. Implementation 5948 of this group requires implementation of the Network Layer 5949 Host Group." 5950 ::= { rmon2MIBGroups 6 } 5952 alMatrixGroup OBJECT-GROUP 5953 OBJECTS { alMatrixSDPkts, alMatrixSDOctets, alMatrixSDCreateTime, 5954 alMatrixDSPkts, alMatrixDSOctets, alMatrixDSCreateTime, 5955 alMatrixTopNControlMatrixIndex, 5956 alMatrixTopNControlRateBase, 5957 alMatrixTopNControlTimeRemaining, 5958 alMatrixTopNControlGeneratedReports, 5959 alMatrixTopNControlDuration, 5960 alMatrixTopNControlRequestedSize, 5961 alMatrixTopNControlGrantedSize, 5962 alMatrixTopNControlStartTime, 5963 alMatrixTopNControlOwner, alMatrixTopNControlStatus, 5964 alMatrixTopNProtocolDirLocalIndex, 5965 alMatrixTopNSourceAddress, alMatrixTopNDestAddress, 5966 alMatrixTopNAppProtocolDirLocalIndex, 5967 alMatrixTopNPktRate, alMatrixTopNReversePktRate, 5968 alMatrixTopNOctetRate, alMatrixTopNReverseOctetRate } 5969 STATUS current 5970 DESCRIPTION 5971 "Counts the amount of traffic, by protocol, sent between each 5972 pair of network addresses discovered by the 5973 probe. Implementation of this group requires implementation of 5974 the Network Layer Matrix Group." 5975 ::= { rmon2MIBGroups 7 } 5977 usrHistoryGroup OBJECT-GROUP 5978 OBJECTS { usrHistoryControlObjects, 5979 usrHistoryControlBucketsRequested, 5980 usrHistoryControlBucketsGranted, 5981 usrHistoryControlInterval, 5982 usrHistoryControlOwner, usrHistoryControlStatus, 5983 usrHistoryObjectVariable, usrHistoryObjectSampleType, 5984 usrHistoryIntervalStart, usrHistoryIntervalEnd, 5985 usrHistoryAbsValue, usrHistoryValStatus } 5986 STATUS current 5987 DESCRIPTION 5988 "The usrHistoryGroup provides user-defined collection of 5989 historical information from MIB objects on the probe." 5990 ::= { rmon2MIBGroups 8 } 5992 probeInformationGroup OBJECT-GROUP 5993 OBJECTS { probeCapabilities, 5994 probeSoftwareRev, probeHardwareRev, probeDateTime } 5995 STATUS current 5996 DESCRIPTION 5997 "This group describes various operating parameters of the 5998 probe as well as controlling the local time of the probe." 5999 ::= { rmon2MIBGroups 9 } 6001 probeConfigurationGroup OBJECT-GROUP 6002 OBJECTS { probeResetControl, probeDownloadFile, 6003 probeDownloadTFTPServer, probeDownloadAction, 6004 probeDownloadStatus, 6005 serialMode, serialProtocol, serialTimeout, 6006 serialModemInitString, serialModemHangUpString, 6007 serialModemConnectResp, serialModemNoConnectResp, 6008 serialDialoutTimeout, serialStatus, 6009 netConfigIPAddress, netConfigSubnetMask, 6010 netConfigStatus, netDefaultGateway, 6011 trapDestCommunity, trapDestProtocol, trapDestAddress, 6012 trapDestOwner, trapDestStatus, 6013 serialConnectDestIpAddress, serialConnectType, 6014 serialConnectDialString, serialConnectSwitchConnectSeq, 6015 serialConnectSwitchDisconnectSeq, 6016 serialConnectSwitchResetSeq, 6017 serialConnectOwner, serialConnectStatus } 6018 STATUS deprecated 6019 DESCRIPTION 6020 "This group controls the configuration of various operating 6021 parameters of the probe." 6022 ::= { rmon2MIBGroups 10 } 6024 rmon1EnhancementGroup OBJECT-GROUP 6025 OBJECTS { historyControlDroppedFrames, hostControlDroppedFrames, 6026 hostControlCreateTime, matrixControlDroppedFrames, 6027 matrixControlCreateTime, channelDroppedFrames, 6028 channelCreateTime, filterProtocolDirDataLocalIndex, 6029 filterProtocolDirLocalIndex } 6030 STATUS current 6031 DESCRIPTION 6032 "This group adds some enhancements to RMON-1 that help 6033 management stations." 6034 ::= { rmon2MIBGroups 11 } 6036 rmon1EthernetEnhancementGroup OBJECT-GROUP 6037 OBJECTS { etherStatsDroppedFrames, etherStatsCreateTime } 6038 STATUS current 6039 DESCRIPTION 6040 "This group adds some enhancements to RMON-1 that help 6041 management stations." 6042 ::= { rmon2MIBGroups 12 } 6044 rmon1TokenRingEnhancementGroup OBJECT-GROUP 6045 OBJECTS { tokenRingMLStatsDroppedFrames, 6046 tokenRingMLStatsCreateTime, 6047 tokenRingPStatsDroppedFrames, tokenRingPStatsCreateTime, 6048 ringStationControlDroppedFrames, 6049 ringStationControlCreateTime, 6050 sourceRoutingStatsDroppedFrames, 6051 sourceRoutingStatsCreateTime } 6052 STATUS deprecated 6053 DESCRIPTION 6054 "This group adds some enhancements to RMON-1 that help 6055 management stations." 6056 ::= { rmon2MIBGroups 13 } 6057 END 6058 7. Security Considerations 6060 In order to implement this MIB, a probe must capture all 6061 packets on the locally-attached network, including packets 6062 between third parties. These packets are analyzed to collect 6063 network addresses, protocol usage information, and 6064 conversation statistics. Data of this nature may be considered 6065 sensitive in some environments. In such environments the 6066 administrator may wish to restrict SNMP access to the probe. 6068 The usrHistoryGroup periodically samples the values of user- 6069 specified variables on the probe and stores them in another 6070 table. Since the access-control specified for stored snapshot 6071 may be different than the access-control for the sampled 6072 variable, the agent MUST ensure that usrHistoryObjectVariable 6073 is not writable in MIB views that don't already have read 6074 access to the entire agent. Because the access control 6075 configuration can change over time, information could later be 6076 deemed sensitive that would still be accessible to this 6077 function. For this reason, an agent SHOULD check the access 6078 control on every sample. If an agent doesn't implement the 6079 latter check, there is a potential for sensitive information 6080 to be revealed. 6082 A probe implementing this MIB is likely to also implement RMON 6083 [RFC2819], which includes functions for returning the contents 6084 of captured packets, potentially including sensitive user data 6085 or passwords. It is recommended that SNMP access to these 6086 functions be restricted. 6088 There are a number of management objects defined in this MIB 6089 that have a MAX-ACCESS clause of read-write and/or read- 6090 create. Such objects may be considered sensitive or 6091 vulnerable in some network environments. The support for SET 6092 operations in a non-secure environment without proper 6093 protection can have a negative effect on network operations. 6095 SNMPv1 by itself is not a secure environment. Even if the 6096 network itself is secure (for example by using IPSec), even 6097 then, there is no control as to who on the secure network is 6098 allowed to access and GET/SET (read/change/create/delete) the 6099 objects in this MIB. 6101 It is recommended that the implementors consider the security 6102 features as provided by the SNMPv3 framework. Specifically, 6103 the use of the User-based Security Model RFC 2574 [RFC3414] 6104 and the View-based Access Control Model RFC 2575 [RFC3415] is 6105 recommended. 6107 It is then a customer/user responsibility to ensure that the 6108 SNMP entity giving access to an instance of this MIB, is 6109 properly configured to give access to the objects only to 6110 those principals (users) that have legitimate rights to indeed 6111 GET or SET (change/create/delete) them. 6113 8. Appendix - TimeFilter Implementation Notes 6115 1) Theory of Operation 6117 The TimeFilter mechanism allows an NMS to reduce the number of 6118 SNMP transactions required for a 'table-update' operation. 6119 Polling of tables that incorporate a 'TimeFilter' INDEX can be 6120 reduced to a theoretical minimum (if used correctly). It can 6121 be easily implemented by an agent in a way independent of the 6122 number of NMS applications using the same time-filtered table. 6124 Although the name 'TimeFilter' may imply that a history of 6125 change events is maintained by the agent, this is not the 6126 case. A time-filtered-value represents the current value of 6127 the object instance, not the 'saved' value at the time 6128 indicated by the TimeFilter INDEX value. Note that TimeFilter 6129 objects only appear in INDEX clauses (always not-accessible), 6130 so their value is never retrieved. By design, the actual value 6131 of a TimeFilter instance is not in itself meaningful (it's not 6132 a 'last-change-timestamp'). 6134 The TimeFilter is a boolean filtering function applied in 6135 internal Get* PDU processing. If the 'last-change-time' of the 6136 specified instance is less than the particular TimeFilter 6137 INDEX value, then the instance is considered 'not-present' 6138 (skipped for GetNext and GetBulk PDUs; 'noSuchInstance' or 6139 returned to the requester. 6141 1.1) Agent Implementation of a Time-Filtered Table 6143 In implementation, the time-filtered rows (one for each tick 6144 of sysUpTime) are only conceptual. The agent simply filters a 6145 real table based on: 6146 * the current value of sysUpTime 6147 * the TimeFilter value passed in the varbind 6148 * the last-update timestamp of each requested counter 6149 (agent implementation requirement) 6151 For example, to implement a time-filtered counter, an agent 6152 maintains a timestamp in a 32-bit storage location, 6153 initialized to zero. This is in addition to whatever 6154 instrumentation is needed for the counter. 6156 Each time the counter is updated, the current value of 6157 sysUpTime is recorded in the associated timestamp. If this is 6158 not possible or practical, then a background polling process 6159 must 'refresh' the timestamp by sampling counter values and 6160 comparing them to recorded samples. The timestamp update must 6161 occur within 5 seconds of the actual change event. 6163 When an agent receives a Get, GetNext, or GetBulk PDU 6164 requesting a time-filtered instance, the following agent has 6165 determined that the instance is within the MIB view indicated 6166 by the community string in the PDU. 6168 /* return TRUE if the object is present */ 6169 boolean time_filter_test ( 6170 TimeFilter last_modified_timestamp, 6171 TimeFilter index_value_in_pdu ) 6172 { 6173 if (last_modified_timestamp < index_value_in_pdu) 6174 return FALSE; 6175 else 6176 return TRUE; 6177 } 6179 The agent applies this function regardless of the 6180 lastActivationTime of the conceptual row in question. In other 6181 words, counter discontinuities are ignored (i.e. conceptual 6182 row deleted and then re-created later). An agent should 6183 consider a object instance 'changed' when it is created 6184 (either at restart time for scalars and static objects, or 6185 row-creation-time for dynamic tables). 6187 Note that using a timeFilter INDEX value of zero removes the 6188 filtering functionality, as the instance will always be 6189 'present' according to the test above. 6191 1.2) NMS Implementation of a Time-Filtered Table 6193 The particular TimeFilter INDEX values used by an NMS reflect 6194 the polling interval of the NMS, relative to the particular 6195 agent's notion of sysUpTime. 6197 An NMS needs to maintain one timestamp variable per agent 6198 (initialized to zero) for an arbitrary group of time-filtered 6199 MIB objects that are gathered together in the same PDU. Each 6200 time the Get* PDU is sent, a request for sysUpTime is 6201 included. The retrieved sysUpTime value is used as the 6202 timeFilter value in the next polling cycle. If a polling sweep 6203 of a time-filtered group of objects requires more than one 6204 SNMP transaction, then the sysUpTime value retrieved in the 6205 first GetResponse PDU of the polling sweep is saved as the 6206 next timeFilter value. 6208 The actual last-update time of a given object is not indicated 6209 in the returned GetResponse instance identifier, but rather 6210 the timeFilter value passed in the Get*Request PDU is 6211 returned. 6213 A "time-filtered get-next/bulk-sweep", done once per polling 6214 cycle, is a series of GetNext or GetBulk transactions, and is 6215 over when one of the following events occurs: 6216 1) the TimeFilter index value returned in the GetResponse is 6217 different than the TimeFilter index value passed in the 6218 GetNext or GetBulk request. Counter values will still be 6219 returned beyond this point (until the last-change-time is 6220 reached), but most likely the same values will be 6221 returned. 6222 2) the return PDU includes instances lexigraphically greater 6223 than the objects expected (i.e. same GetNext semantics as 6224 if the TimeFilter wasn't there) 6225 3) a noSuchName or other exception/error is returned. 6227 Note that the use of a time-filtered table in combination with 6228 a GetRequest PDU neutralizes any optimization that otherwise 6229 might be achieved with the TimeFilter, because no PDU 6230 transactions are saved. Either the current time-filtered 6231 object-value is returned, or a 'noSuchInstance' exception 6232 (SNMPv1c) or 'noSuchName' error (SNMPv1) is returned. 6234 If GetBulk PDUs are used, then the value selected for response 6235 PDUs generated by the agent, since duplicate entries (one per 6236 'tick' of sysUpTime) are likely to pad the PDU to its maximum 6237 size. An appropriate of conceptual rows in the time-filtered 6238 table if known, or equal to the number of instances expected 6239 to fit in a GetResponse PDU without causing a 'tooBig' error 6240 from the agent. 6242 2) TimeFilter Example 6244 The following example demonstrates how an NMS and Agent might 6245 use a table with a TimeFilter object in the INDEX. A static 6246 table is assumed to keep the example simple, but dynamic 6247 tables can also be supported. 6249 2.1) General Assumptions 6251 fooEntry INDEX { fooTimeMark, fooIfIndex } 6252 FooEntry = SEQUENCE { 6253 fooTimeMark TimeFilter, 6254 fooIfIndex Integer32, 6255 fooCounts Counter32 6256 } 6258 The NMS polls the fooTable every 15 seconds and the 6259 baseline poll occurs when the agent has been up for 6260 6 seconds, and the NMS has been up for 10 seconds. 6262 There are 2 static rows in this table at system 6263 initialization (fooCounts.0.1 and fooCounts.0.2). 6265 Row 1 was updated as follows: 6266 SysUpTime fooCounts.*.1 value 6267 500 1 6268 900 2 6269 2300 3 6271 Row 2 was updated as follows: 6272 SysUpTime fooCounts.*.2 value 6273 1100 1 6274 1400 2 6276 2.2) SNMP Transactions from NMS Perspective 6278 Time nms-1000: 6279 # NMS baseline poll -- get everything since last agent 6280 # restart - TimeFilter == 0 6282 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6283 fooCounts.0); 6284 returns: 6285 sysUpTime.0 == 600 6286 fooCounts.0.1 == 1 # incremented at time 500 6287 fooCounts.0.2 == 0 # visible since created at time 6288 0 6290 Time nms-2500: 6291 # NMS 1st poll 6292 # TimeFilter index == 600 6293 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6294 fooCounts.600); 6295 returns: 6296 sysUpTime.0 == 2100 6297 fooCounts.600.1 == 2 # incremented at time 900 6298 fooCounts.600.2 == 2 # incremented at times 6299 # 1100 and 1400 6300 fooCounts.601.1 == 2 # indicates end of sweep 6302 Time nms-4000: 6303 # NMS 2nd poll 6304 # TimeFilter == 2100 6306 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6307 fooCounts.2100); 6308 returns: 6309 sysUpTime.0 == 3600 6310 fooCounts.2100.1 == 3 # incremented at time 2300 6311 fooCounts.2102.1 == 3 # indicates end-of-sweep 6313 # the counter value for row 2 is not returned because 6314 # it hasn't changed since sysUpTime == 2100. 6315 # The next timetick value for row 1 is returned instead 6317 Time nms-5500: 6318 # NMS 3rd poll 6319 # TimeFilter == 3600 6321 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6322 fooCounts.3600); 6323 returns: 6324 sysUpTime.0 == 5100 6325 some-instance-outside-the-fooTable == 6326 some-instance-outside-the-fooTable == 6328 # no 'fooTable' counter values at all are returned 6329 # because neither counter has been updated since 6330 # sysUpTime == 3600 6332 2.3) Transactions and TimeFilter Maintenance: Agent 6333 Perspective 6335 Time agt-0: 6336 # initialize fooTable 6337 fooCounts.1 = 0; changed.1 = 0; 6338 fooCounts.2 = 0; changed.2 = 0; 6340 Time agt-500: 6341 # increment fooCounts.1 6342 ++fooCounts.1; changed.1 = 500; 6344 Time agt-600 6345 # answer get-bulk 6346 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6347 # fooCounts.0); 6348 # (changed >= 0) 6349 # return both counters 6351 Time agt-900: 6352 # increment fooCounts.1 6353 ++fooCounts.1; changed.1 = 900; 6355 Time agt-1100: 6356 # increment fooCounts.2 6357 ++fooCounts.2; changed.2 = 1100; 6359 Time agt-1400: 6360 # increment fooCounts.2 6361 ++fooCounts.2; changed.2 = 1400; 6363 Time agt-2100 6364 # answer get-bulk 6365 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6366 # fooCounts.600); 6367 # (changed >= 600) 6368 # return both counters 6370 Time agt-2300: 6371 # increment fooCounts.1 6372 ++fooCounts.1; changed.1 = 2300; 6374 Time agt-3600: 6375 # answer get-bulk 6376 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6377 # fooCounts.2100); 6378 # (changed >= 2100) 6379 # return only fooCounts.1 from the fooTable--twice 6381 Time agt-5100: 6383 # answer get-bulk 6384 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6385 # fooCounts.3600); 6386 # (changed >= 3600) 6387 # return lexigraphically-next two MIB instances 6389 9. Changes since RFC 2021 6391 This version updates the proposed-standard version of the 6392 RMON2 MIB (published as RFC 2021) by adding 2 new enumerations 6393 to the nlMatrixTopNControlRateBase object and 4 new 6394 enumerations to the alMatrixTopNControlRateBase object. These 6395 new enumerations support the creation of high capacity topN 6396 reports in the High Capacity RMON MIB [RFC3273]. 6398 Additionally, the following object have been deprecated as 6399 they have not had enough independent implementations to 6400 demonstrate interoperability to meet the requirements of a 6401 Draft Standard: 6403 probeDownloadFile 6404 probeDownloadTFTPServer 6405 probeDownloadAction 6406 probeDownloadStatus 6407 serialMode 6408 serialProtocol 6409 serialTimeout 6410 serialModemInitString 6411 serialModemHangUpString 6412 serialModemConnectResp 6413 serialModemNoConnectResp 6414 serialDialoutTimeout 6415 serialStatus 6416 serialConnectDestIpAddress 6417 serialConnectType 6418 serialConnectDialString 6419 serialConnectSwitchConnectSeq 6420 serialConnectSwitchDisconnectSeq 6421 serialConnectSwitchResetSeq 6422 serialConnectOwner 6423 serialConnectStatus 6424 netConfigIPAddress 6425 netConfigSubnetMask 6426 netConfigStatus 6427 netDefaultGateway 6428 tokenRingMLStats2DroppedFrames 6429 tokenRingMLStats2CreateTime 6430 tokenRingPStats2DroppedFrames 6431 tokenRingPStats2CreateTime 6432 ringStationControl2DroppedFrames 6433 ringStationControl2CreateTime 6434 sourceRoutingStats2DroppedFrames 6435 sourceRoutingStats2CreateTime 6437 In addition, two corrections were made. The LastCreateTime 6438 Textual Convention had been defined with a base type of 6439 another textual convention which isn't allowed in SMIv2. The 6440 definition has been modified to use TimeTicks as the base 6441 type. 6443 Further, the SerialConfigEntry SEQUENCE definition included 6444 sub-typing information that is not allowed in SMIv2. This 6445 information has been deleted. Ranges were added to a number of 6446 objects and textual-conventions to constrain their maximum 6447 (and sometimes minimum) sizes: 6448 ControlString 6449 protocolDirID 6450 protocolDirParameters 6451 addressMapNetworkAddress 6452 nlHostAddress 6453 nlMatrixSDSourceAddress 6454 nlMatrixSDDestAddress 6455 nlMatrixDSSourceAddress 6456 nlMatrixDSDestAddress 6457 nlMatrixTopNSourceAddress 6458 nlMatrixTopNDestAddress 6459 alHostEntry 6460 alMatrixSDEntry 6461 alMatrixDSEntry 6462 alMatrixTopNSourceAddress 6463 alMatrixTopNDestAddress 6465 10. Acknowledgments 6467 This document was produced by the IETF Remote Network 6468 Monitoring Working Group. 6470 The TimeFilter mechanism was invented and documented by Jeanne 6471 Haney. 6473 The User History group was created by Andy Bierman. 6475 11. Author's Address 6477 Steve Waldbusser 6479 Phone: +1 650-948-6500 6480 Fax: +1 650-745-0671 6481 EMail: waldbusser@nextbeacon.com 6482 12. References 6484 12.1. Normative References 6486 [RFC2578] 6487 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6488 Rose, M. and S. Waldbusser, "Structure of Management 6489 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 6490 1999. 6492 [RFC2579] 6493 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6494 Rose, M. and S. Waldbusser, "Textual Conventions for 6495 SMIv2", STD 58, RFC 2579, April 1999. 6497 [RFC2580] 6498 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6499 Rose, M. and S. Waldbusser, "Conformance Statements for 6500 SMIv2", STD 58, RFC 2580, April 1999. 6502 [RFC2819] 6503 Waldbusser, S., "Remote Network Monitoring MIB", RFC 6504 2819, Lucent Technologies, May 2000. 6506 [RFC3273] 6507 Waldbusser, S., "RMON for High Capacity Networks", RFC 6508 3273, July 2002. 6510 12.2. Informative References 6512 [RFC3410] 6513 Case, J., Mundy, R., Partain, D. and B. Stewart, 6514 "Introduction and Applicability Statements for Internet 6515 Standard Management Framework", RFC 3410, December 2002. 6517 [RFC3411] 6518 Harrington, D., Presuhn, R., and B. Wijnen, "An 6519 Architecture for Describing SNMP Management Frameworks", 6520 STD 62. RFC 3411, December 2002. 6522 [RFC2863] 6523 McCloghrie, K. and F. Kastenholz, "The Interfaces Group 6524 MIB", RFC 2863, Cisco Systems, Argon Networks, June 2000. 6526 [RFC1513] 6527 Waldbusser, S., "Token Ring Extensions to the Remote 6528 Network Monitoring MIB", RFC 1513, September 1993. 6530 [RFC2108] 6531 De Graaf, K., Romascanu, D., McMaster, D. and K. 6532 McCloghrie, "Definition of Managed Objects for IEEE 802.3 6533 Repeater Devices using SMIv2", RFC 2108, February 1997. 6535 [RFC3414] 6536 Blumenthal, U. and B. Wijnen, "The User-Based Security 6537 Model (USM) for Version 3 of the Simple Network 6538 Management Protocol (SNMPv3)", STD 62, RFC 3414, December 6539 2002. 6541 [RFC3415] 6542 Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based 6543 Access Control Model (VACM) for the Simple Network 6544 Management Protocol (SNMP)", STD 62, RFC 3415, December 6545 2002. 6547 13. Full Copyright Statement 6549 Copyright (C) The Internet Society (2004). 6551 This document is subject to the rights, licenses and 6552 restrictions contained in BCP 78, and except as set forth 6553 therein, the authors retain all their rights. 6555 This document and the information contained herein are 6556 provided on an "AS IS" basis and THE CONTRIBUTOR, THE 6557 ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), 6558 THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE 6559 DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 6560 LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN 6561 WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 6562 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 6564 Intellectual Property 6566 The IETF takes no position regarding the validity or scope of 6567 any Intellectual Property Rights or other rights that might be 6568 claimed to pertain to the implementation or use of the 6569 technology described in this document or the extent to which 6570 any license under such rights might or might not be available; 6571 nor does it represent that it has made any independent effort 6572 to identify any such rights. Information on the procedures 6573 with respect to rights in RFC documents can be found in BCP 78 6574 and BCP 79. 6576 Copies of IPR disclosures made to the IETF Secretariat and any 6577 assurances of licenses to be made available, or the result of 6578 an attempt made to obtain a general license or permission for 6579 the use of such proprietary rights by implementers or users of 6580 this specification can be obtained from the IETF on-line IPR 6581 repository at http://www.ietf.org/ipr. 6583 The IETF invites any interested party to bring to its 6584 attention any copyrights, patents or patent applications, or 6585 other proprietary rights that may cover technology that may be 6586 required to implement this standard. Please address the 6587 information to the IETF at ietf-ipr@ietf.org. 6589 Table of Contents 6591 1 The Internet-Standard Management Framework ............ 3 6592 2 Overview .............................................. 4 6593 2.1 Remote Network Management Goals ..................... 4 6594 2.2 Structure of MIB .................................... 6 6595 3 Control of Remote Network Monitoring Devices .......... 8 6596 3.1 Resource Sharing Among Multiple Management Sta- 6597 tions .............................................. 8 6598 3.2 Row Addition Among Multiple Management Stations ..... 10 6599 4 Conventions ........................................... 12 6600 5 RMON 2 Conventions .................................... 13 6601 5.1 Usage of the term Application Level ................. 13 6602 5.2 Protocol Directory and Limited Extensibility ........ 13 6603 5.3 Errors in packets ................................... 14 6604 6 Definitions ........................................... 14 6605 7 Security Considerations ............................... 140 6606 8 Appendix - TimeFilter Implementation Notes ............ 142 6607 9 Changes since RFC 2021 ................................ 148 6608 10 Acknowledgments ...................................... 150 6609 11 Author's Address ..................................... 150 6610 12 References ........................................... 151 6611 12.1 Normative References ............................... 151 6612 12.2 Informative References ............................. 151 6613 13 Full Copyright Statement ............................. 152