idnits 2.17.1 draft-ietf-rtfm-meter-mib-02.txt: 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-24) 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 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. ** 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 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.) ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. == There are 1 instance of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == Line 1702 has weird spacing: '...taValue flow...' -- 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 (September 1997) is 9718 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) ** Obsolete normative reference: RFC 1902 (ref. '2') (Obsoleted by RFC 2578) ** Obsolete normative reference: RFC 1903 (ref. '3') (Obsoleted by RFC 2579) ** Obsolete normative reference: RFC 1904 (ref. '4') (Obsoleted by RFC 2580) ** Obsolete normative reference: RFC 1908 (ref. '5') (Obsoleted by RFC 2576) -- Possible downref: Non-RFC (?) normative reference: ref. '6' -- Possible downref: Non-RFC (?) normative reference: ref. '7' ** Downref: Normative reference to an Informational RFC: RFC 1272 (ref. '8') ** Obsolete normative reference: RFC 2063 (ref. '9') (Obsoleted by RFC 2722) ** Obsolete normative reference: RFC 2021 (ref. '10') (Obsoleted by RFC 4502) ** Obsolete normative reference: RFC 1700 (ref. '11') (Obsoleted by RFC 3232) ** Downref: Normative reference to an Historic RFC: RFC 1285 (ref. '12') ** Obsolete normative reference: RFC 1884 (ref. '13') (Obsoleted by RFC 2373) Summary: 18 errors (**), 0 flaws (~~), 3 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Engineering Task Force Nevil Brownlee 2 INTERNET-DRAFT The University of Auckland 3 September 1997 5 Traffic Flow Measurement: Meter MIB 7 9 Status of this Memo 11 This document is an Internet Draft. Internet Drafts are working 12 documents of the Internet Engineering Task Force (IETF), its Areas, and 13 its Working Groups. Note that other groups may also distribute working 14 documents as Internet Drafts. This Internet Draft is a product of the 15 Realtime Traffic Flow Measurement Working Group of the IETF. 17 Internet Drafts are draft documents valid for a maximum of six months. 18 Internet Drafts may be updated, replaced, or obsoleted by other 19 documents at any time. It is not appropriate to use Internet Drafts as 20 reference material or to cite them other than as a "working draft" or 21 "work in progress." 23 Please check the I-D abstract listing contained in the internet-drafts 24 Shadow Directories on nic.ddn.mil, nnsc.nsf.net, nic.nordu.net, 25 ftp.nisc.sri.com or munnari.oz.au to learn the current status of this or 26 any other Internet Draft. 28 Abstract 30 A 'Traffic Meter' collects data relating to traffic flows within a 31 network. This document defines a Management Information Base (MIB) for 32 use in controlling a traffic meter, in particular for specifying the 33 flows to be measured. It also provides an efficient mechanism for 34 retrieving flow data from the meter using SNMP. Security issues 35 concerning the operation of traffic meters are summarised. 37 Contents 39 1 Introduction 1 41 2 The Network Management Framework 2 43 3 Objects 2 44 3.1 Format of Definitions . . . . . . . . . . . . . . . . . . . . 3 45 4 Overview 3 46 4.1 Scope of Definitions, Textual Conventions . . . . . . . . . . 4 47 4.2 Usage of the MIB variables . . . . . . . . . . . . . . . . . . 4 49 5 Changes Introduced Since RFC 2064 6 51 6 Definitions 7 53 7 Security Considerations 42 55 8 Acknowledgements 43 57 9 References 43 59 10 Author's Address 45 61 1 Introduction 63 This memo defines a portion of the Management Information Base (MIB) for 64 use with network management protocols in the Internet community. In 65 particular, it describes objects for managing and collecting data from 66 network Realtime Traffic Flow Meters, as described in [9]. 68 The MIB is 'basic' in the sense that it provides more than enough 69 information for everyday traffic measurment. Furthermore, it can be 70 easily extended by adding new attributes as required. The RTFM Working 71 group is actively pursuing the development of the meter in this way. 73 2 The Network Management Framework 75 The Internet-standard Network Management Framework consists of three 76 components. They are: 78 RFC 1155 defines the SMI, the mechanisms used for describing 79 and naming objects for the purpose of management. RFC 1212 80 defines a more concise description mechanism, which is wholly 81 consistent with the SMI. 83 RFC 1156 defines MIB-I, the core set of managed objects for the 84 Internet suite of protocols. RFC 1213 [1] defines MIB-II, an 85 evolution of MIB-I based on implementation experience and new 86 operational requirements. 88 RFC 1157 defines the SNMP, the protocol used for network access 89 to managed objects. 91 RFC 1902 [2] defines the SMI for version 2 of the Simple 92 Network Management Protocol. 94 RFCs 1903 and 1904 [3,4] define Textual Conventions and 95 Conformance Statements for version 2 of the Simple Network 96 Management Protocol. 98 RFC 1908 [5] describes how versions 1 and 2 of the Simple 99 Network Management Protocol should coexist. 101 The Framework permits new objects to be defined for the purpose of 102 experimentation and evaluation. 104 3 Objects 106 Managed objects are accessed via a virtual information store, termed the 107 Management Information Base or MIB. Objects in the MIB are defined using 108 the subset of Abstract Syntax Notation One (ASN.1) [6] defined in the 109 SMI. In particular, each object has a name, a syntax, and an encoding. 110 The name is an object identifier, an administratively assigned name, 111 which specifies an object type. The object type together with an object 112 instance serves to uniquely identify a specific instantiation of the 113 object. For human convenience, we often use a textual string, termed 114 the OBJECT DESCRIPTOR, to also refer to the object type. 116 The syntax of an object type defines the abstract data structure 117 corresponding to that object type. The ASN.1 language is used for this 118 purpose. However, the SMI [2] purposely restricts the ASN.1 constructs 119 which may be used. These restrictions are explicitly made for 120 simplicity. 122 The encoding of an object type is simply how that object type is 123 represented using the object type's syntax. Implicitly tied to the 124 notion of an object type's syntax and encoding is how the object type is 125 represented when being transmitted on the network. 127 The SMI specifies the use of the basic encoding rules of ASN.1 [7], 128 subject to the additional requirements imposed by the SNMP. 130 3.1 Format of Definitions 132 Section 4 contains the specification of all object types contained in 133 this MIB module. These object types are specified using the conventions 134 defined in [2] and [3]. 136 4 Overview 138 Traffic Flow Measurement seeks to provide a well-defined method for 139 gathering traffic flow information from networks and internetworks. The 140 background for this is given in "Traffic Flow Measurement: Background" 141 [8]. The Realtime Traffic Flow Measurement (rtfm) Working Group has 142 produced a measurement architecture to achieve this goal; this is 143 documented in "Traffic Flow Measurement: Architecture" [9]. The 144 architecture defines three entities: 146 - METERS, which observe network traffic flows and build up a table of 147 flow data records for them, 149 - METER READERS, which collect traffic flow data from meters, and 151 - MANAGERS, which oversee the operation of meters and meter readers. 153 This memo defines the SNMP management information for a Traffic Flow 154 Meter (TFM). Work in this field was begun by the Internet Accounting 155 Working Group. It has been further developed and expanded by the 156 Realtime Traffic Flow Measurement Working Group. 158 4.1 Scope of Definitions, Textual Conventions 160 All objects defined in this memo are registered in a single subtree 161 within the mib-2 namespace [1,2], and are for use in network devices 162 which may perform a PDU forwarding or monitoring function. For these 163 devices, the value of the ifSpecific variable in the MIB-II [1] has the 164 OBJECT IDENTIFIER value: 166 flowMIB OBJECT IDENTIFIER ::= mib-2 40 168 as defined below. 170 The RTFM Meter MIB was first produced and tested using SNMPv1. It was 171 converted into SNMPv2 following the guidelines in RFC 1908 [5]. 173 4.2 Usage of the MIB variables 175 The MIB is organised in four parts - control, data, rules and 176 conformance statements. 178 The rules implement the set of packet-matching actions, as described in 179 the "Traffic Flow Measurment: Architecture" document [9]. In addition 180 they provide for BASIC-style subroutines, allowing a network manager to 181 dramatically reduce the number of rules required to monitor a large 182 network. 184 Traffic flows are identified by a set of attributes for each of their 185 end-points. Attributes include network addresses for each layer of the 186 network protocol stack, and 'subscriber ids,' which may be used to 187 identify an accountable entity for the flow. 189 The conformance statements are set out as defined in [4]. They explain 190 what must be implemented in a meter which claims to conform to this MIB. 192 To retrieve flow data one could simply do a linear scan of the flow 193 table. This would certainly work, but would require a lot of protocol 194 exchanges. To reduce the overhead in retrieving flow data the flow 195 table uses a TimeFilter variable, defined as a Textual Convention in the 196 RMON2 MIB [10]. 198 As an alternative method of reading flow data, the MIB provides a view 199 of the flow table called the flowDataPackageTable. This is (logically) 200 a four-dimensional array, subscripted by package selector, ruleset, 201 activity time and starting flow number. The package selector is a 202 sequence of bytes which specifies a list of flow attributes. 204 A data package (as returned by the meter) is a sequence of values for 205 the attributes specified in its selector, encoded using the Basic 206 Encoding Rules [7]. It allows a meter reader to retrieve all the 207 attribute values it requires in a single MIB object. This, when used 208 together with SNMPv2's GetBulk request, allows a meter reader to scan 209 the flow table and upload a specified set of attribute values for flows 210 which have changed since the last reading, and which were created by a 211 specified rule set. 213 One aspect of data collection which needs emphasis is that all the MIB 214 variables are set up to allow multiple independent meter readers to work 215 properly, i.e. the flow table indexes are stateless. An alternative 216 approach would have been to 'snapshot' the flow table, which would mean 217 that the meter readers would have to be synchronized. The stateless 218 approach does mean that two meter readers will never return exactly the 219 same set of traffic counts, but over long periods (e.g. 15-minute 220 collections over a day) the discrepancies are acceptable. If one really 221 needs a snapshot, this can be achieved by switching to an identical rule 222 set with a different RuleSet number, hence asynchronous collections may 223 be regarded as a useful generalisation of synchronised ones. 225 The control variables are the minimum set required for a meter reader. 226 Their number has been whittled down as experience has been gained with 227 the MIB implementation. A few of them are 'general,' i.e. they control 228 the overall behaviour of the meter. These are set by a single 'master' 229 manager, and no other manager should attempt to change their values. 230 The decision as to which manager is the 'master' must be made by the 231 network operations personnel responsible; this MIB does not attempt to 232 define any interaction between managers. 234 There are three other groups of control variables, arranged into tables 235 in the same way as in the RMON2 MIB [10]. They are used as follows: 237 - RULE SET INFO: Before attempting to download a RuleSet, a manager 238 must create a row in the flowRuleSetInfoTable and set its 239 flowRuleInfoSize to a value large enough to hold the RuleSet. When 240 the rule set is ready the manager must set flowRuleInfoStatus to 241 'active,' indicating that the rule set is ready for use (but not 242 yet 'running'). 244 - METER READER INFO: Any meter reader wishing to collect data 245 reliably for all flows from a RuleSet should first create a row in 246 the flowReaderInfoTable with flowReaderRuleSet set to that 247 RuleSet's index in the flowRuleSetInfoTable. It should write that 248 row's flowReaderLastTime object each time it starts a collection 249 pass through the flow table. The meter will not recover a flow's 250 memory until every meter reader holding a row for that flow's 251 RuleSet has collected the flow's data. 253 - MANAGER INFO: Any manager wishing to run a RuleSet in the meter 254 must create a row in the flowManagerInfo table, specifying the 255 desired RuleSet to run and its corresponding 'standby' Ruleset (if 256 one is desired). A current RuleSet is 'running' if its 257 flowManagerRunningStandby value is false(2), similarly a standby 258 RuleSet is 'running' if flowManagerRunningStandby is true(1). 260 5 Changes Introduced Since RFC 2064 262 The first version of the Meter MIB was published as RFC 2064 in January 263 1997. The most significant changes since then are summarised below. 265 - TEXTUAL CONVENTIONS: Greater use is made of textual conventions to 266 describe the various types of addresses used by the meter. 268 - PACKET MATCHING ATTRIBUTES: Computed attributes (e.g. FlowClass 269 and FlowKind) may now be tested. This allows one to use these 270 variables to store information during packet matching. 272 A new attribute, MatchingStoD, has been added. Its value is 1 273 while a packet is being matched with its adresses in 'wire' 274 (source-to-destination) order. 276 - FLOOD MODE: This is now a read-write variable. Setting it to 277 false(2) switches the meter out of flood mode and back to normal 278 operation. 280 - CONTROL TABLES: Several variables have been added to the RuleSet, 281 Reader and Manager tables to provide more effective control of the 282 meter's activities. 284 - FLOW TABLE: 64-bit counters are used for octet and PDU counts. 285 This reduces the problems caused by the wrap-around of 32-bit 286 counters in earlier versions. 288 flowDataRuleSet is now used as an index to the flow table. This 289 allows a meter reader to collect only those flow table rows created 290 by a specified RuleSet. 292 - DATA PACKAGES: This is a new table, allowing a meter reader to 293 retrieve values for a list of attributes from a flow as a single 294 object. When used with SNMP GetBulk requests it provides an 295 efficient way to recover flow data. 297 Earlier versions had a 'Column Activity Table;' using this it was 298 difficult to collect all data for a flow efficiently in a single 299 SNMP request. 301 6 Definitions 303 FLOW-METER-MIB DEFINITIONS ::= BEGIN 305 IMPORTS 306 MODULE-IDENTITY, OBJECT-TYPE, Counter32, Counter64, Integer32 307 FROM SNMPv2-SMI 308 TEXTUAL-CONVENTION, RowStatus, TimeStamp, TruthValue 309 FROM SNMPv2-TC 310 OBJECT-GROUP, MODULE-COMPLIANCE 311 FROM SNMPv2-CONF 312 mib-2, ifIndex 313 FROM RFC1213-MIB 314 OwnerString 315 FROM RMON-MIB 317 TimeFilter 318 FROM RMON2-MIB; 320 flowMIB MODULE-IDENTITY 321 LAST-UPDATED "9707071715Z" 322 ORGANIZATION "IETF Realtime Traffic Flow Measurement Working Group" 323 CONTACT-INFO 324 "Nevil Brownlee, The University of Auckland 326 Postal: Information Technology Sytems & Services 327 The University of Auckland 328 Private Bag 92-019 329 Auckland, New Zealand 331 Phone: +64 9 373 7599 x8941 332 E-mail: n.brownlee@auckland.ac.nz" 333 DESCRIPTION 334 "MIB for the RTFM Traffic Flow Meter." 336 REVISION "9707071715Z" 337 DESCRIPTION 338 "Significant changes since RFC 2064 include: 339 - flowDataPackageTable added 340 - flowColumnActivityTable deprecated 341 - flowManagerCounterWrap deprecated" 343 REVISION "9603080208Z" 344 DESCRIPTION 345 "Initial version of this MIB (RFC 2064)" 346 ::= { mib-2 40 } 348 flowControl OBJECT IDENTIFIER ::= { flowMIB 1 } 350 flowData OBJECT IDENTIFIER ::= { flowMIB 2 } 352 flowRules OBJECT IDENTIFIER ::= { flowMIB 3 } 354 flowMIBConformance OBJECT IDENTIFIER ::= { flowMIB 4 } 356 -- Textual Conventions 358 MediumType ::= TEXTUAL-CONVENTION 359 STATUS current 360 DESCRIPTION 361 "Specifies the type of a MediumAddress (see below). The 362 values used for IEEE 802 media are from the 'Network 363 Management Parameters (ifType definitions)' section of the 364 Assigned Numbers RFC [11]." 365 SYNTAX INTEGER { 366 ethernet(7), 367 tokenring(9), 368 fddi(15) } 370 MediumAddress ::= TEXTUAL-CONVENTION 371 STATUS current 372 DESCRIPTION 373 "Specifies the value of a Medium Access Control (MAC) address. 374 Address format depends on the actual Medium, as follows: 376 Ethernet: ethernet(7) 377 6-octet 802.3 MAC address in 'canonical' order 379 Token Ring: tokenring(9) 380 6-octet 802.5 MAC address in 'canonical' order 382 FDDI: fddi(15) 383 FddiMACLongAddress, i.e. a 6-octet MAC address 384 in 'canonical' order (defined in the FDDI MIB [12]) 385 " 386 SYNTAX OCTET STRING (SIZE (6..20)) 388 PeerType ::= TEXTUAL-CONVENTION 389 STATUS current 390 DESCRIPTION 391 "Indicates the type of a PeerAddress (see below). The values 392 used are from the 'Address Family Numbers' section of the 393 Assigned Numbers RFC [11]." 394 SYNTAX INTEGER { 395 ipv4(1), 396 ipv6(2), 397 nsap(3), 398 ipx(11), 399 appletalk(12), 400 decnet(13) } 402 PeerAddress ::= TEXTUAL-CONVENTION 403 STATUS current 404 DESCRIPTION 405 "Specifies the value of a peer address for various network 406 protocols. Address format depends on the actual protocol, 407 as indicated below: 409 IPv4: ipv4(1) 410 4-octet IpAddress (defined in the SNMPv2 SMI [2]) 412 IPv6: ipv6(2) 413 16-octet IpAddress (defined in the 414 IPv6 Addressing RFC [13]) 416 CLNS: nsap(3) 417 NsapAddress (defined in the SNMPv2 SMI [2]) 419 Novell: ipx(11) 420 4-octet Network number, 421 6-octet Host number (MAC address) 423 AppleTalk: appletalk(12) 424 2-octet Network number (sixteen bits), 425 1-octet Host number (eight bits) 427 DECnet: decnet(13) 428 1-octet Area number (in low-order six bits), 429 2-octet Host number (in low-order ten bits) 430 " 431 SYNTAX OCTET STRING (SIZE (3..20)) 433 AdjacentType ::= TEXTUAL-CONVENTION 434 STATUS current 435 DESCRIPTION 436 "Indicates the type of an adjacent address. 437 Is a superset of MediumType and PeerType." 438 SYNTAX INTEGER { 439 ip(1), 440 nsap(3), 441 ethernet(7), 442 tokenring(9), 443 ipx(11), 444 appletalk(12), 445 decnet(13), 446 fddi(15) } 448 AdjacentAddress ::= TEXTUAL-CONVENTION 449 STATUS current 450 DESCRIPTION 451 "Specifies the value of an adjacent address. 452 Is a superset of MediumAddress and PeerAddress." 453 SYNTAX OCTET STRING (SIZE (3..20)) 455 TransportType ::= TEXTUAL-CONVENTION 456 STATUS current 457 DESCRIPTION 458 "Indicates the type of a TransportAddress (see below). Values 459 will depend on the actual protocol; for IP they will be those 460 given in the 'Protocol Numbers' section of the Assigned Numbers 461 RFC [11], including icmp(1), tcp(6) and udp(17)." 462 SYNTAX Integer32 (1..255) 464 TransportAddress ::= TEXTUAL-CONVENTION 465 STATUS current 466 DESCRIPTION 467 "Specifies the value of a transport address for various 468 network protocols. Format as follows: 470 IP: 471 2-octet UDP or TCP port number 473 Other protocols: 474 2-octet port number 475 " 476 SYNTAX OCTET STRING (SIZE (2)) 478 RuleAddress ::= TEXTUAL-CONVENTION 479 STATUS current 480 DESCRIPTION 481 "Specifies the value of an address. Is a superset of 482 MediumAddress, PeerAddress and TransportAddress." 483 SYNTAX OCTET STRING (SIZE (2..20)) 485 FlowAttributeNumber ::= TEXTUAL-CONVENTION 486 STATUS current 487 DESCRIPTION 488 "Uniquely identifies an attribute within a flow data record." 489 SYNTAX INTEGER { 490 flowIndex(1), 491 flowStatus(2), 492 flowTimeMark(3), 494 sourceInterface(4), 495 sourceAdjacentType(5), 496 sourceAdjacentAddress(6), 497 sourceAdjacentMask(7), 498 sourcePeerType(8), 499 sourcePeerAddress(9), 500 sourcePeerMask(10), 501 sourceTransType(11), 502 sourceTransAddress(12), 503 sourceTransMask(13), 505 destInterface(14), 506 destAdjacentType(15), 507 destAdjacentAddress(16), 508 destAdjacentMask(17), 509 destPeerType(18), 510 destPeerAddress(19), 511 destPeerMask(20), 512 destTransType(21), 513 destTransAddress(22), 514 destTransMask(23), 516 pduScale(24), 517 octetScale(25), 518 ruleSet(26), 519 toOctets(27), -- Source-to-Dest 520 toPDUs(28), 521 fromOctets(29), -- Dest-to-Source 522 fromPDUs(30), 523 firstTime(31), -- Activity times 524 lastActiveTime(32), 526 sourceSubscriberID(33), -- Subscriber ID 527 destSubscriberID(34), 528 sessionID(35), 530 sourceClass(36), -- Computed attributes 531 destClass(37), 532 flowClass(38), 533 sourceKind(39), 534 destKind(40), 535 flowKind(41) } 537 RuleAttributeNumber ::= TEXTUAL-CONVENTION 538 STATUS current 539 DESCRIPTION 540 "Uniquely identifies an attribute which may be tested in 541 a rule. These include attributes whose values come directly 542 from (or are computed from) the flow's packets, and the five 543 'meter' variables used to hold an Attribute Number." 544 SYNTAX INTEGER { 545 null(0), 546 sourceInterface(4), -- Source Address 547 sourceAdjacentType(5), 548 sourceAdjacentAddress(6), 549 sourcePeerType(8), 550 sourcePeerAddress(9), 551 sourceTransType(11), 552 sourceTransAddress(12), 554 destInterface(14), -- Dest Address 555 destAdjacentType(15), 556 destAdjacentAddress(16), 557 destPeerType(18), 558 destPeerAddress(19), 559 destTransType(21), 560 destTransAddress(22), 562 sourceSubscriberID(33), -- Subscriber ID 563 destSubscriberID(34), 564 sessionID(35), 566 sourceClass(36), -- Computed attributes 567 destClass(37), 568 flowClass(38), 569 sourceKind(39), 570 destKind(40), 571 flowKind(41), 573 matchingStoD(50), -- Packet matching 575 v1(51), -- Meter variables 576 v2(52), 577 v3(53), 578 v4(54), 579 v5(55) } 581 ActionNumber ::= TEXTUAL-CONVENTION 582 STATUS current 583 DESCRIPTION 584 "Uniquely identifies the action of a rule, i.e. the Pattern 585 Matching Engine's opcode number. Details of the opcodes 586 are given in the 'Traffic Flow Measurement: Architecture' 587 document [9]." 588 SYNTAX INTEGER { 589 ignore(1), 590 noMatch(2), 591 count(3), 592 countPkt(4), 593 return(5), 594 gosub(6), 595 gosubAct(7), 596 assign(8), 597 assignAct(9), 598 goto(10), 599 gotoAct(11), 600 pushRuleTo(12), 601 pushRuleToAct(13), 602 pushPktTo(14), 603 pushPktToAct(15) } 605 -- 606 -- Control Group: Rule Set Info Table 607 -- 609 flowRuleSetInfoTable OBJECT-TYPE 610 SYNTAX SEQUENCE OF FlowRuleSetInfoEntry 611 MAX-ACCESS not-accessible 612 STATUS current 613 DESCRIPTION 614 "An array of information about the rule sets held in the 615 meter. 617 Any manager may configure a new rule set for the meter by 618 creating a row in this table with status active(1), and setting 619 values for all the objects in its rules. At this stage the new 620 rule set is available but not 'running,' i.e. it is not being 621 used by the meter to produce entries in the flow table. 623 To actually 'run' a rule set a manager must create a row in 624 the flowManagerInfoTable, set it's flowManagerStatus to 625 active(1), and set either its CurrentRuleSet or StandbyRuleSet 626 to point to the rule set to be run. 628 Once a rule set is running a manager may not change any of the 629 objects within the rule set itself. 631 Any manager may stop a rule set running by removing all 632 references to it in the flowManagerInfoTable (i.e. by setting 633 CurrentRuleSet and StandbyRuleSet values to 0). This provides a 634 way to stop rule sets left running if a manager fails." 635 ::= { flowControl 1 } 637 flowRuleSetInfoEntry OBJECT-TYPE 638 SYNTAX FlowRuleSetInfoEntry 639 MAX-ACCESS not-accessible 640 STATUS current 641 DESCRIPTION 642 "Information about a particular rule set." 643 INDEX { flowRuleInfoIndex } 644 ::= { flowRuleSetInfoTable 1 } 646 FlowRuleSetInfoEntry ::= SEQUENCE { 647 flowRuleInfoIndex Integer32, 648 flowRuleInfoSize Integer32, 649 flowRuleInfoOwner OwnerString, 650 flowRuleInfoTimeStamp TimeStamp, 651 flowRuleInfoStatus RowStatus, 652 flowRuleInfoName OCTET STRING, 653 flowRuleInfoRulesReady TruthValue, 654 flowRuleInfoFlowRecords Integer32 655 } 657 flowRuleInfoIndex OBJECT-TYPE 658 SYNTAX Integer32 (1..2147483647) 659 MAX-ACCESS not-accessible 660 STATUS current 661 DESCRIPTION 662 "An index which selects an entry in the flowRuleSetInfoTable. 663 Each such entry contains control information for a particular 664 rule set which the meter may run." 665 ::= { flowRuleSetInfoEntry 1 } 667 flowRuleInfoSize OBJECT-TYPE 668 SYNTAX Integer32 669 MAX-ACCESS read-create 670 STATUS current 671 DESCRIPTION 672 "Number of rules in this rule set. Setting this variable will 673 cause the meter to allocate space for these rules." 674 ::= { flowRuleSetInfoEntry 2 } 676 flowRuleInfoOwner OBJECT-TYPE 677 SYNTAX OwnerString 678 MAX-ACCESS read-create 679 STATUS current 680 DESCRIPTION 681 "Identifies the manager which 'owns' this rule set. A manager 682 must set this variable when creating a row in this table." 683 ::= { flowRuleSetInfoEntry 3 } 685 flowRuleInfoTimeStamp OBJECT-TYPE 686 SYNTAX TimeStamp 687 MAX-ACCESS read-only 688 STATUS current 689 DESCRIPTION 690 "Time this row's associated rule set was last changed." 691 ::= { flowRuleSetInfoEntry 4 } 693 flowRuleInfoStatus OBJECT-TYPE 694 SYNTAX RowStatus 695 MAX-ACCESS read-create 696 STATUS current 697 DESCRIPTION 698 "The status of this flowRuleSetInfoEntry. If this value is 699 not active(1) the meter must not attempt to use the row's 700 associated rule set. Once its value has been set to active(1) 701 a manager may only change this row's flowRuleInfoSize, 702 flowRuleInfoName and floeRuleInfoRulesReady variables." 703 ::= { flowRuleSetInfoEntry 5 } 705 flowRuleInfoName OBJECT-TYPE 706 SYNTAX OCTET STRING 707 MAX-ACCESS read-create 708 STATUS current 709 DESCRIPTION 710 "An alphanumeric identifier used by managers and readers to 711 identify a rule set. For example, a manager wishing to run a 712 rule set named WWW-FLOWS could search the flowRuleSetInfoTable 713 to see whether the WWW-FLOWS rule set is already available on 714 the meter. 716 Note that references to rule sets in the flowManagerInfoTable 717 use indexes for their flowRuleSetInfoTable entries. These may 718 be different each time the rule set is loaded into a meter." 719 ::= { flowRuleSetInfoEntry 6 } 721 flowRuleInfoRulesReady OBJECT-TYPE 722 SYNTAX TruthValue 723 MAX-ACCESS read-create 724 STATUS current 725 DESCRIPTION 726 "Indicates whether the rules for this row's associated rule set 727 are ready for use. The meter will refuse to 'run' the rule set 728 unless this variable has been set to true(1)." 729 ::= { flowRuleSetInfoEntry 7 } 731 flowRuleInfoFlowRecords OBJECT-TYPE 732 SYNTAX Integer32 733 MAX-ACCESS read-only 734 STATUS current 735 DESCRIPTION 736 "The number of entries in the flow table for this rule set. 737 These may be current (waiting for collection by one or more 738 meter readers) or idle (waiting for the meter to recover 739 their memory)." 740 ::= { flowRuleSetInfoEntry 8 } 742 -- 743 -- Control Group: Interface Info Table 744 -- 746 flowInterfaceTable OBJECT-TYPE 747 SYNTAX SEQUENCE OF FlowInterfaceEntry 748 MAX-ACCESS not-accessible 749 STATUS current 750 DESCRIPTION 751 "An array of information specific to each meter interface." 752 ::= { flowControl 2 } 754 flowInterfaceEntry OBJECT-TYPE 755 SYNTAX FlowInterfaceEntry 756 MAX-ACCESS not-accessible 757 STATUS current 758 DESCRIPTION 759 "Information about a particular interface." 760 INDEX { ifIndex } 761 ::= { flowInterfaceTable 1 } 763 FlowInterfaceEntry ::= SEQUENCE { 764 flowInterfaceSampleRate Integer32, 765 flowInterfaceLostPackets Counter32 766 } 768 flowInterfaceSampleRate OBJECT-TYPE 769 SYNTAX Integer32 770 MAX-ACCESS read-write 771 STATUS current 772 DESCRIPTION 773 "The parameter N for statistical counting on this interface. 774 Set to N to count 1/Nth of the packets appearing at this 775 interface. A meter should choose its own algorithm to 776 introduce variance into the sampling so that exactly every Nth 777 packet is not counted. A sampling rate of 1 counts all 778 packets. A sampling rate of 0 results in the interface 779 being ignored by the meter." 780 DEFVAL { 1 } 781 ::= { flowInterfaceEntry 1 } 783 flowInterfaceLostPackets OBJECT-TYPE 784 SYNTAX Counter32 785 MAX-ACCESS read-only 786 STATUS current 787 DESCRIPTION 788 "The number of packets the meter has lost for this interface. 789 Such losses may occur because the meter has been unable to 790 keep up with the traffic volume." 791 ::= { flowInterfaceEntry 2 } 793 -- 794 -- Control Group: Meter Reader Info Table 795 -- 797 -- Any meter reader wishing to collect data reliably for flows 798 -- should first create a row in this table. It should write that 799 -- row's flowReaderLastTime object each time it starts a collection 800 -- pass through the flow table. 802 -- If a meter reader (MR) does not create a row in this table, e.g. 803 -- because it failed authentication in the meter's SNMP write 804 -- community, collection can still proceed but the meter will not be 805 -- aware of meter reader MR. This could lead the meter to recover 806 -- flows before they have been collected by MR. 808 flowReaderInfoTable OBJECT-TYPE 809 SYNTAX SEQUENCE OF FlowReaderInfoEntry 810 MAX-ACCESS not-accessible 811 STATUS current 812 DESCRIPTION 813 "An array of information about meter readers which have 814 registered their intent to collect flow data from this meter." 815 ::= { flowControl 3 } 817 flowReaderInfoEntry OBJECT-TYPE 818 SYNTAX FlowReaderInfoEntry 819 MAX-ACCESS not-accessible 820 STATUS current 821 DESCRIPTION 822 "Information about a particular meter reader." 824 INDEX { flowReaderIndex } 825 ::= { flowReaderInfoTable 1 } 827 FlowReaderInfoEntry ::= SEQUENCE { 828 flowReaderIndex Integer32, 829 flowReaderTimeout Integer32, 830 flowReaderOwner OwnerString, 831 flowReaderLastTime TimeStamp, 832 flowReaderPreviousTime TimeStamp, 833 flowReaderStatus RowStatus, 834 flowReaderRuleSet Integer32 835 } 837 flowReaderIndex OBJECT-TYPE 838 SYNTAX Integer32 (1..2147483647) 839 MAX-ACCESS not-accessible 840 STATUS current 841 DESCRIPTION 842 "An index which selects an entry in the flowReaderInfoTable." 843 ::= { flowReaderInfoEntry 1 } 845 flowReaderTimeout OBJECT-TYPE 846 SYNTAX Integer32 847 MAX-ACCESS read-create 848 STATUS current 849 DESCRIPTION 850 "Specifies the maximum time (in seconds) between flow data 851 collections for this meter reader. If this time elapses 852 without a collection, the meter should assume that this meter 853 reader has stopped collecting, and delete this row from the 854 table. A value of zero indicates that this row should not be 855 timed out." 856 ::= { flowReaderInfoEntry 2 } 858 flowReaderOwner OBJECT-TYPE 859 SYNTAX OwnerString 860 MAX-ACCESS read-create 861 STATUS current 862 DESCRIPTION 863 "Identifies the meter reader which created this row." 864 ::= { flowReaderInfoEntry 3 } 866 flowReaderLastTime OBJECT-TYPE 867 SYNTAX TimeStamp 868 MAX-ACCESS read-create 869 STATUS current 870 DESCRIPTION 871 "Time this meter reader began its most recent data collection. 873 This variable should be written by a meter reader as its first 874 step in reading flow data. The meter will set this LastTime 875 value to sysUptime and set its PreviousTime value (below) to 876 the old LastTime. This allows the meter to recover flows 877 which have been inactive since PreviousTime, for these have 878 been collected at least once. 880 If the meter reader fails to write flowLastReadTime, collection 881 may still proceed but the meter may not be able to recover 882 inactive flows until the flowReaderTimeout has been reached 883 for this entry." 884 ::= { flowReaderInfoEntry 4 } 886 flowReaderPreviousTime OBJECT-TYPE 887 SYNTAX TimeStamp 888 MAX-ACCESS read-only 889 STATUS current 890 DESCRIPTION 891 "Time this meter reader began the collection before last." 892 ::= { flowReaderInfoEntry 5 } 894 flowReaderStatus OBJECT-TYPE 895 SYNTAX RowStatus 896 MAX-ACCESS read-create 897 STATUS current 898 DESCRIPTION 899 "The status of this FlowReaderInfoEntry. A value of active(1) 900 implies that the associated reader should be collecting data 901 from the meter. Once this variable has been set to active(1) 902 a manager may only change this row's flowReaderLastTime and 903 flowReaderTimeout variables." 904 ::= { flowReaderInfoEntry 6 } 906 flowReaderRuleSet OBJECT-TYPE 907 SYNTAX Integer32 (1..2147483647) 908 MAX-ACCESS read-create 909 STATUS current 910 DESCRIPTION 911 "An index to the array of rule sets. Specifies a set of rules 912 of interest to this meter reader. The reader will attempt to 913 collect any data generated by the meter for this rule set, and 914 the meter will not recover the memory of any of the rule set's 915 flows until this collection has taken place. Note that a 916 reader may have entries in this table for several rule sets." 917 ::= { flowReaderInfoEntry 7 } 919 -- 920 -- Control Group: Manager Info Table 921 -- 923 -- Any manager wishing to run a rule set must create a row in this 924 -- table. Once it has a table row, the manager may set the control 925 -- variables in its row so as to cause the meter to run any valid 926 -- rule set held by the meter. 928 -- A single manager may run several rule sets; it must create a row 929 -- in this table for each of them. In short, each row of this table 930 -- describes (and controls) a 'task' which the meter is executing. 932 flowManagerInfoTable OBJECT-TYPE 933 SYNTAX SEQUENCE OF FlowManagerInfoEntry 934 MAX-ACCESS not-accessible 935 STATUS current 936 DESCRIPTION 937 "An array of information about managers which have 938 registered their intent to run rule sets on this meter." 939 ::= { flowControl 4 } 941 flowManagerInfoEntry OBJECT-TYPE 942 SYNTAX FlowManagerInfoEntry 943 MAX-ACCESS not-accessible 944 STATUS current 945 DESCRIPTION 946 "Information about a particular meter 'task.' By creating 947 an entry in this table and activating it, a manager requests 948 that the meter 'run' the indicated rule set. 950 The entry also specifies a HighWaterMark and a StandbyRuleSet. 951 If the meter's flow table usage exceeds this task's 952 HighWaterMark the meter will stop running the task's 953 CurrentRuleSet and switch to its StandbyRuleSet. 955 If the value of the task's StandbyRuleSet is 0 when its 956 HighWaterMark is exceeded, the meter simply stops running the 957 task's CurrentRuleSet. By careful selection of HighWaterMarks 958 for the various tasks a manager can ensure that the most 959 critical rule sets are the last to stop running as the number 960 of flows increases. 962 When a manager has determined that the demand for flow table 963 space has abated, it may cause the task to switch back to its 964 CurrentRuleSet by setting its flowManagerRunningStandby 965 variable to false(2)." 966 INDEX { flowManagerIndex } 967 ::= { flowManagerInfoTable 1 } 969 FlowManagerInfoEntry ::= SEQUENCE { 970 flowManagerIndex Integer32, 971 flowManagerCurrentRuleSet Integer32, 972 flowManagerStandbyRuleSet Integer32, 973 flowManagerHighWaterMark Integer32, 974 flowManagerCounterWrap INTEGER, 975 flowManagerOwner OwnerString, 976 flowManagerTimeStamp TimeStamp, 977 flowManagerStatus RowStatus, 978 flowManagerRunningStandby TruthValue 979 } 981 flowManagerIndex OBJECT-TYPE 982 SYNTAX Integer32 (1..2147483647) 983 MAX-ACCESS not-accessible 984 STATUS current 985 DESCRIPTION 986 "An index which selects an entry in the flowManagerInfoTable." 987 ::= { flowManagerInfoEntry 1 } 989 flowManagerCurrentRuleSet OBJECT-TYPE 990 SYNTAX Integer32 991 MAX-ACCESS read-create 992 STATUS current 993 DESCRIPTION 994 "Index to the array of rule sets. Specifies which set of 995 rules is the 'current' one for this task. The meter will 996 be 'running' the current ruleset if this row's 997 flowManagerRunningStandby value is false(2). 999 When the manager sets this variable the meter will close the 1000 task's old current rule set and start using the new one. 1001 Specifying rule set 0 (the empty set) stops flow measurement 1002 by this manager. Flows created by the old rule set remain 1003 in memory, orphaned until their data has been read." 1004 ::= { flowManagerInfoEntry 2 } 1006 flowManagerStandbyRuleSet OBJECT-TYPE 1007 SYNTAX Integer32 1008 MAX-ACCESS read-create 1009 STATUS current 1010 DESCRIPTION 1011 "Index to the array of rule sets. After reaching HighWaterMark 1012 (see below) the manager will switch to using the task's 1013 StandbyRuleSet in place of its CurrentRuleSet. For this to be 1014 effective the designated StandbyRuleSet should have a coarser 1015 reporting granularity then the CurrentRuleSet. The manager may 1016 also need to decrease the meter reading interval so that the 1017 meter can recover flows measured by the CurrentRuleSet." 1018 DEFVAL { 0 } -- No standby 1019 ::= { flowManagerInfoEntry 3 } 1021 flowManagerHighWaterMark OBJECT-TYPE 1022 SYNTAX Integer32 (0..100) 1023 MAX-ACCESS read-create 1024 STATUS current 1025 DESCRIPTION 1026 "A value expressed as a percentage, interpreted by the meter 1027 as an indication of how full the flow table should be before 1028 it should switch to the standby rule set (if one has been 1029 specified) for this task. Values of 0% or 100% disable the 1030 checking represented by this variable." 1031 ::= { flowManagerInfoEntry 4 } 1033 flowManagerCounterWrap OBJECT-TYPE 1034 SYNTAX INTEGER { wrap(1), scale(2) } 1035 MAX-ACCESS read-create 1036 STATUS deprecated 1037 DESCRIPTION 1038 "Specifies whether PDU and octet counters should wrap when 1039 they reach the top of their range (normal behaviour for 1040 Counter64 objects), or whether their scale factors should 1041 be used instead. The combination of counter and scale 1042 factor allows counts to be returned as binary floating 1043 point numbers, with 64-bit mantissas and 8-bit exponents." 1044 DEFVAL { wrap } 1045 ::= { flowManagerInfoEntry 5 } 1047 flowManagerOwner OBJECT-TYPE 1048 SYNTAX OwnerString 1049 MAX-ACCESS read-create 1050 STATUS current 1051 DESCRIPTION 1052 "Identifies the manager which created this row." 1053 ::= { flowManagerInfoEntry 6 } 1055 flowManagerTimeStamp OBJECT-TYPE 1056 SYNTAX TimeStamp 1057 MAX-ACCESS read-only 1058 STATUS current 1059 DESCRIPTION 1060 "Time this row was last changed by its manager." 1061 ::= { flowManagerInfoEntry 7 } 1063 flowManagerStatus OBJECT-TYPE 1064 SYNTAX RowStatus 1065 MAX-ACCESS read-create 1066 STATUS current 1067 DESCRIPTION 1068 "The status of this row in the flowManagerInfoTable. A value 1069 of active(1) implies that this task may be activated, by 1070 setting its CurrentRuleSet and StandbyRuleSet variables. 1071 Its HighWaterMark and RunningStandby variables may also be 1072 changed." 1073 ::= { flowManagerInfoEntry 8 } 1075 flowManagerRunningStandby OBJECT-TYPE 1076 SYNTAX TruthValue 1077 MAX-ACCESS read-create 1078 STATUS current 1079 DESCRIPTION 1080 "Set to true(1) by the meter to indicate that it has switched 1081 to runnning this task's StandbyRuleSet in place of its 1082 CurrentRuleSet. To switch back to the CurrentRuleSet, the 1083 manager may simply set this variable to false(2)." 1084 DEFVAL { false } 1085 ::= { flowManagerInfoEntry 9 } 1087 -- 1088 -- Control Group: General Meter Control Variables 1089 -- 1091 flowFloodMark OBJECT-TYPE 1092 SYNTAX Integer32 (0..100) 1093 MAX-ACCESS read-write 1094 STATUS current 1095 DESCRIPTION 1096 "A value expressed as a percentage, interpreted by the meter 1097 as an indication of how full the flow table should be before 1098 it should take some action to avoid running out of resources 1099 to handle new flows. Values of 0% or 100% disable the 1100 checking represented by this variable." 1101 DEFVAL { 95 } -- Enabled by default. 1102 ::= { flowControl 5 } 1104 flowInactivityTimeout OBJECT-TYPE 1105 SYNTAX Integer32 1106 MAX-ACCESS read-write 1107 STATUS current 1108 DESCRIPTION 1109 "The time in seconds since the last packet seen, after which 1110 a flow becomes 'idle.' Note that although a flow may be 1111 idle, it will not be discarded (and its memory recovered) 1112 until after its data has been collected by all the meter 1113 readers registered for its RuleSet." 1114 DEFVAL { 600 } -- 10 minutes 1115 ::= { flowControl 6 } 1117 flowActiveFlows OBJECT-TYPE 1118 SYNTAX Integer32 1119 MAX-ACCESS read-only 1120 STATUS current 1121 DESCRIPTION 1122 "The numbers of flows which are currently in use." 1123 ::= { flowControl 7 } 1125 flowMaxFlows OBJECT-TYPE 1126 SYNTAX Integer32 1127 MAX-ACCESS read-only 1128 STATUS current 1129 DESCRIPTION 1130 "The maximum number of flows allowed in the meter's 1131 flow table. At present this is determined when the meter 1132 is first started up." 1133 ::= { flowControl 8 } 1135 flowFloodMode OBJECT-TYPE 1136 SYNTAX TruthValue 1137 MAX-ACCESS read-write 1138 STATUS current 1139 DESCRIPTION 1140 "Indicates that the meter has passed its FloodMark and is 1141 not running in its normal mode. When a manager notices this 1142 it should take action to remedy the problem which caused the 1143 flooding. Once the flood has receded, the manager may set 1144 this variable to false(2) to resume normal operaation." 1145 ::= { flowControl 9 } 1147 -- 1148 -- The Flow Table 1149 -- 1151 -- This is a table kept by a meter, with one flow data entry for every 1152 -- flow being measured. Each flow data entry stores the attribute 1153 -- values for a traffic flow. Details of flows and their attributes 1154 -- are given in the 'Traffic Flow Measurement: Architecture' 1155 -- document [9]. 1157 -- From time to time a meter reader may sweep the flow table so as 1158 -- to read counts. This is most effectively achieved by using the 1159 -- TimeMark variable together with successive GetBulk requests to 1160 -- retrieve the values of the desired flow attribute variables. 1162 -- This scheme allows multiple meter readers to independently use the 1163 -- same meter; the meter readers do not have to be synchronised and 1164 -- they may use different collection intervals. 1166 flowDataTable OBJECT-TYPE 1167 SYNTAX SEQUENCE OF FlowDataEntry 1168 MAX-ACCESS not-accessible 1169 STATUS current 1170 DESCRIPTION 1171 "The list of all flows being measured." 1172 ::= { flowData 1 } 1174 flowDataEntry OBJECT-TYPE 1175 SYNTAX FlowDataEntry 1176 MAX-ACCESS not-accessible 1177 STATUS current 1178 DESCRIPTION 1179 "The flow data record for a particular flow." 1181 INDEX { flowDataRuleSet, flowDataTimeMark, flowDataIndex } 1182 ::= { flowDataTable 1 } 1184 FlowDataEntry ::= SEQUENCE { 1185 flowDataIndex Integer32, 1186 flowDataTimeMark TimeFilter, 1187 flowDataStatus INTEGER, 1189 flowDataSourceInterface Integer32, 1190 flowDataSourceAdjacentType AdjacentType, 1191 flowDataSourceAdjacentAddress AdjacentAddress, 1192 flowDataSourceAdjacentMask AdjacentAddress, 1193 flowDataSourcePeerType PeerType, 1194 flowDataSourcePeerAddress PeerAddress, 1195 flowDataSourcePeerMask PeerAddress, 1196 flowDataSourceTransType TransportType, 1197 flowDataSourceTransAddress TransportAddress, 1198 flowDataSourceTransMask TransportAddress, 1200 flowDataDestInterface Integer32, 1201 flowDataDestAdjacentType AdjacentType, 1202 flowDataDestAdjacentAddress AdjacentAddress, 1203 flowDataDestAdjacentMask AdjacentAddress, 1204 flowDataDestPeerType PeerType, 1205 flowDataDestPeerAddress PeerAddress, 1206 flowDataDestPeerMask PeerAddress, 1207 flowDataDestTransType TransportType, 1208 flowDataDestTransAddress TransportAddress, 1209 flowDataDestTransMask TransportAddress, 1211 flowDataPDUScale Integer32, 1212 flowDataOctetScale Integer32, 1214 flowDataRuleSet Integer32, 1216 flowDataToOctets Counter64, -- Source->Dest 1217 flowDataToPDUs Counter64, 1218 flowDataFromOctets Counter64, -- Dest->Source 1219 flowDataFromPDUs Counter64, 1220 flowDataFirstTime TimeStamp, -- Activity times 1221 flowDataLastActiveTime TimeStamp, 1223 flowDataSourceSubscriberID OCTET STRING, 1224 flowDataDestSubscriberID OCTET STRING, 1225 flowDataSessionID OCTET STRING, 1227 flowDataSourceClass Integer32, 1228 flowDataDestClass Integer32, 1229 flowDataClass Integer32, 1230 flowDataSourceKind Integer32, 1231 flowDataDestKind Integer32, 1232 flowDataKind Integer32 1233 } 1235 flowDataIndex OBJECT-TYPE 1236 SYNTAX Integer32 (1..2147483647) 1237 MAX-ACCESS not-accessible 1238 STATUS current 1239 DESCRIPTION 1240 "Value of this flow data record's index within the meter's 1241 flow table." 1242 ::= { flowDataEntry 1 } 1244 flowDataTimeMark OBJECT-TYPE 1245 SYNTAX TimeFilter 1246 MAX-ACCESS not-accessible 1247 STATUS current 1248 DESCRIPTION 1249 "A TimeFilter for this entry. Allows GetNext and GetBulk 1250 to find flow table rows which have changed since a specified 1251 value of sysUptime." 1252 ::= { flowDataEntry 2 } 1254 flowDataStatus OBJECT-TYPE 1255 SYNTAX INTEGER { inactive(1), current(2) } 1256 MAX-ACCESS read-only 1257 STATUS current 1258 DESCRIPTION 1259 "Status of this flow data record." 1260 ::= { flowDataEntry 3 } 1262 flowDataSourceInterface OBJECT-TYPE 1263 SYNTAX Integer32 1264 MAX-ACCESS read-only 1265 STATUS current 1266 DESCRIPTION 1267 "Index of the interface associated with the source address 1268 for this flow. It's value is one of those contained in the 1269 ifIndex field of the meter's interfaces table." 1270 ::= { flowDataEntry 4 } 1272 flowDataSourceAdjacentType OBJECT-TYPE 1273 SYNTAX AdjacentType 1274 MAX-ACCESS read-only 1275 STATUS current 1276 DESCRIPTION 1277 "Adjacent address type of the source for this flow. If 1278 metering is being performed at the network level this will 1279 probably be an 802 MAC address, and the adjacent type will 1280 indicate the medium being used. If traffic is being metered 1281 inside a tunnel, its adjacent address type will be the peer 1282 type of the host at the end of the tunnel." 1284 ::= { flowDataEntry 5 } 1286 flowDataSourceAdjacentAddress OBJECT-TYPE 1287 SYNTAX AdjacentAddress 1288 MAX-ACCESS read-only 1289 STATUS current 1290 DESCRIPTION 1291 "Address of the adjacent device on the path for the source 1292 for this flow." 1293 ::= { flowDataEntry 6 } 1295 flowDataSourceAdjacentMask OBJECT-TYPE 1296 SYNTAX AdjacentAddress 1297 MAX-ACCESS read-only 1298 STATUS current 1299 DESCRIPTION 1300 "1-bits in this mask indicate which bits must match when 1301 comparing the adjacent source address for this flow." 1302 ::= { flowDataEntry 7 } 1304 flowDataSourcePeerType OBJECT-TYPE 1305 SYNTAX PeerType 1306 MAX-ACCESS read-only 1307 STATUS current 1308 DESCRIPTION 1309 "Peer address type of the source for this flow." 1310 ::= { flowDataEntry 8 } 1312 flowDataSourcePeerAddress OBJECT-TYPE 1313 SYNTAX PeerAddress 1314 MAX-ACCESS read-only 1315 STATUS current 1316 DESCRIPTION 1317 "Address of the peer device for the source of this flow." 1318 ::= { flowDataEntry 9 } 1320 flowDataSourcePeerMask OBJECT-TYPE 1321 SYNTAX PeerAddress 1322 MAX-ACCESS read-only 1323 STATUS current 1324 DESCRIPTION 1325 "1-bits in this mask indicate which bits must match when 1326 comparing the source peer address for this flow." 1327 ::= { flowDataEntry 10 } 1329 flowDataSourceTransType OBJECT-TYPE 1330 SYNTAX TransportType 1331 MAX-ACCESS read-only 1332 STATUS current 1333 DESCRIPTION 1334 "Transport address type of the source for this flow. The 1335 value of this attribute will depend on the peer address type." 1336 ::= { flowDataEntry 11 } 1338 flowDataSourceTransAddress OBJECT-TYPE 1339 SYNTAX TransportAddress 1340 MAX-ACCESS read-only 1341 STATUS current 1342 DESCRIPTION 1343 "Transport address for the source of this flow." 1344 ::= { flowDataEntry 12 } 1346 flowDataSourceTransMask OBJECT-TYPE 1347 SYNTAX TransportAddress 1348 MAX-ACCESS read-only 1349 STATUS current 1350 DESCRIPTION 1351 "1-bits in this mask indicate which bits must match when 1352 comparing the transport source address for this flow." 1353 ::= { flowDataEntry 13 } 1355 flowDataDestInterface OBJECT-TYPE 1356 SYNTAX Integer32 1357 MAX-ACCESS read-only 1358 STATUS current 1359 DESCRIPTION 1360 "Index of the interface associated with the dest address for 1361 this flow. This value is one of the values contained in the 1362 ifIndex field of the interfaces table." 1363 ::= { flowDataEntry 14 } 1365 flowDataDestAdjacentType OBJECT-TYPE 1366 SYNTAX AdjacentType 1367 MAX-ACCESS read-only 1368 STATUS current 1369 DESCRIPTION 1370 "Adjacent address type of the destination for this flow." 1371 ::= { flowDataEntry 15 } 1373 flowDataDestAdjacentAddress OBJECT-TYPE 1374 SYNTAX AdjacentAddress 1375 MAX-ACCESS read-only 1376 STATUS current 1377 DESCRIPTION 1378 "Address of the adjacent device on the path for the 1379 destination for this flow." 1380 ::= { flowDataEntry 16 } 1382 flowDataDestAdjacentMask OBJECT-TYPE 1383 SYNTAX AdjacentAddress 1384 MAX-ACCESS read-only 1385 STATUS current 1386 DESCRIPTION 1387 "1-bits in this mask indicate which bits must match when 1388 comparing the adjacent dest address for this flow." 1389 ::= { flowDataEntry 17 } 1391 flowDataDestPeerType OBJECT-TYPE 1392 SYNTAX PeerType 1393 MAX-ACCESS read-only 1394 STATUS current 1395 DESCRIPTION 1396 "Peer address type of the destination for this flow." 1397 ::= { flowDataEntry 18 } 1399 flowDataDestPeerAddress OBJECT-TYPE 1400 SYNTAX PeerAddress 1401 MAX-ACCESS read-only 1402 STATUS current 1403 DESCRIPTION 1404 "Address of the peer device for the destination of this flow." 1405 ::= { flowDataEntry 19 } 1407 flowDataDestPeerMask OBJECT-TYPE 1408 SYNTAX PeerAddress 1409 MAX-ACCESS read-only 1410 STATUS current 1411 DESCRIPTION 1412 "1-bits in this mask indicate which bits must match when 1413 comparing the dest peer type for this flow." 1414 ::= { flowDataEntry 20 } 1416 flowDataDestTransType OBJECT-TYPE 1417 SYNTAX TransportType 1418 MAX-ACCESS read-only 1419 STATUS current 1420 DESCRIPTION 1421 "Transport address type of the destination for this flow. The 1422 value of this attribute will depend on the peer address type." 1423 ::= { flowDataEntry 21 } 1425 flowDataDestTransAddress OBJECT-TYPE 1426 SYNTAX TransportAddress 1427 MAX-ACCESS read-only 1428 STATUS current 1429 DESCRIPTION 1430 "Transport address for the destination of this flow." 1431 ::= { flowDataEntry 22 } 1433 flowDataDestTransMask OBJECT-TYPE 1434 SYNTAX TransportAddress 1435 MAX-ACCESS read-only 1436 STATUS current 1437 DESCRIPTION 1438 "1-bits in this mask indicate which bits must match when 1439 comparing the transport destination address for this flow." 1440 ::= { flowDataEntry 23 } 1442 flowDataPDUScale OBJECT-TYPE 1443 SYNTAX Integer32 (1..255) 1444 MAX-ACCESS read-only 1445 STATUS current 1446 DESCRIPTION 1447 "The scale factor applied to this particular flow. Indicates 1448 the number of bits the PDU counter values should be moved left 1449 to obtain the actual values." 1450 ::= { flowDataEntry 24 } 1452 flowDataOctetScale OBJECT-TYPE 1453 SYNTAX Integer32 (1..255) 1454 MAX-ACCESS read-only 1455 STATUS current 1456 DESCRIPTION 1457 "The scale factor applied to this particular flow. Indicates 1458 the number of bits the octet counter values should be moved 1459 left to obtain the actual values." 1460 ::= { flowDataEntry 25 } 1462 flowDataRuleSet OBJECT-TYPE 1463 SYNTAX Integer32 (1..255) 1464 MAX-ACCESS not-accessible 1465 STATUS current 1466 DESCRIPTION 1467 "The RuleSet number of the rule set which created this flow. 1468 Allows a manager to use GetNext or GetBulk requests to find 1469 flows belonging to a particular RuleSet." 1470 ::= { flowDataEntry 26 } 1472 flowDataToOctets OBJECT-TYPE 1473 SYNTAX Counter64 1474 MAX-ACCESS read-only 1475 STATUS current 1476 DESCRIPTION 1477 "The count of octets flowing from source to dest address and 1478 being delivered to the protocol level being metered. In the 1479 case of IP this would count the number of octets delivered to 1480 the IP level." 1481 ::= { flowDataEntry 27 } 1483 flowDataToPDUs OBJECT-TYPE 1484 SYNTAX Counter64 1485 MAX-ACCESS read-only 1486 STATUS current 1487 DESCRIPTION 1488 "The count of protocol packets flowing from source to dest 1489 address and being delivered to the protocol level being 1490 metered. In the case of IP, for example, this would count the 1491 IP packets delivered to the IP protocol level." 1492 ::= { flowDataEntry 28 } 1494 flowDataFromOctets OBJECT-TYPE 1495 SYNTAX Counter64 1496 MAX-ACCESS read-only 1497 STATUS current 1498 DESCRIPTION 1499 "The count of octets flowing from dest to source address and 1500 being delivered to the protocol level being metered." 1501 ::= { flowDataEntry 29 } 1503 flowDataFromPDUs OBJECT-TYPE 1504 SYNTAX Counter64 1505 MAX-ACCESS read-only 1506 STATUS current 1507 DESCRIPTION 1508 "The count of protocol packets flowing from dest to source 1509 address and being delivered to the protocol level being 1510 metered. In the case of IP, for example, this would count 1511 the IP packets delivered to the IP protocol level." 1512 ::= { flowDataEntry 30 } 1514 flowDataFirstTime OBJECT-TYPE 1515 SYNTAX TimeStamp 1516 MAX-ACCESS read-only 1517 STATUS current 1518 DESCRIPTION 1519 "The time at which this flow was first entered in the table" 1520 ::= { flowDataEntry 31 } 1522 flowDataLastActiveTime OBJECT-TYPE 1523 SYNTAX TimeStamp 1524 MAX-ACCESS read-only 1525 STATUS current 1526 DESCRIPTION 1527 "The last time this flow had activity, i.e. the time of 1528 arrival of the most recent PDU belonging to this flow." 1529 ::= { flowDataEntry 32 } 1531 flowDataSourceSubscriberID OBJECT-TYPE 1532 SYNTAX OCTET STRING (SIZE (4..20)) 1533 MAX-ACCESS read-only 1534 STATUS current 1535 DESCRIPTION 1536 "Subscriber ID associated with the source address for this 1537 flow." 1538 ::= { flowDataEntry 33 } 1540 flowDataDestSubscriberID OBJECT-TYPE 1541 SYNTAX OCTET STRING (SIZE (4..20)) 1542 MAX-ACCESS read-only 1543 STATUS current 1544 DESCRIPTION 1545 "Subscriber ID associated with the dest address for this 1546 flow." 1547 ::= { flowDataEntry 34 } 1549 flowDataSessionID OBJECT-TYPE 1550 SYNTAX OCTET STRING (SIZE (4..10)) 1551 MAX-ACCESS read-only 1552 STATUS current 1553 DESCRIPTION 1554 "Session ID for this flow. Such an ID might be allocated 1555 by a network access server to distinguish a series of sessions 1556 between the same pair of addresses, which would otherwise 1557 appear to be parts of the same accounting flow." 1558 ::= { flowDataEntry 35 } 1560 flowDataSourceClass OBJECT-TYPE 1561 SYNTAX Integer32 (1..255) 1562 MAX-ACCESS read-only 1563 STATUS current 1564 DESCRIPTION 1565 "Source class for this flow. Determined by the rules, set by 1566 a PushRule action when this flow was entered in the table." 1567 ::= { flowDataEntry 36 } 1569 flowDataDestClass OBJECT-TYPE 1570 SYNTAX Integer32 (1..255) 1571 MAX-ACCESS read-only 1572 STATUS current 1573 DESCRIPTION 1574 "Destination class for this flow. Determined by the rules, set 1575 by a PushRule action when this flow was entered in the table." 1576 ::= { flowDataEntry 37 } 1578 flowDataClass OBJECT-TYPE 1579 SYNTAX Integer32 (1..255) 1580 MAX-ACCESS read-only 1581 STATUS current 1582 DESCRIPTION 1583 "Class for this flow. Determined by the rules, set by a 1584 PushRule action when this flow was entered in the table." 1585 ::= { flowDataEntry 38 } 1587 flowDataSourceKind OBJECT-TYPE 1588 SYNTAX Integer32 (1..255) 1589 MAX-ACCESS read-only 1590 STATUS current 1591 DESCRIPTION 1592 "Source kind for this flow. Determined by the rules, set by 1593 a PushRule action when this flow was entered in the table." 1594 ::= { flowDataEntry 39 } 1596 flowDataDestKind OBJECT-TYPE 1597 SYNTAX Integer32 (1..255) 1598 MAX-ACCESS read-only 1599 STATUS current 1600 DESCRIPTION 1601 "Destination kind for this flow. Determined by the rules, set 1602 by a PushRule action when this flow was entered in the table." 1603 ::= { flowDataEntry 40 } 1605 flowDataKind OBJECT-TYPE 1606 SYNTAX Integer32 (1..255) 1607 MAX-ACCESS read-only 1608 STATUS current 1609 DESCRIPTION 1610 "Class for this flow. Determined by the rules, set by a 1611 PushRule action when this flow was entered in the table." 1612 ::= { flowDataEntry 41 } 1614 -- 1615 -- The Activity Column Table 1616 -- 1618 flowColumnActivityTable OBJECT-TYPE 1619 SYNTAX SEQUENCE OF FlowColumnActivityEntry 1620 MAX-ACCESS not-accessible 1621 STATUS deprecated 1622 DESCRIPTION 1623 "Index into the Flow Table. Allows a meter reader to retrieve 1624 a list containing the flow table indeces of flows which were 1625 last active at or after a given time, together with the values 1626 of a specified attribute for each such flow." 1627 ::= { flowData 2 } 1629 flowColumnActivityEntry OBJECT-TYPE 1630 SYNTAX FlowColumnActivityEntry 1631 MAX-ACCESS not-accessible 1632 STATUS deprecated 1633 DESCRIPTION 1634 "The Column Activity Entry for a particular attribute, 1635 activity time and flow." 1636 INDEX { flowColumnActivityAttribute, flowColumnActivityTime, 1637 flowColumnActivityIndex } 1638 ::= { flowColumnActivityTable 1 } 1640 FlowColumnActivityEntry ::= SEQUENCE { 1641 flowColumnActivityAttribute FlowAttributeNumber, 1642 flowColumnActivityTime TimeFilter, 1643 flowColumnActivityIndex Integer32, 1644 flowColumnActivityData OCTET STRING 1645 } 1647 flowColumnActivityAttribute OBJECT-TYPE 1648 SYNTAX FlowAttributeNumber 1649 MAX-ACCESS read-only 1650 STATUS deprecated 1651 DESCRIPTION 1652 "Specifies the attribute for which values are required from 1653 active flows." 1654 ::= { flowColumnActivityEntry 1 } 1656 flowColumnActivityTime OBJECT-TYPE 1657 SYNTAX TimeFilter 1658 MAX-ACCESS read-only 1659 STATUS deprecated 1660 DESCRIPTION 1661 "This variable is a copy of flowDataLastActiveTime in the 1662 flow data record identified by the flowColumnActivityIndex 1663 value of this flowColumnActivityTable entry." 1664 ::= { flowColumnActivityEntry 2 } 1666 flowColumnActivityIndex OBJECT-TYPE 1667 SYNTAX Integer32 (1..2147483647) 1668 MAX-ACCESS read-only 1669 STATUS deprecated 1670 DESCRIPTION 1671 "Index of a flow table entry which was active at or after 1672 a specified flowColumnActivityTime." 1673 ::= { flowColumnActivityEntry 3 } 1675 flowColumnActivityData OBJECT-TYPE 1676 SYNTAX OCTET STRING (SIZE (3..1000)) 1677 MAX-ACCESS read-only 1678 STATUS deprecated 1679 DESCRIPTION 1680 "Collection of attribute data for flows active after 1681 flowColumnActivityTime. Within the OCTET STRING is a 1682 sequence of { flow index, attribute value } pairs, one for 1683 each active flow. The end of the sequence is marked by a 1684 flow index value of 0, indicating that there are no more 1685 rows in this column. 1687 The format of objects inside flowColumnFlowData is as follows. 1688 All numbers are unsigned. Numbers and strings appear with 1689 their high-order bytes leading. Numbers are fixed size, as 1690 specified by their SYNTAX in the flow table (above), i.e. one 1691 octet for flowAddressType and small constants, and four octets 1692 for Counter and TimeStamp. Strings are variable-length, with 1693 the length given in a single leading octet. 1695 The following is an attempt at an ASN.1 definition of 1696 flowColumnActivityData: 1698 flowColumnActivityData ::= SEQUENCE flowRowItemEntry 1699 flowRowItemEntry ::= SEQUENCE { 1700 flowRowNumber Integer32 (1..65535), 1701 -- 0 indicates the end of this column 1702 flowDataValue flowDataType -- Choice depends on attribute 1703 } 1704 flowDataType ::= CHOICE { 1705 flowByteValue Integer32 (1..255), 1706 flowShortValue Integer32 (1..65535), 1707 flowLongValue Integer32, 1708 flowStringValue OCTET STRING -- Length (n) in first byte, 1709 -- n+1 bytes total length, trailing zeroes truncated 1710 }" 1711 ::= { flowColumnActivityEntry 4 } 1713 -- 1714 -- The Data Package Table 1715 -- 1717 flowDataPackageTable OBJECT-TYPE 1718 SYNTAX SEQUENCE OF FlowDataPackageEntry 1719 MAX-ACCESS not-accessible 1720 STATUS current 1721 DESCRIPTION 1722 "Index into the Flow Table. Allows a meter reader to retrieve 1723 a sequence containing the values of a specified set of 1724 attributes for a flow which came from a specified rule set and 1725 which was last active at or after a given time." 1726 ::= { flowData 3 } 1728 flowDataPackageEntry OBJECT-TYPE 1729 SYNTAX FlowDataPackageEntry 1730 MAX-ACCESS not-accessible 1731 STATUS current 1732 DESCRIPTION 1733 "The data package containing selected variables from 1734 active rows in the flow table." 1735 INDEX { flowPackageSelector, 1736 flowPackageRuleSet, flowPackageTime, flowPackageIndex } 1737 ::= { flowDataPackageTable 1 } 1739 FlowDataPackageEntry ::= SEQUENCE { 1740 flowPackageSelector OCTET STRING, 1741 flowPackageRuleSet Integer32, 1742 flowPackageTime TimeFilter, 1743 flowPackageIndex Integer32, 1744 flowPackageData OCTET STRING 1745 } 1747 flowPackageSelector OBJECT-TYPE 1748 SYNTAX OCTET STRING 1749 MAX-ACCESS not-accessible 1750 STATUS current 1751 DESCRIPTION 1752 "Specifies the attributes for which values are required from 1753 an active flow. These are encoded as a sequence of octets 1754 each containing a FlowAttribute number, preceded by an octet 1755 giving the length of the sequence (not including the length 1756 octet)." 1757 ::= { flowDataPackageEntry 1 } 1759 flowPackageRuleSet OBJECT-TYPE 1760 SYNTAX Integer32 (1..255) 1761 MAX-ACCESS not-accessible 1762 STATUS current 1763 DESCRIPTION 1764 "Specifies the index (in the flowRuleSetInfoTable) of the rule 1765 set which produced the required flow." 1766 ::= { flowDataPackageEntry 2 } 1768 flowPackageTime OBJECT-TYPE 1769 SYNTAX TimeFilter 1770 MAX-ACCESS not-accessible 1771 STATUS current 1772 DESCRIPTION 1773 "This variable is a copy of flowDataLastActiveTime in the 1774 flow data record identified by the flowPackageIndex 1775 value of this flowPackageTable entry." 1776 ::= { flowDataPackageEntry 3 } 1778 flowPackageIndex OBJECT-TYPE 1779 SYNTAX Integer32 (1..2147483647) 1780 MAX-ACCESS not-accessible 1781 STATUS current 1782 DESCRIPTION 1783 "Index of a flow table entry which was active at or after 1784 a specified flowPackageTime." 1785 ::= { flowDataPackageEntry 4 } 1787 flowPackageData OBJECT-TYPE 1788 SYNTAX OCTET STRING 1789 MAX-ACCESS read-only 1790 STATUS current 1791 DESCRIPTION 1792 "A Collection of attribute values for a single flow, as 1793 specified by this row's indeces. The attribute values are 1794 contained within a BER-encoded sequence [7], in the order 1795 they appear in their flowPackageSelector. For example, to 1796 retrieve a flowPackage containing values for attributes 11, 1797 18 and 29, for flows in rule set 7, active since uptime 12345, 1798 beginning with the first row after row 3447, one would request 1799 the package whose Object Identifier (OID) is 1800 flowPackageData . 3.11.18.29 . 7. 12345 . 3447 " 1801 ::= { flowDataPackageEntry 5 } 1803 -- 1804 -- The Rule Table 1805 -- 1807 -- This is an array of rule tables; the 'running' ones are indicated 1808 -- by the entries in the meter's flowManagerInfoTable. Several rule 1809 -- sets can be held in a meter so that the manager can change the rules 1810 -- easily, for example with time of day. Note that a manager may 1811 -- not change the rules in any 'running' rule set! See the 'Traffic 1812 -- Flow Measurement: Architecture' document [9] for details of rules 1813 -- and how they are used. 1814 -- 1815 -- Space for a rule table is allocated by setting the value of 1816 -- flowRuleInfoSize in the rule table's flowRuleSetInfoTable row. 1818 flowRuleTable OBJECT-TYPE 1819 SYNTAX SEQUENCE OF FlowRuleEntry 1820 MAX-ACCESS not-accessible 1821 STATUS current 1822 DESCRIPTION 1823 "Contains all the rule sets which may be used by the meter." 1824 ::= { flowRules 1 } 1826 flowRuleEntry OBJECT-TYPE 1827 SYNTAX FlowRuleEntry 1828 MAX-ACCESS not-accessible 1829 STATUS current 1830 DESCRIPTION 1831 "The rule record itself." 1832 INDEX { flowRuleSet, flowRuleIndex } 1833 ::= { flowRuleTable 1 } 1835 FlowRuleEntry ::= SEQUENCE { 1836 flowRuleSet Integer32, 1837 flowRuleIndex Integer32, 1838 flowRuleSelector RuleAttributeNumber, 1839 flowRuleMask RuleAddress, 1840 flowRuleMatchedValue RuleAddress, 1841 flowRuleAction ActionNumber, 1842 flowRuleParameter Integer32 1843 } 1845 flowRuleSet OBJECT-TYPE 1846 SYNTAX Integer32 (1..255) 1847 MAX-ACCESS not-accessible 1848 STATUS current 1849 DESCRIPTION 1850 "Selects a rule set from the array of rule sets." 1851 ::= { flowRuleEntry 1 } 1853 flowRuleIndex OBJECT-TYPE 1854 SYNTAX Integer32 (1..65535) 1855 MAX-ACCESS not-accessible 1856 STATUS current 1857 DESCRIPTION 1858 "The index into the Rule table. N.B: These values will 1859 normally be consecutive, given the fall-through semantics 1860 of processing the table." 1861 ::= { flowRuleEntry 2 } 1863 flowRuleSelector OBJECT-TYPE 1864 SYNTAX RuleAttributeNumber 1865 MAX-ACCESS read-write 1866 STATUS current 1867 DESCRIPTION 1868 "Indicates the attribute to be matched. 1870 null(0) is a special case; null rules always succeed. 1872 matchingStoD(50) is set by the meter's Packet Matching Engine. 1873 Its value is true(1) if the PME is attempting to match the 1874 packet with its addresses in Source-to-Destination order (i.e. 1875 as they appear in the packet), and false(2) otherwise. 1876 Details of how packets are matched are given in the 'Traffic 1877 Flow Measurement: Architecture' document [9]. 1879 v1(51), v2(52), v3(53), v4(54) and v5(55) select meter 1880 variables, each of which can hold the name (i.e. selector 1881 value) of an address attribute. When one of these is used 1882 as a selector, its value specifies the attribute to be 1883 tested. Variable values are set by an Assign action." 1884 ::= { flowRuleEntry 3 } 1886 flowRuleMask OBJECT-TYPE 1887 SYNTAX RuleAddress 1888 MAX-ACCESS read-write 1889 STATUS current 1890 DESCRIPTION 1891 "The initial mask used to compute the desired value. If the 1892 mask is zero the rule's test will always succeed." 1893 ::= { flowRuleEntry 4 } 1895 flowRuleMatchedValue OBJECT-TYPE 1896 SYNTAX RuleAddress 1897 MAX-ACCESS read-write 1898 STATUS current 1899 DESCRIPTION 1900 "The resulting value to be matched for equality. 1901 Specifically, if the attribute chosen by the flowRuleSelector 1902 logically ANDed with the mask specified by the flowRuleMask 1903 equals the value specified in the flowRuleMatchedValue, then 1904 continue processing the table entry based on the action 1905 specified by the flowRuleAction entry. Otherwise, proceed to 1906 the next entry in the rule table." 1907 ::= { flowRuleEntry 5 } 1909 flowRuleAction OBJECT-TYPE 1910 SYNTAX ActionNumber 1911 MAX-ACCESS read-write 1912 STATUS current 1913 DESCRIPTION 1914 "The action to be taken if this rule's test succeeds, or if 1915 the meter's 'test' flag is off. Actions are opcodes for the 1916 meter's Packet Matching Engine; details are given in the 1917 'Traffic Flow Measurement: Architecture' document [9]." 1918 ::= { flowRuleEntry 6 } 1920 flowRuleParameter OBJECT-TYPE 1921 SYNTAX Integer32 (1..65535) 1922 MAX-ACCESS read-write 1923 STATUS current 1924 DESCRIPTION 1925 "A parameter value providing extra information for the 1926 rule's action." 1927 ::= { flowRuleEntry 7 } 1929 -- 1930 -- Traffic Flow Meter conformance statement 1931 -- 1933 flowMIBCompliances 1934 OBJECT IDENTIFIER ::= { flowMIBConformance 1 } 1936 flowMIBGroups 1937 OBJECT IDENTIFIER ::= { flowMIBConformance 2 } 1939 flowControlGroup OBJECT-GROUP 1940 OBJECTS { 1941 flowRuleInfoSize, flowRuleInfoOwner, 1942 flowRuleInfoTimeStamp, flowRuleInfoStatus, 1943 flowRuleInfoName, flowRuleInfoRulesReady, 1944 flowRuleInfoFlowRecords, 1945 flowInterfaceSampleRate, 1946 flowInterfaceLostPackets, 1947 flowReaderTimeout, flowReaderOwner, 1948 flowReaderLastTime, flowReaderPreviousTime, 1949 flowReaderStatus, flowReaderRuleSet, 1950 flowManagerCurrentRuleSet, flowManagerStandbyRuleSet, 1951 flowManagerHighWaterMark, 1952 -- flowManagerCounterWrap, 1953 flowManagerOwner, flowManagerTimeStamp, 1954 flowManagerStatus, flowManagerRunningStandby, 1955 flowFloodMark, 1956 flowInactivityTimeout, flowActiveFlows, 1957 flowMaxFlows, flowFloodMode } 1958 STATUS current 1959 DESCRIPTION 1960 "The control group defines objects which are used to control 1961 an accounting meter." 1962 ::= {flowMIBGroups 1 } 1964 flowDataTableGroup OBJECT-GROUP 1965 OBJECTS { 1966 -- flowDataIndex, 1967 flowDataStatus, 1968 flowDataSourceInterface, 1969 flowDataSourceAdjacentType, 1970 flowDataSourceAdjacentAddress, flowDataSourceAdjacentMask, 1971 flowDataSourcePeerType, 1972 flowDataSourcePeerAddress, flowDataSourcePeerMask, 1973 flowDataSourceTransType, 1974 flowDataSourceTransAddress, flowDataSourceTransMask, 1975 flowDataDestInterface, 1976 flowDataDestAdjacentType, 1977 flowDataDestAdjacentAddress, flowDataDestAdjacentMask, 1978 flowDataDestPeerType, 1979 flowDataDestPeerAddress, flowDataDestPeerMask, 1980 flowDataDestTransType, 1981 flowDataDestTransAddress, flowDataDestTransMask, 1982 -- flowDataRuleSet, 1983 flowDataToOctets, flowDataToPDUs, 1984 flowDataFromOctets, flowDataFromPDUs, 1985 flowDataFirstTime, flowDataLastActiveTime, 1986 flowDataSourceClass, flowDataDestClass, flowDataClass, 1987 flowDataSourceKind, flowDataDestKind, flowDataKind 1988 } 1989 STATUS current 1990 DESCRIPTION 1991 "The flow table group defines objects which provide the 1992 structure for the rule table, including the creation time 1993 and activity time indexes into it. In addition it defines 1994 objects which provide a base set of flow attributes for the 1995 adjacent, peer and transport layers, together with a flow's 1996 counters and times. Finally it defines a flow's class and 1997 kind attributes, which are set by rule actions." 1998 ::= {flowMIBGroups 2 } 2000 flowDataScaleGroup OBJECT-GROUP 2001 OBJECTS { 2002 flowManagerCounterWrap, 2003 flowDataPDUScale, flowDataOctetScale 2004 } 2005 STATUS deprecated 2006 DESCRIPTION 2007 "The flow scale group defines objects which specify scale 2008 factors for counters." 2009 ::= {flowMIBGroups 3 } 2011 flowDataSubscriberGroup OBJECT-GROUP 2012 OBJECTS { 2013 flowDataSourceSubscriberID, flowDataDestSubscriberID, 2014 flowDataSessionID 2015 } 2016 STATUS current 2017 DESCRIPTION 2018 "The flow subscriber group defines objects which may be used 2019 to identify the end point(s) of a flow." 2020 ::= {flowMIBGroups 4 } 2022 flowDataColumnTableGroup OBJECT-GROUP 2023 OBJECTS { 2024 flowColumnActivityAttribute, 2025 flowColumnActivityIndex, 2026 flowColumnActivityTime, 2027 flowColumnActivityData 2028 } 2029 STATUS deprecated 2030 DESCRIPTION 2031 "The flow column table group defines objects which can be used 2032 to collect part of a column of attribute values from the flow 2033 table." 2034 ::= {flowMIBGroups 5 } 2036 flowDataPackageGroup OBJECT-GROUP 2037 OBJECTS { 2038 -- flowPackageSelector, flowPackageRuleSet, flowPackageIndex, 2039 flowPackageData 2040 } 2041 STATUS current 2042 DESCRIPTION 2043 "The data package group defines objects which can be used 2044 to collect a specified set of attribute values from a row of 2045 the flow table." 2047 ::= {flowMIBGroups 6 } 2049 flowRuleTableGroup OBJECT-GROUP 2050 OBJECTS { 2051 flowRuleSelector, 2052 flowRuleMask, flowRuleMatchedValue, 2053 flowRuleAction, flowRuleParameter 2054 } 2055 STATUS current 2056 DESCRIPTION 2057 "The rule table group defines objects which hold the set(s) 2058 of rules specifying which traffic flows are to be accounted 2059 for." 2060 ::= {flowMIBGroups 7 } 2062 flowDataScaleGroup2 OBJECT-GROUP 2063 OBJECTS { 2064 -- flowManagerCounterWrap, 2065 flowDataPDUScale, flowDataOctetScale 2066 } 2067 STATUS current 2068 DESCRIPTION 2069 "The flow scale group defines objects which specify scale 2070 factors for counters. This group replaces the earlier 2071 version of flowDataScaleGroup above (now deprecated)." 2072 ::= {flowMIBGroups 8} 2074 flowMIBCompliance MODULE-COMPLIANCE 2075 STATUS current 2076 DESCRIPTION 2077 "The compliance statement for a Traffic Flow Meter." 2078 MODULE 2079 MANDATORY-GROUPS { 2080 flowControlGroup, 2081 flowDataTableGroup, 2082 flowDataPackageGroup, 2083 flowRuleTableGroup 2084 } 2085 ::= { flowMIBCompliances 1 } 2087 END 2089 7 Security Considerations 2091 This MIB describes how an RTFM traffic meter is controlled, and provides 2092 a way for traffic flow data to be retrieved from it by a meter reader. 2093 This is essentially an application using SNMP as a method of 2094 communication between co-operating hosts; it does not - in itself - have 2095 any inherent security risks. 2097 Since, however, the traffic flow data can be extremely valuable for 2098 network management purposes it is vital that sensible precautions be 2099 taken to keep the meter and its data secure. This requires that access 2100 to the meter for control purposes (e.g. loading RuleSets and reading 2101 flow data) be restricted. Such restriction could be achieved in many 2102 ways, for example 2104 - Physical Separation. Meter(s) and meter reader(s) could be 2105 deployed so that control capabilities are kept within a separate 2106 network, access to which is carefully controlled. 2108 - Application-layer Security. A minimal level of security for SNMP 2109 is provided by using 'community' strings, which are essentially 2110 clear-text passwords. Stronger security for SNMP is being 2111 developed within the IETF; when this becomes available it should be 2112 used to protect managed network equipment. 2114 - Lower-layer Security. Access to the meter can be protected using 2115 encryption at the network layer. For example, one could run SNMP 2116 to the meter through an encrypted TCP tunnel. 2118 When implementing a meter it may be sensible to use separate network 2119 interfaces for control and for metering. If this is done the control 2120 network can be set up so that it doesn't carry any 'user' traffic, and 2121 the metering interfaces can ignore any user attempts to take control of 2122 the meter. 2124 Users should also consider how they will address attempts to circumvent 2125 a meter, i.e. to prevent it from measuring flows. Such attempts are 2126 essentially denial-of-service attacks on the metering interfaces. For 2127 example 2129 - Port Scan attacks. The attacker sends packets to each of a very 2130 large number of IP (Address : Port) pairs. Each of these packets 2131 creates a new flow in the meter; if there are enough of them the 2132 meter will recognise a 'flood' condition, and will probably stop 2133 creating new flows. As a minimum, users (and implementors) should 2134 ensure that meters can recover from flood conditions as soon as 2135 possible after they occur. 2137 - Counter Wrap attacks: The attacker sends enough packets to cause 2138 the counters in a flow to wrap several times between meter 2139 readings, thus causing the counts to be artificially low. The 2140 change to using 64-bit counters in this MIB reduces this problem 2141 significantly. 2143 Users can reduce the severity of both the above attacks by ensuring that 2144 their meters are read often enough to prevent them being flooded. The 2145 resulting flow data will contain a record of the attacking packets, 2146 which may well be useful in determining where any attack came from. 2148 8 Acknowledgements 2150 An early draft of this document was produced under the auspices of the 2151 IETF's Accounting Working Group with assistance from the SNMP Working 2152 Group and the Security Area Advisory Group. Particular thanks are due 2153 to Jim Barnes, Sig Handelman and Stephen Stibler for their support and 2154 their assistance with checking early versions of the MIB. 2156 Stephen Stibler shared the development workload of producing the MIB 2157 changes summarized in chpter 5 (above). 2159 9 References 2161 [1] McCloghrie, K., and Rose, M., Editors, "Management 2162 Information Base for Network Management of TCP/IP-based 2163 internets," RFC 1213, Performance Systems International, March 2164 1991. 2166 [2] Case J., McCloghrie K., Rose M., and Waldbusser S., 2167 "Structure of Management Information for version 2 of the 2168 Simple Network Managemenet Protocol," RFC 1902, SNMP Research 2169 Inc., Hughes LAN Systems, Dover Beach Consulting, Carnegie 2170 Mellon University, January 1996. 2172 [3] Case J., McCloghrie, K., Rose, M., and Waldbusser, S., 2173 "Textual Conventions for version 2 of the Simple Network 2174 Managemenet Protocol SNMPv2", RFC 1903, SNMP Research Inc., 2175 Hughes LAN Systems, Dover Beach Consulting, Carnegie Mellon 2176 University, January 1996. 2178 [4] Case, J., McCloghrie, K., Rose, M., and Waldbusser, S., 2179 "Conformance Statements for version 2 of the Simple Network 2180 Managemenet Protocol (SNMPv2)," RFC 1904, SNMP Research Inc., 2181 Hughes LAN Systems, Dover Beach Consulting, Carnegie Mellon 2182 University, January 1996. 2184 [5] Case, J., McCloghrie, K., Rose, M., and Waldbusser, S., 2185 "Coexistence between version 1 and version 2 of the 2186 Internet-standard Network Management Framework," RFC 1908, SNMP 2187 Research Inc., Hughes LAN Systems, Dover Beach Consulting, 2188 Carnegie Mellon University, January 1996. 2190 [6] Information processing systems - Open Systems 2191 Interconnection - Specification of Abstract Syntax Notation One 2192 (ASN.1), International Organization for Standardization, 2193 International Standard 8824, December 1987. 2195 [7] Information processing systems - Open Systems 2196 Interconnection - Specification of Basic Encoding Rules for 2197 Abstract Notation One (ASN.1), International Organization for 2198 Standardization, International Standard 8825, December 1987. 2200 [8] Mills, C., Hirsch, G. and Ruth, G., "Internet Accounting 2201 Background," RFC 1272, Bolt Beranek and Newman Inc., Meridian 2202 Technology Corporation, November 1991. 2204 [9] Brownlee, N., Mills, C., and G. Ruth, "Traffic Flow 2205 Measurement: Architecture", RFC 2063, The University of 2206 Auckland, Bolt Beranek and Newman Inc., GTE Laboratories, Inc, 2207 January 1997. 2209 [10] Waldbusser, S., "Remote Network Monitoring Management 2210 Information Base Version 2 using SMIv2," RFC 2021, INS, January 2211 1997. 2213 [11] Reynolds, J., Postel, J., "Assigned Numbers," RFC 1700, 2214 ISI, October 1994. 2216 [12] Case, J., "FDDI Management Information Base," RFC 1285, 2217 SNMP Research Incorporated, January 1992. 2219 [13] Hinden, R., Deering, S., "IP Version 6 Addressing 2220 Architecture," RFC 1884, Ipsilon Networks, Xerox PARC, December 2221 1995. 2223 10 Author's Address 2225 Nevil Brownlee 2226 Information Technology Systems & Services 2227 The University of Auckland 2229 Phone: +64 9 373 7599 x8941 2230 E-mail: n.brownlee@auckland.ac.nz