idnits 2.17.1 draft-ietf-rmonmib-rmon2-v2-04.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 6641. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 6653. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 6660. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 6666. ** 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. == 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 4386: '...ryObjectVariable SHOULD be checked for...' RFC 2119 keyword, line 6103: '...iable, the agent MUST ensure that usrH...' RFC 2119 keyword, line 6108: '...reason, an agent SHOULD check the acce...' RFC 2119 keyword, line 6139: '...It is RECOMMENDED that implementers co...' RFC 2119 keyword, line 6145: '... 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 4545 has weird spacing: '... field octet...' == Line 4800 has weird spacing: '...se code bps...' == Line 5037 has weird spacing: '... octets cont...' == Line 5047 has weird spacing: '... octets cont...' == Line 5049 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 (August 21, 2005) is 6823 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) ** Downref: Normative reference to an Historic RFC: RFC 1513 Summary: 7 errors (**), 0 flaws (~~), 8 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 August 21, 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 Internet-Drafts are draft documents valid for a maximum of 30 six months and may be updated, replaced, or obsoleted by 31 other documents at any time. It is inappropriate to use 32 Internet-Drafts as reference material or to cite them other 33 than as "work in progress." 35 The list of current Internet-Drafts can be accessed at 36 http://www.ietf.org/ietf/1id-abstracts.txt. 38 The list of Internet-Draft Shadow Directories can be 39 accessed at http://www.ietf.org/shadow.html. 41 This Internet-Draft will expire on February 21, 2006. 43 Distribution of this document is unlimited. Please send 44 comments to the RMON WG mailing list . 46 Copyright Notice 48 Copyright (C) The Internet Society (2005). 50 Abstract 52 This document defines a portion of the Management 53 Information Base (MIB) for use with network management 54 protocols in TCP/IP-based internets. In particular, it 55 defines objects for managing remote network monitoring 56 devices. 58 This document obsoletes RFC 2021 and the RMON2-MIB module 59 contained in this memo obsoletes the RMON2-MIB module at 60 RFC3273 level. 62 XXX Note To RFC Editor: 63 Please replace the module at: 64 ftp://ftp.rfc-editor.org/in-notes/mibs/current.mibs/rmon2.mib 65 with the RMON2-MIB module in this document 66 XXX 68 Table of Contents 70 1 The Internet-Standard Management Framework ............ 4 71 2 Overview .............................................. 5 72 2.1 Remote Network Management Goals ..................... 5 73 2.2 Structure of MIB .................................... 7 74 3 Control of Remote Network Monitoring Devices .......... 9 75 3.1 Resource Sharing Among Multiple Management Sta- 76 tions .............................................. 9 77 3.2 Row Addition Among Multiple Management Stations ..... 11 78 4 Conventions ........................................... 14 79 5 RMON 2 Conventions .................................... 15 80 5.1 Usage of the term Application Level ................. 15 81 5.2 Protocol Directory and Limited Extensibility ........ 15 82 5.3 Errors in packets ................................... 16 83 6 Definitions ........................................... 16 84 7 Security Considerations ............................... 146 85 8 IANA Considerations ................................... 147 86 9 Appendix - TimeFilter Implementation Notes ............ 148 87 10 Changes since RFC 2021 ............................... 154 88 11 Acknowledgments ...................................... 157 89 12 Author's Address ..................................... 157 90 13 References ........................................... 158 91 13.1 Normative References ............................... 158 92 13.2 Informative References ............................. 159 93 14 Full Copyright Statement ............................. 159 95 1. The Internet-Standard Management Framework 97 For a detailed overview of the documents that describe the 98 current Internet-Standard Management Framework, please 99 refer to section 7 of RFC 3410 [RFC3410]. 101 Managed objects are accessed via a virtual information 102 store, termed the Management Information Base or MIB. MIB 103 objects are generally accessed through the Simple Network 104 Management Protocol (SNMP). Objects in the MIB are defined 105 using the mechanisms defined in the Structure of Management 106 Information (SMI). This memo specifies a MIB module that 107 is compliant to the SMIv2, which is described in STD 58, 108 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, 109 RFC 2580 [RFC2580]. 111 2. Overview 113 The RMON2 MIB defines objects that provide RMON analysis up to 114 the application layer. 116 Remote network monitoring devices, often called monitors or 117 probes, are instruments that exist for the purpose of managing 118 a network. Often these remote probes are stand-alone devices 119 and devote significant internal resources for the sole purpose 120 of managing a network. An organization may employ many of 121 these devices, one per network segment, to manage its 122 internet. In addition, these devices may be used for a 123 network management service provider to access a client 124 network, often geographically remote. 126 The objects defined in this document are intended as an 127 interface between an RMON agent and an RMON management 128 application and are not intended for direct manipulation by 129 humans. While some users may tolerate the direct display of 130 some of these objects, few will tolerate the complexity of 131 manually manipulating objects to accomplish row creation. 132 These functions should be handled by the management 133 application. 135 2.1. Remote Network Management Goals 137 o Offline Operation 138 There are sometimes conditions when a management 139 station will not be in constant contact with its 140 remote monitoring devices. This is sometimes by 141 design in an attempt to lower communications costs 142 (especially when communicating over a WAN or 143 dialup link), or by accident as network failures 144 affect the communications between the management 145 station and the probe. 147 For this reason, this MIB allows a probe to be 148 configured to perform diagnostics and to collect 149 statistics continuously, even when communication with 150 the management station may not be possible or 151 efficient. The probe may then attempt to notify 152 the management station when an exceptional condition 153 occurs. Thus, even in circumstances where 154 communication between management station and probe is 155 not continuous, fault, performance, and configuration 156 information may be continuously accumulated and 157 communicated to the management station conveniently 158 and efficiently. 160 o Proactive Monitoring 161 Given the resources available on the monitor, it 162 is potentially helpful for it continuously to run 163 diagnostics and to log network performance. The 164 monitor is always available at the onset of any 165 failure. It can notify the management station of the 166 failure and can store historical statistical 167 information about the failure. This historical 168 information can be played back by the management 169 station in an attempt to perform further diagnosis 170 into the cause of the problem. 172 o Problem Detection and Reporting 173 The monitor can be configured to recognize 174 conditions, most notably error conditions, and 175 continuously to check for them. When one of these 176 conditions occurs, the event may be logged, and 177 management stations may be notified in a number of 178 ways. 180 o Value Added Data 181 Because a remote monitoring device represents a 182 network resource dedicated exclusively to network 183 management functions, and because it is located 184 directly on the monitored portion of the network, the 185 remote network monitoring device has the opportunity 186 to add significant value to the data it collects. 187 For instance, by highlighting those hosts on the 188 network that generate the most traffic or errors, the 189 probe can give the management station precisely the 190 information it needs to solve a class of problems. 192 o Multiple Managers 193 An organization may have multiple management stations 194 for different units of the organization, for different 195 functions (e.g. engineering and operations), and in an 196 attempt to provide disaster recovery. Because 197 environments with multiple management stations are 198 common, the remote network monitoring device has to 199 deal with more than own management station, 200 potentially using its resources concurrently. 202 2.2. Structure of MIB 204 The objects are arranged into the following groups: 206 - protocol directory 208 - protocol distribution 210 - address mapping 212 - network layer host 214 - network layer matrix 216 - application layer host 218 - application layer matrix 220 - user history 222 - probe configuration 224 These groups are the basic units of conformance. If a remote 225 monitoring device implements a group, then it must implement 226 all objects in that group. For example, a managed agent that 227 implements the network layer matrix group must implement the 228 nlMatrixSDTable and the nlMatrixDSTable. 230 Implementations of this MIB must also implement the IF-MIB 231 [RFC2863]. 233 These groups are defined to provide a means of assigning 234 object identifiers, and to provide a method for managed agents 235 to know which objects they must implement. 237 This document also contains enhancements to tables defined in 238 the RMON MIB [RFC2819]. These enhancements include: 240 1) Adding the DroppedFrames and LastCreateTime 241 conventions to each table defined in the RMON MIB. 243 2) Augmenting the RMON filter table with a mechanism 244 that allows filtering based on an offset from the 245 beginning of a particular protocol, even if the 246 protocol headers are variable length. 248 3) Augmenting the RMON filter and capture status bits 249 with additional bits for WAN media and generic media. 250 These bits are defined here as: 252 Bit Definition 253 6 For WAN media, this bit is set for packets 254 coming from one direction and cleared for 255 packets coming from the other direction. 256 It is an implementation specific matter 257 as to which bit is assigned to which 258 direction, but it must be consistent for 259 all packets received by the agent, and if 260 the agent knows which end of the link is 261 "local" and which end is "network", the bit 262 should be set for packets from the "local" 263 side and should be cleared for packets from 264 the "network" side. 266 7 For any media, this bit is set for any packet 267 with a physical layer error. This bit may be 268 set in addition to other media-specific bits 269 that denote the same condition. 271 8 For any media, this bit is set for any packet 272 that is too short for the media. This bit may 273 be set in addition to other media-specific 274 bits that denote the same condition. 275 9 For any media, this bit is set for any packet 276 that is too long for the media. This bit may 277 be set in addition to other media-specific bits 278 that denote the same condition. 280 These enhancements are implemented by RMON-2 probes that also 281 implement RMON and do not add any requirements to probes that 282 are compliant to just RMON. 284 3. Control of Remote Network Monitoring Devices 286 Due to the complex nature of the available functions in these 287 devices, the functions often need user configuration. In many 288 cases, the function requires parameters to be set up for a 289 data collection operation. The operation can proceed only 290 after these parameters are fully set up. 292 Many functional groups in this MIB have one or more tables in 293 which to set up control parameters, and one or more data 294 tables in which to place the results of the operation. The 295 control tables are typically read/write in nature, while the 296 data tables are typically read/only. Because the parameters 297 in the control table often describe resulting data in the data 298 table, many of the parameters can be modified only when the 299 control entry is not active. Thus, the method for modifying 300 these parameters is to de-activate the entry, perform the SNMP 301 Set operations to modify the entry, and then re-activate the 302 entry. Deleting the control entry causes the deletion of any 303 associated data entries, which also gives a convenient method 304 for reclaiming the resources used by the associated data. 306 Some objects in this MIB provide a mechanism to execute an 307 action on the remote monitoring device. These objects may 308 execute an action as a result of a change in the state of the 309 object. For those objects in this MIB, a request to set an 310 object to the same value as it currently holds would thus 311 cause no action to occur. 313 To facilitate control by multiple managers, resources have to 314 be shared among the managers. These resources are typically 315 the memory and computation resources that a function requires. 317 3.1. Resource Sharing Among Multiple Management Stations 319 When multiple management stations wish to use functions that 320 compete for a finite amount of resources on a device, a method 321 to facilitate this sharing of resources is required. 322 Potential conflicts include: 324 o Two management stations wish to simultaneously use 325 resources that together would exceed the capability of 326 the device. 328 o A management station uses a significant amount of 329 resources for a long period of time. 330 o A management station uses resources and then crashes, 331 forgetting to free the resources so others may 332 use them. 334 The OwnerString mechanism is provided for each management 335 station initiated function in this MIB to avoid these 336 conflicts and to help resolve them when they occur. Each 337 function has a label identifying the initiator (owner) of the 338 function. This label is set by the initiator to provide for 339 the following possibilities: 341 o A management station may recognize resources it owns 342 and no longer needs. 343 o A network operator can find the management station that 344 owns the resource and negotiate for it to be freed. 345 o A network operator may decide to unilaterally free 346 resources another network operator has reserved. 347 o Upon initialization, a management station may recognize 348 resources it had reserved in the past. With this 349 information it may free the resources if it no longer 350 needs them. 352 Management stations and probes should support any format of 353 the owner string dictated by the local policy of the 354 organization. It is suggested that this name contain one or 355 more of the following: IP address, management station name, 356 network manager's name, location, or phone number. This 357 information will help users to share the resources more 358 effectively. 360 There is often default functionality that the device or the 361 administrator of the probe (often the network administrator) 362 wishes to set up. The resources associated with this 363 functionality are then owned by the device itself or by the 364 network administrator, and are intended to be long-lived. In 365 this case, the device or the administrator will set the 366 relevant owner object to a string starting with 'monitor'. 367 Indiscriminate modification of the monitor-owned configuration 368 by network management stations is discouraged. In fact, a 369 network management station should only modify these objects 370 under the direction of the administrator of the probe. 372 Resources on a probe are scarce and are typically allocated 373 when control rows are created by an application. Since many 374 applications may be using a probe simultaneously, 375 indiscriminate allocation of resources to particular 376 applications is very likely to cause resource shortages in the 377 probe. 379 When a network management station wishes to utilize a function 380 in a monitor, it is encouraged to first scan the control table 381 of that function to find an instance with similar parameters 382 to share. This is especially true for those instances owned 383 by the monitor, which can be assumed to change infrequently. 384 If a management station decides to share an instance owned by 385 another management station, it should understand that the 386 management station that owns the instance may indiscriminately 387 modify or delete it. 389 It should be noted that a management application should have 390 the most trust in a monitor-owned row because it should be 391 changed very infrequently. A row owned by the management 392 application is less long-lived because a network administrator 393 is more likely to re-assign resources from a row that is in 394 use by one user than from a monitor-owned row that is 395 potentially in use by many users. A row owned by another 396 application would be even less long-lived because the other 397 application may delete or modify that row completely at its 398 discretion. 400 3.2. Row Addition Among Multiple Management Stations 402 The addition of new rows is achieved using the RowStatus 403 Textual Convention [RFC2579]. In this MIB, rows are often 404 added to a table in order to configure a function. This 405 configuration usually involves parameters that control the 406 operation of the function. The agent must check these 407 parameters to make sure they are appropriate given 408 restrictions defined in this MIB as well as any implementation 409 specific restrictions such as lack of resources. The agent 410 implementor may be confused as to when to check these 411 parameters and when to signal to the management station that 412 the parameters are invalid. There are two opportunities: 414 o When the management station sets each parameter object. 416 o When the management station sets the row status object 417 to active. 419 If the latter is chosen, it would be unclear to the management 420 station which of the several parameters was invalid and caused 421 the badValue error to be emitted. Thus, wherever possible, 422 the implementor should choose the former as it will provide 423 more information to the management station. 425 A problem can arise when multiple management stations attempt 426 to set configuration information simultaneously using SNMP. 427 When this involves the addition of a new conceptual row in the 428 same control table, the managers may collide, attempting to 429 create the same entry. To guard against these collisions, 430 each such control entry contains a status object with special 431 semantics that help to arbitrate among the managers. If an 432 attempt is made with the row addition mechanism to create such 433 a status object and that object already exists, an error is 434 returned. When more than one manager simultaneously attempts 435 to create the same conceptual row, only the first will 436 succeed. The others will receive an error. 438 In the RMON MIB [RFC2819], the EntryStatus textual convention 439 was introduced to provide this mutual exclusion function. 440 Since then, this function was added to the SNMP framework as 441 the RowStatus textual convention. The RowStatus textual 442 convention is used for the definition of all new tables. 444 When a manager wishes to create a new control entry, it needs 445 to choose an index for that row. It may choose this index in 446 a variety of ways, hopefully minimizing the chances that the 447 index is in use by another manager. If the index is in use, 448 the mechanism mentioned previously will guard against 449 collisions. Examples of schemes to choose index values 450 include random selection or scanning the control table looking 451 for the first unused index. Because index values may be any 452 valid value in the range and they are chosen by the manager, 453 the agent must allow a row to be created with any unused index 454 value if it has the resources to create a new row. 456 Some tables in this MIB reference other tables within this 457 MIB. When creating or deleting entries in these tables, it is 458 generally allowable for dangling references to exist. There 459 is no defined order for creating or deleting entries in these 460 tables. 462 4. Conventions 464 The following conventions are used throughout the RMON MIB and 465 its companion documents. 467 Good Packets 469 Good packets are error-free packets that have a valid frame 470 length. For example, on Ethernet, good packets are error-free 471 packets that are between 64 octets long and 1518 octets long. 472 They follow the form defined in IEEE 802.3 section 3.2.all. 474 Bad Packets 476 Bad packets are packets that have proper framing and are 477 therefore recognized as packets, but contain errors within the 478 packet or have an invalid length. For example, on Ethernet, 479 bad packets have a valid preamble and SFD, but have a bad CRC, 480 or are either shorter than 64 octets or longer than 1518 481 octets. 483 5. RMON 2 Conventions 485 The following practices and conventions are introduced in the 486 RMON 2 MIB. 488 5.1. Usage of the term Application Level 490 There are many cases in this MIB where the term Application 491 Level is used to describe a class of protocols or a 492 capability. This does not typically mean a protocol that is 493 an OSI Layer 7 protocol. Rather, it is used to identify a 494 class of protocols that is not limited to MAC-layer and 495 network-layer protocols, but can also include transport, 496 session, presentation, and application-layer protocols. 498 5.2. Protocol Directory and Limited Extensibility 500 Every RMON 2 implementation will have the capability to parse 501 certain types of packets and identify their protocol type at 502 multiple levels. The protocol directory presents an inventory 503 of those protocol types the probe is capable of monitoring, 504 and allows the addition, deletion, and configuration of 505 protocol types in this list. 507 One concept deserves special attention: the "limited 508 extensibility" of the protocol directory table. The RMON 2 509 model is that protocols are detected by static software that 510 has been written at implementation time. Therefore, as a 511 matter of configuration, an implementation does not have the 512 ability to suddenly learn how to parse new packet types. 513 However, an implementation may be written such that the 514 software knows where the demultiplexing field is for a 515 particular protocol, and can be written in such a way that the 516 decoding of the next layer up is table-driven. This works 517 when the code has been written to accomodate it and can be 518 extended no more than one level higher. This extensibility is 519 called "limited extensibility" to highlight these limitations. 520 However, this can be a very useful tool. 522 For example, suppose that an implementation has C code that 523 understands how to decode IP packets on any of several 524 ethernet encapsulations, and also knows how to interpret the 525 IP protocol field to recognize UDP packets and how to decode 526 the UDP port number fields. That implementation may be table- 527 driven so that among the many different UDP port numbers 528 possible, it is configured to recognize 161 as SNMP, port 53 529 as DNS, and port 69 as TFTP. The limited extensibility of the 530 protocol directory table would allow an SNMP operation to 531 create an entry that would create an additional table mapping 532 for UDP that would recognize UDP port 123 as NTP and begin 533 counting such packets. 535 This limited extensibility is an option that an implementation 536 can choose to allow or disallow for any protocol that has 537 child protocols. 539 5.3. Errors in packets 541 Packets with link-level errors are not counted anywhere in 542 this MIB because most variables in this MIB requires the 543 decoding of the contents of the packet, which is meaningless 544 if there is a link-level error. 546 Packets in which protocol errors are detected are counted for 547 all protocols below the layer in which the error was 548 encountered. The implication of this is that packets in which 549 errors are detected at the network-layer are not counted 550 anywhere in this MIB, while packets with errors detected at 551 the transport layer may have network-layer statistics counted. 553 6. Definitions 555 RMON2-MIB DEFINITIONS ::= BEGIN 556 IMPORTS 557 MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32, 558 Gauge32, IpAddress, TimeTicks, mib-2 FROM SNMPv2-SMI 559 TEXTUAL-CONVENTION, RowStatus, DisplayString, TimeStamp 560 FROM SNMPv2-TC 561 MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF 562 ifIndex FROM IF-MIB 563 OwnerString, statistics, history, hosts, 564 matrix, filter, etherStatsEntry, historyControlEntry, 565 hostControlEntry, matrixControlEntry, filterEntry, 566 channelEntry FROM RMON-MIB 567 tokenRing, tokenRingMLStatsEntry, tokenRingPStatsEntry, 568 ringStationControlEntry, sourceRoutingStatsEntry 569 FROM TOKEN-RING-RMON-MIB; 570 -- Remote Network Monitoring MIB 572 rmon MODULE-IDENTITY 573 LAST-UPDATED "200508211500Z" -- August 21, 2005 574 ORGANIZATION "IETF RMON MIB Working Group" 575 CONTACT-INFO 576 "Author: 577 Steve Waldbusser 578 Phone: +1-650-948-6500 579 Fax : +1-650-745-0671 580 Email: waldbusser@nextbeacon.com 582 Working Group Chair: 583 Andy Bierman 584 E-mail: ietf@andybierman.com 586 Working Group Mailing List: 587 To subscribe send email to: " 588 DESCRIPTION 589 "The MIB module for managing remote monitoring 590 device implementations. This MIB module 591 extends the architecture introduced in the original 592 RMON MIB as specified in RFC 2819. 594 Copyright (C) The Internet Society (2005). This version of 595 this MIB module is part of RFC yyyy; see the RFC itself for 596 full legal notices." 598 REVISION "200508211500Z" -- August 21, 2005 599 DESCRIPTION 600 "This version updates the proposed-standard version of the 601 RMON2 MIB (published as RFC 2021) by adding 2 new enumerations 602 to the nlMatrixTopNControlRateBase object and 4 new 603 enumerations to the alMatrixTopNControlRateBase object. These 604 new enumerations support the creation of high capacity topN 605 reports in the High Capacity RMON MIB [RFC3273]. 607 Additionally, the following objects have been deprecated as 608 they have not had enough independent implementations to 609 demonstrate interoperability to meet the requirements of a 610 Draft Standard: 612 probeDownloadFile 613 probeDownloadTFTPServer 614 probeDownloadAction 615 probeDownloadStatus 616 serialMode 617 serialProtocol 618 serialTimeout 619 serialModemInitString 620 serialModemHangUpString 621 serialModemConnectResp 622 serialModemNoConnectResp 623 serialDialoutTimeout 624 serialStatus 625 serialConnectDestIpAddress 626 serialConnectType 627 serialConnectDialString 628 serialConnectSwitchConnectSeq 629 serialConnectSwitchDisconnectSeq 630 serialConnectSwitchResetSeq 631 serialConnectOwner 632 serialConnectStatus 633 netConfigIPAddress 634 netConfigSubnetMask 635 netConfigStatus 636 netDefaultGateway 637 tokenRingMLStats2DroppedFrames 638 tokenRingMLStats2CreateTime 639 tokenRingPStats2DroppedFrames 640 tokenRingPStats2CreateTime 641 ringStationControl2DroppedFrames 642 ringStationControl2CreateTime 643 sourceRoutingStats2DroppedFrames 644 sourceRoutingStats2CreateTime 645 trapDestIndex 646 trapDestCommunity 647 trapDestProtocol 648 trapDestAddress 649 trapDestOwner 650 trapDestStatus 652 In addition, two corrections were made. The LastCreateTime 653 Textual Convention had been defined with a base type of 654 another textual convention which isn't allowed in SMIv2. The 655 definition has been modified to use TimeTicks as the base 656 type. 658 Further, the SerialConfigEntry SEQUENCE definition included 659 sub-typing information that is not allowed in SMIv2. This 660 information has been deleted. Ranges were added to a number of 661 objects and textual-conventions to constrain their maximum 662 (and sometimes minimum) sizes. The addition of these ranges 663 documents existing practice for these objects. These objects 664 are: 665 ControlString 666 protocolDirID 667 protocolDirParameters 668 addressMapNetworkAddress 669 nlHostAddress 670 nlMatrixSDSourceAddress 671 nlMatrixSDDestAddress 672 nlMatrixDSSourceAddress 673 nlMatrixDSDestAddress 674 nlMatrixTopNSourceAddress 675 nlMatrixTopNDestAddress 676 alHostEntry 677 alMatrixSDEntry 678 alMatrixDSEntry 679 alMatrixTopNSourceAddress 680 alMatrixTopNDestAddress 682 Finally, the TimeFilter TC has been updated to encourage agent 683 implementations that allow a MIB walk to behave well even when 684 performed by an application that is not aware of the special 685 TimeFilter semantics." 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] 700 protocolDir OBJECT IDENTIFIER ::= { rmon 11 } 701 protocolDist OBJECT IDENTIFIER ::= { rmon 12 } 702 addressMap OBJECT IDENTIFIER ::= { rmon 13 } 703 nlHost OBJECT IDENTIFIER ::= { rmon 14 } 704 nlMatrix OBJECT IDENTIFIER ::= { rmon 15 } 705 alHost OBJECT IDENTIFIER ::= { rmon 16 } 706 alMatrix OBJECT IDENTIFIER ::= { rmon 17 } 707 usrHistory OBJECT IDENTIFIER ::= { rmon 18 } 708 probeConfig OBJECT IDENTIFIER ::= { rmon 19 } 709 rmonConformance OBJECT IDENTIFIER ::= { rmon 20 } 711 -- Textual Conventions 713 ZeroBasedCounter32 ::= TEXTUAL-CONVENTION 714 STATUS current 715 DESCRIPTION 716 "This TC describes an object which counts events with the 717 following semantics: objects of this type will be set to 718 zero(0) on creation and will thereafter count appropriate 719 events, wrapping back to zero(0) when the value 2^32 is 720 reached. 722 Provided that an application discovers the new object within 723 the minimum time to wrap it can use the initial value as a 724 delta since it last polled the table of which this object is 725 part. It is important for a management station to be aware of 726 this minimum time and the actual time between polls, and to 727 discard data if the actual time is too long or there is no 728 defined minimum time. 730 Typically this TC is used in tables where the INDEX space is 731 constantly changing and/or the TimeFilter mechanism is in use." 732 SYNTAX Gauge32 734 LastCreateTime ::= TEXTUAL-CONVENTION 735 STATUS current 736 DESCRIPTION 737 "This TC describes an object that stores the value of the 738 sysUpTime object at the last time its entry was created. 740 This can be used for polling applications to determine that an 741 entry has been deleted and re-created between polls, causing 742 an otherwise undetectable discontinuity in the data. 744 If sysUpTime is reset to zero as a result of a re- 745 initialization of the network management (sub)system, then 746 the values of all LastCreateTime objects are also reset. 747 However, after approximately 497 days without a re- 748 initialization, the sysUpTime object will reach 2^^32-1 and 749 then increment around to zero; in this case, existing values 750 of TimeStamp objects do not change. This can lead to 751 ambiguities in the value of TimeStamp objects." 752 SYNTAX TimeTicks 754 TimeFilter ::= TEXTUAL-CONVENTION 755 STATUS current 756 DESCRIPTION 757 "To be used for the index to a table. Allows an application 758 to download only those rows changed since a particular time. 759 A row is considered changed if the value of any object in the 760 row changes, if the row is created, or if any object in the 761 row is created or deleted. Note that deleted rows cannot be 762 detected or downloaded. 764 When sysUpTime is equal to zero, this table shall be empty. 766 One entry exists for each past value of sysUpTime, except that 767 the whole table is purged should sysUpTime wrap. 769 As this basic row is updated new conceptual rows are created 770 (which still share the now updated object values with all 771 other instances). The number of instances which are created 772 is determined by the value of sysUpTime at which the basic row 773 was last updated. One instance will exist for each value of 774 sysUpTime at the last update time for the row. A new 775 timeMark instance is created for each new sysUpTime value. 776 Each new conceptual row will be associated with the timeMark 777 instance which was created at the value of sysUpTime with 778 which the conceptual row is to be associated. 780 By definition all conceptual rows were updated at or after 781 time zero and so at least one conceptual row (associated with 782 timeMark.0) must exist for each underlying (basic) row. 784 See the appendix for further discussion of this variable. 786 Consider the following fooTable: 788 fooTable ... 789 INDEX { fooTimeMark, fooIndex } 791 FooEntry { 792 fooTimeMark TimeFilter 793 fooIndex INTEGER, 794 fooCounts Counter 795 } 797 Should there be two basic rows in this table (fooIndex == 1, 798 fooIndex == 2) and row 1 was updated most recently at time 6, 799 while row 2 was updated most recently at time 8, and both rows 800 had been updated on several earlier occasions such that the 801 current values were 5 and 9 respectively then the following 802 fooCounts instances would exist. 804 fooCounts.0.1 5 805 fooCounts.0.2 9 806 fooCounts.1.1 5 807 fooCounts.1.2 9 808 fooCounts.2.1 5 809 fooCounts.2.2 9 810 fooCounts.3.1 5 811 fooCounts.3.2 9 812 fooCounts.4.1 5 813 fooCounts.4.2 9 814 fooCounts.5.1 5 815 fooCounts.5.2 9 816 fooCounts.6.1 5 817 fooCounts.6.2 9 818 fooCounts.7.2 9 -- note that row 1 doesn't exist for 819 fooCounts.8.2 9 -- times 7 and 8" 820 SYNTAX TimeTicks 822 DataSource ::= TEXTUAL-CONVENTION 823 STATUS current 824 DESCRIPTION 825 "Identifies the source of the data that the associated 826 function is configured to analyze. This source can be any 827 interface on this device. 829 In order to identify a particular interface, this 830 object shall identify the instance of the ifIndex 831 object, defined in [RFC2863], for the desired interface. 833 For example, if an entry were to receive data from 834 interface #1, this object would be set to ifIndex.1." 835 SYNTAX OBJECT IDENTIFIER 837 -- 838 -- Protocol Directory Group 839 -- 840 -- Lists the inventory of protocols the probe has the capability of 841 -- monitoring and allows the addition, deletion, and configuration of 842 -- entries in this list. 844 protocolDirLastChange OBJECT-TYPE 845 SYNTAX TimeStamp 846 MAX-ACCESS read-only 847 STATUS current 848 DESCRIPTION 849 "The value of sysUpTime at the time the protocol directory 850 was last modified, either through insertions or deletions, 851 or through modifications of either the 852 protocolDirAddressMapConfig, protocolDirHostConfig, or 853 protocolDirMatrixConfig." 854 ::= { protocolDir 1 } 856 protocolDirTable OBJECT-TYPE 857 SYNTAX SEQUENCE OF ProtocolDirEntry 858 MAX-ACCESS not-accessible 859 STATUS current 860 DESCRIPTION 861 "This table lists the protocols that this agent has the 862 capability to decode and count. There is one entry in this 863 table for each such protocol. These protocols represent 864 different network layer, transport layer, and higher-layer 865 protocols. The agent should boot up with this table 866 preconfigured with those protocols that it knows about and 867 wishes to monitor. Implementations are strongly encouraged to 868 support protocols higher than the network layer (at least for 869 the protocol distribution group), even for implementations 870 that don't support the application layer groups." 871 ::= { protocolDir 2 } 873 protocolDirEntry OBJECT-TYPE 874 SYNTAX ProtocolDirEntry 875 MAX-ACCESS not-accessible 876 STATUS current 877 DESCRIPTION 878 "A conceptual row in the protocolDirTable. 880 An example of the indexing of this entry is 881 protocolDirLocalIndex.8.0.0.0.1.0.0.8.0.2.0.0, which is the 882 encoding of a length of 8, followed by 8 subids encoding the 883 protocolDirID of 1.2048, followed by a length of 2 and the 884 2 subids encoding zero-valued parameters. 886 Note that some combinations of index values may result in an 887 index that exceeds 128 sub-identifiers in length which exceeds 888 the maximum for the SNMP protocol. Implementations should take 889 care to avoid such combinations." 890 INDEX { protocolDirID, protocolDirParameters } 891 ::= { protocolDirTable 1 } 893 ProtocolDirEntry ::= SEQUENCE { 894 protocolDirID OCTET STRING, 895 protocolDirParameters OCTET STRING, 896 protocolDirLocalIndex Integer32, 897 protocolDirDescr DisplayString, 898 protocolDirType BITS, 899 protocolDirAddressMapConfig INTEGER, 900 protocolDirHostConfig INTEGER, 901 protocolDirMatrixConfig INTEGER, 902 protocolDirOwner OwnerString, 903 protocolDirStatus RowStatus 904 } 906 protocolDirID OBJECT-TYPE 907 SYNTAX OCTET STRING (SIZE (4..128)) 908 MAX-ACCESS not-accessible 909 STATUS current 910 DESCRIPTION 911 "A unique identifier for a particular protocol. Standard 912 identifiers will be defined in a manner such that they 913 can often be used as specifications for new protocols - i.e. 914 a tree-structured assignment mechanism that matches the 915 protocol encapsulation `tree' and which has algorithmic 916 assignment mechanisms for certain subtrees. See RFC 2074 for 917 more details. 919 Despite the algorithmic mechanism, the probe will only place 920 entries in here for those protocols it chooses to collect. In 921 other words, it need not populate this table with all of the 922 possible ethernet protocol types, nor need it create them on 923 the fly when it sees them. Whether or not it does these 924 things is a matter of product definition (cost/benefit, 925 usability), and is up to the designer of the product. 927 If an entry is written to this table with a protocolDirID that 928 the agent doesn't understand, either directly or 929 algorithmically, the SET request will be rejected with an 930 inconsistentName or badValue (for SNMPv1) error." 931 ::= { protocolDirEntry 1 } 933 protocolDirParameters OBJECT-TYPE 934 SYNTAX OCTET STRING (SIZE (1..32)) 935 MAX-ACCESS not-accessible 936 STATUS current 937 DESCRIPTION 938 "A set of parameters for the associated protocolDirID. 939 See the associated RMON2 Protocol Identifiers document 940 for a description of the possible parameters. There 941 will be one octet in this string for each sub-identifier in 942 the protocolDirID, and the parameters will appear here in the 943 same order as the associated sub-identifiers appear in the 944 protocolDirID. 946 Every node in the protocolDirID tree has a different, optional 947 set of parameters defined (that is, the definition of 948 parameters for a node is optional). The proper parameter 949 value for each node is included in this string. Note that the 950 inclusion of a parameter value in this string for each node is 951 not optional - what is optional is that a node may have no 952 parameters defined, in which case the parameter field for that 953 node will be zero." 954 ::= { protocolDirEntry 2 } 956 protocolDirLocalIndex OBJECT-TYPE 957 SYNTAX Integer32 (1..2147483647) 958 MAX-ACCESS read-only 959 STATUS current 960 DESCRIPTION 961 "The locally arbitrary, but unique identifier associated 962 with this protocolDir entry. 964 The value for each supported protocol must remain constant at 965 least from one re-initialization of the entity's network 966 management system to the next re-initialization, except that 967 if a protocol is deleted and re-created, it must be re-created 968 with a new value that has not been used since the last 969 re-initialization. 971 The specific value is meaningful only within a given SNMP 972 entity. A protocolDirLocalIndex must not be re-used until the 973 next agent restart in the event the protocol directory entry 974 is deleted." 975 ::= { protocolDirEntry 3 } 977 protocolDirDescr OBJECT-TYPE 978 SYNTAX DisplayString (SIZE (1..64)) 979 MAX-ACCESS read-create 980 STATUS current 981 DESCRIPTION 982 "A textual description of the protocol encapsulation. 983 A probe may choose to describe only a subset of the 984 entire encapsulation (e.g. only the highest layer). 986 This object is intended for human consumption only. 988 This object may not be modified if the associated 989 protocolDirStatus object is equal to active(1)." 990 ::= { protocolDirEntry 4 } 992 protocolDirType OBJECT-TYPE 993 SYNTAX BITS { 994 extensible(0), 995 addressRecognitionCapable(1) 996 } 997 MAX-ACCESS read-only 998 STATUS current 999 DESCRIPTION 1000 "This object describes 2 attributes of this protocol 1001 directory entry. 1003 The presence or absence of the `extensible' bit describes 1004 whether or not this protocol directory entry can be extended 1005 by the user by creating protocol directory entries which are 1006 children of this protocol. 1008 An example of an entry that will often allow extensibility is 1009 `ip.udp'. The probe may automatically populate some children 1010 of this node such as `ip.udp.snmp' and `ip.udp.dns'. 1011 A probe administrator or user may also populate additional 1012 children via remote SNMP requests that create entries in this 1013 table. When a child node is added for a protocol for which the 1014 probe has no built in support, extending a parent node (for 1015 which the probe does have built in support), 1016 that child node is not extendible. This is termed `limited 1017 extensibility'. 1019 When a child node is added through this extensibility 1020 mechanism, the values of protocolDirLocalIndex and 1021 protocolDirType shall be assigned by the agent. 1023 The other objects in the entry will be assigned by the 1024 manager who is creating the new entry. 1026 This object also describes whether or not this agent can 1027 recognize addresses for this protocol, should it be a network 1028 level protocol. That is, while a probe may be able to 1029 recognize packets of a particular network layer protocol and 1030 count them, it takes additional logic to be able to recognize 1031 the addresses in this protocol and to populate network layer 1032 or application layer tables with the addresses in this 1033 protocol. If this bit is set, the agent will recognize 1034 network layer addresses for this protoocl and populate the 1035 network and application layer host and matrix tables with 1036 these protocols. 1038 Note that when an entry is created, the agent will supply 1039 values for the bits that match the capabilities of the agent 1040 with respect to this protocol. Note that since row creations 1041 usually exercise the limited extensibility feature, these 1042 bits will usually be set to zero." 1043 ::= { protocolDirEntry 5 } 1045 protocolDirAddressMapConfig OBJECT-TYPE 1046 SYNTAX INTEGER { 1047 notSupported(1), 1048 supportedOff(2), 1049 supportedOn(3) 1050 } 1051 MAX-ACCESS read-create 1052 STATUS current 1053 DESCRIPTION 1054 "This object describes and configures the probe's support for 1055 address mapping for this protocol. When the probe creates 1056 entries in this table for all protocols that it understands, 1057 it will set the entry to notSupported(1) if it doesn't have 1058 the capability to perform address mapping for the protocol or 1059 if this protocol is not a network-layer protocol. When 1060 an entry is created in this table by a management operation as 1061 part of the limited extensibility feature, the probe must set 1062 this value to notSupported(1), because limited extensibility 1063 of the protocolDirTable does not extend to interpreting 1064 addresses of the extended protocols. 1066 If the value of this object is notSupported(1), the probe 1067 will not perform address mapping for this protocol and 1068 shall not allow this object to be changed to any other value. 1069 If the value of this object is supportedOn(3), the probe 1070 supports address mapping for this protocol and is configured 1071 to perform address mapping for this protocol for all 1072 addressMappingControlEntries and all interfaces. 1073 If the value of this object is supportedOff(2), the probe 1074 supports address mapping for this protocol but is configured 1075 to not perform address mapping for this protocol for any 1076 addressMappingControlEntries and all interfaces. 1077 Whenever this value changes from supportedOn(3) to 1078 supportedOff(2), the probe shall delete all related entries in 1079 the addressMappingTable." 1080 ::= { protocolDirEntry 6 } 1082 protocolDirHostConfig OBJECT-TYPE 1083 SYNTAX INTEGER { 1084 notSupported(1), 1085 supportedOff(2), 1086 supportedOn(3) 1087 } 1088 MAX-ACCESS read-create 1089 STATUS current 1090 DESCRIPTION 1091 "This object describes and configures the probe's support for 1092 the network layer and application layer host tables for this 1093 protocol. When the probe creates entries in this table for 1094 all protocols that it understands, it will set the entry to 1095 notSupported(1) if it doesn't have the capability to track the 1096 nlHostTable for this protocol or if the alHostTable is 1097 implemented but doesn't have the capability to track this 1098 protocol. Note that if the alHostTable is implemented, the 1099 probe may only support a protocol if it is supported in both 1100 the nlHostTable and the alHostTable. 1102 If the associated protocolDirType object has the 1103 addressRecognitionCapable bit set, then this is a network 1104 layer protocol for which the probe recognizes addresses, and 1105 thus the probe will populate the nlHostTable and alHostTable 1106 with addresses it discovers for this protocol. 1108 If the value of this object is notSupported(1), the probe 1109 will not track the nlHostTable or alHostTable for this 1110 protocol and shall not allow this object to be changed to any 1111 other value. If the value of this object is supportedOn(3), 1112 the probe supports tracking of the nlHostTable and alHostTable 1113 for this protocol and is configured to track both tables 1114 for this protocol for all control entries and all interfaces. 1115 If the value of this object is supportedOff(2), the probe 1116 supports tracking of the nlHostTable and alHostTable for this 1117 protocol but is configured to not track these tables 1118 for any control entries or interfaces. 1119 Whenever this value changes from supportedOn(3) to 1120 supportedOff(2), the probe shall delete all related entries in 1121 the nlHostTable and alHostTable. 1123 Note that since each alHostEntry references 2 protocol 1124 directory entries, one for the network address and one for the 1125 type of the highest protocol recognized, that an entry will 1126 only be created in that table if this value is supportedOn(3) 1127 for both protocols." 1128 ::= { protocolDirEntry 7 } 1130 protocolDirMatrixConfig OBJECT-TYPE 1131 SYNTAX INTEGER { 1132 notSupported(1), 1133 supportedOff(2), 1134 supportedOn(3) 1135 } 1136 MAX-ACCESS read-create 1137 STATUS current 1138 DESCRIPTION 1139 "This object describes and configures the probe's support for 1140 the network layer and application layer matrix tables for this 1141 protocol. When the probe creates entries in this table for 1142 all protocols that it understands, it will set the entry to 1143 notSupported(1) if it doesn't have the capability to track the 1144 nlMatrixTables for this protocol or if the alMatrixTables are 1145 implemented but don't have the capability to track this 1146 protocol. Note that if the alMatrix tables are implemented, 1147 the probe may only support a protocol if it is supported in 1148 the the both of the nlMatrixTables and both of the 1149 alMatrixTables. 1151 If the associated protocolDirType object has the 1152 addressRecognitionCapable bit set, then this is a network 1153 layer protocol for which the probe recognizes addresses, and 1154 thus the probe will populate both of the nlMatrixTables and 1155 both of the alMatrixTables with addresses it discovers for 1156 this protocol. 1158 If the value of this object is notSupported(1), the probe 1159 will not track either of the nlMatrixTables or the 1160 alMatrixTables for this protocol and shall not allow this 1161 object to be changed to any other value. If the value of this 1162 object is supportedOn(3), the probe supports tracking of both 1163 of the nlMatrixTables and (if implemented) both of the 1164 alMatrixTables for this protocol and is configured to track 1165 these tables for this protocol for all control entries and all 1166 interfaces. If the value of this object is supportedOff(2), 1167 the probe supports tracking of both of the nlMatrixTables and 1168 (if implemented) both of the alMatrixTables for this protocol 1169 but is configured to not track these tables for this 1170 protocol for any control entries or interfaces. 1171 Whenever this value changes from supportedOn(3) to 1172 supportedOff(2), the probe shall delete all related entries in 1173 the nlMatrixTables and the alMatrixTables. 1175 Note that since each alMatrixEntry references 2 protocol 1176 directory entries, one for the network address and one for the 1177 type of the highest protocol recognized, that an entry will 1178 only be created in that table if this value is supportedOn(3) 1179 for both protocols." 1180 ::= { protocolDirEntry 8 } 1182 protocolDirOwner OBJECT-TYPE 1183 SYNTAX OwnerString 1184 MAX-ACCESS read-create 1185 STATUS current 1186 DESCRIPTION 1187 "The entity that configured this entry and is 1188 therefore using the resources assigned to it." 1189 ::= { protocolDirEntry 9 } 1191 protocolDirStatus OBJECT-TYPE 1192 SYNTAX RowStatus 1193 MAX-ACCESS read-create 1194 STATUS current 1195 DESCRIPTION 1196 "The status of this protocol directory entry. 1198 An entry may not exist in the active state unless all 1199 objects in the entry have an appropriate value. 1201 If this object is not equal to active(1), all associated 1202 entries in the nlHostTable, nlMatrixSDTable, nlMatrixDSTable, 1203 alHostTable, alMatrixSDTable, and alMatrixDSTable shall be 1204 deleted." 1205 ::= { protocolDirEntry 10 } 1207 -- 1208 -- Protocol Distribution Group (protocolDist) 1209 -- 1210 -- Collects the relative amounts of octets and packets for the 1211 -- different protocols detected on a network segment. 1212 -- protocolDistControlTable, 1213 -- protocolDistStatsTable 1215 protocolDistControlTable OBJECT-TYPE 1216 SYNTAX SEQUENCE OF ProtocolDistControlEntry 1217 MAX-ACCESS not-accessible 1218 STATUS current 1219 DESCRIPTION 1220 "Controls the setup of protocol type distribution statistics 1221 tables. 1223 Implementations are encouraged to add an entry per monitored 1224 interface upon initialization so that a default collection 1225 of protocol statistics is available. 1227 Rationale: 1228 This table controls collection of very basic statistics 1229 for any or all of the protocols detected on a given interface. 1230 An NMS can use this table to quickly determine bandwidth 1231 allocation utilized by different protocols. 1233 A media-specific statistics collection could also 1234 be configured (e.g. etherStats, trPStats) to easily obtain 1235 total frame, octet, and droppedEvents for the same 1236 interface." 1237 ::= { protocolDist 1 } 1239 protocolDistControlEntry OBJECT-TYPE 1240 SYNTAX ProtocolDistControlEntry 1241 MAX-ACCESS not-accessible 1242 STATUS current 1243 DESCRIPTION 1244 "A conceptual row in the protocolDistControlTable. 1246 An example of the indexing of this entry is 1247 protocolDistControlDroppedFrames.7" 1248 INDEX { protocolDistControlIndex } 1249 ::= { protocolDistControlTable 1 } 1251 ProtocolDistControlEntry ::= SEQUENCE { 1252 protocolDistControlIndex Integer32, 1253 protocolDistControlDataSource DataSource, 1254 protocolDistControlDroppedFrames Counter32, 1255 protocolDistControlCreateTime LastCreateTime, 1256 protocolDistControlOwner OwnerString, 1257 protocolDistControlStatus RowStatus 1258 } 1260 protocolDistControlIndex OBJECT-TYPE 1261 SYNTAX Integer32 (1..65535) 1262 MAX-ACCESS not-accessible 1263 STATUS current 1264 DESCRIPTION 1265 "A unique index for this protocolDistControlEntry." 1266 ::= { protocolDistControlEntry 1 } 1268 protocolDistControlDataSource OBJECT-TYPE 1269 SYNTAX DataSource 1270 MAX-ACCESS read-create 1271 STATUS current 1272 DESCRIPTION 1273 "The source of data for the this protocol distribution. 1275 The statistics in this group reflect all packets 1276 on the local network segment attached to the 1277 identified interface. 1279 This object may not be modified if the associated 1280 protocolDistControlStatus object is equal to active(1)." 1281 ::= { protocolDistControlEntry 2 } 1283 protocolDistControlDroppedFrames OBJECT-TYPE 1284 SYNTAX Counter32 1285 MAX-ACCESS read-only 1286 STATUS current 1287 DESCRIPTION 1288 "The total number of frames which were received by the probe 1289 and therefore not accounted for in the *StatsDropEvents, but 1290 for which the probe chose not to count for this entry for 1291 whatever reason. Most often, this event occurs when the probe 1292 is out of some resources and decides to shed load from this 1293 collection. 1295 This count does not include packets that were not counted 1296 because they had MAC-layer errors. 1298 Note that, unlike the dropEvents counter, this number is the 1299 exact number of frames dropped." 1300 ::= { protocolDistControlEntry 3 } 1302 protocolDistControlCreateTime OBJECT-TYPE 1303 SYNTAX LastCreateTime 1304 MAX-ACCESS read-only 1305 STATUS current 1306 DESCRIPTION 1307 "The value of sysUpTime when this control entry was last 1308 activated. This can be used by the management station to 1309 ensure that the table has not been deleted and recreated 1310 between polls." 1311 ::= { protocolDistControlEntry 4 } 1313 protocolDistControlOwner OBJECT-TYPE 1314 SYNTAX OwnerString 1315 MAX-ACCESS read-create 1316 STATUS current 1317 DESCRIPTION 1318 "The entity that configured this entry and is 1319 therefore using the resources assigned to it." 1320 ::= { protocolDistControlEntry 5 } 1322 protocolDistControlStatus OBJECT-TYPE 1323 SYNTAX RowStatus 1324 MAX-ACCESS read-create 1325 STATUS current 1326 DESCRIPTION 1327 "The status of this row. 1329 An entry may not exist in the active state unless all 1330 objects in the entry have an appropriate value. 1332 If this object is not equal to active(1), all associated 1333 entries in the protocolDistStatsTable shall be deleted." 1334 ::= { protocolDistControlEntry 6 } 1336 -- per interface protocol distribution statistics table 1337 protocolDistStatsTable OBJECT-TYPE 1338 SYNTAX SEQUENCE OF ProtocolDistStatsEntry 1339 MAX-ACCESS not-accessible 1340 STATUS current 1341 DESCRIPTION 1342 "An entry is made in this table for every protocol in the 1343 protocolDirTable which has been seen in at least one packet. 1344 Counters are updated in this table for every protocol type 1345 that is encountered when parsing a packet, but no counters are 1346 updated for packets with MAC-layer errors. 1348 Note that if a protocolDirEntry is deleted, all associated 1349 entries in this table are removed." 1350 ::= { protocolDist 2 } 1352 protocolDistStatsEntry OBJECT-TYPE 1353 SYNTAX ProtocolDistStatsEntry 1354 MAX-ACCESS not-accessible 1355 STATUS current 1356 DESCRIPTION 1357 "A conceptual row in the protocolDistStatsTable. 1359 The index is composed of the protocolDistControlIndex of the 1360 associated protocolDistControlEntry followed by the 1361 protocolDirLocalIndex of the associated protocol that this 1362 entry represents. In other words, the index identifies the 1363 protocol distribution an entry is a part of as well as the 1364 particular protocol that it represents. 1366 An example of the indexing of this entry is 1367 protocolDistStatsPkts.1.18" 1368 INDEX { protocolDistControlIndex, protocolDirLocalIndex } 1369 ::= { protocolDistStatsTable 1 } 1371 ProtocolDistStatsEntry ::= SEQUENCE { 1372 protocolDistStatsPkts ZeroBasedCounter32, 1373 protocolDistStatsOctets ZeroBasedCounter32 1374 } 1376 protocolDistStatsPkts OBJECT-TYPE 1377 SYNTAX ZeroBasedCounter32 1378 MAX-ACCESS read-only 1379 STATUS current 1380 DESCRIPTION 1381 "The number of packets without errors received of this 1382 protocol type. Note that this is the number of link-layer 1383 packets, so if a single network-layer packet is fragmented 1384 into several link-layer frames, this counter is incremented 1385 several times." 1386 ::= { protocolDistStatsEntry 1 } 1388 protocolDistStatsOctets OBJECT-TYPE 1389 SYNTAX ZeroBasedCounter32 1390 MAX-ACCESS read-only 1391 STATUS current 1392 DESCRIPTION 1393 "The number of octets in packets received of this protocol 1394 type since it was added to the protocolDistStatsTable 1395 (excluding framing bits but including FCS octets), except for 1396 those octets in packets that contained errors. 1398 Note this doesn't count just those octets in the particular 1399 protocol frames, but includes the entire packet that contained 1400 the protocol." 1401 ::= { protocolDistStatsEntry 2 } 1403 -- 1404 -- Address Map Group (addressMap) 1405 -- 1406 -- Lists MAC address to network address bindings discovered by the 1407 -- probe and what interface they were last seen on. 1408 -- addressMapControlTable 1409 -- addressMapTable 1411 addressMapInserts OBJECT-TYPE 1412 SYNTAX Counter32 1413 MAX-ACCESS read-only 1414 STATUS current 1415 DESCRIPTION 1416 "The number of times an address mapping entry has been 1417 inserted into the addressMapTable. If an entry is inserted, 1418 then deleted, and then inserted, this counter will be 1419 incremented by 2. 1421 Note that the table size can be determined by subtracting 1422 addressMapDeletes from addressMapInserts." 1423 ::= { addressMap 1 } 1425 addressMapDeletes OBJECT-TYPE 1426 SYNTAX Counter32 1427 MAX-ACCESS read-only 1428 STATUS current 1429 DESCRIPTION 1430 "The number of times an address mapping entry has been 1431 deleted from the addressMapTable (for any reason). If 1432 an entry is deleted, then inserted, and then deleted, this 1433 counter will be incremented by 2. 1435 Note that the table size can be determined by subtracting 1436 addressMapDeletes from addressMapInserts." 1437 ::= { addressMap 2 } 1439 addressMapMaxDesiredEntries OBJECT-TYPE 1440 SYNTAX Integer32 (-1..2147483647) 1441 MAX-ACCESS read-write 1442 STATUS current 1443 DESCRIPTION 1444 "The maximum number of entries that are desired in the 1445 addressMapTable. The probe will not create more than 1446 this number of entries in the table, but may choose to create 1447 fewer entries in this table for any reason including the lack 1448 of resources. 1450 If this object is set to a value less than the current number 1451 of entries, enough entries are chosen in an 1452 implementation-dependent manner and deleted so that the number 1453 of entries in the table equals the value of this object. 1455 If this value is set to -1, the probe may create any number 1456 of entries in this table. 1458 This object may be used to control how resources are allocated 1459 on the probe for the various RMON functions." 1460 ::= { addressMap 3 } 1462 addressMapControlTable OBJECT-TYPE 1463 SYNTAX SEQUENCE OF AddressMapControlEntry 1464 MAX-ACCESS not-accessible 1465 STATUS current 1466 DESCRIPTION 1467 "A table to control the collection of network layer address to 1468 physical address to interface mappings. 1470 Note that this is not like the typical RMON 1471 controlTable and dataTable in which each entry creates 1472 its own data table. Each entry in this table enables the 1473 discovery of addresses on a new interface and the placement 1474 of address mappings into the central addressMapTable. 1476 Implementations are encouraged to add an entry per monitored 1477 interface upon initialization so that a default collection 1478 of address mappings is available." 1479 ::= { addressMap 4 } 1481 addressMapControlEntry OBJECT-TYPE 1482 SYNTAX AddressMapControlEntry 1483 MAX-ACCESS not-accessible 1484 STATUS current 1485 DESCRIPTION 1486 "A conceptual row in the addressMapControlTable. 1488 An example of the indexing of this entry is 1489 addressMapControlDroppedFrames.1" 1490 INDEX { addressMapControlIndex } 1491 ::= { addressMapControlTable 1 } 1493 AddressMapControlEntry ::= SEQUENCE { 1494 addressMapControlIndex Integer32, 1495 addressMapControlDataSource DataSource, 1496 addressMapControlDroppedFrames Counter32, 1497 addressMapControlOwner OwnerString, 1498 addressMapControlStatus RowStatus 1499 } 1501 addressMapControlIndex OBJECT-TYPE 1502 SYNTAX Integer32 (1..65535) 1503 MAX-ACCESS not-accessible 1504 STATUS current 1505 DESCRIPTION 1506 "A unique index for this entry in the addressMapControlTable." 1507 ::= { addressMapControlEntry 1 } 1509 addressMapControlDataSource OBJECT-TYPE 1510 SYNTAX DataSource 1511 MAX-ACCESS read-create 1512 STATUS current 1513 DESCRIPTION 1514 "The source of data for this addressMapControlEntry." 1515 ::= { addressMapControlEntry 2 } 1517 addressMapControlDroppedFrames OBJECT-TYPE 1518 SYNTAX Counter32 1519 MAX-ACCESS read-only 1520 STATUS current 1521 DESCRIPTION 1522 "The total number of frames which were received by the probe 1523 and therefore not accounted for in the *StatsDropEvents, but 1524 for which the probe chose not to count for this entry for 1525 whatever reason. Most often, this event occurs when the probe 1526 is out of some resources and decides to shed load from this 1527 collection. 1529 This count does not include packets that were not counted 1530 because they had MAC-layer errors. 1532 Note that, unlike the dropEvents counter, this number is the 1533 exact number of frames dropped." 1534 ::= { addressMapControlEntry 3 } 1536 addressMapControlOwner OBJECT-TYPE 1537 SYNTAX OwnerString 1538 MAX-ACCESS read-create 1539 STATUS current 1540 DESCRIPTION 1541 "The entity that configured this entry and is 1542 therefore using the resources assigned to it." 1543 ::= { addressMapControlEntry 4 } 1545 addressMapControlStatus OBJECT-TYPE 1546 SYNTAX RowStatus 1547 MAX-ACCESS read-create 1548 STATUS current 1549 DESCRIPTION 1550 "The status of this addressMap control entry. 1552 An entry may not exist in the active state unless all 1553 objects in the entry have an appropriate value. 1555 If this object is not equal to active(1), all associated 1556 entries in the addressMapTable shall be deleted." 1557 ::= { addressMapControlEntry 5 } 1559 addressMapTable OBJECT-TYPE 1560 SYNTAX SEQUENCE OF AddressMapEntry 1561 MAX-ACCESS not-accessible 1562 STATUS current 1563 DESCRIPTION 1564 "A table of network layer address to physical address to 1565 interface mappings. 1567 The probe will add entries to this table based on the source 1568 MAC and network addresses seen in packets without MAC-level 1569 errors. The probe will populate this table for all protocols 1570 in the protocol directory table whose value of 1571 protocolDirAddressMapConfig is equal to supportedOn(3), and 1572 will delete any entries whose protocolDirEntry is deleted or 1573 has a protocolDirAddressMapConfig value of supportedOff(2)." 1574 ::= { addressMap 5 } 1576 addressMapEntry OBJECT-TYPE 1577 SYNTAX AddressMapEntry 1578 MAX-ACCESS not-accessible 1579 STATUS current 1580 DESCRIPTION 1581 "A conceptual row in the addressMapTable. 1583 The protocolDirLocalIndex in the index identifies the network 1584 layer protocol of the addressMapNetworkAddress. 1586 An example of the indexing of this entry is 1587 addressMapSource.783495.18.4.128.2.6.6.11.1.3.6.1.2.1.2.2.1.1.1. 1589 Note that some combinations of index values may result in an 1590 index that exceeds 128 sub-identifiers in length which exceeds 1591 the maximum for the SNMP protocol. Implementations should take 1592 care to avoid such combinations." 1593 INDEX { addressMapTimeMark, protocolDirLocalIndex, 1594 addressMapNetworkAddress, addressMapSource } 1595 ::= { addressMapTable 1 } 1597 AddressMapEntry ::= SEQUENCE { 1598 addressMapTimeMark TimeFilter, 1599 addressMapNetworkAddress OCTET STRING, 1600 addressMapSource OBJECT IDENTIFIER, 1601 addressMapPhysicalAddress OCTET STRING, 1602 addressMapLastChange TimeStamp 1603 } 1605 addressMapTimeMark OBJECT-TYPE 1606 SYNTAX TimeFilter 1607 MAX-ACCESS not-accessible 1608 STATUS current 1609 DESCRIPTION 1610 "A TimeFilter for this entry. See the TimeFilter textual 1611 convention to see how this works." 1612 ::= { addressMapEntry 1 } 1614 addressMapNetworkAddress OBJECT-TYPE 1615 SYNTAX OCTET STRING (SIZE (1..255)) 1616 MAX-ACCESS not-accessible 1617 STATUS current 1618 DESCRIPTION 1619 "The network address for this relation. 1621 This is represented as an octet string with 1622 specific semantics and length as identified 1623 by the protocolDirLocalIndex component of the 1624 index. 1626 For example, if the protocolDirLocalIndex indicates an 1627 encapsulation of ip, this object is encoded as a length 1628 octet of 4, followed by the 4 octets of the ip address, 1629 in network byte order." 1630 ::= { addressMapEntry 2 } 1632 addressMapSource OBJECT-TYPE 1633 SYNTAX OBJECT IDENTIFIER 1634 MAX-ACCESS not-accessible 1635 STATUS current 1636 DESCRIPTION 1637 "The interface or port on which the associated network 1638 address was most recently seen. 1640 If this address mapping was discovered on an interface, this 1641 object shall identify the instance of the ifIndex 1642 object, defined in [RFC2863], for the desired interface. 1643 For example, if an entry were to receive data from 1644 interface #1, this object would be set to ifIndex.1. 1646 If this address mapping was discovered on a port, this 1647 object shall identify the instance of the rptrGroupPortIndex 1648 object, defined in [RFC2108], for the desired port. 1649 For example, if an entry were to receive data from 1650 group #1, port #1, this object would be set to 1651 rptrGroupPortIndex.1.1. 1653 Note that while the dataSource associated with this entry 1654 may only point to index objects, this object may at times 1655 point to repeater port objects. This situation occurs when 1656 the dataSource points to an interface which is a locally 1657 attached repeater and the agent has additional information 1658 about the source port of traffic seen on that repeater." 1659 ::= { addressMapEntry 3 } 1661 addressMapPhysicalAddress OBJECT-TYPE 1662 SYNTAX OCTET STRING 1663 MAX-ACCESS read-only 1664 STATUS current 1665 DESCRIPTION 1666 "The last source physical address on which the associated 1667 network address was seen. If the protocol of the associated 1668 network address was encapsulated inside of a network-level or 1669 higher protocol, this will be the address of the next-lower 1670 protocol with the addressRecognitionCapable bit enabled and 1671 will be formatted as specified for that protocol." 1672 ::= { addressMapEntry 4 } 1674 addressMapLastChange OBJECT-TYPE 1675 SYNTAX TimeStamp 1676 MAX-ACCESS read-only 1677 STATUS current 1678 DESCRIPTION 1679 "The value of sysUpTime at the time this entry was last 1680 created or the values of the physical address changed. 1682 This can be used to help detect duplicate address problems, in 1683 which case this object will be updated frequently." 1684 ::= { addressMapEntry 5 } 1686 -- 1687 -- Network Layer Host Group 1688 -- 1689 -- Counts the amount of traffic sent from and to each network address 1690 -- discovered by the probe. 1691 -- Note that while the hlHostControlTable also has objects that 1692 -- control an optional alHostTable, implementation of the alHostTable is 1693 -- not required to fully implement this group. 1695 hlHostControlTable OBJECT-TYPE 1696 SYNTAX SEQUENCE OF HlHostControlEntry 1697 MAX-ACCESS not-accessible 1698 STATUS current 1699 DESCRIPTION 1700 "A list of higher layer (i.e. non-MAC) host table control 1701 entries. 1703 These entries will enable the collection of the network and 1704 application level host tables indexed by network addresses. 1705 Both the network and application level host tables are 1706 controlled by this table is so that they will both be created 1707 and deleted at the same time, further increasing the ease with 1708 which they can be implemented as a single datastore (note that 1709 if an implementation stores application layer host records in 1710 memory, it can derive network layer host records from them). 1712 Entries in the nlHostTable will be created on behalf of each 1713 entry in this table. Additionally, if this probe implements 1714 the alHostTable, entries in the alHostTable will be created on 1715 behalf of each entry in this table. 1717 Implementations are encouraged to add an entry per monitored 1718 interface upon initialization so that a default collection 1719 of host statistics is available." 1720 ::= { nlHost 1 } 1722 hlHostControlEntry OBJECT-TYPE 1723 SYNTAX HlHostControlEntry 1724 MAX-ACCESS not-accessible 1725 STATUS current 1726 DESCRIPTION 1727 "A conceptual row in the hlHostControlTable. 1729 An example of the indexing of this entry is 1730 hlHostControlNlDroppedFrames.1" 1731 INDEX { hlHostControlIndex } 1732 ::= { hlHostControlTable 1 } 1734 HlHostControlEntry ::= SEQUENCE { 1735 hlHostControlIndex Integer32, 1736 hlHostControlDataSource DataSource, 1737 hlHostControlNlDroppedFrames Counter32, 1738 hlHostControlNlInserts Counter32, 1739 hlHostControlNlDeletes Counter32, 1740 hlHostControlNlMaxDesiredEntries Integer32, 1741 hlHostControlAlDroppedFrames Counter32, 1742 hlHostControlAlInserts Counter32, 1743 hlHostControlAlDeletes Counter32, 1744 hlHostControlAlMaxDesiredEntries Integer32, 1745 hlHostControlOwner OwnerString, 1746 hlHostControlStatus RowStatus 1747 } 1749 hlHostControlIndex OBJECT-TYPE 1750 SYNTAX Integer32 (1..65535) 1751 MAX-ACCESS not-accessible 1752 STATUS current 1753 DESCRIPTION 1754 "An index that uniquely identifies an entry in the 1755 hlHostControlTable. Each such entry defines 1756 a function that discovers hosts on a particular 1757 interface and places statistics about them in the 1758 nlHostTable, and optionally in the alHostTable, on 1759 behalf of this hlHostControlEntry." 1760 ::= { hlHostControlEntry 1 } 1762 hlHostControlDataSource OBJECT-TYPE 1763 SYNTAX DataSource 1764 MAX-ACCESS read-create 1765 STATUS current 1766 DESCRIPTION 1767 "The source of data for the associated host tables. 1769 The statistics in this group reflect all packets 1770 on the local network segment attached to the 1771 identified interface. 1773 This object may not be modified if the associated 1774 hlHostControlStatus object is equal to active(1)." 1775 ::= { hlHostControlEntry 2 } 1777 hlHostControlNlDroppedFrames OBJECT-TYPE 1778 SYNTAX Counter32 1779 MAX-ACCESS read-only 1780 STATUS current 1781 DESCRIPTION 1782 "The total number of frames which were received by the probe 1783 and therefore not accounted for in the *StatsDropEvents, but 1784 for which the probe chose not to count for the associated 1785 nlHost entries for whatever reason. Most often, this event 1786 occurs when the probe is out of some resources and decides to 1787 shed load from this collection. 1789 This count does not include packets that were not counted 1790 because they had MAC-layer errors. 1792 Note that if the nlHostTable is inactive because no protocols 1793 are enabled in the protocol directory, this value should be 0. 1795 Note that, unlike the dropEvents counter, this number is the 1796 exact number of frames dropped." 1797 ::= { hlHostControlEntry 3 } 1799 hlHostControlNlInserts OBJECT-TYPE 1800 SYNTAX Counter32 1801 MAX-ACCESS read-only 1802 STATUS current 1803 DESCRIPTION 1804 "The number of times an nlHost entry has been 1805 inserted into the nlHost table. If an entry is inserted, then 1806 deleted, and then inserted, this counter will be incremented 1807 by 2. 1809 To allow for efficient implementation strategies, agents may 1810 delay updating this object for short periods of time. For 1811 example, an implementation strategy may allow internal 1812 data structures to differ from those visible via SNMP for 1813 short periods of time. This counter may reflect the internal 1814 data structures for those short periods of time. 1816 Note that the table size can be determined by subtracting 1817 hlHostControlNlDeletes from hlHostControlNlInserts." 1819 ::= { hlHostControlEntry 4 } 1821 hlHostControlNlDeletes OBJECT-TYPE 1822 SYNTAX Counter32 1823 MAX-ACCESS read-only 1824 STATUS current 1825 DESCRIPTION 1826 "The number of times an nlHost entry has been 1827 deleted from the nlHost table (for any reason). If an entry 1828 is deleted, then inserted, and then deleted, this counter will 1829 be incremented by 2. 1831 To allow for efficient implementation strategies, agents may 1832 delay updating this object for short periods of time. For 1833 example, an implementation strategy may allow internal 1834 data structures to differ from those visible via SNMP for 1835 short periods of time. This counter may reflect the internal 1836 data structures for those short periods of time. 1838 Note that the table size can be determined by subtracting 1839 hlHostControlNlDeletes from hlHostControlNlInserts." 1840 ::= { hlHostControlEntry 5 } 1842 hlHostControlNlMaxDesiredEntries OBJECT-TYPE 1843 SYNTAX Integer32 (-1..2147483647) 1844 MAX-ACCESS read-create 1845 STATUS current 1846 DESCRIPTION 1847 "The maximum number of entries that are desired in the 1848 nlHostTable on behalf of this control entry. The probe will 1849 not create more than this number of associated entries in the 1850 table, but may choose to create fewer entries in this table 1851 for any reason including the lack of resources. 1853 If this object is set to a value less than the current number 1854 of entries, enough entries are chosen in an 1855 implementation-dependent manner and deleted so that the number 1856 of entries in the table equals the value of this object. 1858 If this value is set to -1, the probe may create any number 1859 of entries in this table. If the associated 1860 hlHostControlStatus object is equal to `active', this 1861 object may not be modified. 1863 This object may be used to control how resources are allocated 1864 on the probe for the various RMON functions." 1865 ::= { hlHostControlEntry 6 } 1867 hlHostControlAlDroppedFrames OBJECT-TYPE 1868 SYNTAX Counter32 1869 MAX-ACCESS read-only 1870 STATUS current 1871 DESCRIPTION 1872 "The total number of frames which were received by the probe 1873 and therefore not accounted for in the *StatsDropEvents, but 1874 for which the probe chose not to count for the associated 1875 alHost entries for whatever reason. Most often, this event 1876 occurs when the probe is out of some resources and decides to 1877 shed load from this collection. 1879 This count does not include packets that were not counted 1880 because they had MAC-layer errors. 1882 Note that if the alHostTable is not implemented or is inactive 1883 because no protocols are enabled in the protocol directory, 1884 this value should be 0. 1886 Note that, unlike the dropEvents counter, this number is the 1887 exact number of frames dropped." 1888 ::= { hlHostControlEntry 7 } 1890 hlHostControlAlInserts OBJECT-TYPE 1891 SYNTAX Counter32 1892 MAX-ACCESS read-only 1893 STATUS current 1894 DESCRIPTION 1895 "The number of times an alHost entry has been 1896 inserted into the alHost table. If an entry is inserted, then 1897 deleted, and then inserted, this counter will be incremented 1898 by 2. 1900 To allow for efficient implementation strategies, agents may 1901 delay updating this object for short periods of time. For 1902 example, an implementation strategy may allow internal 1903 data structures to differ from those visible via SNMP for 1904 short periods of time. This counter may reflect the internal 1905 data structures for those short periods of time. 1907 Note that the table size can be determined by subtracting 1908 hlHostControlAlDeletes from hlHostControlAlInserts." 1909 ::= { hlHostControlEntry 8 } 1911 hlHostControlAlDeletes OBJECT-TYPE 1912 SYNTAX Counter32 1913 MAX-ACCESS read-only 1914 STATUS current 1915 DESCRIPTION 1916 "The number of times an alHost entry has been 1917 deleted from the alHost table (for any reason). If an entry 1918 is deleted, then inserted, and then deleted, this counter will 1919 be incremented by 2. 1921 To allow for efficient implementation strategies, agents may 1922 delay updating this object for short periods of time. For 1923 example, an implementation strategy may allow internal 1924 data structures to differ from those visible via SNMP for 1925 short periods of time. This counter may reflect the internal 1926 data structures for those short periods of time. 1928 Note that the table size can be determined by subtracting 1929 hlHostControlAlDeletes from hlHostControlAlInserts." 1930 ::= { hlHostControlEntry 9 } 1932 hlHostControlAlMaxDesiredEntries OBJECT-TYPE 1933 SYNTAX Integer32 (-1..2147483647) 1934 MAX-ACCESS read-create 1935 STATUS current 1936 DESCRIPTION 1937 "The maximum number of entries that are desired in the alHost 1938 table on behalf of this control entry. The probe will not 1939 create more than this number of associated entries in the 1940 table, but may choose to create fewer entries in this table 1941 for any reason including the lack of resources. 1943 If this object is set to a value less than the current number 1944 of entries, enough entries are chosen in an 1945 implementation-dependent manner and deleted so that the number 1946 of entries in the table equals the value of this object. 1948 If this value is set to -1, the probe may create any number 1949 of entries in this table. If the associated 1950 hlHostControlStatus object is equal to `active', this 1951 object may not be modified. 1953 This object may be used to control how resources are allocated 1954 on the probe for the various RMON functions." 1955 ::= { hlHostControlEntry 10 } 1957 hlHostControlOwner OBJECT-TYPE 1958 SYNTAX OwnerString 1959 MAX-ACCESS read-create 1960 STATUS current 1961 DESCRIPTION 1962 "The entity that configured this entry and is 1963 therefore using the resources assigned to it." 1964 ::= { hlHostControlEntry 11 } 1966 hlHostControlStatus OBJECT-TYPE 1967 SYNTAX RowStatus 1968 MAX-ACCESS read-create 1969 STATUS current 1970 DESCRIPTION 1971 "The status of this hlHostControlEntry. 1973 An entry may not exist in the active state unless all 1974 objects in the entry have an appropriate value. 1976 If this object is not equal to active(1), all associated 1977 entries in the nlHostTable and alHostTable shall be deleted." 1978 ::= { hlHostControlEntry 12 } 1980 nlHostTable OBJECT-TYPE 1981 SYNTAX SEQUENCE OF NlHostEntry 1982 MAX-ACCESS not-accessible 1983 STATUS current 1984 DESCRIPTION 1985 "A collection of statistics for a particular network layer 1986 address that has been discovered on an interface of this 1987 device. 1989 The probe will populate this table for all network layer 1990 protocols in the protocol directory table whose value of 1991 protocolDirHostConfig is equal to supportedOn(3), and 1992 will delete any entries whose protocolDirEntry is deleted or 1993 has a protocolDirHostConfig value of supportedOff(2). 1995 The probe will add to this table all addresses seen 1996 as the source or destination address in all packets with no 1997 MAC errors, and will increment octet and packet counts in the 1998 table for all packets with no MAC errors." 1999 ::= { nlHost 2 } 2001 nlHostEntry OBJECT-TYPE 2002 SYNTAX NlHostEntry 2003 MAX-ACCESS not-accessible 2004 STATUS current 2005 DESCRIPTION 2006 "A conceptual row in the nlHostTable. 2008 The hlHostControlIndex value in the index identifies the 2009 hlHostControlEntry on whose behalf this entry was created. 2010 The protocolDirLocalIndex value in the index identifies the 2011 network layer protocol of the nlHostAddress. 2013 An example of the indexing of this entry is 2014 nlHostOutPkts.1.783495.18.4.128.2.6.6. 2016 Note that some combinations of index values may result in an 2017 index that exceeds 128 sub-identifiers in length which exceeds 2018 the maximum for the SNMP protocol. Implementations should take 2019 care to avoid such combinations." 2020 INDEX { hlHostControlIndex, nlHostTimeMark, 2021 protocolDirLocalIndex, nlHostAddress } 2022 ::= { nlHostTable 1 } 2024 NlHostEntry ::= SEQUENCE { 2025 nlHostTimeMark TimeFilter, 2026 nlHostAddress OCTET STRING, 2027 nlHostInPkts ZeroBasedCounter32, 2028 nlHostOutPkts ZeroBasedCounter32, 2029 nlHostInOctets ZeroBasedCounter32, 2030 nlHostOutOctets ZeroBasedCounter32, 2031 nlHostOutMacNonUnicastPkts ZeroBasedCounter32, 2032 nlHostCreateTime LastCreateTime 2033 } 2035 nlHostTimeMark OBJECT-TYPE 2036 SYNTAX TimeFilter 2037 MAX-ACCESS not-accessible 2038 STATUS current 2039 DESCRIPTION 2040 "A TimeFilter for this entry. See the TimeFilter textual 2041 convention to see how this works." 2042 ::= { nlHostEntry 1 } 2044 nlHostAddress OBJECT-TYPE 2045 SYNTAX OCTET STRING (SIZE (1..255)) 2046 MAX-ACCESS not-accessible 2047 STATUS current 2048 DESCRIPTION 2049 "The network address for this nlHostEntry. 2051 This is represented as an octet string with 2052 specific semantics and length as identified 2053 by the protocolDirLocalIndex component of the index. 2055 For example, if the protocolDirLocalIndex indicates an 2056 encapsulation of ip, this object is encoded as a length 2057 octet of 4, followed by the 4 octets of the ip address, 2058 in network byte order." 2059 ::= { nlHostEntry 2 } 2061 nlHostInPkts OBJECT-TYPE 2062 SYNTAX ZeroBasedCounter32 2063 MAX-ACCESS read-only 2064 STATUS current 2065 DESCRIPTION 2066 "The number of packets without errors transmitted to 2067 this address since it was added to the nlHostTable. Note that 2068 this is the number of link-layer packets, so if a single 2069 network-layer packet is fragmented into several link-layer 2070 frames, this counter is incremented several times." 2071 ::= { nlHostEntry 3 } 2073 nlHostOutPkts OBJECT-TYPE 2074 SYNTAX ZeroBasedCounter32 2075 MAX-ACCESS read-only 2076 STATUS current 2077 DESCRIPTION 2078 "The number of packets without errors transmitted by 2079 this address since it was added to the nlHostTable. Note that 2080 this is the number of link-layer packets, so if a single 2081 network-layer packet is fragmented into several link-layer 2082 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." 2129 ::= { nlHostEntry 7 } 2131 nlHostCreateTime OBJECT-TYPE 2132 SYNTAX LastCreateTime 2133 MAX-ACCESS read-only 2134 STATUS current 2135 DESCRIPTION 2136 "The value of sysUpTime when this entry was last activated. 2137 This can be used by the management station to ensure that the 2138 entry has not been deleted and recreated between polls." 2139 ::= { nlHostEntry 8 } 2141 -- 2142 -- Network Layer Matrix Group 2143 -- 2144 -- Counts the amount of traffic sent between each pair of network 2145 -- addresses discovered by the probe. 2146 -- Note that while the hlMatrixControlTable also has objects that 2147 -- control optional alMatrixTables, implementation of the 2148 -- alMatrixTables is not required to fully implement this group. 2150 hlMatrixControlTable OBJECT-TYPE 2151 SYNTAX SEQUENCE OF HlMatrixControlEntry 2152 MAX-ACCESS not-accessible 2153 STATUS current 2154 DESCRIPTION 2155 "A list of higher layer (i.e. non-MAC) matrix control entries. 2157 These entries will enable the collection of the network and 2158 application level matrix tables containing conversation 2159 statistics indexed by pairs of network addresses. 2160 Both the network and application level matrix tables are 2161 controlled by this table is so that they will both be created 2162 and deleted at the same time, further increasing the ease with 2163 which they can be implemented as a single datastore (note that 2164 if an implementation stores application layer matrix records 2165 in memory, it can derive network layer matrix records from 2166 them). 2168 Entries in the nlMatrixSDTable and nlMatrixDSTable will be 2169 created on behalf of each entry in this table. Additionally, 2170 if this probe implements the alMatrix tables, entries in the 2171 alMatrix tables will be created on behalf of each entry in 2172 this table." 2173 ::= { nlMatrix 1 } 2175 hlMatrixControlEntry OBJECT-TYPE 2176 SYNTAX HlMatrixControlEntry 2177 MAX-ACCESS not-accessible 2178 STATUS current 2179 DESCRIPTION 2180 "A conceptual row in the hlMatrixControlTable. 2182 An example of indexing of this entry is 2183 hlMatrixControlNlDroppedFrames.1" 2184 INDEX { hlMatrixControlIndex } 2185 ::= { hlMatrixControlTable 1 } 2187 HlMatrixControlEntry ::= SEQUENCE { 2188 hlMatrixControlIndex Integer32, 2189 hlMatrixControlDataSource DataSource, 2190 hlMatrixControlNlDroppedFrames Counter32, 2191 hlMatrixControlNlInserts Counter32, 2192 hlMatrixControlNlDeletes Counter32, 2193 hlMatrixControlNlMaxDesiredEntries Integer32, 2194 hlMatrixControlAlDroppedFrames Counter32, 2195 hlMatrixControlAlInserts Counter32, 2196 hlMatrixControlAlDeletes Counter32, 2197 hlMatrixControlAlMaxDesiredEntries Integer32, 2198 hlMatrixControlOwner OwnerString, 2199 hlMatrixControlStatus RowStatus 2200 } 2202 hlMatrixControlIndex OBJECT-TYPE 2203 SYNTAX Integer32 (1..65535) 2204 MAX-ACCESS not-accessible 2205 STATUS current 2206 DESCRIPTION 2207 "An index that uniquely identifies an entry in the 2208 hlMatrixControlTable. Each such entry defines 2209 a function that discovers conversations on a particular 2210 interface and places statistics about them in the 2211 nlMatrixSDTable and the nlMatrixDSTable, and optionally the 2212 alMatrixSDTable and alMatrixDSTable, on behalf of this 2213 hlMatrixControlEntry." 2214 ::= { hlMatrixControlEntry 1 } 2216 hlMatrixControlDataSource OBJECT-TYPE 2217 SYNTAX DataSource 2218 MAX-ACCESS read-create 2219 STATUS current 2220 DESCRIPTION 2221 "The source of the data for the associated matrix tables. 2223 The statistics in this group reflect all packets 2224 on the local network segment attached to the 2225 identified interface. 2227 This object may not be modified if the associated 2228 hlMatrixControlStatus object is equal to active(1)." 2230 ::= { hlMatrixControlEntry 2 } 2232 hlMatrixControlNlDroppedFrames OBJECT-TYPE 2233 SYNTAX Counter32 2234 MAX-ACCESS read-only 2235 STATUS current 2236 DESCRIPTION 2237 "The total number of frames which were received by the probe 2238 and therefore not accounted for in the *StatsDropEvents, but 2239 for which the probe chose not to count for this entry for 2240 whatever reason. Most often, this event occurs when the probe 2241 is out of some resources and decides to shed load from this 2242 collection. 2244 This count does not include packets that were not counted 2245 because they had MAC-layer errors. 2247 Note that if the nlMatrixTables are inactive because no 2248 protocols are enabled in the protocol directory, this value 2249 should be 0. 2251 Note that, unlike the dropEvents counter, this number is the 2252 exact number of frames dropped." 2253 ::= { hlMatrixControlEntry 3 } 2255 hlMatrixControlNlInserts OBJECT-TYPE 2256 SYNTAX Counter32 2257 MAX-ACCESS read-only 2258 STATUS current 2259 DESCRIPTION 2260 "The number of times an nlMatrix entry has been 2261 inserted into the nlMatrix tables. If an entry is inserted, 2262 then deleted, and then inserted, this counter will be 2263 incremented by 2. The addition of a conversation into both 2264 the nlMatrixSDTable and nlMatrixDSTable shall be counted as 2265 two insertions (even though every addition into one table must 2266 be accompanied by an insertion into the other). 2268 To allow for efficient implementation strategies, agents may 2269 delay updating this object for short periods of time. For 2270 example, an implementation strategy may allow internal 2271 data structures to differ from those visible via SNMP for 2272 short periods of time. This counter may reflect the internal 2273 data structures for those short periods of time. 2275 Note that the sum of then nlMatrixSDTable and nlMatrixDSTable 2276 sizes can be determined by subtracting 2277 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 2278 ::= { hlMatrixControlEntry 4 } 2280 hlMatrixControlNlDeletes OBJECT-TYPE 2281 SYNTAX Counter32 2282 MAX-ACCESS read-only 2283 STATUS current 2284 DESCRIPTION 2285 "The number of times an nlMatrix entry has been 2286 deleted from the nlMatrix tables (for any reason). If an 2287 entry is deleted, then inserted, and then deleted, this 2288 counter will be incremented by 2. The deletion of a 2289 conversation from both the nlMatrixSDTable and nlMatrixDSTable 2290 shall be counted as two deletions (even though every deletion 2291 from one table must be accompanied by a deletion from the 2292 other). 2294 To allow for efficient implementation strategies, agents may 2295 delay updating this object for short periods of time. For 2296 example, an implementation strategy may allow internal 2297 data structures to differ from those visible via SNMP for 2298 short periods of time. This counter may reflect the internal 2299 data structures for those short periods of time. 2301 Note that the table size can be determined by subtracting 2302 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 2303 ::= { hlMatrixControlEntry 5 } 2305 hlMatrixControlNlMaxDesiredEntries OBJECT-TYPE 2306 SYNTAX Integer32 (-1..2147483647) 2307 MAX-ACCESS read-create 2308 STATUS current 2309 DESCRIPTION 2310 "The maximum number of entries that are desired in the 2311 nlMatrix tables on behalf of this control entry. The probe 2312 will not create more than this number of associated entries in 2313 the table, but may choose to create fewer entries in this 2314 table for any reason including the lack of resources. 2316 If this object is set to a value less than the current number 2317 of entries, enough entries are chosen in an 2318 implementation-dependent manner and deleted so that the number 2319 of entries in the table equals the value of this object. 2321 If this value is set to -1, the probe may create any number 2322 of entries in this table. If the associated 2323 hlMatrixControlStatus object is equal to `active', this 2324 object may not be modified. 2326 This object may be used to control how resources are allocated 2327 on the probe for the various RMON functions." 2328 ::= { hlMatrixControlEntry 6 } 2330 hlMatrixControlAlDroppedFrames OBJECT-TYPE 2331 SYNTAX Counter32 2332 MAX-ACCESS read-only 2333 STATUS current 2334 DESCRIPTION 2335 "The total number of frames which were received by the probe 2336 and therefore not accounted for in the *StatsDropEvents, but 2337 for which the probe chose not to count for this entry for 2338 whatever reason. Most often, this event occurs when the probe 2339 is out of some resources and decides to shed load from this 2340 collection. 2342 This count does not include packets that were not counted 2343 because they had MAC-layer errors. 2345 Note that if the alMatrixTables are not implemented or are 2346 inactive because no protocols are enabled in the protocol 2347 directory, this value should be 0. 2349 Note that, unlike the dropEvents counter, this number is the 2350 exact number of frames dropped." 2351 ::= { hlMatrixControlEntry 7 } 2353 hlMatrixControlAlInserts OBJECT-TYPE 2354 SYNTAX Counter32 2355 MAX-ACCESS read-only 2356 STATUS current 2357 DESCRIPTION 2358 "The number of times an alMatrix entry has been 2359 inserted into the alMatrix tables. If an entry is inserted, 2360 then deleted, and then inserted, this counter will be 2361 incremented by 2. The addition of a conversation into both 2362 the alMatrixSDTable and alMatrixDSTable shall be counted as 2363 two insertions (even though every addition into one table must 2364 be accompanied by an insertion into the other). 2366 To allow for efficient implementation strategies, agents may 2367 delay updating this object for short periods of time. For 2368 example, an implementation strategy may allow internal 2369 data structures to differ from those visible via SNMP for 2370 short periods of time. This counter may reflect the internal 2371 data structures for those short periods of time. 2373 Note that the table size can be determined by subtracting 2374 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 2375 ::= { hlMatrixControlEntry 8 } 2377 hlMatrixControlAlDeletes OBJECT-TYPE 2378 SYNTAX Counter32 2379 MAX-ACCESS read-only 2380 STATUS current 2381 DESCRIPTION 2382 "The number of times an alMatrix entry has been 2383 deleted from the alMatrix tables. If an entry is deleted, 2384 then inserted, and then deleted, this counter will be 2385 incremented by 2. The deletion of a conversation from both 2386 the alMatrixSDTable and alMatrixDSTable shall be counted as 2387 two deletions (even though every deletion from one table must 2388 be accompanied by a deletion from the other). 2390 To allow for efficient implementation strategies, agents may 2391 delay updating this object for short periods of time. For 2392 example, an implementation strategy may allow internal 2393 data structures to differ from those visible via SNMP for 2394 short periods of time. This counter may reflect the internal 2395 data structures for those short periods of time. 2397 Note that the table size can be determined by subtracting 2398 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 2399 ::= { hlMatrixControlEntry 9 } 2401 hlMatrixControlAlMaxDesiredEntries OBJECT-TYPE 2402 SYNTAX Integer32 (-1..2147483647) 2403 MAX-ACCESS read-create 2404 STATUS current 2405 DESCRIPTION 2406 "The maximum number of entries that are desired in the 2407 alMatrix tables on behalf of this control entry. The probe 2408 will not create more than this number of associated entries in 2409 the table, but may choose to create fewer entries in this 2410 table for any reason including the lack of resources. 2412 If this object is set to a value less than the current number 2413 of entries, enough entries are chosen in an 2414 implementation-dependent manner and deleted so that the number 2415 of entries in the table equals the value of this object. 2417 If this value is set to -1, the probe may create any number 2418 of entries in this table. If the associated 2419 hlMatrixControlStatus object is equal to `active', this 2420 object may not be modified. 2422 This object may be used to control how resources are allocated 2423 on the probe for the various RMON functions." 2424 ::= { hlMatrixControlEntry 10 } 2426 hlMatrixControlOwner OBJECT-TYPE 2427 SYNTAX OwnerString 2428 MAX-ACCESS read-create 2429 STATUS current 2430 DESCRIPTION 2431 "The entity that configured this entry and is 2432 therefore using the resources assigned to it." 2433 ::= { hlMatrixControlEntry 11 } 2435 hlMatrixControlStatus OBJECT-TYPE 2436 SYNTAX RowStatus 2437 MAX-ACCESS read-create 2438 STATUS current 2439 DESCRIPTION 2440 "The status of this hlMatrixControlEntry. 2442 An entry may not exist in the active state unless all 2443 objects in the entry have an appropriate value. 2445 If this object is not equal to active(1), all 2446 associated entries in the nlMatrixSDTable, 2447 nlMatrixDSTable, alMatrixSDTable, and the alMatrixDSTable 2448 shall be deleted by the agent." 2449 ::= { hlMatrixControlEntry 12 } 2451 nlMatrixSDTable OBJECT-TYPE 2452 SYNTAX SEQUENCE OF NlMatrixSDEntry 2453 MAX-ACCESS not-accessible 2454 STATUS current 2455 DESCRIPTION 2456 "A list of traffic matrix entries which collect statistics for 2457 conversations between two network-level addresses. This table 2458 is indexed first by the source address and then by the 2459 destination address to make it convenient to collect all 2460 conversations from a particular address. 2462 The probe will populate this table for all network layer 2463 protocols in the protocol directory table whose value of 2464 protocolDirMatrixConfig is equal to supportedOn(3), and 2465 will delete any entries whose protocolDirEntry is deleted or 2466 has a protocolDirMatrixConfig value of supportedOff(2). 2468 The probe will add to this table all pairs of addresses 2469 seen in all packets with no MAC errors, and will increment 2470 octet and packet counts in the table for all packets with no 2471 MAC errors. 2473 Further, this table will only contain entries that have a 2474 corresponding entry in the nlMatrixDSTable with the same 2475 source address and destination address." 2476 ::= { nlMatrix 2 } 2478 nlMatrixSDEntry OBJECT-TYPE 2479 SYNTAX NlMatrixSDEntry 2480 MAX-ACCESS not-accessible 2481 STATUS current 2482 DESCRIPTION 2483 "A conceptual row in the nlMatrixSDTable. 2485 The hlMatrixControlIndex value in the index identifies the 2486 hlMatrixControlEntry on whose behalf this entry was created. 2487 The protocolDirLocalIndex value in the index identifies the 2488 network layer protocol of the nlMatrixSDSourceAddress and 2489 nlMatrixSDDestAddress. 2491 An example of the indexing of this table is 2492 nlMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7. 2494 Note that some combinations of index values may result in an 2495 index that exceeds 128 sub-identifiers in length which exceeds 2496 the maximum for the SNMP protocol. Implementations should take 2497 care to avoid such combinations." 2498 INDEX { hlMatrixControlIndex, nlMatrixSDTimeMark, 2499 protocolDirLocalIndex, 2500 nlMatrixSDSourceAddress, nlMatrixSDDestAddress } 2501 ::= { nlMatrixSDTable 1 } 2503 NlMatrixSDEntry ::= SEQUENCE { 2504 nlMatrixSDTimeMark TimeFilter, 2505 nlMatrixSDSourceAddress OCTET STRING, 2506 nlMatrixSDDestAddress OCTET STRING, 2507 nlMatrixSDPkts ZeroBasedCounter32, 2508 nlMatrixSDOctets ZeroBasedCounter32, 2509 nlMatrixSDCreateTime LastCreateTime 2510 } 2512 nlMatrixSDTimeMark OBJECT-TYPE 2513 SYNTAX TimeFilter 2514 MAX-ACCESS not-accessible 2515 STATUS current 2516 DESCRIPTION 2517 "A TimeFilter for this entry. See the TimeFilter textual 2518 convention to see how this works." 2519 ::= { nlMatrixSDEntry 1 } 2521 nlMatrixSDSourceAddress OBJECT-TYPE 2522 SYNTAX OCTET STRING (SIZE (1..255)) 2523 MAX-ACCESS not-accessible 2524 STATUS current 2525 DESCRIPTION 2526 "The network source address for this nlMatrixSDEntry. 2528 This is represented as an octet string with 2529 specific semantics and length as identified 2530 by the protocolDirLocalIndex component of the index. 2532 For example, if the protocolDirLocalIndex indicates an 2533 encapsulation of ip, this object is encoded as a length 2534 octet of 4, followed by the 4 octets of the ip address, 2535 in network byte order." 2536 ::= { nlMatrixSDEntry 2 } 2538 nlMatrixSDDestAddress OBJECT-TYPE 2539 SYNTAX OCTET STRING (SIZE (1..255)) 2540 MAX-ACCESS not-accessible 2541 STATUS current 2542 DESCRIPTION 2543 "The network destination address for this 2544 nlMatrixSDEntry. 2546 This is represented as an octet string with 2547 specific semantics and length as identified 2548 by the protocolDirLocalIndex component of the index. 2550 For example, if the protocolDirLocalIndex indicates an 2551 encapsulation of ip, this object is encoded as a length 2552 octet of 4, followed by the 4 octets of the ip address, 2553 in network byte order." 2554 ::= { nlMatrixSDEntry 3 } 2556 nlMatrixSDPkts OBJECT-TYPE 2557 SYNTAX ZeroBasedCounter32 2558 MAX-ACCESS read-only 2559 STATUS current 2560 DESCRIPTION 2561 "The number of packets without errors transmitted from the 2562 source address to the destination address since this entry was 2563 added to the nlMatrixSDTable. Note that this is the number of 2564 link-layer packets, so if a single network-layer packet is 2565 fragmented into several link-layer frames, this counter is 2566 incremented several times." 2567 ::= { nlMatrixSDEntry 4 } 2569 nlMatrixSDOctets OBJECT-TYPE 2570 SYNTAX ZeroBasedCounter32 2571 MAX-ACCESS read-only 2572 STATUS current 2573 DESCRIPTION 2574 "The number of octets transmitted from the source address to 2575 the destination address since this entry was added to the 2576 nlMatrixSDTable (excluding framing bits but 2577 including FCS octets), excluding those octets in packets that 2578 contained errors. 2580 Note this doesn't count just those octets in the particular 2581 protocol frames, but includes the entire packet that contained 2582 the protocol." 2584 ::= { nlMatrixSDEntry 5 } 2586 nlMatrixSDCreateTime OBJECT-TYPE 2587 SYNTAX LastCreateTime 2588 MAX-ACCESS read-only 2589 STATUS current 2590 DESCRIPTION 2591 "The value of sysUpTime when this entry was last activated. 2592 This can be used by the management station to ensure that the 2593 entry has not been deleted and recreated between polls." 2594 ::= { nlMatrixSDEntry 6 } 2596 -- Traffic matrix tables from destination to source 2598 nlMatrixDSTable OBJECT-TYPE 2599 SYNTAX SEQUENCE OF NlMatrixDSEntry 2600 MAX-ACCESS not-accessible 2601 STATUS current 2602 DESCRIPTION 2603 "A list of traffic matrix entries which collect statistics for 2604 conversations between two network-level addresses. This table 2605 is indexed first by the destination address and then by the 2606 source address to make it convenient to collect all 2607 conversations to a particular address. 2609 The probe will populate this table for all network layer 2610 protocols in the protocol directory table whose value of 2611 protocolDirMatrixConfig is equal to supportedOn(3), and 2612 will delete any entries whose protocolDirEntry is deleted or 2613 has a protocolDirMatrixConfig value of supportedOff(2). 2615 The probe will add to this table all pairs of addresses 2616 seen in all packets with no MAC errors, and will increment 2617 octet and packet counts in the table for all packets with no 2618 MAC errors. 2620 Further, this table will only contain entries that have a 2621 corresponding entry in the nlMatrixSDTable with the same 2622 source address and destination address." 2623 ::= { nlMatrix 3 } 2625 nlMatrixDSEntry OBJECT-TYPE 2626 SYNTAX NlMatrixDSEntry 2627 MAX-ACCESS not-accessible 2628 STATUS current 2629 DESCRIPTION 2630 "A conceptual row in the nlMatrixDSTable. 2632 The hlMatrixControlIndex value in the index identifies the 2633 hlMatrixControlEntry on whose behalf this entry was created. 2634 The protocolDirLocalIndex value in the index identifies the 2635 network layer protocol of the nlMatrixDSSourceAddress and 2636 nlMatrixDSDestAddress. 2638 An example of the indexing of this table is 2639 nlMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6. 2641 Note that some combinations of index values may result in an 2642 index that exceeds 128 sub-identifiers in length which exceeds 2643 the maximum for the SNMP protocol. Implementations should take 2644 care to avoid such combinations." 2645 INDEX { hlMatrixControlIndex, nlMatrixDSTimeMark, 2646 protocolDirLocalIndex, 2647 nlMatrixDSDestAddress, nlMatrixDSSourceAddress } 2648 ::= { nlMatrixDSTable 1 } 2650 NlMatrixDSEntry ::= SEQUENCE { 2651 nlMatrixDSTimeMark TimeFilter, 2652 nlMatrixDSSourceAddress OCTET STRING, 2653 nlMatrixDSDestAddress OCTET STRING, 2654 nlMatrixDSPkts ZeroBasedCounter32, 2655 nlMatrixDSOctets ZeroBasedCounter32, 2656 nlMatrixDSCreateTime LastCreateTime 2657 } 2659 nlMatrixDSTimeMark OBJECT-TYPE 2660 SYNTAX TimeFilter 2661 MAX-ACCESS not-accessible 2662 STATUS current 2663 DESCRIPTION 2664 "A TimeFilter for this entry. See the TimeFilter textual 2665 convention to see how this works." 2666 ::= { nlMatrixDSEntry 1 } 2668 nlMatrixDSSourceAddress OBJECT-TYPE 2669 SYNTAX OCTET STRING (SIZE (1..255)) 2670 MAX-ACCESS not-accessible 2671 STATUS current 2672 DESCRIPTION 2673 "The network source address for this nlMatrixDSEntry. 2675 This is represented as an octet string with 2676 specific semantics and length as identified 2677 by the protocolDirLocalIndex component of the index. 2679 For example, if the protocolDirLocalIndex indicates an 2680 encapsulation of ip, this object is encoded as a length 2681 octet of 4, followed by the 4 octets of the ip address, 2682 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. 3343 The first protocolDirLocalIndex value in the index identifies 3344 the network layer protocol of the nlMatrixSDSourceAddress and 3345 nlMatrixSDDestAddress. 3346 The nlMatrixSDSourceAddress value in the index identifies the 3347 network layer address of the source host in this conversation. 3348 The nlMatrixSDDestAddress value in the index identifies the 3349 network layer address of the destination host in this 3350 conversation. 3351 The second protocolDirLocalIndex value in the index identifies 3352 the protocol that is counted by this entry. 3354 An example of the indexing of this entry is 3355 alMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7.34. 3357 Note that some combinations of index values may result in an 3358 index that exceeds 128 sub-identifiers in length which exceeds 3359 the maximum for the SNMP protocol. Implementations should take 3360 care to avoid such combinations." 3361 INDEX { hlMatrixControlIndex, alMatrixSDTimeMark, 3362 protocolDirLocalIndex, 3363 nlMatrixSDSourceAddress, nlMatrixSDDestAddress, 3364 protocolDirLocalIndex } 3365 ::= { alMatrixSDTable 1 } 3367 AlMatrixSDEntry ::= SEQUENCE { 3368 alMatrixSDTimeMark TimeFilter, 3369 alMatrixSDPkts ZeroBasedCounter32, 3370 alMatrixSDOctets ZeroBasedCounter32, 3371 alMatrixSDCreateTime LastCreateTime 3372 } 3374 alMatrixSDTimeMark OBJECT-TYPE 3375 SYNTAX TimeFilter 3376 MAX-ACCESS not-accessible 3377 STATUS current 3378 DESCRIPTION 3379 "A TimeFilter for this entry. See the TimeFilter textual 3380 convention to see how this works." 3381 ::= { alMatrixSDEntry 1 } 3383 alMatrixSDPkts OBJECT-TYPE 3384 SYNTAX ZeroBasedCounter32 3385 MAX-ACCESS read-only 3386 STATUS current 3387 DESCRIPTION 3388 "The number of packets of this protocol type without errors 3389 transmitted from the source address to the destination address 3390 since this entry was added to the alMatrixSDTable. Note that 3391 this is the number of link-layer packets, so if a single 3392 network-layer packet is fragmented into several link-layer 3393 frames, this counter is incremented several times." 3394 ::= { alMatrixSDEntry 2 } 3396 alMatrixSDOctets OBJECT-TYPE 3397 SYNTAX ZeroBasedCounter32 3398 MAX-ACCESS read-only 3399 STATUS current 3400 DESCRIPTION 3401 "The number of octets in packets of this protocol type 3402 transmitted from the source address to the destination address 3403 since this entry was added to the alMatrixSDTable (excluding 3404 framing bits but including FCS octets), excluding those octets 3405 in packets that contained errors. 3407 Note this doesn't count just those octets in the particular 3408 protocol frames, but includes the entire packet that contained 3409 the protocol." 3410 ::= { alMatrixSDEntry 3 } 3412 alMatrixSDCreateTime OBJECT-TYPE 3413 SYNTAX LastCreateTime 3414 MAX-ACCESS read-only 3415 STATUS current 3416 DESCRIPTION 3417 "The value of sysUpTime when this entry was last activated. 3418 This can be used by the management station to ensure that the 3419 entry has not been deleted and recreated between polls." 3420 ::= { alMatrixSDEntry 4 } 3422 -- Traffic matrix tables from destination to source 3424 alMatrixDSTable OBJECT-TYPE 3425 SYNTAX SEQUENCE OF AlMatrixDSEntry 3426 MAX-ACCESS not-accessible 3427 STATUS current 3428 DESCRIPTION 3429 "A list of application traffic matrix entries which collect 3430 statistics for conversations of a particular protocol between 3431 two network-level addresses. This table is indexed first by 3432 the destination address and then by the source address to make 3433 it convenient to collect all statistics to a particular 3434 address. 3436 The probe will populate this table for all protocols in the 3437 protocol directory table whose value of 3438 protocolDirMatrixConfig is equal to supportedOn(3), and 3439 will delete any entries whose protocolDirEntry is deleted or 3440 has a protocolDirMatrixConfig value of supportedOff(2). 3442 The probe will add to this table all pairs of addresses for 3443 all protocols seen in all packets with no MAC errors, and will 3444 increment octet and packet counts in the table for all packets 3445 with no MAC errors. Further, entries will only be added to 3446 this table if their address pair exists in the nlMatrixDSTable 3447 and will be deleted from this table if the address pair is 3448 deleted from the nlMatrixDSTable." 3449 ::= { alMatrix 2 } 3451 alMatrixDSEntry OBJECT-TYPE 3452 SYNTAX AlMatrixDSEntry 3453 MAX-ACCESS not-accessible 3454 STATUS current 3455 DESCRIPTION 3456 "A conceptual row in the alMatrixDSTable. 3458 The hlMatrixControlIndex value in the index identifies the 3459 hlMatrixControlEntry on whose behalf this entry was created. 3460 The first protocolDirLocalIndex value in the index identifies 3461 the network layer protocol of the alMatrixDSSourceAddress and 3462 alMatrixDSDestAddress. 3463 The nlMatrixDSDestAddress value in the index identifies the 3464 network layer address of the destination host in this 3465 conversation. 3466 The nlMatrixDSSourceAddress value in the index identifies the 3467 network layer address of the source host in this conversation. 3468 The second protocolDirLocalIndex value in the index identifies 3469 the protocol that is counted by this entry. 3471 An example of the indexing of this entry is 3472 alMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6.34. 3474 Note that some combinations of index values may result in an 3475 index that exceeds 128 sub-identifiers in length which exceeds 3476 the maximum for the SNMP protocol. Implementations should take 3477 care to avoid such combinations." 3478 INDEX { hlMatrixControlIndex, alMatrixDSTimeMark, 3479 protocolDirLocalIndex, 3480 nlMatrixDSDestAddress, nlMatrixDSSourceAddress, 3481 protocolDirLocalIndex } 3482 ::= { alMatrixDSTable 1 } 3484 AlMatrixDSEntry ::= SEQUENCE { 3485 alMatrixDSTimeMark TimeFilter, 3486 alMatrixDSPkts ZeroBasedCounter32, 3487 alMatrixDSOctets ZeroBasedCounter32, 3488 alMatrixDSCreateTime LastCreateTime 3489 } 3491 alMatrixDSTimeMark OBJECT-TYPE 3492 SYNTAX TimeFilter 3493 MAX-ACCESS not-accessible 3494 STATUS current 3495 DESCRIPTION 3496 "A TimeFilter for this entry. See the TimeFilter textual 3497 convention to see how this works." 3498 ::= { alMatrixDSEntry 1 } 3500 alMatrixDSPkts OBJECT-TYPE 3501 SYNTAX ZeroBasedCounter32 3502 MAX-ACCESS read-only 3503 STATUS current 3504 DESCRIPTION 3505 "The number of packets of this protocol type without errors 3506 transmitted from the source address to the destination address 3507 since this entry was added to the alMatrixDSTable. Note that 3508 this is the number of link-layer packets, so if a single 3509 network-layer packet is fragmented into several link-layer 3510 frames, this counter is incremented several times." 3511 ::= { alMatrixDSEntry 2 } 3513 alMatrixDSOctets OBJECT-TYPE 3514 SYNTAX ZeroBasedCounter32 3515 MAX-ACCESS read-only 3516 STATUS current 3517 DESCRIPTION 3518 "The number of octets in packets of this protocol type 3519 transmitted from the source address to the destination address 3520 since this entry was added to the alMatrixDSTable (excluding 3521 framing bits but including FCS octets), excluding those octets 3522 in packets that contained errors. 3524 Note this doesn't count just those octets in the particular 3525 protocol frames, but includes the entire packet that contained 3526 the protocol." 3527 ::= { alMatrixDSEntry 3 } 3529 alMatrixDSCreateTime OBJECT-TYPE 3530 SYNTAX LastCreateTime 3531 MAX-ACCESS read-only 3532 STATUS current 3533 DESCRIPTION 3534 "The value of sysUpTime when this entry was last activated. 3535 This can be used by the management station to ensure that the 3536 entry has not been deleted and recreated between polls." 3537 ::= { alMatrixDSEntry 4 } 3539 alMatrixTopNControlTable OBJECT-TYPE 3540 SYNTAX SEQUENCE OF AlMatrixTopNControlEntry 3541 MAX-ACCESS not-accessible 3542 STATUS current 3543 DESCRIPTION 3544 "A set of parameters that control the creation of a 3545 report of the top N matrix entries according to 3546 a selected metric." 3547 ::= { alMatrix 3 } 3549 alMatrixTopNControlEntry OBJECT-TYPE 3550 SYNTAX AlMatrixTopNControlEntry 3551 MAX-ACCESS not-accessible 3552 STATUS current 3553 DESCRIPTION 3554 "A conceptual row in the alMatrixTopNControlTable. 3556 An example of the indexing of this table is 3557 alMatrixTopNControlDuration.3" 3558 INDEX { alMatrixTopNControlIndex } 3559 ::= { alMatrixTopNControlTable 1 } 3561 AlMatrixTopNControlEntry ::= SEQUENCE { 3562 alMatrixTopNControlIndex Integer32, 3563 alMatrixTopNControlMatrixIndex Integer32, 3564 alMatrixTopNControlRateBase INTEGER, 3565 alMatrixTopNControlTimeRemaining Integer32, 3566 alMatrixTopNControlGeneratedReports Counter32, 3567 alMatrixTopNControlDuration Integer32, 3568 alMatrixTopNControlRequestedSize Integer32, 3569 alMatrixTopNControlGrantedSize Integer32, 3570 alMatrixTopNControlStartTime TimeStamp, 3571 alMatrixTopNControlOwner OwnerString, 3572 alMatrixTopNControlStatus RowStatus 3573 } 3575 alMatrixTopNControlIndex OBJECT-TYPE 3576 SYNTAX Integer32 (1..65535) 3577 MAX-ACCESS not-accessible 3578 STATUS current 3579 DESCRIPTION 3580 "An index that uniquely identifies an entry 3581 in the alMatrixTopNControlTable. Each such 3582 entry defines one top N report prepared for 3583 one interface." 3584 ::= { alMatrixTopNControlEntry 1 } 3586 alMatrixTopNControlMatrixIndex OBJECT-TYPE 3587 SYNTAX Integer32 (1..65535) 3588 MAX-ACCESS read-create 3589 STATUS current 3590 DESCRIPTION 3591 "The alMatrix[SD/DS] table for which a top N report will be 3592 prepared on behalf of this entry. The alMatrix[SD/DS] table 3593 is identified by the value of the hlMatrixControlIndex 3594 for that table - that value is used here to identify the 3595 particular table. 3597 This object may not be modified if the associated 3598 alMatrixTopNControlStatus object is equal to active(1)." 3599 ::= { alMatrixTopNControlEntry 2 } 3601 alMatrixTopNControlRateBase OBJECT-TYPE 3602 SYNTAX INTEGER { 3603 alMatrixTopNTerminalsPkts(1), 3604 alMatrixTopNTerminalsOctets(2), 3605 alMatrixTopNAllPkts(3), 3606 alMatrixTopNAllOctets(4), 3607 alMatrixTopNTerminalsHighCapacityPkts(5), 3608 alMatrixTopNTerminalsHighCapacityOctets(6), 3609 alMatrixTopNAllHighCapacityPkts(7), 3610 alMatrixTopNAllHighCapacityOctets(8) 3611 } 3612 MAX-ACCESS read-create 3613 STATUS current 3614 DESCRIPTION 3615 "The variable for each alMatrix[SD/DS] entry that the 3616 alMatrixTopNEntries are sorted by, as well as the 3617 selector of the view of the matrix table that will be 3618 used, as well as a control for the table that the results 3619 will be reported in. 3621 The values alMatrixTopNTerminalsPkts, 3622 alMatrixTopNTerminalsOctets, 3623 alMatrixTopNTerminalsHighCapacityPkts, and 3624 alMatrixTopNTerminalsHighCapacityOctets cause collection 3625 only from protocols that have no child protocols that are 3626 counted. The values alMatrixTopNAllPkts, 3627 alMatrixTopNAllOctets, alMatrixTopNAllHighCapacityPkts, and 3628 alMatrixTopNAllHighCapacityOctets cause collection from all 3629 alMatrix entries. 3631 This object may not be modified if the associated 3632 alMatrixTopNControlStatus object is equal to active(1)." 3633 ::= { alMatrixTopNControlEntry 3 } 3635 alMatrixTopNControlTimeRemaining OBJECT-TYPE 3636 SYNTAX Integer32 (0..2147483647) 3637 MAX-ACCESS read-create 3638 STATUS current 3639 DESCRIPTION 3640 "The number of seconds left in the report currently 3641 being collected. When this object is modified by 3642 the management station, a new collection is started, 3643 possibly aborting a currently running report. The 3644 new value is used as the requested duration of this 3645 report, and is immediately loaded into the associated 3646 alMatrixTopNControlDuration object. 3647 When the report finishes, the probe will automatically 3648 start another collection with the same initial value 3649 of alMatrixTopNControlTimeRemaining. Thus the management 3650 station may simply read the resulting reports repeatedly, 3651 checking the startTime and duration each time to ensure that a 3652 report was not missed or that the report parameters were not 3653 changed. 3655 While the value of this object is non-zero, it decrements 3656 by one per second until it reaches zero. At the time 3657 that this object decrements to zero, the report is made 3658 accessible in the alMatrixTopNTable, overwriting any report 3659 that may be there. 3661 When this object is modified by the management station, any 3662 associated entries in the alMatrixTopNTable shall be deleted. 3664 (Note that this is a different algorithm than the one used in 3665 the hostTopNTable)." 3666 DEFVAL { 1800 } 3667 ::= { alMatrixTopNControlEntry 4 } 3669 alMatrixTopNControlGeneratedReports OBJECT-TYPE 3670 SYNTAX Counter32 3671 MAX-ACCESS read-only 3672 STATUS current 3673 DESCRIPTION 3674 "The number of reports that have been generated by this entry." 3675 ::= { alMatrixTopNControlEntry 5 } 3677 alMatrixTopNControlDuration OBJECT-TYPE 3678 SYNTAX Integer32 3679 MAX-ACCESS read-only 3680 STATUS current 3681 DESCRIPTION 3682 "The number of seconds that this report has collected 3683 during the last sampling interval. 3685 When the associated alMatrixTopNControlTimeRemaining object 3686 is set, this object shall be set by the probe to the 3687 same value and shall not be modified until the next 3688 time the alMatrixTopNControlTimeRemaining is set. 3690 This value shall be zero if no reports have been 3691 requested for this alMatrixTopNControlEntry." 3692 ::= { alMatrixTopNControlEntry 6 } 3694 alMatrixTopNControlRequestedSize OBJECT-TYPE 3695 SYNTAX Integer32 (0..2147483647) 3696 MAX-ACCESS read-create 3697 STATUS current 3698 DESCRIPTION 3699 "The maximum number of matrix entries requested for this report. 3701 When this object is created or modified, the probe 3702 should set alMatrixTopNControlGrantedSize as closely to this 3703 object as is possible for the particular probe 3704 implementation and available resources." 3705 DEFVAL { 150 } 3706 ::= { alMatrixTopNControlEntry 7 } 3708 alMatrixTopNControlGrantedSize OBJECT-TYPE 3709 SYNTAX Integer32 (0..2147483647) 3710 MAX-ACCESS read-only 3711 STATUS current 3712 DESCRIPTION 3713 "The maximum number of matrix entries in this report. 3715 When the associated alMatrixTopNControlRequestedSize object 3716 is created or modified, the probe should set this 3717 object as closely to the requested value as is 3718 possible for the particular implementation and 3719 available resources. The probe must not lower this 3720 value except as a result of a set to the associated 3721 alMatrixTopNControlRequestedSize object. 3723 If the value of alMatrixTopNControlRateBase is equal to 3724 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, when the 3725 next topN report is generated, matrix entries with the highest 3726 value of alMatrixTopNPktRate shall be placed in this table in 3727 decreasing order of this rate until there is no more room or 3728 until there are no more matrix entries. 3730 If the value of alMatrixTopNControlRateBase is equal to 3731 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, when the 3732 next topN report is generated, matrix entries with the highest 3733 value of alMatrixTopNOctetRate shall be placed in this table 3734 in decreasing order of this rate until there is no more room 3735 or until there are no more matrix entries. 3737 It is an implementation-specific matter how entries with the 3738 same value of alMatrixTopNPktRate or alMatrixTopNOctetRate are 3739 sorted. It is also an implementation-specific matter as to 3740 whether or not zero-valued entries are available." 3741 ::= { alMatrixTopNControlEntry 8 } 3743 alMatrixTopNControlStartTime OBJECT-TYPE 3744 SYNTAX TimeStamp 3745 MAX-ACCESS read-only 3746 STATUS current 3747 DESCRIPTION 3748 "The value of sysUpTime when this top N report was 3749 last started. In other words, this is the time that 3750 the associated alMatrixTopNControlTimeRemaining object 3751 was modified to start the requested report or the time 3752 the report was last automatically (re)started. 3754 This object may be used by the management station to 3755 determine if a report was missed or not." 3756 ::= { alMatrixTopNControlEntry 9 } 3758 alMatrixTopNControlOwner OBJECT-TYPE 3759 SYNTAX OwnerString 3760 MAX-ACCESS read-create 3761 STATUS current 3762 DESCRIPTION 3763 "The entity that configured this entry and is 3764 therefore using the resources assigned to it." 3765 ::= { alMatrixTopNControlEntry 10 } 3767 alMatrixTopNControlStatus OBJECT-TYPE 3768 SYNTAX RowStatus 3769 MAX-ACCESS read-create 3770 STATUS current 3771 DESCRIPTION 3772 "The status of this alMatrixTopNControlEntry. 3774 An entry may not exist in the active state unless all 3775 objects in the entry have an appropriate value. 3777 If this object is not equal to active(1), all 3778 associated entries in the alMatrixTopNTable shall be 3779 deleted by the agent." 3780 ::= { alMatrixTopNControlEntry 11 } 3782 alMatrixTopNTable OBJECT-TYPE 3783 SYNTAX SEQUENCE OF AlMatrixTopNEntry 3784 MAX-ACCESS not-accessible 3785 STATUS current 3786 DESCRIPTION 3787 "A set of statistics for those application layer matrix 3788 entries that have counted the highest number of octets or 3789 packets." 3790 ::= { alMatrix 4 } 3792 alMatrixTopNEntry OBJECT-TYPE 3793 SYNTAX AlMatrixTopNEntry 3794 MAX-ACCESS not-accessible 3795 STATUS current 3796 DESCRIPTION 3797 "A conceptual row in the alMatrixTopNTable. 3799 The alMatrixTopNControlIndex value in the index identifies 3800 the alMatrixTopNControlEntry on whose behalf this entry was 3801 created. 3803 An example of the indexing of this table is 3804 alMatrixTopNPktRate.3.10" 3805 INDEX { alMatrixTopNControlIndex, alMatrixTopNIndex } 3806 ::= { alMatrixTopNTable 1 } 3808 AlMatrixTopNEntry ::= SEQUENCE { 3809 alMatrixTopNIndex Integer32, 3810 alMatrixTopNProtocolDirLocalIndex Integer32, 3811 alMatrixTopNSourceAddress OCTET STRING, 3812 alMatrixTopNDestAddress OCTET STRING, 3813 alMatrixTopNAppProtocolDirLocalIndex Integer32, 3814 alMatrixTopNPktRate Gauge32, 3815 alMatrixTopNReversePktRate Gauge32, 3816 alMatrixTopNOctetRate Gauge32, 3817 alMatrixTopNReverseOctetRate Gauge32 3818 } 3820 alMatrixTopNIndex OBJECT-TYPE 3821 SYNTAX Integer32 (1..65535) 3822 MAX-ACCESS not-accessible 3823 STATUS current 3824 DESCRIPTION 3825 "An index that uniquely identifies an entry in 3826 the alMatrixTopNTable among those in the same report. 3828 This index is between 1 and N, where N is the 3829 number of entries in this report. 3831 If the value of alMatrixTopNControlRateBase is equal to 3832 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, increasing 3833 values of alMatrixTopNIndex shall be assigned to entries with 3834 decreasing values of alMatrixTopNPktRate until index N is 3835 assigned or there are no more alMatrixTopNEntries. 3837 If the value of alMatrixTopNControlRateBase is equal to 3838 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, 3839 increasing values of alMatrixTopNIndex shall be assigned to 3840 entries with decreasing values of alMatrixTopNOctetRate until 3841 index N is assigned or there are no more alMatrixTopNEntries." 3842 ::= { alMatrixTopNEntry 1 } 3844 alMatrixTopNProtocolDirLocalIndex OBJECT-TYPE 3845 SYNTAX Integer32 (1..2147483647) 3846 MAX-ACCESS read-only 3847 STATUS current 3848 DESCRIPTION 3849 "The protocolDirLocalIndex of the network layer protocol of 3850 this entry's network address." 3851 ::= { alMatrixTopNEntry 2 } 3853 alMatrixTopNSourceAddress OBJECT-TYPE 3854 SYNTAX OCTET STRING (SIZE (1..255)) 3855 MAX-ACCESS read-only 3856 STATUS current 3857 DESCRIPTION 3858 "The network layer address of the source host in this 3859 conversation. 3861 This is represented as an octet string with 3862 specific semantics and length as identified 3863 by the associated alMatrixTopNProtocolDirLocalIndex. 3865 For example, if the alMatrixTopNProtocolDirLocalIndex 3866 indicates an encapsulation of ip, this object is encoded as a 3867 length octet of 4, followed by the 4 octets of the ip address, 3868 in network byte order." 3869 ::= { alMatrixTopNEntry 3 } 3871 alMatrixTopNDestAddress OBJECT-TYPE 3872 SYNTAX OCTET STRING (SIZE (1..255)) 3873 MAX-ACCESS read-only 3874 STATUS current 3875 DESCRIPTION 3876 "The network layer address of the destination host in this 3877 conversation. 3879 This is represented as an octet string with 3880 specific semantics and length as identified 3881 by the associated alMatrixTopNProtocolDirLocalIndex. 3883 For example, if the alMatrixTopNProtocolDirLocalIndex 3884 indicates an encapsulation of ip, this object is encoded as a 3885 length octet of 4, followed by the 4 octets of the ip address, 3886 in network byte order." 3887 ::= { alMatrixTopNEntry 4 } 3889 alMatrixTopNAppProtocolDirLocalIndex OBJECT-TYPE 3890 SYNTAX Integer32 (1..2147483647) 3891 MAX-ACCESS read-only 3892 STATUS current 3893 DESCRIPTION 3894 "The type of the protocol counted by this matrix entry." 3895 ::= { alMatrixTopNEntry 5 } 3897 alMatrixTopNPktRate OBJECT-TYPE 3898 SYNTAX Gauge32 3899 MAX-ACCESS read-only 3900 STATUS current 3901 DESCRIPTION 3902 "The number of packets seen of this protocol from the source 3903 host to the destination host during this sampling interval, 3904 counted using the rules for counting the alMatrixSDPkts 3905 object. 3907 If the value of alMatrixTopNControlRateBase is 3908 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, this 3909 variable will be used to sort this report." 3910 ::= { alMatrixTopNEntry 6 } 3912 alMatrixTopNReversePktRate OBJECT-TYPE 3913 SYNTAX Gauge32 3914 MAX-ACCESS read-only 3915 STATUS current 3916 DESCRIPTION 3917 "The number of packets seen of this protocol from the 3918 destination host to the source host during this sampling 3919 interval, counted using the rules for counting the 3920 alMatrixDSPkts object (note that the corresponding 3921 alMatrixSDPkts object selected is the one whose source address 3922 is equal to alMatrixTopNDestAddress and whose destination 3923 address is equal to alMatrixTopNSourceAddress.) 3925 Note that if the value of alMatrixTopNControlRateBase is equal 3926 to alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, the sort 3927 of topN entries is based entirely on alMatrixTopNPktRate, and 3928 not on the value of this object." 3929 ::= { alMatrixTopNEntry 7 } 3931 alMatrixTopNOctetRate OBJECT-TYPE 3932 SYNTAX Gauge32 3933 MAX-ACCESS read-only 3934 STATUS current 3935 DESCRIPTION 3936 "The number of octets seen of this protocol from the source 3937 host to the destination host during this sampling interval, 3938 counted using the rules for counting the alMatrixSDOctets 3939 object. 3941 If the value of alMatrixTopNControlRateBase is 3942 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, this 3943 variable will be used to sort this report." 3944 ::= { alMatrixTopNEntry 8 } 3946 alMatrixTopNReverseOctetRate OBJECT-TYPE 3947 SYNTAX Gauge32 3948 MAX-ACCESS read-only 3949 STATUS current 3950 DESCRIPTION 3951 "The number of octets seen of this protocol from the 3952 destination host to the source host during this sampling 3953 interval, counted using the rules for counting the 3954 alMatrixDSOctets object (note that the corresponding 3955 alMatrixSDOctets object selected is the one whose source 3956 address is equal to alMatrixTopNDestAddress and whose 3957 destination address is equal to alMatrixTopNSourceAddress.) 3959 Note that if the value of alMatrixTopNControlRateBase is equal 3960 to alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, the 3961 sort of topN entries is based entirely on 3962 alMatrixTopNOctetRate, and not on the value of this object." 3963 ::= { alMatrixTopNEntry 9 } 3965 -- 3966 -- User History Collection Group (usrHistory) 3967 -- 3968 -- The usrHistory group combines mechanisms seen in the alarm and 3969 -- history groups to provide user-specified history collection, 3970 -- utilizing two additional control tables and one additional data 3971 -- table. This function has traditionally been done by NMS 3972 -- applications, via periodic polling. The usrHistory group allows 3973 -- this task to be offloaded to an RMON probe. 3974 -- 3975 -- Data (an ASN.1 INTEGER based object) is collected in the same 3976 -- manner as any history data table (e.g. etherHistoryTable) except 3977 -- that the user specifies the MIB instances to be collected. Objects 3978 -- are collected in bucket-groups, with the intent that all MIB 3979 -- instances in the same bucket-group are collected as atomically as 3980 -- possible by the RMON probe. 3981 -- 3982 -- The usrHistoryControlTable is a one-dimensional read-create table. 3983 -- Each row configures a collection of user history buckets, much 3984 -- the same as a historyControlEntry, except that the creation of a 3985 -- row in this table will cause one or more associated instances in 3986 -- the usrHistoryObjectTable to be created. The user specifies the 3987 -- number of bucket elements (rows in the usrHistoryObjectTable) 3988 -- requested, as well as the number of buckets requested. 3989 -- 3990 -- The usrHistoryObjectTable is a 2-d read-write table. 3991 -- Each row configures a single MIB instance to be collected. 3992 -- All rows with the same major index constitute a bucket-group. 3993 -- 3994 -- The usrHistoryTable is a 3-d read-only table containing 3995 -- the data of associated usrHistoryControlEntries. Each 3996 -- entry represents the value of a single MIB instance 3997 -- during a specific sampling interval (or the rate of 3998 -- change during the interval). 3999 -- 4000 -- A sample value is stored in two objects - an absolute value and 4001 -- a status object. This allows numbers from -(2G-1) to +4G to be 4002 -- stored. The status object also indicates whether a sample is 4003 -- valid. This allows data collection to continue if periodic 4004 -- retrieval of a particular instance fails for any reason. 4005 -- 4006 -- Row Creation Order Relationships 4007 -- 4008 -- The static nature of the usrHistoryObjectTable creates 4009 -- some row creation/modification issues. The rows in this 4010 -- table need to be set before the associated 4011 -- usrHistoryControlEntry can be activated. 4012 -- 4013 -- Note that the usrHistoryObject entries associated with a 4014 -- particular usrHistoryControlEntry are not required to 4015 -- be active before the control entry is activated. However, 4016 -- the usrHistory data entries associated with an inactive 4017 -- usrHistoryObject entry will be inactive (i.e. 4018 -- usrHistoryValStatus == valueNotAvailable). 4019 -- 4021 usrHistoryControlTable OBJECT-TYPE 4022 SYNTAX SEQUENCE OF UsrHistoryControlEntry 4023 MAX-ACCESS not-accessible 4024 STATUS current 4025 DESCRIPTION 4026 "A list of data-collection configuration entries." 4027 ::= { usrHistory 1 } 4029 usrHistoryControlEntry OBJECT-TYPE 4030 SYNTAX UsrHistoryControlEntry 4031 MAX-ACCESS not-accessible 4032 STATUS current 4033 DESCRIPTION 4034 "A list of parameters that set up a group of user-defined 4035 MIB objects to be sampled periodically (called a 4036 bucket-group). 4038 For example, an instance of usrHistoryControlInterval 4039 might be named usrHistoryControlInterval.1" 4040 INDEX { usrHistoryControlIndex } 4041 ::= { usrHistoryControlTable 1 } 4043 UsrHistoryControlEntry ::= SEQUENCE { 4044 usrHistoryControlIndex Integer32, 4045 usrHistoryControlObjects Integer32, 4046 usrHistoryControlBucketsRequested Integer32, 4047 usrHistoryControlBucketsGranted Integer32, 4048 usrHistoryControlInterval Integer32, 4049 usrHistoryControlOwner OwnerString, 4050 usrHistoryControlStatus RowStatus 4051 } 4053 usrHistoryControlIndex OBJECT-TYPE 4054 SYNTAX Integer32 (1..65535) 4055 MAX-ACCESS not-accessible 4056 STATUS current 4057 DESCRIPTION 4058 "An index that uniquely identifies an entry in the 4059 usrHistoryControlTable. Each such entry defines a 4060 set of samples at a particular interval for a specified 4061 set of MIB instances available from the managed system." 4062 ::= { usrHistoryControlEntry 1 } 4064 usrHistoryControlObjects OBJECT-TYPE 4065 SYNTAX Integer32 (1..65535) 4066 MAX-ACCESS read-create 4067 STATUS current 4068 DESCRIPTION 4069 "The number of MIB objects to be collected 4070 in the portion of usrHistoryTable associated with this 4071 usrHistoryControlEntry. 4073 This object may not be modified if the associated instance 4074 of usrHistoryControlStatus is equal to active(1)." 4075 ::= { usrHistoryControlEntry 2 } 4077 usrHistoryControlBucketsRequested OBJECT-TYPE 4078 SYNTAX Integer32 (1..65535) 4079 MAX-ACCESS read-create 4080 STATUS current 4081 DESCRIPTION 4082 "The requested number of discrete time intervals 4083 over which data is to be saved in the part of the 4084 usrHistoryTable associated with this usrHistoryControlEntry. 4086 When this object is created or modified, the probe 4087 should set usrHistoryControlBucketsGranted as closely to 4088 this object as is possible for the particular probe 4089 implementation and available resources." 4090 DEFVAL { 50 } 4091 ::= { usrHistoryControlEntry 3 } 4093 usrHistoryControlBucketsGranted OBJECT-TYPE 4094 SYNTAX Integer32 (1..65535) 4095 MAX-ACCESS read-only 4096 STATUS current 4097 DESCRIPTION 4098 "The number of discrete sampling intervals 4099 over which data shall be saved in the part of 4100 the usrHistoryTable associated with this 4101 usrHistoryControlEntry. 4103 When the associated usrHistoryControlBucketsRequested 4104 object is created or modified, the probe should set 4105 this object as closely to the requested value as is 4106 possible for the particular probe implementation and 4107 available resources. The probe must not lower this 4108 value except as a result of a modification to the associated 4109 usrHistoryControlBucketsRequested object. 4111 The associated usrHistoryControlBucketsRequested object 4112 should be set before or at the same time as this object 4113 to allow the probe to accurately estimate the resources 4114 required for this usrHistoryControlEntry. 4116 There will be times when the actual number of buckets 4117 associated with this entry is less than the value of 4118 this object. In this case, at the end of each sampling 4119 interval, a new bucket will be added to the usrHistoryTable. 4121 When the number of buckets reaches the value of this object 4122 and a new bucket is to be added to the usrHistoryTable, 4123 the oldest bucket associated with this usrHistoryControlEntry 4124 shall be deleted by the agent so that the new bucket can be 4125 added. 4127 When the value of this object changes to a value less than 4128 the current value, entries are deleted from the 4129 usrHistoryTable associated with this usrHistoryControlEntry. 4130 Enough of the oldest of these entries shall be deleted by the 4131 agent so that their number remains less than or equal to the 4132 new value of this object. 4134 When the value of this object changes to a value greater 4135 than the current value, the number of associated usrHistory 4136 entries may be allowed to grow." 4138 ::= { usrHistoryControlEntry 4 } 4140 usrHistoryControlInterval OBJECT-TYPE 4141 SYNTAX Integer32 (1..2147483647) 4142 MAX-ACCESS read-create 4143 STATUS current 4144 DESCRIPTION 4145 "The interval in seconds over which the data is 4146 sampled for each bucket in the part of the usrHistory 4147 table associated with this usrHistoryControlEntry. 4149 Because the counters in a bucket may overflow at their 4150 maximum value with no indication, a prudent manager will 4151 take into account the possibility of overflow in any of 4152 the associated counters. It is important to consider the 4153 minimum time in which any counter could overflow on a 4154 particular media type and set the usrHistoryControlInterval 4155 object to a value less than this interval. 4157 This object may not be modified if the associated 4158 usrHistoryControlStatus object is equal to active(1)." 4159 DEFVAL { 1800 } 4160 ::= { usrHistoryControlEntry 5 } 4162 usrHistoryControlOwner OBJECT-TYPE 4163 SYNTAX OwnerString 4164 MAX-ACCESS read-create 4165 STATUS current 4166 DESCRIPTION 4167 "The entity that configured this entry and is 4168 therefore using the resources assigned to it." 4169 ::= { usrHistoryControlEntry 6 } 4171 usrHistoryControlStatus OBJECT-TYPE 4172 SYNTAX RowStatus 4173 MAX-ACCESS read-create 4174 STATUS current 4175 DESCRIPTION 4176 "The status of this variable history control entry. 4178 An entry may not exist in the active state unless all 4179 objects in the entry have an appropriate value. 4181 If this object is not equal to active(1), all associated 4182 entries in the usrHistoryTable shall be deleted." 4183 ::= { usrHistoryControlEntry 7 } 4185 -- Object table 4187 usrHistoryObjectTable OBJECT-TYPE 4188 SYNTAX SEQUENCE OF UsrHistoryObjectEntry 4189 MAX-ACCESS not-accessible 4190 STATUS current 4191 DESCRIPTION 4192 "A list of data-collection configuration entries." 4193 ::= { usrHistory 2 } 4195 usrHistoryObjectEntry OBJECT-TYPE 4196 SYNTAX UsrHistoryObjectEntry 4197 MAX-ACCESS not-accessible 4198 STATUS current 4199 DESCRIPTION 4200 "A list of MIB instances to be sampled periodically. 4202 Entries in this table are created when an associated 4203 usrHistoryControlObjects object is created. 4205 The usrHistoryControlIndex value in the index is 4206 that of the associated usrHistoryControlEntry. 4208 For example, an instance of usrHistoryObjectVariable might be 4209 usrHistoryObjectVariable.1.3" 4210 INDEX { usrHistoryControlIndex, usrHistoryObjectIndex } 4211 ::= { usrHistoryObjectTable 1 } 4213 UsrHistoryObjectEntry ::= SEQUENCE { 4214 usrHistoryObjectIndex Integer32, 4215 usrHistoryObjectVariable OBJECT IDENTIFIER, 4216 usrHistoryObjectSampleType INTEGER 4217 } 4219 usrHistoryObjectIndex OBJECT-TYPE 4220 SYNTAX Integer32 (1..65535) 4221 MAX-ACCESS not-accessible 4222 STATUS current 4223 DESCRIPTION 4224 "An index used to uniquely identify an entry in the 4225 usrHistoryObject table. Each such entry defines a 4226 MIB instance to be collected periodically." 4227 ::= { usrHistoryObjectEntry 1 } 4229 usrHistoryObjectVariable OBJECT-TYPE 4230 SYNTAX OBJECT IDENTIFIER 4231 MAX-ACCESS read-create 4232 STATUS current 4233 DESCRIPTION 4234 "The object identifier of the particular variable to be 4235 sampled. 4237 Only variables that resolve to an ASN.1 primitive type of 4238 Integer32 (Integer32, Counter, Gauge, or TimeTicks) may be 4239 sampled. 4241 Because SNMP access control is articulated entirely in terms 4242 of the contents of MIB views, no access control mechanism 4243 exists that can restrict the value of this object to identify 4244 only those objects that exist in a particular MIB view. 4245 Because there is thus no acceptable means of restricting the 4246 read access that could be obtained through the user history 4247 mechanism, the probe must only grant write access to this 4248 object in those views that have read access to all objects on 4249 the probe. See USM [RFC3414] and VACM [RFC3415] for more 4250 information. 4252 During a set operation, if the supplied variable name is not 4253 available in the selected MIB view, a badValue error must be 4254 returned. 4256 This object may not be modified if the associated 4257 usrHistoryControlStatus object is equal to active(1)." 4258 ::= { usrHistoryObjectEntry 2 } 4260 usrHistoryObjectSampleType OBJECT-TYPE 4261 SYNTAX INTEGER { 4262 absoluteValue(1), 4263 deltaValue(2) 4264 } 4265 MAX-ACCESS read-create 4266 STATUS current 4267 DESCRIPTION 4268 "The method of sampling the selected variable for storage in 4269 the usrHistoryTable. 4271 If the value of this object is absoluteValue(1), the value of 4272 the selected variable will be copied directly into the history 4273 bucket. 4275 If the value of this object is deltaValue(2), the value of the 4276 selected variable at the last sample will be subtracted from 4277 the current value, and the difference will be stored in the 4278 history bucket. If the associated usrHistoryObjectVariable 4279 instance could not be obtained at the previous sample 4280 interval, then a delta sample is not possible, and the value 4281 of the associated usrHistoryValStatus object for this interval 4282 will be valueNotAvailable(1). 4284 This object may not be modified if the associated 4285 usrHistoryControlStatus object is equal to active(1)." 4286 ::= { usrHistoryObjectEntry 3 } 4288 -- data table 4290 usrHistoryTable OBJECT-TYPE 4291 SYNTAX SEQUENCE OF UsrHistoryEntry 4292 MAX-ACCESS not-accessible 4293 STATUS current 4294 DESCRIPTION 4295 "A list of user defined history entries." 4296 ::= { usrHistory 3 } 4298 usrHistoryEntry OBJECT-TYPE 4299 SYNTAX UsrHistoryEntry 4300 MAX-ACCESS not-accessible 4301 STATUS current 4302 DESCRIPTION 4303 "A historical sample of user-defined variables. This sample 4304 is associated with the usrHistoryControlEntry which set up the 4305 parameters for a regular collection of these samples. 4307 The usrHistoryControlIndex value in the index identifies the 4308 usrHistoryControlEntry on whose behalf this entry was created. 4309 The usrHistoryObjectIndex value in the index identifies the 4310 usrHistoryObjectEntry on whose behalf this entry was created. 4312 For example, an instance of usrHistoryAbsValue, which represents 4313 the 14th sample of a variable collected as specified by 4314 usrHistoryControlEntry.1 and usrHistoryObjectEntry.1.5, 4315 would be named usrHistoryAbsValue.1.14.5" 4316 INDEX { usrHistoryControlIndex, usrHistorySampleIndex, 4317 usrHistoryObjectIndex } 4318 ::= { usrHistoryTable 1 } 4320 UsrHistoryEntry ::= SEQUENCE { 4321 usrHistorySampleIndex Integer32, 4322 usrHistoryIntervalStart TimeStamp, 4323 usrHistoryIntervalEnd TimeStamp, 4324 usrHistoryAbsValue Gauge32, 4325 usrHistoryValStatus INTEGER 4326 } 4328 usrHistorySampleIndex OBJECT-TYPE 4329 SYNTAX Integer32 (1..2147483647) 4330 MAX-ACCESS not-accessible 4331 STATUS current 4332 DESCRIPTION 4333 "An index that uniquely identifies the particular sample this 4334 entry represents among all samples associated with the same 4335 usrHistoryControlEntry. This index starts at 1 and increases 4336 by one as each new sample is taken." 4337 ::= { usrHistoryEntry 1 } 4339 usrHistoryIntervalStart OBJECT-TYPE 4340 SYNTAX TimeStamp 4341 MAX-ACCESS read-only 4342 STATUS current 4343 DESCRIPTION 4344 "The value of sysUpTime at the start of the interval over 4345 which this sample was measured. If the probe keeps track of 4346 the time of day, it should start the first sample of the 4347 history at a time such that when the next hour of the day 4348 begins, a sample is started at that instant. 4350 Note that following this rule may require the probe to delay 4351 collecting the first sample of the history, as each sample 4352 must be of the same interval. Also note that the sample which 4353 is currently being collected is not accessible in this table 4354 until the end of its interval." 4355 ::= { usrHistoryEntry 2 } 4357 usrHistoryIntervalEnd OBJECT-TYPE 4358 SYNTAX TimeStamp 4359 MAX-ACCESS read-only 4360 STATUS current 4361 DESCRIPTION 4362 "The value of sysUpTime at the end of the interval over which 4363 this sample was measured." 4364 ::= { usrHistoryEntry 3 } 4366 usrHistoryAbsValue OBJECT-TYPE 4367 SYNTAX Gauge32 4368 MAX-ACCESS read-only 4369 STATUS current 4370 DESCRIPTION 4371 "The absolute value (i.e. unsigned value) of the 4372 user-specified statistic during the last sampling period. The 4373 value during the current sampling period is not made available 4374 until the period is completed. 4376 To obtain the true value for this sampling interval, the 4377 associated instance of usrHistoryValStatus must be checked, 4378 and usrHistoryAbsValue adjusted as necessary. 4380 If the MIB instance could not be accessed during the sampling 4381 interval, then this object will have a value of zero and the 4382 associated instance of usrHistoryValStatus will be set to 4383 'valueNotAvailable(1)'. 4385 The access control check prescribed in the definition of 4386 usrHistoryObjectVariable SHOULD be checked for each sampling 4387 interval. If this check determines that access should not be 4388 allowed, then this object will have a value of zero and the 4389 associated instance of usrHistoryValStatus will be set to 4390 'valueNotAvailable(1)'." 4391 ::= { usrHistoryEntry 4 } 4393 usrHistoryValStatus OBJECT-TYPE 4394 SYNTAX INTEGER { 4395 valueNotAvailable(1), 4396 valuePositive(2), 4397 valueNegative(3) 4398 } 4399 MAX-ACCESS read-only 4400 STATUS current 4401 DESCRIPTION 4402 "This object indicates the validity and sign of the data in 4403 the associated instance of usrHistoryAbsValue. 4405 If the MIB instance could not be accessed during the sampling 4406 interval, then 'valueNotAvailable(1)' will be returned. 4408 If the sample is valid and actual value of the sample is 4409 greater than or equal to zero then 'valuePositive(2)' is 4410 returned. 4412 If the sample is valid and the actual value of the sample is 4413 less than zero, 'valueNegative(3)' will be returned. The 4414 associated instance of usrHistoryAbsValue should be multiplied 4415 by -1 to obtain the true sample value." 4416 ::= { usrHistoryEntry 5 } 4418 -- The Probe Configuration Group 4419 -- 4420 -- This group controls the configuration of various operating 4421 -- parameters of the probe. 4423 ControlString ::= TEXTUAL-CONVENTION 4424 STATUS current 4425 DESCRIPTION 4426 "This data type is used to communicate with a modem or a 4427 serial data switch. A ControlString contains embedded 4428 commands to control how the device will interact with the 4429 remote device through the serial interface. Commands are 4430 represented as two character sequences beginning with 4431 the `^' character. 4433 The following commands are recognized by the device (note 4434 that command characters are case sensitive): 4436 ^s Send string that follows which is terminated by the 4437 next command or the end of string. 4438 ^c Delay for the number of seconds that follows. Toss 4439 out any data received rather than storing it in a 4440 buffer for parsing. 4441 ^t Set timeout to the value represented by the decimal 4442 digits that follow. The default timeout is 20 4443 seconds. Note that this timeout may be overridden 4444 by a smaller serialTimeout configured for the 4445 associated serial interface (see serialConfigTable). 4446 ^w Wait for the reply string that follows which is 4447 terminated by the next command or the end of string. 4448 Partial and case insensitive matching is applied, ie. 4449 if the reply string (any case combination) is found 4450 anywhere in the received string, then the a match is 4451 found. If the current timeout elapses without a match, 4452 then the remaining control string is ignored. 4453 ^! The ^ character. 4454 ^d Delay the number of seconds specified by the decimal 4455 digits that follow. 4456 ^b Send break for the number of milliseconds specified by 4457 the decimal digits that follow. If no digits follow, 4458 break will be enforced for 250 milliseconds by default. 4460 The following ASCII control characters may be inserted into 4461 the `^s' send string or the `^w' reply string: 4463 ^@ 0x00 4464 ^A 0x01 4465 .. 4466 ^M 0x0D 4467 .. 4468 ^Z 0x1A 4469 ^[ 0x1B 4470 ^ 0x1C 4471 ^] 0x1D 4472 ^^ 0x1E 4473 ^_ 0x1F 4475 Binary data may also be inserted into the data stream. The 4476 control sequence for each byte of binary data is ^0x##, where 4477 ## is the hexadecimal representation of the data byte. Two 4478 ASCII characters (0-9, a-f, A-F) must follow the `^0x' 4479 control prefix. For example, `^0x0D^0x0A' is interpreted as a 4480 carriage return followed by a line feed." 4481 SYNTAX OCTET STRING (SIZE (0..255)) 4483 probeCapabilities OBJECT-TYPE 4484 SYNTAX BITS { 4485 etherStats(0), 4486 historyControl(1), 4487 etherHistory(2), 4488 alarm(3), 4489 hosts(4), 4490 hostTopN(5), 4491 matrix(6), 4492 filter(7), 4493 capture(8), 4494 event(9), 4495 tokenRingMLStats(10), 4496 tokenRingPStats(11), 4497 tokenRingMLHistory(12), 4498 tokenRingPHistory(13), 4499 ringStation(14), 4500 ringStationOrder(15), 4501 ringStationConfig(16), 4502 sourceRouting(17), 4503 protocolDirectory(18), 4504 protocolDistribution(19), 4505 addressMapping(20), 4506 nlHost(21), 4507 nlMatrix(22), 4508 alHost(23), 4509 alMatrix(24), 4510 usrHistory(25), 4511 probeConfig(26) 4512 } 4513 MAX-ACCESS read-only 4514 STATUS current 4515 DESCRIPTION 4516 "An indication of the RMON MIB groups supported 4517 on at least one interface by this probe." 4518 ::= { probeConfig 1 } 4520 probeSoftwareRev OBJECT-TYPE 4521 SYNTAX DisplayString (SIZE(0..15)) 4522 MAX-ACCESS read-only 4523 STATUS current 4524 DESCRIPTION 4525 "The software revision of this device. This string will have 4526 a zero length if the revision is unknown." 4527 ::= { probeConfig 2 } 4529 probeHardwareRev OBJECT-TYPE 4530 SYNTAX DisplayString (SIZE(0..31)) 4531 MAX-ACCESS read-only 4532 STATUS current 4533 DESCRIPTION 4534 "The hardware revision of this device. This string will have 4535 a zero length if the revision is unknown." 4536 ::= { probeConfig 3 } 4538 probeDateTime OBJECT-TYPE 4539 SYNTAX OCTET STRING (SIZE (0 | 8 | 11)) 4540 MAX-ACCESS read-write 4541 STATUS current 4542 DESCRIPTION 4543 "Probe's current date and time. 4545 field octets contents range 4546 ----- ------ -------- ----- 4547 1 1-2 year 0..65536 4548 2 3 month 1..12 4549 3 4 day 1..31 4550 4 5 hour 0..23 4551 5 6 minutes 0..59 4552 6 7 seconds 0..60 4553 (use 60 for leap-second) 4554 7 8 deci-seconds 0..9 4555 8 9 direction from UTC '+' / '-' 4556 9 10 hours from UTC 0..11 4557 10 11 minutes from UTC 0..59 4559 For example, Tuesday May 26, 1992 at 1:30:15 PM 4560 EDT would be displayed as: 4562 1992-5-26,13:30:15.0,-4:0 4564 Note that if only local time is known, then 4565 timezone information (fields 8-10) is not 4566 present, and if no time information is known, the null 4567 string is returned." 4568 ::= { probeConfig 4 } 4570 probeResetControl OBJECT-TYPE 4571 SYNTAX INTEGER { 4572 running(1), 4573 warmBoot(2), 4574 coldBoot(3) 4575 } 4577 MAX-ACCESS read-write 4578 STATUS current 4579 DESCRIPTION 4580 "Setting this object to warmBoot(2) causes the device to 4581 restart the application software with current configuration 4582 parameters saved in non-volatile memory. Setting this 4583 object to coldBoot(3) causes the device to reinitialize 4584 configuration parameters in non-volatile memory to default 4585 values and restart the application software. When the device 4586 is running normally, this variable has a value of 4587 running(1)." 4588 ::= { probeConfig 5 } 4590 -- The following download objects do not restrict an implementation 4591 -- from implementing additional download mechanisms (controlled in an 4592 -- implementation-specific manner). Further, in the case where the RMON 4593 -- agent shares a processor with other types of systems, the 4594 -- implementation is not required to download those non-RMON functions 4595 -- with this mechanism. 4597 probeDownloadFile OBJECT-TYPE 4598 SYNTAX DisplayString (SIZE(0..127)) 4599 MAX-ACCESS read-write 4600 STATUS deprecated 4601 DESCRIPTION 4602 "The file name to be downloaded from the TFTP server when a 4603 download is next requested via this MIB. This value is set to 4604 the zero length string when no file name has been specified. 4606 This object has been deprecated as it has not had enough 4607 independent implementations to demonstrate interoperability to 4608 meet the requirements of a Draft Standard." 4609 ::= { probeConfig 6 } 4611 probeDownloadTFTPServer OBJECT-TYPE 4612 SYNTAX IpAddress 4613 MAX-ACCESS read-write 4614 STATUS deprecated 4615 DESCRIPTION 4616 "The IP address of the TFTP server that contains the boot 4617 image to load when a download is next requested via this MIB. 4618 This value is set to `0.0.0.0' when no IP address has been 4619 specified. 4621 This object has been deprecated as it has not had enough 4622 independent implementations to demonstrate interoperability to 4623 meet the requirements of a Draft Standard." 4624 ::= { probeConfig 7 } 4626 probeDownloadAction OBJECT-TYPE 4627 SYNTAX INTEGER { 4628 notDownloading(1), 4629 downloadToPROM(2), 4630 downloadToRAM(3) 4631 } 4632 MAX-ACCESS read-write 4633 STATUS deprecated 4634 DESCRIPTION 4635 "When this object is set to downloadToRAM(3) or 4636 downloadToPROM(2), the device will discontinue its 4637 normal operation and begin download of the image specified 4638 by probeDownloadFile from the server specified by 4639 probeDownloadTFTPServer using the TFTP protocol. If 4640 downloadToRAM(3) is specified, the new image is copied 4641 to RAM only (the old image remains unaltered in the flash 4642 EPROM). If downloadToPROM(2) is specified 4643 the new image is written to the flash EPROM 4644 memory after its checksum has been verified to be correct. 4645 When the download process is completed, the device will 4646 warm boot to restart the newly loaded application. 4647 When the device is not downloading, this object will have 4648 a value of notDownloading(1). 4650 This object has been deprecated as it has not had enough 4651 independent implementations to demonstrate interoperability to 4652 meet the requirements of a Draft Standard." 4653 ::= { probeConfig 8 } 4655 probeDownloadStatus OBJECT-TYPE 4656 SYNTAX INTEGER { 4657 downloadSuccess(1), 4658 downloadStatusUnknown(2), 4659 downloadGeneralError(3), 4660 downloadNoResponseFromServer(4), 4661 downloadChecksumError(5), 4662 downloadIncompatibleImage(6), 4663 downloadTftpFileNotFound(7), 4664 downloadTftpAccessViolation(8) 4666 } 4667 MAX-ACCESS read-only 4668 STATUS deprecated 4669 DESCRIPTION 4670 "The status of the last download procedure, if any. This 4671 object will have a value of downloadStatusUnknown(2) if no 4672 download process has been performed. 4674 This object has been deprecated as it has not had enough 4675 independent implementations to demonstrate interoperability to 4676 meet the requirements of a Draft Standard." 4677 ::= { probeConfig 9 } 4679 serialConfigTable OBJECT-TYPE 4680 SYNTAX SEQUENCE OF SerialConfigEntry 4681 MAX-ACCESS not-accessible 4682 STATUS deprecated 4683 DESCRIPTION 4684 "A table of serial interface configuration entries. This data 4685 will be stored in non-volatile memory and preserved across 4686 probe resets or power loss. 4688 This table has been deprecated as it has not had enough 4689 independent implementations to demonstrate interoperability to 4690 meet the requirements of a Draft Standard." 4691 ::= { probeConfig 10 } 4693 serialConfigEntry OBJECT-TYPE 4694 SYNTAX SerialConfigEntry 4695 MAX-ACCESS not-accessible 4696 STATUS deprecated 4697 DESCRIPTION 4698 "A set of configuration parameters for a particular 4699 serial interface on this device. If the device has no serial 4700 interfaces, this table is empty. 4702 The index is composed of the ifIndex assigned to this serial 4703 line interface." 4704 INDEX { ifIndex } 4705 ::= { serialConfigTable 1 } 4707 SerialConfigEntry ::= SEQUENCE { 4708 serialMode INTEGER, 4709 serialProtocol INTEGER, 4710 serialTimeout Integer32, 4711 serialModemInitString ControlString, 4712 serialModemHangUpString ControlString, 4713 serialModemConnectResp DisplayString, 4714 serialModemNoConnectResp DisplayString, 4715 serialDialoutTimeout Integer32, 4716 serialStatus RowStatus 4717 } 4719 serialMode OBJECT-TYPE 4720 SYNTAX INTEGER { 4721 direct(1), 4722 modem(2) 4723 } 4724 MAX-ACCESS read-create 4725 STATUS deprecated 4726 DESCRIPTION 4727 "The type of incoming connection to expect on this serial 4728 interface." 4729 DEFVAL { direct } 4730 ::= { serialConfigEntry 1 } 4732 serialProtocol OBJECT-TYPE 4733 SYNTAX INTEGER { 4734 other(1), 4735 slip(2), 4736 ppp(3) 4737 } 4738 MAX-ACCESS read-create 4739 STATUS deprecated 4740 DESCRIPTION 4741 "The type of data link encapsulation to be used on this 4742 serial interface." 4743 DEFVAL { slip } 4744 ::= { serialConfigEntry 2 } 4746 serialTimeout OBJECT-TYPE 4747 SYNTAX Integer32 (1..65535) 4748 MAX-ACCESS read-create 4749 STATUS deprecated 4750 DESCRIPTION 4751 "This timeout value is used when the Management Station has 4752 initiated the conversation over the serial link. This variable 4753 represents the number of seconds of inactivity allowed before 4754 terminating the connection on this serial interface. Use the 4755 serialDialoutTimeout in the case where the probe has initiated 4756 the connection for the purpose of sending a trap." 4757 DEFVAL { 300 } 4758 ::= { serialConfigEntry 3 } 4760 serialModemInitString OBJECT-TYPE 4761 SYNTAX ControlString (SIZE (0..255)) 4762 MAX-ACCESS read-create 4763 STATUS deprecated 4764 DESCRIPTION 4765 "A control string which controls how a modem attached to this 4766 serial interface should be initialized. The initialization 4767 is performed once during startup and again after each 4768 connection is terminated if the associated serialMode has the 4769 value of modem(2). 4771 A control string that is appropriate for a wide variety of 4772 modems is: '^s^MATE0Q0V1X4 S0=1 S2=43^M'." 4773 ::= { serialConfigEntry 4 } 4775 serialModemHangUpString OBJECT-TYPE 4776 SYNTAX ControlString (SIZE (0..255)) 4777 MAX-ACCESS read-create 4778 STATUS deprecated 4779 DESCRIPTION 4780 "A control string which specifies how to disconnect a modem 4781 connection on this serial interface. This object is only 4782 meaningful if the associated serialMode has the value 4783 of modem(2). 4784 A control string that is appropriate for a wide variety of 4785 modems is: '^d2^s+++^d2^sATH0^M^d2'." 4786 ::= { serialConfigEntry 5 } 4788 serialModemConnectResp OBJECT-TYPE 4789 SYNTAX DisplayString (SIZE (0..255)) 4790 MAX-ACCESS read-create 4791 STATUS deprecated 4792 DESCRIPTION 4793 "An ASCII string containing substrings that describe the 4794 expected modem connection response code and associated bps 4795 rate. The substrings are delimited by the first character 4796 in the string, for example: 4797 /CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 4798 CONNECT 4800/4800/CONNECT 9600/9600 4799 will be interpreted as: 4800 response code bps rate 4801 CONNECT 300 4802 CONNECT 1200 1200 4803 CONNECT 2400 2400 4804 CONNECT 4800 4800 4805 CONNECT 9600 9600 4806 The agent will use the information in this string to adjust 4807 the bps rate of this serial interface once a modem connection 4808 is established. 4810 A value that is appropriate for a wide variety of modems is: 4811 '/CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 4812 CONNECT 4800/4800/CONNECT 9600/9600/CONNECT 14400/14400/ 4813 CONNECT 19200/19200/CONNECT 38400/38400/'." 4814 ::= { serialConfigEntry 6 } 4816 serialModemNoConnectResp OBJECT-TYPE 4817 SYNTAX DisplayString (SIZE (0..255)) 4818 MAX-ACCESS read-create 4819 STATUS deprecated 4820 DESCRIPTION 4821 "An ASCII string containing response codes that may be 4822 generated by a modem to report the reason why a connection 4823 attempt has failed. The response codes are delimited by 4824 the first character in the string, for example: 4825 /NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/ 4826 If one of these response codes is received via this serial 4827 interface while attempting to make a modem connection, 4828 the agent will issue the hang up command as specified by 4829 serialModemHangUpString. 4831 A value that is appropriate for a wide variety of modems is: 4832 '/NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/'." 4833 ::= { serialConfigEntry 7 } 4835 serialDialoutTimeout OBJECT-TYPE 4836 SYNTAX Integer32 (1..65535) 4837 MAX-ACCESS read-create 4838 STATUS deprecated 4839 DESCRIPTION 4840 "This timeout value is used when the probe initiates the 4841 serial connection with the intention of contacting a 4842 management station. This variable represents the number 4843 of seconds of inactivity allowed before terminating the 4844 connection on this serial interface." 4845 DEFVAL { 20 } 4846 ::= { serialConfigEntry 8 } 4848 serialStatus OBJECT-TYPE 4849 SYNTAX RowStatus 4850 MAX-ACCESS read-create 4851 STATUS deprecated 4852 DESCRIPTION 4853 "The status of this serialConfigEntry. 4855 An entry may not exist in the active state unless all 4856 objects in the entry have an appropriate value." 4857 ::= { serialConfigEntry 9 } 4859 netConfigTable OBJECT-TYPE 4860 SYNTAX SEQUENCE OF NetConfigEntry 4861 MAX-ACCESS not-accessible 4862 STATUS deprecated 4863 DESCRIPTION 4864 "A table of netConfigEntries. 4866 This table has been deprecated as it has not had enough 4867 independent implementations to demonstrate interoperability to 4868 meet the requirements of a Draft Standard." 4869 ::= { probeConfig 11 } 4871 netConfigEntry OBJECT-TYPE 4872 SYNTAX NetConfigEntry 4873 MAX-ACCESS not-accessible 4874 STATUS deprecated 4875 DESCRIPTION 4876 "A set of configuration parameters for a particular 4877 network interface on this device. If the device has no network 4878 interface, this table is empty. 4880 The index is composed of the ifIndex assigned to the 4881 corresponding interface." 4882 INDEX { ifIndex } 4883 ::= { netConfigTable 1 } 4885 NetConfigEntry ::= SEQUENCE { 4886 netConfigIPAddress IpAddress, 4887 netConfigSubnetMask IpAddress, 4888 netConfigStatus RowStatus 4889 } 4891 netConfigIPAddress OBJECT-TYPE 4892 SYNTAX IpAddress 4893 MAX-ACCESS read-create 4894 STATUS deprecated 4895 DESCRIPTION 4896 "The IP address of this Net interface. The default value 4897 for this object is 0.0.0.0. If either the netConfigIPAddress 4898 or netConfigSubnetMask are 0.0.0.0, then when the device 4899 boots, it may use BOOTP to try to figure out what these 4900 values should be. If BOOTP fails, before the device 4901 can talk on the network, this value must be configured 4902 (e.g., through a terminal attached to the device). If BOOTP is 4903 used, care should be taken to not send BOOTP broadcasts too 4904 frequently and to eventually send very infrequently if no 4905 replies are received." 4906 ::= { netConfigEntry 1 } 4908 netConfigSubnetMask OBJECT-TYPE 4909 SYNTAX IpAddress 4910 MAX-ACCESS read-create 4911 STATUS deprecated 4912 DESCRIPTION 4913 "The subnet mask of this Net interface. The default value 4914 for this object is 0.0.0.0. If either the netConfigIPAddress 4915 or netConfigSubnetMask are 0.0.0.0, then when the device 4916 boots, it may use BOOTP to try to figure out what these 4917 values should be. If BOOTP fails, before the device 4918 can talk on the network, this value must be configured 4919 (e.g., through a terminal attached to the device). If BOOTP is 4920 used, care should be taken to not send BOOTP broadcasts too 4921 frequently and to eventually send very infrequently if no 4922 replies are received." 4923 ::= { netConfigEntry 2 } 4925 netConfigStatus OBJECT-TYPE 4926 SYNTAX RowStatus 4927 MAX-ACCESS read-create 4928 STATUS deprecated 4929 DESCRIPTION 4930 "The status of this netConfigEntry. 4932 An entry may not exist in the active state unless all 4933 objects in the entry have an appropriate value." 4934 ::= { netConfigEntry 3 } 4936 netDefaultGateway OBJECT-TYPE 4937 SYNTAX IpAddress 4938 MAX-ACCESS read-write 4939 STATUS deprecated 4940 DESCRIPTION 4941 "The IP Address of the default gateway. If this value is 4942 undefined or unknown, it shall have the value 0.0.0.0." 4943 ::= { probeConfig 12 } 4945 -- Trap Destination Table 4946 -- 4947 -- This table defines the destination addresses for traps generated 4948 -- from the device. This table maps a community to one or more trap 4949 -- destination entries. 4950 -- 4951 -- The same trap will be sent to all destinations specified in the 4952 -- entries that have the same trapDestCommunity as the eventCommunity 4953 -- (as defined by RMON MIB), as long as no access control mechanism 4954 -- (e.g., VACM) prohibits sending to one or mor of the destinations. 4955 -- Information in this table will be stored in non-volatile memory. 4956 -- If the device has gone through a hard restart, this information 4957 -- will be reset to its default state. 4959 trapDestTable OBJECT-TYPE 4960 SYNTAX SEQUENCE OF TrapDestEntry 4961 MAX-ACCESS not-accessible 4962 STATUS deprecated 4963 DESCRIPTION 4964 "A list of trap destination entries." 4965 ::= { probeConfig 13 } 4967 trapDestEntry OBJECT-TYPE 4968 SYNTAX TrapDestEntry 4969 MAX-ACCESS not-accessible 4970 STATUS deprecated 4971 DESCRIPTION 4972 "This entry includes a destination IP address to which to send 4973 traps for this community." 4975 INDEX { trapDestIndex } 4976 ::= { trapDestTable 1 } 4978 TrapDestEntry ::= SEQUENCE { 4979 trapDestIndex Integer32, 4980 trapDestCommunity OCTET STRING, 4981 trapDestProtocol INTEGER, 4982 trapDestAddress OCTET STRING, 4983 trapDestOwner OwnerString, 4984 trapDestStatus RowStatus 4985 } 4987 trapDestIndex OBJECT-TYPE 4988 SYNTAX Integer32 (1..65535) 4989 MAX-ACCESS not-accessible 4990 STATUS deprecated 4991 DESCRIPTION 4992 "A value that uniquely identifies this trapDestEntry." 4993 ::= { trapDestEntry 1 } 4995 trapDestCommunity OBJECT-TYPE 4996 SYNTAX OCTET STRING (SIZE(0..127)) 4997 MAX-ACCESS read-create 4998 STATUS deprecated 4999 DESCRIPTION 5000 "A community to which this destination address belongs. 5001 This entry is associated with any eventEntries in the RMON 5002 MIB whose value of eventCommunity is equal to the value of 5003 this object. Every time an associated event entry sends a 5004 trap due to an event, that trap will be sent to each 5005 address in the trapDestTable with a trapDestCommunity equal to 5006 eventCommunity, as long as no access control mechanism 5007 precludes it (e.g., VACM). 5009 This object may not be modified if the associated 5010 trapDestStatus object is equal to active(1)." 5011 ::= { trapDestEntry 2 } 5013 trapDestProtocol OBJECT-TYPE 5014 SYNTAX INTEGER { 5015 ip(1), 5016 ipx(2) 5017 } 5018 MAX-ACCESS read-create 5019 STATUS deprecated 5020 DESCRIPTION 5021 "The protocol with which to send this trap." 5022 ::= { trapDestEntry 3 } 5024 trapDestAddress OBJECT-TYPE 5025 SYNTAX OCTET STRING 5026 MAX-ACCESS read-create 5027 STATUS deprecated 5028 DESCRIPTION 5029 "The address to send traps on behalf of this entry. 5031 If the associated trapDestProtocol object is equal to ip(1), 5032 the encoding of this object is the same as the snmpUDPAddress 5033 textual convention in RFC 3417 'Transport Mappings for the 5034 Simple Network Management Protocol(SNMP)' [RFC3417]: 5035 -- for a SnmpUDPAddress of length 6: 5036 -- 5037 -- octets contents encoding 5038 -- 1-4 IP-address network-byte order 5039 -- 5-6 UDP-port network-byte order 5041 If the associated trapDestProtocol object is equal to ipx(2), 5042 the encoding of this object is the same as the snmpIPXAddress 5043 textual convention in RFC 3417 "Transport Mappings for the 5044 Simple Network Management Protocol(SNMP)" [RFC3417]: 5045 -- for a SnmpIPXAddress of length 12: 5046 -- 5047 -- octets contents encoding 5048 -- 1-4 network-number network-byte order 5049 -- 5-10 physical-address network-byte order 5050 -- 11-12 socket-number network-byte order 5052 This object may not be modified if the associated 5053 trapDestStatus object is equal to active(1)." 5054 ::= { trapDestEntry 4 } 5056 trapDestOwner OBJECT-TYPE 5057 SYNTAX OwnerString 5058 MAX-ACCESS read-create 5059 STATUS deprecated 5060 DESCRIPTION 5061 "The entity that configured this entry and is 5062 therefore using the resources assigned to it." 5064 ::= { trapDestEntry 5 } 5066 trapDestStatus OBJECT-TYPE 5067 SYNTAX RowStatus 5068 MAX-ACCESS read-create 5069 STATUS deprecated 5070 DESCRIPTION 5071 "The status of this trap destination entry. 5073 An entry may not exist in the active state unless all 5074 objects in the entry have an appropriate value." 5075 ::= { trapDestEntry 6 } 5077 -- Serial Connection Table 5078 -- 5079 -- The device may communicate with a management station using 5080 -- SLIP. In order for the device to send traps via SLIP, it must 5081 -- be able to initiate a connection over the serial interface. The 5082 -- serialConnectionTable stores the parameters for such connection 5083 -- initiation. 5085 serialConnectionTable OBJECT-TYPE 5086 SYNTAX SEQUENCE OF SerialConnectionEntry 5087 MAX-ACCESS not-accessible 5088 STATUS deprecated 5089 DESCRIPTION 5090 "A list of serialConnectionEntries. 5092 This table has been deprecated as it has not had enough 5093 independent implementations to demonstrate interoperability to 5094 meet the requirements of a Draft Standard." 5095 ::= { probeConfig 14 } 5097 serialConnectionEntry OBJECT-TYPE 5098 SYNTAX SerialConnectionEntry 5099 MAX-ACCESS not-accessible 5100 STATUS deprecated 5101 DESCRIPTION 5102 "Configuration for a SLIP link over a serial line." 5103 INDEX { serialConnectIndex } 5104 ::= { serialConnectionTable 1 } 5106 SerialConnectionEntry ::= SEQUENCE { 5107 serialConnectIndex Integer32, 5108 serialConnectDestIpAddress IpAddress, 5109 serialConnectType INTEGER, 5110 serialConnectDialString ControlString, 5111 serialConnectSwitchConnectSeq ControlString, 5112 serialConnectSwitchDisconnectSeq ControlString, 5113 serialConnectSwitchResetSeq ControlString, 5114 serialConnectOwner OwnerString, 5115 serialConnectStatus RowStatus 5116 } 5118 serialConnectIndex OBJECT-TYPE 5119 SYNTAX Integer32 (1..65535) 5120 MAX-ACCESS not-accessible 5121 STATUS deprecated 5122 DESCRIPTION 5123 "A value that uniquely identifies this serialConnection 5124 entry." 5125 ::= { serialConnectionEntry 1 } 5127 serialConnectDestIpAddress OBJECT-TYPE 5128 SYNTAX IpAddress 5129 MAX-ACCESS read-create 5130 STATUS deprecated 5131 DESCRIPTION 5132 "The IP Address that can be reached at the other end of this 5133 serial connection. 5134 This object may not be modified if the associated 5135 serialConnectStatus object is equal to active(1)." 5136 ::= { serialConnectionEntry 2 } 5138 serialConnectType OBJECT-TYPE 5139 SYNTAX INTEGER { 5140 direct(1), 5141 modem(2), 5142 switch(3), 5143 modemSwitch(4) 5144 } 5145 MAX-ACCESS read-create 5146 STATUS deprecated 5147 DESCRIPTION 5148 "The type of outgoing connection to make. If this object 5149 has the value direct(1), then a direct serial connection 5150 is assumed. If this object has the value modem(2), 5151 then serialConnectDialString will be used to make a modem 5152 connection. If this object has the value switch(3), 5153 then serialConnectSwitchConnectSeq will be used to establish 5154 the connection over a serial data switch, and 5155 serialConnectSwitchDisconnectSeq will be used to terminate 5156 the connection. If this object has the value 5157 modem-switch(4), then a modem connection will be made first 5158 followed by the switch connection. 5160 This object may not be modified if the associated 5161 serialConnectStatus object is equal to active(1)." 5162 DEFVAL { direct } 5163 ::= { serialConnectionEntry 3 } 5165 serialConnectDialString OBJECT-TYPE 5166 SYNTAX ControlString (SIZE(0..255)) 5167 MAX-ACCESS read-create 5168 STATUS deprecated 5169 DESCRIPTION 5170 "A control string which specifies how to dial the phone 5171 number in order to establish a modem connection. The 5172 string should include dialing prefix and suffix. For 5173 example: ``^s^MATD9,888-1234^M'' will instruct the Probe 5174 to send a carriage return followed by the dialing prefix 5175 ``ATD'', the phone number ``9,888-1234'', and a carriage 5176 return as the dialing suffix. 5177 This object may not be modified if the associated 5178 serialConnectStatus object is equal to active(1)." 5179 ::= { serialConnectionEntry 4 } 5181 serialConnectSwitchConnectSeq OBJECT-TYPE 5182 SYNTAX ControlString (SIZE(0..255)) 5183 MAX-ACCESS read-create 5184 STATUS deprecated 5185 DESCRIPTION 5186 "A control string which specifies how to establish a 5187 data switch connection. 5188 This object may not be modified if the associated 5189 serialConnectStatus object is equal to active(1)." 5190 ::= { serialConnectionEntry 5 } 5192 serialConnectSwitchDisconnectSeq OBJECT-TYPE 5193 SYNTAX ControlString (SIZE(0..255)) 5194 MAX-ACCESS read-create 5195 STATUS deprecated 5196 DESCRIPTION 5197 "A control string which specifies how to terminate a 5198 data switch connection. 5199 This object may not be modified if the associated 5200 serialConnectStatus object is equal to active(1)." 5201 ::= { serialConnectionEntry 6 } 5203 serialConnectSwitchResetSeq OBJECT-TYPE 5204 SYNTAX ControlString (SIZE(0..255)) 5205 MAX-ACCESS read-create 5206 STATUS deprecated 5207 DESCRIPTION 5208 "A control string which specifies how to reset a data 5209 switch in the event of a timeout. 5210 This object may not be modified if the associated 5211 serialConnectStatus object is equal to active(1)." 5212 ::= { serialConnectionEntry 7 } 5214 serialConnectOwner OBJECT-TYPE 5215 SYNTAX OwnerString 5216 MAX-ACCESS read-create 5217 STATUS deprecated 5218 DESCRIPTION 5219 "The entity that configured this entry and is 5220 therefore using the resources assigned to it." 5221 ::= { serialConnectionEntry 8 } 5223 serialConnectStatus OBJECT-TYPE 5224 SYNTAX RowStatus 5225 MAX-ACCESS read-create 5226 STATUS deprecated 5227 DESCRIPTION 5228 "The status of this serialConnectionEntry. 5230 If the manager attempts to set this object to active(1) when 5231 the serialConnectType is set to modem(2) or modem-switch(4) 5232 and the serialConnectDialString is a zero-length string or 5233 cannot be correctly parsed as a ConnectString, the set 5234 request will be rejected with badValue(3). 5236 If the manager attempts to set this object to active(1) when 5237 the serialConnectType is set to switch(3) or modem-switch(4) 5238 and the serialConnectSwitchConnectSeq, 5239 the serialConnectSwitchDisconnectSeq, or 5240 the serialConnectSwitchResetSeq are zero-length strings 5241 or cannot be correctly parsed as ConnectStrings, the set 5242 request will be rejected with badValue(3). 5244 An entry may not exist in the active state unless all 5245 objects in the entry have an appropriate value." 5246 ::= { serialConnectionEntry 9 } 5248 -- 5249 -- Extensions to the RMON 1 MIB for RMON 2 devices 5250 -- 5251 -- These extensions include the standard LastCreateTime Textual 5252 -- Convention for all control tables, as well as an augmentation of 5253 -- the filter entry that provides variable-length offsets into 5254 -- packets. 5256 -- Each of the following, except for filterDroppedFrames, is a 5257 -- read-only object which, if implemented, automatically appears when 5258 -- the RMON1 row it is associated with is created. 5260 etherStats2Table OBJECT-TYPE 5261 SYNTAX SEQUENCE OF EtherStats2Entry 5262 MAX-ACCESS not-accessible 5263 STATUS current 5264 DESCRIPTION 5265 "Contains the RMON-2 augmentations to RMON-1." 5266 ::= { statistics 4 } 5268 etherStats2Entry OBJECT-TYPE 5269 SYNTAX EtherStats2Entry 5270 MAX-ACCESS not-accessible 5271 STATUS current 5272 DESCRIPTION 5273 "Contains the RMON-2 augmentations to RMON-1." 5274 AUGMENTS { etherStatsEntry } 5275 ::= { etherStats2Table 1 } 5277 EtherStats2Entry ::= SEQUENCE { 5278 etherStatsDroppedFrames Counter32, 5279 etherStatsCreateTime LastCreateTime 5280 } 5281 etherStatsDroppedFrames OBJECT-TYPE 5282 SYNTAX Counter32 5283 MAX-ACCESS read-only 5284 STATUS current 5285 DESCRIPTION 5286 "The total number of frames which were received by the probe 5287 and therefore not accounted for in the *StatsDropEvents, but 5288 for which the probe chose not to count for this entry for 5289 whatever reason. Most often, this event occurs when the probe 5290 is out of some resources and decides to shed load from this 5291 collection. 5293 This count does not include packets that were not counted 5294 because they had MAC-layer errors. 5296 Note that, unlike the dropEvents counter, this number is the 5297 exact number of frames dropped." 5298 ::= { etherStats2Entry 1 } 5300 etherStatsCreateTime OBJECT-TYPE 5301 SYNTAX LastCreateTime 5302 MAX-ACCESS read-only 5303 STATUS current 5304 DESCRIPTION 5305 "The value of sysUpTime when this control entry was last 5306 activated. This can be used by the management station to 5307 ensure that the table has not been deleted and recreated 5308 between polls." 5309 ::= { etherStats2Entry 2 } 5311 historyControl2Table OBJECT-TYPE 5312 SYNTAX SEQUENCE OF HistoryControl2Entry 5313 MAX-ACCESS not-accessible 5314 STATUS current 5315 DESCRIPTION 5316 "Contains the RMON-2 augmentations to RMON-1." 5317 ::= { history 5 } 5319 historyControl2Entry OBJECT-TYPE 5320 SYNTAX HistoryControl2Entry 5321 MAX-ACCESS not-accessible 5322 STATUS current 5323 DESCRIPTION 5324 "Contains the RMON-2 augmentations to RMON-1." 5326 AUGMENTS { historyControlEntry } 5327 ::= { historyControl2Table 1 } 5329 HistoryControl2Entry ::= SEQUENCE { 5330 historyControlDroppedFrames Counter32 5331 } 5333 historyControlDroppedFrames OBJECT-TYPE 5334 SYNTAX Counter32 5335 MAX-ACCESS read-only 5336 STATUS current 5337 DESCRIPTION 5338 "The total number of frames which were received by the probe 5339 and therefore not accounted for in the *StatsDropEvents, but 5340 for which the probe chose not to count for this entry for 5341 whatever reason. Most often, this event occurs when the probe 5342 is out of some resources and decides to shed load from this 5343 collection. 5345 This count does not include packets that were not counted 5346 because they had MAC-layer errors. 5348 Note that, unlike the dropEvents counter, this number is the 5349 exact number of frames dropped." 5350 ::= { historyControl2Entry 1 } 5352 hostControl2Table OBJECT-TYPE 5353 SYNTAX SEQUENCE OF HostControl2Entry 5354 MAX-ACCESS not-accessible 5355 STATUS current 5356 DESCRIPTION 5357 "Contains the RMON-2 augmentations to RMON-1." 5358 ::= { hosts 4 } 5360 hostControl2Entry OBJECT-TYPE 5361 SYNTAX HostControl2Entry 5362 MAX-ACCESS not-accessible 5363 STATUS current 5364 DESCRIPTION 5365 "Contains the RMON-2 augmentations to RMON-1." 5366 AUGMENTS { hostControlEntry } 5367 ::= { hostControl2Table 1 } 5369 HostControl2Entry ::= SEQUENCE { 5370 hostControlDroppedFrames Counter32, 5371 hostControlCreateTime LastCreateTime 5372 } 5374 hostControlDroppedFrames OBJECT-TYPE 5375 SYNTAX Counter32 5376 MAX-ACCESS read-only 5377 STATUS current 5378 DESCRIPTION 5379 "The total number of frames which were received by the probe 5380 and therefore not accounted for in the *StatsDropEvents, but 5381 for which the probe chose not to count for this entry for 5382 whatever reason. Most often, this event occurs when the probe 5383 is out of some resources and decides to shed load from this 5384 collection. 5386 This count does not include packets that were not counted 5387 because they had MAC-layer errors. 5389 Note that, unlike the dropEvents counter, this number is the 5390 exact number of frames dropped." 5391 ::= { hostControl2Entry 1 } 5393 hostControlCreateTime OBJECT-TYPE 5394 SYNTAX LastCreateTime 5395 MAX-ACCESS read-only 5396 STATUS current 5397 DESCRIPTION 5398 "The value of sysUpTime when this control entry was last 5399 activated. This can be used by the management station to 5400 ensure that the table has not been deleted and recreated 5401 between polls." 5402 ::= { hostControl2Entry 2 } 5404 matrixControl2Table OBJECT-TYPE 5405 SYNTAX SEQUENCE OF MatrixControl2Entry 5406 MAX-ACCESS not-accessible 5407 STATUS current 5408 DESCRIPTION 5409 "Contains the RMON-2 augmentations to RMON-1." 5410 ::= { matrix 4 } 5412 matrixControl2Entry OBJECT-TYPE 5413 SYNTAX MatrixControl2Entry 5414 MAX-ACCESS not-accessible 5415 STATUS current 5416 DESCRIPTION 5417 "Contains the RMON-2 augmentations to RMON-1." 5418 AUGMENTS { matrixControlEntry } 5419 ::= { matrixControl2Table 1 } 5421 MatrixControl2Entry ::= SEQUENCE { 5422 matrixControlDroppedFrames Counter32, 5423 matrixControlCreateTime LastCreateTime 5424 } 5426 matrixControlDroppedFrames OBJECT-TYPE 5427 SYNTAX Counter32 5428 MAX-ACCESS read-only 5429 STATUS current 5430 DESCRIPTION 5431 "The total number of frames which were received by the probe 5432 and therefore not accounted for in the *StatsDropEvents, but 5433 for which the probe chose not to count for this entry for 5434 whatever reason. Most often, this event occurs when the probe 5435 is out of some resources and decides to shed load from this 5436 collection. 5438 This count does not include packets that were not counted 5439 because they had MAC-layer errors. 5441 Note that, unlike the dropEvents counter, this number is the 5442 exact number of frames dropped." 5443 ::= { matrixControl2Entry 1 } 5445 matrixControlCreateTime OBJECT-TYPE 5446 SYNTAX LastCreateTime 5447 MAX-ACCESS read-only 5448 STATUS current 5449 DESCRIPTION 5450 "The value of sysUpTime when this control entry was last 5451 activated. This can be used by the management station to 5452 ensure that the table has not been deleted and recreated 5453 between polls." 5454 ::= { matrixControl2Entry 2 } 5456 channel2Table OBJECT-TYPE 5457 SYNTAX SEQUENCE OF Channel2Entry 5458 MAX-ACCESS not-accessible 5459 STATUS current 5460 DESCRIPTION 5461 "Contains the RMON-2 augmentations to RMON-1." 5462 ::= { filter 3 } 5464 channel2Entry OBJECT-TYPE 5465 SYNTAX Channel2Entry 5466 MAX-ACCESS not-accessible 5467 STATUS current 5468 DESCRIPTION 5469 "Contains the RMON-2 augmentations to RMON-1." 5470 AUGMENTS { channelEntry } 5471 ::= { channel2Table 1 } 5473 Channel2Entry ::= SEQUENCE { 5474 channelDroppedFrames Counter32, 5475 channelCreateTime LastCreateTime 5476 } 5478 channelDroppedFrames OBJECT-TYPE 5479 SYNTAX Counter32 5480 MAX-ACCESS read-only 5481 STATUS current 5482 DESCRIPTION 5483 "The total number of frames which were received by the probe 5484 and therefore not accounted for in the *StatsDropEvents, but 5485 for which the probe chose not to count for this entry for 5486 whatever reason. Most often, this event occurs when the probe 5487 is out of some resources and decides to shed load from this 5488 collection. 5490 This count does not include packets that were not counted 5491 because they had MAC-layer errors. 5493 Note that, unlike the dropEvents counter, this number is the 5494 exact number of frames dropped." 5495 ::= { channel2Entry 1 } 5497 channelCreateTime OBJECT-TYPE 5498 SYNTAX LastCreateTime 5499 MAX-ACCESS read-only 5500 STATUS current 5501 DESCRIPTION 5502 "The value of sysUpTime when this control entry was last 5503 activated. This can be used by the management station to 5504 ensure that the table has not been deleted and recreated 5505 between polls." 5506 ::= { channel2Entry 2 } 5508 tokenRingMLStats2Table OBJECT-TYPE 5509 SYNTAX SEQUENCE OF TokenRingMLStats2Entry 5510 MAX-ACCESS not-accessible 5511 STATUS deprecated 5512 DESCRIPTION 5513 "Contains the RMON-2 augmentations to RMON-1. 5515 This table has been deprecated as it has not had enough 5516 independent implementations to demonstrate interoperability to 5517 meet the requirements of a Draft Standard." 5518 ::= { statistics 5 } 5520 tokenRingMLStats2Entry OBJECT-TYPE 5521 SYNTAX TokenRingMLStats2Entry 5522 MAX-ACCESS not-accessible 5523 STATUS deprecated 5524 DESCRIPTION 5525 "Contains the RMON-2 augmentations to RMON-1." 5526 AUGMENTS { tokenRingMLStatsEntry } 5527 ::= { tokenRingMLStats2Table 1 } 5529 TokenRingMLStats2Entry ::= SEQUENCE { 5530 tokenRingMLStatsDroppedFrames Counter32, 5531 tokenRingMLStatsCreateTime LastCreateTime 5532 } 5534 tokenRingMLStatsDroppedFrames OBJECT-TYPE 5535 SYNTAX Counter32 5536 MAX-ACCESS read-only 5537 STATUS deprecated 5538 DESCRIPTION 5539 "The total number of frames which were received by the probe 5540 and therefore not accounted for in the *StatsDropEvents, but 5541 for which the probe chose not to count for this entry for 5542 whatever reason. Most often, this event occurs when the probe 5543 is out of some resources and decides to shed load from this 5544 collection. 5546 This count does not include packets that were not counted 5547 because they had MAC-layer errors. 5549 Note that, unlike the dropEvents counter, this number is the 5550 exact number of frames dropped." 5551 ::= { tokenRingMLStats2Entry 1 } 5553 tokenRingMLStatsCreateTime OBJECT-TYPE 5554 SYNTAX LastCreateTime 5555 MAX-ACCESS read-only 5556 STATUS deprecated 5557 DESCRIPTION 5558 "The value of sysUpTime when this control entry was last 5559 activated. This can be used by the management station to 5560 ensure that the table has not been deleted and recreated 5561 between polls." 5562 ::= { tokenRingMLStats2Entry 2 } 5564 tokenRingPStats2Table OBJECT-TYPE 5565 SYNTAX SEQUENCE OF TokenRingPStats2Entry 5566 MAX-ACCESS not-accessible 5567 STATUS deprecated 5568 DESCRIPTION 5569 "Contains the RMON-2 augmentations to RMON-1. 5571 This table has been deprecated as it has not had enough 5572 independent implementations to demonstrate interoperability to 5573 meet the requirements of a Draft Standard." 5574 ::= { statistics 6 } 5576 tokenRingPStats2Entry OBJECT-TYPE 5577 SYNTAX TokenRingPStats2Entry 5578 MAX-ACCESS not-accessible 5579 STATUS deprecated 5580 DESCRIPTION 5581 "Contains the RMON-2 augmentations to RMON-1." 5582 AUGMENTS { tokenRingPStatsEntry } 5583 ::= { tokenRingPStats2Table 1 } 5585 TokenRingPStats2Entry ::= SEQUENCE { 5586 tokenRingPStatsDroppedFrames Counter32, 5587 tokenRingPStatsCreateTime LastCreateTime 5588 } 5589 tokenRingPStatsDroppedFrames OBJECT-TYPE 5590 SYNTAX Counter32 5591 MAX-ACCESS read-only 5592 STATUS deprecated 5593 DESCRIPTION 5594 "The total number of frames which were received by the probe 5595 and therefore not accounted for in the *StatsDropEvents, but 5596 for which the probe chose not to count for this entry for 5597 whatever reason. Most often, this event occurs when the probe 5598 is out of some resources and decides to shed load from this 5599 collection. 5601 This count does not include packets that were not counted 5602 because they had MAC-layer errors. 5604 Note that, unlike the dropEvents counter, this number is the 5605 exact number of frames dropped." 5606 ::= { tokenRingPStats2Entry 1 } 5608 tokenRingPStatsCreateTime OBJECT-TYPE 5609 SYNTAX LastCreateTime 5610 MAX-ACCESS read-only 5611 STATUS deprecated 5612 DESCRIPTION 5613 "The value of sysUpTime when this control entry was last 5614 activated. This can be used by the management station to 5615 ensure that the table has not been deleted and recreated 5616 between polls." 5617 ::= { tokenRingPStats2Entry 2 } 5619 ringStationControl2Table OBJECT-TYPE 5620 SYNTAX SEQUENCE OF RingStationControl2Entry 5621 MAX-ACCESS not-accessible 5622 STATUS deprecated 5623 DESCRIPTION 5624 "Contains the RMON-2 augmentations to RMON-1. 5626 This table has been deprecated as it has not had enough 5627 independent implementations to demonstrate interoperability to 5628 meet the requirements of a Draft Standard." 5629 ::= { tokenRing 7 } 5631 ringStationControl2Entry OBJECT-TYPE 5632 SYNTAX RingStationControl2Entry 5633 MAX-ACCESS not-accessible 5634 STATUS deprecated 5635 DESCRIPTION 5636 "Contains the RMON-2 augmentations to RMON-1." 5637 AUGMENTS { ringStationControlEntry } 5638 ::= { ringStationControl2Table 1 } 5640 RingStationControl2Entry ::= SEQUENCE { 5641 ringStationControlDroppedFrames Counter32, 5642 ringStationControlCreateTime LastCreateTime 5643 } 5645 ringStationControlDroppedFrames OBJECT-TYPE 5646 SYNTAX Counter32 5647 MAX-ACCESS read-only 5648 STATUS deprecated 5649 DESCRIPTION 5650 "The total number of frames which were received by the probe 5651 and therefore not accounted for in the *StatsDropEvents, but 5652 for which the probe chose not to count for this entry for 5653 whatever reason. Most often, this event occurs when the probe 5654 is out of some resources and decides to shed load from this 5655 collection. 5657 This count does not include packets that were not counted 5658 because they had MAC-layer errors. 5660 Note that, unlike the dropEvents counter, this number is the 5661 exact number of frames dropped." 5662 ::= { ringStationControl2Entry 1 } 5664 ringStationControlCreateTime OBJECT-TYPE 5665 SYNTAX LastCreateTime 5666 MAX-ACCESS read-only 5667 STATUS deprecated 5668 DESCRIPTION 5669 "The value of sysUpTime when this control entry was last 5670 activated. This can be used by the management station to 5671 ensure that the table has not been deleted and recreated 5672 between polls." 5673 ::= { ringStationControl2Entry 2 } 5675 sourceRoutingStats2Table OBJECT-TYPE 5676 SYNTAX SEQUENCE OF SourceRoutingStats2Entry 5677 MAX-ACCESS not-accessible 5678 STATUS deprecated 5679 DESCRIPTION 5680 "Contains the RMON-2 augmentations to RMON-1. 5682 This table has been deprecated as it has not had enough 5683 independent implementations to demonstrate interoperability to 5684 meet the requirements of a Draft Standard." 5685 ::= { tokenRing 8 } 5687 sourceRoutingStats2Entry OBJECT-TYPE 5688 SYNTAX SourceRoutingStats2Entry 5689 MAX-ACCESS not-accessible 5690 STATUS deprecated 5691 DESCRIPTION 5692 "Contains the RMON-2 augmentations to RMON-1." 5693 AUGMENTS { sourceRoutingStatsEntry } 5694 ::= { sourceRoutingStats2Table 1 } 5696 SourceRoutingStats2Entry ::= SEQUENCE { 5697 sourceRoutingStatsDroppedFrames Counter32, 5698 sourceRoutingStatsCreateTime LastCreateTime 5699 } 5701 sourceRoutingStatsDroppedFrames OBJECT-TYPE 5702 SYNTAX Counter32 5703 MAX-ACCESS read-only 5704 STATUS deprecated 5705 DESCRIPTION 5706 "The total number of frames which were received by the probe 5707 and therefore not accounted for in the *StatsDropEvents, but 5708 for which the probe chose not to count for this entry for 5709 whatever reason. Most often, this event occurs when the probe 5710 is out of some resources and decides to shed load from this 5711 collection. 5713 This count does not include packets that were not counted 5714 because they had MAC-layer errors. 5716 Note that, unlike the dropEvents counter, this number is the 5717 exact number of frames dropped." 5718 ::= { sourceRoutingStats2Entry 1 } 5720 sourceRoutingStatsCreateTime OBJECT-TYPE 5721 SYNTAX LastCreateTime 5722 MAX-ACCESS read-only 5723 STATUS deprecated 5724 DESCRIPTION 5725 "The value of sysUpTime when this control entry was last 5726 activated. This can be used by the management station to 5727 ensure that the table has not been deleted and recreated 5728 between polls." 5729 ::= { sourceRoutingStats2Entry 2 } 5731 filter2Table OBJECT-TYPE 5732 SYNTAX SEQUENCE OF Filter2Entry 5733 MAX-ACCESS not-accessible 5734 STATUS current 5735 DESCRIPTION 5736 "Provides a variable-length packet filter feature to the 5737 RMON-1 filter table." 5738 ::= { filter 4 } 5740 filter2Entry OBJECT-TYPE 5741 SYNTAX Filter2Entry 5742 MAX-ACCESS not-accessible 5743 STATUS current 5744 DESCRIPTION 5745 "Provides a variable-length packet filter feature to the 5746 RMON-1 filter table." 5747 AUGMENTS { filterEntry } 5748 ::= { filter2Table 1 } 5750 Filter2Entry ::= SEQUENCE { 5751 filterProtocolDirDataLocalIndex Integer32, 5752 filterProtocolDirLocalIndex Integer32 5753 } 5755 filterProtocolDirDataLocalIndex OBJECT-TYPE 5756 SYNTAX Integer32 (0..2147483647) 5757 MAX-ACCESS read-create 5758 STATUS current 5759 DESCRIPTION 5760 "When this object is set to a non-zero value, the filter that 5761 it is associated with performs the following operations on 5762 every packet: 5764 1) - If the packet doesn't match the protocol directory entry 5765 identified by this object, discard the packet and exit 5766 (i.e., discard the packet if it is not of the identified 5767 protocol). 5768 2) - If the associated filterProtocolDirLocalIndex is non-zero 5769 and the packet doesn't match the protocol directory 5770 entry identified by that object, discard the packet and 5771 exit 5772 3) - If the packet matches, perform the regular filter 5773 algorithm as if the beginning of this named protocol is 5774 the beginning of the packet, potentially applying the 5775 filterOffset value to move further into the packet." 5776 DEFVAL { 0 } 5777 ::= { filter2Entry 1 } 5779 filterProtocolDirLocalIndex OBJECT-TYPE 5780 SYNTAX Integer32 (0..2147483647) 5781 MAX-ACCESS read-create 5782 STATUS current 5783 DESCRIPTION 5784 "When this object is set to a non-zero value, the filter that 5785 it is associated with will discard the packet if the packet 5786 doesn't match this protocol directory entry." 5787 DEFVAL { 0 } 5788 ::= { filter2Entry 2 } 5790 -- Conformance Macros 5792 rmon2MIBCompliances OBJECT IDENTIFIER ::= { rmonConformance 1 } 5793 rmon2MIBGroups OBJECT IDENTIFIER ::= { rmonConformance 2 } 5795 rmon2MIBCompliance MODULE-COMPLIANCE 5796 STATUS current 5797 DESCRIPTION 5798 "Describes the requirements for conformance to 5799 the RMON2 MIB" 5800 MODULE -- this module 5801 MANDATORY-GROUPS { protocolDirectoryGroup, 5802 protocolDistributionGroup, 5803 addressMapGroup, 5804 nlHostGroup, 5805 nlMatrixGroup, 5806 usrHistoryGroup, 5807 probeInformationGroup } 5809 OBJECT nlMatrixTopNControlRateBase 5810 SYNTAX INTEGER { 5811 nlMatrixTopNPkts(1), 5812 nlMatrixTopNOctets(2) 5813 } 5814 DESCRIPTION 5815 "Conformance to RMON2 requires only support for these 5816 values of nlMatrixTopNControlRateBase." 5818 GROUP rmon1EnhancementGroup 5819 DESCRIPTION 5820 "The rmon1EnhancementGroup is mandatory for systems 5821 which implement RMON [RFC2819]" 5822 GROUP rmon1EthernetEnhancementGroup 5823 DESCRIPTION 5824 "The rmon1EthernetEnhancementGroup is optional and is 5825 appropriate for systems that implement the Ethernet 5826 group of RMON [RFC2819]" 5827 ::= { rmon2MIBCompliances 1 } 5829 rmon2MIBApplicationLayerCompliance MODULE-COMPLIANCE 5830 STATUS current 5831 DESCRIPTION 5832 "Describes the requirements for conformance to 5833 the RMON2 MIB with Application Layer Enhancements." 5834 MODULE -- this module 5835 MANDATORY-GROUPS { protocolDirectoryGroup, 5836 protocolDistributionGroup, 5837 addressMapGroup, 5838 nlHostGroup, 5839 nlMatrixGroup, 5840 alHostGroup, 5841 alMatrixGroup, 5842 usrHistoryGroup, 5843 probeInformationGroup } 5845 OBJECT nlMatrixTopNControlRateBase 5846 SYNTAX INTEGER { 5847 nlMatrixTopNPkts(1), 5848 nlMatrixTopNOctets(2) 5849 } 5850 DESCRIPTION 5851 "Conformance to RMON2 requires only support for these 5852 values of nlMatrixTopNControlRateBase." 5854 OBJECT alMatrixTopNControlRateBase 5855 SYNTAX INTEGER { 5856 alMatrixTopNTerminalsPkts(1), 5857 alMatrixTopNTerminalsOctets(2), 5858 alMatrixTopNAllPkts(3), 5859 alMatrixTopNAllOctets(4) 5860 } 5861 DESCRIPTION 5862 "Conformance to RMON2 requires only support for these 5863 values of alMatrixTopNControlRateBase." 5865 GROUP rmon1EnhancementGroup 5866 DESCRIPTION 5867 "The rmon1EnhancementGroup is mandatory for systems 5868 which implement RMON [RFC2819]" 5869 GROUP rmon1EthernetEnhancementGroup 5870 DESCRIPTION 5871 "The rmon1EthernetEnhancementGroup is optional and is 5872 appropriate for systems that implement the Ethernet 5873 group of RMON [RFC2819]" 5874 ::= { rmon2MIBCompliances 2 } 5876 protocolDirectoryGroup OBJECT-GROUP 5877 OBJECTS { protocolDirLastChange, 5878 protocolDirLocalIndex, protocolDirDescr, 5879 protocolDirType, protocolDirAddressMapConfig, 5880 protocolDirHostConfig, protocolDirMatrixConfig, 5881 protocolDirOwner, protocolDirStatus } 5882 STATUS current 5883 DESCRIPTION 5884 "Lists the inventory of protocols the probe has the capability 5885 of monitoring and allows the addition, deletion, and 5886 configuration of entries in this list." 5887 ::= { rmon2MIBGroups 1 } 5889 protocolDistributionGroup OBJECT-GROUP 5890 OBJECTS { protocolDistControlDataSource, 5891 protocolDistControlDroppedFrames, 5892 protocolDistControlCreateTime, 5893 protocolDistControlOwner, protocolDistControlStatus, 5894 protocolDistStatsPkts, protocolDistStatsOctets } 5895 STATUS current 5896 DESCRIPTION 5897 "Collects the relative amounts of octets and packets for the 5898 different protocols detected on a network segment." 5899 ::= { rmon2MIBGroups 2 } 5901 addressMapGroup OBJECT-GROUP 5902 OBJECTS { addressMapInserts, addressMapDeletes, 5903 addressMapMaxDesiredEntries, 5904 addressMapControlDataSource, 5905 addressMapControlDroppedFrames, 5906 addressMapControlOwner, addressMapControlStatus, 5907 addressMapPhysicalAddress, 5908 addressMapLastChange } 5909 STATUS current 5910 DESCRIPTION 5911 "Lists MAC address to network address bindings discovered by 5912 the probe and what interface they were last seen on." 5913 ::= { rmon2MIBGroups 3 } 5915 nlHostGroup OBJECT-GROUP 5916 OBJECTS { hlHostControlDataSource, 5917 hlHostControlNlDroppedFrames, hlHostControlNlInserts, 5918 hlHostControlNlDeletes, 5919 hlHostControlNlMaxDesiredEntries, 5920 hlHostControlAlDroppedFrames, hlHostControlAlInserts, 5921 hlHostControlAlDeletes, 5922 hlHostControlAlMaxDesiredEntries, hlHostControlOwner, 5923 hlHostControlStatus, nlHostInPkts, nlHostOutPkts, 5924 nlHostInOctets, nlHostOutOctets, 5925 nlHostOutMacNonUnicastPkts, nlHostCreateTime } 5926 STATUS current 5927 DESCRIPTION 5928 "Counts the amount of traffic sent from and to each network 5929 address discovered by the probe. Note that while the 5930 hlHostControlTable also has objects that control an optional 5931 alHostTable, implementation of the alHostTable is not required 5932 to fully implement this group." 5933 ::= { rmon2MIBGroups 4 } 5935 nlMatrixGroup OBJECT-GROUP 5936 OBJECTS { hlMatrixControlDataSource, 5937 hlMatrixControlNlDroppedFrames, 5938 hlMatrixControlNlInserts, hlMatrixControlNlDeletes, 5939 hlMatrixControlNlMaxDesiredEntries, 5940 hlMatrixControlAlDroppedFrames, 5941 hlMatrixControlAlInserts, hlMatrixControlAlDeletes, 5942 hlMatrixControlAlMaxDesiredEntries, 5943 hlMatrixControlOwner, hlMatrixControlStatus, 5944 nlMatrixSDPkts, nlMatrixSDOctets, nlMatrixSDCreateTime, 5945 nlMatrixDSPkts, nlMatrixDSOctets, nlMatrixDSCreateTime, 5946 nlMatrixTopNControlMatrixIndex, 5947 nlMatrixTopNControlRateBase, 5948 nlMatrixTopNControlTimeRemaining, 5949 nlMatrixTopNControlGeneratedReports, 5950 nlMatrixTopNControlDuration, 5951 nlMatrixTopNControlRequestedSize, 5952 nlMatrixTopNControlGrantedSize, 5953 nlMatrixTopNControlStartTime, 5954 nlMatrixTopNControlOwner, nlMatrixTopNControlStatus, 5955 nlMatrixTopNProtocolDirLocalIndex, 5956 nlMatrixTopNSourceAddress, nlMatrixTopNDestAddress, 5957 nlMatrixTopNPktRate, nlMatrixTopNReversePktRate, 5958 nlMatrixTopNOctetRate, nlMatrixTopNReverseOctetRate } 5959 STATUS current 5960 DESCRIPTION 5961 "Counts the amount of traffic sent between each pair of 5962 network addresses discovered by the probe. Note that while the 5963 hlMatrixControlTable also has objects that control optional 5964 alMatrixTables, implementation of the alMatrixTables is not 5965 required to fully implement this group." 5966 ::= { rmon2MIBGroups 5 } 5968 alHostGroup OBJECT-GROUP 5969 OBJECTS { alHostInPkts, alHostOutPkts, 5970 alHostInOctets, alHostOutOctets, alHostCreateTime } 5971 STATUS current 5972 DESCRIPTION 5973 "Counts the amount of traffic, by protocol, sent from and to 5974 each network address discovered by the probe. Implementation 5975 of this group requires implementation of the Network Layer 5976 Host Group." 5977 ::= { rmon2MIBGroups 6 } 5979 alMatrixGroup OBJECT-GROUP 5980 OBJECTS { alMatrixSDPkts, alMatrixSDOctets, alMatrixSDCreateTime, 5981 alMatrixDSPkts, alMatrixDSOctets, alMatrixDSCreateTime, 5982 alMatrixTopNControlMatrixIndex, 5983 alMatrixTopNControlRateBase, 5984 alMatrixTopNControlTimeRemaining, 5985 alMatrixTopNControlGeneratedReports, 5986 alMatrixTopNControlDuration, 5987 alMatrixTopNControlRequestedSize, 5988 alMatrixTopNControlGrantedSize, 5989 alMatrixTopNControlStartTime, 5990 alMatrixTopNControlOwner, alMatrixTopNControlStatus, 5991 alMatrixTopNProtocolDirLocalIndex, 5992 alMatrixTopNSourceAddress, alMatrixTopNDestAddress, 5993 alMatrixTopNAppProtocolDirLocalIndex, 5994 alMatrixTopNPktRate, alMatrixTopNReversePktRate, 5995 alMatrixTopNOctetRate, alMatrixTopNReverseOctetRate } 5996 STATUS current 5997 DESCRIPTION 5998 "Counts the amount of traffic, by protocol, sent between each 5999 pair of network addresses discovered by the 6000 probe. Implementation of this group requires implementation of 6001 the Network Layer Matrix Group." 6002 ::= { rmon2MIBGroups 7 } 6004 usrHistoryGroup OBJECT-GROUP 6005 OBJECTS { usrHistoryControlObjects, 6006 usrHistoryControlBucketsRequested, 6007 usrHistoryControlBucketsGranted, 6008 usrHistoryControlInterval, 6009 usrHistoryControlOwner, usrHistoryControlStatus, 6010 usrHistoryObjectVariable, usrHistoryObjectSampleType, 6011 usrHistoryIntervalStart, usrHistoryIntervalEnd, 6012 usrHistoryAbsValue, usrHistoryValStatus } 6013 STATUS current 6014 DESCRIPTION 6015 "The usrHistoryGroup provides user-defined collection of 6016 historical information from MIB objects on the probe." 6017 ::= { rmon2MIBGroups 8 } 6019 probeInformationGroup OBJECT-GROUP 6020 OBJECTS { probeCapabilities, 6021 probeSoftwareRev, probeHardwareRev, probeDateTime } 6022 STATUS current 6023 DESCRIPTION 6024 "This group describes various operating parameters of the 6025 probe as well as controlling the local time of the probe." 6026 ::= { rmon2MIBGroups 9 } 6028 probeConfigurationGroup OBJECT-GROUP 6029 OBJECTS { probeResetControl, probeDownloadFile, 6030 probeDownloadTFTPServer, probeDownloadAction, 6031 probeDownloadStatus, 6032 serialMode, serialProtocol, serialTimeout, 6033 serialModemInitString, serialModemHangUpString, 6034 serialModemConnectResp, serialModemNoConnectResp, 6035 serialDialoutTimeout, serialStatus, 6036 netConfigIPAddress, netConfigSubnetMask, 6037 netConfigStatus, netDefaultGateway, 6038 trapDestCommunity, trapDestProtocol, trapDestAddress, 6039 trapDestOwner, trapDestStatus, 6040 serialConnectDestIpAddress, serialConnectType, 6041 serialConnectDialString, serialConnectSwitchConnectSeq, 6042 serialConnectSwitchDisconnectSeq, 6043 serialConnectSwitchResetSeq, 6044 serialConnectOwner, serialConnectStatus } 6045 STATUS deprecated 6046 DESCRIPTION 6047 "This group controls the configuration of various operating 6048 parameters of the probe. This group is not referenced by any 6049 MODULE-COMPLIANCE macro because it is 'grandfathered' from 6050 more recent MIB review rules that would require it." 6051 ::= { rmon2MIBGroups 10 } 6053 rmon1EnhancementGroup OBJECT-GROUP 6054 OBJECTS { historyControlDroppedFrames, hostControlDroppedFrames, 6055 hostControlCreateTime, matrixControlDroppedFrames, 6056 matrixControlCreateTime, channelDroppedFrames, 6057 channelCreateTime, filterProtocolDirDataLocalIndex, 6058 filterProtocolDirLocalIndex } 6059 STATUS current 6060 DESCRIPTION 6061 "This group adds some enhancements to RMON-1 that help 6062 management stations." 6063 ::= { rmon2MIBGroups 11 } 6065 rmon1EthernetEnhancementGroup OBJECT-GROUP 6066 OBJECTS { etherStatsDroppedFrames, etherStatsCreateTime } 6067 STATUS current 6068 DESCRIPTION 6069 "This group adds some enhancements to RMON-1 that help 6070 management stations." 6071 ::= { rmon2MIBGroups 12 } 6073 rmon1TokenRingEnhancementGroup OBJECT-GROUP 6074 OBJECTS { tokenRingMLStatsDroppedFrames, 6075 tokenRingMLStatsCreateTime, 6076 tokenRingPStatsDroppedFrames, tokenRingPStatsCreateTime, 6077 ringStationControlDroppedFrames, 6078 ringStationControlCreateTime, 6079 sourceRoutingStatsDroppedFrames, 6080 sourceRoutingStatsCreateTime } 6081 STATUS deprecated 6082 DESCRIPTION 6083 "This group adds some enhancements to RMON-1 that help 6084 management stations. This group is not referenced by any 6085 MODULE-COMPLIANCE macro because it is 'grandfathered' from 6086 more recent MIB review rules that would require it." 6087 ::= { rmon2MIBGroups 13 } 6088 END 6089 7. Security Considerations 6091 In order to implement this MIB, a probe must capture all 6092 packets on the locally-attached network, including packets 6093 between third parties. These packets are analyzed to collect 6094 network addresses, protocol usage information, and 6095 conversation statistics. Data of this nature may be considered 6096 sensitive in some environments. In such environments the 6097 administrator may wish to restrict SNMP access to the probe. 6099 The usrHistoryGroup periodically samples the values of user- 6100 specified variables on the probe and stores them in another 6101 table. Since the access-control specified for stored snapshot 6102 may be different than the access-control for the sampled 6103 variable, the agent MUST ensure that usrHistoryObjectVariable 6104 is not writable in MIB views that don't already have read 6105 access to the entire agent. Because the access control 6106 configuration can change over time, information could later be 6107 deemed sensitive that would still be accessible to this 6108 function. For this reason, an agent SHOULD check the access 6109 control on every sample. If an agent doesn't implement the 6110 latter check, there is a potential for sensitive information 6111 to be revealed. 6113 A probe implementing this MIB is likely to also implement RMON 6114 [RFC2819], which includes functions for returning the contents 6115 of captured packets, potentially including sensitive user data 6116 or passwords. It is recommended that SNMP access to these 6117 functions be restricted. 6119 There are a number of management objects defined in this MIB 6120 that have a MAX-ACCESS clause of read-write and/or read- 6121 create. Such objects may be considered sensitive or 6122 vulnerable in some network environments. The support for SET 6123 operations in a non-secure environment without proper 6124 protection can have a negative effect on network operations. 6126 Some of the readable objects in this MIB module (i.e., objects 6127 with a MAX-ACCESS other than not-accessible) may be considered 6128 sensitive or vulnerable in some network environments. It is 6129 thus important to control even GET and/or NOTIFY access to 6130 these objects and possibly to even encrypt the values of these 6131 objects when sending them over the network via SNMP. 6133 SNMP versions prior to SNMPv3 did not include adequate 6134 security. Even if the network itself is secure (for example 6135 by using IPSec), even then, there is no control as to who on 6136 the secure network is allowed to access and GET/SET 6137 (read/change/create/delete) the objects in this MIB module. 6139 It is RECOMMENDED that implementers consider the security 6140 features as provided by the SNMPv3 framework (see [RFC3410], 6141 section 8), including full support for the SNMPv3 6142 cryptographic mechanisms (for authentication and privacy). 6144 Further, deployment of SNMP versions prior to SNMPv3 is NOT 6145 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and 6146 to enable cryptographic security. It is then a 6147 customer/operator responsibility to ensure that the SNMP 6148 entity giving access to an instance of this MIB module is 6149 properly configured to give access to the objects only to 6150 those principals (users) that have legitimate rights to indeed 6151 GET or SET (change/create/delete) them. 6153 8. IANA Considerations 6155 No IANA actions are necessary. 6157 9. Appendix - TimeFilter Implementation Notes 6159 1) Theory of Operation 6161 The TimeFilter mechanism allows an NMS to reduce the number of 6162 SNMP transactions required for a 'table-update' operation, by 6163 retrieving only the rows that have changed since a specified 6164 time (usually the last poll time). Polling of tables that 6165 incorporate a 'TimeFilter' INDEX can be reduced to a 6166 theoretical minimum (if used correctly). It can be easily 6167 implemented by an agent in a way independent of the number of 6168 NMS applications using the same time-filtered table. 6170 Although the name 'TimeFilter' may imply that a history of 6171 change events is maintained by the agent, this is not the 6172 case. A time-filtered-value represents the current value of 6173 the object instance, not the 'saved' value at the time 6174 indicated by the TimeFilter INDEX value. Note that TimeFilter 6175 objects only appear in INDEX clauses (always not-accessible), 6176 so their value is never retrieved. By design, the actual value 6177 of a TimeFilter instance is not in itself meaningful (it's not 6178 a 'last-change-timestamp'). 6180 The TimeFilter is a boolean filtering function applied in 6181 internal Get* PDU processing. If the 'last-change-time' of the 6182 specified instance is less than the particular TimeFilter 6183 INDEX value, then the instance is considered 'not-present', 6184 and it is skipped for GetNext and GetBulk PDUs, or a 6185 'noSuchInstance' exception is returned for Get PDUs. 6187 For TimeFilter purposes: 6188 - a row is created when an accessible column is created 6189 within 6190 the row. 6191 - a column that is created or deleted causes the TimeFilter 6192 to 6193 to update the time-stamp, only because the value of the 6194 column 6195 is changing (non-existent <-> some value). 6196 - a row is deleted when all accessible columns are deleted. 6197 This 6198 event is not detectable with TimeFilter, and deleted rows 6199 are 6200 not retrievable with SNMP. 6202 1.1) Agent Implementation of a Time-Filtered Table 6204 In implementation, the time-filtered rows (one for each tick 6205 of sysUpTime) are only conceptual. The agent simply filters a 6206 real table based on: 6207 * the current value of sysUpTime 6208 * the TimeFilter value passed in the varbind 6209 * the last-update timestamp of each requested row 6210 (agent implementation requirement) 6212 For example, to implement a time-filtered table row (e.g., set 6213 of counters), an agent maintains a timestamp in a 32-bit 6214 storage location, initialized to zero. This is in addition to 6215 whatever instrumentation is needed for the set of counters. 6217 Each time one of the counters is updated, the current value of 6218 sysUpTime is recorded in the associated timestamp. If this is 6219 not possible or practical, then a background polling process 6220 must 'refresh' the timestamp by sampling counter values and 6221 comparing them to recorded samples. The timestamp update must 6222 occur within 5 seconds of the actual change event. 6224 When an agent receives a Get, GetNext, or GetBulk PDU 6225 requesting a time-filtered instance, after the agent has 6226 determined that the instance is within the specified MIB view, 6227 the following conceptual test is applied to determine if the 6228 object is returned or filtered: 6230 /* return TRUE if the object is present */ 6231 boolean time_filter_test ( 6232 TimeFilter last_modified_timestamp, 6233 TimeFilter index_value_in_pdu ) 6234 { 6235 if (last_modified_timestamp < index_value_in_pdu) 6236 return FALSE; 6237 else 6238 return TRUE; 6239 } 6241 The agent applies this function regardless of the 6242 lastActivationTime of the conceptual row in question. In other 6243 words, counter discontinuities are ignored (i.e. conceptual 6244 row deleted and then re-created later). An agent should 6245 consider a object instance 'changed' when it is created 6246 (either at restart time for scalars and static objects, or 6247 row-creation-time for dynamic tables). 6249 Note that using a timeFilter INDEX value of zero removes the 6250 filtering functionality, as the instance will always be 6251 'present' according to the test above. 6253 After some deployment experience, it has been determined that 6254 a time-filtered table is more efficient to use if the agent 6255 stops a "MIB walk" operation after one time-filtered entry. 6256 That is, a GetNext or GetBulk operation will provide one pass 6257 through a given table, i.e., the agent will continue to the 6258 next object or table, instead of incrementing a TimeMark INDEX 6259 value, even if there exists higher TimeMark values which are 6260 valid for the same conceptual row. 6262 It is acceptable for an agent to implement a time-filtered 6263 table in this manner or in the traditional manner (i.e., every 6264 conceptual time-filtered instance is returned in GetNext and 6265 GetBulk PDU responses). 6267 1.2) NMS Implementation of a Time-Filtered Table 6269 The particular TimeFilter INDEX values used by an NMS reflect 6270 the polling interval of the NMS, relative to the particular 6271 agent's notion of sysUpTime. 6273 An NMS needs to maintain one timestamp variable per agent 6274 (initialized to zero) for an arbitrary group of time-filtered 6275 MIB objects that are gathered together in the same PDU. Each 6276 time the Get* PDU is sent, a request for sysUpTime is 6277 included. The retrieved sysUpTime value is used as the 6278 timeFilter value in the next polling cycle. If a polling sweep 6279 of a time-filtered group of objects requires more than one 6280 SNMP transaction, then the sysUpTime value retrieved in the 6281 first GetResponse PDU of the polling sweep is saved as the 6282 next timeFilter value. 6284 The actual last-update time of a given object is not indicated 6285 in the returned GetResponse instance identifier, but rather 6286 the timeFilter value passed in the Get*Request PDU is 6287 returned. 6289 A "time-filtered get-next/bulk-sweep", done once per polling 6290 cycle, is a series of GetNext or GetBulk transactions, and is 6291 over when one of the following events occurs: 6292 1) the TimeFilter index value returned in the GetResponse is 6293 different than the TimeFilter index value passed in the 6294 GetNext or GetBulk request. Counter values will still be 6295 returned beyond this point (until the last-change-time is 6296 reached), but most likely the same values will be 6297 returned. 6298 2) the return PDU includes instances lexigraphically greater 6299 than the objects expected (i.e. same GetNext semantics as 6300 if the TimeFilter wasn't there) 6301 3) a noSuchName or other exception/error is returned. 6303 Note that the use of a time-filtered table in combination with 6304 a GetRequest PDU neutralizes any optimization that otherwise 6305 might be achieved with the TimeFilter. Either the current 6306 time-filtered object-value is returned, or, if there is no 6307 time-filtered object-value instance, then a 'noSuchInstance' 6308 exception (SNMPv2c or SNMPv3) or 'noSuchName' error (SNMPv1) 6309 is returned. 6311 2) TimeFilter Example 6313 The following example demonstrates how an NMS and Agent might 6314 use a table with a TimeFilter object in the INDEX. A static 6315 table is assumed to keep the example simple, but dynamic 6316 tables can also be supported. 6318 2.1) General Assumptions 6320 fooEntry INDEX { fooTimeMark, fooIfIndex } 6321 FooEntry = SEQUENCE { 6322 fooTimeMark TimeFilter, 6323 fooIfIndex Integer32, 6324 fooCounts Counter32 6325 } 6327 The NMS polls the fooTable every 15 seconds and the 6328 baseline poll occurs when the agent has been up for 6329 6 seconds, and the NMS has been up for 10 seconds. 6331 There are 2 static rows in this table at system 6332 initialization (fooCounts.0.1 and fooCounts.0.2). 6334 Row 1 was updated as follows: 6335 SysUpTime fooCounts.*.1 value 6336 500 1 6337 900 2 6338 2300 3 6340 Row 2 was updated as follows: 6341 SysUpTime fooCounts.*.2 value 6342 1100 1 6343 1400 2 6345 2.2) SNMP Transactions from NMS Perspective 6347 Time nms-1000: 6348 # NMS baseline poll -- get everything since last agent 6349 # restart - TimeFilter == 0 6351 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6352 fooCounts.0); 6353 returns: 6354 sysUpTime.0 == 600 6355 fooCounts.0.1 == 1 # incremented at time 500 6356 fooCounts.0.2 == 0 # visible; created at time 0 6358 Time nms-2500: 6359 # NMS 1st poll 6360 # TimeFilter index == 600 6362 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6363 fooCounts.600); 6364 returns: 6365 sysUpTime.0 == 2100 6366 fooCounts.600.1 == 2 # incremented at time 900 6367 fooCounts.601.1 == 2 # indicates end of sweep 6369 Time nms-4000: 6370 # NMS 2nd poll 6371 # TimeFilter == 2100 6373 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6374 fooCounts.2100); 6375 returns: 6376 sysUpTime.0 == 3600 6377 fooCounts.2100.1 == 3 # incremented at time 2300 6378 fooCounts.2102.1 == 3 # indicates end-of-sweep 6380 # the counter value for row 2 is not returned because 6381 # it hasn't changed since sysUpTime == 2100. 6382 # The next timetick value for row 1 is returned instead 6384 Time nms-5500: 6385 # NMS 3rd poll 6386 # TimeFilter == 3600 6388 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6389 fooCounts.3600); 6390 returns: 6391 sysUpTime.0 == 5100 6392 some-instance-outside-the-fooTable == 6393 some-instance-outside-the-fooTable == 6395 # no 'fooTable' counter values at all are returned 6396 # because neither counter has been updated since 6397 # sysUpTime == 3600 6399 2.3) Transactions and TimeFilter Maintenance: Agent 6400 Perspective 6402 Time agt-0: 6403 # initialize fooTable 6404 fooCounts.1 = 0; changed.1 = 0; 6405 fooCounts.2 = 0; changed.2 = 0; 6407 Time agt-500: 6408 # increment fooCounts.1 6409 ++fooCounts.1; changed.1 = 500; 6411 Time agt-600 6412 # answer get-bulk 6413 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6414 # fooCounts.0); 6415 # (changed >= 0) 6416 # return both counters 6418 Time agt-900: 6419 # increment fooCounts.1 6420 ++fooCounts.1; changed.1 = 900; 6422 Time agt-1100: 6423 # increment fooCounts.2 6424 ++fooCounts.2; changed.2 = 1100; 6426 Time agt-1400: 6427 # increment fooCounts.2 6428 ++fooCounts.2; changed.2 = 1400; 6430 Time agt-2100 6431 # answer get-bulk 6432 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6433 # fooCounts.600); 6434 # (changed >= 600) 6435 # return both counters 6437 Time agt-2300: 6438 # increment fooCounts.1 6439 ++fooCounts.1; changed.1 = 2300; 6441 Time agt-3600: 6442 # answer get-bulk 6443 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6444 # fooCounts.2100); 6445 # (changed >= 2100) 6446 # return only fooCounts.1 from the fooTable--twice 6448 Time agt-5100: 6449 # answer get-bulk 6450 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6451 # fooCounts.3600); 6452 # (changed >= 3600) 6453 # return lexigraphically-next two MIB instances 6455 10. Changes since RFC 2021 6457 This version updates the proposed-standard version of the 6458 RMON2 MIB (published as RFC 2021) by adding 2 new enumerations 6459 to the nlMatrixTopNControlRateBase object and 4 new 6460 enumerations to the alMatrixTopNControlRateBase object. These 6461 new enumerations support the creation of high capacity topN 6462 reports in the High Capacity RMON MIB [RFC3273]. 6464 Additionally, the following objects have been deprecated as 6465 they have not had enough independent implementations to 6466 demonstrate interoperability to meet the requirements of a 6467 Draft Standard: 6469 probeDownloadFile 6470 probeDownloadTFTPServer 6471 probeDownloadAction 6472 probeDownloadStatus 6473 serialMode 6474 serialProtocol 6475 serialTimeout 6476 serialModemInitString 6477 serialModemHangUpString 6478 serialModemConnectResp 6479 serialModemNoConnectResp 6480 serialDialoutTimeout 6481 serialStatus 6482 serialConnectDestIpAddress 6483 serialConnectType 6484 serialConnectDialString 6485 serialConnectSwitchConnectSeq 6486 serialConnectSwitchDisconnectSeq 6487 serialConnectSwitchResetSeq 6488 serialConnectOwner 6489 serialConnectStatus 6490 netConfigIPAddress 6491 netConfigSubnetMask 6492 netConfigStatus 6493 netDefaultGateway 6494 tokenRingMLStats2DroppedFrames 6495 tokenRingMLStats2CreateTime 6496 tokenRingPStats2DroppedFrames 6497 tokenRingPStats2CreateTime 6498 ringStationControl2DroppedFrames 6499 ringStationControl2CreateTime 6500 sourceRoutingStats2DroppedFrames 6501 sourceRoutingStats2CreateTime 6502 trapDestIndex 6503 trapDestCommunity 6504 trapDestProtocol 6505 trapDestAddress 6506 trapDestOwner 6507 trapDestStatus 6509 In addition, two corrections were made. The LastCreateTime 6510 Textual Convention had been defined with a base type of 6511 another textual convention which isn't allowed in SMIv2. The 6512 definition has been modified to use TimeTicks as the base 6513 type. 6515 Further, the SerialConfigEntry SEQUENCE definition included 6516 sub-typing information that is not allowed in SMIv2. This 6517 information has been deleted. Ranges were added to a number of 6518 objects and textual-conventions to constrain their maximum 6519 (and sometimes minimum) sizes. The addition of these ranges 6520 documents existing practice for 6521 these objects. These objects are: 6522 ControlString 6523 protocolDirID 6524 protocolDirParameters 6525 addressMapNetworkAddress 6526 nlHostAddress 6527 nlMatrixSDSourceAddress 6528 nlMatrixSDDestAddress 6529 nlMatrixDSSourceAddress 6530 nlMatrixDSDestAddress 6531 nlMatrixTopNSourceAddress 6532 nlMatrixTopNDestAddress 6533 alHostEntry 6534 alMatrixSDEntry 6535 alMatrixDSEntry 6536 alMatrixTopNSourceAddress 6537 alMatrixTopNDestAddress 6539 Finally, the TimeFilter TC has been updated to encourage agent 6540 implementations that allow a MIB walk to behave well even when 6541 performed by an application that is not aware of the special 6542 TimeFilter semantics. 6544 11. Acknowledgments 6546 This document was produced by the IETF Remote Network 6547 Monitoring Working Group. 6549 The TimeFilter mechanism was invented and documented by Jeanne 6550 Haney. 6552 The User History group was created by Andy Bierman. 6554 12. Author's Address 6556 Steve Waldbusser 6558 Phone: +1 650-948-6500 6559 Fax: +1 650-745-0671 6560 EMail: waldbusser@nextbeacon.com 6561 13. References 6563 13.1. Normative References 6565 [RFC2578] 6566 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6567 Rose, M. and S. Waldbusser, "Structure of Management 6568 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 6569 1999. 6571 [RFC2579] 6572 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6573 Rose, M. and S. Waldbusser, "Textual Conventions for 6574 SMIv2", STD 58, RFC 2579, April 1999. 6576 [RFC2580] 6577 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6578 Rose, M. and S. Waldbusser, "Conformance Statements for 6579 SMIv2", STD 58, RFC 2580, April 1999. 6581 [RFC2819] 6582 Waldbusser, S., "Remote Network Monitoring MIB", RFC 6583 2819, Lucent Technologies, May 2000. 6585 [RFC3273] 6586 Waldbusser, S., "RMON for High Capacity Networks", RFC 6587 3273, July 2002. 6589 [RFC3417] 6590 Presuhn, R., "Transport Mappings for the Simple Network 6591 Management Protocol (SNMP)", STD 62, RFC 3417, December 6592 2002. 6594 [RFC2863] 6595 McCloghrie, K. and F. Kastenholz, "The Interfaces Group 6596 MIB", RFC 2863, Cisco Systems, Argon Networks, June 2000. 6598 [RFC1513] 6599 Waldbusser, S., "Token Ring Extensions to the Remote 6600 Network Monitoring MIB", RFC 1513, September 1993. 6602 13.2. Informative References 6604 [RFC3410] 6605 Case, J., Mundy, R., Partain, D. and B. Stewart, 6606 "Introduction and Applicability Statements for Internet 6607 Standard Management Framework", RFC 3410, December 2002. 6609 [RFC2108] 6610 De Graaf, K., Romascanu, D., McMaster, D. and K. 6611 McCloghrie, "Definition of Managed Objects for IEEE 802.3 6612 Repeater Devices using SMIv2", RFC 2108, February 1997. 6614 [RFC3414] 6615 Blumenthal, U. and B. Wijnen, "The User-Based Security 6616 Model (USM) for Version 3 of the Simple Network 6617 Management Protocol (SNMPv3)", STD 62, RFC 3414, December 6618 2002. 6620 [RFC3415] 6621 Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based 6622 Access Control Model (VACM) for the Simple Network 6623 Management Protocol (SNMP)", STD 62, RFC 3415, December 6624 2002. 6626 14. Full Copyright Statement 6628 Copyright (C) The Internet Society (2005). 6630 This document is subject to the rights, licenses and 6631 restrictions contained in BCP 78, and except as set forth 6632 therein, the authors retain all their rights. 6634 This document and the information contained herein are 6635 provided on an "AS IS" basis and THE CONTRIBUTOR, THE 6636 ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), 6637 THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE 6638 DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 6639 LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN 6640 WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 6641 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 6643 Intellectual Property 6645 The IETF takes no position regarding the validity or scope of 6646 any Intellectual Property Rights or other rights that might be 6647 claimed to pertain to the implementation or use of the 6648 technology described in this document or the extent to which 6649 any license under such rights might or might not be available; 6650 nor does it represent that it has made any independent effort 6651 to identify any such rights. Information on the procedures 6652 with respect to rights in RFC documents can be found in BCP 78 6653 and BCP 79. 6655 Copies of IPR disclosures made to the IETF Secretariat and any 6656 assurances of licenses to be made available, or the result of 6657 an attempt made to obtain a general license or permission for 6658 the use of such proprietary rights by implementers or users of 6659 this specification can be obtained from the IETF on-line IPR 6660 repository at http://www.ietf.org/ipr. 6662 The IETF invites any interested party to bring to its 6663 attention any copyrights, patents or patent applications, or 6664 other proprietary rights that may cover technology that may be 6665 required to implement this standard. Please address the 6666 information to the IETF at ietf-ipr@ietf.org.