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