idnits 2.17.1 draft-ietf-rmonmib-rmon2-01.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): ---------------------------------------------------------------------------- ** Cannot find the required boilerplate sections (Copyright, IPR, etc.) in this document. Expected boilerplate is as follows today (2024-04-25) according to https://trustee.ietf.org/license-info : IETF Trust Legal Provisions of 28-dec-2009, Section 6.a: This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 2: Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 3: This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing document type: Expected "INTERNET-DRAFT" in the upper left hand corner of the first page ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories. == 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 Abstract section. (A line matching the expected section header was found, but with an unexpected indentation: ' 2. Abstract' ) ** 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 a Security Considerations section. ** 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 676 instances of too long lines in the document, the longest one being 16 characters in excess of 72. ** The abstract seems to contain references ([2], [3], [4], [5], [6], [7], [4,6], [8], [9], [10], [XXX], [1]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == Line 488 has weird spacing: '...imeMark timeF...' == Line 3191 has weird spacing: '...ticular probe...' == Line 3618 has weird spacing: '... field octet...' == Line 3881 has weird spacing: '...se code bps...' -- 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 (June 1, 1995) is 10556 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? '1' on line 4275 looks like a reference -- Missing reference section? '2' on line 4281 looks like a reference -- Missing reference section? '3' on line 4286 looks like a reference -- Missing reference section? '4' on line 4292 looks like a reference -- Missing reference section? '5' on line 4298 looks like a reference -- Missing reference section? '6' on line 4304 looks like a reference -- Missing reference section? '9' on line 4321 looks like a reference -- Missing reference section? 'XXX' on line 1370 looks like a reference -- Missing reference section? '7' on line 4309 looks like a reference -- Missing reference section? '8' on line 4315 looks like a reference -- Missing reference section? '10' on line 4326 looks like a reference Summary: 14 errors (**), 0 flaws (~~), 5 warnings (==), 13 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Remote Network Monitoring Management Information Base 3 5 June 1, 1995 7 Editor: 9 Steven Waldbusser 11 waldbusser@ins.com 13 1. Status of this Memo 15 This document is an Internet-Draft. Internet-Drafts are 16 working documents of the Internet Engineering Task Force 17 (IETF), its areas, and its working groups. Note that other 18 groups may also distribute working documents as Internet- 19 Drafts. 21 Internet-Drafts are draft documents valid for a maximum of six 22 months. Internet-Drafts may be updated, replaced, or 23 obsoleted by other documents at any time. It is not 24 appropriate to use Internet-Drafts as reference material or to 25 cite them other than as a ``working draft'' or ``work in 26 progress.'' 28 To learn the current status of any Internet-Draft, please 29 check the 1id-abstracts.txt listing contained in the 30 Internet-Drafts Shadow Directories on ds.internic.net, 31 nic.nordu.net, venera.isi.edu, or munnari.oz.au. 33 2. Abstract 35 This memo defines an experimental portion of the Management 36 Information Base (MIB) for use with network management 37 protocols in TCP/IP-based internets. In particular, it 38 defines objects for managing remote network monitoring 39 devices. 41 This memo does not specify a standard for the Internet 42 community. 44 3. The Network Management Framework 46 The Internet-standard Network Management Framework consists of 47 three components. They are: 49 RFC 1155[1] which defines the SMI, the mechanisms used for 50 describing and naming objects for the purpose of management. 51 RFC 1212[2] defines a more concise description mechanism, 52 which is wholly consistent with the SMI. 54 RFC 1213[3] which defines MIB-II, the core set of managed 55 objects for the Internet suite of protocols. 57 RFC 1157[4] which defines the SNMP, the protocol used for 58 network access to managed objects. 60 The Framework permits new objects to be defined for the 61 purpose of experimentation and evaluation. 63 Managed objects are accessed via a virtual information store, 64 termed the Management Information Base or MIB. Within a given 65 MIB module, objects are defined using RFC 1212's OBJECT-TYPE 66 macro. At a minimum, each object has a name, a syntax, an 67 access-level, and an implementation-status. 69 The name is an object identifier, an administratively assigned 70 name, which specifies an object type. The object type 71 together with an object instance serves to uniquely identify a 72 specific instantiation of the object. For human convenience, 73 we often use a textual string, termed the object descriptor, 74 to also refer to the object type. 76 The syntax of an object type defines the abstract data 77 structure corresponding to that object type. The ASN.1[5] 78 language is used for this purpose. However, RFC 1155 79 purposely restricts the ASN.1 constructs which may be used. 80 These restrictions are explicitly made for simplicity. 82 The access-level of an object type defines whether it makes 83 "protocol sense" to read and/or write the value of an instance 84 of the object type. (This access-level is independent of any 85 administrative authorization policy.) 87 The implementation-status of an object type indicates whether 88 the object is mandatory, optional, obsolete, or deprecated. 90 4. Overview 92 Remote network monitoring devices, often called monitors or 93 probes, are instruments that exist for the purpose of managing 94 a network. Often these remote probes are stand-alone devices 95 and devote significant internal resources for the sole purpose 96 of managing a network. An organization may employ many of 97 these devices, one per network segment, to manage its 98 internet. In addition, these devices may be used for a 99 network management service provider to access a client 100 network, often geographically remote. 102 The objects defined in this document are intended as an 103 interface between an RMON agent and an RMON management 104 application and are not intended for direct manipulation by 105 humans. While some users may tolerate the direct display of 106 some of these objects, few will tolerate the complexity of 107 manually manipulating objects to accomplish row creation. 108 These functions should be handled by the management 109 application. 111 4.1. Remote Network Management Goals 113 o Offline Operation 114 There are sometimes conditions when a management 115 station will not be in constant contact with its 116 remote monitoring devices. This is sometimes by 117 design in an attempt to lower communications costs 118 (especially when communicating over a WAN or 119 dialup link), or by accident as network failures 120 affect the communications between the management 121 station and the probe. 123 For this reason, this MIB allows a probe to be 124 configured to perform diagnostics and to collect 125 statistics continuously, even when communication with 126 the management station may not be possible or 127 efficient. The probe may then attempt to notify 128 the management station when an exceptional condition 129 occurs. Thus, even in circumstances where 130 communication between management station and probe is 131 not continuous, fault, performance, and configuration 132 information may be continuously accumulated and 133 communicated to the management station conveniently 134 and efficiently. 136 o Proactive Monitoring 137 Given the resources available on the monitor, it 138 is potentially helpful for it continuously to run 139 diagnostics and to log network performance. The 140 monitor is always available at the onset of any 141 failure. It can notify the management station of the 142 failure and can store historical statistical 143 information about the failure. This historical 144 information can be played back by the management 145 station in an attempt to perform further diagnosis 146 into the cause of the problem. 148 o Problem Detection and Reporting 149 The monitor can be configured to recognize 150 conditions, most notably error conditions, and 151 continuously to check for them. When one of these 152 conditions occurs, the event may be logged, and 153 management stations may be notified in a number of 154 ways. 156 o Value Added Data 157 Because a remote monitoring device represents a 158 network resource dedicated exclusively to network 159 management functions, and because it is located 160 directly on the monitored portion of the network, the 161 remote network monitoring device has the opportunity 162 to add significant value to the data it collects. 163 For instance, by highlighting those hosts on the 164 network that generate the most traffic or errors, the 165 probe can give the management station precisely the 166 information it needs to solve a class of problems. 168 o Multiple Managers 169 An organization may have multiple management stations 170 for different units of the organization, for different 171 functions (e.g. engineering and operations), and in an 172 attempt to provide disaster recovery. Because 173 environments with multiple management stations are 174 common, the remote network monitoring device has to 175 deal with more than own management station, 176 potentially using its resources concurrently. 178 4.2. Structure of MIB 180 The objects are arranged into the following groups: 182 - protocol directory 184 - protocol distribution 186 - address mapping 188 - network layer host 190 - network layer matrix 192 These groups are the basic unit of conformance. If a remote 193 monitoring device implements a group, then it must implement 194 all objects in that group. For example, a managed agent that 195 implements the network layer matrix group must implement the 196 nlMatrixSDTable and the nlMatrixDSTable. 198 Implementations of this MIB must also implement the system and 199 interfaces group of MIB-II [6]. MIB-II may also mandate the 200 implementation of additional groups. 202 These groups are defined to provide a means of assigning 203 object identifiers, and to provide a method for managed agents 204 to know which objects they must implement. 206 5. Control of Remote Network Monitoring Devices 208 Due to the complex nature of the available functions in these 209 devices, the functions often need user configuration. In many 210 cases, the function requires parameters to be set up for a 211 data collection operation. The operation can proceed only 212 after these parameters are fully set up. 214 Many functional groups in this MIB have one or more tables in 215 which to set up control parameters, and one or more data 216 tables in which to place the results of the operation. The 217 control tables are typically read-write in nature, while the 218 data tables are typically read-only. Because the parameters 219 in the control table often describe resulting data in the data 220 table, many of the parameters can be modified only when the 221 control entry is invalid. Thus, the method for modifying 222 these parameters is to invalidate the control entry, causing 223 its deletion and the deletion of any associated data entries, 224 and then create a new control entry with the proper 225 parameters. Deleting the control entry also gives a 226 convenient method for reclaiming the resources used by the 227 associated data. 229 Some objects in this MIB provide a mechanism to execute an 230 action on the remote monitoring device. These objects may 231 execute an action as a result of a change in the state of the 232 object. For those objects in this MIB, a request to set an 233 object to the same value as it currently holds would thus 234 cause no action to occur. 236 To facilitate control by multiple managers, resources have to 237 be shared among the managers. These resources are typically 238 the memory and computation resources that a function requires. 240 5.1. Resource Sharing Among Multiple Management Stations 242 When multiple management stations wish to use functions that 243 compete for a finite amount of resources on a device, a method 244 to facilitate this sharing of resources is required. 245 Potential conflicts include: 247 o Two management stations wish to simultaneously use 248 resources that together would exceed the capability of 249 the device. 251 o A management station uses a significant amount of 252 resources for a long period of time. 253 o A management station uses resources and then crashes, 254 forgetting to free the resources so others may 255 use them. 257 A mechanism is provided for each management station initiated 258 function in this MIB to avoid these conflicts and to help 259 resolve them when they occur. Each function has a label 260 identifying the initiator (owner) of the function. This label 261 is set by the initiator to provide for the following 262 possibilities: 264 o A management station may recognize resources it owns 265 and no longer needs. 266 o A network operator can find the management station that 267 owns the resource and negotiate for it to be freed. 268 o A network operator may decide to unilaterally free 269 resources another network operator has reserved. 270 o Upon initialization, a management station may recognize 271 resources it had reserved in the past. With this 272 information it may free the resources if it no longer 273 needs them. 275 Management stations and probes should support any format of 276 the owner string dictated by the local policy of the 277 organization. It is suggested that this name contain one or 278 more of the following: IP address, management station name, 279 network manager's name, location, or phone number. This 280 information will help users to share the resources more 281 effectively. 283 There is often default functionality that the device or the 284 administrator of the probe (often the network administrator) 285 wishes to set up. The resources associated with this 286 functionality are then owned by the device itself or by the 287 network administrator, and are intended to be long-lived. In 288 this case, the device or the administrator will set the 289 relevant owner object to a string starting with 'monitor'. 290 Indiscriminate modification of the monitor-owned configuration 291 by network management stations is discouraged. In fact, a 292 network management station should only modify these objects 293 under the direction of the administrator of the probe. 295 Resources on a probe are scarce and are typically allocated 296 when control rows are created by an application. Since many 297 applications may be using a probe simultaneously, 298 indiscriminate allocation of resources to particular 299 applications is very likely to cause resource shortages in the 300 probe. 302 When a network management station wishes to utilize a function 303 in a monitor, it is encouraged to first scan the control table 304 of that function to find an instance with similar parameters 305 to share. This is especially true for those instances owned 306 by the monitor, which can be assumed to change infrequently. 307 If a management station decides to share an instance owned by 308 another management station, it should understand that the 309 management station that owns the instance may indiscriminately 310 modify or delete it. 312 It should be noted that a management application should have 313 the most trust in a monitor-owned row because it should be 314 changed very infrequently. A row owned by the management 315 application is less long-lived because a network administrator 316 is more likely to re-assign resources from a row that is in 317 use by one user than from a monitor-owned row that is 318 potentially in use by many users. A row owned by another 319 application would be even less long-lived because the other 320 application may delete or modify that row completely at its 321 discretion. 323 5.2. Row Addition Among Multiple Management Stations 325 The addition of new rows is achieved using the method 326 described in RFC 1212 [9]. In this MIB, rows are often added 327 to a table in order to configure a function. This 328 configuration usually involves parameters that control the 329 operation of the function. The agent must check these 330 parameters to make sure they are appropriate given 331 restrictions defined in this MIB as well as any implementation 332 specific restrictions such as lack of resources. The agent 333 implementor may be confused as to when to check these 334 parameters and when to signal to the management station that 335 the parameters are invalid. There are two opportunities: 337 o When the management station sets each parameter object. 339 o When the management station sets the entry status object 340 to valid. 342 If the latter is chosen, it would be unclear to the management 343 station which of the several parameters was invalid and caused 344 the badValue error to be emitted. Thus, wherever possible, 345 the implementor should choose the former as it will provide 346 more information to the management station. 348 A problem can arise when multiple management stations attempt 349 to set configuration information simultaneously using SNMP. 350 When this involves the addition of a new conceptual row in the 351 same control table, the managers may collide, attempting to 352 create the same entry. To guard against these collisions, 353 each such control entry contains a status object with special 354 semantics that help to arbitrate among the managers. If an 355 attempt is made with the row addition mechanism to create such 356 a status object and that object already exists, an error is 357 returned. When more than one manager simultaneously attempts 358 to create the same conceptual row, only the first will 359 succeed. The others will receive an error. 361 When a manager wishes to create a new control entry, it needs 362 to choose an index for that row. It may choose this index in 363 a variety of ways, hopefully minimizing the chances that the 364 index is in use by another manager. If the index is in use, 365 the mechanism mentioned previously will guard against 366 collisions. Examples of schemes to choose index values 367 include random selection or scanning the control table looking 368 for the first unused index. Because index values may be any 369 valid value in the range and they are chosen by the manager, 370 the agent must allow a row to be created with any unused index 371 value if it has the resources to create a new row. 373 Some tables in this MIB reference other tables within this 374 MIB. When creating or deleting entries in these tables, it is 375 generally allowable for dangling references to exist. There 376 is no defined order for creating or deleting entries in these 377 tables. 379 Define/describe the "limited extensibility" mechanism of the 380 protocolDirectory. 382 6. Conventions 384 The following conventions are used throughout the RMON MIB and 385 its companion documents. 387 Good Packets 389 Good packets are error-free packets that have a valid frame 390 length. For example, on Ethernet, good packets are error-free 391 packets that are between 64 octets long and 1518 octets long. 392 They follow the form defined in IEEE 802.3 section 3.2.all. 394 Bad Packets 396 Bad packets are packets that have proper framing and are 397 therefore recognized as packets, but contain errors within the 398 packet or have an invalid length. For example, on Ethernet, 399 bad packets have a valid preamble and SFD, but have a bad CRC, 400 or are either shorter than 64 octets or longer than 1518 401 octets. 403 7. Definitions 405 RMON2-MIB DEFINITIONS ::= BEGIN 407 IMPORTS 408 MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32, 409 Gauge32, IpAddress, TimeTicks, 410 NOTIFICATION-TYPE, OBJECT-IDENTITY FROM SNMPv2-SMI 411 TEXTUAL-CONVENTION, RowStatus, DisplayString, 412 MacAddress FROM SNMPv2-TC 413 MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF 414 mib-2 FROM RFC1213-MIB 415 rmon, OwnerString FROM RFC1757-MIB; 417 -- Remote Network Monitoring MIB 419 rmon MODULE-IDENTITY 420 LAST-UPDATED "9506020000Z" 421 ORGANIZATION "IETF RMON MIB Working Group" 422 CONTACT-INFO 423 "Andy Bierman (WG Chair) 424 Postal: Cisco Systems, Inc. 425 170 West Tasman Drive 426 San Jose, CA 95134-1706 427 USA 428 Phone: +1 408 526 8951 429 Email: abierman@cisco.com 431 Steve Waldbusser (WG Editor) 432 Postal: International Network Services 433 650 Castro Street, Suite 260 434 Mountain View, CA 94041 436 Phone: +1 415 254 4251 437 Email: waldbusser@ins.com" 438 DESCRIPTION 439 "The MIB module for managing remote monitoring 440 device implementations. This MIB module 441 augments the original RMON MIB as specified in 442 RFC 1757." 443 ::= { mib-2 16 } 445 protocolDir OBJECT IDENTIFIER ::= { rmon 11 } 446 protocolDist OBJECT IDENTIFIER ::= { rmon 12 } 447 addressMap OBJECT IDENTIFIER ::= { rmon 13 } 448 nlHost OBJECT IDENTIFIER ::= { rmon 14 } 449 nlMatrix OBJECT IDENTIFIER ::= { rmon 15 } 450 alHost OBJECT IDENTIFIER ::= { rmon 16 } 451 alMatrix OBJECT IDENTIFIER ::= { rmon 17 } 452 usrHistory OBJECT IDENTIFIER ::= { rmon 18 } 453 probeConfig OBJECT IDENTIFIER ::= { rmon 19 } 455 -- Textual Conventions 456 TimeFilter ::= TEXTUAL-CONVENTION 457 STATUS current 458 DESCRIPTION 459 "To be used for the index to a table. Allows an application 460 to download only those rows changed since a particular time. 462 When sysUpTime is equal to zero, this table shall be empty. 464 One entry exists for each past value of sysUpTime, except that 465 the whole table is purged should sysUpTime wrap. 467 As this basic row is updated new concptual rows are created 468 (which still share the now updated object values with all 469 other instances). The number of instances which are created 470 is determined by the value of sysUpTime at which the basic row 471 was last updated. One instance will exist for each value of 472 sysUpTime and the last update time for the row. A new timeMark 473 instance is created for each new sysUpTime value. Each new 474 conceptual row will be associated with the timeMark instance 475 which was created at the value of sysUpTime with which the 476 conceptual row is to be associated. 478 By definition all conceptual rows were updated at or after 479 time zero and so at least one conceptual row (associatd with 480 timeMark.0) must exist for each underlying (basic) row. 482 Consider the following fooTable: 484 fooTable ... 485 INDEX { timeMark, fooIndex } 487 FooEntry { 488 fooTimeMark timeFilter 489 fooIndex INTEGER, 490 fooCounts Counter 491 } 493 Should there be two basic rows in this table (fooIndex == 1, 494 fooIndex == 2) and row 1 was updated most recently at time 6, 495 while row 2 was updated most recently at time 8, and both rows 496 had been updated on several earlier occaision such that the 497 current values were 5 and 9 respectively then the following 498 fooCounts instances would exist. 500 fooCounts.0.1 5 501 fooCounts.0.2 9 502 fooCounts.1.1 5 503 fooCounts.1.2 9 504 fooCounts.2.1 5 505 fooCounts.2.2 9 506 fooCounts.3.1 5 507 fooCounts.3.2 9 508 fooCounts.4.1 5 509 fooCounts.4.2 9 510 fooCounts.5.1 5 511 fooCounts.5.2 9 512 fooCounts.6.1 5 513 fooCounts.6.2 9 514 fooCounts.7.2 9 515 fooCounts.8.2 9" 516 SYNTAX TimeTicks 518 protocolDirTable OBJECT-TYPE 519 SYNTAX SEQUENCE OF ProtocolDirEntry 520 MAX-ACCESS not-accessible 521 STATUS current 522 DESCRIPTION 523 "This table lists the protocols that this agent has the 524 capability to decode and count. There is one entry in this 525 table for each such protocol. These protocols represent 526 different network layer, transport layer, and higher-layer 527 protocols. The agent should boot up with this table 528 preconfigured with those protocols that it knows about and 529 wishes to monitor." 530 ::= { protocolDir 1 } 532 protocolDirEntry OBJECT-TYPE 533 SYNTAX ProtocolDirEntry 534 MAX-ACCESS not-accessible 535 STATUS current 536 DESCRIPTION 537 "This table lists the protocols that this agent has the 538 capability to decode and count. There is one entry in this 539 table for each such protocol. These protocols represent 540 different network layer, transport layer, and higher-layer 541 protocols. The agent should boot up with this table 542 preconfigured with those protocols that it knows about and 543 wishes to monitor." 544 INDEX { protocolDirID, protocolDirParameters } 545 ::= { protocolDirTable 1 } 547 ProtocolDirEntry ::= SEQUENCE { 548 protocolDirID OBJECT IDENTIFIER, 549 protocolDirParameters OCTET STRING, 550 protocolDirIndex Integer32, 551 protocolDirDescr DisplayString, 552 protocolDirType BITS, 553 protocolDirAddressMapConfig INTEGER, 554 protocolDirNlHostConfig INTEGER, 555 protocolDirNlMatrixConfig INTEGER, 556 protocolDirAlHostConfig INTEGER, 557 protocolDirAlMatrixConfig INTEGER, 558 protocolDirAddressCapable INTEGER, 559 protocolDirOwner OwnerString, 560 protocolDirStatus RowStatus 561 } 562 protocolDirID OBJECT-TYPE 563 SYNTAX OBJECT IDENTIFIER 564 MAX-ACCESS not-accessible 565 STATUS current 566 DESCRIPTION 567 "A unique identifier for a particular protocol. Standard 568 object identifiers will be defined in a manner such that they 569 can often be used as specifications for new protocols - i.e. 570 a tree-structured assignment mechanism that matches the 571 protocol encapsulation `tree' and which has algorithmic 572 assignment mechanisms for certain subtrees. For example: 574 protocolDir.assignments.ethernet 575 -- children of ethernet will have values representing the 576 -- two byte ethertype value of an ethernet protocol. Some 577 -- well-known ones are defined below. 579 protocolDir.assignments.ethernet.ip 580 -- children of ip will have values representing the 581 -- one byte value of an ip protocol. Some 582 -- well-known ones are defined below. 584 ... 586 protocolDir.assignments.ethernet.ip.udp.dns 588 Despite the algorithmic mechanism, the probe will only place 589 entries in here for those protocols it chooses to collect. In 590 other words, it need not populate this table with all of the 591 possible ethernet protocol types, nor need it create them on 592 the fly when it sees them. Whether or not it does these 593 things is a matter of product definition (cost/benefit, 594 usability), and is up to the designer of the product. 596 If an entry is written to this table with a protocolID that 597 the agent doesn't understand, either directly or 598 algorithmicly, the SET request will be rejected with an 599 inconsistentName or badValue (for SNMPv1) error." 600 ::= { protocolDirEntry 1 } 602 protocolDirParameters OBJECT-TYPE 603 SYNTAX OCTET STRING 604 MAX-ACCESS not-accessible 605 STATUS current 606 DESCRIPTION 607 "A set of options for the associated protocolDirID. There 608 will be one octet in this string for each sub-identifier in 609 the protocolDirID, and the options will appear here in the 610 same order as the associated protocolDirOptions. 612 Every node in the protocolDirID tree has a different, optional 613 set of parameters defined (that is, the definition of 614 parameters for a node is optional). The proper parameter 615 value for each node is included in this string. Note that the 616 inclusion of a parameter value in this string for each node is 617 not optional - what is optional is that a node may have no 618 parameters defined, in which the parameter field for that node 619 will be zero." 620 ::= { protocolDirEntry 2 } 622 protocolDirIndex OBJECT-TYPE 623 SYNTAX Integer32 (1..2147483647) 624 MAX-ACCESS read-only 625 STATUS current 626 DESCRIPTION 627 "The locally arbitrary, but unique identifier associated 628 with this protocolDir entry. 630 The value for each supported protocol must remain constant at 631 least from one re-initialization of the entity's network 632 management system to the next re-initialization. 634 The specific value is meaningful only within a given SNMP 635 entity. A protocolDirIndex may not be re-used until the 636 next agent-restart, in the event the protocol directory entry 637 is deleted." 638 ::= { protocolDirEntry 3 } 640 protocolDirDescr OBJECT-TYPE 641 SYNTAX DisplayString (SIZE (1..64)) 642 MAX-ACCESS read-create 643 STATUS current 644 DESCRIPTION 645 "A textual description of the protocol encapsulation. 646 A probe may choose to describe only a subset of the 647 entire encapsulation (e.g. only the highest layer). 649 This object may not be modified if the associated 650 protocolDirStatus object is equal to active(1)." 651 ::= { protocolDirEntry 4 } 653 protocolDirType OBJECT-TYPE 654 SYNTAX BITS { 655 extensible(0), 656 addressRecognitionCapable(1) 657 } 658 MAX-ACCESS read-only 659 STATUS current 660 DESCRIPTION 661 "This object describes 2 attributes of this protocol 662 directory entry. 664 This object describes whether or not this protocol directory 665 entry can be extended by the user by creating protocol 666 directory entries which are children of this protocol. Some 667 entries that a probe creates will be extensible, and no 668 entries that a user creates will be extensible. 670 An example of an entry that will often allow extensibility is 671 `ip.udp'. The probe may automatically populate some children 672 of this node such as `ip.udp.snmp' and `ip.udp.dns'. 673 A probe administrator or user may also populate additional 674 children via remote SNMP requests that create entries in this 675 table. When a child node added, extending a parent node, 676 that child node is not extendible. This is termed `limited 677 extensibility'. 679 This object also describes whether or not this agent can 680 recognize addresses for this protocol, should it be a network 681 level protocol. That is, while a probe may be able to 682 recognize packets of a particular network layer protocol and 683 count them, it takes additional logic to be able to recognize 684 the addresses in this protocol and to populate network layer 685 or application layer tables with the addresses in this 686 protocol." 687 ::= { protocolDirEntry 5 } 689 protocolDirAddressMapConfig OBJECT-TYPE 690 SYNTAX INTEGER { 691 notSupported(1), 692 supportedOff(2), 693 supportedOn(3) 694 } 695 MAX-ACCESS read-create 696 STATUS current 697 DESCRIPTION 698 "This object describes and configures the probe's support for 699 address mapping for this protocol. When the probe creates 700 entries in this table for all protocols that it understands, 701 it will set the entry to notSupported(1) if it doesn't have the 702 capability to perform address mapping for the protocol or if 703 this protocol is not a network-layer protocol. When 704 an entry is created in this table by a management operation, 705 the probe will set this value to notSupported(1), as the 706 limited extensibility of the protocolDirectory table does not 707 extend to interpreting addresses of the extended protocols. 709 If the value of this object is notSupported(1), the probe 710 will not perform address mapping for this protocol and 711 shall not allow this object to be changed to any other value. 712 If the value of this object is supportedOn(3), the probe 713 supports address mapping for this protocol and is configured 714 to perform address mapping for this protocol for all 715 addressMappingControlEntry's and all interfaces or ports. 716 If the value of this object is supportedOff(3), the probe 717 supports address mapping for this protocol but is configured 718 to not perform address mapping for this protocol for any 719 addressMappingControlEntry's and all interfaces or ports." 720 ::= { protocolDirEntry 6 } 722 protocolDirNlHostConfig OBJECT-TYPE 723 SYNTAX INTEGER { 724 notSupported(1), 725 supportedOff(2), 726 supportedOn(3) 727 } 728 MAX-ACCESS read-create 729 STATUS current 730 DESCRIPTION 731 "This object describes and configures the probe's support for 732 the network layer host table for this protocol. When the 733 probe creates entries in this table for all protocols that it 734 understands, it will set the entry to notSupported(1) if it 735 doesn't have the capability to track the nlHost table for the 736 protocol or if this protocol is not a network-layer protocol. 737 If the associated protocolDirAddressCapable object is equal to 738 addressCapable, then this is a network layer protocol which 739 the probe recognized addresses for, and thus the probe will 740 populate the alHostTable with addresses it discovers for this 741 protocol. 743 When an entry is created in this table by a management 744 operation, the probe will set this value to notSupported(1), 745 as the limited extensibility of the protocolDirectory table 746 does not extend to interpreting network level addresses of the 747 extended protocols. 749 If the value of this object is notSupported(1), the probe 750 will not track the nlHost table for this protocol and 751 shall not allow this object to be changed to any other value. 752 If the value of this object is supportedOn(3), the probe 753 supports tracking of the nlHost table for this protocol and is 754 configured to track the nlHost table for this protocol for all 755 nlHostControlEntry's and all interfaces or ports. 756 If the value of this object is supportedOff(3), the probe 757 supports tracking of the nlHost table for this protocol 758 but is configured to not track the nlHost for this 759 protocol for any nlHostControlEntry's and all interfaces or 760 ports." 761 ::= { protocolDirEntry 7 } 763 protocolDirNlMatrixConfig OBJECT-TYPE 764 SYNTAX INTEGER { 765 notSupported(1), 766 supportedOff(2), 767 supportedOn(3) 768 } 769 MAX-ACCESS read-create 770 STATUS current 771 DESCRIPTION 772 "This object describes and configures the probe's support for 773 the network layer matrix table for this protocol. When the 774 probe creates entries in this table for all protocols that it 775 understands, it will set the entry to notSupported(1) if it 776 doesn't have the capability to track the nlMatrix table for the 777 protocol or if this protocol is not a network-layer protocol. 778 If the associated protocolDirAddressCapable object is equal to 779 addressCapable, then this is a network layer protocol which 780 the probe recognized addresses for, and thus the probe will 781 populate the alHostTable with addresses it discovers for this 782 protocol. 784 When an entry is created in this table by a management 785 operation, the probe will set this value to notSupported(1), 786 as the limited extensibility of the protocolDirectory table 787 does not extend to interpreting network level addresses of the 788 extended protocols. 790 If the value of this object is notSupported(1), the probe 791 will not track the nlMatrix table for this protocol and 792 shall not allow this object to be changed to any other value. 793 If the value of this object is supportedOn(3), the probe 794 supports tracking of the nlMatrix table for this protocol and is 795 configured to track the nlMatrix table for this protocol for all 796 nlMatrixControlEntry's and all interfaces or ports. 797 If the value of this object is supportedOff(3), the probe 798 supports tracking of the nlMatrix table for this protocol 799 but is configured to not track the nlMatrix for this 800 protocol for any nlMatrixControlEntry's and all interfaces or 801 ports." 802 ::= { protocolDirEntry 8 } 804 protocolDirAlHostConfig OBJECT-TYPE 805 SYNTAX INTEGER { 806 notSupported(1), 807 supportedOff(2), 808 supportedOn(3) 809 } 810 MAX-ACCESS read-create 811 STATUS current 812 DESCRIPTION 813 "This object describes and configures the probe's support for 814 the application layer host table for this protocol. When the 815 probe creates entries in this table for all protocols that it 816 understands, it will set the entry to notSupported(1) if it 817 doesn't have the capability to track the nlHost table for the 818 protocol. If the associated protocolDirAddressCapable object 819 is equal to addressCapable, then this is a network layer 820 protocol which the probe recognized addresses for, and thus 821 the probe will populate the alHostTable with addresses it 822 discovers for this protocol. 824 When an entry is created in this table by a management 825 operation, the probe will set this value to notSupported(1), 826 as the limited extensibility of the protocolDirectory table 827 does not extend to interpreting network level addresses of the 828 extended protocols. 830 If the value of this object is notSupported(1), the probe 831 will not track the nlHost table for this protocol and 832 shall not allow this object to be changed to any other value. 834 If the value of this object is supportedOn(3), the probe 835 supports tracking of the nlHost table for this protocol and is 836 configured to track the nlHost table for this protocol for all 837 nlHostControlEntry's and all interfaces or ports. 838 If the value of this object is supportedOff(3), the probe 839 supports tracking of the nlHost table for this protocol 840 but is configured to not track the nlHost for this 841 protocol for any nlHostControlEntry's and all interfaces or 842 ports." 843 ::= { protocolDirEntry 9 } 845 protocolDirAlMatrixConfig OBJECT-TYPE 846 SYNTAX INTEGER { 847 notSupported(1), 848 supportedOff(2), 849 supportedOn(3) 850 } 851 MAX-ACCESS read-create 852 STATUS current 853 DESCRIPTION 854 "This object describes and configures the probe's support for 855 the network layer matrix table for this protocol. When the 856 probe creates entries in this table for all protocols that it 857 understands, it will set the entry to notSupported(1) if it 858 doesn't have the capability to track the nlMatrix table for the 859 protocol or if this protocol is not a network-layer protocol. 860 If the associated protocolDirAddressCapable object is equal to 861 addressCapable, then this is a network layer protocol which 862 the probe recognized addresses for, and thus the probe will 863 populate the alHostTable with addresses it discovers for this 864 protocol. 866 When an entry is created in this table by a management 867 operation, the probe will set this value to notSupported(1), 868 as the limited extensibility of the protocolDirectory table 869 does not extend to interpreting network level addresses of the 870 extended protocols. 872 If the value of this object is notSupported(1), the probe 873 will not track the nlMatrix table for this protocol and 874 shall not allow this object to be changed to any other value. 875 If the value of this object is supportedOn(3), the probe 876 supports tracking of the nlMatrix table for this protocol and is 877 configured to track the nlMatrix table for this protocol for all 878 nlMatrixControlEntry's and all interfaces or ports. 880 If the value of this object is supportedOff(3), the probe 881 supports tracking of the nlMatrix table for this protocol 882 but is configured to not track the nlMatrix for this 883 protocol for any nlMatrixControlEntry's and all interfaces or 884 ports." 885 ::= { protocolDirEntry 10 } 887 protocolDirAddressCapable OBJECT-TYPE 888 SYNTAX INTEGER { 889 addressCapable(1), 890 notAddressCapable(2) 891 } 892 MAX-ACCESS read-create 893 STATUS current 894 DESCRIPTION 895 "" 896 ::= { protocolDirEntry 11 } 898 protocolDirOwner OBJECT-TYPE 899 SYNTAX OwnerString 900 MAX-ACCESS read-create 901 STATUS current 902 DESCRIPTION 903 "The owner of this protocol directory entry." 904 ::= { protocolDirEntry 12 } 906 protocolDirStatus OBJECT-TYPE 907 SYNTAX RowStatus 908 MAX-ACCESS read-create 909 STATUS current 910 DESCRIPTION 911 "The status of this protocol directory entry. 913 A protocol is not qualified for activation until instances of 914 all columns of its protocolDirEntry row have an 915 appropriate value. In particular, one or more management set 916 operations are required to configure the protocol entry: 917 a value must be written to the protocolDirDescr 918 object. 920 Until instances of all corresponding columns are 921 appropriately configured, the value of the corresponding 922 instance of the protocolDirStatus column is `notReady'. 924 For those columnar objects which permit write-access (after 925 their initial creation), their value in an existing conceptual 926 row can be changed irrespective of the value of 927 protocolDirStatus for that row." 928 ::= { protocolDirEntry 13 } 930 protocolAssignments OBJECT IDENTIFIER ::= { protocolDir 2 } 932 -- 933 -- Protocol Distribution Group (protocolDist) 934 -- 935 -- Controls basic segment-level data collection. 936 -- protocolDistControlTable, 937 -- protocolDistStatsTable 939 protocolDistControlTable OBJECT-TYPE 940 SYNTAX SEQUENCE OF ProtocolDistControlEntry 941 MAX-ACCESS not-accessible 942 STATUS current 943 DESCRIPTION 944 "Controls the setup of protocol type distribution statistics 945 tables. 947 Rationale: 948 This table controls collection of very basic statistics 949 for any or all of the protocols detected on a given interface. 950 An NMS can use this table to quickly determine bandwidth 951 allocation utilized by different protocols. 953 A media-specific statistics collection could also 954 be configured (e.g. etherStats, trPStats) to easily obtain 955 total frame, octet, and droppedEvents for the same 956 interface." 957 ::= { protocolDist 1 } 959 protocolDistControlEntry OBJECT-TYPE 960 SYNTAX ProtocolDistControlEntry 961 MAX-ACCESS not-accessible 962 STATUS current 963 DESCRIPTION 964 "Controls the setup of protocol type distribution statistics 965 tables." 966 INDEX { protocolDistControlIndex } 967 ::= { protocolDistControlTable 1 } 969 ProtocolDistControlEntry ::= SEQUENCE { 970 protocolDistControlIndex Integer32 (1..65535), 971 protocolDistControlDataSource OBJECT IDENTIFIER, 972 protocolDistControlDroppedFrames Counter32, 973 protocolDistControlOwner OwnerString, 974 protocolDistControlStatus RowStatus 975 } 977 protocolDistControlIndex OBJECT-TYPE 978 SYNTAX Integer32 979 MAX-ACCESS not-accessible 980 STATUS current 981 DESCRIPTION 982 "A unique index for this protocolDistControlEntry." 983 ::= { protocolDistControlEntry 1 } 985 protocolDistControlDataSource OBJECT-TYPE 986 SYNTAX OBJECT IDENTIFIER 987 MAX-ACCESS read-create 988 STATUS current 989 DESCRIPTION 990 "This object identifies the source of the data that 991 this protocolDistControlEntry entry is configured to analyze. 992 This source can be any interface on this device. 994 The statistics in this group reflect all packets 995 on the local network segment attached to the 996 identified interface. 998 This object may not be modified if the associated 999 protocolDistControlStatus object is equal to active(1)." 1000 ::= { protocolDistControlEntry 2 } 1002 protocolDistControlDroppedFrames OBJECT-TYPE 1003 SYNTAX Counter32 1004 MAX-ACCESS read-only 1005 STATUS current 1006 DESCRIPTION 1007 "The total number of frames which were received by the probe 1008 and therefore not accounted for in the *StatsDropEvents, but 1009 for which the probe chose not to count for this entry for 1010 whatever reason. Most often, this event occurs when the probe 1011 is out of some resources and decides to shed load from this 1012 collection. 1014 Note that this number is the exact number of 1015 frames dropped; it must be set as accurately as possible 1016 by the probe." 1017 ::= { protocolDistControlEntry 3 } 1019 protocolDistControlOwner OBJECT-TYPE 1020 SYNTAX OwnerString 1021 MAX-ACCESS read-create 1022 STATUS current 1023 DESCRIPTION 1024 "The owner of this entry." 1025 ::= { protocolDistControlEntry 4 } 1027 protocolDistControlStatus OBJECT-TYPE 1028 SYNTAX RowStatus 1029 MAX-ACCESS read-create 1030 STATUS current 1031 DESCRIPTION 1032 "The status of this row. 1034 An entry is not qualified for activation until instances of 1035 all columns of its protocolDistControlEntry row have an 1036 appropriate value. In particular, one or more management set 1037 operations are required to configure the entry: 1038 a value must be written to the protocolDistControlDataSource 1039 object. 1041 Until instances of all corresponding columns are 1042 appropriately configured, the value of the corresponding 1043 instance of the protocolDistControlStatus column is `notReady'. 1045 For those columnar objects which permit write-access (after 1046 their initial creation), their value in an existing conceptual 1047 row can be changed irrespective of the value of 1048 protocolDistControlStatus for that row." 1049 ::= { protocolDistControlEntry 5 } 1051 -- per interface protocol distribution statistics table 1052 protocolDistStatsTable OBJECT-TYPE 1053 SYNTAX SEQUENCE OF ProtocolDistStatsEntry 1054 MAX-ACCESS not-accessible 1055 STATUS current 1056 DESCRIPTION 1057 "An entry is made in this table for every entry in the 1058 protocolDirTable for which the values of these counters would 1059 be non-zero. Counters are updated in this table 1060 for every protocol type that is encountered when parsing a 1061 packet." 1062 ::= { protocolDist 2 } 1064 protocolDistStatsEntry OBJECT-TYPE 1065 SYNTAX ProtocolDistStatsEntry 1066 MAX-ACCESS not-accessible 1067 STATUS current 1068 DESCRIPTION 1069 "Every entry in the protocolDirTable potentially has a 1070 corresponding entry in this table. However, this table will 1071 only contain those entries that have a non-zero value of 1072 protocolDistStatsPkts. Counters are updated in this table 1073 for every protocol type that is encountered when parsing a 1074 packet. 1076 The index is composed of the protocolDistControlIndex of the 1077 associated protocolDistControlEntry and the 1078 protocolDirIndex of the associated protocol that this entry 1079 represents." 1080 INDEX { protocolDistControlIndex, 1081 protocolDistStatsProtocolDirIndex } 1082 ::= { protocolDistStatsTable 1 } 1084 ProtocolDistStatsEntry ::= SEQUENCE { 1085 protocolDistStatsProtocolDirIndex Integer32, 1086 protocolDistStatsPkts Counter32, 1087 protocolDistStatsOctets Counter32 1088 } 1090 protocolDistStatsProtocolDirIndex OBJECT-TYPE 1091 SYNTAX Integer32 (1..2147483647) 1092 MAX-ACCESS read-only 1093 STATUS current 1094 DESCRIPTION 1095 "The protocolDirIndex of the protocol this entry represents." 1096 ::= { protocolDistStatsEntry 1 } 1098 protocolDistStatsPkts OBJECT-TYPE 1099 SYNTAX Counter32 1100 MAX-ACCESS read-only 1101 STATUS current 1102 DESCRIPTION 1103 "The number of packets received for this protocol. Note that 1104 this is the number of link-layer packets, so if a single 1105 application layer frame is fragmented into several link-layer 1106 packets, this counter is incremented several times." 1107 ::= { protocolDistStatsEntry 2 } 1109 protocolDistStatsOctets OBJECT-TYPE 1110 SYNTAX Counter32 1111 MAX-ACCESS read-only 1112 STATUS current 1113 DESCRIPTION 1114 "The number of octets received for this protocol." 1115 ::= { protocolDistStatsEntry 3 } 1117 -- 1118 -- Address Map Group (addressMap) 1119 -- 1120 -- network layer address map table 1121 -- addressMapControlTable 1122 -- addressMapTable 1123 -- 1124 addressMapControlTable OBJECT-TYPE 1125 SYNTAX SEQUENCE OF AddressMapControlEntry 1126 MAX-ACCESS not-accessible 1127 STATUS current 1128 DESCRIPTION 1129 "A table to control the collection of network layer address to 1130 physical address to interface mappings. 1132 This is not like the typical RMON controlTable/dataTable in 1133 which each entry creates its own data table. Each entry in 1134 this table enables the discovery of addresses on a new 1135 interface and the placement of address mappings into the 1136 central addressMapTable." 1137 ::= { addressMap 1 } 1139 addressMapControlEntry OBJECT-TYPE 1140 SYNTAX AddressMapControlEntry 1141 MAX-ACCESS not-accessible 1142 STATUS current 1143 DESCRIPTION 1144 "" 1145 INDEX { addressMapControlIndex } 1146 ::= { addressMapControlTable 1 } 1148 AddressMapControlEntry ::= SEQUENCE { 1149 addressMapControlIndex Integer32 (1..65535), 1150 addressMapControlDataSource Integer32, 1151 addressMapControlDroppedFrames Counter32, 1152 addressMapControlActivateTimeStamp TimeTicks, 1153 addressMapControlInserts Counter32, 1154 addressMapControlDeletes Counter32, 1155 addressMapControlOwner OwnerString, 1156 addressMapControlStatus RowStatus 1157 } 1159 addressMapControlIndex OBJECT-TYPE 1160 SYNTAX Integer32 1161 MAX-ACCESS not-accessible 1162 STATUS current 1163 DESCRIPTION 1164 "A unique index for this entry in the addressMapControlTable." 1165 ::= { addressMapControlEntry 1 } 1167 addressMapControlDataSource OBJECT-TYPE 1168 SYNTAX Integer32 1169 MAX-ACCESS read-create 1170 STATUS current 1171 DESCRIPTION 1172 "This object identifies the source of the data that 1173 this addressMapControlEntry entry is configured to analyze. 1174 This source can be any interface on this device. 1176 In order to identify a particular interface, this 1177 object shall identify the instance of the ifIndex 1178 object, defined in [4,6], for the desired interface. 1179 For example, if an entry were to receive data from 1180 interface #1, this object would be set to ifIndex.1. 1182 In order to identify a particular repeater port, this 1183 object shall identify the instance of the rptrGroupPortIndex XXX 1184 object, defined in [XXX], for the desired interface. 1185 For example, if an entry were to receive data from 1186 group #1, port #1, this object would be set to 1187 rptrGroupPortIndex.1.1." 1188 ::= { addressMapControlEntry 2 } 1190 addressMapControlDroppedFrames OBJECT-TYPE 1191 SYNTAX Counter32 1192 MAX-ACCESS read-only 1193 STATUS current 1194 DESCRIPTION 1195 "The total number of frames which were received by the probe 1196 and therefore not accounted for in the *StatsDropEvents, but 1197 for which the probe chose not to count for this entry for 1198 whatever reason. Most often, this event occurs when the probe 1199 is out of some resources and decides to shed load from this 1200 collection. 1202 Note that this number is the exact number of 1203 frames dropped; it must be set as accurately as possible 1204 by the probe." 1205 ::= { addressMapControlEntry 3 } 1207 addressMapControlActivateTimeStamp OBJECT-TYPE 1208 SYNTAX TimeTicks 1209 MAX-ACCESS read-only 1210 STATUS current 1211 DESCRIPTION 1212 "The value of sysUpTime when this control entry was activated. 1213 This can be used by the management station to ensure that the 1214 table has not been deleted and recreated between polls." 1215 ::= { addressMapControlEntry 4 } 1217 addressMapControlInserts OBJECT-TYPE 1218 SYNTAX Counter32 1219 MAX-ACCESS read-only 1220 STATUS current 1221 DESCRIPTION 1222 "The number of times an address mapping entry has been 1223 deleted from this table. If an entry is deleted, then 1224 inserted, and then deleted, this counter will be incremented 1225 by 2. 1227 Note that the table size can be determined by subtracting 1228 addressMapControlDeletes from addressMapControlInserts." 1229 ::= { addressMapControlEntry 5 } 1231 addressMapControlDeletes OBJECT-TYPE 1232 SYNTAX Counter32 1233 MAX-ACCESS read-only 1234 STATUS current 1235 DESCRIPTION 1236 "The number of times an address mapping entry has been 1237 inserted into this table. If an entry is inserted, then 1238 deleted, and then inserted, this counter will be incremented 1239 by 2. 1241 Note that the table size can be determined by subtracting 1242 addressMapControlDeletes from addressMapControlInserts." 1243 ::= { addressMapControlEntry 6 } 1245 addressMapControlOwner OBJECT-TYPE 1246 SYNTAX OwnerString 1247 MAX-ACCESS read-create 1248 STATUS current 1249 DESCRIPTION 1250 "The owner of this addressMap control entry." 1251 ::= { addressMapControlEntry 7 } 1253 addressMapControlStatus OBJECT-TYPE 1254 SYNTAX RowStatus 1255 MAX-ACCESS read-create 1256 STATUS current 1257 DESCRIPTION 1258 "The status of this addressMap control entry. 1260 An entry is not qualified for activation until instances of 1261 all columns of its addressMapControlEntry row have an 1262 appropriate value. 1263 In particular, one or more management set operations are 1264 required to configure the entry: 1265 a value must be written to the addressMapControlDataSource 1266 object. 1268 Until instances of all corresponding columns are 1269 appropriately configured, the value of the corresponding 1270 instance of the addressMapControlStatus column is `notReady'. 1272 For those columnar objects which permit write-access (after 1273 their initial creation), their value in an existing conceptual 1274 row can be changed irrespective of the value of 1275 addressMapControlStatus for that row." 1276 ::= { addressMapControlEntry 8 } 1278 addressMapTable OBJECT-TYPE 1279 SYNTAX SEQUENCE OF AddressMapEntry 1280 MAX-ACCESS not-accessible 1281 STATUS current 1282 DESCRIPTION 1283 "A table of network layer address to physical address to 1284 interface mappings." 1285 ::= { addressMap 2 } 1287 addressMapEntry OBJECT-TYPE 1288 SYNTAX AddressMapEntry 1289 MAX-ACCESS not-accessible 1290 STATUS current 1291 DESCRIPTION 1292 "A table of network layer address to physical address to 1293 interface mappings. 1295 The probe will populate this table for all protocols in the 1296 protocol directory table who's value of 1297 protocolDirAddressMapConfig is equal to supportedOn(3)." 1298 INDEX { addressMapTimeMark, addressMapProtocolDirIndex, 1299 addressMapNetworkAddress, addressMapSource } 1300 ::= { addressMapTable 1 } 1302 AddressMapEntry ::= SEQUENCE { 1303 addressMapTimeMark TimeFilter, 1304 addressMapProtocolDirIndex Integer32, 1305 addressMapNetworkAddress OCTET STRING, 1306 addressMapPhysicalAddress OCTET STRING, 1307 addressMapSource OBJECT IDENTIFIER, 1308 addressMapLastChange TimeTicks 1309 } 1311 addressMapTimeMark OBJECT-TYPE 1312 SYNTAX TimeFilter 1313 MAX-ACCESS not-accessible 1314 STATUS current 1315 DESCRIPTION 1316 "A TimeFilter for this entry. See the TimeFilter textual 1317 convention to see how this works." 1318 ::= { addressMapEntry 1 } 1320 addressMapProtocolDirIndex OBJECT-TYPE 1321 SYNTAX Integer32 (1..2147483647) 1322 MAX-ACCESS read-only 1323 STATUS current 1324 DESCRIPTION 1325 "The protocolDirIndex of the network layer protocol of 1326 this entry's network address." 1327 ::= { addressMapEntry 2 } 1329 addressMapNetworkAddress OBJECT-TYPE 1330 SYNTAX OCTET STRING 1331 MAX-ACCESS not-accessible 1332 STATUS current 1333 DESCRIPTION 1334 "The network address for this relation. 1336 This is represented as an octet string with 1337 specific semantics and length as identified 1338 by the addressMapProtocolDirIndex component. 1340 For example, if the protocolDirIndex indicates an encapsulation 1341 of ip, this object is encoded as the 4 octets of the ip address, 1342 in network byte order. " 1343 ::= { addressMapEntry 3 } 1345 addressMapPhysicalAddress OBJECT-TYPE 1346 SYNTAX OCTET STRING 1347 MAX-ACCESS read-only 1348 STATUS current 1349 DESCRIPTION 1350 "The last physical address on which the associated network address 1351 was seen." 1352 ::= { addressMapEntry 4 } 1354 addressMapSource OBJECT-TYPE 1355 SYNTAX OBJECT IDENTIFIER 1356 MAX-ACCESS read-only 1357 STATUS current 1358 DESCRIPTION 1359 "The last interface or port on which the associated network 1360 address was seen. 1362 If this address mapping was discovered on an interface, this 1363 object shall identify the instance of the ifIndex 1364 object, defined in [4,6], for the desired interface. 1365 For example, if an entry were to receive data from 1366 interface #1, this object would be set to ifIndex.1. 1368 If this address mapping was discovered on a port, this 1369 object shall identify the instance of the rptrGroupPortIndex XXX 1370 object, defined in [XXX], for the desired port. 1371 For example, if an entry were to receive data from 1372 group #1, port #1, this object would be set to 1373 rptrGroupPortIndex.1.1." 1374 ::= { addressMapEntry 5 } 1376 addressMapLastChange OBJECT-TYPE 1377 SYNTAX TimeTicks 1378 MAX-ACCESS read-only 1379 STATUS current 1380 DESCRIPTION 1381 "The value of sysUpTime at the time this entry was created or 1382 the values of the physical address or ifIndex changed." 1383 ::= { addressMapEntry 6 } 1385 hlHostControlTable OBJECT-TYPE 1386 SYNTAX SEQUENCE OF HlHostControlEntry 1387 MAX-ACCESS not-accessible 1388 STATUS current 1389 DESCRIPTION 1390 "A list of higher layer (i.e. non-MAC) host table control entries. 1392 These entries will enable the collection of the host and 1393 application level tables indexed by network addresses. 1395 Entries in the hlHostTable will be created on behalf of each 1396 entry in this table. Additionally, if this probe implements 1397 the alHostTable, entries in the alHostTable will be created on 1398 behalf of each entry in this table." 1399 ::= { nlHost 1 } 1401 hlHostControlEntry OBJECT-TYPE 1402 SYNTAX HlHostControlEntry 1403 MAX-ACCESS not-accessible 1404 STATUS current 1405 DESCRIPTION 1406 "A list of parameters that set up the discovery of 1407 hosts on a particular interface and the collection 1408 of statistics about these hosts in the hlHostTable and 1409 alHostTable." 1410 INDEX { hlHostControlIndex } 1411 ::= { hlHostControlTable 1 } 1413 HlHostControlEntry ::= SEQUENCE { 1414 hlHostControlIndex Integer32 (1..65535), 1415 hlHostControlDataSource OBJECT IDENTIFIER, 1416 hlHostControlActivateTimeStamp TimeTicks, 1417 hlHostControlNlDroppedFrames Counter32, 1418 hlHostControlNlInserts Counter32, 1419 hlHostControlNlDeletes Counter32, 1420 hlHostControlNlMaxDesiredEntries Integer32, 1421 hlHostControlAlDroppedFrames Counter32, 1422 hlHostControlAlInserts Counter32, 1423 hlHostControlAlDeletes Counter32, 1424 hlHostControlAlMaxDesiredEntries Integer32, 1425 hlHostControlOwner OwnerString, 1426 hlHostControlStatus RowStatus 1427 } 1429 hlHostControlIndex OBJECT-TYPE 1430 SYNTAX Integer32 (1..65535) 1431 MAX-ACCESS read-only 1432 STATUS current 1433 DESCRIPTION 1434 "An index that uniquely identifies an entry in the 1435 hlHostControl table. Each such entry defines 1436 a function that discovers hosts on a particular 1437 interface and places statistics about them in the 1438 nlHostTable, and optionally in the alHostTable, on 1439 behalf of this hlHostControlEntry." 1440 ::= { hlHostControlEntry 1 } 1442 hlHostControlDataSource OBJECT-TYPE 1443 SYNTAX OBJECT IDENTIFIER 1444 MAX-ACCESS read-create 1445 STATUS current 1446 DESCRIPTION 1447 "This object identifies the source of the data for 1448 this instance of the host function. This source 1449 can be any interface on this device. In order 1450 to identify a particular interface, this object shall 1451 identify the instance of the ifIndex object, defined 1452 in [4,6], for the desired interface. For example, 1453 if an entry were to receive data from interface #1, 1454 this object would be set to ifIndex.1. 1456 The statistics in this group reflect all packets 1457 on the local network segment attached to the 1458 identified interface. 1460 This object may not be modified if the associated 1461 hlHostControlStatus object is equal to valid(1)." 1462 ::= { hlHostControlEntry 2 } 1464 hlHostControlActivateTimeStamp OBJECT-TYPE 1465 SYNTAX TimeTicks 1466 MAX-ACCESS read-only 1467 STATUS current 1468 DESCRIPTION 1469 "The value of sysUpTime when this control entry was activated. 1470 This can be used by the management station to ensure that the 1471 table has not been deleted and recreated between polls." 1472 ::= { hlHostControlEntry 3 } 1474 hlHostControlNlDroppedFrames OBJECT-TYPE 1475 SYNTAX Counter32 1476 MAX-ACCESS read-only 1477 STATUS current 1478 DESCRIPTION 1479 "The total number of frames which were received by the probe 1480 and therefore not accounted for in the *StatsDropEvents, but 1481 for which the probe chose not to count for this entry for 1482 whatever reason. Most often, this event occurs when the probe 1483 is out of some resources and decides to shed load from this 1484 collection. 1486 Note that this number is the exact number of 1487 frames dropped; it must be set as accurately as possible 1488 by the probe." 1489 ::= { hlHostControlEntry 4 } 1491 hlHostControlNlInserts OBJECT-TYPE 1492 SYNTAX Counter32 1493 MAX-ACCESS read-only 1494 STATUS current 1495 DESCRIPTION 1496 "The number of times an nlHost entry has been 1497 deleted from the nlHost table. If an entry is deleted, then 1498 inserted, and then deleted, this counter will be incremented 1499 by 2. 1501 Note that the table size can be determined by subtracting 1502 hlHostControlNlDeletes from hlHostControlNlInserts." 1503 ::= { hlHostControlEntry 5 } 1505 hlHostControlNlDeletes OBJECT-TYPE 1506 SYNTAX Counter32 1507 MAX-ACCESS read-only 1508 STATUS current 1509 DESCRIPTION 1510 "The number of times an nlHost entry has been 1511 inserted into the nlHost table. If an entry is inserted, then 1512 deleted, and then inserted, this counter will be incremented 1513 by 2. 1515 Note that the table size can be determined by subtracting 1516 hlHostControlDeletes from hlHostControlInserts." 1517 ::= { hlHostControlEntry 6 } 1519 hlHostControlNlMaxDesiredEntries OBJECT-TYPE 1520 SYNTAX Integer32 1521 MAX-ACCESS read-create 1522 STATUS current 1523 DESCRIPTION 1524 "The maximum number of entries that are desired in the 1525 associated nlHostTable. The probe will not create more than 1526 this number of entries in the table, but may choose to create 1527 fewer entries in this table for any reason including the lack 1528 of resources. 1530 If this value is set to zero, the probe may create any number 1531 of entries in this table. 1533 This object may be used to control how resources are allocated 1534 on the probe for the various RMON functions." 1535 ::= { hlHostControlEntry 7 } 1537 hlHostControlAlDroppedFrames OBJECT-TYPE 1538 SYNTAX Counter32 1539 MAX-ACCESS read-only 1540 STATUS current 1541 DESCRIPTION 1542 "The total number of frames which were received by the probe 1543 and therefore not accounted for in the *StatsDropEvents, but 1544 for which the probe chose not to count for this entry for 1545 whatever reason. Most often, this event occurs when the probe 1546 is out of some resources and decides to shed load from this 1547 collection. 1549 Note that this number is the exact number of 1550 frames dropped; it must be set as accurately as possible 1551 by the probe." 1552 ::= { hlHostControlEntry 8 } 1554 hlHostControlAlInserts OBJECT-TYPE 1555 SYNTAX Counter32 1556 MAX-ACCESS read-only 1557 STATUS current 1558 DESCRIPTION 1559 "The number of times an alHost entry has been 1560 deleted from the alHost table. If an entry is deleted, then 1561 inserted, and then deleted, this counter will be incremented 1562 by 2. 1564 Note that the table size can be determined by subtracting 1565 hlHostControlAlDeletes from hlHostControlAlInserts." 1567 ::= { hlHostControlEntry 9 } 1569 hlHostControlAlDeletes OBJECT-TYPE 1570 SYNTAX Counter32 1571 MAX-ACCESS read-only 1572 STATUS current 1573 DESCRIPTION 1574 "The number of times an alHost entry has been 1575 inserted into the alHost table. If an entry is inserted, then 1576 deleted, and then inserted, this counter will be incremented 1577 by 2. 1579 Note that the table size can be determined by subtracting 1580 hlHostControlAlDeletes from hlHostControlAlInserts." 1581 ::= { hlHostControlEntry 10 } 1583 hlHostControlAlMaxDesiredEntries OBJECT-TYPE 1584 SYNTAX Integer32 1585 MAX-ACCESS read-create 1586 STATUS current 1587 DESCRIPTION 1588 "The maximum number of entries that are desired in the alHost 1589 table. The probe will not create more than this number of 1590 entries in the table, but may choose to create fewer entries 1591 in this table for any reason including the lack of resources. 1593 If this value is set to zero, the probe may create any number 1594 of entries in this table. 1596 This object may be used to control how resources are allocated 1597 on the probe for the various RMON functions." 1598 ::= { hlHostControlEntry 11 } 1600 hlHostControlOwner OBJECT-TYPE 1601 SYNTAX OwnerString 1602 MAX-ACCESS read-create 1603 STATUS current 1604 DESCRIPTION 1605 "The entity that configured this entry and is 1606 therefore using the resources assigned to it." 1607 ::= { hlHostControlEntry 12 } 1609 hlHostControlStatus OBJECT-TYPE 1610 SYNTAX RowStatus 1611 MAX-ACCESS read-create 1612 STATUS current 1613 DESCRIPTION 1614 "The status of this hlHostControl entry. 1616 If this object is not equal to valid(1), all 1617 associated entries in the nlHostTable and alHostTable 1618 shall be deleted by the agent." 1619 ::= { hlHostControlEntry 13 } 1621 nlHostTable OBJECT-TYPE 1622 SYNTAX SEQUENCE OF NlHostEntry 1623 MAX-ACCESS not-accessible 1624 STATUS current 1625 DESCRIPTION 1626 "A list of nlHost entries. Each such entry defines statistics 1627 for packets from and to a particular network address." 1628 ::= { nlHost 2 } 1630 nlHostEntry OBJECT-TYPE 1631 SYNTAX NlHostEntry 1632 MAX-ACCESS not-accessible 1633 STATUS current 1634 DESCRIPTION 1635 "A collection of statistics for a particular host 1636 that has been discovered on an interface of this 1637 device. 1639 The probe will populate this table for all network layer 1640 protocols in the protocol directory table who's value of 1641 protocolDirNlHostConfig is equal to supportedOn(3). 1643 The probe will add to this table all hosts who's address it 1644 sees as the source or destination address in all good MAC 1645 packets." 1646 INDEX { hlHostControlIndex, nlHostTimeMark, 1647 nlHostProtocolDirIndex, nlHostAddress } 1648 ::= { nlHostTable 1 } 1650 NlHostEntry ::= SEQUENCE { 1651 nlHostTimeMark TimeFilter, 1652 nlHostProtocolDirIndex Integer32, 1653 nlHostAddress OCTET STRING, 1654 nlHostInPkts Counter32, 1655 nlHostOutPkts Counter32, 1656 nlHostInOctets Counter32, 1657 nlHostOutOctets Counter32, 1658 nlHostOutMacNonUnicastPkts Counter32 1659 } 1661 nlHostTimeMark OBJECT-TYPE 1662 SYNTAX TimeFilter 1663 MAX-ACCESS not-accessible 1664 STATUS current 1665 DESCRIPTION 1666 "A TimeFilter for this entry. See the TimeFilter textual 1667 convention to see how this works." 1668 ::= { nlHostEntry 1 } 1670 nlHostProtocolDirIndex OBJECT-TYPE 1671 SYNTAX Integer32 (1..2147483647) 1672 MAX-ACCESS read-only 1673 STATUS current 1674 DESCRIPTION 1675 "The protocolDirIndex of the network layer protocol of 1676 this entry's network address." 1677 ::= { nlHostEntry 2 } 1679 nlHostAddress OBJECT-TYPE 1680 SYNTAX OCTET STRING 1681 MAX-ACCESS not-accessible 1682 STATUS current 1683 DESCRIPTION 1684 "The network address for this nlHostEntry. 1686 This is represented as an octet string with 1687 specific semantics and length as identified 1688 by the protocolDirIndex component." 1689 ::= { nlHostEntry 3 } 1691 nlHostInPkts OBJECT-TYPE 1692 SYNTAX Counter32 1693 MAX-ACCESS read-only 1694 STATUS current 1695 DESCRIPTION 1696 "The number of packets without errors transmitted to 1697 this address since it was added to the nlHostTable." 1698 ::= { nlHostEntry 4 } 1700 nlHostOutPkts OBJECT-TYPE 1701 SYNTAX Counter32 1702 MAX-ACCESS read-only 1703 STATUS current 1704 DESCRIPTION 1705 "The number of packets including errors transmitted 1706 by this address since it was added to the nlHostTable." 1707 ::= { nlHostEntry 5 } 1709 nlHostInOctets OBJECT-TYPE 1710 SYNTAX Counter32 1711 MAX-ACCESS read-only 1712 STATUS current 1713 DESCRIPTION 1714 "The number of octets transmitted to this address 1715 since it was added to the nlHostTable (excluding 1716 framing bits but including FCS octets), except for 1717 those octets in packets that contained errors." 1718 ::= { nlHostEntry 6 } 1720 nlHostOutOctets OBJECT-TYPE 1721 SYNTAX Counter32 1722 MAX-ACCESS read-only 1723 STATUS current 1724 DESCRIPTION 1725 "The number of octets transmitted by this address 1726 since it was added to the nlHostTable (excluding 1727 framing bits but including FCS octets), including 1728 those octets in packets that contained errors." 1729 ::= { nlHostEntry 7 } 1731 nlHostOutMacNonUnicastPkts OBJECT-TYPE 1732 SYNTAX Counter32 1733 MAX-ACCESS read-only 1734 STATUS current 1735 DESCRIPTION 1736 "The number of good packets transmitted by this 1737 address that were directed to the broadcast address 1738 or to the multicast address since this host was added 1739 to the nlHostTable." 1740 ::= { nlHostEntry 8 } 1742 hlMatrixControlTable OBJECT-TYPE 1743 SYNTAX SEQUENCE OF HlMatrixControlEntry 1744 MAX-ACCESS not-accessible 1745 STATUS current 1746 DESCRIPTION 1747 "A list of higher layer (i.e. non-MAC) matrix table control 1748 entries. 1750 These entries will enable the collection of the host and 1751 application level matrix tables indexed by pairs of network 1752 addresses. 1754 Entries in the hlMatrixTable will be created on behalf of each 1755 entry in this table. Additionally, if this probe implements 1756 the alMatrix tables, entries in the alMatrix tables will be 1757 created on behalf of each entry in this table." 1758 ::= { nlMatrix 1 } 1760 hlMatrixControlEntry OBJECT-TYPE 1761 SYNTAX HlMatrixControlEntry 1762 MAX-ACCESS not-accessible 1763 STATUS current 1764 DESCRIPTION 1765 "A list of parameters that set up the discovery of 1766 conversations on a particular interface and the collection 1767 of statistics about these conversations in the hlMatrixTable and 1768 alMatrixTable." 1769 INDEX { hlMatrixControlIndex } 1770 ::= { hlMatrixControlTable 1 } 1772 HlMatrixControlEntry ::= SEQUENCE { 1773 hlMatrixControlIndex Integer32 (1..65535), 1774 hlMatrixControlDataSource OBJECT IDENTIFIER, 1775 hlMatrixControlActivateTimeStamp TimeTicks, 1776 hlMatrixControlNlDroppedFrames Counter32, 1777 hlMatrixControlNlInserts Counter32, 1778 hlMatrixControlNlDeletes Counter32, 1779 hlMatrixControlNlMaxDesiredEntries Integer32, 1780 hlMatrixControlAlDroppedFrames Counter32, 1781 hlMatrixControlAlInserts Counter32, 1782 hlMatrixControlAlDeletes Counter32, 1783 hlMatrixControlAlMaxDesiredEntries Integer32, 1784 hlMatrixControlOwner OwnerString, 1785 hlMatrixControlStatus RowStatus 1786 } 1788 hlMatrixControlIndex OBJECT-TYPE 1789 SYNTAX Integer32 (1..65535) 1790 MAX-ACCESS read-only 1791 STATUS current 1792 DESCRIPTION 1793 "An index that uniquely identifies an entry in the 1794 hlMatrixControl table. Each such entry defines 1795 a function that discovers conversations on a particular 1796 interface and places statistics about them in the 1797 hlMatrixSDTable and the hlMatrixDSTable, and optionally the 1798 alMatrixSDTable and alMatrixDSTable, on behalf of this 1799 hlMatrixControlEntry." 1800 ::= { hlMatrixControlEntry 1 } 1802 hlMatrixControlDataSource OBJECT-TYPE 1803 SYNTAX OBJECT IDENTIFIER 1804 MAX-ACCESS read-create 1805 STATUS current 1806 DESCRIPTION 1807 "This object identifies the source of 1808 the data from which this entry creates a traffic matrix. 1809 This source can be any interface on this device. In 1810 order to identify a particular interface, this object 1811 shall identify the instance of the ifIndex object, 1812 defined in [4,6], for the desired interface. For 1813 example, if an entry were to receive data from 1814 interface #1, this object would be set to ifIndex.1. 1816 The statistics in this group reflect all packets 1817 on the local network segment attached to the 1818 identified interface. 1820 This object may not be modified if the associated 1821 hlMatrixControlStatus object is equal to valid(1)." 1822 ::= { hlMatrixControlEntry 2 } 1824 hlMatrixControlActivateTimeStamp OBJECT-TYPE 1825 SYNTAX TimeTicks 1826 MAX-ACCESS read-only 1827 STATUS current 1828 DESCRIPTION 1829 "The value of sysUpTime when this control entry was activated. 1830 This can be used by the management station to ensure that the 1831 table has not been deleted and recreated between polls." 1832 ::= { hlMatrixControlEntry 3 } 1834 hlMatrixControlNlDroppedFrames OBJECT-TYPE 1835 SYNTAX Counter32 1836 MAX-ACCESS read-only 1837 STATUS current 1838 DESCRIPTION 1839 "The total number of frames which were received by the probe 1840 and therefore not accounted for in the *StatsDropEvents, but 1841 for which the probe chose not to count for this entry for 1842 whatever reason. Most often, this event occurs when the probe 1843 is out of some resources and decides to shed load from this 1844 collection. 1846 Note that this number is the exact number of 1847 frames dropped; it must be set as accurately as possible 1848 by the probe." 1849 ::= { hlMatrixControlEntry 4 } 1851 hlMatrixControlNlInserts OBJECT-TYPE 1852 SYNTAX Counter32 1853 MAX-ACCESS read-only 1854 STATUS current 1855 DESCRIPTION 1856 "The number of times an nlMatrix entry has been 1857 inserted to the nlMatrix tables. If an entry is deleted, then 1858 inserted, and then deleted, this counter will be incremented 1859 by 2. The addition of a conversation into both the 1860 nlMatrixSDTable and nlMatrixDSTable shall be counted as two 1861 insertions (even though every addition into one table must be 1862 accompanied by an insertion into the other). 1864 Note that the table size can be determined by subtracting 1865 hlMatrixControlNlDeletes from hlMatrixControlNlInserts." 1866 ::= { hlMatrixControlEntry 5 } 1868 hlMatrixControlNlDeletes OBJECT-TYPE 1869 SYNTAX Counter32 1870 MAX-ACCESS read-only 1871 STATUS current 1872 DESCRIPTION 1873 "The number of times an nlMatrix entry has been 1874 deleted from the nlMatrix tables. If an entry is inserted, then 1875 deleted, and then inserted, this counter will be incremented 1876 by 2. The deletion of a conversation from both the 1877 nlMatrixSDTable and nlMatrixDSTable shall be counted as two 1878 deletions (even though every deletion from one table must be 1879 accompanied by a deletion from the other). 1881 Note that the table size can be determined by subtracting 1882 hlMatrixMatrixNlDeletes from hlMatrixControlNlInserts." 1883 ::= { hlMatrixControlEntry 6 } 1885 hlMatrixControlNlMaxDesiredEntries OBJECT-TYPE 1886 SYNTAX Integer32 1887 MAX-ACCESS read-create 1888 STATUS current 1889 DESCRIPTION 1890 "The maximum number of entries that are desired in the 1891 nlMatrix tables. The probe will not create more than this 1892 number of entries in the table, but may choose to create fewer 1893 entries in this table for any reason including the lack of 1894 resources. 1896 If this value is set to zero, the probe may create any number 1897 of entries in this table. 1899 This object may be used to control how resources are allocated 1900 on the probe for the various RMON functions." 1901 ::= { hlMatrixControlEntry 7 } 1903 hlMatrixControlAlDroppedFrames OBJECT-TYPE 1904 SYNTAX Counter32 1905 MAX-ACCESS read-only 1906 STATUS current 1907 DESCRIPTION 1908 "The total number of frames which were received by the probe 1909 and therefore not accounted for in the *StatsDropEvents, but 1910 for which the probe chose not to count for this entry for 1911 whatever reason. Most often, this event occurs when the probe 1912 is out of some resources and decides to shed load from this 1913 collection. 1915 Note that this number is the exact number of 1916 frames dropped; it must be set as accurately as possible 1917 by the probe." 1918 ::= { hlMatrixControlEntry 8 } 1920 hlMatrixControlAlInserts OBJECT-TYPE 1921 SYNTAX Counter32 1922 MAX-ACCESS read-only 1923 STATUS current 1924 DESCRIPTION 1925 "The number of times an alMatrix entry has been 1926 inserted to the alMatrix tables. If an entry is deleted, then 1927 inserted, and then deleted, this counter will be incremented 1928 by 2. The addition of a conversation into both the 1929 alMatrixSDTable and alMatrixDSTable shall be counted as two 1930 insertions (even though every addition into one table must be 1931 accompanied by an insertion into the other). 1933 Note that the table size can be determined by subtracting 1934 hlMatrixControlAlDeletes from hlMatrixControlAlInserts." 1935 ::= { hlMatrixControlEntry 9 } 1937 hlMatrixControlAlDeletes OBJECT-TYPE 1938 SYNTAX Counter32 1939 MAX-ACCESS read-only 1940 STATUS current 1941 DESCRIPTION 1942 "The number of times an alMatrix entry has been 1943 deleted from the alMatrix tables. If an entry is inserted, then 1944 deleted, and then inserted, this counter will be incremented 1945 by 2. The deletion of a conversation from both the 1946 alMatrixSDTable and alMatrixDSTable shall be counted as two 1947 deletions (even though every deletion from one table must be 1948 accompanied by a deletion from the other). 1950 Note that the table size can be determined by subtracting 1951 hlMatrixMatrixAlDeletes from hlMatrixControlAlInserts." 1952 ::= { hlMatrixControlEntry 10 } 1954 hlMatrixControlAlMaxDesiredEntries OBJECT-TYPE 1955 SYNTAX Integer32 1956 MAX-ACCESS read-create 1957 STATUS current 1958 DESCRIPTION 1959 "The maximum number of entries that are desired in the 1960 alMatrix tables. The probe will not create more than this 1961 number of entries in the table, but may choose to create fewer 1962 entries in this table for any reason including the lack of 1963 resources. 1965 If this value is set to zero, the probe may create any number 1966 of entries in this table. 1968 This object may be used to control how resources are allocated 1969 on the probe for the various RMON functions." 1970 ::= { hlMatrixControlEntry 11 } 1972 hlMatrixControlOwner OBJECT-TYPE 1973 SYNTAX OwnerString 1974 MAX-ACCESS read-create 1975 STATUS current 1976 DESCRIPTION 1977 "The entity that configured this entry and is 1978 therefore using the resources assigned to it." 1979 ::= { hlMatrixControlEntry 12 } 1981 hlMatrixControlStatus OBJECT-TYPE 1982 SYNTAX RowStatus 1983 MAX-ACCESS read-create 1984 STATUS current 1985 DESCRIPTION 1986 "The status of this hlMatrixControl entry. 1988 If this object is not equal to valid(1), all 1989 associated entries in the hlMatrixSDTable and the 1990 hlMatrixDSTable shall be deleted by the agent." 1991 ::= { hlMatrixControlEntry 13 } 1993 nlMatrixSDTable OBJECT-TYPE 1994 SYNTAX SEQUENCE OF NlMatrixSDEntry 1995 MAX-ACCESS not-accessible 1996 STATUS current 1997 DESCRIPTION 1998 "A list of traffic matrix entries indexed by 1999 source and destination network-level address." 2000 ::= { nlMatrix 2 } 2002 nlMatrixSDEntry OBJECT-TYPE 2003 SYNTAX NlMatrixSDEntry 2004 MAX-ACCESS not-accessible 2005 STATUS current 2006 DESCRIPTION 2007 "A collection of statistics for communications between 2008 two addresses on a particular interface. 2010 The probe will populate this table for all network layer 2011 protocols in the protocol directory table who's value of 2012 protocolDirNlMatrixConfig is equal to supportedOn(3)." 2013 INDEX { hlMatrixControlIndex, nlMatrixSDTimeMark, 2014 nlMatrixSDProtocolDirIndex, 2015 nlMatrixSDSourceAddress, nlMatrixSDDestAddress } 2016 ::= { nlMatrixSDTable 1 } 2018 NlMatrixSDEntry ::= SEQUENCE { 2019 nlMatrixSDIndex Integer32 (1..65535), 2020 nlMatrixSDTimeMark TimeFilter, 2021 nlMatrixSDProtocolDirIndex Integer32, 2022 nlMatrixSDSourceAddress OCTET STRING, 2023 nlMatrixSDDestAddress OCTET STRING, 2024 nlMatrixSDPkts Counter32, 2025 nlMatrixSDOctets Counter32 2026 } 2028 nlMatrixSDIndex OBJECT-TYPE 2029 SYNTAX Integer32 (1..65535) 2030 MAX-ACCESS read-only 2031 STATUS current 2032 DESCRIPTION 2033 "The set of collected matrix statistics of which 2034 this entry is a part. The set of matrix statistics 2035 identified by a particular value of this index 2036 is associated with the same nlMatrixControlEntry 2037 as identified by the same value of hlMatrixControlIndex." 2038 ::= { nlMatrixSDEntry 1 } 2040 nlMatrixSDTimeMark OBJECT-TYPE 2041 SYNTAX TimeFilter 2042 MAX-ACCESS not-accessible 2043 STATUS current 2044 DESCRIPTION 2045 "A TimeFilter for this entry. See the TimeFilter textual 2046 convention to see how this works." 2047 ::= { nlMatrixSDEntry 2 } 2049 nlMatrixSDProtocolDirIndex OBJECT-TYPE 2050 SYNTAX Integer32 (1..2147483647) 2051 MAX-ACCESS read-only 2052 STATUS current 2053 DESCRIPTION 2054 "The protocolDirIndex of the network layer protocol of 2055 this entry's network address." 2056 ::= { nlMatrixSDEntry 3 } 2058 nlMatrixSDSourceAddress OBJECT-TYPE 2059 SYNTAX OCTET STRING 2060 MAX-ACCESS read-only 2061 STATUS current 2062 DESCRIPTION 2063 "The type of network source address for this nlMatrixSDEntry. 2065 This object is formatted as appropriate to the 2066 protocolDirIndex associated with this instance." 2067 ::= { nlMatrixSDEntry 4 } 2069 nlMatrixSDDestAddress OBJECT-TYPE 2070 SYNTAX OCTET STRING 2071 MAX-ACCESS read-only 2072 STATUS current 2073 DESCRIPTION 2074 "The type of network destination address for this nlMatrixSDEntry. 2076 This object is formatted as appropriate to the 2077 protocolDirIndex associated with this instance." 2078 ::= { nlMatrixSDEntry 5 } 2080 nlMatrixSDPkts OBJECT-TYPE 2081 SYNTAX Counter32 2082 MAX-ACCESS read-only 2083 STATUS current 2084 DESCRIPTION 2085 "The number of packets transmitted from the source 2086 address to the destination address (this number 2087 includes error packets)." 2088 ::= { nlMatrixSDEntry 6 } 2090 nlMatrixSDOctets OBJECT-TYPE 2091 SYNTAX Counter32 2092 MAX-ACCESS read-only 2093 STATUS current 2094 DESCRIPTION 2095 "The number of octets (excluding framing bits but 2096 including FCS octets) contained in all packets 2097 transmitted from the source address to the 2098 destination address." 2099 ::= { nlMatrixSDEntry 7 } 2101 -- Traffic matrix tables from destination to source 2103 nlMatrixDSTable OBJECT-TYPE 2104 SYNTAX SEQUENCE OF NlMatrixDSEntry 2105 MAX-ACCESS not-accessible 2106 STATUS current 2107 DESCRIPTION 2108 "A list of traffic matrix entries indexed by 2109 destination and source network-level address." 2110 ::= { nlMatrix 3 } 2112 nlMatrixDSEntry OBJECT-TYPE 2113 SYNTAX NlMatrixDSEntry 2114 MAX-ACCESS not-accessible 2115 STATUS current 2116 DESCRIPTION 2117 "A collection of statistics for communications between 2118 two address on a particular interface. 2120 The probe will populate this table for all network layer 2121 protocols in the protocol directory table who's value of 2122 protocolDirNlMatrixConfig is set to supportedOn(3)." 2123 INDEX { hlMatrixControlIndex, nlMatrixDSTimeMark, 2124 nlMatrixDSProtocolDirIndex, 2125 nlMatrixDSDestAddress, nlMatrixDSSourceAddress } 2126 ::= { nlMatrixDSTable 1 } 2128 NlMatrixDSEntry ::= SEQUENCE { 2129 nlMatrixDSIndex Integer32 (1..65535), 2130 nlMatrixDSTimeMark TimeFilter, 2131 nlMatrixDSProtocolDirIndex Integer32, 2132 nlMatrixDSSourceAddress OCTET STRING, 2133 nlMatrixDSDestAddress OCTET STRING, 2134 nlMatrixDSPkts Counter32, 2135 nlMatrixDSOctets Counter32 2136 } 2138 nlMatrixDSIndex OBJECT-TYPE 2139 SYNTAX Integer32 (1..65535) 2140 MAX-ACCESS read-only 2141 STATUS current 2142 DESCRIPTION 2143 "The set of collected matrix statistics of which 2144 this entry is a part. The set of matrix statistics 2145 identified by a particular value of this index 2146 is associated with the same nlMatrixControlEntry 2147 as identified by the same value of hlMatrixControlIndex." 2148 ::= { nlMatrixDSEntry 1 } 2150 nlMatrixDSTimeMark OBJECT-TYPE 2151 SYNTAX TimeFilter 2152 MAX-ACCESS not-accessible 2153 STATUS current 2154 DESCRIPTION 2155 "A TimeFilter for this entry. See the TimeFilter textual 2156 convention to see how this works." 2157 ::= { nlMatrixDSEntry 2 } 2159 nlMatrixDSProtocolDirIndex OBJECT-TYPE 2160 SYNTAX Integer32 (1..2147483647) 2161 MAX-ACCESS read-only 2162 STATUS current 2163 DESCRIPTION 2164 "The protocolDirIndex of the network layer protocol of 2165 this entry's network address." 2166 ::= { nlMatrixDSEntry 3 } 2168 nlMatrixDSSourceAddress OBJECT-TYPE 2169 SYNTAX OCTET STRING 2170 MAX-ACCESS read-only 2171 STATUS current 2172 DESCRIPTION 2173 "The type of network source address for this nlMatrixDSEntry. 2175 This object is formatted as appropriate to the 2176 protocolDirIndex associated with this instance." 2177 ::= { nlMatrixDSEntry 4 } 2179 nlMatrixDSDestAddress OBJECT-TYPE 2180 SYNTAX OCTET STRING 2181 MAX-ACCESS read-only 2182 STATUS current 2183 DESCRIPTION 2184 "The type of network destination address for this nlMatrixDSEntry. 2186 This object is formatted as appropriate to the 2187 protocolDirIndex associated with this instance." 2188 ::= { nlMatrixDSEntry 5 } 2190 nlMatrixDSPkts OBJECT-TYPE 2191 SYNTAX Counter32 2192 MAX-ACCESS read-only 2193 STATUS current 2194 DESCRIPTION 2195 "The number of packets transmitted from the source 2196 address to the destination address (this number 2197 includes error packets)." 2199 ::= { nlMatrixDSEntry 6 } 2201 nlMatrixDSOctets OBJECT-TYPE 2202 SYNTAX Counter32 2203 MAX-ACCESS read-only 2204 STATUS current 2205 DESCRIPTION 2206 "The number of octets (excluding framing bits 2207 but including FCS octets) contained in all packets 2208 transmitted from the source address to the 2209 destination address." 2210 ::= { nlMatrixDSEntry 7 } 2212 nlMatrixTopNControlTable OBJECT-TYPE 2213 SYNTAX SEQUENCE OF NlMatrixTopNControlEntry 2214 MAX-ACCESS not-accessible 2215 STATUS current 2216 DESCRIPTION 2217 "A list of nlMatrix top N control entries." 2218 ::= { nlMatrix 4 } 2220 nlMatrixTopNControlEntry OBJECT-TYPE 2221 SYNTAX NlMatrixTopNControlEntry 2222 MAX-ACCESS not-accessible 2223 STATUS current 2224 DESCRIPTION 2225 "A set of parameters that control the creation of a 2226 report of the top N matrix entries according to several 2227 metrics. For example, an instance of the 2228 nlMatrixTopNDuration object might be named 2229 nlMatrixTopNDuration.3" 2230 INDEX { nlMatrixTopNControlIndex } 2231 ::= { nlMatrixTopNControlTable 1 } 2233 NlMatrixTopNControlEntry ::= SEQUENCE { 2234 nlMatrixTopNControlIndex Integer32 (1..65535), 2235 nlMatrixTopNMatrixIndex Integer32 (1..65535), 2236 nlMatrixTopNRateBase INTEGER, 2237 nlMatrixTopNTimeRemaining Integer32, 2238 nlMatrixTopNDuration Integer32, 2239 nlMatrixTopNRequestedSize Integer32, 2240 nlMatrixTopNGrantedSize Integer32, 2241 nlMatrixTopNStartTime TimeTicks, 2242 nlMatrixTopNOwner OwnerString, 2243 nlMatrixTopNStatus RowStatus 2245 } 2247 nlMatrixTopNControlIndex OBJECT-TYPE 2248 SYNTAX Integer32 (1..65535) 2249 MAX-ACCESS read-only 2250 STATUS current 2251 DESCRIPTION 2252 "An index that uniquely identifies an entry 2253 in the nlMatrixTopNControl table. Each such 2254 entry defines one top N report prepared for 2255 one interface." 2256 ::= { nlMatrixTopNControlEntry 1 } 2258 nlMatrixTopNMatrixIndex OBJECT-TYPE 2259 SYNTAX Integer32 (1..65535) 2260 MAX-ACCESS read-create 2261 STATUS current 2262 DESCRIPTION 2263 "The nlMatrix table for which a top N report will be 2264 prepared on behalf of this entry. The nlMatrix table 2265 identified by a particular value of this index is 2266 associated with the same nlMatrix table as identified by 2267 the same value of nlMatrixIndex. 2269 This object may not be modified if the associated 2270 nlMatrixTopNStatus object is equal to valid(1)." 2271 ::= { nlMatrixTopNControlEntry 2 } 2273 nlMatrixTopNRateBase OBJECT-TYPE 2274 SYNTAX INTEGER { 2275 nlMatrixTopNSourceToDestPkts(1), 2276 nlMatrixTopNDestToSourcePkts(2), 2277 nlMatrixTopNSourceToDestOctets(3), 2278 nlMatrixTopNDestToSourceOctets(4) 2279 } 2280 MAX-ACCESS read-create 2281 STATUS current 2282 DESCRIPTION 2283 "The variable for each nlMatrix entry that the nlMatrixTopNRate 2284 variable is based upon, as well as the selector of the matrix 2285 table that will be used. 2287 This object may not be modified if the associated 2288 nlMatrixTopNStatus object is equal to valid(1)." 2289 ::= { nlMatrixTopNControlEntry 3 } 2291 nlMatrixTopNTimeRemaining OBJECT-TYPE 2292 SYNTAX Integer32 2293 MAX-ACCESS read-create 2294 STATUS current 2295 DESCRIPTION 2296 "The number of seconds left in the report currently 2297 being collected. When this object is modified by 2298 the management station, a new collection is started, 2299 possibly aborting a currently running report. The 2300 new value is used as the requested duration of this 2301 report, and is loaded into the associated 2302 nlMatrixTopNDuration object when the report is finished. 2303 When the report finishes, the probe will automatically 2304 start another collection with the same initial value 2305 of nlMatrixTopNTimeRemaining. 2307 While the value of this object is non-zero, it decrements 2308 by one per second until it reaches zero. At the time 2309 that this object decrements to zero, the report is made 2310 accessible in the nlMatrixTopNTable, overwriting any report 2311 that may be there. 2313 (Note that this is a different algorithm than in 2314 the hostTopNTable)." 2315 DEFVAL { 0 } 2316 ::= { nlMatrixTopNControlEntry 4 } 2318 nlMatrixTopNDuration OBJECT-TYPE 2319 SYNTAX Integer32 2320 MAX-ACCESS read-only 2321 STATUS current 2322 DESCRIPTION 2323 "The number of seconds that this report has collected 2324 during the last sampling interval. 2326 When the associated nlMatrixTopNTimeRemaining object is 2327 set, this object shall be set by the probe to the 2328 same value and shall not be modified until the next 2329 time the nlMatrixTopNTimeRemaining is set. 2331 This value shall be zero if no reports have been 2332 requested for this nlMatrixTopNControlEntry." 2333 DEFVAL { 0 } 2334 ::= { nlMatrixTopNControlEntry 5 } 2336 nlMatrixTopNRequestedSize OBJECT-TYPE 2337 SYNTAX Integer32 2338 MAX-ACCESS read-create 2339 STATUS current 2340 DESCRIPTION 2341 "The maximum number of matrix entries requested for the top N 2342 table. 2344 When this object is created or modified, the probe 2345 should set nlMatrixTopNGrantedSize as closely to this 2346 object as is possible for the particular probe 2347 implementation and available resources." 2348 DEFVAL { 10 } 2349 ::= { nlMatrixTopNControlEntry 6 } 2351 nlMatrixTopNGrantedSize OBJECT-TYPE 2352 SYNTAX Integer32 2353 MAX-ACCESS read-only 2354 STATUS current 2355 DESCRIPTION 2356 "The maximum number of matrix entries in the top N table. 2358 When the associated nlMatrixTopNRequestedSize object is 2359 created or modified, the probe should set this 2360 object as closely to the requested value as is 2361 possible for the particular implementation and 2362 available resources. The probe must not lower this 2363 value except as a result of a set to the associated 2364 nlMatrixTopNRequestedSize object. 2365 When the next topN report is generated, matrix entries 2366 with the highest value of nlMatrixTopNRate shall 2367 be placed in this table in decreasing order of this rate 2368 until there is no more room or until there are no more 2369 matrix entries." 2370 ::= { nlMatrixTopNControlEntry 7 } 2372 nlMatrixTopNStartTime OBJECT-TYPE 2373 SYNTAX TimeTicks 2374 MAX-ACCESS read-only 2375 STATUS current 2376 DESCRIPTION 2377 "The value of sysUpTime when this top N report was 2378 last started. In other words, this is the time that 2379 the associated nlMatrixTopNTimeRemaining object was 2380 modified to start the requested report or the time 2381 the report was last automatically (re)started." 2382 ::= { nlMatrixTopNControlEntry 8 } 2384 nlMatrixTopNOwner OBJECT-TYPE 2385 SYNTAX OwnerString 2386 MAX-ACCESS read-create 2387 STATUS current 2388 DESCRIPTION 2389 "The entity that configured this entry and is 2390 therefore using the resources assigned to it." 2391 ::= { nlMatrixTopNControlEntry 9 } 2393 nlMatrixTopNStatus OBJECT-TYPE 2394 SYNTAX RowStatus 2395 MAX-ACCESS read-create 2396 STATUS current 2397 DESCRIPTION 2398 "The status of this nlMatrixTopNControl entry. 2400 If this object is not equal to valid(1), all 2401 associated nlMatrixTopNEntries shall be deleted by the 2402 agent." 2403 ::= { nlMatrixTopNControlEntry 10 } 2405 nlMatrixTopNTable OBJECT-TYPE 2406 SYNTAX SEQUENCE OF NlMatrixTopNEntry 2407 MAX-ACCESS not-accessible 2408 STATUS current 2409 DESCRIPTION 2410 "A list of top N nlMatrix entries." 2411 ::= { nlMatrix 5 } 2413 nlMatrixTopNEntry OBJECT-TYPE 2414 SYNTAX NlMatrixTopNEntry 2415 MAX-ACCESS not-accessible 2416 STATUS current 2417 DESCRIPTION 2418 "A set of statistics for a matrix entry that is part of a 2419 top N report. For example, an instance of the 2420 nlMatrixTopNRate object might be named 2421 nlMatrixTopNRate.3.10 2423 The value of nlMatrixTopNControlIndex in the index is 2424 that of the associated nlMatrix on who's behalf this study 2425 was prepared." 2427 INDEX { nlMatrixTopNControlIndex, nlMatrixTopNIndex } 2428 ::= { nlMatrixTopNTable 1 } 2430 NlMatrixTopNEntry ::= SEQUENCE { 2431 nlMatrixTopNIndex Integer32 (1..65535), 2432 nlMatrixTopNProtocolDirIndex OBJECT IDENTIFIER, 2433 nlMatrixTopNSourceAddress OCTET STRING, 2434 nlMatrixTopNDestinationAddress OCTET STRING, 2435 nlMatrixTopNRate Integer32 2436 } 2438 nlMatrixTopNIndex OBJECT-TYPE 2439 SYNTAX Integer32 (1..65535) 2440 MAX-ACCESS read-only 2441 STATUS current 2442 DESCRIPTION 2443 "An index that uniquely identifies an entry in 2444 the nlMatrixTopN table among those in the same report. 2445 This index is between 1 and N, where N is the 2446 number of entries in this table. Increasing values 2447 of nlMatrixTopNIndex shall be assigned to entries with 2448 decreasing values of nlMatrixTopNRate until index N 2449 is assigned to the entry with the lowest value of 2450 nlMatrixTopNRate or there are no more nlMatrixTopNEntries." 2451 ::= { nlMatrixTopNEntry 1 } 2453 nlMatrixTopNProtocolDirIndex OBJECT-TYPE 2454 SYNTAX OBJECT IDENTIFIER 2455 MAX-ACCESS read-only 2456 STATUS current 2457 DESCRIPTION 2458 "The network layer type of this matrix entry." 2459 ::= { nlMatrixTopNEntry 2 } 2461 nlMatrixTopNSourceAddress OBJECT-TYPE 2462 SYNTAX OCTET STRING 2463 MAX-ACCESS read-only 2464 STATUS current 2465 DESCRIPTION 2466 "The network layer source address of this matrix entry." 2467 ::= { nlMatrixTopNEntry 3 } 2469 nlMatrixTopNDestinationAddress OBJECT-TYPE 2470 SYNTAX OCTET STRING 2471 MAX-ACCESS read-only 2472 STATUS current 2473 DESCRIPTION 2474 "The network layer destination address of this matrix entry." 2475 ::= { nlMatrixTopNEntry 4 } 2477 nlMatrixTopNRate OBJECT-TYPE 2478 SYNTAX Integer32 2479 MAX-ACCESS read-only 2480 STATUS current 2481 DESCRIPTION 2482 "The amount of change in the selected variable 2483 during this sampling interval. The selected 2484 variable is this nlMatrix entry's instance of the object 2485 selected by nlMatrixTopNRateBase." 2486 ::= { nlMatrixTopNEntry 5 } 2488 -- The application analysis group 2489 -- 2490 alHostTable OBJECT-TYPE 2491 SYNTAX SEQUENCE OF AlHostEntry 2492 MAX-ACCESS not-accessible 2493 STATUS current 2494 DESCRIPTION 2495 "A list of alHost entries. Each such entry defines statistics 2496 for packets from and to a particular network address." 2497 ::= { alHost 1 } 2499 alHostEntry OBJECT-TYPE 2500 SYNTAX AlHostEntry 2501 MAX-ACCESS not-accessible 2502 STATUS current 2503 DESCRIPTION 2504 "A collection of statistics for a particular host 2505 that has been discovered on an interface of this 2506 device. 2508 The probe will populate this table for all network layer 2509 protocols in the protocol directory table who's value of 2510 protocolDirAlHostConfig is equal to supportedOn(3). 2512 The probe will add to this table all hosts who's address it 2513 sees as the source or destination address in all good MAC 2514 packets." 2515 INDEX { hlHostControlIndex, alHostTimeMark, 2516 alHostProtocolDirIndex, nlHostAddress, 2517 alHostAppProtocolDirIndex } 2518 ::= { alHostTable 1 } 2520 AlHostEntry ::= SEQUENCE { 2521 alHostTimeMark TimeFilter, 2522 alHostProtocolDirIndex Integer32, 2523 alHostAppProtocolDirIndex Integer32, 2524 alHostInPkts Counter32, 2525 alHostOutPkts Counter32, 2526 alHostInOctets Counter32, 2527 alHostOutOctets Counter32 2528 } 2530 alHostTimeMark OBJECT-TYPE 2531 SYNTAX TimeFilter 2532 MAX-ACCESS not-accessible 2533 STATUS current 2534 DESCRIPTION 2535 "A TimeFilter for this entry. See the TimeFilter textual 2536 convention to see how this works." 2537 ::= { alHostEntry 1 } 2539 alHostProtocolDirIndex OBJECT-TYPE 2540 SYNTAX Integer32 (1..2147483647) 2541 MAX-ACCESS read-only 2542 STATUS current 2543 DESCRIPTION 2544 "The protocolDirIndex of the network layer protocol of 2545 this entry's network address." 2546 ::= { alHostEntry 2 } 2548 alHostAppProtocolDirIndex OBJECT-TYPE 2549 SYNTAX Integer32 (1..2147483647) 2550 MAX-ACCESS read-only 2551 STATUS current 2552 DESCRIPTION 2553 "The protocolDirIndex of the protocol this entry is counting." 2554 ::= { alHostEntry 3 } 2556 alHostInPkts OBJECT-TYPE 2557 SYNTAX Counter32 2558 MAX-ACCESS read-only 2559 STATUS current 2560 DESCRIPTION 2561 "The number of packets without errors transmitted to 2562 this address of this application type since it was added to 2563 the alHostTable." 2564 ::= { alHostEntry 4 } 2566 alHostOutPkts OBJECT-TYPE 2567 SYNTAX Counter32 2568 MAX-ACCESS read-only 2569 STATUS current 2570 DESCRIPTION 2571 "The number of packets including errors transmitted 2572 by this address of this application type since it was added 2573 to the alHostTable." 2574 ::= { alHostEntry 5 } 2576 alHostInOctets OBJECT-TYPE 2577 SYNTAX Counter32 2578 MAX-ACCESS read-only 2579 STATUS current 2580 DESCRIPTION 2581 "The number of octets transmitted to this address 2582 of this application type since it was added to the 2583 alHostTable (excluding framing bits but including 2584 FCS octets), except for those octets in packets that 2585 contained errors." 2586 ::= { alHostEntry 6 } 2588 alHostOutOctets OBJECT-TYPE 2589 SYNTAX Counter32 2590 MAX-ACCESS read-only 2591 STATUS current 2592 DESCRIPTION 2593 "The number of octets transmitted by this address 2594 of this application type since it was added to the 2595 alHostTable (excluding framing bits but including 2596 FCS octets), including those octets in packets that 2597 contained errors." 2598 ::= { alHostEntry 7 } 2600 -- The applications level matrix group 2602 alMatrixSDTable OBJECT-TYPE 2603 SYNTAX SEQUENCE OF AlMatrixSDEntry 2604 MAX-ACCESS not-accessible 2605 STATUS current 2606 DESCRIPTION 2607 "A list of traffic matrix entries indexed by 2608 source and destination network-level address and an 2609 application protocol spoken between those addresses." 2610 ::= { alMatrix 1 } 2612 alMatrixSDEntry OBJECT-TYPE 2613 SYNTAX AlMatrixSDEntry 2614 MAX-ACCESS not-accessible 2615 STATUS current 2616 DESCRIPTION 2617 "A collection of statistics for communications between 2618 two addresses on a particular interface. 2620 The probe will populate this table for all network layer 2621 protocols in the protocol directory table who's value of 2622 protocolDirAlMatrixConfig is equal to supportedOn(3)." 2624 INDEX { hlMatrixControlIndex, alMatrixSDTimeMark, 2625 alMatrixSDProtocolDirIndex, 2626 nlMatrixSDSourceAddress, nlMatrixSDDestAddress, 2627 alMatrixSDAppProtocolDirIndex } 2628 ::= { alMatrixSDTable 1 } 2630 AlMatrixSDEntry ::= SEQUENCE { 2631 alMatrixSDTimeMark TimeFilter, 2632 alMatrixSDProtocolDirIndex Integer32, 2633 alMatrixSDAppProtocolDirIndex Integer32, 2634 alMatrixSDPkts Counter32, 2635 alMatrixSDOctets Counter32 2636 } 2638 alMatrixSDTimeMark OBJECT-TYPE 2639 SYNTAX TimeFilter 2640 MAX-ACCESS not-accessible 2641 STATUS current 2642 DESCRIPTION 2643 "A TimeFilter for this entry. See the TimeFilter textual 2644 convention to see how this works." 2645 ::= { alMatrixSDEntry 1 } 2647 alMatrixSDProtocolDirIndex OBJECT-TYPE 2648 SYNTAX Integer32 (1..2147483647) 2649 MAX-ACCESS read-only 2650 STATUS current 2651 DESCRIPTION 2652 "The protocolDirIndex of the network layer protocol of 2653 this entry's network address." 2654 ::= { alMatrixSDEntry 2 } 2656 alMatrixSDAppProtocolDirIndex OBJECT-TYPE 2657 SYNTAX Integer32 (1..2147483647) 2658 MAX-ACCESS read-only 2659 STATUS current 2660 DESCRIPTION 2661 "The protocolDirIndex of the protocol this entry is counting." 2662 ::= { alMatrixSDEntry 3 } 2664 alMatrixSDPkts OBJECT-TYPE 2665 SYNTAX Counter32 2666 MAX-ACCESS read-only 2667 STATUS current 2668 DESCRIPTION 2669 "The number of packets transmitted from the source 2670 address to the destination address (this number 2671 includes error packets)." 2672 ::= { alMatrixSDEntry 4 } 2674 alMatrixSDOctets OBJECT-TYPE 2675 SYNTAX Counter32 2676 MAX-ACCESS read-only 2677 STATUS current 2678 DESCRIPTION 2679 "The number of octets (excluding framing bits but 2680 including FCS octets) contained in all packets 2681 transmitted from the source address to the 2682 destination address." 2683 ::= { alMatrixSDEntry 5 } 2685 -- Traffic matrix tables from destination to source 2687 alMatrixDSTable OBJECT-TYPE 2688 SYNTAX SEQUENCE OF AlMatrixDSEntry 2689 MAX-ACCESS not-accessible 2690 STATUS current 2691 DESCRIPTION 2692 "A list of traffic matrix entries indexed by 2693 destination and source network-level address." 2694 ::= { alMatrix 2 } 2696 alMatrixDSEntry OBJECT-TYPE 2697 SYNTAX AlMatrixDSEntry 2698 MAX-ACCESS not-accessible 2699 STATUS current 2700 DESCRIPTION 2701 "A collection of statistics for communications between 2702 two address on a particular interface. 2704 The probe will populate this table for all network layer 2705 protocols in the protocol directory table who's value of 2706 protocolDirAlMatrixConfig is set to supportedOn(3)." 2707 INDEX { nlMatrixDSIndex, alMatrixDSTimeMark, protocolDirIndex, 2708 nlMatrixDSDestAddress, nlMatrixDSSourceAddress } 2709 ::= { alMatrixDSTable 1 } 2711 AlMatrixDSEntry ::= SEQUENCE { 2712 alMatrixDSTimeMark TimeFilter, 2713 alMatrixDSProtocolDirIndex Integer32, 2714 alMatrixDSAppProtocolDirIndex Integer32, 2715 alMatrixDSPkts Counter32, 2716 alMatrixDSOctets Counter32 2717 } 2719 alMatrixDSTimeMark OBJECT-TYPE 2720 SYNTAX TimeFilter 2721 MAX-ACCESS not-accessible 2722 STATUS current 2723 DESCRIPTION 2724 "A TimeFilter for this entry. See the TimeFilter textual 2725 convention to see how this works." 2726 ::= { alMatrixDSEntry 1 } 2728 alMatrixDSProtocolDirIndex OBJECT-TYPE 2729 SYNTAX Integer32 (1..2147483647) 2730 MAX-ACCESS read-only 2731 STATUS current 2732 DESCRIPTION 2733 "The protocolDirIndex of the network layer protocol of 2734 this entry's network address." 2735 ::= { alMatrixDSEntry 2 } 2737 alMatrixDSAppProtocolDirIndex OBJECT-TYPE 2738 SYNTAX Integer32 (1..2147483647) 2739 MAX-ACCESS read-only 2740 STATUS current 2741 DESCRIPTION 2742 "The protocolDirIndex of the protocol this entry is counting." 2743 ::= { alMatrixDSEntry 3 } 2745 alMatrixDSPkts OBJECT-TYPE 2746 SYNTAX Counter32 2747 MAX-ACCESS read-only 2748 STATUS current 2749 DESCRIPTION 2750 "The number of packets transmitted from the source 2751 address to the destination address (this number 2752 includes error packets)." 2753 ::= { alMatrixDSEntry 4 } 2755 alMatrixDSOctets OBJECT-TYPE 2756 SYNTAX Counter32 2757 MAX-ACCESS read-only 2758 STATUS current 2759 DESCRIPTION 2760 "The number of octets (excluding framing bits 2761 but including FCS octets) contained in all packets 2762 transmitted from the source address to the 2763 destination address." 2764 ::= { alMatrixDSEntry 5 } 2766 alMatrixTopNControlTable OBJECT-TYPE 2767 SYNTAX SEQUENCE OF AlMatrixTopNControlEntry 2768 MAX-ACCESS not-accessible 2769 STATUS current 2770 DESCRIPTION 2771 "A list of alMatrix top N control entries." 2772 ::= { alMatrix 4 } 2774 alMatrixTopNControlEntry OBJECT-TYPE 2775 SYNTAX AlMatrixTopNControlEntry 2776 MAX-ACCESS not-accessible 2777 STATUS current 2778 DESCRIPTION 2779 "A set of parameters that control the creation of a 2780 report of the top N matrix entries according to several 2781 metrics. For example, an instance of the 2782 alMatrixTopNDuration object might be named 2783 alMatrixTopNDuration.3" 2784 INDEX { alMatrixTopNControlIndex } 2785 ::= { alMatrixTopNControlTable 1 } 2787 AlMatrixTopNControlEntry ::= SEQUENCE { 2788 alMatrixTopNControlIndex Integer32 (1..65535), 2789 alMatrixTopNMatrixIndex Integer32 (1..65535), 2790 alMatrixTopNRateBase INTEGER, 2791 alMatrixTopNTimeRemaining Integer32, 2792 alMatrixTopNDuration Integer32, 2793 alMatrixTopNRequestedSize Integer32, 2794 alMatrixTopNGrantedSize Integer32, 2795 alMatrixTopNStartTime TimeTicks, 2796 alMatrixTopNOwner OwnerString, 2797 alMatrixTopNStatus RowStatus 2798 } 2800 alMatrixTopNControlIndex OBJECT-TYPE 2801 SYNTAX Integer32 (1..65535) 2802 MAX-ACCESS read-only 2803 STATUS current 2804 DESCRIPTION 2805 "An index that uniquely identifies an entry 2806 in the alMatrixTopNControl table. Each such 2807 entry defines one top N report prepared for 2808 one interface." 2809 ::= { alMatrixTopNControlEntry 1 } 2811 alMatrixTopNMatrixIndex OBJECT-TYPE 2812 SYNTAX Integer32 (1..65535) 2813 MAX-ACCESS read-create 2814 STATUS current 2815 DESCRIPTION 2816 "The alMatrix table for which a top N report will be 2817 prepared on behalf of this entry. The alMatrix table 2818 identified by a particular value of this index is 2819 associated with the same alMatrix table as identified by 2820 the same value of alMatrixIndex. 2822 This object may not be modified if the associated 2823 alMatrixTopNStatus object is equal to valid(1)." 2824 ::= { alMatrixTopNControlEntry 2 } 2826 alMatrixTopNRateBase OBJECT-TYPE 2827 SYNTAX INTEGER { 2828 alMatrixTopNSourceToDestPkts(1), 2829 alMatrixTopNDestToSourcePkts(2), 2830 alMatrixTopNSourceToDestOctets(3), 2831 alMatrixTopNDestToSourceOctets(4) 2832 } 2833 MAX-ACCESS read-create 2834 STATUS current 2835 DESCRIPTION 2836 "The variable for each alMatrix entry that the alMatrixTopNRate 2837 variable is based upon, as well as the selector of the matrix 2838 table that will be used. 2840 This object may not be modified if the associated 2841 alMatrixTopNStatus object is equal to valid(1)." 2842 ::= { alMatrixTopNControlEntry 3 } 2844 alMatrixTopNTimeRemaining OBJECT-TYPE 2845 SYNTAX Integer32 2846 MAX-ACCESS read-create 2847 STATUS current 2848 DESCRIPTION 2849 "The number of seconds left in the report currently 2850 being collected. When this object is modified by 2851 the management station, a new collection is started, 2852 possibly aborting a currently running report. The 2853 new value is used as the requested duration of this 2854 report, and is loaded into the associated 2855 alMatrixTopNDuration object when the report is finished. 2856 When the report finishes, the probe will automatically 2857 start another collection with the same initial value 2858 of alMatrixTopNTimeRemaining. 2860 While the value of this object is non-zero, it decrements 2861 by one per second until it reaches zero. At the time 2862 that this object decrements to zero, the report is made 2863 accessible in the alMatrixTopNTable, overwriting any report 2864 that may be there. 2866 (Note that this is a different algorithm than in 2867 the hostTopNTable)." 2868 DEFVAL { 0 } 2869 ::= { alMatrixTopNControlEntry 4 } 2871 alMatrixTopNDuration OBJECT-TYPE 2872 SYNTAX Integer32 2873 MAX-ACCESS read-only 2874 STATUS current 2875 DESCRIPTION 2876 "The number of seconds that this report has collected 2877 during the last sampling interval. 2879 When the associated alMatrixTopNTimeRemaining object is 2880 set, this object shall be set by the probe to the 2881 same value and shall not be modified until the next 2882 time the alMatrixTopNTimeRemaining is set. 2884 This value shall be zero if no reports have been 2885 requested for this alMatrixTopNControlEntry." 2886 DEFVAL { 0 } 2887 ::= { alMatrixTopNControlEntry 5 } 2889 alMatrixTopNRequestedSize OBJECT-TYPE 2890 SYNTAX Integer32 2891 MAX-ACCESS read-create 2892 STATUS current 2893 DESCRIPTION 2894 "The maximum number of matrix entries requested for the top N 2895 table. 2897 When this object is created or modified, the probe 2898 should set alMatrixTopNGrantedSize as closely to this 2899 object as is possible for the particular probe 2900 implementation and available resources." 2901 DEFVAL { 10 } 2902 ::= { alMatrixTopNControlEntry 6 } 2904 alMatrixTopNGrantedSize OBJECT-TYPE 2905 SYNTAX Integer32 2906 MAX-ACCESS read-only 2907 STATUS current 2908 DESCRIPTION 2909 "The maximum number of matrix entries in the top N table. 2911 When the associated alMatrixTopNRequestedSize object is 2912 created or modified, the probe should set this 2913 object as closely to the requested value as is 2914 possible for the particular implementation and 2915 available resources. The probe must not lower this 2916 value except as a result of a set to the associated 2917 alMatrixTopNRequestedSize object. 2918 When the next topN report is generated, matrix entries 2919 with the highest value of alMatrixTopNRate shall 2920 be placed in this table in decreasing order of this rate 2921 until there is no more room or until there are no more 2922 matrix entries." 2923 ::= { alMatrixTopNControlEntry 7 } 2925 alMatrixTopNStartTime OBJECT-TYPE 2926 SYNTAX TimeTicks 2927 MAX-ACCESS read-only 2928 STATUS current 2929 DESCRIPTION 2930 "The value of sysUpTime when this top N report was 2931 last started. In other words, this is the time that 2932 the associated alMatrixTopNTimeRemaining object was 2933 modified to start the requested report or the time 2934 the report was last automatically (re)started." 2935 ::= { alMatrixTopNControlEntry 8 } 2937 alMatrixTopNOwner OBJECT-TYPE 2938 SYNTAX OwnerString 2939 MAX-ACCESS read-create 2940 STATUS current 2941 DESCRIPTION 2942 "The entity that configured this entry and is 2943 therefore using the resources assigned to it." 2944 ::= { alMatrixTopNControlEntry 9 } 2946 alMatrixTopNStatus OBJECT-TYPE 2947 SYNTAX RowStatus 2948 MAX-ACCESS read-create 2949 STATUS current 2950 DESCRIPTION 2951 "The status of this alMatrixTopNControl entry. 2953 If this object is not equal to valid(1), all 2954 associated alMatrixTopNEntries shall be deleted by the 2955 agent." 2956 ::= { alMatrixTopNControlEntry 10 } 2958 alMatrixTopNTable OBJECT-TYPE 2959 SYNTAX SEQUENCE OF AlMatrixTopNEntry 2960 MAX-ACCESS not-accessible 2961 STATUS current 2962 DESCRIPTION 2963 "A list of top N alMatrix entries." 2964 ::= { alMatrix 5 } 2966 alMatrixTopNEntry OBJECT-TYPE 2967 SYNTAX AlMatrixTopNEntry 2968 MAX-ACCESS not-accessible 2969 STATUS current 2970 DESCRIPTION 2971 "A set of statistics for a matrix entry that is part of a 2972 top N report. For example, an instance of the 2973 alMatrixTopNRate object might be named 2974 alMatrixTopNRate.3.10 2976 The value of alMatrixTopNControlIndex in the index is 2977 that of the associated alMatrix on who's behalf this study 2978 was prepared." 2979 INDEX { alMatrixTopNControlIndex, alMatrixTopNIndex } 2980 ::= { alMatrixTopNTable 1 } 2982 AlMatrixTopNEntry ::= SEQUENCE { 2983 alMatrixTopNIndex Integer32 (1..65535), 2984 alMatrixTopNProtocolDirIndex OBJECT IDENTIFIER, 2985 alMatrixTopNSourceAddress OCTET STRING, 2986 alMatrixTopNDestinationAddress OCTET STRING, 2987 alMatrixTopNAppProtocolDirIndex OBJECT IDENTIFIER, 2988 alMatrixTopNRate Integer32 2989 } 2991 alMatrixTopNIndex OBJECT-TYPE 2992 SYNTAX Integer32 (1..65535) 2993 MAX-ACCESS read-only 2994 STATUS current 2995 DESCRIPTION 2996 "An index that uniquely identifies an entry in 2997 the alMatrixTopN table among those in the same report. 2998 This index is between 1 and N, where N is the 2999 number of entries in this table. Increasing values 3000 of alMatrixTopNIndex shall be assigned to entries with 3001 decreasing values of alMatrixTopNRate until index N 3002 is assigned to the entry with the lowest value of 3003 alMatrixTopNRate or there are no more alMatrixTopNEntries." 3004 ::= { alMatrixTopNEntry 1 } 3006 alMatrixTopNProtocolDirIndex OBJECT-TYPE 3007 SYNTAX OBJECT IDENTIFIER 3008 MAX-ACCESS read-only 3009 STATUS current 3010 DESCRIPTION 3011 "The network layer type of this matrix entry." 3012 ::= { alMatrixTopNEntry 2 } 3014 alMatrixTopNSourceAddress OBJECT-TYPE 3015 SYNTAX OCTET STRING 3016 MAX-ACCESS read-only 3017 STATUS current 3018 DESCRIPTION 3019 "The network layer source address of this matrix entry." 3020 ::= { alMatrixTopNEntry 3 } 3022 alMatrixTopNDestinationAddress OBJECT-TYPE 3023 SYNTAX OCTET STRING 3024 MAX-ACCESS read-only 3025 STATUS current 3026 DESCRIPTION 3027 "The network layer destination address of this matrix entry." 3028 ::= { alMatrixTopNEntry 4 } 3030 alMatrixTopNAppProtocolDirIndex OBJECT-TYPE 3031 SYNTAX OBJECT IDENTIFIER 3032 MAX-ACCESS read-only 3033 STATUS current 3034 DESCRIPTION 3035 "The type of the protocol counted by this matrix entry." 3036 ::= { alMatrixTopNEntry 5 } 3038 alMatrixTopNRate OBJECT-TYPE 3039 SYNTAX Integer32 3040 MAX-ACCESS read-only 3041 STATUS current 3042 DESCRIPTION 3043 "The amount of change in the selected variable 3044 during this sampling interval. The selected 3045 variable is this alMatrix entry's instance of the object 3046 selected by alMatrixTopNRateBase." 3047 ::= { alMatrixTopNEntry 6 } 3049 -- 3050 -- User History Collection Group (usrHistory) 3051 -- 3052 -- The usrHistory group combines mechanisms seen in the alarm and 3053 -- history groups to provide user-specified history collection, 3054 -- utilizing two additional control tables and one additional data 3055 -- table. This function has traditionally been done by NMS 3056 -- applications, via periodic polling. The usrHistory group allows 3057 -- this task to be offloaded to an RMON probe. 3058 -- 3059 -- Data (an ASN.1 INTEGER based object) is collected in the same manner 3060 -- as any history data table (e.g. etherHistoryTable) except that 3061 -- the user specifies the MIB instances to be collected. Objects are 3062 -- collected in bucket-groups, with the intent that all MIB instances in 3063 -- the same bucket-group are collected as atomically as possible by the 3064 -- RMON probe. 3065 -- 3066 -- The usrHistoryControlTable is a one-dimensional read-create table. 3067 -- Each row configures a collection of user history buckets, much 3068 -- the same as a historyControlEntry, except that the creation of a 3069 -- row in this table will cause one or more associated instances in the 3070 -- usrHistoryObjectTable to be created. The user specifies the 3071 -- number of bucket elements (rows in the usrHistoryObjectTable) 3072 -- requested, as well as the number of buckets requested. 3073 -- 3074 -- The usrHistoryObjectTable is a 2-d read-write table. 3076 -- Each row configures a single MIB instance to be collected. 3077 -- All rows with the same major index constitute a bucket-group. 3078 -- 3079 -- The usrHistoryTable is a 3-d read-only table containing 3080 -- the data of associated usrHistoryControlEntries. Each 3081 -- entry represents the value of a single MIB instance 3082 -- during a specific sampling interval (or the rate of 3083 -- change during the interval). 3084 -- 3085 -- A sample value is stored in two objects--an absolute value and 3086 -- a status object. This allows numbers from -(2G-1) to +4G to be stored. 3087 -- The status object also indicates whether a sample is valid. This allows 3088 -- data collection to continue if periodic retrieval of a particular 3089 -- instance fails for any reason. 3090 -- 3091 -- Row Creation Order Relationships 3092 -- 3093 -- The static nature of the usrHistoryObjectTable creates 3094 -- some row creation/modification issues. The rows in this 3095 -- table need to be set before the associated 3096 -- usrHistoryControlEntry can be activated. 3097 -- 3098 -- Note that the usrHistoryObject entries associated with a 3099 -- particular usrHistoryControl entry are not required to 3100 -- be valid before the control entry is activated. However, 3101 -- the usrHistory data entries associated with an invalid 3102 -- usrHistoryObject entry will be invalid (i.e. 3103 -- usrHistoryValStatus == valueNotAvailable). 3104 -- 3106 usrHistoryControlTable OBJECT-TYPE 3107 SYNTAX SEQUENCE OF UsrHistoryControlEntry 3108 MAX-ACCESS not-accessible 3109 STATUS current 3110 DESCRIPTION 3111 "A list of data-collection configuration entries." 3112 ::= { usrHistory 1 } 3114 usrHistoryControlEntry OBJECT-TYPE 3115 SYNTAX UsrHistoryControlEntry 3116 MAX-ACCESS not-accessible 3117 STATUS current 3118 DESCRIPTION 3119 "A list of parameters that set up a group of user-defined 3120 MIB objects to be sampled periodically (called a 3121 bucket-group). 3123 For example, an instance of usrHistoryControlInterval 3124 might be named usrHistoryControlInterval.1" 3125 INDEX { usrHistoryControlIndex } 3126 ::= { usrHistoryControlTable 1 } 3128 UsrHistoryControlEntry ::= SEQUENCE { 3129 usrHistoryControlIndex Integer32, 3130 usrHistoryControlObjects Integer32, 3131 usrHistoryControlBucketsRequested Integer32, 3132 usrHistoryControlBucketsGranted Integer32, 3133 usrHistoryControlInterval Integer32, 3134 usrHistoryControlOwner OwnerString, 3135 usrHistoryControlStatus RowStatus 3136 } 3138 usrHistoryControlIndex OBJECT-TYPE 3139 SYNTAX Integer32 (1..65535) 3140 MAX-ACCESS not-accessible 3141 STATUS current 3142 DESCRIPTION 3143 "An index that uniquely identifies an entry in the 3144 usrHistoryControl table. Each such entry defines a 3145 set of samples at a particular interval for a specified 3146 set of MIB instances available from the managed system." 3147 ::= { usrHistoryControlEntry 1 } 3149 usrHistoryControlObjects OBJECT-TYPE 3150 SYNTAX Integer32 (1..65535) 3151 MAX-ACCESS read-create 3152 STATUS current 3153 DESCRIPTION 3154 "The number of MIB objects to be collected 3155 in the portion of usrHistoryTable associated with this 3156 usrHistoryControlEntry. 3158 This object may not be modified if the associated instance 3159 of usrHistoryControlStatus is equal to active(1)." 3160 ::= { usrHistoryControlEntry 2 } 3162 usrHistoryControlBucketsRequested OBJECT-TYPE 3163 SYNTAX Integer32 (1..65535) 3164 MAX-ACCESS read-create 3165 STATUS current 3166 DESCRIPTION 3167 "The requested number of discrete time intervals 3168 over which data is to be saved in the part of the 3169 usrHistoryTable associated with this usrHistoryControlEntry. 3171 When this object is created or modified, the probe 3172 should set usrHistoryControlBucketsGranted as closely to 3173 this object as is possible for the particular probe 3174 implementation and available resources." 3175 DEFVAL { 50 } 3176 ::= { usrHistoryControlEntry 3 } 3178 usrHistoryControlBucketsGranted OBJECT-TYPE 3179 SYNTAX Integer32 (1..65535) 3180 MAX-ACCESS read-only 3181 STATUS current 3182 DESCRIPTION 3183 "The number of discrete sampling intervals 3184 over which data shall be saved in the part of 3185 the usrHistoryTable associated with this 3186 usrHistoryControlEntry. 3188 When the associated usrHistoryControlBucketsRequested 3189 object is created or modified, the probe should set 3190 this object as closely to the requested value as is 3191 possible for the particular probe implementation and 3192 available resources. The probe must not lower this 3193 value except as a result of a modification to the associated 3194 usrHistoryControlBucketsRequested object. 3196 The associated usrHistoryControlObjectsRequested object 3197 should be set before or at the same time as this object 3198 to allow the probe to accurately estimate the resources 3199 required for this usrHistoryControlEntry. 3201 There will be times when the actual number of buckets 3202 associated with this entry is less than the value of 3203 this object. In this case, at the end of each sampling 3204 interval, a new bucket will be added to the usrHistoryTable. 3206 When the number of buckets reaches the value of this object 3207 and a new bucket is to be added to the usrHistoryTable, 3208 the oldest bucket associated with this usrHistoryControlEntry 3209 shall be deleted by the agent so that the new bucket can be added. 3211 When the value of this object changes to a value less than 3212 the current value, entries are deleted from the usrHistoryTable 3213 associated with this usrHistoryControlEntry. Enough of 3214 the oldest of these entries shall be deleted by the agent so 3215 that their number remains less than or equal to the new value of 3216 this object. 3218 When the value of this object changes to a value greater 3219 than the current value, the number of associated usrHistory 3220 entries may be allowed to grow." 3221 ::= { usrHistoryControlEntry 4 } 3223 usrHistoryControlInterval OBJECT-TYPE 3224 SYNTAX Integer32 (1..2147483647) 3225 MAX-ACCESS read-create 3226 STATUS current 3227 DESCRIPTION 3228 "The interval in seconds over which the data is 3229 sampled for each bucket in the part of the usrHistory 3230 table associated with this usrHistoryControlEntry. 3232 Because the counters in a bucket may overflow at their 3233 maximum value with no indication, a prudent manager will 3234 take into account the possibility of overflow in any of 3235 the associated counters. It is important to consider the 3236 minimum time in which any counter could overflow on a 3237 particular media type and set the usrHistoryControlInterval 3238 object to a value less than this interval. 3240 This object may not be modified if the associated 3241 usrHistoryControlStatus object is equal to active(1)." 3242 DEFVAL { 1800 } 3243 ::= { usrHistoryControlEntry 5 } 3245 usrHistoryControlOwner OBJECT-TYPE 3246 SYNTAX OwnerString 3247 MAX-ACCESS read-create 3248 STATUS current 3249 DESCRIPTION 3250 "The entity that configured this entry and is therefore using the 3251 resources assigned to it." 3252 ::= { usrHistoryControlEntry 6 } 3254 usrHistoryControlStatus OBJECT-TYPE 3255 SYNTAX RowStatus 3256 MAX-ACCESS read-create 3257 STATUS current 3258 DESCRIPTION 3259 "The status of this variable history control entry." 3260 ::= { usrHistoryControlEntry 7 } 3261 -- Object table 3263 usrHistoryObjectTable OBJECT-TYPE 3264 SYNTAX SEQUENCE OF UsrHistoryObjectEntry 3265 MAX-ACCESS not-accessible 3266 STATUS current 3267 DESCRIPTION 3268 "A list of data-collection configuration entries." 3269 ::= { usrHistory 2 } 3271 usrHistoryObjectEntry OBJECT-TYPE 3272 SYNTAX UsrHistoryObjectEntry 3273 MAX-ACCESS not-accessible 3274 STATUS current 3275 DESCRIPTION 3276 "A list of MIB instances to be sampled periodically. 3278 Entries in this table are created when an associated 3279 usrHistoryControlObjects object is created. 3281 For example, an instance of usrHistoryObjectVariable might be 3282 usrHistoryObjectVariable.1.3" 3283 INDEX { usrHistoryControlIndex, usrHistoryObjectIndex } 3284 ::= { usrHistoryObjectTable 1 } 3286 UsrHistoryObjectEntry ::= SEQUENCE { 3287 usrHistoryObjectIndex Integer32, 3288 usrHistoryObjectVariable OBJECT IDENTIFIER, 3289 usrHistoryObjectSampleType INTEGER 3290 } 3292 usrHistoryObjectIndex OBJECT-TYPE 3293 SYNTAX Integer32 (1..65535) 3294 MAX-ACCESS not-accessible 3295 STATUS current 3296 DESCRIPTION 3297 "An index used to uniquely identify an entry in the 3298 usrHistoryObject table. Each such entry defines a 3299 MIB instance to be collected periodically." 3300 ::= { usrHistoryObjectEntry 1 } 3302 usrHistoryObjectVariable OBJECT-TYPE 3303 SYNTAX OBJECT IDENTIFIER 3304 MAX-ACCESS read-create 3305 STATUS current 3306 DESCRIPTION 3307 "The object identifier of the particular variable to be sampled. 3309 Only variables that resolve to an ASN.1 primitive type of Integer32 3310 (Integer32, Counter, Gauge, or TimeTicks) may be sampled. 3312 Because SNMP access control is articulated entirely in terms of 3313 the contents of MIB views, no access control mechanism exists 3314 that can restrict the value of this object to identify only 3315 those objects that exist in a particular MIB view. Because there 3316 is thus no acceptable means of restricting the read access that 3317 could be obtained through the user history mechanism, the probe 3318 must only grant write access to this object in those views that 3319 have read access to all objects on the probe. 3321 During a set operation, if the supplied variable name is not 3322 available in the selected MIB view, a badValue error must be returned. 3324 This object may not be modified if the associated 3325 usrHistoryControlStatus object is equal to active(1)." 3326 ::= { usrHistoryObjectEntry 2 } 3328 usrHistoryObjectSampleType OBJECT-TYPE 3329 SYNTAX INTEGER { 3330 absoluteValue(1), 3331 deltaValue(2) 3332 } 3333 MAX-ACCESS read-create 3334 STATUS current 3335 DESCRIPTION 3336 "The method of sampling the selected variable for storage in the 3337 usrHistoryTable. 3339 If the value of this object is absoluteValue(1), the value of 3340 the selected variable will be copied directly into the history 3341 bucket. 3343 If the value of this object is deltaValue(2), the value of the 3344 selected variable at the last sample will be subtracted from 3345 the current value, and the difference will be stored in the 3346 history bucket. If the associated usrHistoryObjectVariable 3347 instance could not be obtained at the previous sample interval, 3348 then a delta sample is not possible, and the value of the 3349 associated usrHistoryValStatus object for this interval will 3350 be valueNotAvailable(1). 3352 This object may not be modified if the associated 3353 usrHistoryControlStatus object is equal to active(1)." 3354 ::= { usrHistoryObjectEntry 3 } 3356 -- data table 3358 usrHistoryTable OBJECT-TYPE 3359 SYNTAX SEQUENCE OF UsrHistoryEntry 3360 MAX-ACCESS not-accessible 3361 STATUS current 3362 DESCRIPTION 3363 "A list of user defined history entries." 3364 ::= { usrHistory 3 } 3366 usrHistoryEntry OBJECT-TYPE 3367 SYNTAX UsrHistoryEntry 3368 MAX-ACCESS not-accessible 3369 STATUS current 3370 DESCRIPTION 3371 "An historical sample of user-defined variables. This sample is 3372 associated with the usrHistoryControlEntry which set up the 3373 parameters for a regular collection of these samples. 3374 For example, an instance of usrHistoryValue, which represents 3375 the 14th sample of a variable collected as specified by 3376 usrHistoryControlEntry.1 and usrHistoryObjectEntry.1.5, 3377 would be named usrHistoryValue.1.14.5" 3378 INDEX { usrHistoryControlIndex, usrHistorySampleIndex, 3379 usrHistoryObjectIndex } 3380 ::= { usrHistoryTable 1 } 3382 UsrHistoryEntry ::= SEQUENCE { 3383 usrHistorySampleIndex Integer32, 3384 usrHistoryIntervalStart TimeTicks, 3385 usrHistoryIntervalEnd TimeTicks, 3386 usrHistoryAbsValue Gauge32, 3387 usrHistoryValStatus INTEGER 3388 } 3390 usrHistorySampleIndex OBJECT-TYPE 3391 SYNTAX Integer32 (1..2147483647) 3392 MAX-ACCESS read-only 3393 STATUS current 3394 DESCRIPTION 3395 "An index that uniquely identifies the particular sample this entry 3396 represents among all samples associated with the same 3397 usrHistoryControlEntry. This index starts at 1 and increases by 3398 one as each new sample is taken." 3399 ::= { usrHistoryEntry 1 } 3401 usrHistoryIntervalStart OBJECT-TYPE 3402 SYNTAX TimeTicks 3403 MAX-ACCESS read-only 3404 STATUS current 3405 DESCRIPTION 3406 "The value of sysUpTime at the start of the interval over which this 3407 sample was measured. If the probe keeps track of the time of day, 3408 it should start the first sample of the history at a time such that 3409 when the next hour of the day begins, a sample is started at 3410 that instant. 3412 Note that following this rule may require the probe to delay 3413 collecting the first sample of the history, as each sample must be 3414 of the same interval. Also note that the sample which is 3415 currently being collected is not accessible in this table until 3416 the end of its interval." 3417 ::= { usrHistoryEntry 2 } 3419 usrHistoryIntervalEnd OBJECT-TYPE 3420 SYNTAX TimeTicks 3421 MAX-ACCESS read-only 3422 STATUS current 3423 DESCRIPTION 3424 "The value of sysUpTime at the end of the interval over which this 3425 sample was measured." 3426 ::= { usrHistoryEntry 3 } 3428 usrHistoryAbsValue OBJECT-TYPE 3429 SYNTAX Gauge32 3430 MAX-ACCESS read-only 3431 STATUS current 3432 DESCRIPTION 3433 "The absolute value of the user-specified statistic during the 3434 last sampling period. The value during the current sampling 3435 period is not made available until the period is completed. 3437 To obtain the true value for this sampling interval, the 3438 associated instance of usrHistoryValStatus must be checked, 3439 and usrHistoryAbsValue adjusted as necessary. 3441 If the MIB instance could not be accessed during the sampling 3442 interval, then this object will have a value of zero and the 3443 associated instance of usrHistoryValStatus will be set to 3444 'valueNotAvailable(1)'." 3445 ::= { usrHistoryEntry 4 } 3447 usrHistoryValStatus OBJECT-TYPE 3448 SYNTAX INTEGER { 3449 valueNotAvailable(1), 3450 valuePositive(2), 3451 valueNegative(3) 3452 } 3453 MAX-ACCESS read-only 3454 STATUS current 3455 DESCRIPTION 3456 "This object indicates the validity and sign of the data in 3457 the associated instance of usrHistoryAbsValue. 3459 If the MIB instance could not be accessed during the sampling 3460 interval, then 'valueNotAvailable(1)' will be returned. 3462 If the sample is valid and actual value of the sample is greater 3463 than or equal to zero then 'valuePositive(2)' is returned. 3465 If the sample is valid and the actual value of the sample is less 3466 than zero, 'valueNegative(3)' will be returned. The associated 3467 instance of usrHistoryAbsValue should be multiplied by -1 to 3468 obtain the true sample value." 3469 ::= { usrHistoryEntry 5 } 3471 -- The probe config group 3473 ControlString ::= DisplayString 3474 -- This data type is used to communicate with a modem or a serial 3475 -- data switch. A ControlString contains embeded commands to 3476 -- control how the device will interact with the remote device 3477 -- through the serial interface. Commands are represented as 3478 -- two character sequences beginning with the "^" character. 3479 -- The following commands are recognized by the device (note 3480 -- that command characters are case sensitive): 3481 -- 3482 -- ^s Send string that follows which is terminated by the next 3483 -- command or the end of string. 3484 -- ^c Delay for the number of seconds that follows. Toss out 3485 -- any data received rather than storing it in a buffer for 3486 -- parsing. 3487 -- ^t Set timeout to the value represented by the decimal 3488 -- digits that follow. The default timeout is 20 seconds. 3489 -- Note that this timeout may be override by a smaller 3490 -- serialTimeout configured for the associated serial 3491 -- interface (see serialConfigTable). 3492 -- ^w Wait for the reply string that follows which is terminated 3493 -- by the next command or the end of string. Partial and 3494 -- case insensitive matching is applied, ie. if the reply 3495 -- string (any case combination) is found anywhere in the 3496 -- received string, then the a match is found. If the 3497 -- current timeout elapses without a match, then the 3498 -- remaining control string is ignored. 3499 -- ^! The ^ character. 3500 -- ^d Delay the number of seconds specified by the decimal 3501 -- digits that follow. 3502 -- ^b Send break for the number of milliseconds specified by 3503 -- the decimal digits that follow. If no digits follow, 3504 -- break will be enforced for 250 milliseconds by default. 3505 -- 3506 -- The following ASCII control characters may be inserted into 3507 -- the "^s" send string or the "^w" reply string: 3508 -- 3509 -- ^@ 0x00 3510 -- ^A 0x01 3511 -- .. 3512 -- ^M 0x0D 3513 -- .. 3514 -- ^Z 0x1A 3515 -- ^[ 0x1B 3516 -- ^ 0x1C 3517 -- ^] 0x1D 3518 -- ^^ 0x1E 3519 -- ^_ 0x1F 3520 -- 3521 -- Binary data may also be inserted into the data stream. The 3522 -- control sequence for each byte of binary data is ^0x##, where 3523 -- ## is the hexadecimal representation of the data byte. Two 3524 -- ASCII characters (0-9, a-f, A-F) must follow the "^0x" control 3525 -- prefix. For example, "^0x0D^0x0A" is interpreted as a carriage 3526 -- return followed by a line feed. 3528 probeCapabilities OBJECT-TYPE 3529 SYNTAX Integer32 3530 MAX-ACCESS read-only 3531 STATUS current 3532 DESCRIPTION 3533 "An indication of the RMON MIB groups supported 3534 on at least one interface by this probe. 3535 The value of this mask is a sum. This sum 3536 initially takes the value zero. Then, for each 3537 MIB group G, that is supported by this probe, 3538 2 raised to a value representing G is added to the 3539 sum. 3541 Over time, addition MIB groups may be defined. A 3542 probe must set all unused bits to zero, and an NMS 3543 must ignore unknown bits. 3545 The RMON groups are defined as follows: 3547 G (bit#) Group name 3548 -------------------------------------- 3549 From RFC 1757: 3550 0 etherStats 3551 1 historyControl 3552 2 etherHistory 3553 3 alarm 3554 4 hosts 3555 5 hostTopN 3556 6 matrix 3557 7 filter 3558 8 capture 3559 9 event 3561 From RFC 1513: 3562 10 tokenRingMLStats 3563 11 tokenRingPStats 3564 12 tokenRingMLHistory 3565 13 tokenRingPHistory 3566 14 ringStation 3567 15 ringStationOrder 3568 16 ringStationConfig 3569 17 sourceRouting 3571 From [??? RMON-2 groups here ???]: 3572 18 protocolDir 3573 19 protocolDist 3574 20 addressMapping 3575 21 slHost 3576 22 slMatrix 3577 23 slHistory 3578 24 slFilter 3579 25 usrHistory 3580 26 probeConfig 3582 For example, an RMON probe supporting the etherStats, 3583 historyControl, and etherHistory groups would have 3584 a value of 7 (2^0 + 2^1 + 2^2)." 3585 ::= { probeConfig 1 } 3587 probeIdentification OBJECT-TYPE 3588 SYNTAX DisplayString (SIZE(0..127)) 3589 MAX-ACCESS read-write 3590 STATUS current 3591 DESCRIPTION 3592 "A string uniquely identifying this device." 3593 ::= { probeConfig 2 } 3595 probeFirmwareRev OBJECT-TYPE 3596 SYNTAX DisplayString (SIZE(0..15)) 3597 MAX-ACCESS read-only 3598 STATUS current 3599 DESCRIPTION 3600 "The firmware revision of this device." 3601 ::= { probeConfig 3 } 3603 probeHardwareRev OBJECT-TYPE 3604 SYNTAX DisplayString (SIZE(0..31)) 3605 MAX-ACCESS read-only 3606 STATUS current 3607 DESCRIPTION 3608 "The hardware revision of this device." 3609 ::= { probeConfig 4 } 3611 probeDateTime OBJECT-TYPE 3612 SYNTAX OCTET STRING (SIZE (0 | 8 | 11)) 3613 MAX-ACCESS read-write 3614 STATUS current 3615 DESCRIPTION 3616 "Probe's current date and time. 3618 field octets contents range 3619 ----- ------ -------- ----- 3620 1 1-2 year 0..65536 3621 2 3 month 1..12 3622 3 4 day 1..31 3623 4 5 hour 0..23 3624 5 6 minutes 0..59 3625 6 7 seconds 0..60 3626 (use 60 for leap-second) 3627 7 8 deci-seconds 0..9 3628 8 9 direction from UTC '+' / '-' 3629 9 10 hours from UTC 0..11 3630 10 11 minutes from UTC 0..59 3632 For example, Tuesday May 26, 1992 at 1:30:15 PM 3633 EDT would be displayed as: 3635 1992-5-26,13:30:15.0,-4:0 3637 Note that if only local time is known, then 3638 timezone information (fields 8-10) is not 3639 present, and if no time information is known, the null 3640 string is returned." 3641 ::= { probeConfig 5 } 3643 probeResetControl OBJECT-TYPE 3644 SYNTAX INTEGER { 3645 running(1), 3646 warmBoot(2), 3647 coldBoot(3) 3648 } 3649 MAX-ACCESS read-write 3650 STATUS current 3651 DESCRIPTION 3652 "Setting this object to warmBoot(2) causes the device to 3653 restart the application software with current configuration 3654 parameters saved in non-volatile memory. Setting this 3655 object to coldBoot(3) causes the device to reinitialize 3656 configuration parameters in non-volatile memory to default 3657 values and restart the application software. When the device 3658 is running normally, this variable has a value of running(1)." 3659 ::= { probeConfig 6 } 3661 probeDownloadFile OBJECT-TYPE 3662 SYNTAX DisplayString (SIZE(0..127)) 3663 MAX-ACCESS read-write 3664 STATUS current 3665 DESCRIPTION 3666 "The file name to be downloaded from the TFTP server." 3667 ::= { probeConfig 7 } 3669 probeDownloadTFTPServer OBJECT-TYPE 3670 SYNTAX IpAddress 3671 MAX-ACCESS read-write 3672 STATUS current 3673 DESCRIPTION 3674 "The IP address of the TFTP server that contains the boot 3675 image to load." 3676 ::= { probeConfig 8 } 3678 probeDownloadAction OBJECT-TYPE 3679 SYNTAX INTEGER { 3680 imageValid(1), 3681 downloadToPROM(2), 3682 downloadToRAM(3) 3683 } 3684 MAX-ACCESS read-write 3685 STATUS current 3686 DESCRIPTION 3687 "When this object is set to downloadToRAM(2) or 3688 downloadToPROM(3), the device will discontinue its 3689 normal operation and begin download of the image specified 3690 by probeDownLoadFile from the server specifed by 3691 probeDownLoadTFTPServer using the TFTP protocol. If 3692 downloadToRAM(2) is specified, the new image is copied 3693 to RAM only (the old image remains unaltered in the flash 3694 EPROM). If downloadToPROM(3) is specified 3695 the new image is written to the flash EPROM 3696 memory after its checksum has been verified to be correct. 3697 When the download process is completed, the device will 3698 warm boot to restart the newly loaded application. 3699 When the device is not downloading, this object will have 3700 a value of imageValid(1)." 3701 ::= { probeConfig 9 } 3703 probeDownloadStatus OBJECT-TYPE 3704 SYNTAX INTEGER { 3705 downloadSuccess(1), 3706 downloadFailed(2), 3707 downloadStatusUnknown(3) 3708 } 3709 MAX-ACCESS read-only 3710 STATUS current 3711 DESCRIPTION 3712 "The status of the last download procedure, if any. This object 3713 will have a value of downloadStatusUnknown(3) if no download 3714 process has been performed." 3715 ::= { probeConfig 10 } 3717 serialConfigTable OBJECT-TYPE 3718 SYNTAX SEQUENCE OF SerialConfigEntry 3719 MAX-ACCESS not-accessible 3720 STATUS current 3721 DESCRIPTION 3722 "A table of serial interface configuration entries. This data 3723 will be stored in non-volatile memory and preserved across 3724 probe resets or power loss." 3725 ::= { probeConfig 11 } 3727 serialConfigEntry OBJECT-TYPE 3728 SYNTAX SerialConfigEntry 3729 MAX-ACCESS not-accessible 3730 STATUS current 3731 DESCRIPTION 3732 "A set of configuration parameters for a particular 3733 serial interface on this device." 3734 INDEX { serialIfIndex } 3735 ::= { serialConfigTable 1 } 3737 SerialConfigEntry ::= SEQUENCE { 3738 serialIfIndex Integer32 (1..65535), 3739 serialIpAddress IpAddress, 3740 serialSubnetMask IpAddress, 3741 serialMode INTEGER, 3742 serialProtocol INTEGER, 3743 serialSpeed INTEGER, 3744 serialTimeout Integer32 (1..65535), 3745 serialModemInitString ControlString (SIZE (0..255)), 3746 serialModemHangUpString ControlString (SIZE (0..255)), 3747 serialModemConnectResp DisplayString (SIZE (0..255)), 3748 serialModemNoConnectResp DisplayString (SIZE (0..255)), 3749 serialFlowControl INTEGER, 3750 serialDialoutTimeout Integer32 (1..65535) 3751 } 3753 serialIfIndex OBJECT-TYPE 3754 SYNTAX Integer32 (1..65535) 3755 MAX-ACCESS read-only 3756 STATUS current 3757 DESCRIPTION 3758 "The value of this object uniquely identifies the serial 3759 interface on this device for which this entry contains 3760 configuration parameters. The interface identified by a 3761 particular value of this object is the same interface as 3762 identified by the same value of the ifIndex object, defined 3763 in RFC 1213." 3764 ::= { serialConfigEntry 1 } 3766 serialIpAddress OBJECT-TYPE 3767 SYNTAX IpAddress 3768 MAX-ACCESS read-create 3769 STATUS current 3770 DESCRIPTION 3771 "The IP address of this serial interface." 3772 ::= { serialConfigEntry 2 } 3774 serialSubnetMask OBJECT-TYPE 3775 SYNTAX IpAddress 3776 MAX-ACCESS read-create 3777 STATUS current 3778 DESCRIPTION 3779 "The IP subnet mask of this serial interface." 3780 ::= { serialConfigEntry 3 } 3782 serialMode OBJECT-TYPE 3783 SYNTAX INTEGER { 3784 direct(1), 3785 modem(2) 3786 } 3787 MAX-ACCESS read-create 3788 STATUS current 3789 DESCRIPTION 3790 "The type of incoming connection to expect on this serial 3791 interface." 3793 DEFVAL { direct } 3794 ::= { serialConfigEntry 4 } 3796 serialProtocol OBJECT-TYPE 3797 SYNTAX INTEGER { 3798 other(1), 3799 slip(2) 3800 } 3801 MAX-ACCESS read-create 3802 STATUS current 3803 DESCRIPTION 3804 "The type of data link encapsulation to be used on this 3805 serial interface." 3806 DEFVAL { slip } 3807 ::= { serialConfigEntry 5 } 3809 serialSpeed OBJECT-TYPE 3810 SYNTAX INTEGER { 3811 speed300bps(1), 3812 speed1200bps(2), 3813 speed2400bps(3), 3814 speed4800bps(4), 3815 speed9600bps(5), 3816 speed14400bps(6), 3817 speed19200bps(7), 3818 speed38400bps(8) 3819 } 3820 MAX-ACCESS read-create 3821 STATUS current 3822 DESCRIPTION 3823 "The data rate to configure this serial interface to on startup 3824 as well as after each serial connection." 3825 DEFVAL { speed9600bps } 3826 ::= { serialConfigEntry 6 } 3828 serialTimeout OBJECT-TYPE 3829 SYNTAX Integer32 (1..65535) 3830 MAX-ACCESS read-create 3831 STATUS current 3832 DESCRIPTION 3833 "This timeout value is used when the Management Station has initiated 3834 the conversation over the serial link. This variable represents the 3835 number of seconds of inactivity allowed before terminating 3836 the connection on this serial interface. Use the serialTrapTimeout 3837 in the case where the probe has initiated the connection for the 3838 purpose of sending a trap." 3839 DEFVAL { 300 } 3840 ::= { serialConfigEntry 7 } 3842 serialModemInitString OBJECT-TYPE 3843 SYNTAX ControlString (SIZE (0..255)) 3844 MAX-ACCESS read-create 3845 STATUS current 3846 DESCRIPTION 3847 "A control string which controls how a modem attached to this 3848 serial interface should be initialized. The initialization is 3849 performed once during startup and again after each connection 3850 is terminated if the associated serialMode has the value 3851 of modem(2). 3852 A control string that is appropriate for a wide variety of 3853 modems is: '^s^MATE0Q0V1X4 S0=1 S2=43^M'." 3854 ::= { serialConfigEntry 8 } 3856 serialModemHangUpString OBJECT-TYPE 3857 SYNTAX ControlString (SIZE (0..255)) 3858 MAX-ACCESS read-create 3859 STATUS current 3860 DESCRIPTION 3861 "A control string which specifies how to disconnect a modem 3862 connection on this serial interface. This object is only 3863 meaningful if the associated serialMode has the value 3864 of modem(2). 3865 A control string that is appropriate for a wide variety of 3866 modems is: '^d2^s+++^d2^sATH0^M^d2'." 3867 ::= { serialConfigEntry 9 } 3869 serialModemConnectResp OBJECT-TYPE 3870 SYNTAX DisplayString (SIZE (0..255)) 3871 MAX-ACCESS read-create 3872 STATUS current 3873 DESCRIPTION 3874 "An ASCII string conntaining substrings that desribe the 3875 expected modem connection response code and associated bps 3876 rate. The substrings are delimited by the first character 3877 in the string, for example: 3878 /CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 3879 CONNECT 4800/4800/CONNECT 9600/9600 3880 will be interpreted as: 3881 response code bps rate 3882 CONNECT 300 3883 CONNECT 1200 1200 3884 CONNECT 2400 2400 3885 CONNECT 4800 4800 3886 CONNECT 9600 9600 3887 The agent will use the information in this string to adjust 3888 the bps rate of this serial interface once a modem connection 3889 is established. 3891 A value that is appropriate for a wide variety of modems is: 3892 '/CONNECT/300/CONNECT 1200/1200/CONNECT 2400/2400/ 3893 CONNECT 4800/4800/CONNECT 9600/9600/CONNECT 14400/14400/ 3894 CONNECT 19200/19200/CONNECT 38400/38400/'." 3895 ::= { serialConfigEntry 10 } 3897 serialModemNoConnectResp OBJECT-TYPE 3898 SYNTAX DisplayString (SIZE (0..255)) 3899 MAX-ACCESS read-create 3900 STATUS current 3901 DESCRIPTION 3902 "An ASCII string containing response codes that may be 3903 generated by a modem to report the reason why a connection 3904 attempt has failed. The response codes are delimited by 3905 the first character in the string, for example: 3906 /NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/ 3907 If one of these response codes is received via this serial 3908 interface while attempting to make a modem connection, 3909 the agent will issue the hang up command as specified by 3910 modemHangUpString. 3912 A value that is appropriate for a wide variety of modems is: 3913 '/NO CARRIER/BUSY/NO DIALTONE/NO ANSWER/ERROR/'." 3914 ::= { serialConfigEntry 11 } 3916 serialFlowControl OBJECT-TYPE 3917 SYNTAX INTEGER { 3918 noFlowControl(1), 3919 hardwareFlowControl(2) 3920 } 3921 MAX-ACCESS read-create 3922 STATUS current 3923 DESCRIPTION 3924 "The type of flow control to use on this serial 3925 interface." 3926 DEFVAL { hardwareFlowControl } 3927 ::= { serialConfigEntry 12 } 3929 serialDialoutTimeout OBJECT-TYPE 3930 SYNTAX Integer32 (1..65535) 3931 MAX-ACCESS read-create 3932 STATUS current 3933 DESCRIPTION 3934 "This timeout value is used when the probe initiates the 3935 serial connection with the intention of contacting a 3936 management station. This variable represents the number 3937 of seconds of inactivity allowed before terminating the 3938 connection on this serial interface." 3939 DEFVAL { 20 } 3940 ::= { serialConfigEntry 13 } 3942 netConfigTable OBJECT-TYPE 3943 SYNTAX SEQUENCE OF NetConfigEntry 3944 MAX-ACCESS not-accessible 3945 STATUS current 3946 DESCRIPTION 3947 "A table of network configuration entries." 3948 ::= { probeConfig 12 } 3950 netConfigEntry OBJECT-TYPE 3951 SYNTAX NetConfigEntry 3952 MAX-ACCESS not-accessible 3953 STATUS current 3954 DESCRIPTION 3955 "A set of configuration parameters for a particular 3956 network interface on this device." 3957 INDEX { netConfigIfIndex } 3958 ::= { netConfigTable 1 } 3960 NetConfigEntry ::= SEQUENCE { 3961 netConfigIfIndex Integer32 (1..65535), 3962 netConfigIPAddress IpAddress, 3963 netConfigSubnetMask IpAddress 3964 } 3966 netConfigIfIndex OBJECT-TYPE 3967 SYNTAX Integer32 (1..65535) 3968 MAX-ACCESS read-only 3969 STATUS current 3970 DESCRIPTION 3971 "The value of this object uniquely identifies the physical 3972 interface on this device for which this entry contains 3973 configuration parameters. The interface identified by a 3974 particular value of this object is the same interface as 3975 identified by the same value of the ifIndex object, defined 3976 in RFC 1213." 3977 ::= { netConfigEntry 1 } 3979 netConfigIPAddress OBJECT-TYPE 3980 SYNTAX IpAddress 3981 MAX-ACCESS read-create 3982 STATUS current 3983 DESCRIPTION 3984 "The IP address of this Net interface. The default value 3985 for this object is 0.0.0.0. If either the netConfigIPAddress or 3986 netConfigSubnetMask are 0.0.0.0, then when the device boots, it will 3987 use BOOTP to try to figure out what these values should be. 3988 Otherwise, if BOOTP fails, before the device can talk on the 3989 network, this value must be configured through a terminal 3990 attached to the device." 3991 ::= { netConfigEntry 2 } 3993 netConfigSubnetMask OBJECT-TYPE 3994 SYNTAX IpAddress 3995 MAX-ACCESS read-create 3996 STATUS current 3997 DESCRIPTION 3998 "The subnet mask of this Net interface. The default value 3999 for this object is 0.0.0.0. If either the netConfigIPAddress 4000 or netConfigSubnetMask are 0.0.0.0, then when the device boots, it 4001 will use BOOTP to try to figure out what these values should be. 4002 Otherwise, if BOOTP fails, before the device can talk on the 4003 network, this value must be configured through a terminal 4004 attached to the device." 4005 ::= { netConfigEntry 3 } 4007 netDefaultGateway OBJECT-TYPE 4008 SYNTAX IpAddress 4009 MAX-ACCESS read-create 4010 STATUS current 4011 DESCRIPTION 4012 "The IP Address of the default gateway" 4013 ::= { probeConfig 13 } 4015 -- Trap Destination Table 4016 -- 4017 -- This table defines the destination addresses for traps generated 4018 -- from the device. This table maps a community to one or more trap 4019 -- destination entries. 4020 -- 4021 -- The same trap will be sent to all destinations specified in the 4022 -- entries that have the same trapDestCommunity as the eventCommunity 4023 -- (as defined by RMON MIB). Information in this table will be stored 4024 -- in non-volatile memory. If the device has gone through a hard 4025 -- restart, this information will be reset to its default state. 4027 trapDestTable OBJECT-TYPE 4028 SYNTAX SEQUENCE OF TrapDestEntry 4029 MAX-ACCESS not-accessible 4030 STATUS current 4031 DESCRIPTION 4032 "A list of trap destination entries." 4033 ::= { probeConfig 14 } 4035 trapDestEntry OBJECT-TYPE 4036 SYNTAX TrapDestEntry 4037 MAX-ACCESS not-accessible 4038 STATUS current 4039 DESCRIPTION 4040 "This entry includes a destination IP address to which to send 4041 traps for this community. It also includes a backup address in 4042 case the primary address does not acknowledge the trap." 4043 INDEX { trapDestIndex } 4044 ::= { trapDestTable 1 } 4046 TrapDestEntry ::= SEQUENCE { 4047 trapDestIndex Integer32 (1..65535), 4048 trapDestCommunity OCTET STRING (SIZE(0..127)), 4049 trapDestIpAddress IpAddress, 4050 trapDestOwner OwnerString, 4051 trapDestStatus RowStatus 4052 } 4054 trapDestIndex OBJECT-TYPE 4055 SYNTAX Integer32 (1..65535) 4056 MAX-ACCESS read-only 4057 STATUS current 4058 DESCRIPTION 4059 "A value that uniquely identifies this trapDestEntry." 4060 ::= { trapDestEntry 1 } 4062 trapDestCommunity OBJECT-TYPE 4063 SYNTAX OCTET STRING (SIZE(0..127)) 4064 MAX-ACCESS read-create 4065 STATUS current 4066 DESCRIPTION 4067 "A community to which these destination IP addresses belong. 4068 This entry is associated with any eventEntries in the RMON MIB 4069 whose value of eventCommunity is equal to the value of this 4070 object. Every time an associated event entry sends a trap 4071 due to an event, that trap will be sent according to the 4072 addresses specified in this entry. 4074 This object may not be modifed if the associated trapDestStatus 4075 object is equal to valid(1)." 4076 ::= { trapDestEntry 2 } 4078 trapDestIpAddress OBJECT-TYPE 4079 SYNTAX IpAddress 4080 MAX-ACCESS read-create 4081 STATUS current 4082 DESCRIPTION 4083 "The primary IP address to which to send traps. 4085 This object may not be modifed if the associated trapDestStatus 4086 object is equal to valid(1)." 4087 ::= { trapDestEntry 3 } 4089 trapDestOwner OBJECT-TYPE 4090 SYNTAX OwnerString 4091 MAX-ACCESS read-create 4092 STATUS current 4093 DESCRIPTION 4094 "The owner of this trap destination entry." 4095 ::= { trapDestEntry 4 } 4097 trapDestStatus OBJECT-TYPE 4098 SYNTAX RowStatus 4099 MAX-ACCESS read-create 4100 STATUS current 4101 DESCRIPTION 4102 "The status of this trap destination entry." 4103 ::= { trapDestEntry 5 } 4105 -- Serial Connection Table 4106 -- 4107 -- The device may communicate with a management station using 4108 -- SLIP. In order for the device to send traps via SLIP, it must 4109 -- be able to initiate a connection over the serial interface. The 4110 -- serial connection table stores the parameters for such connection 4111 -- initiation. 4113 serialConnectionTable OBJECT-TYPE 4114 SYNTAX SEQUENCE OF SerialConnectionEntry 4115 MAX-ACCESS not-accessible 4116 STATUS current 4117 DESCRIPTION 4118 "A list of serial connection entries." 4119 ::= { probeConfig 15 } 4121 serialConnectionEntry OBJECT-TYPE 4122 SYNTAX SerialConnectionEntry 4123 MAX-ACCESS not-accessible 4124 STATUS current 4125 DESCRIPTION 4126 "Configuration for a SLIP link over a serial line." 4127 INDEX { serialConnectIndex } 4128 ::= { serialConnectionTable 1 } 4130 SerialConnectionEntry ::= SEQUENCE { 4131 serialConnectIndex Integer32 (1..65535), 4132 serialConnectDestIpAddress IpAddress, 4133 serialConnectType INTEGER, 4134 serialConnectDialString ControlString (SIZE(0..255)), 4135 serialConnectSwitchConnectSeq ControlString (SIZE(0..255)), 4136 serialConnectSwitchDisconnectSeq ControlString (SIZE(0..255)), 4137 serialConnectSwitchResetSeq ControlString (SIZE(0..255)), 4138 serialConnectOwner OwnerString, 4139 serialConnectStatus RowStatus 4140 } 4142 serialConnectIndex OBJECT-TYPE 4143 SYNTAX Integer32 (1..65535) 4144 MAX-ACCESS read-only 4145 STATUS current 4146 DESCRIPTION 4147 "A value that uniquely identifies this serialConnection entry." 4148 ::= { serialConnectionEntry 1 } 4150 serialConnectDestIpAddress OBJECT-TYPE 4151 SYNTAX IpAddress 4152 MAX-ACCESS read-create 4153 STATUS current 4154 DESCRIPTION 4155 "The IP Address that can be reached at the other end of this 4156 serial connection. 4157 This object may not be modifed if the associated 4158 serialConnectStatus object is equal to valid(1)." 4159 ::= { serialConnectionEntry 2 } 4161 serialConnectType OBJECT-TYPE 4162 SYNTAX INTEGER { 4163 direct(1), 4164 modem(2), 4165 switch(3), 4166 modemSwitch(4) 4167 } 4168 MAX-ACCESS read-create 4169 STATUS current 4170 DESCRIPTION 4171 "The type of outgoing connection to make. If this object 4172 has the value direct(1), then a direct serial connection 4173 is assumed. If this object has the value modem(2), 4174 then serialConnectDialString will be used to make a modem 4175 connection. If this object has the value switch(3), 4176 then serialConnectSwitchConnectSeq will be used to establish 4177 the connection over a serial data switch, and 4178 serialConnectSwitchDisconnectSeq will be used to terminate 4179 the connection. If this object has the value modem-switch(4), 4180 then a modem connection will be made first followed by 4181 the switch connection. 4182 This object may not be modifed if the associated 4183 serialConnectStatus object is equal to valid(1)." 4184 DEFVAL { direct } 4185 ::= { serialConnectionEntry 3 } 4187 serialConnectDialString OBJECT-TYPE 4188 SYNTAX ControlString (SIZE(0..255)) 4189 MAX-ACCESS read-create 4190 STATUS current 4191 DESCRIPTION 4192 "A control string which specifies how to dial the phone 4193 number in order to establish a modem connection. The 4194 string should include dialing prefix and suffix. For 4195 example: ``^s^MATD9,888-1234^M'' will instruct the Probe 4196 to send a carriage return followed by the dialing prefix 4197 ``ATD'', the phone number ``9,888-1234'', and a carriage 4198 return as the dialing suffix. 4199 This object may not be modifed if the associated 4200 serialConnectStatus object is equal to valid(1)." 4201 ::= { serialConnectionEntry 4 } 4203 serialConnectSwitchConnectSeq OBJECT-TYPE 4204 SYNTAX ControlString (SIZE(0..255)) 4205 MAX-ACCESS read-create 4206 STATUS current 4207 DESCRIPTION 4208 "A control string which specifies how to establish a 4209 data switch connection. 4210 This object may not be modifed if the associated 4211 serialConnectStatus object is equal to valid(1)." 4212 ::= { serialConnectionEntry 5 } 4214 serialConnectSwitchDisconnectSeq OBJECT-TYPE 4215 SYNTAX ControlString (SIZE(0..255)) 4216 MAX-ACCESS read-create 4217 STATUS current 4218 DESCRIPTION 4219 "A control string which specifies how to terminate a 4220 data switch connection. 4221 This object may not be modifed if the associated 4222 serialConnectStatus object is equal to valid(1)." 4223 ::= { serialConnectionEntry 6 } 4225 serialConnectSwitchResetSeq OBJECT-TYPE 4226 SYNTAX ControlString (SIZE(0..255)) 4227 MAX-ACCESS read-create 4228 STATUS current 4229 DESCRIPTION 4230 "A control string which specifies how to reset a data 4231 switch in the event of a timeout. 4232 This object may not be modifed if the associated 4233 serialConnectStatus object is equal to valid(1)." 4234 ::= { serialConnectionEntry 7 } 4236 serialConnectOwner OBJECT-TYPE 4237 SYNTAX OwnerString 4238 MAX-ACCESS read-create 4239 STATUS current 4240 DESCRIPTION 4241 "The owner of this serial connection entry." 4243 ::= { serialConnectionEntry 8 } 4245 serialConnectStatus OBJECT-TYPE 4246 SYNTAX RowStatus 4247 MAX-ACCESS read-create 4248 STATUS current 4249 DESCRIPTION 4250 "The status of this serial connection entry. 4252 If the manager attempts to set this object to valid(1) when 4253 the serialConnectType is set to modem(2) or modem-switch(4) 4254 and the serialConnectDialString is a zero-length string or 4255 cannot be correctly parsed as a ConnectString, the set 4256 request will be rejected with badValue(3). 4258 If the manager attempts to set this object to valid(1) when 4259 the serialConnectType is set to switch(3) or modem-switch(4) 4260 and the serialConnectSwitchConnectSeq, 4261 the serialConnectSwitchDisconnectSeq, or 4262 the serialConnectSwitchResetSeq are zero-length strings 4263 or cannot be correctly parsed as ConnectStrings, the set 4264 request will be rejected with badValue(3)." 4265 ::= { serialConnectionEntry 9 } 4267 END 4268 8. Acknowledgments 4270 This document was produced by the IETF Remote Network 4271 Monitoring Working Group. 4273 9. References 4275 [1] V. Cerf, IAB Recommendations for the Development of 4276 Internet Network Management Standards. Internet Working 4277 Group Request for Comments 1052. Network Information 4278 Center, SRI International, Menlo Park, California, 4279 (April, 1988). 4281 [2] V. Cerf, Report of the Second Ad Hoc Network Management 4282 Review Group, Internet Working Group Request for Comments 4283 1109. Network Information Center, SRI International, 4284 Menlo Park, California, (August, 1989). 4286 [3] M.T. Rose and K. McCloghrie, Structure and Identification 4287 of Management Information for TCP/IP-based internets, 4288 Internet Working Group Request for Comments 1155. 4289 Network Information Center, SRI International, Menlo 4290 Park, California, (May, 1990). 4292 [4] K. McCloghrie and M.T. Rose, Management Information Base 4293 for Network Management of TCP/IP-based internets: MIB-II, 4294 Internet Working Group Request for Comments 1213 Network 4295 Information Center, SRI International, Menlo Park, 4296 California, (March, 1991). 4298 [5] J.D. Case, M.S. Fedor, M.L. Schoffstall, and J.R. Davin, 4299 Simple Network Management Protocol, Internet Working 4300 Group Request for Comments 1157. Network Information 4301 Center, SRI International, Menlo Park, California, (May, 4302 1990). 4304 [6] K. McCloghrie and F. Kastenholz, Evolution of the 4305 Interfaces Group of MIB-II, Internet Working Group 4306 Request for Comments 1573. Network Information Center, 4307 SRI International, Menlo Park, California, (Jan, 1994). 4309 [7] Information processing systems - Open Systems 4310 Interconnection - Specification of Abstract Syntax 4311 Notation One (ASN.1), International Organization for 4312 Standardization. International Standard 8824, (December, 4313 1987). 4315 [8] Information processing systems - Open Systems 4316 Interconnection - Specification of Basic Encoding Rules 4317 for Abstract Notation One (ASN.1), International 4318 Organization for Standardization. International Standard 4319 8825, (December, 1987). 4321 [9] M.T. Rose, K. McCloghrie, Editors, Concise MIB 4322 Definitions, Internet Working Group Request for Comments 4323 1212. Network Information Center, SRI International, 4324 Menlo Park, California, (March, 1991). 4326 [10] M.T. Rose, Editor, A Convention for Defining Traps for 4327 use with the SNMP, Internet Working Group Request for 4328 Comments 1215. Network Information Center, SRI 4329 International, Menlo Park, California, (March, 1991). 4331 Table of Contents 4333 1 Status of this Memo ................................... 1 4334 2 Abstract .............................................. 1 4335 3 The Network Management Framework ...................... 3 4336 4 Overview .............................................. 4 4337 4.1 Remote Network Management Goals ..................... 4 4338 4.2 Structure of MIB .................................... 6 4339 5 Control of Remote Network Monitoring Devices .......... 7 4340 5.1 Resource Sharing Among Multiple Management Sta- 4341 tions .............................................. 7 4342 5.2 Row Addition Among Multiple Management Stations ..... 9 4343 6 Conventions ........................................... 11 4344 7 Definitions ........................................... 12 4345 8 Acknowledgments ....................................... 101 4346 9 References ............................................ 102