idnits 2.17.1 draft-ietf-rmonmib-rmon2-v2-05.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 6775. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 6787. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 6794. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 6800. ** 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 4520: '...ryObjectVariable SHOULD be checked for...' RFC 2119 keyword, line 6237: '...iable, the agent MUST ensure that usrH...' RFC 2119 keyword, line 6242: '...reason, an agent SHOULD check the acce...' RFC 2119 keyword, line 6273: '...It is RECOMMENDED that implementers co...' RFC 2119 keyword, line 6279: '... 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 4679 has weird spacing: '... field octet...' == Line 4934 has weird spacing: '...se code bps...' == Line 5171 has weird spacing: '... octets cont...' == Line 5181 has weird spacing: '... octets cont...' == Line 5183 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 (October 3, 2005) is 6780 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 October 3, 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 April 3, 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 ............................... 149 85 8 IANA Considerations ................................... 150 86 9 Appendix - TimeFilter Implementation Notes ............ 151 87 10 Changes since RFC 2021 ............................... 157 88 11 Acknowledgments ...................................... 160 89 12 Author's Address ..................................... 160 90 13 References ........................................... 161 91 13.1 Normative References ............................... 161 92 13.2 Informative References ............................. 162 93 14 Full Copyright Statement ............................. 162 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 "200510031500Z" -- October 3, 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 "200510031500Z" -- October 3, 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 Note that this is not a history mechanism. Only current values 760 of underlying objects are returned, not saved instance values 761 associated with particular values of sysUpTime. 763 An entry is considered changed if the value of any object in the 764 entry changes, if the row is created, or if any object in the 765 entry is created or deleted. Note that deleted entries cannot 766 be detected or downloaded. 768 A time-filtered conceptual table is created by inserting a 769 single object of SYNTAX TimeFilter as the first INDEX component 770 in a copy of an existing basic conceptual table (i.e., any 771 SEQUENCE without a TimeFilter INDEX component). Thus, for 772 each conceptual entry 'I' in the basic table, there exists N 773 conceptual entries in the time-filtered version, (indexed N.I) 774 where 'N' is equal to the value of sysUpTime. 776 When an application retrieves conceptual instances from a 777 time-filtered table, and an INDEX value is provided for the 778 TimeFilter INDEX component 'N', the agent will only consider 779 returning basic conceptual entries (e.g., 'fooColumn.N.I') if 780 any column within the basic conceptual entry has changed since 781 sysUpTime equals 'N'. If not, the basic conceptual entry will 782 be ignored for the particular retrieval operation. 784 When sysUpTime is equal to zero, this table shall be empty. 786 One conceptual entry exists for each past value of sysUpTime, 787 except that the whole table is purged should sysUpTime wrap. 789 As an entry in a time-filtered table is updated (i.e., one of 790 the columns in the basic conceptual table is changed), new 791 conceptual entries are also created in the time-filtered version 792 (which still share the now updated object values with all other 793 instances). The number of unique time-filtered instances which 794 are created is determined by the value of sysUpTime at which the 795 basic entry was last updated. One unique instance will exist 796 for each value of sysUpTime at the last update time for the row. 797 However, a new TimeFilter index instance is created for each new 798 sysUpTime value. The TimeFilter index values not associated 799 with entry updates are called duplicate time-filtered instances. 801 After some deployment experience, it has been determined that 802 a time-filtered table is more efficient to use if the agent 803 stops a 'MIB walk' operation by skipping over rows with a 804 TimeFilter index value higher than the value in the received 805 GetNext/GetBulk request. That is, instead of incrementing a 806 TimeFilter index value, the agent will continue to the next 807 object or table. As a consequence, GetNext or GetBulk 808 operations will provide only one pass through a time-filtered 809 table. 811 It is suggested for an agent to implement a time-filtered table 812 in this manner to improve performance and avoid a 'MIB walk' 813 getting stuck in time-filtered tables. It is, however, still 814 acceptable for an agent to implement a time-filtered table in 815 the traditional manner (i.e., every conceptual time-filtered 816 instance is returned in GetNext and GetBulk PDU responses) and 817 management applications must be able to deal with such 818 traditional implementations. 820 See the appendix for further discussion of this textual 821 convention. 823 The following example is provided to demonstrate TimeFilter 824 behavior: 826 Consider the following basic conceptual table basicFooTable 827 (Note that the basic version of a time-filtered table may not 828 actually be defined.) 830 basicFooTable: 832 basicFooTable ... 833 INDEX { fooIndex } 835 BasicFooEntry { 836 fooIndex Integer32, 837 fooCounts Counter32 838 } 840 For this example, the basicFooTable contains two static 841 conceptual entries (fooIndex equals '1' and '2'), created at 842 time zero. It also contains one dynamic conceptual entry 843 (fooIndex equals '3'), which is created at time '3' and deleted 844 at time '7'. 846 The time-filtered version of the basicFooTable could be defined 847 as follows: 849 FooTable: 851 fooTable ... 852 INDEX { fooTimeMark, fooIndex } 854 FooEntry { 855 fooTimeMark TimeFilter, 856 fooIndex Integer32, 857 fooCounts Counter32 858 } 860 Note that entries exist in the time-filtered conceptual table 861 only if they actually exist in the underlying (basic) table. 863 For this example, the fooTable will have three underlying 864 basic entries (fooIndex == 1, 2, and 3), with the following 865 activity (for sysUpTime equal 0 to 9): 867 - fooEntry.N.1 is created at time '0', and most recently 868 updated at time '6' to the value '5'. 869 - fooEntry.N.2 is created at time '0', and most recently 870 updated at time '8' to the value '9'. 871 - fooEntry.N.3 is created at time '3', updated at time '5' 872 to the value '17', and deleted at time '7'. 874 The following tables show the values that would be returned for 875 'MIB walk' operations with various TimeFilter values, done at 876 different times. An application issues a retrieval request at 877 time 'T', with a TimeFilter value 'N' (typically set to a lower 878 value, such as the value of sysUpTime at the last polling cycle). 880 The following values would be returned in a MIB walk of 881 fooCounts.N if T equals '0' and N equals '0': 883 fooCounts.N.I Value 884 ========================== 885 fooCounts.0.1 0 886 fooCounts.0.2 0 888 Note there is nothing returned for fooCounts.0.3 since that 889 entry does not exist at sysUpTime equals '0'. 891 The following values would be returned in a full (traditional) MIB 892 walk of fooCounts.N if T equals '3' and N equals '0': 894 fooCounts.N.I Value 895 ======================= 896 fooCounts.0.1 0 897 fooCounts.0.2 0 898 fooCounts.0.3 0 899 fooCounts.1.3 0 900 fooCounts.2.3 0 901 fooCounts.3.3 0 903 Note that there are no instances for T equals 1 or 2, for the 904 first two values of N, since these entries did not change 905 since they were created at time '0'. 907 Note that the current value for 'fooCounts.N.3' is returned 908 here, even for values of N less than '3' (when the entry was 909 created). The agent only considers the current existence of an 910 entry in the TimeFilter algorithm, not the time when the entry 911 was created. 913 Note that the instances 'fooCounts.0.3', 'fooCounts.1.3' 914 and 'fooCounts.2.3' are duplicates and can be suppressed by the 915 agent in a MIB walk. 917 The following values would be returned in a full (traditional) 918 MIB walk of fooCounts.N if T equals '6' and N equals '3': 920 fooCounts.N.I Value 921 ======================= 922 fooCounts.3.1 5 923 fooCounts.3.3 17 924 fooCounts.4.1 5 925 fooCounts.4.3 17 926 fooCounts.5.1 5 927 fooCounts.5.3 17 928 fooCounts.6.1 5 930 Note that no instances for entry 'fooCounts.N.2' are returned 931 since it has not changed since time '3'. 933 Note that all instances except 'fooCounts.5.3' and 934 'fooCounts.6.1' are duplicates and can be suppressed by the 935 agent in a MIB walk. 937 The following values would be returned in a full (traditional) 938 MIB walk of fooCounts.N if T equals '9' and N equals '6': 940 fooCounts.N.I Value 941 ======================= 942 fooCounts.6.1 5 943 fooCounts.6.2 9 944 fooCounts.7.2 9 945 fooCounts.8.2 9 947 Note that no instances for entry 'fooCounts.N.3' are returned 948 since it was deleted at time '7'. 950 Note that instances 'fooCounts.6.2' and 'fooCounts.7.2' 951 are duplicates and can be suppressed by the agent in a MIB 952 walk." 954 SYNTAX TimeTicks 956 DataSource ::= TEXTUAL-CONVENTION 957 STATUS current 958 DESCRIPTION 959 "Identifies the source of the data that the associated 960 function is configured to analyze. This source can be any 961 interface on this device. 963 In order to identify a particular interface, this 964 object shall identify the instance of the ifIndex 965 object, defined in [RFC2863], for the desired interface. 967 For example, if an entry were to receive data from 968 interface #1, this object would be set to ifIndex.1." 969 SYNTAX OBJECT IDENTIFIER 971 -- 972 -- Protocol Directory Group 973 -- 974 -- Lists the inventory of protocols the probe has the capability of 975 -- monitoring and allows the addition, deletion, and configuration of 976 -- entries in this list. 978 protocolDirLastChange OBJECT-TYPE 979 SYNTAX TimeStamp 980 MAX-ACCESS read-only 981 STATUS current 982 DESCRIPTION 983 "The value of sysUpTime at the time the protocol directory 984 was last modified, either through insertions or deletions, 985 or through modifications of either the 986 protocolDirAddressMapConfig, protocolDirHostConfig, or 987 protocolDirMatrixConfig." 988 ::= { protocolDir 1 } 990 protocolDirTable OBJECT-TYPE 991 SYNTAX SEQUENCE OF ProtocolDirEntry 992 MAX-ACCESS not-accessible 993 STATUS current 994 DESCRIPTION 995 "This table lists the protocols that this agent has the 996 capability to decode and count. There is one entry in this 997 table for each such protocol. These protocols represent 998 different network layer, transport layer, and higher-layer 999 protocols. The agent should boot up with this table 1000 preconfigured with those protocols that it knows about and 1001 wishes to monitor. Implementations are strongly encouraged to 1002 support protocols higher than the network layer (at least for 1003 the protocol distribution group), even for implementations 1004 that don't support the application layer groups." 1005 ::= { protocolDir 2 } 1007 protocolDirEntry OBJECT-TYPE 1008 SYNTAX ProtocolDirEntry 1009 MAX-ACCESS not-accessible 1010 STATUS current 1011 DESCRIPTION 1012 "A conceptual row in the protocolDirTable. 1014 An example of the indexing of this entry is 1015 protocolDirLocalIndex.8.0.0.0.1.0.0.8.0.2.0.0, which is the 1016 encoding of a length of 8, followed by 8 subids encoding the 1017 protocolDirID of 1.2048, followed by a length of 2 and the 1018 2 subids encoding zero-valued parameters. 1020 Note that some combinations of index values may result in an 1021 index that exceeds 128 sub-identifiers in length which exceeds 1022 the maximum for the SNMP protocol. Implementations should take 1023 care to avoid such combinations." 1024 INDEX { protocolDirID, protocolDirParameters } 1025 ::= { protocolDirTable 1 } 1027 ProtocolDirEntry ::= SEQUENCE { 1028 protocolDirID OCTET STRING, 1029 protocolDirParameters OCTET STRING, 1030 protocolDirLocalIndex Integer32, 1031 protocolDirDescr DisplayString, 1032 protocolDirType BITS, 1033 protocolDirAddressMapConfig INTEGER, 1034 protocolDirHostConfig INTEGER, 1035 protocolDirMatrixConfig INTEGER, 1036 protocolDirOwner OwnerString, 1037 protocolDirStatus RowStatus 1038 } 1040 protocolDirID OBJECT-TYPE 1041 SYNTAX OCTET STRING (SIZE (4..128)) 1042 MAX-ACCESS not-accessible 1043 STATUS current 1044 DESCRIPTION 1045 "A unique identifier for a particular protocol. Standard 1046 identifiers will be defined in a manner such that they 1047 can often be used as specifications for new protocols - i.e. 1048 a tree-structured assignment mechanism that matches the 1049 protocol encapsulation `tree' and which has algorithmic 1050 assignment mechanisms for certain subtrees. See RFC 2074 for 1051 more details. 1053 Despite the algorithmic mechanism, the probe will only place 1054 entries in here for those protocols it chooses to collect. In 1055 other words, it need not populate this table with all of the 1056 possible ethernet protocol types, nor need it create them on 1057 the fly when it sees them. Whether or not it does these 1058 things is a matter of product definition (cost/benefit, 1059 usability), and is up to the designer of the product. 1061 If an entry is written to this table with a protocolDirID that 1062 the agent doesn't understand, either directly or 1063 algorithmically, the SET request will be rejected with an 1064 inconsistentName or badValue (for SNMPv1) error." 1065 ::= { protocolDirEntry 1 } 1067 protocolDirParameters OBJECT-TYPE 1068 SYNTAX OCTET STRING (SIZE (1..32)) 1069 MAX-ACCESS not-accessible 1070 STATUS current 1071 DESCRIPTION 1072 "A set of parameters for the associated protocolDirID. 1073 See the associated RMON2 Protocol Identifiers document 1074 for a description of the possible parameters. There 1075 will be one octet in this string for each sub-identifier in 1076 the protocolDirID, and the parameters will appear here in the 1077 same order as the associated sub-identifiers appear in the 1078 protocolDirID. 1080 Every node in the protocolDirID tree has a different, optional 1081 set of parameters defined (that is, the definition of 1082 parameters for a node is optional). The proper parameter 1083 value for each node is included in this string. Note that the 1084 inclusion of a parameter value in this string for each node is 1085 not optional - what is optional is that a node may have no 1086 parameters defined, in which case the parameter field for that 1087 node will be zero." 1088 ::= { protocolDirEntry 2 } 1090 protocolDirLocalIndex OBJECT-TYPE 1091 SYNTAX Integer32 (1..2147483647) 1092 MAX-ACCESS read-only 1093 STATUS current 1094 DESCRIPTION 1095 "The locally arbitrary, but unique identifier associated 1096 with this protocolDir entry. 1098 The value for each supported protocol must remain constant at 1099 least from one re-initialization of the entity's network 1100 management system to the next re-initialization, except that 1101 if a protocol is deleted and re-created, it must be re-created 1102 with a new value that has not been used since the last 1103 re-initialization. 1105 The specific value is meaningful only within a given SNMP 1106 entity. A protocolDirLocalIndex must not be re-used until the 1107 next agent restart in the event the protocol directory entry 1108 is deleted." 1109 ::= { protocolDirEntry 3 } 1111 protocolDirDescr OBJECT-TYPE 1112 SYNTAX DisplayString (SIZE (1..64)) 1113 MAX-ACCESS read-create 1114 STATUS current 1115 DESCRIPTION 1116 "A textual description of the protocol encapsulation. 1117 A probe may choose to describe only a subset of the 1118 entire encapsulation (e.g. only the highest layer). 1120 This object is intended for human consumption only. 1122 This object may not be modified if the associated 1123 protocolDirStatus object is equal to active(1)." 1124 ::= { protocolDirEntry 4 } 1126 protocolDirType OBJECT-TYPE 1127 SYNTAX BITS { 1128 extensible(0), 1129 addressRecognitionCapable(1) 1130 } 1131 MAX-ACCESS read-only 1132 STATUS current 1133 DESCRIPTION 1134 "This object describes 2 attributes of this protocol 1135 directory entry. 1137 The presence or absence of the `extensible' bit describes 1138 whether or not this protocol directory entry can be extended 1139 by the user by creating protocol directory entries which are 1140 children of this protocol. 1142 An example of an entry that will often allow extensibility is 1143 `ip.udp'. The probe may automatically populate some children 1144 of this node such as `ip.udp.snmp' and `ip.udp.dns'. 1145 A probe administrator or user may also populate additional 1146 children via remote SNMP requests that create entries in this 1147 table. When a child node is added for a protocol for which the 1148 probe has no built in support, extending a parent node (for 1149 which the probe does have built in support), 1150 that child node is not extendible. This is termed `limited 1151 extensibility'. 1153 When a child node is added through this extensibility 1154 mechanism, the values of protocolDirLocalIndex and 1155 protocolDirType shall be assigned by the agent. 1157 The other objects in the entry will be assigned by the 1158 manager who is creating the new entry. 1160 This object also describes whether or not this agent can 1161 recognize addresses for this protocol, should it be a network 1162 level protocol. That is, while a probe may be able to 1163 recognize packets of a particular network layer protocol and 1164 count them, it takes additional logic to be able to recognize 1165 the addresses in this protocol and to populate network layer 1166 or application layer tables with the addresses in this 1167 protocol. If this bit is set, the agent will recognize 1168 network layer addresses for this protoocl and populate the 1169 network and application layer host and matrix tables with 1170 these protocols. 1172 Note that when an entry is created, the agent will supply 1173 values for the bits that match the capabilities of the agent 1174 with respect to this protocol. Note that since row creations 1175 usually exercise the limited extensibility feature, these 1176 bits will usually be set to zero." 1177 ::= { protocolDirEntry 5 } 1179 protocolDirAddressMapConfig OBJECT-TYPE 1180 SYNTAX INTEGER { 1181 notSupported(1), 1182 supportedOff(2), 1183 supportedOn(3) 1184 } 1185 MAX-ACCESS read-create 1186 STATUS current 1187 DESCRIPTION 1188 "This object describes and configures the probe's support for 1189 address mapping for this protocol. When the probe creates 1190 entries in this table for all protocols that it understands, 1191 it will set the entry to notSupported(1) if it doesn't have 1192 the capability to perform address mapping for the protocol or 1193 if this protocol is not a network-layer protocol. When 1194 an entry is created in this table by a management operation as 1195 part of the limited extensibility feature, the probe must set 1196 this value to notSupported(1), because limited extensibility 1197 of the protocolDirTable does not extend to interpreting 1198 addresses of the extended protocols. 1200 If the value of this object is notSupported(1), the probe 1201 will not perform address mapping for this protocol and 1202 shall not allow this object to be changed to any other value. 1203 If the value of this object is supportedOn(3), the probe 1204 supports address mapping for this protocol and is configured 1205 to perform address mapping for this protocol for all 1206 addressMappingControlEntries and all interfaces. 1207 If the value of this object is supportedOff(2), the probe 1208 supports address mapping for this protocol but is configured 1209 to not perform address mapping for this protocol for any 1210 addressMappingControlEntries and all interfaces. 1211 Whenever this value changes from supportedOn(3) to 1212 supportedOff(2), the probe shall delete all related entries in 1213 the addressMappingTable." 1214 ::= { protocolDirEntry 6 } 1216 protocolDirHostConfig OBJECT-TYPE 1217 SYNTAX INTEGER { 1218 notSupported(1), 1219 supportedOff(2), 1220 supportedOn(3) 1221 } 1222 MAX-ACCESS read-create 1223 STATUS current 1224 DESCRIPTION 1225 "This object describes and configures the probe's support for 1226 the network layer and application layer host tables for this 1227 protocol. When the probe creates entries in this table for 1228 all protocols that it understands, it will set the entry to 1229 notSupported(1) if it doesn't have the capability to track the 1230 nlHostTable for this protocol or if the alHostTable is 1231 implemented but doesn't have the capability to track this 1232 protocol. Note that if the alHostTable is implemented, the 1233 probe may only support a protocol if it is supported in both 1234 the nlHostTable and the alHostTable. 1236 If the associated protocolDirType object has the 1237 addressRecognitionCapable bit set, then this is a network 1238 layer protocol for which the probe recognizes addresses, and 1239 thus the probe will populate the nlHostTable and alHostTable 1240 with addresses it discovers for this protocol. 1242 If the value of this object is notSupported(1), the probe 1243 will not track the nlHostTable or alHostTable for this 1244 protocol and shall not allow this object to be changed to any 1245 other value. If the value of this object is supportedOn(3), 1246 the probe supports tracking of the nlHostTable and alHostTable 1247 for this protocol and is configured to track both tables 1248 for this protocol for all control entries and all interfaces. 1249 If the value of this object is supportedOff(2), the probe 1250 supports tracking of the nlHostTable and alHostTable for this 1251 protocol but is configured to not track these tables 1252 for any control entries or interfaces. 1253 Whenever this value changes from supportedOn(3) to 1254 supportedOff(2), the probe shall delete all related entries in 1255 the nlHostTable and alHostTable. 1257 Note that since each alHostEntry references 2 protocol 1258 directory entries, one for the network address and one for the 1259 type of the highest protocol recognized, that an entry will 1260 only be created in that table if this value is supportedOn(3) 1261 for both protocols." 1262 ::= { protocolDirEntry 7 } 1264 protocolDirMatrixConfig OBJECT-TYPE 1265 SYNTAX INTEGER { 1266 notSupported(1), 1267 supportedOff(2), 1268 supportedOn(3) 1269 } 1270 MAX-ACCESS read-create 1271 STATUS current 1272 DESCRIPTION 1273 "This object describes and configures the probe's support for 1274 the network layer and application layer matrix tables for this 1275 protocol. When the probe creates entries in this table for 1276 all protocols that it understands, it will set the entry to 1277 notSupported(1) if it doesn't have the capability to track the 1278 nlMatrixTables for this protocol or if the alMatrixTables are 1279 implemented but don't have the capability to track this 1280 protocol. Note that if the alMatrix tables are implemented, 1281 the probe may only support a protocol if it is supported in 1282 the the both of the nlMatrixTables and both of the 1283 alMatrixTables. 1285 If the associated protocolDirType object has the 1286 addressRecognitionCapable bit set, then this is a network 1287 layer protocol for which the probe recognizes addresses, and 1288 thus the probe will populate both of the nlMatrixTables and 1289 both of the alMatrixTables with addresses it discovers for 1290 this protocol. 1292 If the value of this object is notSupported(1), the probe 1293 will not track either of the nlMatrixTables or the 1294 alMatrixTables for this protocol and shall not allow this 1295 object to be changed to any other value. If the value of this 1296 object is supportedOn(3), the probe supports tracking of both 1297 of the nlMatrixTables and (if implemented) both of the 1298 alMatrixTables for this protocol and is configured to track 1299 these tables for this protocol for all control entries and all 1300 interfaces. If the value of this object is supportedOff(2), 1301 the probe supports tracking of both of the nlMatrixTables and 1302 (if implemented) both of the alMatrixTables for this protocol 1303 but is configured to not track these tables for this 1304 protocol for any control entries or interfaces. 1305 Whenever this value changes from supportedOn(3) to 1306 supportedOff(2), the probe shall delete all related entries in 1307 the nlMatrixTables and the alMatrixTables. 1309 Note that since each alMatrixEntry references 2 protocol 1310 directory entries, one for the network address and one for the 1311 type of the highest protocol recognized, that an entry will 1312 only be created in that table if this value is supportedOn(3) 1313 for both protocols." 1314 ::= { protocolDirEntry 8 } 1316 protocolDirOwner OBJECT-TYPE 1317 SYNTAX OwnerString 1318 MAX-ACCESS read-create 1319 STATUS current 1320 DESCRIPTION 1321 "The entity that configured this entry and is 1322 therefore using the resources assigned to it." 1323 ::= { protocolDirEntry 9 } 1325 protocolDirStatus OBJECT-TYPE 1326 SYNTAX RowStatus 1327 MAX-ACCESS read-create 1328 STATUS current 1329 DESCRIPTION 1330 "The status of this protocol directory entry. 1332 An entry may not exist in the active state unless all 1333 objects in the entry have an appropriate value. 1335 If this object is not equal to active(1), all associated 1336 entries in the nlHostTable, nlMatrixSDTable, nlMatrixDSTable, 1337 alHostTable, alMatrixSDTable, and alMatrixDSTable shall be 1338 deleted." 1339 ::= { protocolDirEntry 10 } 1341 -- 1342 -- Protocol Distribution Group (protocolDist) 1343 -- 1344 -- Collects the relative amounts of octets and packets for the 1345 -- different protocols detected on a network segment. 1346 -- protocolDistControlTable, 1347 -- protocolDistStatsTable 1349 protocolDistControlTable OBJECT-TYPE 1350 SYNTAX SEQUENCE OF ProtocolDistControlEntry 1351 MAX-ACCESS not-accessible 1352 STATUS current 1353 DESCRIPTION 1354 "Controls the setup of protocol type distribution statistics 1355 tables. 1357 Implementations are encouraged to add an entry per monitored 1358 interface upon initialization so that a default collection 1359 of protocol statistics is available. 1361 Rationale: 1362 This table controls collection of very basic statistics 1363 for any or all of the protocols detected on a given interface. 1364 An NMS can use this table to quickly determine bandwidth 1365 allocation utilized by different protocols. 1367 A media-specific statistics collection could also 1368 be configured (e.g. etherStats, trPStats) to easily obtain 1369 total frame, octet, and droppedEvents for the same 1370 interface." 1371 ::= { protocolDist 1 } 1373 protocolDistControlEntry OBJECT-TYPE 1374 SYNTAX ProtocolDistControlEntry 1375 MAX-ACCESS not-accessible 1376 STATUS current 1377 DESCRIPTION 1378 "A conceptual row in the protocolDistControlTable. 1380 An example of the indexing of this entry is 1381 protocolDistControlDroppedFrames.7" 1382 INDEX { protocolDistControlIndex } 1383 ::= { protocolDistControlTable 1 } 1385 ProtocolDistControlEntry ::= SEQUENCE { 1386 protocolDistControlIndex Integer32, 1387 protocolDistControlDataSource DataSource, 1388 protocolDistControlDroppedFrames Counter32, 1389 protocolDistControlCreateTime LastCreateTime, 1390 protocolDistControlOwner OwnerString, 1391 protocolDistControlStatus RowStatus 1392 } 1394 protocolDistControlIndex OBJECT-TYPE 1395 SYNTAX Integer32 (1..65535) 1396 MAX-ACCESS not-accessible 1397 STATUS current 1398 DESCRIPTION 1399 "A unique index for this protocolDistControlEntry." 1400 ::= { protocolDistControlEntry 1 } 1402 protocolDistControlDataSource OBJECT-TYPE 1403 SYNTAX DataSource 1404 MAX-ACCESS read-create 1405 STATUS current 1406 DESCRIPTION 1407 "The source of data for the this protocol distribution. 1409 The statistics in this group reflect all packets 1410 on the local network segment attached to the 1411 identified interface. 1413 This object may not be modified if the associated 1414 protocolDistControlStatus object is equal to active(1)." 1415 ::= { protocolDistControlEntry 2 } 1417 protocolDistControlDroppedFrames OBJECT-TYPE 1418 SYNTAX Counter32 1419 MAX-ACCESS read-only 1420 STATUS current 1421 DESCRIPTION 1422 "The total number of frames which were received by the probe 1423 and therefore not accounted for in the *StatsDropEvents, but 1424 for which the probe chose not to count for this entry for 1425 whatever reason. Most often, this event occurs when the probe 1426 is out of some resources and decides to shed load from this 1427 collection. 1429 This count does not include packets that were not counted 1430 because they had MAC-layer errors. 1432 Note that, unlike the dropEvents counter, this number is the 1433 exact number of frames dropped." 1434 ::= { protocolDistControlEntry 3 } 1436 protocolDistControlCreateTime OBJECT-TYPE 1437 SYNTAX LastCreateTime 1438 MAX-ACCESS read-only 1439 STATUS current 1440 DESCRIPTION 1441 "The value of sysUpTime when this control entry was last 1442 activated. This can be used by the management station to 1443 ensure that the table has not been deleted and recreated 1444 between polls." 1445 ::= { protocolDistControlEntry 4 } 1447 protocolDistControlOwner OBJECT-TYPE 1448 SYNTAX OwnerString 1449 MAX-ACCESS read-create 1450 STATUS current 1451 DESCRIPTION 1452 "The entity that configured this entry and is 1453 therefore using the resources assigned to it." 1454 ::= { protocolDistControlEntry 5 } 1456 protocolDistControlStatus OBJECT-TYPE 1457 SYNTAX RowStatus 1458 MAX-ACCESS read-create 1459 STATUS current 1460 DESCRIPTION 1461 "The status of this row. 1463 An entry may not exist in the active state unless all 1464 objects in the entry have an appropriate value. 1466 If this object is not equal to active(1), all associated 1467 entries in the protocolDistStatsTable shall be deleted." 1468 ::= { protocolDistControlEntry 6 } 1470 -- per interface protocol distribution statistics table 1471 protocolDistStatsTable OBJECT-TYPE 1472 SYNTAX SEQUENCE OF ProtocolDistStatsEntry 1473 MAX-ACCESS not-accessible 1474 STATUS current 1475 DESCRIPTION 1476 "An entry is made in this table for every protocol in the 1477 protocolDirTable which has been seen in at least one packet. 1478 Counters are updated in this table for every protocol type 1479 that is encountered when parsing a packet, but no counters are 1480 updated for packets with MAC-layer errors. 1482 Note that if a protocolDirEntry is deleted, all associated 1483 entries in this table are removed." 1484 ::= { protocolDist 2 } 1486 protocolDistStatsEntry OBJECT-TYPE 1487 SYNTAX ProtocolDistStatsEntry 1488 MAX-ACCESS not-accessible 1489 STATUS current 1490 DESCRIPTION 1491 "A conceptual row in the protocolDistStatsTable. 1493 The index is composed of the protocolDistControlIndex of the 1494 associated protocolDistControlEntry followed by the 1495 protocolDirLocalIndex of the associated protocol that this 1496 entry represents. In other words, the index identifies the 1497 protocol distribution an entry is a part of as well as the 1498 particular protocol that it represents. 1500 An example of the indexing of this entry is 1501 protocolDistStatsPkts.1.18" 1502 INDEX { protocolDistControlIndex, protocolDirLocalIndex } 1503 ::= { protocolDistStatsTable 1 } 1505 ProtocolDistStatsEntry ::= SEQUENCE { 1506 protocolDistStatsPkts ZeroBasedCounter32, 1507 protocolDistStatsOctets ZeroBasedCounter32 1508 } 1510 protocolDistStatsPkts OBJECT-TYPE 1511 SYNTAX ZeroBasedCounter32 1512 MAX-ACCESS read-only 1513 STATUS current 1514 DESCRIPTION 1515 "The number of packets without errors received of this 1516 protocol type. Note that this is the number of link-layer 1517 packets, so if a single network-layer packet is fragmented 1518 into several link-layer frames, this counter is incremented 1519 several times." 1520 ::= { protocolDistStatsEntry 1 } 1522 protocolDistStatsOctets OBJECT-TYPE 1523 SYNTAX ZeroBasedCounter32 1524 MAX-ACCESS read-only 1525 STATUS current 1526 DESCRIPTION 1527 "The number of octets in packets received of this protocol 1528 type since it was added to the protocolDistStatsTable 1529 (excluding framing bits but including FCS octets), except for 1530 those octets in packets that contained errors. 1532 Note this doesn't count just those octets in the particular 1533 protocol frames, but includes the entire packet that contained 1534 the protocol." 1535 ::= { protocolDistStatsEntry 2 } 1537 -- 1538 -- Address Map Group (addressMap) 1539 -- 1540 -- Lists MAC address to network address bindings discovered by the 1541 -- probe and what interface they were last seen on. 1542 -- addressMapControlTable 1543 -- addressMapTable 1545 addressMapInserts OBJECT-TYPE 1546 SYNTAX Counter32 1547 MAX-ACCESS read-only 1548 STATUS current 1549 DESCRIPTION 1550 "The number of times an address mapping entry has been 1551 inserted into the addressMapTable. If an entry is inserted, 1552 then deleted, and then inserted, this counter will be 1553 incremented by 2. 1555 Note that the table size can be determined by subtracting 1556 addressMapDeletes from addressMapInserts." 1557 ::= { addressMap 1 } 1559 addressMapDeletes OBJECT-TYPE 1560 SYNTAX Counter32 1561 MAX-ACCESS read-only 1562 STATUS current 1563 DESCRIPTION 1564 "The number of times an address mapping entry has been 1565 deleted from the addressMapTable (for any reason). If 1566 an entry is deleted, then inserted, and then deleted, this 1567 counter will be incremented by 2. 1569 Note that the table size can be determined by subtracting 1570 addressMapDeletes from addressMapInserts." 1571 ::= { addressMap 2 } 1573 addressMapMaxDesiredEntries OBJECT-TYPE 1574 SYNTAX Integer32 (-1..2147483647) 1575 MAX-ACCESS read-write 1576 STATUS current 1577 DESCRIPTION 1578 "The maximum number of entries that are desired in the 1579 addressMapTable. The probe will not create more than 1580 this number of entries in the table, but may choose to create 1581 fewer entries in this table for any reason including the lack 1582 of resources. 1584 If this object is set to a value less than the current number 1585 of entries, enough entries are chosen in an 1586 implementation-dependent manner and deleted so that the number 1587 of entries in the table equals the value of this object. 1589 If this value is set to -1, the probe may create any number 1590 of entries in this table. 1592 This object may be used to control how resources are allocated 1593 on the probe for the various RMON functions." 1594 ::= { addressMap 3 } 1596 addressMapControlTable OBJECT-TYPE 1597 SYNTAX SEQUENCE OF AddressMapControlEntry 1598 MAX-ACCESS not-accessible 1599 STATUS current 1600 DESCRIPTION 1601 "A table to control the collection of network layer address to 1602 physical address to interface mappings. 1604 Note that this is not like the typical RMON 1605 controlTable and dataTable in which each entry creates 1606 its own data table. Each entry in this table enables the 1607 discovery of addresses on a new interface and the placement 1608 of address mappings into the central addressMapTable. 1610 Implementations are encouraged to add an entry per monitored 1611 interface upon initialization so that a default collection 1612 of address mappings is available." 1613 ::= { addressMap 4 } 1615 addressMapControlEntry OBJECT-TYPE 1616 SYNTAX AddressMapControlEntry 1617 MAX-ACCESS not-accessible 1618 STATUS current 1619 DESCRIPTION 1620 "A conceptual row in the addressMapControlTable. 1622 An example of the indexing of this entry is 1623 addressMapControlDroppedFrames.1" 1624 INDEX { addressMapControlIndex } 1625 ::= { addressMapControlTable 1 } 1627 AddressMapControlEntry ::= SEQUENCE { 1628 addressMapControlIndex Integer32, 1629 addressMapControlDataSource DataSource, 1630 addressMapControlDroppedFrames Counter32, 1631 addressMapControlOwner OwnerString, 1632 addressMapControlStatus RowStatus 1633 } 1635 addressMapControlIndex OBJECT-TYPE 1636 SYNTAX Integer32 (1..65535) 1637 MAX-ACCESS not-accessible 1638 STATUS current 1639 DESCRIPTION 1640 "A unique index for this entry in the addressMapControlTable." 1641 ::= { addressMapControlEntry 1 } 1643 addressMapControlDataSource OBJECT-TYPE 1644 SYNTAX DataSource 1645 MAX-ACCESS read-create 1646 STATUS current 1647 DESCRIPTION 1648 "The source of data for this addressMapControlEntry." 1649 ::= { addressMapControlEntry 2 } 1651 addressMapControlDroppedFrames OBJECT-TYPE 1652 SYNTAX Counter32 1653 MAX-ACCESS read-only 1654 STATUS current 1655 DESCRIPTION 1656 "The total number of frames which were received by the probe 1657 and therefore not accounted for in the *StatsDropEvents, but 1658 for which the probe chose not to count for this entry for 1659 whatever reason. Most often, this event occurs when the probe 1660 is out of some resources and decides to shed load from this 1661 collection. 1663 This count does not include packets that were not counted 1664 because they had MAC-layer errors. 1666 Note that, unlike the dropEvents counter, this number is the 1667 exact number of frames dropped." 1668 ::= { addressMapControlEntry 3 } 1670 addressMapControlOwner OBJECT-TYPE 1671 SYNTAX OwnerString 1672 MAX-ACCESS read-create 1673 STATUS current 1674 DESCRIPTION 1675 "The entity that configured this entry and is 1676 therefore using the resources assigned to it." 1677 ::= { addressMapControlEntry 4 } 1679 addressMapControlStatus OBJECT-TYPE 1680 SYNTAX RowStatus 1681 MAX-ACCESS read-create 1682 STATUS current 1683 DESCRIPTION 1684 "The status of this addressMap control entry. 1686 An entry may not exist in the active state unless all 1687 objects in the entry have an appropriate value. 1689 If this object is not equal to active(1), all associated 1690 entries in the addressMapTable shall be deleted." 1691 ::= { addressMapControlEntry 5 } 1693 addressMapTable OBJECT-TYPE 1694 SYNTAX SEQUENCE OF AddressMapEntry 1695 MAX-ACCESS not-accessible 1696 STATUS current 1697 DESCRIPTION 1698 "A table of network layer address to physical address to 1699 interface mappings. 1701 The probe will add entries to this table based on the source 1702 MAC and network addresses seen in packets without MAC-level 1703 errors. The probe will populate this table for all protocols 1704 in the protocol directory table whose value of 1705 protocolDirAddressMapConfig is equal to supportedOn(3), and 1706 will delete any entries whose protocolDirEntry is deleted or 1707 has a protocolDirAddressMapConfig value of supportedOff(2)." 1708 ::= { addressMap 5 } 1710 addressMapEntry OBJECT-TYPE 1711 SYNTAX AddressMapEntry 1712 MAX-ACCESS not-accessible 1713 STATUS current 1714 DESCRIPTION 1715 "A conceptual row in the addressMapTable. 1717 The protocolDirLocalIndex in the index identifies the network 1718 layer protocol of the addressMapNetworkAddress. 1720 An example of the indexing of this entry is 1721 addressMapSource.783495.18.4.128.2.6.6.11.1.3.6.1.2.1.2.2.1.1.1. 1723 Note that some combinations of index values may result in an 1724 index that exceeds 128 sub-identifiers in length which exceeds 1725 the maximum for the SNMP protocol. Implementations should take 1726 care to avoid such combinations." 1727 INDEX { addressMapTimeMark, protocolDirLocalIndex, 1728 addressMapNetworkAddress, addressMapSource } 1729 ::= { addressMapTable 1 } 1731 AddressMapEntry ::= SEQUENCE { 1732 addressMapTimeMark TimeFilter, 1733 addressMapNetworkAddress OCTET STRING, 1734 addressMapSource OBJECT IDENTIFIER, 1735 addressMapPhysicalAddress OCTET STRING, 1736 addressMapLastChange TimeStamp 1737 } 1739 addressMapTimeMark OBJECT-TYPE 1740 SYNTAX TimeFilter 1741 MAX-ACCESS not-accessible 1742 STATUS current 1743 DESCRIPTION 1744 "A TimeFilter for this entry. See the TimeFilter textual 1745 convention to see how this works." 1746 ::= { addressMapEntry 1 } 1748 addressMapNetworkAddress OBJECT-TYPE 1749 SYNTAX OCTET STRING (SIZE (1..255)) 1750 MAX-ACCESS not-accessible 1751 STATUS current 1752 DESCRIPTION 1753 "The network address for this relation. 1755 This is represented as an octet string with 1756 specific semantics and length as identified 1757 by the protocolDirLocalIndex component of the 1758 index. 1760 For example, if the protocolDirLocalIndex indicates an 1761 encapsulation of ip, this object is encoded as a length 1762 octet of 4, followed by the 4 octets of the ip address, 1763 in network byte order." 1764 ::= { addressMapEntry 2 } 1766 addressMapSource OBJECT-TYPE 1767 SYNTAX OBJECT IDENTIFIER 1768 MAX-ACCESS not-accessible 1769 STATUS current 1770 DESCRIPTION 1771 "The interface or port on which the associated network 1772 address was most recently seen. 1774 If this address mapping was discovered on an interface, this 1775 object shall identify the instance of the ifIndex 1776 object, defined in [RFC2863], for the desired interface. 1777 For example, if an entry were to receive data from 1778 interface #1, this object would be set to ifIndex.1. 1780 If this address mapping was discovered on a port, this 1781 object shall identify the instance of the rptrGroupPortIndex 1782 object, defined in [RFC2108], for the desired port. 1783 For example, if an entry were to receive data from 1784 group #1, port #1, this object would be set to 1785 rptrGroupPortIndex.1.1. 1787 Note that while the dataSource associated with this entry 1788 may only point to index objects, this object may at times 1789 point to repeater port objects. This situation occurs when 1790 the dataSource points to an interface which is a locally 1791 attached repeater and the agent has additional information 1792 about the source port of traffic seen on that repeater." 1793 ::= { addressMapEntry 3 } 1795 addressMapPhysicalAddress OBJECT-TYPE 1796 SYNTAX OCTET STRING 1797 MAX-ACCESS read-only 1798 STATUS current 1799 DESCRIPTION 1800 "The last source physical address on which the associated 1801 network address was seen. If the protocol of the associated 1802 network address was encapsulated inside of a network-level or 1803 higher protocol, this will be the address of the next-lower 1804 protocol with the addressRecognitionCapable bit enabled and 1805 will be formatted as specified for that protocol." 1806 ::= { addressMapEntry 4 } 1808 addressMapLastChange OBJECT-TYPE 1809 SYNTAX TimeStamp 1810 MAX-ACCESS read-only 1811 STATUS current 1812 DESCRIPTION 1813 "The value of sysUpTime at the time this entry was last 1814 created or the values of the physical address changed. 1816 This can be used to help detect duplicate address problems, in 1817 which case this object will be updated frequently." 1818 ::= { addressMapEntry 5 } 1820 -- 1821 -- Network Layer Host Group 1822 -- 1823 -- Counts the amount of traffic sent from and to each network address 1824 -- discovered by the probe. 1825 -- Note that while the hlHostControlTable also has objects that 1826 -- control an optional alHostTable, implementation of the alHostTable is 1827 -- not required to fully implement this group. 1829 hlHostControlTable OBJECT-TYPE 1830 SYNTAX SEQUENCE OF HlHostControlEntry 1831 MAX-ACCESS not-accessible 1832 STATUS current 1833 DESCRIPTION 1834 "A list of higher layer (i.e. non-MAC) host table control 1835 entries. 1837 These entries will enable the collection of the network and 1838 application level host tables indexed by network addresses. 1839 Both the network and application level host tables are 1840 controlled by this table is so that they will both be created 1841 and deleted at the same time, further increasing the ease with 1842 which they can be implemented as a single datastore (note that 1843 if an implementation stores application layer host records in 1844 memory, it can derive network layer host records from them). 1846 Entries in the nlHostTable will be created on behalf of each 1847 entry in this table. Additionally, if this probe implements 1848 the alHostTable, entries in the alHostTable will be created on 1849 behalf of each entry in this table. 1851 Implementations are encouraged to add an entry per monitored 1852 interface upon initialization so that a default collection 1853 of host statistics is available." 1854 ::= { nlHost 1 } 1856 hlHostControlEntry OBJECT-TYPE 1857 SYNTAX HlHostControlEntry 1858 MAX-ACCESS not-accessible 1859 STATUS current 1860 DESCRIPTION 1861 "A conceptual row in the hlHostControlTable. 1863 An example of the indexing of this entry is 1864 hlHostControlNlDroppedFrames.1" 1865 INDEX { hlHostControlIndex } 1866 ::= { hlHostControlTable 1 } 1868 HlHostControlEntry ::= SEQUENCE { 1869 hlHostControlIndex Integer32, 1870 hlHostControlDataSource DataSource, 1871 hlHostControlNlDroppedFrames Counter32, 1872 hlHostControlNlInserts Counter32, 1873 hlHostControlNlDeletes Counter32, 1874 hlHostControlNlMaxDesiredEntries Integer32, 1875 hlHostControlAlDroppedFrames Counter32, 1876 hlHostControlAlInserts Counter32, 1877 hlHostControlAlDeletes Counter32, 1878 hlHostControlAlMaxDesiredEntries Integer32, 1879 hlHostControlOwner OwnerString, 1880 hlHostControlStatus RowStatus 1881 } 1883 hlHostControlIndex OBJECT-TYPE 1884 SYNTAX Integer32 (1..65535) 1885 MAX-ACCESS not-accessible 1886 STATUS current 1887 DESCRIPTION 1888 "An index that uniquely identifies an entry in the 1889 hlHostControlTable. Each such entry defines 1890 a function that discovers hosts on a particular 1891 interface and places statistics about them in the 1892 nlHostTable, and optionally in the alHostTable, on 1893 behalf of this hlHostControlEntry." 1894 ::= { hlHostControlEntry 1 } 1896 hlHostControlDataSource OBJECT-TYPE 1897 SYNTAX DataSource 1898 MAX-ACCESS read-create 1899 STATUS current 1900 DESCRIPTION 1901 "The source of data for the associated host tables. 1903 The statistics in this group reflect all packets 1904 on the local network segment attached to the 1905 identified interface. 1907 This object may not be modified if the associated 1908 hlHostControlStatus object is equal to active(1)." 1909 ::= { hlHostControlEntry 2 } 1911 hlHostControlNlDroppedFrames OBJECT-TYPE 1912 SYNTAX Counter32 1913 MAX-ACCESS read-only 1914 STATUS current 1915 DESCRIPTION 1916 "The total number of frames which were received by the probe 1917 and therefore not accounted for in the *StatsDropEvents, but 1918 for which the probe chose not to count for the associated 1919 nlHost entries for whatever reason. Most often, this event 1920 occurs when the probe is out of some resources and decides to 1921 shed load from this collection. 1923 This count does not include packets that were not counted 1924 because they had MAC-layer errors. 1926 Note that if the nlHostTable is inactive because no protocols 1927 are enabled in the protocol directory, this value should be 0. 1929 Note that, unlike the dropEvents counter, this number is the 1930 exact number of frames dropped." 1931 ::= { hlHostControlEntry 3 } 1933 hlHostControlNlInserts OBJECT-TYPE 1934 SYNTAX Counter32 1935 MAX-ACCESS read-only 1936 STATUS current 1937 DESCRIPTION 1938 "The number of times an nlHost entry has been 1939 inserted into the nlHost table. If an entry is inserted, then 1940 deleted, and then inserted, this counter will be incremented 1941 by 2. 1943 To allow for efficient implementation strategies, agents may 1944 delay updating this object for short periods of time. For 1945 example, an implementation strategy may allow internal 1946 data structures to differ from those visible via SNMP for 1947 short periods of time. This counter may reflect the internal 1948 data structures for those short periods of time. 1950 Note that the table size can be determined by subtracting 1951 hlHostControlNlDeletes from hlHostControlNlInserts." 1953 ::= { hlHostControlEntry 4 } 1955 hlHostControlNlDeletes OBJECT-TYPE 1956 SYNTAX Counter32 1957 MAX-ACCESS read-only 1958 STATUS current 1959 DESCRIPTION 1960 "The number of times an nlHost entry has been 1961 deleted from the nlHost table (for any reason). If an entry 1962 is deleted, then inserted, and then deleted, this counter will 1963 be incremented by 2. 1965 To allow for efficient implementation strategies, agents may 1966 delay updating this object for short periods of time. For 1967 example, an implementation strategy may allow internal 1968 data structures to differ from those visible via SNMP for 1969 short periods of time. This counter may reflect the internal 1970 data structures for those short periods of time. 1972 Note that the table size can be determined by subtracting 1973 hlHostControlNlDeletes from hlHostControlNlInserts." 1974 ::= { hlHostControlEntry 5 } 1976 hlHostControlNlMaxDesiredEntries OBJECT-TYPE 1977 SYNTAX Integer32 (-1..2147483647) 1978 MAX-ACCESS read-create 1979 STATUS current 1980 DESCRIPTION 1981 "The maximum number of entries that are desired in the 1982 nlHostTable on behalf of this control entry. The probe will 1983 not create more than this number of associated entries in the 1984 table, but may choose to create fewer entries in this table 1985 for any reason including the lack of resources. 1987 If this object is set to a value less than the current number 1988 of entries, enough entries are chosen in an 1989 implementation-dependent manner and deleted so that the number 1990 of entries in the table equals the value of this object. 1992 If this value is set to -1, the probe may create any number 1993 of entries in this table. If the associated 1994 hlHostControlStatus object is equal to `active', this 1995 object may not be modified. 1997 This object may be used to control how resources are allocated 1998 on the probe for the various RMON functions." 1999 ::= { hlHostControlEntry 6 } 2001 hlHostControlAlDroppedFrames OBJECT-TYPE 2002 SYNTAX Counter32 2003 MAX-ACCESS read-only 2004 STATUS current 2005 DESCRIPTION 2006 "The total number of frames which were received by the probe 2007 and therefore not accounted for in the *StatsDropEvents, but 2008 for which the probe chose not to count for the associated 2009 alHost entries for whatever reason. Most often, this event 2010 occurs when the probe is out of some resources and decides to 2011 shed load from this collection. 2013 This count does not include packets that were not counted 2014 because they had MAC-layer errors. 2016 Note that if the alHostTable is not implemented or is inactive 2017 because no protocols are enabled in the protocol directory, 2018 this value should be 0. 2020 Note that, unlike the dropEvents counter, this number is the 2021 exact number of frames dropped." 2022 ::= { hlHostControlEntry 7 } 2024 hlHostControlAlInserts OBJECT-TYPE 2025 SYNTAX Counter32 2026 MAX-ACCESS read-only 2027 STATUS current 2028 DESCRIPTION 2029 "The number of times an alHost entry has been 2030 inserted into the alHost table. If an entry is inserted, then 2031 deleted, and then inserted, this counter will be incremented 2032 by 2. 2034 To allow for efficient implementation strategies, agents may 2035 delay updating this object for short periods of time. For 2036 example, an implementation strategy may allow internal 2037 data structures to differ from those visible via SNMP for 2038 short periods of time. This counter may reflect the internal 2039 data structures for those short periods of time. 2041 Note that the table size can be determined by subtracting 2042 hlHostControlAlDeletes from hlHostControlAlInserts." 2043 ::= { hlHostControlEntry 8 } 2045 hlHostControlAlDeletes OBJECT-TYPE 2046 SYNTAX Counter32 2047 MAX-ACCESS read-only 2048 STATUS current 2049 DESCRIPTION 2050 "The number of times an alHost entry has been 2051 deleted from the alHost table (for any reason). If an entry 2052 is deleted, then inserted, and then deleted, this counter will 2053 be incremented by 2. 2055 To allow for efficient implementation strategies, agents may 2056 delay updating this object for short periods of time. For 2057 example, an implementation strategy may allow internal 2058 data structures to differ from those visible via SNMP for 2059 short periods of time. This counter may reflect the internal 2060 data structures for those short periods of time. 2062 Note that the table size can be determined by subtracting 2063 hlHostControlAlDeletes from hlHostControlAlInserts." 2064 ::= { hlHostControlEntry 9 } 2066 hlHostControlAlMaxDesiredEntries OBJECT-TYPE 2067 SYNTAX Integer32 (-1..2147483647) 2068 MAX-ACCESS read-create 2069 STATUS current 2070 DESCRIPTION 2071 "The maximum number of entries that are desired in the alHost 2072 table on behalf of this control entry. The probe will not 2073 create more than this number of associated entries in the 2074 table, but may choose to create fewer entries in this table 2075 for any reason including the lack of resources. 2077 If this object is set to a value less than the current number 2078 of entries, enough entries are chosen in an 2079 implementation-dependent manner and deleted so that the number 2080 of entries in the table equals the value of this object. 2082 If this value is set to -1, the probe may create any number 2083 of entries in this table. If the associated 2084 hlHostControlStatus object is equal to `active', this 2085 object may not be modified. 2087 This object may be used to control how resources are allocated 2088 on the probe for the various RMON functions." 2089 ::= { hlHostControlEntry 10 } 2091 hlHostControlOwner OBJECT-TYPE 2092 SYNTAX OwnerString 2093 MAX-ACCESS read-create 2094 STATUS current 2095 DESCRIPTION 2096 "The entity that configured this entry and is 2097 therefore using the resources assigned to it." 2098 ::= { hlHostControlEntry 11 } 2100 hlHostControlStatus OBJECT-TYPE 2101 SYNTAX RowStatus 2102 MAX-ACCESS read-create 2103 STATUS current 2104 DESCRIPTION 2105 "The status of this hlHostControlEntry. 2107 An entry may not exist in the active state unless all 2108 objects in the entry have an appropriate value. 2110 If this object is not equal to active(1), all associated 2111 entries in the nlHostTable and alHostTable shall be deleted." 2112 ::= { hlHostControlEntry 12 } 2114 nlHostTable OBJECT-TYPE 2115 SYNTAX SEQUENCE OF NlHostEntry 2116 MAX-ACCESS not-accessible 2117 STATUS current 2118 DESCRIPTION 2119 "A collection of statistics for a particular network layer 2120 address that has been discovered on an interface of this 2121 device. 2123 The probe will populate this table for all network layer 2124 protocols in the protocol directory table whose value of 2125 protocolDirHostConfig is equal to supportedOn(3), and 2126 will delete any entries whose protocolDirEntry is deleted or 2127 has a protocolDirHostConfig value of supportedOff(2). 2129 The probe will add to this table all addresses seen 2130 as the source or destination address in all packets with no 2131 MAC errors, and will increment octet and packet counts in the 2132 table for all packets with no MAC errors." 2133 ::= { nlHost 2 } 2135 nlHostEntry OBJECT-TYPE 2136 SYNTAX NlHostEntry 2137 MAX-ACCESS not-accessible 2138 STATUS current 2139 DESCRIPTION 2140 "A conceptual row in the nlHostTable. 2142 The hlHostControlIndex value in the index identifies the 2143 hlHostControlEntry on whose behalf this entry was created. 2144 The protocolDirLocalIndex value in the index identifies the 2145 network layer protocol of the nlHostAddress. 2147 An example of the indexing of this entry is 2148 nlHostOutPkts.1.783495.18.4.128.2.6.6. 2150 Note that some combinations of index values may result in an 2151 index that exceeds 128 sub-identifiers in length which exceeds 2152 the maximum for the SNMP protocol. Implementations should take 2153 care to avoid such combinations." 2154 INDEX { hlHostControlIndex, nlHostTimeMark, 2155 protocolDirLocalIndex, nlHostAddress } 2156 ::= { nlHostTable 1 } 2158 NlHostEntry ::= SEQUENCE { 2159 nlHostTimeMark TimeFilter, 2160 nlHostAddress OCTET STRING, 2161 nlHostInPkts ZeroBasedCounter32, 2162 nlHostOutPkts ZeroBasedCounter32, 2163 nlHostInOctets ZeroBasedCounter32, 2164 nlHostOutOctets ZeroBasedCounter32, 2165 nlHostOutMacNonUnicastPkts ZeroBasedCounter32, 2166 nlHostCreateTime LastCreateTime 2167 } 2169 nlHostTimeMark OBJECT-TYPE 2170 SYNTAX TimeFilter 2171 MAX-ACCESS not-accessible 2172 STATUS current 2173 DESCRIPTION 2174 "A TimeFilter for this entry. See the TimeFilter textual 2175 convention to see how this works." 2176 ::= { nlHostEntry 1 } 2178 nlHostAddress OBJECT-TYPE 2179 SYNTAX OCTET STRING (SIZE (1..255)) 2180 MAX-ACCESS not-accessible 2181 STATUS current 2182 DESCRIPTION 2183 "The network address for this nlHostEntry. 2185 This is represented as an octet string with 2186 specific semantics and length as identified 2187 by the protocolDirLocalIndex component of the index. 2189 For example, if the protocolDirLocalIndex indicates an 2190 encapsulation of ip, this object is encoded as a length 2191 octet of 4, followed by the 4 octets of the ip address, 2192 in network byte order." 2193 ::= { nlHostEntry 2 } 2195 nlHostInPkts OBJECT-TYPE 2196 SYNTAX ZeroBasedCounter32 2197 MAX-ACCESS read-only 2198 STATUS current 2199 DESCRIPTION 2200 "The number of packets without errors transmitted to 2201 this address since it was added to the nlHostTable. Note that 2202 this is the number of link-layer packets, so if a single 2203 network-layer packet is fragmented into several link-layer 2204 frames, this counter is incremented several times." 2205 ::= { nlHostEntry 3 } 2207 nlHostOutPkts OBJECT-TYPE 2208 SYNTAX ZeroBasedCounter32 2209 MAX-ACCESS read-only 2210 STATUS current 2211 DESCRIPTION 2212 "The number of packets without errors transmitted by 2213 this address since it was added to the nlHostTable. Note that 2214 this is the number of link-layer packets, so if a single 2215 network-layer packet is fragmented into several link-layer 2216 frames, this counter is incremented several times." 2218 ::= { nlHostEntry 4 } 2220 nlHostInOctets OBJECT-TYPE 2221 SYNTAX ZeroBasedCounter32 2222 MAX-ACCESS read-only 2223 STATUS current 2224 DESCRIPTION 2225 "The number of octets transmitted to this address 2226 since it was added to the nlHostTable (excluding 2227 framing bits but including FCS octets), excluding 2228 those octets in packets that contained errors. 2230 Note this doesn't count just those octets in the particular 2231 protocol frames, but includes the entire packet that contained 2232 the protocol." 2233 ::= { nlHostEntry 5 } 2235 nlHostOutOctets OBJECT-TYPE 2236 SYNTAX ZeroBasedCounter32 2237 MAX-ACCESS read-only 2238 STATUS current 2239 DESCRIPTION 2240 "The number of octets transmitted by this address 2241 since it was added to the nlHostTable (excluding 2242 framing bits but including FCS octets), excluding 2243 those octets in packets that contained errors. 2245 Note this doesn't count just those octets in the particular 2246 protocol frames, but includes the entire packet that contained 2247 the protocol." 2248 ::= { nlHostEntry 6 } 2250 nlHostOutMacNonUnicastPkts OBJECT-TYPE 2251 SYNTAX ZeroBasedCounter32 2252 MAX-ACCESS read-only 2253 STATUS current 2254 DESCRIPTION 2255 "The number of packets without errors transmitted by this 2256 address that were directed to any MAC broadcast addresses 2257 or to any MAC multicast addresses since this host was 2258 added to the nlHostTable. Note that this is the number of 2259 link-layer packets, so if a single network-layer packet is 2260 fragmented into several link-layer frames, this counter is 2261 incremented several times." 2263 ::= { nlHostEntry 7 } 2265 nlHostCreateTime OBJECT-TYPE 2266 SYNTAX LastCreateTime 2267 MAX-ACCESS read-only 2268 STATUS current 2269 DESCRIPTION 2270 "The value of sysUpTime when this entry was last activated. 2271 This can be used by the management station to ensure that the 2272 entry has not been deleted and recreated between polls." 2273 ::= { nlHostEntry 8 } 2275 -- 2276 -- Network Layer Matrix Group 2277 -- 2278 -- Counts the amount of traffic sent between each pair of network 2279 -- addresses discovered by the probe. 2280 -- Note that while the hlMatrixControlTable also has objects that 2281 -- control optional alMatrixTables, implementation of the 2282 -- alMatrixTables is not required to fully implement this group. 2284 hlMatrixControlTable OBJECT-TYPE 2285 SYNTAX SEQUENCE OF HlMatrixControlEntry 2286 MAX-ACCESS not-accessible 2287 STATUS current 2288 DESCRIPTION 2289 "A list of higher layer (i.e. non-MAC) matrix control entries. 2291 These entries will enable the collection of the network and 2292 application level matrix tables containing conversation 2293 statistics indexed by pairs of network addresses. 2294 Both the network and application level matrix tables are 2295 controlled by this table is so that they will both be created 2296 and deleted at the same time, further increasing the ease with 2297 which they can be implemented as a single datastore (note that 2298 if an implementation stores application layer matrix records 2299 in memory, it can derive network layer matrix records from 2300 them). 2302 Entries in the nlMatrixSDTable and nlMatrixDSTable will be 2303 created on behalf of each entry in this table. Additionally, 2304 if this probe implements the alMatrix tables, entries in the 2305 alMatrix tables will be created on behalf of each entry in 2306 this table." 2307 ::= { nlMatrix 1 } 2309 hlMatrixControlEntry OBJECT-TYPE 2310 SYNTAX HlMatrixControlEntry 2311 MAX-ACCESS not-accessible 2312 STATUS current 2313 DESCRIPTION 2314 "A conceptual row in the hlMatrixControlTable. 2316 An example of indexing of this entry is 2317 hlMatrixControlNlDroppedFrames.1" 2318 INDEX { hlMatrixControlIndex } 2319 ::= { hlMatrixControlTable 1 } 2321 HlMatrixControlEntry ::= SEQUENCE { 2322 hlMatrixControlIndex Integer32, 2323 hlMatrixControlDataSource DataSource, 2324 hlMatrixControlNlDroppedFrames Counter32, 2325 hlMatrixControlNlInserts Counter32, 2326 hlMatrixControlNlDeletes Counter32, 2327 hlMatrixControlNlMaxDesiredEntries Integer32, 2328 hlMatrixControlAlDroppedFrames Counter32, 2329 hlMatrixControlAlInserts Counter32, 2330 hlMatrixControlAlDeletes Counter32, 2331 hlMatrixControlAlMaxDesiredEntries Integer32, 2332 hlMatrixControlOwner OwnerString, 2333 hlMatrixControlStatus RowStatus 2334 } 2336 hlMatrixControlIndex OBJECT-TYPE 2337 SYNTAX Integer32 (1..65535) 2338 MAX-ACCESS not-accessible 2339 STATUS current 2340 DESCRIPTION 2341 "An index that uniquely identifies an entry in the 2342 hlMatrixControlTable. Each such entry defines 2343 a function that discovers conversations on a particular 2344 interface and places statistics about them in the 2345 nlMatrixSDTable and the nlMatrixDSTable, and optionally the 2346 alMatrixSDTable and alMatrixDSTable, on behalf of this 2347 hlMatrixControlEntry." 2348 ::= { hlMatrixControlEntry 1 } 2350 hlMatrixControlDataSource OBJECT-TYPE 2351 SYNTAX DataSource 2352 MAX-ACCESS read-create 2353 STATUS current 2354 DESCRIPTION 2355 "The source of the data for the associated matrix tables. 2357 The statistics in this group reflect all packets 2358 on the local network segment attached to the 2359 identified interface. 2361 This object may not be modified if the associated 2362 hlMatrixControlStatus object is equal to active(1)." 2364 ::= { hlMatrixControlEntry 2 } 2366 hlMatrixControlNlDroppedFrames OBJECT-TYPE 2367 SYNTAX Counter32 2368 MAX-ACCESS read-only 2369 STATUS current 2370 DESCRIPTION 2371 "The total number of frames which were received by the probe 2372 and therefore not accounted for in the *StatsDropEvents, but 2373 for which the probe chose not to count for this entry for 2374 whatever reason. Most often, this event occurs when the probe 2375 is out of some resources and decides to shed load from this 2376 collection. 2378 This count does not include packets that were not counted 2379 because they had MAC-layer errors. 2381 Note that if the nlMatrixTables are inactive because no 2382 protocols are enabled in the protocol directory, this value 2383 should be 0. 2385 Note that, unlike the dropEvents counter, this number is the 2386 exact number of frames dropped." 2387 ::= { hlMatrixControlEntry 3 } 2389 hlMatrixControlNlInserts OBJECT-TYPE 2390 SYNTAX Counter32 2391 MAX-ACCESS read-only 2392 STATUS current 2393 DESCRIPTION 2394 "The number of times an nlMatrix entry has been 2395 inserted into the nlMatrix tables. If an entry is inserted, 2396 then deleted, and then inserted, this counter will be 2397 incremented by 2. The addition of a conversation into both 2398 the nlMatrixSDTable and nlMatrixDSTable shall be counted as 2399 two insertions (even though every addition into one table must 2400 be accompanied by an insertion into the other). 2402 To allow for efficient implementation strategies, agents may 2403 delay updating this object for short periods of time. For 2404 example, an implementation strategy may allow internal 2405 data structures to differ from those visible via SNMP for 2406 short periods of time. This counter may reflect the internal 2407 data structures for those short periods of time. 2409 Note that the sum of then nlMatrixSDTable and nlMatrixDSTable 2410 sizes can be determined by subtracting 2411 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 2412 ::= { hlMatrixControlEntry 4 } 2414 hlMatrixControlNlDeletes OBJECT-TYPE 2415 SYNTAX Counter32 2416 MAX-ACCESS read-only 2417 STATUS current 2418 DESCRIPTION 2419 "The number of times an nlMatrix entry has been 2420 deleted from the nlMatrix tables (for any reason). If an 2421 entry is deleted, then inserted, and then deleted, this 2422 counter will be incremented by 2. The deletion of a 2423 conversation from both the nlMatrixSDTable and nlMatrixDSTable 2424 shall be counted as two deletions (even though every deletion 2425 from one table must be accompanied by a deletion from the 2426 other). 2428 To allow for efficient implementation strategies, agents may 2429 delay updating this object for short periods of time. For 2430 example, an implementation strategy may allow internal 2431 data structures to differ from those visible via SNMP for 2432 short periods of time. This counter may reflect the internal 2433 data structures for those short periods of time. 2435 Note that the table size can be determined by subtracting 2436 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 2437 ::= { hlMatrixControlEntry 5 } 2439 hlMatrixControlNlMaxDesiredEntries OBJECT-TYPE 2440 SYNTAX Integer32 (-1..2147483647) 2441 MAX-ACCESS read-create 2442 STATUS current 2443 DESCRIPTION 2444 "The maximum number of entries that are desired in the 2445 nlMatrix tables on behalf of this control entry. The probe 2446 will not create more than this number of associated entries in 2447 the table, but may choose to create fewer entries in this 2448 table for any reason including the lack of resources. 2450 If this object is set to a value less than the current number 2451 of entries, enough entries are chosen in an 2452 implementation-dependent manner and deleted so that the number 2453 of entries in the table equals the value of this object. 2455 If this value is set to -1, the probe may create any number 2456 of entries in this table. If the associated 2457 hlMatrixControlStatus object is equal to `active', this 2458 object may not be modified. 2460 This object may be used to control how resources are allocated 2461 on the probe for the various RMON functions." 2462 ::= { hlMatrixControlEntry 6 } 2464 hlMatrixControlAlDroppedFrames OBJECT-TYPE 2465 SYNTAX Counter32 2466 MAX-ACCESS read-only 2467 STATUS current 2468 DESCRIPTION 2469 "The total number of frames which were received by the probe 2470 and therefore not accounted for in the *StatsDropEvents, but 2471 for which the probe chose not to count for this entry for 2472 whatever reason. Most often, this event occurs when the probe 2473 is out of some resources and decides to shed load from this 2474 collection. 2476 This count does not include packets that were not counted 2477 because they had MAC-layer errors. 2479 Note that if the alMatrixTables are not implemented or are 2480 inactive because no protocols are enabled in the protocol 2481 directory, this value should be 0. 2483 Note that, unlike the dropEvents counter, this number is the 2484 exact number of frames dropped." 2485 ::= { hlMatrixControlEntry 7 } 2487 hlMatrixControlAlInserts OBJECT-TYPE 2488 SYNTAX Counter32 2489 MAX-ACCESS read-only 2490 STATUS current 2491 DESCRIPTION 2492 "The number of times an alMatrix entry has been 2493 inserted into the alMatrix tables. If an entry is inserted, 2494 then deleted, and then inserted, this counter will be 2495 incremented by 2. The addition of a conversation into both 2496 the alMatrixSDTable and alMatrixDSTable shall be counted as 2497 two insertions (even though every addition into one table must 2498 be accompanied by an insertion into the other). 2500 To allow for efficient implementation strategies, agents may 2501 delay updating this object for short periods of time. For 2502 example, an implementation strategy may allow internal 2503 data structures to differ from those visible via SNMP for 2504 short periods of time. This counter may reflect the internal 2505 data structures for those short periods of time. 2507 Note that the table size can be determined by subtracting 2508 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 2509 ::= { hlMatrixControlEntry 8 } 2511 hlMatrixControlAlDeletes OBJECT-TYPE 2512 SYNTAX Counter32 2513 MAX-ACCESS read-only 2514 STATUS current 2515 DESCRIPTION 2516 "The number of times an alMatrix entry has been 2517 deleted from the alMatrix tables. If an entry is deleted, 2518 then inserted, and then deleted, this counter will be 2519 incremented by 2. The deletion of a conversation from both 2520 the alMatrixSDTable and alMatrixDSTable shall be counted as 2521 two deletions (even though every deletion from one table must 2522 be accompanied by a deletion from the other). 2524 To allow for efficient implementation strategies, agents may 2525 delay updating this object for short periods of time. For 2526 example, an implementation strategy may allow internal 2527 data structures to differ from those visible via SNMP for 2528 short periods of time. This counter may reflect the internal 2529 data structures for those short periods of time. 2531 Note that the table size can be determined by subtracting 2532 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 2533 ::= { hlMatrixControlEntry 9 } 2535 hlMatrixControlAlMaxDesiredEntries OBJECT-TYPE 2536 SYNTAX Integer32 (-1..2147483647) 2537 MAX-ACCESS read-create 2538 STATUS current 2539 DESCRIPTION 2540 "The maximum number of entries that are desired in the 2541 alMatrix tables on behalf of this control entry. The probe 2542 will not create more than this number of associated entries in 2543 the table, but may choose to create fewer entries in this 2544 table for any reason including the lack of resources. 2546 If this object is set to a value less than the current number 2547 of entries, enough entries are chosen in an 2548 implementation-dependent manner and deleted so that the number 2549 of entries in the table equals the value of this object. 2551 If this value is set to -1, the probe may create any number 2552 of entries in this table. If the associated 2553 hlMatrixControlStatus object is equal to `active', this 2554 object may not be modified. 2556 This object may be used to control how resources are allocated 2557 on the probe for the various RMON functions." 2558 ::= { hlMatrixControlEntry 10 } 2560 hlMatrixControlOwner OBJECT-TYPE 2561 SYNTAX OwnerString 2562 MAX-ACCESS read-create 2563 STATUS current 2564 DESCRIPTION 2565 "The entity that configured this entry and is 2566 therefore using the resources assigned to it." 2567 ::= { hlMatrixControlEntry 11 } 2569 hlMatrixControlStatus OBJECT-TYPE 2570 SYNTAX RowStatus 2571 MAX-ACCESS read-create 2572 STATUS current 2573 DESCRIPTION 2574 "The status of this hlMatrixControlEntry. 2576 An entry may not exist in the active state unless all 2577 objects in the entry have an appropriate value. 2579 If this object is not equal to active(1), all 2580 associated entries in the nlMatrixSDTable, 2581 nlMatrixDSTable, alMatrixSDTable, and the alMatrixDSTable 2582 shall be deleted by the agent." 2583 ::= { hlMatrixControlEntry 12 } 2585 nlMatrixSDTable OBJECT-TYPE 2586 SYNTAX SEQUENCE OF NlMatrixSDEntry 2587 MAX-ACCESS not-accessible 2588 STATUS current 2589 DESCRIPTION 2590 "A list of traffic matrix entries which collect statistics for 2591 conversations between two network-level addresses. This table 2592 is indexed first by the source address and then by the 2593 destination address to make it convenient to collect all 2594 conversations from a particular address. 2596 The probe will populate this table for all network layer 2597 protocols in the protocol directory table whose value of 2598 protocolDirMatrixConfig is equal to supportedOn(3), and 2599 will delete any entries whose protocolDirEntry is deleted or 2600 has a protocolDirMatrixConfig value of supportedOff(2). 2602 The probe will add to this table all pairs of addresses 2603 seen in all packets with no MAC errors, and will increment 2604 octet and packet counts in the table for all packets with no 2605 MAC errors. 2607 Further, this table will only contain entries that have a 2608 corresponding entry in the nlMatrixDSTable with the same 2609 source address and destination address." 2610 ::= { nlMatrix 2 } 2612 nlMatrixSDEntry OBJECT-TYPE 2613 SYNTAX NlMatrixSDEntry 2614 MAX-ACCESS not-accessible 2615 STATUS current 2616 DESCRIPTION 2617 "A conceptual row in the nlMatrixSDTable. 2619 The hlMatrixControlIndex value in the index identifies the 2620 hlMatrixControlEntry on whose behalf this entry was created. 2621 The protocolDirLocalIndex value in the index identifies the 2622 network layer protocol of the nlMatrixSDSourceAddress and 2623 nlMatrixSDDestAddress. 2625 An example of the indexing of this table is 2626 nlMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7. 2628 Note that some combinations of index values may result in an 2629 index that exceeds 128 sub-identifiers in length which exceeds 2630 the maximum for the SNMP protocol. Implementations should take 2631 care to avoid such combinations." 2632 INDEX { hlMatrixControlIndex, nlMatrixSDTimeMark, 2633 protocolDirLocalIndex, 2634 nlMatrixSDSourceAddress, nlMatrixSDDestAddress } 2635 ::= { nlMatrixSDTable 1 } 2637 NlMatrixSDEntry ::= SEQUENCE { 2638 nlMatrixSDTimeMark TimeFilter, 2639 nlMatrixSDSourceAddress OCTET STRING, 2640 nlMatrixSDDestAddress OCTET STRING, 2641 nlMatrixSDPkts ZeroBasedCounter32, 2642 nlMatrixSDOctets ZeroBasedCounter32, 2643 nlMatrixSDCreateTime LastCreateTime 2644 } 2646 nlMatrixSDTimeMark OBJECT-TYPE 2647 SYNTAX TimeFilter 2648 MAX-ACCESS not-accessible 2649 STATUS current 2650 DESCRIPTION 2651 "A TimeFilter for this entry. See the TimeFilter textual 2652 convention to see how this works." 2653 ::= { nlMatrixSDEntry 1 } 2655 nlMatrixSDSourceAddress OBJECT-TYPE 2656 SYNTAX OCTET STRING (SIZE (1..255)) 2657 MAX-ACCESS not-accessible 2658 STATUS current 2659 DESCRIPTION 2660 "The network source address for this nlMatrixSDEntry. 2662 This is represented as an octet string with 2663 specific semantics and length as identified 2664 by the protocolDirLocalIndex component of the index. 2666 For example, if the protocolDirLocalIndex indicates an 2667 encapsulation of ip, this object is encoded as a length 2668 octet of 4, followed by the 4 octets of the ip address, 2669 in network byte order." 2670 ::= { nlMatrixSDEntry 2 } 2672 nlMatrixSDDestAddress OBJECT-TYPE 2673 SYNTAX OCTET STRING (SIZE (1..255)) 2674 MAX-ACCESS not-accessible 2675 STATUS current 2676 DESCRIPTION 2677 "The network destination address for this 2678 nlMatrixSDEntry. 2680 This is represented as an octet string with 2681 specific semantics and length as identified 2682 by the protocolDirLocalIndex component of the index. 2684 For example, if the protocolDirLocalIndex indicates an 2685 encapsulation of ip, this object is encoded as a length 2686 octet of 4, followed by the 4 octets of the ip address, 2687 in network byte order." 2688 ::= { nlMatrixSDEntry 3 } 2690 nlMatrixSDPkts OBJECT-TYPE 2691 SYNTAX ZeroBasedCounter32 2692 MAX-ACCESS read-only 2693 STATUS current 2694 DESCRIPTION 2695 "The number of packets without errors transmitted from the 2696 source address to the destination address since this entry was 2697 added to the nlMatrixSDTable. Note that this is the number of 2698 link-layer packets, so if a single network-layer packet is 2699 fragmented into several link-layer frames, this counter is 2700 incremented several times." 2701 ::= { nlMatrixSDEntry 4 } 2703 nlMatrixSDOctets OBJECT-TYPE 2704 SYNTAX ZeroBasedCounter32 2705 MAX-ACCESS read-only 2706 STATUS current 2707 DESCRIPTION 2708 "The number of octets transmitted from the source address to 2709 the destination address since this entry was added to the 2710 nlMatrixSDTable (excluding framing bits but 2711 including FCS octets), excluding those octets in packets that 2712 contained errors. 2714 Note this doesn't count just those octets in the particular 2715 protocol frames, but includes the entire packet that contained 2716 the protocol." 2718 ::= { nlMatrixSDEntry 5 } 2720 nlMatrixSDCreateTime OBJECT-TYPE 2721 SYNTAX LastCreateTime 2722 MAX-ACCESS read-only 2723 STATUS current 2724 DESCRIPTION 2725 "The value of sysUpTime when this entry was last activated. 2726 This can be used by the management station to ensure that the 2727 entry has not been deleted and recreated between polls." 2728 ::= { nlMatrixSDEntry 6 } 2730 -- Traffic matrix tables from destination to source 2732 nlMatrixDSTable OBJECT-TYPE 2733 SYNTAX SEQUENCE OF NlMatrixDSEntry 2734 MAX-ACCESS not-accessible 2735 STATUS current 2736 DESCRIPTION 2737 "A list of traffic matrix entries which collect statistics for 2738 conversations between two network-level addresses. This table 2739 is indexed first by the destination address and then by the 2740 source address to make it convenient to collect all 2741 conversations to a particular address. 2743 The probe will populate this table for all network layer 2744 protocols in the protocol directory table whose value of 2745 protocolDirMatrixConfig is equal to supportedOn(3), and 2746 will delete any entries whose protocolDirEntry is deleted or 2747 has a protocolDirMatrixConfig value of supportedOff(2). 2749 The probe will add to this table all pairs of addresses 2750 seen in all packets with no MAC errors, and will increment 2751 octet and packet counts in the table for all packets with no 2752 MAC errors. 2754 Further, this table will only contain entries that have a 2755 corresponding entry in the nlMatrixSDTable with the same 2756 source address and destination address." 2757 ::= { nlMatrix 3 } 2759 nlMatrixDSEntry OBJECT-TYPE 2760 SYNTAX NlMatrixDSEntry 2761 MAX-ACCESS not-accessible 2762 STATUS current 2763 DESCRIPTION 2764 "A conceptual row in the nlMatrixDSTable. 2766 The hlMatrixControlIndex value in the index identifies the 2767 hlMatrixControlEntry on whose behalf this entry was created. 2768 The protocolDirLocalIndex value in the index identifies the 2769 network layer protocol of the nlMatrixDSSourceAddress and 2770 nlMatrixDSDestAddress. 2772 An example of the indexing of this table is 2773 nlMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6. 2775 Note that some combinations of index values may result in an 2776 index that exceeds 128 sub-identifiers in length which exceeds 2777 the maximum for the SNMP protocol. Implementations should take 2778 care to avoid such combinations." 2779 INDEX { hlMatrixControlIndex, nlMatrixDSTimeMark, 2780 protocolDirLocalIndex, 2781 nlMatrixDSDestAddress, nlMatrixDSSourceAddress } 2782 ::= { nlMatrixDSTable 1 } 2784 NlMatrixDSEntry ::= SEQUENCE { 2785 nlMatrixDSTimeMark TimeFilter, 2786 nlMatrixDSSourceAddress OCTET STRING, 2787 nlMatrixDSDestAddress OCTET STRING, 2788 nlMatrixDSPkts ZeroBasedCounter32, 2789 nlMatrixDSOctets ZeroBasedCounter32, 2790 nlMatrixDSCreateTime LastCreateTime 2791 } 2793 nlMatrixDSTimeMark OBJECT-TYPE 2794 SYNTAX TimeFilter 2795 MAX-ACCESS not-accessible 2796 STATUS current 2797 DESCRIPTION 2798 "A TimeFilter for this entry. See the TimeFilter textual 2799 convention to see how this works." 2800 ::= { nlMatrixDSEntry 1 } 2802 nlMatrixDSSourceAddress OBJECT-TYPE 2803 SYNTAX OCTET STRING (SIZE (1..255)) 2804 MAX-ACCESS not-accessible 2805 STATUS current 2806 DESCRIPTION 2807 "The network source address for this nlMatrixDSEntry. 2809 This is represented as an octet string with 2810 specific semantics and length as identified 2811 by the protocolDirLocalIndex component of the index. 2813 For example, if the protocolDirLocalIndex indicates an 2814 encapsulation of ip, this object is encoded as a length 2815 octet of 4, followed by the 4 octets of the ip address, 2816 in network byte order." 2817 ::= { nlMatrixDSEntry 2 } 2819 nlMatrixDSDestAddress OBJECT-TYPE 2820 SYNTAX OCTET STRING (SIZE (1..255)) 2821 MAX-ACCESS not-accessible 2822 STATUS current 2823 DESCRIPTION 2824 "The network destination address for this 2825 nlMatrixDSEntry. 2827 This is represented as an octet string with 2828 specific semantics and length as identified 2829 by the protocolDirLocalIndex component of the index. 2831 For example, if the protocolDirLocalIndex indicates an 2832 encapsulation of ip, this object is encoded as a length 2833 octet of 4, followed by the 4 octets of the ip address, 2834 in network byte order." 2835 ::= { nlMatrixDSEntry 3 } 2837 nlMatrixDSPkts OBJECT-TYPE 2838 SYNTAX ZeroBasedCounter32 2839 MAX-ACCESS read-only 2840 STATUS current 2841 DESCRIPTION 2842 "The number of packets without errors transmitted from the 2843 source address to the destination address since this entry was 2844 added to the nlMatrixDSTable. Note that this is the number of 2845 link-layer packets, so if a single network-layer packet is 2846 fragmented into several link-layer frames, this counter is 2847 incremented several times." 2848 ::= { nlMatrixDSEntry 4 } 2850 nlMatrixDSOctets OBJECT-TYPE 2851 SYNTAX ZeroBasedCounter32 2852 MAX-ACCESS read-only 2853 STATUS current 2854 DESCRIPTION 2855 "The number of octets transmitted from the source address 2856 to the destination address since this entry was added to the 2857 nlMatrixDSTable (excluding framing bits but 2858 including FCS octets), excluding those octets in packets that 2859 contained errors. 2861 Note this doesn't count just those octets in the particular 2862 protocol frames, but includes the entire packet that contained 2863 the protocol." 2864 ::= { nlMatrixDSEntry 5 } 2866 nlMatrixDSCreateTime OBJECT-TYPE 2867 SYNTAX LastCreateTime 2868 MAX-ACCESS read-only 2869 STATUS current 2870 DESCRIPTION 2871 "The value of sysUpTime when this entry was last activated. 2872 This can be used by the management station to ensure that the 2873 entry has not been deleted and recreated between polls." 2874 ::= { nlMatrixDSEntry 6 } 2876 nlMatrixTopNControlTable OBJECT-TYPE 2877 SYNTAX SEQUENCE OF NlMatrixTopNControlEntry 2878 MAX-ACCESS not-accessible 2879 STATUS current 2880 DESCRIPTION 2881 "A set of parameters that control the creation of a 2882 report of the top N matrix entries according to 2883 a selected metric." 2884 ::= { nlMatrix 4 } 2886 nlMatrixTopNControlEntry OBJECT-TYPE 2887 SYNTAX NlMatrixTopNControlEntry 2888 MAX-ACCESS not-accessible 2889 STATUS current 2890 DESCRIPTION 2891 "A conceptual row in the nlMatrixTopNControlTable. 2893 An example of the indexing of this table is 2894 nlMatrixTopNControlDuration.3" 2895 INDEX { nlMatrixTopNControlIndex } 2896 ::= { nlMatrixTopNControlTable 1 } 2898 NlMatrixTopNControlEntry ::= SEQUENCE { 2899 nlMatrixTopNControlIndex Integer32, 2900 nlMatrixTopNControlMatrixIndex Integer32, 2901 nlMatrixTopNControlRateBase INTEGER, 2902 nlMatrixTopNControlTimeRemaining Integer32, 2903 nlMatrixTopNControlGeneratedReports Counter32, 2904 nlMatrixTopNControlDuration Integer32, 2905 nlMatrixTopNControlRequestedSize Integer32, 2906 nlMatrixTopNControlGrantedSize Integer32, 2907 nlMatrixTopNControlStartTime TimeStamp, 2908 nlMatrixTopNControlOwner OwnerString, 2909 nlMatrixTopNControlStatus RowStatus 2910 } 2912 nlMatrixTopNControlIndex OBJECT-TYPE 2913 SYNTAX Integer32 (1..65535) 2914 MAX-ACCESS not-accessible 2915 STATUS current 2916 DESCRIPTION 2917 "An index that uniquely identifies an entry 2918 in the nlMatrixTopNControlTable. Each such 2919 entry defines one top N report prepared for 2920 one interface." 2921 ::= { nlMatrixTopNControlEntry 1 } 2923 nlMatrixTopNControlMatrixIndex OBJECT-TYPE 2924 SYNTAX Integer32 (1..65535) 2925 MAX-ACCESS read-create 2926 STATUS current 2927 DESCRIPTION 2928 "The nlMatrix[SD/DS] table for which a top N report will be 2929 prepared on behalf of this entry. The nlMatrix[SD/DS] table 2930 is identified by the value of the hlMatrixControlIndex 2931 for that table - that value is used here to identify the 2932 particular table. 2934 This object may not be modified if the associated 2935 nlMatrixTopNControlStatus object is equal to active(1)." 2936 ::= { nlMatrixTopNControlEntry 2 } 2938 nlMatrixTopNControlRateBase OBJECT-TYPE 2939 SYNTAX INTEGER { 2940 nlMatrixTopNPkts(1), 2941 nlMatrixTopNOctets(2), 2942 nlMatrixTopNHighCapacityPkts(3), 2943 nlMatrixTopNHighCapacityOctets(4) 2944 } 2945 MAX-ACCESS read-create 2946 STATUS current 2947 DESCRIPTION 2948 "The variable for each nlMatrix[SD/DS] entry that the 2949 nlMatrixTopNEntries are sorted by, as well as a control 2950 for the table that the results will be reported in. 2952 This object may not be modified if the associated 2953 nlMatrixTopNControlStatus object is equal to active(1). 2955 If this value is less than or equal to 2, when the report 2956 is prepared, entries are created in the nlMatrixTopNTable 2957 associated with this object. 2958 If this value is greater than or equal to 3, when the report 2959 is prepared, entries are created in the 2960 nlMatrixTopNHighCapacityTable associated with this object." 2961 ::= { nlMatrixTopNControlEntry 3 } 2963 nlMatrixTopNControlTimeRemaining OBJECT-TYPE 2964 SYNTAX Integer32 (0..2147483647) 2965 MAX-ACCESS read-create 2966 STATUS current 2967 DESCRIPTION 2968 "The number of seconds left in the report currently 2969 being collected. When this object is modified by 2970 the management station, a new collection is started, 2971 possibly aborting a currently running report. The 2972 new value is used as the requested duration of this 2973 report, and is immediately loaded into the associated 2974 nlMatrixTopNControlDuration object. 2975 When the report finishes, the probe will automatically 2976 start another collection with the same initial value 2977 of nlMatrixTopNControlTimeRemaining. Thus the management 2978 station may simply read the resulting reports repeatedly, 2979 checking the startTime and duration each time to ensure that a 2980 report was not missed or that the report parameters were not 2981 changed. 2983 While the value of this object is non-zero, it decrements 2984 by one per second until it reaches zero. At the time 2985 that this object decrements to zero, the report is made 2986 accessible in the nlMatrixTopNTable, overwriting any report 2987 that may be there. 2989 When this object is modified by the management station, any 2990 associated entries in the nlMatrixTopNTable shall be deleted. 2992 (Note that this is a different algorithm than the one used in 2993 the hostTopNTable)." 2994 DEFVAL { 1800 } 2995 ::= { nlMatrixTopNControlEntry 4 } 2997 nlMatrixTopNControlGeneratedReports OBJECT-TYPE 2998 SYNTAX Counter32 2999 MAX-ACCESS read-only 3000 STATUS current 3001 DESCRIPTION 3002 "The number of reports that have been generated by this entry." 3003 ::= { nlMatrixTopNControlEntry 5 } 3005 nlMatrixTopNControlDuration OBJECT-TYPE 3006 SYNTAX Integer32 3007 MAX-ACCESS read-only 3008 STATUS current 3009 DESCRIPTION 3010 "The number of seconds that this report has collected 3011 during the last sampling interval. 3013 When the associated nlMatrixTopNControlTimeRemaining object is 3014 set, this object shall be set by the probe to the 3015 same value and shall not be modified until the next 3016 time the nlMatrixTopNControlTimeRemaining is set. 3018 This value shall be zero if no reports have been 3019 requested for this nlMatrixTopNControlEntry." 3020 ::= { nlMatrixTopNControlEntry 6 } 3022 nlMatrixTopNControlRequestedSize OBJECT-TYPE 3023 SYNTAX Integer32 (0..2147483647) 3024 MAX-ACCESS read-create 3025 STATUS current 3026 DESCRIPTION 3027 "The maximum number of matrix entries requested for this report. 3029 When this object is created or modified, the probe 3030 should set nlMatrixTopNControlGrantedSize as closely to this 3031 object as is possible for the particular probe 3032 implementation and available resources." 3033 DEFVAL { 150 } 3034 ::= { nlMatrixTopNControlEntry 7 } 3036 nlMatrixTopNControlGrantedSize OBJECT-TYPE 3037 SYNTAX Integer32 (0..2147483647) 3038 MAX-ACCESS read-only 3039 STATUS current 3040 DESCRIPTION 3041 "The maximum number of matrix entries in this report. 3043 When the associated nlMatrixTopNControlRequestedSize object is 3044 created or modified, the probe should set this 3045 object as closely to the requested value as is 3046 possible for the particular implementation and 3047 available resources. The probe must not lower this 3048 value except as a result of a set to the associated 3049 nlMatrixTopNControlRequestedSize object. 3051 If the value of nlMatrixTopNControlRateBase is equal to 3052 nlMatrixTopNPkts, when the next topN report is generated, 3053 matrix entries with the highest value of nlMatrixTopNPktRate 3054 shall be placed in this table in decreasing order of this rate 3055 until there is no more room or until there are no more 3056 matrix entries. 3058 If the value of nlMatrixTopNControlRateBase is equal to 3059 nlMatrixTopNOctets, when the next topN report is generated, 3060 matrix entries with the highest value of nlMatrixTopNOctetRate 3061 shall be placed in this table in decreasing order of this rate 3062 until there is no more room or until there are no more 3063 matrix entries. 3065 It is an implementation-specific matter how entries with the 3066 same value of nlMatrixTopNPktRate or nlMatrixTopNOctetRate are 3067 sorted. It is also an implementation-specific matter as to 3068 whether or not zero-valued entries are available." 3069 ::= { nlMatrixTopNControlEntry 8 } 3071 nlMatrixTopNControlStartTime OBJECT-TYPE 3072 SYNTAX TimeStamp 3073 MAX-ACCESS read-only 3074 STATUS current 3075 DESCRIPTION 3076 "The value of sysUpTime when this top N report was 3077 last started. In other words, this is the time that 3078 the associated nlMatrixTopNControlTimeRemaining object was 3079 modified to start the requested report or the time 3080 the report was last automatically (re)started. 3082 This object may be used by the management station to 3083 determine if a report was missed or not." 3084 ::= { nlMatrixTopNControlEntry 9 } 3086 nlMatrixTopNControlOwner OBJECT-TYPE 3087 SYNTAX OwnerString 3088 MAX-ACCESS read-create 3089 STATUS current 3090 DESCRIPTION 3091 "The entity that configured this entry and is 3092 therefore using the resources assigned to it." 3093 ::= { nlMatrixTopNControlEntry 10 } 3095 nlMatrixTopNControlStatus OBJECT-TYPE 3096 SYNTAX RowStatus 3097 MAX-ACCESS read-create 3098 STATUS current 3099 DESCRIPTION 3100 "The status of this nlMatrixTopNControlEntry. 3102 An entry may not exist in the active state unless all 3103 objects in the entry have an appropriate value. 3105 If this object is not equal to active(1), all 3106 associated entries in the nlMatrixTopNTable shall be deleted 3107 by the agent." 3108 ::= { nlMatrixTopNControlEntry 11 } 3110 nlMatrixTopNTable OBJECT-TYPE 3111 SYNTAX SEQUENCE OF NlMatrixTopNEntry 3112 MAX-ACCESS not-accessible 3113 STATUS current 3114 DESCRIPTION 3115 "A set of statistics for those network layer matrix entries 3116 that have counted the highest number of octets or packets." 3117 ::= { nlMatrix 5 } 3119 nlMatrixTopNEntry OBJECT-TYPE 3120 SYNTAX NlMatrixTopNEntry 3121 MAX-ACCESS not-accessible 3122 STATUS current 3123 DESCRIPTION 3124 "A conceptual row in the nlMatrixTopNTable. 3126 The nlMatrixTopNControlIndex value in the index identifies the 3127 nlMatrixTopNControlEntry on whose behalf this entry was 3128 created. 3130 An example of the indexing of this table is 3131 nlMatrixTopNPktRate.3.10" 3132 INDEX { nlMatrixTopNControlIndex, nlMatrixTopNIndex } 3133 ::= { nlMatrixTopNTable 1 } 3135 NlMatrixTopNEntry ::= SEQUENCE { 3136 nlMatrixTopNIndex Integer32, 3137 nlMatrixTopNProtocolDirLocalIndex Integer32, 3138 nlMatrixTopNSourceAddress OCTET STRING, 3139 nlMatrixTopNDestAddress OCTET STRING, 3140 nlMatrixTopNPktRate Gauge32, 3141 nlMatrixTopNReversePktRate Gauge32, 3142 nlMatrixTopNOctetRate Gauge32, 3143 nlMatrixTopNReverseOctetRate Gauge32 3144 } 3146 nlMatrixTopNIndex OBJECT-TYPE 3147 SYNTAX Integer32 (1..65535) 3148 MAX-ACCESS not-accessible 3149 STATUS current 3150 DESCRIPTION 3151 "An index that uniquely identifies an entry in 3152 the nlMatrixTopNTable among those in the same report. 3153 This index is between 1 and N, where N is the 3154 number of entries in this report. 3156 If the value of nlMatrixTopNControlRateBase is equal to 3157 nlMatrixTopNPkts, increasing values of nlMatrixTopNIndex shall 3158 be assigned to entries with decreasing values of 3159 nlMatrixTopNPktRate until index N is assigned or there are no 3160 more nlMatrixTopNEntries. 3162 If the value of nlMatrixTopNControlRateBase is equal to 3163 nlMatrixTopNOctets, increasing values of nlMatrixTopNIndex 3164 shall be assigned to entries with decreasing values of 3165 nlMatrixTopNOctetRate until index N is assigned or there are 3166 no more nlMatrixTopNEntries." 3167 ::= { nlMatrixTopNEntry 1 } 3169 nlMatrixTopNProtocolDirLocalIndex OBJECT-TYPE 3170 SYNTAX Integer32 (1..2147483647) 3171 MAX-ACCESS read-only 3172 STATUS current 3173 DESCRIPTION 3174 "The protocolDirLocalIndex of the network layer protocol of 3175 this entry's network address." 3176 ::= { nlMatrixTopNEntry 2 } 3178 nlMatrixTopNSourceAddress OBJECT-TYPE 3179 SYNTAX OCTET STRING (SIZE (1..255)) 3180 MAX-ACCESS read-only 3181 STATUS current 3182 DESCRIPTION 3183 "The network layer address of the source host in this 3184 conversation. 3186 This is represented as an octet string with 3187 specific semantics and length as identified 3188 by the associated nlMatrixTopNProtocolDirLocalIndex. 3190 For example, if the protocolDirLocalIndex indicates an 3191 encapsulation of ip, this object is encoded as a length 3192 octet of 4, followed by the 4 octets of the ip address, 3193 in network byte order." 3194 ::= { nlMatrixTopNEntry 3 } 3196 nlMatrixTopNDestAddress OBJECT-TYPE 3197 SYNTAX OCTET STRING (SIZE (1..255)) 3198 MAX-ACCESS read-only 3199 STATUS current 3200 DESCRIPTION 3201 "The network layer address of the destination host in this 3202 conversation. 3204 This is represented as an octet string with 3205 specific semantics and length as identified 3206 by the associated nlMatrixTopNProtocolDirLocalIndex. 3208 For example, if the nlMatrixTopNProtocolDirLocalIndex 3209 indicates an encapsulation of ip, this object is encoded as a 3210 length octet of 4, followed by the 4 octets of the ip address, 3211 in network byte order." 3212 ::= { nlMatrixTopNEntry 4 } 3214 nlMatrixTopNPktRate OBJECT-TYPE 3215 SYNTAX Gauge32 3216 MAX-ACCESS read-only 3217 STATUS current 3218 DESCRIPTION 3219 "The number of packets seen from the source host 3220 to the destination host during this sampling interval, counted 3221 using the rules for counting the nlMatrixSDPkts object. 3222 If the value of nlMatrixTopNControlRateBase is 3223 nlMatrixTopNPkts, this variable will be used to sort this 3224 report." 3225 ::= { nlMatrixTopNEntry 5 } 3227 nlMatrixTopNReversePktRate OBJECT-TYPE 3228 SYNTAX Gauge32 3229 MAX-ACCESS read-only 3230 STATUS current 3231 DESCRIPTION 3232 "The number of packets seen from the destination host to the 3233 source host during this sampling interval, counted 3234 using the rules for counting the nlMatrixSDPkts object (note 3235 that the corresponding nlMatrixSDPkts object selected is the 3236 one whose source address is equal to nlMatrixTopNDestAddress 3237 and whose destination address is equal to 3238 nlMatrixTopNSourceAddress.) 3240 Note that if the value of nlMatrixTopNControlRateBase is equal 3241 to nlMatrixTopNPkts, the sort of topN entries is based 3242 entirely on nlMatrixTopNPktRate, and not on the value of this 3243 object." 3244 ::= { nlMatrixTopNEntry 6 } 3246 nlMatrixTopNOctetRate OBJECT-TYPE 3247 SYNTAX Gauge32 3248 MAX-ACCESS read-only 3249 STATUS current 3250 DESCRIPTION 3251 "The number of octets seen from the source host 3252 to the destination host during this sampling interval, counted 3253 using the rules for counting the nlMatrixSDOctets object. If 3254 the value of nlMatrixTopNControlRateBase is 3255 nlMatrixTopNOctets, this variable will be used to sort this 3256 report." 3257 ::= { nlMatrixTopNEntry 7 } 3259 nlMatrixTopNReverseOctetRate OBJECT-TYPE 3260 SYNTAX Gauge32 3261 MAX-ACCESS read-only 3262 STATUS current 3263 DESCRIPTION 3264 "The number of octets seen from the destination host to the 3265 source host during this sampling interval, counted 3266 using the rules for counting the nlMatrixDSOctets object (note 3267 that the corresponding nlMatrixSDOctets object selected is the 3268 one whose source address is equal to nlMatrixTopNDestAddress 3269 and whose destination address is equal to 3270 nlMatrixTopNSourceAddress.) 3272 Note that if the value of nlMatrixTopNControlRateBase is equal 3273 to nlMatrixTopNOctets, the sort of topN entries is based 3274 entirely on nlMatrixTopNOctetRate, and not on the value of 3275 this object." 3276 ::= { nlMatrixTopNEntry 8 } 3278 -- Application Layer Functions 3279 -- 3280 -- The application layer host, matrix, and matrixTopN functions report 3281 -- on protocol usage at the network layer or higher. Note that the 3282 -- use of the term application layer does not imply that only 3283 -- application-layer protocols are counted, rather it means that 3284 -- protocols up to and including the application layer are supported. 3286 -- 3287 -- Application Layer Host Group 3288 -- 3289 -- Counts the amount of traffic, by protocol, sent from and to each 3290 -- network address discovered by the probe. 3291 -- Implementation of this group requires implementation of the Network 3292 -- Layer Host Group. 3294 alHostTable OBJECT-TYPE 3295 SYNTAX SEQUENCE OF AlHostEntry 3296 MAX-ACCESS not-accessible 3297 STATUS current 3298 DESCRIPTION 3299 "A collection of statistics for a particular protocol from a 3300 particular network address that has been discovered on an 3301 interface of this device. 3303 The probe will populate this table for all protocols in the 3304 protocol directory table whose value of 3305 protocolDirHostConfig is equal to supportedOn(3), and 3306 will delete any entries whose protocolDirEntry is deleted or 3307 has a protocolDirHostConfig value of supportedOff(2). 3309 The probe will add to this table all addresses 3310 seen as the source or destination address in all packets with 3311 no MAC errors, and will increment octet and packet counts in 3312 the table for all packets with no MAC errors. Further, 3313 entries will only be added to this table if their address 3314 exists in the nlHostTable and will be deleted from this table 3315 if their address is deleted from the nlHostTable." 3316 ::= { alHost 1 } 3318 alHostEntry OBJECT-TYPE 3319 SYNTAX AlHostEntry 3320 MAX-ACCESS not-accessible 3321 STATUS current 3322 DESCRIPTION 3323 "A conceptual row in the alHostTable. 3325 The hlHostControlIndex value in the index identifies the 3326 hlHostControlEntry on whose behalf this entry was created. 3327 The first protocolDirLocalIndex value in the index identifies 3328 the network layer protocol of the address. 3329 The nlHostAddress value in the index identifies the network 3330 layer address of this entry. 3331 The second protocolDirLocalIndex value in the index identifies 3332 the protocol that is counted by this entry. 3334 An example of the indexing in this entry is 3335 alHostOutPkts.1.783495.18.4.128.2.6.6.34. 3337 Note that some combinations of index values may result in an 3338 index that exceeds 128 sub-identifiers in length which exceeds 3339 the maximum for the SNMP protocol. Implementations should take 3340 care to avoid such combinations." 3341 INDEX { hlHostControlIndex, alHostTimeMark, 3342 protocolDirLocalIndex, nlHostAddress, 3343 protocolDirLocalIndex } 3344 ::= { alHostTable 1 } 3346 AlHostEntry ::= SEQUENCE { 3347 alHostTimeMark TimeFilter, 3348 alHostInPkts ZeroBasedCounter32, 3349 alHostOutPkts ZeroBasedCounter32, 3350 alHostInOctets ZeroBasedCounter32, 3351 alHostOutOctets ZeroBasedCounter32, 3352 alHostCreateTime LastCreateTime 3353 } 3355 alHostTimeMark OBJECT-TYPE 3356 SYNTAX TimeFilter 3357 MAX-ACCESS not-accessible 3358 STATUS current 3359 DESCRIPTION 3360 "A TimeFilter for this entry. See the TimeFilter textual 3361 convention to see how this works." 3362 ::= { alHostEntry 1 } 3364 alHostInPkts OBJECT-TYPE 3365 SYNTAX ZeroBasedCounter32 3366 MAX-ACCESS read-only 3367 STATUS current 3368 DESCRIPTION 3369 "The number of packets of this protocol type without errors 3370 transmitted to this address since it was added to the 3371 alHostTable. Note that this is the number of link-layer 3372 packets, so if a single network-layer packet is fragmented 3373 into several link-layer frames, this counter is incremented 3374 several times." 3375 ::= { alHostEntry 2 } 3377 alHostOutPkts OBJECT-TYPE 3378 SYNTAX ZeroBasedCounter32 3379 MAX-ACCESS read-only 3380 STATUS current 3381 DESCRIPTION 3382 "The number of packets of this protocol type without errors 3383 transmitted by this address since it was added to the 3384 alHostTable. Note that this is the number of link-layer 3385 packets, so if a single network-layer packet is fragmented 3386 into several link-layer frames, this counter is incremented 3387 several times." 3388 ::= { alHostEntry 3 } 3390 alHostInOctets OBJECT-TYPE 3391 SYNTAX ZeroBasedCounter32 3392 MAX-ACCESS read-only 3393 STATUS current 3394 DESCRIPTION 3395 "The number of octets transmitted to this address 3396 of this protocol type since it was added to the 3397 alHostTable (excluding framing bits but including 3398 FCS octets), excluding those octets in packets that 3399 contained errors. 3401 Note this doesn't count just those octets in the particular 3402 protocol frames, but includes the entire packet that contained 3403 the protocol." 3404 ::= { alHostEntry 4 } 3406 alHostOutOctets OBJECT-TYPE 3407 SYNTAX ZeroBasedCounter32 3408 MAX-ACCESS read-only 3409 STATUS current 3410 DESCRIPTION 3411 "The number of octets transmitted by this address 3412 of this protocol type since it was added to the 3413 alHostTable (excluding framing bits but including 3414 FCS octets), excluding those octets in packets that 3415 contained errors. 3417 Note this doesn't count just those octets in the particular 3418 protocol frames, but includes the entire packet that contained 3419 the protocol." 3420 ::= { alHostEntry 5 } 3422 alHostCreateTime OBJECT-TYPE 3423 SYNTAX LastCreateTime 3424 MAX-ACCESS read-only 3425 STATUS current 3426 DESCRIPTION 3427 "The value of sysUpTime when this entry was last activated. 3428 This can be used by the management station to ensure that the 3429 entry has not been deleted and recreated between polls." 3430 ::= { alHostEntry 6 } 3432 -- 3433 -- Application Layer Matrix Group 3434 -- 3435 -- Counts the amount of traffic, by protocol, sent between each pair 3436 -- of network addresses discovered by the probe. 3437 -- Implementation of this group requires implementation of the Network 3438 -- Layer Matrix Group. 3440 alMatrixSDTable OBJECT-TYPE 3441 SYNTAX SEQUENCE OF AlMatrixSDEntry 3442 MAX-ACCESS not-accessible 3443 STATUS current 3444 DESCRIPTION 3445 "A list of application traffic matrix entries which collect 3446 statistics for conversations of a particular protocol between 3447 two network-level addresses. This table is indexed first by 3448 the source address and then by the destination address to make 3449 it convenient to collect all statistics from a particular 3450 address. 3452 The probe will populate this table for all protocols in the 3453 protocol directory table whose value of 3454 protocolDirMatrixConfig is equal to supportedOn(3), and 3455 will delete any entries whose protocolDirEntry is deleted or 3456 has a protocolDirMatrixConfig value of supportedOff(2). 3458 The probe will add to this table all pairs of addresses for 3459 all protocols seen in all packets with no MAC errors, and will 3460 increment octet and packet counts in the table for all packets 3461 with no MAC errors. Further, entries will only be added to 3462 this table if their address pair exists in the nlMatrixSDTable 3463 and will be deleted from this table if the address pair is 3464 deleted from the nlMatrixSDTable." 3465 ::= { alMatrix 1 } 3467 alMatrixSDEntry OBJECT-TYPE 3468 SYNTAX AlMatrixSDEntry 3469 MAX-ACCESS not-accessible 3470 STATUS current 3471 DESCRIPTION 3472 "A conceptual row in the alMatrixSDTable. 3474 The hlMatrixControlIndex value in the index identifies the 3475 hlMatrixControlEntry on whose behalf this entry was created. 3477 The first protocolDirLocalIndex value in the index identifies 3478 the network layer protocol of the nlMatrixSDSourceAddress and 3479 nlMatrixSDDestAddress. 3480 The nlMatrixSDSourceAddress value in the index identifies the 3481 network layer address of the source host in this conversation. 3482 The nlMatrixSDDestAddress value in the index identifies the 3483 network layer address of the destination host in this 3484 conversation. 3485 The second protocolDirLocalIndex value in the index identifies 3486 the protocol that is counted by this entry. 3488 An example of the indexing of this entry is 3489 alMatrixSDPkts.1.783495.18.4.128.2.6.6.4.128.2.6.7.34. 3491 Note that some combinations of index values may result in an 3492 index that exceeds 128 sub-identifiers in length which exceeds 3493 the maximum for the SNMP protocol. Implementations should take 3494 care to avoid such combinations." 3495 INDEX { hlMatrixControlIndex, alMatrixSDTimeMark, 3496 protocolDirLocalIndex, 3497 nlMatrixSDSourceAddress, nlMatrixSDDestAddress, 3498 protocolDirLocalIndex } 3499 ::= { alMatrixSDTable 1 } 3501 AlMatrixSDEntry ::= SEQUENCE { 3502 alMatrixSDTimeMark TimeFilter, 3503 alMatrixSDPkts ZeroBasedCounter32, 3504 alMatrixSDOctets ZeroBasedCounter32, 3505 alMatrixSDCreateTime LastCreateTime 3506 } 3508 alMatrixSDTimeMark OBJECT-TYPE 3509 SYNTAX TimeFilter 3510 MAX-ACCESS not-accessible 3511 STATUS current 3512 DESCRIPTION 3513 "A TimeFilter for this entry. See the TimeFilter textual 3514 convention to see how this works." 3515 ::= { alMatrixSDEntry 1 } 3517 alMatrixSDPkts OBJECT-TYPE 3518 SYNTAX ZeroBasedCounter32 3519 MAX-ACCESS read-only 3520 STATUS current 3521 DESCRIPTION 3522 "The number of packets of this protocol type without errors 3523 transmitted from the source address to the destination address 3524 since this entry was added to the alMatrixSDTable. Note that 3525 this is the number of link-layer packets, so if a single 3526 network-layer packet is fragmented into several link-layer 3527 frames, this counter is incremented several times." 3528 ::= { alMatrixSDEntry 2 } 3530 alMatrixSDOctets OBJECT-TYPE 3531 SYNTAX ZeroBasedCounter32 3532 MAX-ACCESS read-only 3533 STATUS current 3534 DESCRIPTION 3535 "The number of octets in packets of this protocol type 3536 transmitted from the source address to the destination address 3537 since this entry was added to the alMatrixSDTable (excluding 3538 framing bits but including FCS octets), excluding those octets 3539 in packets that contained errors. 3541 Note this doesn't count just those octets in the particular 3542 protocol frames, but includes the entire packet that contained 3543 the protocol." 3544 ::= { alMatrixSDEntry 3 } 3546 alMatrixSDCreateTime OBJECT-TYPE 3547 SYNTAX LastCreateTime 3548 MAX-ACCESS read-only 3549 STATUS current 3550 DESCRIPTION 3551 "The value of sysUpTime when this entry was last activated. 3552 This can be used by the management station to ensure that the 3553 entry has not been deleted and recreated between polls." 3554 ::= { alMatrixSDEntry 4 } 3556 -- Traffic matrix tables from destination to source 3558 alMatrixDSTable OBJECT-TYPE 3559 SYNTAX SEQUENCE OF AlMatrixDSEntry 3560 MAX-ACCESS not-accessible 3561 STATUS current 3562 DESCRIPTION 3563 "A list of application traffic matrix entries which collect 3564 statistics for conversations of a particular protocol between 3565 two network-level addresses. This table is indexed first by 3566 the destination address and then by the source address to make 3567 it convenient to collect all statistics to a particular 3568 address. 3570 The probe will populate this table for all protocols in the 3571 protocol directory table whose value of 3572 protocolDirMatrixConfig is equal to supportedOn(3), and 3573 will delete any entries whose protocolDirEntry is deleted or 3574 has a protocolDirMatrixConfig value of supportedOff(2). 3576 The probe will add to this table all pairs of addresses for 3577 all protocols seen in all packets with no MAC errors, and will 3578 increment octet and packet counts in the table for all packets 3579 with no MAC errors. Further, entries will only be added to 3580 this table if their address pair exists in the nlMatrixDSTable 3581 and will be deleted from this table if the address pair is 3582 deleted from the nlMatrixDSTable." 3583 ::= { alMatrix 2 } 3585 alMatrixDSEntry OBJECT-TYPE 3586 SYNTAX AlMatrixDSEntry 3587 MAX-ACCESS not-accessible 3588 STATUS current 3589 DESCRIPTION 3590 "A conceptual row in the alMatrixDSTable. 3592 The hlMatrixControlIndex value in the index identifies the 3593 hlMatrixControlEntry on whose behalf this entry was created. 3594 The first protocolDirLocalIndex value in the index identifies 3595 the network layer protocol of the alMatrixDSSourceAddress and 3596 alMatrixDSDestAddress. 3597 The nlMatrixDSDestAddress value in the index identifies the 3598 network layer address of the destination host in this 3599 conversation. 3600 The nlMatrixDSSourceAddress value in the index identifies the 3601 network layer address of the source host in this conversation. 3602 The second protocolDirLocalIndex value in the index identifies 3603 the protocol that is counted by this entry. 3605 An example of the indexing of this entry is 3606 alMatrixDSPkts.1.783495.18.4.128.2.6.7.4.128.2.6.6.34. 3608 Note that some combinations of index values may result in an 3609 index that exceeds 128 sub-identifiers in length which exceeds 3610 the maximum for the SNMP protocol. Implementations should take 3611 care to avoid such combinations." 3612 INDEX { hlMatrixControlIndex, alMatrixDSTimeMark, 3613 protocolDirLocalIndex, 3614 nlMatrixDSDestAddress, nlMatrixDSSourceAddress, 3615 protocolDirLocalIndex } 3616 ::= { alMatrixDSTable 1 } 3618 AlMatrixDSEntry ::= SEQUENCE { 3619 alMatrixDSTimeMark TimeFilter, 3620 alMatrixDSPkts ZeroBasedCounter32, 3621 alMatrixDSOctets ZeroBasedCounter32, 3622 alMatrixDSCreateTime LastCreateTime 3623 } 3625 alMatrixDSTimeMark OBJECT-TYPE 3626 SYNTAX TimeFilter 3627 MAX-ACCESS not-accessible 3628 STATUS current 3629 DESCRIPTION 3630 "A TimeFilter for this entry. See the TimeFilter textual 3631 convention to see how this works." 3632 ::= { alMatrixDSEntry 1 } 3634 alMatrixDSPkts OBJECT-TYPE 3635 SYNTAX ZeroBasedCounter32 3636 MAX-ACCESS read-only 3637 STATUS current 3638 DESCRIPTION 3639 "The number of packets of this protocol type without errors 3640 transmitted from the source address to the destination address 3641 since this entry was added to the alMatrixDSTable. Note that 3642 this is the number of link-layer packets, so if a single 3643 network-layer packet is fragmented into several link-layer 3644 frames, this counter is incremented several times." 3645 ::= { alMatrixDSEntry 2 } 3647 alMatrixDSOctets OBJECT-TYPE 3648 SYNTAX ZeroBasedCounter32 3649 MAX-ACCESS read-only 3650 STATUS current 3651 DESCRIPTION 3652 "The number of octets in packets of this protocol type 3653 transmitted from the source address to the destination address 3654 since this entry was added to the alMatrixDSTable (excluding 3655 framing bits but including FCS octets), excluding those octets 3656 in packets that contained errors. 3658 Note this doesn't count just those octets in the particular 3659 protocol frames, but includes the entire packet that contained 3660 the protocol." 3661 ::= { alMatrixDSEntry 3 } 3663 alMatrixDSCreateTime OBJECT-TYPE 3664 SYNTAX LastCreateTime 3665 MAX-ACCESS read-only 3666 STATUS current 3667 DESCRIPTION 3668 "The value of sysUpTime when this entry was last activated. 3669 This can be used by the management station to ensure that the 3670 entry has not been deleted and recreated between polls." 3671 ::= { alMatrixDSEntry 4 } 3673 alMatrixTopNControlTable OBJECT-TYPE 3674 SYNTAX SEQUENCE OF AlMatrixTopNControlEntry 3675 MAX-ACCESS not-accessible 3676 STATUS current 3677 DESCRIPTION 3678 "A set of parameters that control the creation of a 3679 report of the top N matrix entries according to 3680 a selected metric." 3681 ::= { alMatrix 3 } 3683 alMatrixTopNControlEntry OBJECT-TYPE 3684 SYNTAX AlMatrixTopNControlEntry 3685 MAX-ACCESS not-accessible 3686 STATUS current 3687 DESCRIPTION 3688 "A conceptual row in the alMatrixTopNControlTable. 3690 An example of the indexing of this table is 3691 alMatrixTopNControlDuration.3" 3692 INDEX { alMatrixTopNControlIndex } 3693 ::= { alMatrixTopNControlTable 1 } 3695 AlMatrixTopNControlEntry ::= SEQUENCE { 3696 alMatrixTopNControlIndex Integer32, 3697 alMatrixTopNControlMatrixIndex Integer32, 3698 alMatrixTopNControlRateBase INTEGER, 3699 alMatrixTopNControlTimeRemaining Integer32, 3700 alMatrixTopNControlGeneratedReports Counter32, 3701 alMatrixTopNControlDuration Integer32, 3702 alMatrixTopNControlRequestedSize Integer32, 3703 alMatrixTopNControlGrantedSize Integer32, 3704 alMatrixTopNControlStartTime TimeStamp, 3705 alMatrixTopNControlOwner OwnerString, 3706 alMatrixTopNControlStatus RowStatus 3707 } 3709 alMatrixTopNControlIndex OBJECT-TYPE 3710 SYNTAX Integer32 (1..65535) 3711 MAX-ACCESS not-accessible 3712 STATUS current 3713 DESCRIPTION 3714 "An index that uniquely identifies an entry 3715 in the alMatrixTopNControlTable. Each such 3716 entry defines one top N report prepared for 3717 one interface." 3718 ::= { alMatrixTopNControlEntry 1 } 3720 alMatrixTopNControlMatrixIndex OBJECT-TYPE 3721 SYNTAX Integer32 (1..65535) 3722 MAX-ACCESS read-create 3723 STATUS current 3724 DESCRIPTION 3725 "The alMatrix[SD/DS] table for which a top N report will be 3726 prepared on behalf of this entry. The alMatrix[SD/DS] table 3727 is identified by the value of the hlMatrixControlIndex 3728 for that table - that value is used here to identify the 3729 particular table. 3731 This object may not be modified if the associated 3732 alMatrixTopNControlStatus object is equal to active(1)." 3733 ::= { alMatrixTopNControlEntry 2 } 3735 alMatrixTopNControlRateBase OBJECT-TYPE 3736 SYNTAX INTEGER { 3737 alMatrixTopNTerminalsPkts(1), 3738 alMatrixTopNTerminalsOctets(2), 3739 alMatrixTopNAllPkts(3), 3740 alMatrixTopNAllOctets(4), 3741 alMatrixTopNTerminalsHighCapacityPkts(5), 3742 alMatrixTopNTerminalsHighCapacityOctets(6), 3743 alMatrixTopNAllHighCapacityPkts(7), 3744 alMatrixTopNAllHighCapacityOctets(8) 3745 } 3746 MAX-ACCESS read-create 3747 STATUS current 3748 DESCRIPTION 3749 "The variable for each alMatrix[SD/DS] entry that the 3750 alMatrixTopNEntries are sorted by, as well as the 3751 selector of the view of the matrix table that will be 3752 used, as well as a control for the table that the results 3753 will be reported in. 3755 The values alMatrixTopNTerminalsPkts, 3756 alMatrixTopNTerminalsOctets, 3757 alMatrixTopNTerminalsHighCapacityPkts, and 3758 alMatrixTopNTerminalsHighCapacityOctets cause collection 3759 only from protocols that have no child protocols that are 3760 counted. The values alMatrixTopNAllPkts, 3761 alMatrixTopNAllOctets, alMatrixTopNAllHighCapacityPkts, and 3762 alMatrixTopNAllHighCapacityOctets cause collection from all 3763 alMatrix entries. 3765 This object may not be modified if the associated 3766 alMatrixTopNControlStatus object is equal to active(1)." 3767 ::= { alMatrixTopNControlEntry 3 } 3769 alMatrixTopNControlTimeRemaining OBJECT-TYPE 3770 SYNTAX Integer32 (0..2147483647) 3771 MAX-ACCESS read-create 3772 STATUS current 3773 DESCRIPTION 3774 "The number of seconds left in the report currently 3775 being collected. When this object is modified by 3776 the management station, a new collection is started, 3777 possibly aborting a currently running report. The 3778 new value is used as the requested duration of this 3779 report, and is immediately loaded into the associated 3780 alMatrixTopNControlDuration object. 3781 When the report finishes, the probe will automatically 3782 start another collection with the same initial value 3783 of alMatrixTopNControlTimeRemaining. Thus the management 3784 station may simply read the resulting reports repeatedly, 3785 checking the startTime and duration each time to ensure that a 3786 report was not missed or that the report parameters were not 3787 changed. 3789 While the value of this object is non-zero, it decrements 3790 by one per second until it reaches zero. At the time 3791 that this object decrements to zero, the report is made 3792 accessible in the alMatrixTopNTable, overwriting any report 3793 that may be there. 3795 When this object is modified by the management station, any 3796 associated entries in the alMatrixTopNTable shall be deleted. 3798 (Note that this is a different algorithm than the one used in 3799 the hostTopNTable)." 3800 DEFVAL { 1800 } 3801 ::= { alMatrixTopNControlEntry 4 } 3803 alMatrixTopNControlGeneratedReports OBJECT-TYPE 3804 SYNTAX Counter32 3805 MAX-ACCESS read-only 3806 STATUS current 3807 DESCRIPTION 3808 "The number of reports that have been generated by this entry." 3809 ::= { alMatrixTopNControlEntry 5 } 3811 alMatrixTopNControlDuration OBJECT-TYPE 3812 SYNTAX Integer32 3813 MAX-ACCESS read-only 3814 STATUS current 3815 DESCRIPTION 3816 "The number of seconds that this report has collected 3817 during the last sampling interval. 3819 When the associated alMatrixTopNControlTimeRemaining object 3820 is set, this object shall be set by the probe to the 3821 same value and shall not be modified until the next 3822 time the alMatrixTopNControlTimeRemaining is set. 3824 This value shall be zero if no reports have been 3825 requested for this alMatrixTopNControlEntry." 3826 ::= { alMatrixTopNControlEntry 6 } 3828 alMatrixTopNControlRequestedSize OBJECT-TYPE 3829 SYNTAX Integer32 (0..2147483647) 3830 MAX-ACCESS read-create 3831 STATUS current 3832 DESCRIPTION 3833 "The maximum number of matrix entries requested for this report. 3835 When this object is created or modified, the probe 3836 should set alMatrixTopNControlGrantedSize as closely to this 3837 object as is possible for the particular probe 3838 implementation and available resources." 3839 DEFVAL { 150 } 3840 ::= { alMatrixTopNControlEntry 7 } 3842 alMatrixTopNControlGrantedSize OBJECT-TYPE 3843 SYNTAX Integer32 (0..2147483647) 3844 MAX-ACCESS read-only 3845 STATUS current 3846 DESCRIPTION 3847 "The maximum number of matrix entries in this report. 3849 When the associated alMatrixTopNControlRequestedSize object 3850 is created or modified, the probe should set this 3851 object as closely to the requested value as is 3852 possible for the particular implementation and 3853 available resources. The probe must not lower this 3854 value except as a result of a set to the associated 3855 alMatrixTopNControlRequestedSize object. 3857 If the value of alMatrixTopNControlRateBase is equal to 3858 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, when the 3859 next topN report is generated, matrix entries with the highest 3860 value of alMatrixTopNPktRate shall be placed in this table in 3861 decreasing order of this rate until there is no more room or 3862 until there are no more matrix entries. 3864 If the value of alMatrixTopNControlRateBase is equal to 3865 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, when the 3866 next topN report is generated, matrix entries with the highest 3867 value of alMatrixTopNOctetRate shall be placed in this table 3868 in decreasing order of this rate until there is no more room 3869 or until there are no more matrix entries. 3871 It is an implementation-specific matter how entries with the 3872 same value of alMatrixTopNPktRate or alMatrixTopNOctetRate are 3873 sorted. It is also an implementation-specific matter as to 3874 whether or not zero-valued entries are available." 3875 ::= { alMatrixTopNControlEntry 8 } 3877 alMatrixTopNControlStartTime OBJECT-TYPE 3878 SYNTAX TimeStamp 3879 MAX-ACCESS read-only 3880 STATUS current 3881 DESCRIPTION 3882 "The value of sysUpTime when this top N report was 3883 last started. In other words, this is the time that 3884 the associated alMatrixTopNControlTimeRemaining object 3885 was modified to start the requested report or the time 3886 the report was last automatically (re)started. 3888 This object may be used by the management station to 3889 determine if a report was missed or not." 3890 ::= { alMatrixTopNControlEntry 9 } 3892 alMatrixTopNControlOwner OBJECT-TYPE 3893 SYNTAX OwnerString 3894 MAX-ACCESS read-create 3895 STATUS current 3896 DESCRIPTION 3897 "The entity that configured this entry and is 3898 therefore using the resources assigned to it." 3899 ::= { alMatrixTopNControlEntry 10 } 3901 alMatrixTopNControlStatus OBJECT-TYPE 3902 SYNTAX RowStatus 3903 MAX-ACCESS read-create 3904 STATUS current 3905 DESCRIPTION 3906 "The status of this alMatrixTopNControlEntry. 3908 An entry may not exist in the active state unless all 3909 objects in the entry have an appropriate value. 3911 If this object is not equal to active(1), all 3912 associated entries in the alMatrixTopNTable shall be 3913 deleted by the agent." 3914 ::= { alMatrixTopNControlEntry 11 } 3916 alMatrixTopNTable OBJECT-TYPE 3917 SYNTAX SEQUENCE OF AlMatrixTopNEntry 3918 MAX-ACCESS not-accessible 3919 STATUS current 3920 DESCRIPTION 3921 "A set of statistics for those application layer matrix 3922 entries that have counted the highest number of octets or 3923 packets." 3924 ::= { alMatrix 4 } 3926 alMatrixTopNEntry OBJECT-TYPE 3927 SYNTAX AlMatrixTopNEntry 3928 MAX-ACCESS not-accessible 3929 STATUS current 3930 DESCRIPTION 3931 "A conceptual row in the alMatrixTopNTable. 3933 The alMatrixTopNControlIndex value in the index identifies 3934 the alMatrixTopNControlEntry on whose behalf this entry was 3935 created. 3937 An example of the indexing of this table is 3938 alMatrixTopNPktRate.3.10" 3939 INDEX { alMatrixTopNControlIndex, alMatrixTopNIndex } 3940 ::= { alMatrixTopNTable 1 } 3942 AlMatrixTopNEntry ::= SEQUENCE { 3943 alMatrixTopNIndex Integer32, 3944 alMatrixTopNProtocolDirLocalIndex Integer32, 3945 alMatrixTopNSourceAddress OCTET STRING, 3946 alMatrixTopNDestAddress OCTET STRING, 3947 alMatrixTopNAppProtocolDirLocalIndex Integer32, 3948 alMatrixTopNPktRate Gauge32, 3949 alMatrixTopNReversePktRate Gauge32, 3950 alMatrixTopNOctetRate Gauge32, 3951 alMatrixTopNReverseOctetRate Gauge32 3952 } 3954 alMatrixTopNIndex OBJECT-TYPE 3955 SYNTAX Integer32 (1..65535) 3956 MAX-ACCESS not-accessible 3957 STATUS current 3958 DESCRIPTION 3959 "An index that uniquely identifies an entry in 3960 the alMatrixTopNTable among those in the same report. 3962 This index is between 1 and N, where N is the 3963 number of entries in this report. 3965 If the value of alMatrixTopNControlRateBase is equal to 3966 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, increasing 3967 values of alMatrixTopNIndex shall be assigned to entries with 3968 decreasing values of alMatrixTopNPktRate until index N is 3969 assigned or there are no more alMatrixTopNEntries. 3971 If the value of alMatrixTopNControlRateBase is equal to 3972 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, 3973 increasing values of alMatrixTopNIndex shall be assigned to 3974 entries with decreasing values of alMatrixTopNOctetRate until 3975 index N is assigned or there are no more alMatrixTopNEntries." 3976 ::= { alMatrixTopNEntry 1 } 3978 alMatrixTopNProtocolDirLocalIndex OBJECT-TYPE 3979 SYNTAX Integer32 (1..2147483647) 3980 MAX-ACCESS read-only 3981 STATUS current 3982 DESCRIPTION 3983 "The protocolDirLocalIndex of the network layer protocol of 3984 this entry's network address." 3985 ::= { alMatrixTopNEntry 2 } 3987 alMatrixTopNSourceAddress OBJECT-TYPE 3988 SYNTAX OCTET STRING (SIZE (1..255)) 3989 MAX-ACCESS read-only 3990 STATUS current 3991 DESCRIPTION 3992 "The network layer address of the source host in this 3993 conversation. 3995 This is represented as an octet string with 3996 specific semantics and length as identified 3997 by the associated alMatrixTopNProtocolDirLocalIndex. 3999 For example, if the alMatrixTopNProtocolDirLocalIndex 4000 indicates an encapsulation of ip, this object is encoded as a 4001 length octet of 4, followed by the 4 octets of the ip address, 4002 in network byte order." 4003 ::= { alMatrixTopNEntry 3 } 4005 alMatrixTopNDestAddress OBJECT-TYPE 4006 SYNTAX OCTET STRING (SIZE (1..255)) 4007 MAX-ACCESS read-only 4008 STATUS current 4009 DESCRIPTION 4010 "The network layer address of the destination host in this 4011 conversation. 4013 This is represented as an octet string with 4014 specific semantics and length as identified 4015 by the associated alMatrixTopNProtocolDirLocalIndex. 4017 For example, if the alMatrixTopNProtocolDirLocalIndex 4018 indicates an encapsulation of ip, this object is encoded as a 4019 length octet of 4, followed by the 4 octets of the ip address, 4020 in network byte order." 4021 ::= { alMatrixTopNEntry 4 } 4023 alMatrixTopNAppProtocolDirLocalIndex OBJECT-TYPE 4024 SYNTAX Integer32 (1..2147483647) 4025 MAX-ACCESS read-only 4026 STATUS current 4027 DESCRIPTION 4028 "The type of the protocol counted by this matrix entry." 4029 ::= { alMatrixTopNEntry 5 } 4031 alMatrixTopNPktRate OBJECT-TYPE 4032 SYNTAX Gauge32 4033 MAX-ACCESS read-only 4034 STATUS current 4035 DESCRIPTION 4036 "The number of packets seen of this protocol from the source 4037 host to the destination host during this sampling interval, 4038 counted using the rules for counting the alMatrixSDPkts 4039 object. 4041 If the value of alMatrixTopNControlRateBase is 4042 alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, this 4043 variable will be used to sort this report." 4044 ::= { alMatrixTopNEntry 6 } 4046 alMatrixTopNReversePktRate OBJECT-TYPE 4047 SYNTAX Gauge32 4048 MAX-ACCESS read-only 4049 STATUS current 4050 DESCRIPTION 4051 "The number of packets seen of this protocol from the 4052 destination host to the source host during this sampling 4053 interval, counted using the rules for counting the 4054 alMatrixDSPkts object (note that the corresponding 4055 alMatrixSDPkts object selected is the one whose source address 4056 is equal to alMatrixTopNDestAddress and whose destination 4057 address is equal to alMatrixTopNSourceAddress.) 4059 Note that if the value of alMatrixTopNControlRateBase is equal 4060 to alMatrixTopNTerminalsPkts or alMatrixTopNAllPkts, the sort 4061 of topN entries is based entirely on alMatrixTopNPktRate, and 4062 not on the value of this object." 4063 ::= { alMatrixTopNEntry 7 } 4065 alMatrixTopNOctetRate OBJECT-TYPE 4066 SYNTAX Gauge32 4067 MAX-ACCESS read-only 4068 STATUS current 4069 DESCRIPTION 4070 "The number of octets seen of this protocol from the source 4071 host to the destination host during this sampling interval, 4072 counted using the rules for counting the alMatrixSDOctets 4073 object. 4075 If the value of alMatrixTopNControlRateBase is 4076 alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, this 4077 variable will be used to sort this report." 4078 ::= { alMatrixTopNEntry 8 } 4080 alMatrixTopNReverseOctetRate OBJECT-TYPE 4081 SYNTAX Gauge32 4082 MAX-ACCESS read-only 4083 STATUS current 4084 DESCRIPTION 4085 "The number of octets seen of this protocol from the 4086 destination host to the source host during this sampling 4087 interval, counted using the rules for counting the 4088 alMatrixDSOctets object (note that the corresponding 4089 alMatrixSDOctets object selected is the one whose source 4090 address is equal to alMatrixTopNDestAddress and whose 4091 destination address is equal to alMatrixTopNSourceAddress.) 4093 Note that if the value of alMatrixTopNControlRateBase is equal 4094 to alMatrixTopNTerminalsOctets or alMatrixTopNAllOctets, the 4095 sort of topN entries is based entirely on 4096 alMatrixTopNOctetRate, and not on the value of this object." 4097 ::= { alMatrixTopNEntry 9 } 4099 -- 4100 -- User History Collection Group (usrHistory) 4101 -- 4102 -- The usrHistory group combines mechanisms seen in the alarm and 4103 -- history groups to provide user-specified history collection, 4104 -- utilizing two additional control tables and one additional data 4105 -- table. This function has traditionally been done by NMS 4106 -- applications, via periodic polling. The usrHistory group allows 4107 -- this task to be offloaded to an RMON probe. 4108 -- 4109 -- Data (an ASN.1 INTEGER based object) is collected in the same 4110 -- manner as any history data table (e.g. etherHistoryTable) except 4111 -- that the user specifies the MIB instances to be collected. Objects 4112 -- are collected in bucket-groups, with the intent that all MIB 4113 -- instances in the same bucket-group are collected as atomically as 4114 -- possible by the RMON probe. 4115 -- 4116 -- The usrHistoryControlTable is a one-dimensional read-create table. 4117 -- Each row configures a collection of user history buckets, much 4118 -- the same as a historyControlEntry, except that the creation of a 4119 -- row in this table will cause one or more associated instances in 4120 -- the usrHistoryObjectTable to be created. The user specifies the 4121 -- number of bucket elements (rows in the usrHistoryObjectTable) 4122 -- requested, as well as the number of buckets requested. 4123 -- 4124 -- The usrHistoryObjectTable is a 2-d read-write table. 4125 -- Each row configures a single MIB instance to be collected. 4126 -- All rows with the same major index constitute a bucket-group. 4127 -- 4128 -- The usrHistoryTable is a 3-d read-only table containing 4129 -- the data of associated usrHistoryControlEntries. Each 4130 -- entry represents the value of a single MIB instance 4131 -- during a specific sampling interval (or the rate of 4132 -- change during the interval). 4133 -- 4134 -- A sample value is stored in two objects - an absolute value and 4135 -- a status object. This allows numbers from -(2G-1) to +4G to be 4136 -- stored. The status object also indicates whether a sample is 4137 -- valid. This allows data collection to continue if periodic 4138 -- retrieval of a particular instance fails for any reason. 4139 -- 4140 -- Row Creation Order Relationships 4141 -- 4142 -- The static nature of the usrHistoryObjectTable creates 4143 -- some row creation/modification issues. The rows in this 4144 -- table need to be set before the associated 4145 -- usrHistoryControlEntry can be activated. 4146 -- 4147 -- Note that the usrHistoryObject entries associated with a 4148 -- particular usrHistoryControlEntry are not required to 4149 -- be active before the control entry is activated. However, 4150 -- the usrHistory data entries associated with an inactive 4151 -- usrHistoryObject entry will be inactive (i.e. 4152 -- usrHistoryValStatus == valueNotAvailable). 4153 -- 4155 usrHistoryControlTable OBJECT-TYPE 4156 SYNTAX SEQUENCE OF UsrHistoryControlEntry 4157 MAX-ACCESS not-accessible 4158 STATUS current 4159 DESCRIPTION 4160 "A list of data-collection configuration entries." 4161 ::= { usrHistory 1 } 4163 usrHistoryControlEntry OBJECT-TYPE 4164 SYNTAX UsrHistoryControlEntry 4165 MAX-ACCESS not-accessible 4166 STATUS current 4167 DESCRIPTION 4168 "A list of parameters that set up a group of user-defined 4169 MIB objects to be sampled periodically (called a 4170 bucket-group). 4172 For example, an instance of usrHistoryControlInterval 4173 might be named usrHistoryControlInterval.1" 4174 INDEX { usrHistoryControlIndex } 4175 ::= { usrHistoryControlTable 1 } 4177 UsrHistoryControlEntry ::= SEQUENCE { 4178 usrHistoryControlIndex Integer32, 4179 usrHistoryControlObjects Integer32, 4180 usrHistoryControlBucketsRequested Integer32, 4181 usrHistoryControlBucketsGranted Integer32, 4182 usrHistoryControlInterval Integer32, 4183 usrHistoryControlOwner OwnerString, 4184 usrHistoryControlStatus RowStatus 4185 } 4187 usrHistoryControlIndex OBJECT-TYPE 4188 SYNTAX Integer32 (1..65535) 4189 MAX-ACCESS not-accessible 4190 STATUS current 4191 DESCRIPTION 4192 "An index that uniquely identifies an entry in the 4193 usrHistoryControlTable. Each such entry defines a 4194 set of samples at a particular interval for a specified 4195 set of MIB instances available from the managed system." 4196 ::= { usrHistoryControlEntry 1 } 4198 usrHistoryControlObjects OBJECT-TYPE 4199 SYNTAX Integer32 (1..65535) 4200 MAX-ACCESS read-create 4201 STATUS current 4202 DESCRIPTION 4203 "The number of MIB objects to be collected 4204 in the portion of usrHistoryTable associated with this 4205 usrHistoryControlEntry. 4207 This object may not be modified if the associated instance 4208 of usrHistoryControlStatus is equal to active(1)." 4209 ::= { usrHistoryControlEntry 2 } 4211 usrHistoryControlBucketsRequested OBJECT-TYPE 4212 SYNTAX Integer32 (1..65535) 4213 MAX-ACCESS read-create 4214 STATUS current 4215 DESCRIPTION 4216 "The requested number of discrete time intervals 4217 over which data is to be saved in the part of the 4218 usrHistoryTable associated with this usrHistoryControlEntry. 4220 When this object is created or modified, the probe 4221 should set usrHistoryControlBucketsGranted as closely to 4222 this object as is possible for the particular probe 4223 implementation and available resources." 4224 DEFVAL { 50 } 4225 ::= { usrHistoryControlEntry 3 } 4227 usrHistoryControlBucketsGranted OBJECT-TYPE 4228 SYNTAX Integer32 (1..65535) 4229 MAX-ACCESS read-only 4230 STATUS current 4231 DESCRIPTION 4232 "The number of discrete sampling intervals 4233 over which data shall be saved in the part of 4234 the usrHistoryTable associated with this 4235 usrHistoryControlEntry. 4237 When the associated usrHistoryControlBucketsRequested 4238 object is created or modified, the probe should set 4239 this object as closely to the requested value as is 4240 possible for the particular probe implementation and 4241 available resources. The probe must not lower this 4242 value except as a result of a modification to the associated 4243 usrHistoryControlBucketsRequested object. 4245 The associated usrHistoryControlBucketsRequested object 4246 should be set before or at the same time as this object 4247 to allow the probe to accurately estimate the resources 4248 required for this usrHistoryControlEntry. 4250 There will be times when the actual number of buckets 4251 associated with this entry is less than the value of 4252 this object. In this case, at the end of each sampling 4253 interval, a new bucket will be added to the usrHistoryTable. 4255 When the number of buckets reaches the value of this object 4256 and a new bucket is to be added to the usrHistoryTable, 4257 the oldest bucket associated with this usrHistoryControlEntry 4258 shall be deleted by the agent so that the new bucket can be 4259 added. 4261 When the value of this object changes to a value less than 4262 the current value, entries are deleted from the 4263 usrHistoryTable associated with this usrHistoryControlEntry. 4264 Enough of the oldest of these entries shall be deleted by the 4265 agent so that their number remains less than or equal to the 4266 new value of this object. 4268 When the value of this object changes to a value greater 4269 than the current value, the number of associated usrHistory 4270 entries may be allowed to grow." 4272 ::= { usrHistoryControlEntry 4 } 4274 usrHistoryControlInterval OBJECT-TYPE 4275 SYNTAX Integer32 (1..2147483647) 4276 MAX-ACCESS read-create 4277 STATUS current 4278 DESCRIPTION 4279 "The interval in seconds over which the data is 4280 sampled for each bucket in the part of the usrHistory 4281 table associated with this usrHistoryControlEntry. 4283 Because the counters in a bucket may overflow at their 4284 maximum value with no indication, a prudent manager will 4285 take into account the possibility of overflow in any of 4286 the associated counters. It is important to consider the 4287 minimum time in which any counter could overflow on a 4288 particular media type and set the usrHistoryControlInterval 4289 object to a value less than this interval. 4291 This object may not be modified if the associated 4292 usrHistoryControlStatus object is equal to active(1)." 4293 DEFVAL { 1800 } 4294 ::= { usrHistoryControlEntry 5 } 4296 usrHistoryControlOwner OBJECT-TYPE 4297 SYNTAX OwnerString 4298 MAX-ACCESS read-create 4299 STATUS current 4300 DESCRIPTION 4301 "The entity that configured this entry and is 4302 therefore using the resources assigned to it." 4303 ::= { usrHistoryControlEntry 6 } 4305 usrHistoryControlStatus OBJECT-TYPE 4306 SYNTAX RowStatus 4307 MAX-ACCESS read-create 4308 STATUS current 4309 DESCRIPTION 4310 "The status of this variable history control entry. 4312 An entry may not exist in the active state unless all 4313 objects in the entry have an appropriate value. 4315 If this object is not equal to active(1), all associated 4316 entries in the usrHistoryTable shall be deleted." 4317 ::= { usrHistoryControlEntry 7 } 4319 -- Object table 4321 usrHistoryObjectTable OBJECT-TYPE 4322 SYNTAX SEQUENCE OF UsrHistoryObjectEntry 4323 MAX-ACCESS not-accessible 4324 STATUS current 4325 DESCRIPTION 4326 "A list of data-collection configuration entries." 4327 ::= { usrHistory 2 } 4329 usrHistoryObjectEntry OBJECT-TYPE 4330 SYNTAX UsrHistoryObjectEntry 4331 MAX-ACCESS not-accessible 4332 STATUS current 4333 DESCRIPTION 4334 "A list of MIB instances to be sampled periodically. 4336 Entries in this table are created when an associated 4337 usrHistoryControlObjects object is created. 4339 The usrHistoryControlIndex value in the index is 4340 that of the associated usrHistoryControlEntry. 4342 For example, an instance of usrHistoryObjectVariable might be 4343 usrHistoryObjectVariable.1.3" 4344 INDEX { usrHistoryControlIndex, usrHistoryObjectIndex } 4345 ::= { usrHistoryObjectTable 1 } 4347 UsrHistoryObjectEntry ::= SEQUENCE { 4348 usrHistoryObjectIndex Integer32, 4349 usrHistoryObjectVariable OBJECT IDENTIFIER, 4350 usrHistoryObjectSampleType INTEGER 4351 } 4353 usrHistoryObjectIndex OBJECT-TYPE 4354 SYNTAX Integer32 (1..65535) 4355 MAX-ACCESS not-accessible 4356 STATUS current 4357 DESCRIPTION 4358 "An index used to uniquely identify an entry in the 4359 usrHistoryObject table. Each such entry defines a 4360 MIB instance to be collected periodically." 4361 ::= { usrHistoryObjectEntry 1 } 4363 usrHistoryObjectVariable OBJECT-TYPE 4364 SYNTAX OBJECT IDENTIFIER 4365 MAX-ACCESS read-create 4366 STATUS current 4367 DESCRIPTION 4368 "The object identifier of the particular variable to be 4369 sampled. 4371 Only variables that resolve to an ASN.1 primitive type of 4372 Integer32 (Integer32, Counter, Gauge, or TimeTicks) may be 4373 sampled. 4375 Because SNMP access control is articulated entirely in terms 4376 of the contents of MIB views, no access control mechanism 4377 exists that can restrict the value of this object to identify 4378 only those objects that exist in a particular MIB view. 4379 Because there is thus no acceptable means of restricting the 4380 read access that could be obtained through the user history 4381 mechanism, the probe must only grant write access to this 4382 object in those views that have read access to all objects on 4383 the probe. See USM [RFC3414] and VACM [RFC3415] for more 4384 information. 4386 During a set operation, if the supplied variable name is not 4387 available in the selected MIB view, a badValue error must be 4388 returned. 4390 This object may not be modified if the associated 4391 usrHistoryControlStatus object is equal to active(1)." 4392 ::= { usrHistoryObjectEntry 2 } 4394 usrHistoryObjectSampleType OBJECT-TYPE 4395 SYNTAX INTEGER { 4396 absoluteValue(1), 4397 deltaValue(2) 4398 } 4399 MAX-ACCESS read-create 4400 STATUS current 4401 DESCRIPTION 4402 "The method of sampling the selected variable for storage in 4403 the usrHistoryTable. 4405 If the value of this object is absoluteValue(1), the value of 4406 the selected variable will be copied directly into the history 4407 bucket. 4409 If the value of this object is deltaValue(2), the value of the 4410 selected variable at the last sample will be subtracted from 4411 the current value, and the difference will be stored in the 4412 history bucket. If the associated usrHistoryObjectVariable 4413 instance could not be obtained at the previous sample 4414 interval, then a delta sample is not possible, and the value 4415 of the associated usrHistoryValStatus object for this interval 4416 will be valueNotAvailable(1). 4418 This object may not be modified if the associated 4419 usrHistoryControlStatus object is equal to active(1)." 4420 ::= { usrHistoryObjectEntry 3 } 4422 -- data table 4424 usrHistoryTable OBJECT-TYPE 4425 SYNTAX SEQUENCE OF UsrHistoryEntry 4426 MAX-ACCESS not-accessible 4427 STATUS current 4428 DESCRIPTION 4429 "A list of user defined history entries." 4430 ::= { usrHistory 3 } 4432 usrHistoryEntry OBJECT-TYPE 4433 SYNTAX UsrHistoryEntry 4434 MAX-ACCESS not-accessible 4435 STATUS current 4436 DESCRIPTION 4437 "A historical sample of user-defined variables. This sample 4438 is associated with the usrHistoryControlEntry which set up the 4439 parameters for a regular collection of these samples. 4441 The usrHistoryControlIndex value in the index identifies the 4442 usrHistoryControlEntry on whose behalf this entry was created. 4443 The usrHistoryObjectIndex value in the index identifies the 4444 usrHistoryObjectEntry on whose behalf this entry was created. 4446 For example, an instance of usrHistoryAbsValue, which represents 4447 the 14th sample of a variable collected as specified by 4448 usrHistoryControlEntry.1 and usrHistoryObjectEntry.1.5, 4449 would be named usrHistoryAbsValue.1.14.5" 4450 INDEX { usrHistoryControlIndex, usrHistorySampleIndex, 4451 usrHistoryObjectIndex } 4452 ::= { usrHistoryTable 1 } 4454 UsrHistoryEntry ::= SEQUENCE { 4455 usrHistorySampleIndex Integer32, 4456 usrHistoryIntervalStart TimeStamp, 4457 usrHistoryIntervalEnd TimeStamp, 4458 usrHistoryAbsValue Gauge32, 4459 usrHistoryValStatus INTEGER 4460 } 4462 usrHistorySampleIndex OBJECT-TYPE 4463 SYNTAX Integer32 (1..2147483647) 4464 MAX-ACCESS not-accessible 4465 STATUS current 4466 DESCRIPTION 4467 "An index that uniquely identifies the particular sample this 4468 entry represents among all samples associated with the same 4469 usrHistoryControlEntry. This index starts at 1 and increases 4470 by one as each new sample is taken." 4471 ::= { usrHistoryEntry 1 } 4473 usrHistoryIntervalStart OBJECT-TYPE 4474 SYNTAX TimeStamp 4475 MAX-ACCESS read-only 4476 STATUS current 4477 DESCRIPTION 4478 "The value of sysUpTime at the start of the interval over 4479 which this sample was measured. If the probe keeps track of 4480 the time of day, it should start the first sample of the 4481 history at a time such that when the next hour of the day 4482 begins, a sample is started at that instant. 4484 Note that following this rule may require the probe to delay 4485 collecting the first sample of the history, as each sample 4486 must be of the same interval. Also note that the sample which 4487 is currently being collected is not accessible in this table 4488 until the end of its interval." 4489 ::= { usrHistoryEntry 2 } 4491 usrHistoryIntervalEnd OBJECT-TYPE 4492 SYNTAX TimeStamp 4493 MAX-ACCESS read-only 4494 STATUS current 4495 DESCRIPTION 4496 "The value of sysUpTime at the end of the interval over which 4497 this sample was measured." 4498 ::= { usrHistoryEntry 3 } 4500 usrHistoryAbsValue OBJECT-TYPE 4501 SYNTAX Gauge32 4502 MAX-ACCESS read-only 4503 STATUS current 4504 DESCRIPTION 4505 "The absolute value (i.e. unsigned value) of the 4506 user-specified statistic during the last sampling period. The 4507 value during the current sampling period is not made available 4508 until the period is completed. 4510 To obtain the true value for this sampling interval, the 4511 associated instance of usrHistoryValStatus must be checked, 4512 and usrHistoryAbsValue adjusted as necessary. 4514 If the MIB instance could not be accessed during the sampling 4515 interval, then this object will have a value of zero and the 4516 associated instance of usrHistoryValStatus will be set to 4517 'valueNotAvailable(1)'. 4519 The access control check prescribed in the definition of 4520 usrHistoryObjectVariable SHOULD be checked for each sampling 4521 interval. If this check determines that access should not be 4522 allowed, then this object will have a value of zero and the 4523 associated instance of usrHistoryValStatus will be set to 4524 'valueNotAvailable(1)'." 4525 ::= { usrHistoryEntry 4 } 4527 usrHistoryValStatus OBJECT-TYPE 4528 SYNTAX INTEGER { 4529 valueNotAvailable(1), 4530 valuePositive(2), 4531 valueNegative(3) 4532 } 4533 MAX-ACCESS read-only 4534 STATUS current 4535 DESCRIPTION 4536 "This object indicates the validity and sign of the data in 4537 the associated instance of usrHistoryAbsValue. 4539 If the MIB instance could not be accessed during the sampling 4540 interval, then 'valueNotAvailable(1)' will be returned. 4542 If the sample is valid and actual value of the sample is 4543 greater than or equal to zero then 'valuePositive(2)' is 4544 returned. 4546 If the sample is valid and the actual value of the sample is 4547 less than zero, 'valueNegative(3)' will be returned. The 4548 associated instance of usrHistoryAbsValue should be multiplied 4549 by -1 to obtain the true sample value." 4550 ::= { usrHistoryEntry 5 } 4552 -- The Probe Configuration Group 4553 -- 4554 -- This group controls the configuration of various operating 4555 -- parameters of the probe. 4557 ControlString ::= TEXTUAL-CONVENTION 4558 STATUS current 4559 DESCRIPTION 4560 "This data type is used to communicate with a modem or a 4561 serial data switch. A ControlString contains embedded 4562 commands to control how the device will interact with the 4563 remote device through the serial interface. Commands are 4564 represented as two character sequences beginning with 4565 the `^' character. 4567 The following commands are recognized by the device (note 4568 that command characters are case sensitive): 4570 ^s Send string that follows which is terminated by the 4571 next command or the end of string. 4572 ^c Delay for the number of seconds that follows. Toss 4573 out any data received rather than storing it in a 4574 buffer for parsing. 4575 ^t Set timeout to the value represented by the decimal 4576 digits that follow. The default timeout is 20 4577 seconds. Note that this timeout may be overridden 4578 by a smaller serialTimeout configured for the 4579 associated serial interface (see serialConfigTable). 4580 ^w Wait for the reply string that follows which is 4581 terminated by the next command or the end of string. 4582 Partial and case insensitive matching is applied, ie. 4583 if the reply string (any case combination) is found 4584 anywhere in the received string, then the a match is 4585 found. If the current timeout elapses without a match, 4586 then the remaining control string is ignored. 4587 ^! The ^ character. 4588 ^d Delay the number of seconds specified by the decimal 4589 digits that follow. 4590 ^b Send break for the number of milliseconds specified by 4591 the decimal digits that follow. If no digits follow, 4592 break will be enforced for 250 milliseconds by default. 4594 The following ASCII control characters may be inserted into 4595 the `^s' send string or the `^w' reply string: 4597 ^@ 0x00 4598 ^A 0x01 4599 .. 4600 ^M 0x0D 4601 .. 4602 ^Z 0x1A 4603 ^[ 0x1B 4604 ^ 0x1C 4605 ^] 0x1D 4606 ^^ 0x1E 4607 ^_ 0x1F 4609 Binary data may also be inserted into the data stream. The 4610 control sequence for each byte of binary data is ^0x##, where 4611 ## is the hexadecimal representation of the data byte. Two 4612 ASCII characters (0-9, a-f, A-F) must follow the `^0x' 4613 control prefix. For example, `^0x0D^0x0A' is interpreted as a 4614 carriage return followed by a line feed." 4615 SYNTAX OCTET STRING (SIZE (0..255)) 4617 probeCapabilities OBJECT-TYPE 4618 SYNTAX BITS { 4619 etherStats(0), 4620 historyControl(1), 4621 etherHistory(2), 4622 alarm(3), 4623 hosts(4), 4624 hostTopN(5), 4625 matrix(6), 4626 filter(7), 4627 capture(8), 4628 event(9), 4629 tokenRingMLStats(10), 4630 tokenRingPStats(11), 4631 tokenRingMLHistory(12), 4632 tokenRingPHistory(13), 4633 ringStation(14), 4634 ringStationOrder(15), 4635 ringStationConfig(16), 4636 sourceRouting(17), 4637 protocolDirectory(18), 4638 protocolDistribution(19), 4639 addressMapping(20), 4640 nlHost(21), 4641 nlMatrix(22), 4642 alHost(23), 4643 alMatrix(24), 4644 usrHistory(25), 4645 probeConfig(26) 4646 } 4647 MAX-ACCESS read-only 4648 STATUS current 4649 DESCRIPTION 4650 "An indication of the RMON MIB groups supported 4651 on at least one interface by this probe." 4652 ::= { probeConfig 1 } 4654 probeSoftwareRev OBJECT-TYPE 4655 SYNTAX DisplayString (SIZE(0..15)) 4656 MAX-ACCESS read-only 4657 STATUS current 4658 DESCRIPTION 4659 "The software revision of this device. This string will have 4660 a zero length if the revision is unknown." 4661 ::= { probeConfig 2 } 4663 probeHardwareRev OBJECT-TYPE 4664 SYNTAX DisplayString (SIZE(0..31)) 4665 MAX-ACCESS read-only 4666 STATUS current 4667 DESCRIPTION 4668 "The hardware revision of this device. This string will have 4669 a zero length if the revision is unknown." 4670 ::= { probeConfig 3 } 4672 probeDateTime OBJECT-TYPE 4673 SYNTAX OCTET STRING (SIZE (0 | 8 | 11)) 4674 MAX-ACCESS read-write 4675 STATUS current 4676 DESCRIPTION 4677 "Probe's current date and time. 4679 field octets contents range 4680 ----- ------ -------- ----- 4681 1 1-2 year 0..65536 4682 2 3 month 1..12 4683 3 4 day 1..31 4684 4 5 hour 0..23 4685 5 6 minutes 0..59 4686 6 7 seconds 0..60 4687 (use 60 for leap-second) 4688 7 8 deci-seconds 0..9 4689 8 9 direction from UTC '+' / '-' 4690 9 10 hours from UTC 0..11 4691 10 11 minutes from UTC 0..59 4693 For example, Tuesday May 26, 1992 at 1:30:15 PM 4694 EDT would be displayed as: 4696 1992-5-26,13:30:15.0,-4:0 4698 Note that if only local time is known, then 4699 timezone information (fields 8-10) is not 4700 present, and if no time information is known, the null 4701 string is returned." 4702 ::= { probeConfig 4 } 4704 probeResetControl OBJECT-TYPE 4705 SYNTAX INTEGER { 4706 running(1), 4707 warmBoot(2), 4708 coldBoot(3) 4709 } 4711 MAX-ACCESS read-write 4712 STATUS current 4713 DESCRIPTION 4714 "Setting this object to warmBoot(2) causes the device to 4715 restart the application software with current configuration 4716 parameters saved in non-volatile memory. Setting this 4717 object to coldBoot(3) causes the device to reinitialize 4718 configuration parameters in non-volatile memory to default 4719 values and restart the application software. When the device 4720 is running normally, this variable has a value of 4721 running(1)." 4722 ::= { probeConfig 5 } 4724 -- The following download objects do not restrict an implementation 4725 -- from implementing additional download mechanisms (controlled in an 4726 -- implementation-specific manner). Further, in the case where the RMON 4727 -- agent shares a processor with other types of systems, the 4728 -- implementation is not required to download those non-RMON functions 4729 -- with this mechanism. 4731 probeDownloadFile OBJECT-TYPE 4732 SYNTAX DisplayString (SIZE(0..127)) 4733 MAX-ACCESS read-write 4734 STATUS deprecated 4735 DESCRIPTION 4736 "The file name to be downloaded from the TFTP server when a 4737 download is next requested via this MIB. This value is set to 4738 the zero length string when no file name has been specified. 4740 This object has been deprecated as it has not had enough 4741 independent implementations to demonstrate interoperability to 4742 meet the requirements of a Draft Standard." 4743 ::= { probeConfig 6 } 4745 probeDownloadTFTPServer OBJECT-TYPE 4746 SYNTAX IpAddress 4747 MAX-ACCESS read-write 4748 STATUS deprecated 4749 DESCRIPTION 4750 "The IP address of the TFTP server that contains the boot 4751 image to load when a download is next requested via this MIB. 4752 This value is set to `0.0.0.0' when no IP address has been 4753 specified. 4755 This object has been deprecated as it has not had enough 4756 independent implementations to demonstrate interoperability to 4757 meet the requirements of a Draft Standard." 4758 ::= { probeConfig 7 } 4760 probeDownloadAction OBJECT-TYPE 4761 SYNTAX INTEGER { 4762 notDownloading(1), 4763 downloadToPROM(2), 4764 downloadToRAM(3) 4765 } 4766 MAX-ACCESS read-write 4767 STATUS deprecated 4768 DESCRIPTION 4769 "When this object is set to downloadToRAM(3) or 4770 downloadToPROM(2), the device will discontinue its 4771 normal operation and begin download of the image specified 4772 by probeDownloadFile from the server specified by 4773 probeDownloadTFTPServer using the TFTP protocol. If 4774 downloadToRAM(3) is specified, the new image is copied 4775 to RAM only (the old image remains unaltered in the flash 4776 EPROM). If downloadToPROM(2) is specified 4777 the new image is written to the flash EPROM 4778 memory after its checksum has been verified to be correct. 4779 When the download process is completed, the device will 4780 warm boot to restart the newly loaded application. 4781 When the device is not downloading, this object will have 4782 a value of notDownloading(1). 4784 This object has been deprecated as it has not had enough 4785 independent implementations to demonstrate interoperability to 4786 meet the requirements of a Draft Standard." 4787 ::= { probeConfig 8 } 4789 probeDownloadStatus OBJECT-TYPE 4790 SYNTAX INTEGER { 4791 downloadSuccess(1), 4792 downloadStatusUnknown(2), 4793 downloadGeneralError(3), 4794 downloadNoResponseFromServer(4), 4795 downloadChecksumError(5), 4796 downloadIncompatibleImage(6), 4797 downloadTftpFileNotFound(7), 4798 downloadTftpAccessViolation(8) 4800 } 4801 MAX-ACCESS read-only 4802 STATUS deprecated 4803 DESCRIPTION 4804 "The status of the last download procedure, if any. This 4805 object will have a value of downloadStatusUnknown(2) if no 4806 download process has been performed. 4808 This object has been deprecated as it has not had enough 4809 independent implementations to demonstrate interoperability to 4810 meet the requirements of a Draft Standard." 4811 ::= { probeConfig 9 } 4813 serialConfigTable OBJECT-TYPE 4814 SYNTAX SEQUENCE OF SerialConfigEntry 4815 MAX-ACCESS not-accessible 4816 STATUS deprecated 4817 DESCRIPTION 4818 "A table of serial interface configuration entries. This data 4819 will be stored in non-volatile memory and preserved across 4820 probe resets or power loss. 4822 This table has been deprecated as it has not had enough 4823 independent implementations to demonstrate interoperability to 4824 meet the requirements of a Draft Standard." 4825 ::= { probeConfig 10 } 4827 serialConfigEntry OBJECT-TYPE 4828 SYNTAX SerialConfigEntry 4829 MAX-ACCESS not-accessible 4830 STATUS deprecated 4831 DESCRIPTION 4832 "A set of configuration parameters for a particular 4833 serial interface on this device. If the device has no serial 4834 interfaces, this table is empty. 4836 The index is composed of the ifIndex assigned to this serial 4837 line interface." 4838 INDEX { ifIndex } 4839 ::= { serialConfigTable 1 } 4841 SerialConfigEntry ::= SEQUENCE { 4842 serialMode INTEGER, 4843 serialProtocol INTEGER, 4844 serialTimeout Integer32, 4845 serialModemInitString ControlString, 4846 serialModemHangUpString ControlString, 4847 serialModemConnectResp DisplayString, 4848 serialModemNoConnectResp DisplayString, 4849 serialDialoutTimeout Integer32, 4850 serialStatus RowStatus 4851 } 4853 serialMode OBJECT-TYPE 4854 SYNTAX INTEGER { 4855 direct(1), 4856 modem(2) 4857 } 4858 MAX-ACCESS read-create 4859 STATUS deprecated 4860 DESCRIPTION 4861 "The type of incoming connection to expect on this serial 4862 interface." 4863 DEFVAL { direct } 4864 ::= { serialConfigEntry 1 } 4866 serialProtocol OBJECT-TYPE 4867 SYNTAX INTEGER { 4868 other(1), 4869 slip(2), 4870 ppp(3) 4871 } 4872 MAX-ACCESS read-create 4873 STATUS deprecated 4874 DESCRIPTION 4875 "The type of data link encapsulation to be used on this 4876 serial interface." 4877 DEFVAL { slip } 4878 ::= { serialConfigEntry 2 } 4880 serialTimeout OBJECT-TYPE 4881 SYNTAX Integer32 (1..65535) 4882 MAX-ACCESS read-create 4883 STATUS deprecated 4884 DESCRIPTION 4885 "This timeout value is used when the Management Station has 4886 initiated the conversation over the serial link. This variable 4887 represents the number of seconds of inactivity allowed before 4888 terminating the connection on this serial interface. Use the 4889 serialDialoutTimeout in the case where the probe has initiated 4890 the connection for the purpose of sending a trap." 4891 DEFVAL { 300 } 4892 ::= { serialConfigEntry 3 } 4894 serialModemInitString OBJECT-TYPE 4895 SYNTAX ControlString (SIZE (0..255)) 4896 MAX-ACCESS read-create 4897 STATUS deprecated 4898 DESCRIPTION 4899 "A control string which controls how a modem attached to this 4900 serial interface should be initialized. The initialization 4901 is performed once during startup and again after each 4902 connection is terminated if the associated serialMode has the 4903 value of modem(2). 4905 A control string that is appropriate for a wide variety of 4906 modems is: '^s^MATE0Q0V1X4 S0=1 S2=43^M'." 4907 ::= { serialConfigEntry 4 } 4909 serialModemHangUpString OBJECT-TYPE 4910 SYNTAX ControlString (SIZE (0..255)) 4911 MAX-ACCESS read-create 4912 STATUS deprecated 4913 DESCRIPTION 4914 "A control string which specifies how to disconnect a modem 4915 connection on this serial interface. This object is only 4916 meaningful if the associated serialMode has the value 4917 of modem(2). 4918 A control string that is appropriate for a wide variety of 4919 modems is: '^d2^s+++^d2^sATH0^M^d2'." 4920 ::= { serialConfigEntry 5 } 4922 serialModemConnectResp OBJECT-TYPE 4923 SYNTAX DisplayString (SIZE (0..255)) 4924 MAX-ACCESS read-create 4925 STATUS deprecated 4926 DESCRIPTION 4927 "An ASCII string containing substrings that describe the 4928 expected modem connection response code and associated bps 4929 rate. The substrings are delimited by the first character 4930 in the string, for example: 4931 /CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 4932 CONNECT 4800/4800/CONNECT 9600/9600 4933 will be interpreted as: 4934 response code bps rate 4935 CONNECT 300 4936 CONNECT 1200 1200 4937 CONNECT 2400 2400 4938 CONNECT 4800 4800 4939 CONNECT 9600 9600 4940 The agent will use the information in this string to adjust 4941 the bps rate of this serial interface once a modem connection 4942 is established. 4944 A value that is appropriate for a wide variety of modems is: 4945 '/CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 4946 CONNECT 4800/4800/CONNECT 9600/9600/CONNECT 14400/14400/ 4947 CONNECT 19200/19200/CONNECT 38400/38400/'." 4948 ::= { serialConfigEntry 6 } 4950 serialModemNoConnectResp OBJECT-TYPE 4951 SYNTAX DisplayString (SIZE (0..255)) 4952 MAX-ACCESS read-create 4953 STATUS deprecated 4954 DESCRIPTION 4955 "An ASCII string containing response codes that may be 4956 generated by a modem to report the reason why a connection 4957 attempt has failed. The response codes are delimited by 4958 the first character in the string, for example: 4959 /NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/ 4960 If one of these response codes is received via this serial 4961 interface while attempting to make a modem connection, 4962 the agent will issue the hang up command as specified by 4963 serialModemHangUpString. 4965 A value that is appropriate for a wide variety of modems is: 4966 '/NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/'." 4967 ::= { serialConfigEntry 7 } 4969 serialDialoutTimeout OBJECT-TYPE 4970 SYNTAX Integer32 (1..65535) 4971 MAX-ACCESS read-create 4972 STATUS deprecated 4973 DESCRIPTION 4974 "This timeout value is used when the probe initiates the 4975 serial connection with the intention of contacting a 4976 management station. This variable represents the number 4977 of seconds of inactivity allowed before terminating the 4978 connection on this serial interface." 4979 DEFVAL { 20 } 4980 ::= { serialConfigEntry 8 } 4982 serialStatus OBJECT-TYPE 4983 SYNTAX RowStatus 4984 MAX-ACCESS read-create 4985 STATUS deprecated 4986 DESCRIPTION 4987 "The status of this serialConfigEntry. 4989 An entry may not exist in the active state unless all 4990 objects in the entry have an appropriate value." 4991 ::= { serialConfigEntry 9 } 4993 netConfigTable OBJECT-TYPE 4994 SYNTAX SEQUENCE OF NetConfigEntry 4995 MAX-ACCESS not-accessible 4996 STATUS deprecated 4997 DESCRIPTION 4998 "A table of netConfigEntries. 5000 This table has been deprecated as it has not had enough 5001 independent implementations to demonstrate interoperability to 5002 meet the requirements of a Draft Standard." 5003 ::= { probeConfig 11 } 5005 netConfigEntry OBJECT-TYPE 5006 SYNTAX NetConfigEntry 5007 MAX-ACCESS not-accessible 5008 STATUS deprecated 5009 DESCRIPTION 5010 "A set of configuration parameters for a particular 5011 network interface on this device. If the device has no network 5012 interface, this table is empty. 5014 The index is composed of the ifIndex assigned to the 5015 corresponding interface." 5016 INDEX { ifIndex } 5017 ::= { netConfigTable 1 } 5019 NetConfigEntry ::= SEQUENCE { 5020 netConfigIPAddress IpAddress, 5021 netConfigSubnetMask IpAddress, 5022 netConfigStatus RowStatus 5023 } 5025 netConfigIPAddress OBJECT-TYPE 5026 SYNTAX IpAddress 5027 MAX-ACCESS read-create 5028 STATUS deprecated 5029 DESCRIPTION 5030 "The IP address of this Net interface. The default value 5031 for this object is 0.0.0.0. If either the netConfigIPAddress 5032 or netConfigSubnetMask are 0.0.0.0, then when the device 5033 boots, it may use BOOTP to try to figure out what these 5034 values should be. If BOOTP fails, before the device 5035 can talk on the network, this value must be configured 5036 (e.g., through a terminal attached to the device). If BOOTP is 5037 used, care should be taken to not send BOOTP broadcasts too 5038 frequently and to eventually send very infrequently if no 5039 replies are received." 5040 ::= { netConfigEntry 1 } 5042 netConfigSubnetMask OBJECT-TYPE 5043 SYNTAX IpAddress 5044 MAX-ACCESS read-create 5045 STATUS deprecated 5046 DESCRIPTION 5047 "The subnet mask of this Net interface. The default value 5048 for this object is 0.0.0.0. If either the netConfigIPAddress 5049 or netConfigSubnetMask are 0.0.0.0, then when the device 5050 boots, it may use BOOTP to try to figure out what these 5051 values should be. If BOOTP fails, before the device 5052 can talk on the network, this value must be configured 5053 (e.g., through a terminal attached to the device). If BOOTP is 5054 used, care should be taken to not send BOOTP broadcasts too 5055 frequently and to eventually send very infrequently if no 5056 replies are received." 5057 ::= { netConfigEntry 2 } 5059 netConfigStatus OBJECT-TYPE 5060 SYNTAX RowStatus 5061 MAX-ACCESS read-create 5062 STATUS deprecated 5063 DESCRIPTION 5064 "The status of this netConfigEntry. 5066 An entry may not exist in the active state unless all 5067 objects in the entry have an appropriate value." 5068 ::= { netConfigEntry 3 } 5070 netDefaultGateway OBJECT-TYPE 5071 SYNTAX IpAddress 5072 MAX-ACCESS read-write 5073 STATUS deprecated 5074 DESCRIPTION 5075 "The IP Address of the default gateway. If this value is 5076 undefined or unknown, it shall have the value 0.0.0.0." 5077 ::= { probeConfig 12 } 5079 -- Trap Destination Table 5080 -- 5081 -- This table defines the destination addresses for traps generated 5082 -- from the device. This table maps a community to one or more trap 5083 -- destination entries. 5084 -- 5085 -- The same trap will be sent to all destinations specified in the 5086 -- entries that have the same trapDestCommunity as the eventCommunity 5087 -- (as defined by RMON MIB), as long as no access control mechanism 5088 -- (e.g., VACM) prohibits sending to one or mor of the destinations. 5089 -- Information in this table will be stored in non-volatile memory. 5090 -- If the device has gone through a hard restart, this information 5091 -- will be reset to its default state. 5093 trapDestTable OBJECT-TYPE 5094 SYNTAX SEQUENCE OF TrapDestEntry 5095 MAX-ACCESS not-accessible 5096 STATUS deprecated 5097 DESCRIPTION 5098 "A list of trap destination entries." 5099 ::= { probeConfig 13 } 5101 trapDestEntry OBJECT-TYPE 5102 SYNTAX TrapDestEntry 5103 MAX-ACCESS not-accessible 5104 STATUS deprecated 5105 DESCRIPTION 5106 "This entry includes a destination IP address to which to send 5107 traps for this community." 5109 INDEX { trapDestIndex } 5110 ::= { trapDestTable 1 } 5112 TrapDestEntry ::= SEQUENCE { 5113 trapDestIndex Integer32, 5114 trapDestCommunity OCTET STRING, 5115 trapDestProtocol INTEGER, 5116 trapDestAddress OCTET STRING, 5117 trapDestOwner OwnerString, 5118 trapDestStatus RowStatus 5119 } 5121 trapDestIndex OBJECT-TYPE 5122 SYNTAX Integer32 (1..65535) 5123 MAX-ACCESS not-accessible 5124 STATUS deprecated 5125 DESCRIPTION 5126 "A value that uniquely identifies this trapDestEntry." 5127 ::= { trapDestEntry 1 } 5129 trapDestCommunity OBJECT-TYPE 5130 SYNTAX OCTET STRING (SIZE(0..127)) 5131 MAX-ACCESS read-create 5132 STATUS deprecated 5133 DESCRIPTION 5134 "A community to which this destination address belongs. 5135 This entry is associated with any eventEntries in the RMON 5136 MIB whose value of eventCommunity is equal to the value of 5137 this object. Every time an associated event entry sends a 5138 trap due to an event, that trap will be sent to each 5139 address in the trapDestTable with a trapDestCommunity equal to 5140 eventCommunity, as long as no access control mechanism 5141 precludes it (e.g., VACM). 5143 This object may not be modified if the associated 5144 trapDestStatus object is equal to active(1)." 5145 ::= { trapDestEntry 2 } 5147 trapDestProtocol OBJECT-TYPE 5148 SYNTAX INTEGER { 5149 ip(1), 5150 ipx(2) 5151 } 5152 MAX-ACCESS read-create 5153 STATUS deprecated 5154 DESCRIPTION 5155 "The protocol with which to send this trap." 5156 ::= { trapDestEntry 3 } 5158 trapDestAddress OBJECT-TYPE 5159 SYNTAX OCTET STRING 5160 MAX-ACCESS read-create 5161 STATUS deprecated 5162 DESCRIPTION 5163 "The address to send traps on behalf of this entry. 5165 If the associated trapDestProtocol object is equal to ip(1), 5166 the encoding of this object is the same as the snmpUDPAddress 5167 textual convention in RFC 3417 'Transport Mappings for the 5168 Simple Network Management Protocol(SNMP)' [RFC3417]: 5169 -- for a SnmpUDPAddress of length 6: 5170 -- 5171 -- octets contents encoding 5172 -- 1-4 IP-address network-byte order 5173 -- 5-6 UDP-port network-byte order 5175 If the associated trapDestProtocol object is equal to ipx(2), 5176 the encoding of this object is the same as the snmpIPXAddress 5177 textual convention in RFC 3417 "Transport Mappings for the 5178 Simple Network Management Protocol(SNMP)" [RFC3417]: 5179 -- for a SnmpIPXAddress of length 12: 5180 -- 5181 -- octets contents encoding 5182 -- 1-4 network-number network-byte order 5183 -- 5-10 physical-address network-byte order 5184 -- 11-12 socket-number network-byte order 5186 This object may not be modified if the associated 5187 trapDestStatus object is equal to active(1)." 5188 ::= { trapDestEntry 4 } 5190 trapDestOwner OBJECT-TYPE 5191 SYNTAX OwnerString 5192 MAX-ACCESS read-create 5193 STATUS deprecated 5194 DESCRIPTION 5195 "The entity that configured this entry and is 5196 therefore using the resources assigned to it." 5198 ::= { trapDestEntry 5 } 5200 trapDestStatus OBJECT-TYPE 5201 SYNTAX RowStatus 5202 MAX-ACCESS read-create 5203 STATUS deprecated 5204 DESCRIPTION 5205 "The status of this trap destination entry. 5207 An entry may not exist in the active state unless all 5208 objects in the entry have an appropriate value." 5209 ::= { trapDestEntry 6 } 5211 -- Serial Connection Table 5212 -- 5213 -- The device may communicate with a management station using 5214 -- SLIP. In order for the device to send traps via SLIP, it must 5215 -- be able to initiate a connection over the serial interface. The 5216 -- serialConnectionTable stores the parameters for such connection 5217 -- initiation. 5219 serialConnectionTable OBJECT-TYPE 5220 SYNTAX SEQUENCE OF SerialConnectionEntry 5221 MAX-ACCESS not-accessible 5222 STATUS deprecated 5223 DESCRIPTION 5224 "A list of serialConnectionEntries. 5226 This table has been deprecated as it has not had enough 5227 independent implementations to demonstrate interoperability to 5228 meet the requirements of a Draft Standard." 5229 ::= { probeConfig 14 } 5231 serialConnectionEntry OBJECT-TYPE 5232 SYNTAX SerialConnectionEntry 5233 MAX-ACCESS not-accessible 5234 STATUS deprecated 5235 DESCRIPTION 5236 "Configuration for a SLIP link over a serial line." 5237 INDEX { serialConnectIndex } 5238 ::= { serialConnectionTable 1 } 5240 SerialConnectionEntry ::= SEQUENCE { 5241 serialConnectIndex Integer32, 5242 serialConnectDestIpAddress IpAddress, 5243 serialConnectType INTEGER, 5244 serialConnectDialString ControlString, 5245 serialConnectSwitchConnectSeq ControlString, 5246 serialConnectSwitchDisconnectSeq ControlString, 5247 serialConnectSwitchResetSeq ControlString, 5248 serialConnectOwner OwnerString, 5249 serialConnectStatus RowStatus 5250 } 5252 serialConnectIndex OBJECT-TYPE 5253 SYNTAX Integer32 (1..65535) 5254 MAX-ACCESS not-accessible 5255 STATUS deprecated 5256 DESCRIPTION 5257 "A value that uniquely identifies this serialConnection 5258 entry." 5259 ::= { serialConnectionEntry 1 } 5261 serialConnectDestIpAddress OBJECT-TYPE 5262 SYNTAX IpAddress 5263 MAX-ACCESS read-create 5264 STATUS deprecated 5265 DESCRIPTION 5266 "The IP Address that can be reached at the other end of this 5267 serial connection. 5268 This object may not be modified if the associated 5269 serialConnectStatus object is equal to active(1)." 5270 ::= { serialConnectionEntry 2 } 5272 serialConnectType OBJECT-TYPE 5273 SYNTAX INTEGER { 5274 direct(1), 5275 modem(2), 5276 switch(3), 5277 modemSwitch(4) 5278 } 5279 MAX-ACCESS read-create 5280 STATUS deprecated 5281 DESCRIPTION 5282 "The type of outgoing connection to make. If this object 5283 has the value direct(1), then a direct serial connection 5284 is assumed. If this object has the value modem(2), 5285 then serialConnectDialString will be used to make a modem 5286 connection. If this object has the value switch(3), 5287 then serialConnectSwitchConnectSeq will be used to establish 5288 the connection over a serial data switch, and 5289 serialConnectSwitchDisconnectSeq will be used to terminate 5290 the connection. If this object has the value 5291 modem-switch(4), then a modem connection will be made first 5292 followed by the switch connection. 5294 This object may not be modified if the associated 5295 serialConnectStatus object is equal to active(1)." 5296 DEFVAL { direct } 5297 ::= { serialConnectionEntry 3 } 5299 serialConnectDialString OBJECT-TYPE 5300 SYNTAX ControlString (SIZE(0..255)) 5301 MAX-ACCESS read-create 5302 STATUS deprecated 5303 DESCRIPTION 5304 "A control string which specifies how to dial the phone 5305 number in order to establish a modem connection. The 5306 string should include dialing prefix and suffix. For 5307 example: ``^s^MATD9,888-1234^M'' will instruct the Probe 5308 to send a carriage return followed by the dialing prefix 5309 ``ATD'', the phone number ``9,888-1234'', and a carriage 5310 return as the dialing suffix. 5311 This object may not be modified if the associated 5312 serialConnectStatus object is equal to active(1)." 5313 ::= { serialConnectionEntry 4 } 5315 serialConnectSwitchConnectSeq OBJECT-TYPE 5316 SYNTAX ControlString (SIZE(0..255)) 5317 MAX-ACCESS read-create 5318 STATUS deprecated 5319 DESCRIPTION 5320 "A control string which specifies how to establish a 5321 data switch connection. 5322 This object may not be modified if the associated 5323 serialConnectStatus object is equal to active(1)." 5324 ::= { serialConnectionEntry 5 } 5326 serialConnectSwitchDisconnectSeq OBJECT-TYPE 5327 SYNTAX ControlString (SIZE(0..255)) 5328 MAX-ACCESS read-create 5329 STATUS deprecated 5330 DESCRIPTION 5331 "A control string which specifies how to terminate a 5332 data switch connection. 5333 This object may not be modified if the associated 5334 serialConnectStatus object is equal to active(1)." 5335 ::= { serialConnectionEntry 6 } 5337 serialConnectSwitchResetSeq OBJECT-TYPE 5338 SYNTAX ControlString (SIZE(0..255)) 5339 MAX-ACCESS read-create 5340 STATUS deprecated 5341 DESCRIPTION 5342 "A control string which specifies how to reset a data 5343 switch in the event of a timeout. 5344 This object may not be modified if the associated 5345 serialConnectStatus object is equal to active(1)." 5346 ::= { serialConnectionEntry 7 } 5348 serialConnectOwner OBJECT-TYPE 5349 SYNTAX OwnerString 5350 MAX-ACCESS read-create 5351 STATUS deprecated 5352 DESCRIPTION 5353 "The entity that configured this entry and is 5354 therefore using the resources assigned to it." 5355 ::= { serialConnectionEntry 8 } 5357 serialConnectStatus OBJECT-TYPE 5358 SYNTAX RowStatus 5359 MAX-ACCESS read-create 5360 STATUS deprecated 5361 DESCRIPTION 5362 "The status of this serialConnectionEntry. 5364 If the manager attempts to set this object to active(1) when 5365 the serialConnectType is set to modem(2) or modem-switch(4) 5366 and the serialConnectDialString is a zero-length string or 5367 cannot be correctly parsed as a ConnectString, the set 5368 request will be rejected with badValue(3). 5370 If the manager attempts to set this object to active(1) when 5371 the serialConnectType is set to switch(3) or modem-switch(4) 5372 and the serialConnectSwitchConnectSeq, 5373 the serialConnectSwitchDisconnectSeq, or 5374 the serialConnectSwitchResetSeq are zero-length strings 5375 or cannot be correctly parsed as ConnectStrings, the set 5376 request will be rejected with badValue(3). 5378 An entry may not exist in the active state unless all 5379 objects in the entry have an appropriate value." 5380 ::= { serialConnectionEntry 9 } 5382 -- 5383 -- Extensions to the RMON 1 MIB for RMON 2 devices 5384 -- 5385 -- These extensions include the standard LastCreateTime Textual 5386 -- Convention for all control tables, as well as an augmentation of 5387 -- the filter entry that provides variable-length offsets into 5388 -- packets. 5390 -- Each of the following, except for filterDroppedFrames, is a 5391 -- read-only object which, if implemented, automatically appears when 5392 -- the RMON1 row it is associated with is created. 5394 etherStats2Table OBJECT-TYPE 5395 SYNTAX SEQUENCE OF EtherStats2Entry 5396 MAX-ACCESS not-accessible 5397 STATUS current 5398 DESCRIPTION 5399 "Contains the RMON-2 augmentations to RMON-1." 5400 ::= { statistics 4 } 5402 etherStats2Entry OBJECT-TYPE 5403 SYNTAX EtherStats2Entry 5404 MAX-ACCESS not-accessible 5405 STATUS current 5406 DESCRIPTION 5407 "Contains the RMON-2 augmentations to RMON-1." 5408 AUGMENTS { etherStatsEntry } 5409 ::= { etherStats2Table 1 } 5411 EtherStats2Entry ::= SEQUENCE { 5412 etherStatsDroppedFrames Counter32, 5413 etherStatsCreateTime LastCreateTime 5414 } 5415 etherStatsDroppedFrames OBJECT-TYPE 5416 SYNTAX Counter32 5417 MAX-ACCESS read-only 5418 STATUS current 5419 DESCRIPTION 5420 "The total number of frames which were received by the probe 5421 and therefore not accounted for in the *StatsDropEvents, but 5422 for which the probe chose not to count for this entry for 5423 whatever reason. Most often, this event occurs when the probe 5424 is out of some resources and decides to shed load from this 5425 collection. 5427 This count does not include packets that were not counted 5428 because they had MAC-layer errors. 5430 Note that, unlike the dropEvents counter, this number is the 5431 exact number of frames dropped." 5432 ::= { etherStats2Entry 1 } 5434 etherStatsCreateTime OBJECT-TYPE 5435 SYNTAX LastCreateTime 5436 MAX-ACCESS read-only 5437 STATUS current 5438 DESCRIPTION 5439 "The value of sysUpTime when this control entry was last 5440 activated. This can be used by the management station to 5441 ensure that the table has not been deleted and recreated 5442 between polls." 5443 ::= { etherStats2Entry 2 } 5445 historyControl2Table OBJECT-TYPE 5446 SYNTAX SEQUENCE OF HistoryControl2Entry 5447 MAX-ACCESS not-accessible 5448 STATUS current 5449 DESCRIPTION 5450 "Contains the RMON-2 augmentations to RMON-1." 5451 ::= { history 5 } 5453 historyControl2Entry OBJECT-TYPE 5454 SYNTAX HistoryControl2Entry 5455 MAX-ACCESS not-accessible 5456 STATUS current 5457 DESCRIPTION 5458 "Contains the RMON-2 augmentations to RMON-1." 5460 AUGMENTS { historyControlEntry } 5461 ::= { historyControl2Table 1 } 5463 HistoryControl2Entry ::= SEQUENCE { 5464 historyControlDroppedFrames Counter32 5465 } 5467 historyControlDroppedFrames OBJECT-TYPE 5468 SYNTAX Counter32 5469 MAX-ACCESS read-only 5470 STATUS current 5471 DESCRIPTION 5472 "The total number of frames which were received by the probe 5473 and therefore not accounted for in the *StatsDropEvents, but 5474 for which the probe chose not to count for this entry for 5475 whatever reason. Most often, this event occurs when the probe 5476 is out of some resources and decides to shed load from this 5477 collection. 5479 This count does not include packets that were not counted 5480 because they had MAC-layer errors. 5482 Note that, unlike the dropEvents counter, this number is the 5483 exact number of frames dropped." 5484 ::= { historyControl2Entry 1 } 5486 hostControl2Table OBJECT-TYPE 5487 SYNTAX SEQUENCE OF HostControl2Entry 5488 MAX-ACCESS not-accessible 5489 STATUS current 5490 DESCRIPTION 5491 "Contains the RMON-2 augmentations to RMON-1." 5492 ::= { hosts 4 } 5494 hostControl2Entry OBJECT-TYPE 5495 SYNTAX HostControl2Entry 5496 MAX-ACCESS not-accessible 5497 STATUS current 5498 DESCRIPTION 5499 "Contains the RMON-2 augmentations to RMON-1." 5500 AUGMENTS { hostControlEntry } 5501 ::= { hostControl2Table 1 } 5503 HostControl2Entry ::= SEQUENCE { 5504 hostControlDroppedFrames Counter32, 5505 hostControlCreateTime LastCreateTime 5506 } 5508 hostControlDroppedFrames OBJECT-TYPE 5509 SYNTAX Counter32 5510 MAX-ACCESS read-only 5511 STATUS current 5512 DESCRIPTION 5513 "The total number of frames which were received by the probe 5514 and therefore not accounted for in the *StatsDropEvents, but 5515 for which the probe chose not to count for this entry for 5516 whatever reason. Most often, this event occurs when the probe 5517 is out of some resources and decides to shed load from this 5518 collection. 5520 This count does not include packets that were not counted 5521 because they had MAC-layer errors. 5523 Note that, unlike the dropEvents counter, this number is the 5524 exact number of frames dropped." 5525 ::= { hostControl2Entry 1 } 5527 hostControlCreateTime OBJECT-TYPE 5528 SYNTAX LastCreateTime 5529 MAX-ACCESS read-only 5530 STATUS current 5531 DESCRIPTION 5532 "The value of sysUpTime when this control entry was last 5533 activated. This can be used by the management station to 5534 ensure that the table has not been deleted and recreated 5535 between polls." 5536 ::= { hostControl2Entry 2 } 5538 matrixControl2Table OBJECT-TYPE 5539 SYNTAX SEQUENCE OF MatrixControl2Entry 5540 MAX-ACCESS not-accessible 5541 STATUS current 5542 DESCRIPTION 5543 "Contains the RMON-2 augmentations to RMON-1." 5544 ::= { matrix 4 } 5546 matrixControl2Entry OBJECT-TYPE 5547 SYNTAX MatrixControl2Entry 5548 MAX-ACCESS not-accessible 5549 STATUS current 5550 DESCRIPTION 5551 "Contains the RMON-2 augmentations to RMON-1." 5552 AUGMENTS { matrixControlEntry } 5553 ::= { matrixControl2Table 1 } 5555 MatrixControl2Entry ::= SEQUENCE { 5556 matrixControlDroppedFrames Counter32, 5557 matrixControlCreateTime LastCreateTime 5558 } 5560 matrixControlDroppedFrames OBJECT-TYPE 5561 SYNTAX Counter32 5562 MAX-ACCESS read-only 5563 STATUS current 5564 DESCRIPTION 5565 "The total number of frames which were received by the probe 5566 and therefore not accounted for in the *StatsDropEvents, but 5567 for which the probe chose not to count for this entry for 5568 whatever reason. Most often, this event occurs when the probe 5569 is out of some resources and decides to shed load from this 5570 collection. 5572 This count does not include packets that were not counted 5573 because they had MAC-layer errors. 5575 Note that, unlike the dropEvents counter, this number is the 5576 exact number of frames dropped." 5577 ::= { matrixControl2Entry 1 } 5579 matrixControlCreateTime OBJECT-TYPE 5580 SYNTAX LastCreateTime 5581 MAX-ACCESS read-only 5582 STATUS current 5583 DESCRIPTION 5584 "The value of sysUpTime when this control entry was last 5585 activated. This can be used by the management station to 5586 ensure that the table has not been deleted and recreated 5587 between polls." 5588 ::= { matrixControl2Entry 2 } 5590 channel2Table OBJECT-TYPE 5591 SYNTAX SEQUENCE OF Channel2Entry 5592 MAX-ACCESS not-accessible 5593 STATUS current 5594 DESCRIPTION 5595 "Contains the RMON-2 augmentations to RMON-1." 5596 ::= { filter 3 } 5598 channel2Entry OBJECT-TYPE 5599 SYNTAX Channel2Entry 5600 MAX-ACCESS not-accessible 5601 STATUS current 5602 DESCRIPTION 5603 "Contains the RMON-2 augmentations to RMON-1." 5604 AUGMENTS { channelEntry } 5605 ::= { channel2Table 1 } 5607 Channel2Entry ::= SEQUENCE { 5608 channelDroppedFrames Counter32, 5609 channelCreateTime LastCreateTime 5610 } 5612 channelDroppedFrames OBJECT-TYPE 5613 SYNTAX Counter32 5614 MAX-ACCESS read-only 5615 STATUS current 5616 DESCRIPTION 5617 "The total number of frames which were received by the probe 5618 and therefore not accounted for in the *StatsDropEvents, but 5619 for which the probe chose not to count for this entry for 5620 whatever reason. Most often, this event occurs when the probe 5621 is out of some resources and decides to shed load from this 5622 collection. 5624 This count does not include packets that were not counted 5625 because they had MAC-layer errors. 5627 Note that, unlike the dropEvents counter, this number is the 5628 exact number of frames dropped." 5629 ::= { channel2Entry 1 } 5631 channelCreateTime OBJECT-TYPE 5632 SYNTAX LastCreateTime 5633 MAX-ACCESS read-only 5634 STATUS current 5635 DESCRIPTION 5636 "The value of sysUpTime when this control entry was last 5637 activated. This can be used by the management station to 5638 ensure that the table has not been deleted and recreated 5639 between polls." 5640 ::= { channel2Entry 2 } 5642 tokenRingMLStats2Table OBJECT-TYPE 5643 SYNTAX SEQUENCE OF TokenRingMLStats2Entry 5644 MAX-ACCESS not-accessible 5645 STATUS deprecated 5646 DESCRIPTION 5647 "Contains the RMON-2 augmentations to RMON-1. 5649 This table has been deprecated as it has not had enough 5650 independent implementations to demonstrate interoperability to 5651 meet the requirements of a Draft Standard." 5652 ::= { statistics 5 } 5654 tokenRingMLStats2Entry OBJECT-TYPE 5655 SYNTAX TokenRingMLStats2Entry 5656 MAX-ACCESS not-accessible 5657 STATUS deprecated 5658 DESCRIPTION 5659 "Contains the RMON-2 augmentations to RMON-1." 5660 AUGMENTS { tokenRingMLStatsEntry } 5661 ::= { tokenRingMLStats2Table 1 } 5663 TokenRingMLStats2Entry ::= SEQUENCE { 5664 tokenRingMLStatsDroppedFrames Counter32, 5665 tokenRingMLStatsCreateTime LastCreateTime 5666 } 5668 tokenRingMLStatsDroppedFrames OBJECT-TYPE 5669 SYNTAX Counter32 5670 MAX-ACCESS read-only 5671 STATUS deprecated 5672 DESCRIPTION 5673 "The total number of frames which were received by the probe 5674 and therefore not accounted for in the *StatsDropEvents, but 5675 for which the probe chose not to count for this entry for 5676 whatever reason. Most often, this event occurs when the probe 5677 is out of some resources and decides to shed load from this 5678 collection. 5680 This count does not include packets that were not counted 5681 because they had MAC-layer errors. 5683 Note that, unlike the dropEvents counter, this number is the 5684 exact number of frames dropped." 5685 ::= { tokenRingMLStats2Entry 1 } 5687 tokenRingMLStatsCreateTime OBJECT-TYPE 5688 SYNTAX LastCreateTime 5689 MAX-ACCESS read-only 5690 STATUS deprecated 5691 DESCRIPTION 5692 "The value of sysUpTime when this control entry was last 5693 activated. This can be used by the management station to 5694 ensure that the table has not been deleted and recreated 5695 between polls." 5696 ::= { tokenRingMLStats2Entry 2 } 5698 tokenRingPStats2Table OBJECT-TYPE 5699 SYNTAX SEQUENCE OF TokenRingPStats2Entry 5700 MAX-ACCESS not-accessible 5701 STATUS deprecated 5702 DESCRIPTION 5703 "Contains the RMON-2 augmentations to RMON-1. 5705 This table has been deprecated as it has not had enough 5706 independent implementations to demonstrate interoperability to 5707 meet the requirements of a Draft Standard." 5708 ::= { statistics 6 } 5710 tokenRingPStats2Entry OBJECT-TYPE 5711 SYNTAX TokenRingPStats2Entry 5712 MAX-ACCESS not-accessible 5713 STATUS deprecated 5714 DESCRIPTION 5715 "Contains the RMON-2 augmentations to RMON-1." 5716 AUGMENTS { tokenRingPStatsEntry } 5717 ::= { tokenRingPStats2Table 1 } 5719 TokenRingPStats2Entry ::= SEQUENCE { 5720 tokenRingPStatsDroppedFrames Counter32, 5721 tokenRingPStatsCreateTime LastCreateTime 5722 } 5723 tokenRingPStatsDroppedFrames OBJECT-TYPE 5724 SYNTAX Counter32 5725 MAX-ACCESS read-only 5726 STATUS deprecated 5727 DESCRIPTION 5728 "The total number of frames which were received by the probe 5729 and therefore not accounted for in the *StatsDropEvents, but 5730 for which the probe chose not to count for this entry for 5731 whatever reason. Most often, this event occurs when the probe 5732 is out of some resources and decides to shed load from this 5733 collection. 5735 This count does not include packets that were not counted 5736 because they had MAC-layer errors. 5738 Note that, unlike the dropEvents counter, this number is the 5739 exact number of frames dropped." 5740 ::= { tokenRingPStats2Entry 1 } 5742 tokenRingPStatsCreateTime OBJECT-TYPE 5743 SYNTAX LastCreateTime 5744 MAX-ACCESS read-only 5745 STATUS deprecated 5746 DESCRIPTION 5747 "The value of sysUpTime when this control entry was last 5748 activated. This can be used by the management station to 5749 ensure that the table has not been deleted and recreated 5750 between polls." 5751 ::= { tokenRingPStats2Entry 2 } 5753 ringStationControl2Table OBJECT-TYPE 5754 SYNTAX SEQUENCE OF RingStationControl2Entry 5755 MAX-ACCESS not-accessible 5756 STATUS deprecated 5757 DESCRIPTION 5758 "Contains the RMON-2 augmentations to RMON-1. 5760 This table has been deprecated as it has not had enough 5761 independent implementations to demonstrate interoperability to 5762 meet the requirements of a Draft Standard." 5763 ::= { tokenRing 7 } 5765 ringStationControl2Entry OBJECT-TYPE 5766 SYNTAX RingStationControl2Entry 5767 MAX-ACCESS not-accessible 5768 STATUS deprecated 5769 DESCRIPTION 5770 "Contains the RMON-2 augmentations to RMON-1." 5771 AUGMENTS { ringStationControlEntry } 5772 ::= { ringStationControl2Table 1 } 5774 RingStationControl2Entry ::= SEQUENCE { 5775 ringStationControlDroppedFrames Counter32, 5776 ringStationControlCreateTime LastCreateTime 5777 } 5779 ringStationControlDroppedFrames OBJECT-TYPE 5780 SYNTAX Counter32 5781 MAX-ACCESS read-only 5782 STATUS deprecated 5783 DESCRIPTION 5784 "The total number of frames which were received by the probe 5785 and therefore not accounted for in the *StatsDropEvents, but 5786 for which the probe chose not to count for this entry for 5787 whatever reason. Most often, this event occurs when the probe 5788 is out of some resources and decides to shed load from this 5789 collection. 5791 This count does not include packets that were not counted 5792 because they had MAC-layer errors. 5794 Note that, unlike the dropEvents counter, this number is the 5795 exact number of frames dropped." 5796 ::= { ringStationControl2Entry 1 } 5798 ringStationControlCreateTime OBJECT-TYPE 5799 SYNTAX LastCreateTime 5800 MAX-ACCESS read-only 5801 STATUS deprecated 5802 DESCRIPTION 5803 "The value of sysUpTime when this control entry was last 5804 activated. This can be used by the management station to 5805 ensure that the table has not been deleted and recreated 5806 between polls." 5807 ::= { ringStationControl2Entry 2 } 5809 sourceRoutingStats2Table OBJECT-TYPE 5810 SYNTAX SEQUENCE OF SourceRoutingStats2Entry 5811 MAX-ACCESS not-accessible 5812 STATUS deprecated 5813 DESCRIPTION 5814 "Contains the RMON-2 augmentations to RMON-1. 5816 This table has been deprecated as it has not had enough 5817 independent implementations to demonstrate interoperability to 5818 meet the requirements of a Draft Standard." 5819 ::= { tokenRing 8 } 5821 sourceRoutingStats2Entry OBJECT-TYPE 5822 SYNTAX SourceRoutingStats2Entry 5823 MAX-ACCESS not-accessible 5824 STATUS deprecated 5825 DESCRIPTION 5826 "Contains the RMON-2 augmentations to RMON-1." 5827 AUGMENTS { sourceRoutingStatsEntry } 5828 ::= { sourceRoutingStats2Table 1 } 5830 SourceRoutingStats2Entry ::= SEQUENCE { 5831 sourceRoutingStatsDroppedFrames Counter32, 5832 sourceRoutingStatsCreateTime LastCreateTime 5833 } 5835 sourceRoutingStatsDroppedFrames OBJECT-TYPE 5836 SYNTAX Counter32 5837 MAX-ACCESS read-only 5838 STATUS deprecated 5839 DESCRIPTION 5840 "The total number of frames which were received by the probe 5841 and therefore not accounted for in the *StatsDropEvents, but 5842 for which the probe chose not to count for this entry for 5843 whatever reason. Most often, this event occurs when the probe 5844 is out of some resources and decides to shed load from this 5845 collection. 5847 This count does not include packets that were not counted 5848 because they had MAC-layer errors. 5850 Note that, unlike the dropEvents counter, this number is the 5851 exact number of frames dropped." 5852 ::= { sourceRoutingStats2Entry 1 } 5854 sourceRoutingStatsCreateTime OBJECT-TYPE 5855 SYNTAX LastCreateTime 5856 MAX-ACCESS read-only 5857 STATUS deprecated 5858 DESCRIPTION 5859 "The value of sysUpTime when this control entry was last 5860 activated. This can be used by the management station to 5861 ensure that the table has not been deleted and recreated 5862 between polls." 5863 ::= { sourceRoutingStats2Entry 2 } 5865 filter2Table OBJECT-TYPE 5866 SYNTAX SEQUENCE OF Filter2Entry 5867 MAX-ACCESS not-accessible 5868 STATUS current 5869 DESCRIPTION 5870 "Provides a variable-length packet filter feature to the 5871 RMON-1 filter table." 5872 ::= { filter 4 } 5874 filter2Entry OBJECT-TYPE 5875 SYNTAX Filter2Entry 5876 MAX-ACCESS not-accessible 5877 STATUS current 5878 DESCRIPTION 5879 "Provides a variable-length packet filter feature to the 5880 RMON-1 filter table." 5881 AUGMENTS { filterEntry } 5882 ::= { filter2Table 1 } 5884 Filter2Entry ::= SEQUENCE { 5885 filterProtocolDirDataLocalIndex Integer32, 5886 filterProtocolDirLocalIndex Integer32 5887 } 5889 filterProtocolDirDataLocalIndex OBJECT-TYPE 5890 SYNTAX Integer32 (0..2147483647) 5891 MAX-ACCESS read-create 5892 STATUS current 5893 DESCRIPTION 5894 "When this object is set to a non-zero value, the filter that 5895 it is associated with performs the following operations on 5896 every packet: 5898 1) - If the packet doesn't match the protocol directory entry 5899 identified by this object, discard the packet and exit 5900 (i.e., discard the packet if it is not of the identified 5901 protocol). 5902 2) - If the associated filterProtocolDirLocalIndex is non-zero 5903 and the packet doesn't match the protocol directory 5904 entry identified by that object, discard the packet and 5905 exit 5906 3) - If the packet matches, perform the regular filter 5907 algorithm as if the beginning of this named protocol is 5908 the beginning of the packet, potentially applying the 5909 filterOffset value to move further into the packet." 5910 DEFVAL { 0 } 5911 ::= { filter2Entry 1 } 5913 filterProtocolDirLocalIndex OBJECT-TYPE 5914 SYNTAX Integer32 (0..2147483647) 5915 MAX-ACCESS read-create 5916 STATUS current 5917 DESCRIPTION 5918 "When this object is set to a non-zero value, the filter that 5919 it is associated with will discard the packet if the packet 5920 doesn't match this protocol directory entry." 5921 DEFVAL { 0 } 5922 ::= { filter2Entry 2 } 5924 -- Conformance Macros 5926 rmon2MIBCompliances OBJECT IDENTIFIER ::= { rmonConformance 1 } 5927 rmon2MIBGroups OBJECT IDENTIFIER ::= { rmonConformance 2 } 5929 rmon2MIBCompliance MODULE-COMPLIANCE 5930 STATUS current 5931 DESCRIPTION 5932 "Describes the requirements for conformance to 5933 the RMON2 MIB" 5934 MODULE -- this module 5935 MANDATORY-GROUPS { protocolDirectoryGroup, 5936 protocolDistributionGroup, 5937 addressMapGroup, 5938 nlHostGroup, 5939 nlMatrixGroup, 5940 usrHistoryGroup, 5941 probeInformationGroup } 5943 OBJECT nlMatrixTopNControlRateBase 5944 SYNTAX INTEGER { 5945 nlMatrixTopNPkts(1), 5946 nlMatrixTopNOctets(2) 5947 } 5948 DESCRIPTION 5949 "Conformance to RMON2 requires only support for these 5950 values of nlMatrixTopNControlRateBase." 5952 GROUP rmon1EnhancementGroup 5953 DESCRIPTION 5954 "The rmon1EnhancementGroup is mandatory for systems 5955 which implement RMON [RFC2819]" 5956 GROUP rmon1EthernetEnhancementGroup 5957 DESCRIPTION 5958 "The rmon1EthernetEnhancementGroup is optional and is 5959 appropriate for systems that implement the Ethernet 5960 group of RMON [RFC2819]" 5961 ::= { rmon2MIBCompliances 1 } 5963 rmon2MIBApplicationLayerCompliance MODULE-COMPLIANCE 5964 STATUS current 5965 DESCRIPTION 5966 "Describes the requirements for conformance to 5967 the RMON2 MIB with Application Layer Enhancements." 5968 MODULE -- this module 5969 MANDATORY-GROUPS { protocolDirectoryGroup, 5970 protocolDistributionGroup, 5971 addressMapGroup, 5972 nlHostGroup, 5973 nlMatrixGroup, 5974 alHostGroup, 5975 alMatrixGroup, 5976 usrHistoryGroup, 5977 probeInformationGroup } 5979 OBJECT nlMatrixTopNControlRateBase 5980 SYNTAX INTEGER { 5981 nlMatrixTopNPkts(1), 5982 nlMatrixTopNOctets(2) 5983 } 5984 DESCRIPTION 5985 "Conformance to RMON2 requires only support for these 5986 values of nlMatrixTopNControlRateBase." 5988 OBJECT alMatrixTopNControlRateBase 5989 SYNTAX INTEGER { 5990 alMatrixTopNTerminalsPkts(1), 5991 alMatrixTopNTerminalsOctets(2), 5992 alMatrixTopNAllPkts(3), 5993 alMatrixTopNAllOctets(4) 5994 } 5995 DESCRIPTION 5996 "Conformance to RMON2 requires only support for these 5997 values of alMatrixTopNControlRateBase." 5999 GROUP rmon1EnhancementGroup 6000 DESCRIPTION 6001 "The rmon1EnhancementGroup is mandatory for systems 6002 which implement RMON [RFC2819]" 6003 GROUP rmon1EthernetEnhancementGroup 6004 DESCRIPTION 6005 "The rmon1EthernetEnhancementGroup is optional and is 6006 appropriate for systems that implement the Ethernet 6007 group of RMON [RFC2819]" 6008 ::= { rmon2MIBCompliances 2 } 6010 protocolDirectoryGroup OBJECT-GROUP 6011 OBJECTS { protocolDirLastChange, 6012 protocolDirLocalIndex, protocolDirDescr, 6013 protocolDirType, protocolDirAddressMapConfig, 6014 protocolDirHostConfig, protocolDirMatrixConfig, 6015 protocolDirOwner, protocolDirStatus } 6016 STATUS current 6017 DESCRIPTION 6018 "Lists the inventory of protocols the probe has the capability 6019 of monitoring and allows the addition, deletion, and 6020 configuration of entries in this list." 6021 ::= { rmon2MIBGroups 1 } 6023 protocolDistributionGroup OBJECT-GROUP 6024 OBJECTS { protocolDistControlDataSource, 6025 protocolDistControlDroppedFrames, 6026 protocolDistControlCreateTime, 6027 protocolDistControlOwner, protocolDistControlStatus, 6028 protocolDistStatsPkts, protocolDistStatsOctets } 6029 STATUS current 6030 DESCRIPTION 6031 "Collects the relative amounts of octets and packets for the 6032 different protocols detected on a network segment." 6033 ::= { rmon2MIBGroups 2 } 6035 addressMapGroup OBJECT-GROUP 6036 OBJECTS { addressMapInserts, addressMapDeletes, 6037 addressMapMaxDesiredEntries, 6038 addressMapControlDataSource, 6039 addressMapControlDroppedFrames, 6040 addressMapControlOwner, addressMapControlStatus, 6041 addressMapPhysicalAddress, 6042 addressMapLastChange } 6043 STATUS current 6044 DESCRIPTION 6045 "Lists MAC address to network address bindings discovered by 6046 the probe and what interface they were last seen on." 6047 ::= { rmon2MIBGroups 3 } 6049 nlHostGroup OBJECT-GROUP 6050 OBJECTS { hlHostControlDataSource, 6051 hlHostControlNlDroppedFrames, hlHostControlNlInserts, 6052 hlHostControlNlDeletes, 6053 hlHostControlNlMaxDesiredEntries, 6054 hlHostControlAlDroppedFrames, hlHostControlAlInserts, 6055 hlHostControlAlDeletes, 6056 hlHostControlAlMaxDesiredEntries, hlHostControlOwner, 6057 hlHostControlStatus, nlHostInPkts, nlHostOutPkts, 6058 nlHostInOctets, nlHostOutOctets, 6059 nlHostOutMacNonUnicastPkts, nlHostCreateTime } 6060 STATUS current 6061 DESCRIPTION 6062 "Counts the amount of traffic sent from and to each network 6063 address discovered by the probe. Note that while the 6064 hlHostControlTable also has objects that control an optional 6065 alHostTable, implementation of the alHostTable is not required 6066 to fully implement this group." 6067 ::= { rmon2MIBGroups 4 } 6069 nlMatrixGroup OBJECT-GROUP 6070 OBJECTS { hlMatrixControlDataSource, 6071 hlMatrixControlNlDroppedFrames, 6072 hlMatrixControlNlInserts, hlMatrixControlNlDeletes, 6073 hlMatrixControlNlMaxDesiredEntries, 6074 hlMatrixControlAlDroppedFrames, 6075 hlMatrixControlAlInserts, hlMatrixControlAlDeletes, 6076 hlMatrixControlAlMaxDesiredEntries, 6077 hlMatrixControlOwner, hlMatrixControlStatus, 6078 nlMatrixSDPkts, nlMatrixSDOctets, nlMatrixSDCreateTime, 6079 nlMatrixDSPkts, nlMatrixDSOctets, nlMatrixDSCreateTime, 6080 nlMatrixTopNControlMatrixIndex, 6081 nlMatrixTopNControlRateBase, 6082 nlMatrixTopNControlTimeRemaining, 6083 nlMatrixTopNControlGeneratedReports, 6084 nlMatrixTopNControlDuration, 6085 nlMatrixTopNControlRequestedSize, 6086 nlMatrixTopNControlGrantedSize, 6087 nlMatrixTopNControlStartTime, 6088 nlMatrixTopNControlOwner, nlMatrixTopNControlStatus, 6089 nlMatrixTopNProtocolDirLocalIndex, 6090 nlMatrixTopNSourceAddress, nlMatrixTopNDestAddress, 6091 nlMatrixTopNPktRate, nlMatrixTopNReversePktRate, 6092 nlMatrixTopNOctetRate, nlMatrixTopNReverseOctetRate } 6093 STATUS current 6094 DESCRIPTION 6095 "Counts the amount of traffic sent between each pair of 6096 network addresses discovered by the probe. Note that while the 6097 hlMatrixControlTable also has objects that control optional 6098 alMatrixTables, implementation of the alMatrixTables is not 6099 required to fully implement this group." 6100 ::= { rmon2MIBGroups 5 } 6102 alHostGroup OBJECT-GROUP 6103 OBJECTS { alHostInPkts, alHostOutPkts, 6104 alHostInOctets, alHostOutOctets, alHostCreateTime } 6105 STATUS current 6106 DESCRIPTION 6107 "Counts the amount of traffic, by protocol, sent from and to 6108 each network address discovered by the probe. Implementation 6109 of this group requires implementation of the Network Layer 6110 Host Group." 6111 ::= { rmon2MIBGroups 6 } 6113 alMatrixGroup OBJECT-GROUP 6114 OBJECTS { alMatrixSDPkts, alMatrixSDOctets, alMatrixSDCreateTime, 6115 alMatrixDSPkts, alMatrixDSOctets, alMatrixDSCreateTime, 6116 alMatrixTopNControlMatrixIndex, 6117 alMatrixTopNControlRateBase, 6118 alMatrixTopNControlTimeRemaining, 6119 alMatrixTopNControlGeneratedReports, 6120 alMatrixTopNControlDuration, 6121 alMatrixTopNControlRequestedSize, 6122 alMatrixTopNControlGrantedSize, 6123 alMatrixTopNControlStartTime, 6124 alMatrixTopNControlOwner, alMatrixTopNControlStatus, 6125 alMatrixTopNProtocolDirLocalIndex, 6126 alMatrixTopNSourceAddress, alMatrixTopNDestAddress, 6127 alMatrixTopNAppProtocolDirLocalIndex, 6128 alMatrixTopNPktRate, alMatrixTopNReversePktRate, 6129 alMatrixTopNOctetRate, alMatrixTopNReverseOctetRate } 6130 STATUS current 6131 DESCRIPTION 6132 "Counts the amount of traffic, by protocol, sent between each 6133 pair of network addresses discovered by the 6134 probe. Implementation of this group requires implementation of 6135 the Network Layer Matrix Group." 6136 ::= { rmon2MIBGroups 7 } 6138 usrHistoryGroup OBJECT-GROUP 6139 OBJECTS { usrHistoryControlObjects, 6140 usrHistoryControlBucketsRequested, 6141 usrHistoryControlBucketsGranted, 6142 usrHistoryControlInterval, 6143 usrHistoryControlOwner, usrHistoryControlStatus, 6144 usrHistoryObjectVariable, usrHistoryObjectSampleType, 6145 usrHistoryIntervalStart, usrHistoryIntervalEnd, 6146 usrHistoryAbsValue, usrHistoryValStatus } 6147 STATUS current 6148 DESCRIPTION 6149 "The usrHistoryGroup provides user-defined collection of 6150 historical information from MIB objects on the probe." 6151 ::= { rmon2MIBGroups 8 } 6153 probeInformationGroup OBJECT-GROUP 6154 OBJECTS { probeCapabilities, 6155 probeSoftwareRev, probeHardwareRev, probeDateTime } 6156 STATUS current 6157 DESCRIPTION 6158 "This group describes various operating parameters of the 6159 probe as well as controlling the local time of the probe." 6160 ::= { rmon2MIBGroups 9 } 6162 probeConfigurationGroup OBJECT-GROUP 6163 OBJECTS { probeResetControl, probeDownloadFile, 6164 probeDownloadTFTPServer, probeDownloadAction, 6165 probeDownloadStatus, 6166 serialMode, serialProtocol, serialTimeout, 6167 serialModemInitString, serialModemHangUpString, 6168 serialModemConnectResp, serialModemNoConnectResp, 6169 serialDialoutTimeout, serialStatus, 6170 netConfigIPAddress, netConfigSubnetMask, 6171 netConfigStatus, netDefaultGateway, 6172 trapDestCommunity, trapDestProtocol, trapDestAddress, 6173 trapDestOwner, trapDestStatus, 6174 serialConnectDestIpAddress, serialConnectType, 6175 serialConnectDialString, serialConnectSwitchConnectSeq, 6176 serialConnectSwitchDisconnectSeq, 6177 serialConnectSwitchResetSeq, 6178 serialConnectOwner, serialConnectStatus } 6179 STATUS deprecated 6180 DESCRIPTION 6181 "This group controls the configuration of various operating 6182 parameters of the probe. This group is not referenced by any 6183 MODULE-COMPLIANCE macro because it is 'grandfathered' from 6184 more recent MIB review rules that would require it." 6185 ::= { rmon2MIBGroups 10 } 6187 rmon1EnhancementGroup OBJECT-GROUP 6188 OBJECTS { historyControlDroppedFrames, hostControlDroppedFrames, 6189 hostControlCreateTime, matrixControlDroppedFrames, 6190 matrixControlCreateTime, channelDroppedFrames, 6191 channelCreateTime, filterProtocolDirDataLocalIndex, 6192 filterProtocolDirLocalIndex } 6193 STATUS current 6194 DESCRIPTION 6195 "This group adds some enhancements to RMON-1 that help 6196 management stations." 6197 ::= { rmon2MIBGroups 11 } 6199 rmon1EthernetEnhancementGroup OBJECT-GROUP 6200 OBJECTS { etherStatsDroppedFrames, etherStatsCreateTime } 6201 STATUS current 6202 DESCRIPTION 6203 "This group adds some enhancements to RMON-1 that help 6204 management stations." 6205 ::= { rmon2MIBGroups 12 } 6207 rmon1TokenRingEnhancementGroup OBJECT-GROUP 6208 OBJECTS { tokenRingMLStatsDroppedFrames, 6209 tokenRingMLStatsCreateTime, 6210 tokenRingPStatsDroppedFrames, tokenRingPStatsCreateTime, 6211 ringStationControlDroppedFrames, 6212 ringStationControlCreateTime, 6213 sourceRoutingStatsDroppedFrames, 6214 sourceRoutingStatsCreateTime } 6215 STATUS deprecated 6216 DESCRIPTION 6217 "This group adds some enhancements to RMON-1 that help 6218 management stations. This group is not referenced by any 6219 MODULE-COMPLIANCE macro because it is 'grandfathered' from 6220 more recent MIB review rules that would require it." 6221 ::= { rmon2MIBGroups 13 } 6222 END 6223 7. Security Considerations 6225 In order to implement this MIB, a probe must capture all 6226 packets on the locally-attached network, including packets 6227 between third parties. These packets are analyzed to collect 6228 network addresses, protocol usage information, and 6229 conversation statistics. Data of this nature may be considered 6230 sensitive in some environments. In such environments the 6231 administrator may wish to restrict SNMP access to the probe. 6233 The usrHistoryGroup periodically samples the values of user- 6234 specified variables on the probe and stores them in another 6235 table. Since the access-control specified for stored snapshot 6236 may be different than the access-control for the sampled 6237 variable, the agent MUST ensure that usrHistoryObjectVariable 6238 is not writable in MIB views that don't already have read 6239 access to the entire agent. Because the access control 6240 configuration can change over time, information could later be 6241 deemed sensitive that would still be accessible to this 6242 function. For this reason, an agent SHOULD check the access 6243 control on every sample. If an agent doesn't implement the 6244 latter check, there is a potential for sensitive information 6245 to be revealed. 6247 A probe implementing this MIB is likely to also implement RMON 6248 [RFC2819], which includes functions for returning the contents 6249 of captured packets, potentially including sensitive user data 6250 or passwords. It is recommended that SNMP access to these 6251 functions be restricted. 6253 There are a number of management objects defined in this MIB 6254 that have a MAX-ACCESS clause of read-write and/or read- 6255 create. Such objects may be considered sensitive or 6256 vulnerable in some network environments. The support for SET 6257 operations in a non-secure environment without proper 6258 protection can have a negative effect on network operations. 6260 Some of the readable objects in this MIB module (i.e., objects 6261 with a MAX-ACCESS other than not-accessible) may be considered 6262 sensitive or vulnerable in some network environments. It is 6263 thus important to control even GET and/or NOTIFY access to 6264 these objects and possibly to even encrypt the values of these 6265 objects when sending them over the network via SNMP. 6267 SNMP versions prior to SNMPv3 did not include adequate 6268 security. Even if the network itself is secure (for example 6269 by using IPSec), even then, there is no control as to who on 6270 the secure network is allowed to access and GET/SET 6271 (read/change/create/delete) the objects in this MIB module. 6273 It is RECOMMENDED that implementers consider the security 6274 features as provided by the SNMPv3 framework (see [RFC3410], 6275 section 8), including full support for the SNMPv3 6276 cryptographic mechanisms (for authentication and privacy). 6278 Further, deployment of SNMP versions prior to SNMPv3 is NOT 6279 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and 6280 to enable cryptographic security. It is then a 6281 customer/operator responsibility to ensure that the SNMP 6282 entity giving access to an instance of this MIB module is 6283 properly configured to give access to the objects only to 6284 those principals (users) that have legitimate rights to indeed 6285 GET or SET (change/create/delete) them. 6287 8. IANA Considerations 6289 No IANA actions are necessary. 6291 9. Appendix - TimeFilter Implementation Notes 6293 1) Theory of Operation 6295 The TimeFilter mechanism allows an NMS to reduce the number of 6296 SNMP transactions required for a 'table-update' operation, by 6297 retrieving only the rows that have changed since a specified 6298 time (usually the last poll time). Polling of tables that 6299 incorporate a 'TimeFilter' INDEX can be reduced to a 6300 theoretical minimum (if used correctly). It can be easily 6301 implemented by an agent in a way independent of the number of 6302 NMS applications using the same time-filtered table. 6304 Although the name 'TimeFilter' may imply that a history of 6305 change events is maintained by the agent, this is not the 6306 case. A time-filtered-value represents the current value of 6307 the object instance, not the 'saved' value at the time 6308 indicated by the TimeFilter INDEX value. Note that TimeFilter 6309 objects only appear in INDEX clauses (always not-accessible), 6310 so their value is never retrieved. By design, the actual value 6311 of a TimeFilter instance is not in itself meaningful (it's not 6312 a 'last-change-timestamp'). 6314 The TimeFilter is a boolean filtering function applied in 6315 internal Get* PDU processing. If the 'last-change-time' of the 6316 specified instance is less than the particular TimeFilter 6317 INDEX value, then the instance is considered 'not-present', 6318 and it is skipped for GetNext and GetBulk PDUs, or a 6319 'noSuchInstance' exception is returned for Get PDUs. 6321 For TimeFilter purposes: 6322 - a row is created when an accessible column is created 6323 within 6324 the row. 6325 - a column that is created or deleted causes the TimeFilter 6326 to 6327 to update the time-stamp, only because the value of the 6328 column 6329 is changing (non-existent <-> some value). 6330 - a row is deleted when all accessible columns are deleted. 6331 This 6332 event is not detectable with TimeFilter, and deleted rows 6333 are 6334 not retrievable with SNMP. 6336 1.1) Agent Implementation of a Time-Filtered Table 6338 In implementation, the time-filtered rows (one for each tick 6339 of sysUpTime) are only conceptual. The agent simply filters a 6340 real table based on: 6341 * the current value of sysUpTime 6342 * the TimeFilter value passed in the varbind 6343 * the last-update timestamp of each requested row 6344 (agent implementation requirement) 6346 For example, to implement a time-filtered table row (e.g., set 6347 of counters), an agent maintains a timestamp in a 32-bit 6348 storage location, initialized to zero. This is in addition to 6349 whatever instrumentation is needed for the set of counters. 6351 Each time one of the counters is updated, the current value of 6352 sysUpTime is recorded in the associated timestamp. If this is 6353 not possible or practical, then a background polling process 6354 must 'refresh' the timestamp by sampling counter values and 6355 comparing them to recorded samples. The timestamp update must 6356 occur within 5 seconds of the actual change event. 6358 When an agent receives a Get, GetNext, or GetBulk PDU 6359 requesting a time-filtered instance, after the agent has 6360 determined that the instance is within the specified MIB view, 6361 the following conceptual test is applied to determine if the 6362 object is returned or filtered: 6364 /* return TRUE if the object is present */ 6365 boolean time_filter_test ( 6366 TimeFilter last_modified_timestamp, 6367 TimeFilter index_value_in_pdu ) 6368 { 6369 if (last_modified_timestamp < index_value_in_pdu) 6370 return FALSE; 6371 else 6372 return TRUE; 6373 } 6375 The agent applies this function regardless of the 6376 lastActivationTime of the conceptual row in question. In other 6377 words, counter discontinuities are ignored (i.e. conceptual 6378 row deleted and then re-created later). An agent should 6379 consider a object instance 'changed' when it is created 6380 (either at restart time for scalars and static objects, or 6381 row-creation-time for dynamic tables). 6383 Note that using a timeFilter INDEX value of zero removes the 6384 filtering functionality, as the instance will always be 6385 'present' according to the test above. 6387 After some deployment experience, it has been determined that 6388 a time-filtered table is more efficient to use if the agent 6389 stops a "MIB walk" operation after one time-filtered entry. 6390 That is, a GetNext or GetBulk operation will provide one pass 6391 through a given table, i.e., the agent will continue to the 6392 next object or table, instead of incrementing a TimeMark INDEX 6393 value, even if there exists higher TimeMark values which are 6394 valid for the same conceptual row. 6396 It is acceptable for an agent to implement a time-filtered 6397 table in this manner or in the traditional manner (i.e., every 6398 conceptual time-filtered instance is returned in GetNext and 6399 GetBulk PDU responses). 6401 1.2) NMS Implementation of a Time-Filtered Table 6403 The particular TimeFilter INDEX values used by an NMS reflect 6404 the polling interval of the NMS, relative to the particular 6405 agent's notion of sysUpTime. 6407 An NMS needs to maintain one timestamp variable per agent 6408 (initialized to zero) for an arbitrary group of time-filtered 6409 MIB objects that are gathered together in the same PDU. Each 6410 time the Get* PDU is sent, a request for sysUpTime is 6411 included. The retrieved sysUpTime value is used as the 6412 timeFilter value in the next polling cycle. If a polling sweep 6413 of a time-filtered group of objects requires more than one 6414 SNMP transaction, then the sysUpTime value retrieved in the 6415 first GetResponse PDU of the polling sweep is saved as the 6416 next timeFilter value. 6418 The actual last-update time of a given object is not indicated 6419 in the returned GetResponse instance identifier, but rather 6420 the timeFilter value passed in the Get*Request PDU is 6421 returned. 6423 A "time-filtered get-next/bulk-sweep", done once per polling 6424 cycle, is a series of GetNext or GetBulk transactions, and is 6425 over when one of the following events occurs: 6426 1) the TimeFilter index value returned in the GetResponse is 6427 different than the TimeFilter index value passed in the 6428 GetNext or GetBulk request. Counter values will still be 6429 returned beyond this point (until the last-change-time is 6430 reached), but most likely the same values will be 6431 returned. 6432 2) the return PDU includes instances lexigraphically greater 6433 than the objects expected (i.e. same GetNext semantics as 6434 if the TimeFilter wasn't there) 6435 3) a noSuchName or other exception/error is returned. 6437 Note that the use of a time-filtered table in combination with 6438 a GetRequest PDU neutralizes any optimization that otherwise 6439 might be achieved with the TimeFilter. Either the current 6440 time-filtered object-value is returned, or, if there is no 6441 time-filtered object-value instance, then a 'noSuchInstance' 6442 exception (SNMPv2c or SNMPv3) or 'noSuchName' error (SNMPv1) 6443 is returned. 6445 2) TimeFilter Example 6447 The following example demonstrates how an NMS and Agent might 6448 use a table with a TimeFilter object in the INDEX. A static 6449 table is assumed to keep the example simple, but dynamic 6450 tables can also be supported. 6452 2.1) General Assumptions 6454 fooEntry INDEX { fooTimeMark, fooIfIndex } 6455 FooEntry = SEQUENCE { 6456 fooTimeMark TimeFilter, 6457 fooIfIndex Integer32, 6458 fooCounts Counter32 6459 } 6461 The NMS polls the fooTable every 15 seconds and the 6462 baseline poll occurs when the agent has been up for 6463 6 seconds, and the NMS has been up for 10 seconds. 6465 There are 2 static rows in this table at system 6466 initialization (fooCounts.0.1 and fooCounts.0.2). 6468 Row 1 was updated as follows: 6469 SysUpTime fooCounts.*.1 value 6470 500 1 6471 900 2 6472 2300 3 6474 Row 2 was updated as follows: 6475 SysUpTime fooCounts.*.2 value 6476 1100 1 6477 1400 2 6479 2.2) SNMP Transactions from NMS Perspective 6481 Time nms-1000: 6482 # NMS baseline poll -- get everything since last agent 6483 # restart - TimeFilter == 0 6485 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6486 fooCounts.0); 6487 returns: 6488 sysUpTime.0 == 600 6489 fooCounts.0.1 == 1 # incremented at time 500 6490 fooCounts.0.2 == 0 # visible; created at time 0 6492 Time nms-2500: 6493 # NMS 1st poll 6494 # TimeFilter index == 600 6496 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6497 fooCounts.600); 6498 returns: 6499 sysUpTime.0 == 2100 6500 fooCounts.600.1 == 2 # incremented at time 900 6501 fooCounts.601.1 == 2 # indicates end of sweep 6503 Time nms-4000: 6504 # NMS 2nd poll 6505 # TimeFilter == 2100 6507 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6508 fooCounts.2100); 6509 returns: 6510 sysUpTime.0 == 3600 6511 fooCounts.2100.1 == 3 # incremented at time 2300 6512 fooCounts.2102.1 == 3 # indicates end-of-sweep 6514 # the counter value for row 2 is not returned because 6515 # it hasn't changed since sysUpTime == 2100. 6516 # The next timetick value for row 1 is returned instead 6518 Time nms-5500: 6519 # NMS 3rd poll 6520 # TimeFilter == 3600 6522 get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6523 fooCounts.3600); 6524 returns: 6525 sysUpTime.0 == 5100 6526 some-instance-outside-the-fooTable == 6527 some-instance-outside-the-fooTable == 6529 # no 'fooTable' counter values at all are returned 6530 # because neither counter has been updated since 6531 # sysUpTime == 3600 6533 2.3) Transactions and TimeFilter Maintenance: Agent 6534 Perspective 6536 Time agt-0: 6537 # initialize fooTable 6538 fooCounts.1 = 0; changed.1 = 0; 6539 fooCounts.2 = 0; changed.2 = 0; 6541 Time agt-500: 6542 # increment fooCounts.1 6543 ++fooCounts.1; changed.1 = 500; 6545 Time agt-600 6546 # answer get-bulk 6547 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6548 # fooCounts.0); 6549 # (changed >= 0) 6550 # return both counters 6552 Time agt-900: 6553 # increment fooCounts.1 6554 ++fooCounts.1; changed.1 = 900; 6556 Time agt-1100: 6557 # increment fooCounts.2 6558 ++fooCounts.2; changed.2 = 1100; 6560 Time agt-1400: 6561 # increment fooCounts.2 6562 ++fooCounts.2; changed.2 = 1400; 6564 Time agt-2100 6565 # answer get-bulk 6566 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6567 # fooCounts.600); 6568 # (changed >= 600) 6569 # return both counters 6571 Time agt-2300: 6572 # increment fooCounts.1 6573 ++fooCounts.1; changed.1 = 2300; 6575 Time agt-3600: 6576 # answer get-bulk 6577 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6578 # fooCounts.2100); 6579 # (changed >= 2100) 6580 # return only fooCounts.1 from the fooTable--twice 6582 Time agt-5100: 6583 # answer get-bulk 6584 # get-bulk(nonRptrs=1, maxReps=2, sysUpTime.0, 6585 # fooCounts.3600); 6586 # (changed >= 3600) 6587 # return lexigraphically-next two MIB instances 6589 10. Changes since RFC 2021 6591 This version updates the proposed-standard version of the 6592 RMON2 MIB (published as RFC 2021) by adding 2 new enumerations 6593 to the nlMatrixTopNControlRateBase object and 4 new 6594 enumerations to the alMatrixTopNControlRateBase object. These 6595 new enumerations support the creation of high capacity topN 6596 reports in the High Capacity RMON MIB [RFC3273]. 6598 Additionally, the following objects have been deprecated as 6599 they have not had enough independent implementations to 6600 demonstrate interoperability to meet the requirements of a 6601 Draft Standard: 6603 probeDownloadFile 6604 probeDownloadTFTPServer 6605 probeDownloadAction 6606 probeDownloadStatus 6607 serialMode 6608 serialProtocol 6609 serialTimeout 6610 serialModemInitString 6611 serialModemHangUpString 6612 serialModemConnectResp 6613 serialModemNoConnectResp 6614 serialDialoutTimeout 6615 serialStatus 6616 serialConnectDestIpAddress 6617 serialConnectType 6618 serialConnectDialString 6619 serialConnectSwitchConnectSeq 6620 serialConnectSwitchDisconnectSeq 6621 serialConnectSwitchResetSeq 6622 serialConnectOwner 6623 serialConnectStatus 6624 netConfigIPAddress 6625 netConfigSubnetMask 6626 netConfigStatus 6627 netDefaultGateway 6628 tokenRingMLStats2DroppedFrames 6629 tokenRingMLStats2CreateTime 6630 tokenRingPStats2DroppedFrames 6631 tokenRingPStats2CreateTime 6632 ringStationControl2DroppedFrames 6633 ringStationControl2CreateTime 6634 sourceRoutingStats2DroppedFrames 6635 sourceRoutingStats2CreateTime 6636 trapDestIndex 6637 trapDestCommunity 6638 trapDestProtocol 6639 trapDestAddress 6640 trapDestOwner 6641 trapDestStatus 6643 In addition, two corrections were made. The LastCreateTime 6644 Textual Convention had been defined with a base type of 6645 another textual convention which isn't allowed in SMIv2. The 6646 definition has been modified to use TimeTicks as the base 6647 type. 6649 Further, the SerialConfigEntry SEQUENCE definition included 6650 sub-typing information that is not allowed in SMIv2. This 6651 information has been deleted. Ranges were added to a number of 6652 objects and textual-conventions to constrain their maximum 6653 (and sometimes minimum) sizes. The addition of these ranges 6654 documents existing practice for 6655 these objects. These objects are: 6656 ControlString 6657 protocolDirID 6658 protocolDirParameters 6659 addressMapNetworkAddress 6660 nlHostAddress 6661 nlMatrixSDSourceAddress 6662 nlMatrixSDDestAddress 6663 nlMatrixDSSourceAddress 6664 nlMatrixDSDestAddress 6665 nlMatrixTopNSourceAddress 6666 nlMatrixTopNDestAddress 6667 alHostEntry 6668 alMatrixSDEntry 6669 alMatrixDSEntry 6670 alMatrixTopNSourceAddress 6671 alMatrixTopNDestAddress 6673 Finally, the TimeFilter TC has been updated to encourage agent 6674 implementations that allow a MIB walk to behave well even when 6675 performed by an application that is not aware of the special 6676 TimeFilter semantics. 6678 11. Acknowledgments 6680 This document was produced by the IETF Remote Network 6681 Monitoring Working Group. 6683 The TimeFilter mechanism was invented and documented by Jeanne 6684 Haney. 6686 The User History group was created by Andy Bierman. 6688 12. Author's Address 6690 Steve Waldbusser 6692 Phone: +1 650-948-6500 6693 Fax: +1 650-745-0671 6694 EMail: waldbusser@nextbeacon.com 6695 13. References 6697 13.1. Normative References 6699 [RFC2578] 6700 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6701 Rose, M. and S. Waldbusser, "Structure of Management 6702 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 6703 1999. 6705 [RFC2579] 6706 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6707 Rose, M. and S. Waldbusser, "Textual Conventions for 6708 SMIv2", STD 58, RFC 2579, April 1999. 6710 [RFC2580] 6711 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 6712 Rose, M. and S. Waldbusser, "Conformance Statements for 6713 SMIv2", STD 58, RFC 2580, April 1999. 6715 [RFC2819] 6716 Waldbusser, S., "Remote Network Monitoring MIB", RFC 6717 2819, Lucent Technologies, May 2000. 6719 [RFC3273] 6720 Waldbusser, S., "RMON for High Capacity Networks", RFC 6721 3273, July 2002. 6723 [RFC3417] 6724 Presuhn, R., "Transport Mappings for the Simple Network 6725 Management Protocol (SNMP)", STD 62, RFC 3417, December 6726 2002. 6728 [RFC2863] 6729 McCloghrie, K. and F. Kastenholz, "The Interfaces Group 6730 MIB", RFC 2863, Cisco Systems, Argon Networks, June 2000. 6732 [RFC1513] 6733 Waldbusser, S., "Token Ring Extensions to the Remote 6734 Network Monitoring MIB", RFC 1513, September 1993. 6736 13.2. Informative References 6738 [RFC3410] 6739 Case, J., Mundy, R., Partain, D. and B. Stewart, 6740 "Introduction and Applicability Statements for Internet 6741 Standard Management Framework", RFC 3410, December 2002. 6743 [RFC2108] 6744 De Graaf, K., Romascanu, D., McMaster, D. and K. 6745 McCloghrie, "Definition of Managed Objects for IEEE 802.3 6746 Repeater Devices using SMIv2", RFC 2108, February 1997. 6748 [RFC3414] 6749 Blumenthal, U. and B. Wijnen, "The User-Based Security 6750 Model (USM) for Version 3 of the Simple Network 6751 Management Protocol (SNMPv3)", STD 62, RFC 3414, December 6752 2002. 6754 [RFC3415] 6755 Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based 6756 Access Control Model (VACM) for the Simple Network 6757 Management Protocol (SNMP)", STD 62, RFC 3415, December 6758 2002. 6760 14. Full Copyright Statement 6762 Copyright (C) The Internet Society (2005). 6764 This document is subject to the rights, licenses and 6765 restrictions contained in BCP 78, and except as set forth 6766 therein, the authors retain all their rights. 6768 This document and the information contained herein are 6769 provided on an "AS IS" basis and THE CONTRIBUTOR, THE 6770 ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), 6771 THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE 6772 DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 6773 LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN 6774 WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 6775 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 6777 Intellectual Property 6779 The IETF takes no position regarding the validity or scope of 6780 any Intellectual Property Rights or other rights that might be 6781 claimed to pertain to the implementation or use of the 6782 technology described in this document or the extent to which 6783 any license under such rights might or might not be available; 6784 nor does it represent that it has made any independent effort 6785 to identify any such rights. Information on the procedures 6786 with respect to rights in RFC documents can be found in BCP 78 6787 and BCP 79. 6789 Copies of IPR disclosures made to the IETF Secretariat and any 6790 assurances of licenses to be made available, or the result of 6791 an attempt made to obtain a general license or permission for 6792 the use of such proprietary rights by implementers or users of 6793 this specification can be obtained from the IETF on-line IPR 6794 repository at http://www.ietf.org/ipr. 6796 The IETF invites any interested party to bring to its 6797 attention any copyrights, patents or patent applications, or 6798 other proprietary rights that may cover technology that may be 6799 required to implement this standard. Please address the 6800 information to the IETF at ietf-ipr@ietf.org.