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