idnits 2.17.1 draft-ietf-ippm-reporting-mib-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** 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? == There are 9 instances of lines with non-ascii characters in the document. == 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 is 1 instance of too long lines in the document, the longest one being 4 characters in excess of 72. == There are 18 instances of lines with non-RFC2606-compliant FQDNs in the document. == There are 3 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. == There are 1 instance of lines with private range IPv4 addresses in the document. If these are generic example addresses, they should be changed to use any of the ranges defined in RFC 6890 (or successor): 192.0.2.x, 198.51.100.x or 203.0.113.x. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. RFC 2119 keyword, line 3514: '...rk. The measurement parameters MUST be...' RFC 2119 keyword, line 3527: '... methodologies SHOULD include approp...' Miscellaneous warnings: ---------------------------------------------------------------------------- == The "Author's Address" (or "Authors' Addresses") section title is misspelled. == Line 414 has weird spacing: '...results previ...' == Line 893 has weird spacing: '... field octet...' == Line 1138 has weird spacing: '...running the I...' == Line 1476 has weird spacing: '...mOwners objec...' == Line 1774 has weird spacing: '...n order to al...' == (3 more instances...) -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- Couldn't find a document date in the document -- date freshness check skipped. -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: '12' is mentioned on line 123, but not defined == Missing Reference: '18' is mentioned on line 3550, but not defined == Missing Reference: '21' is mentioned on line 3551, but not defined ** Obsolete normative reference: RFC 2571 (ref. '2') (Obsoleted by RFC 3411) ** Downref: Normative reference to an Informational RFC: RFC 1215 (ref. '5') ** Downref: Normative reference to an Historic RFC: RFC 1157 (ref. '9') ** Downref: Normative reference to an Historic RFC: RFC 1901 (ref. '10') ** Obsolete normative reference: RFC 1906 (ref. '11') (Obsoleted by RFC 3417) ** Obsolete normative reference: RFC 2574 (ref. '13') (Obsoleted by RFC 3414) ** Obsolete normative reference: RFC 1905 (ref. '14') (Obsoleted by RFC 3416) ** Obsolete normative reference: RFC 2573 (ref. '15') (Obsoleted by RFC 3413) ** Obsolete normative reference: RFC 2575 (ref. '16') (Obsoleted by RFC 3415) ** Obsolete normative reference: RFC 2570 (ref. '17') (Obsoleted by RFC 3410) Summary: 16 errors (**), 0 flaws (~~), 15 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group E. Stephan/J. Jewitt 3 Internet Draft France Telecom R&D 4 Document: draft-ietf-ippm-reporting-mib-03.txt June, 2003 6 IPPM reporting MIB 8 Status of this Memo 10 This document is an Internet-Draft and is in full conformance with 11 all provisions of Section 10 of RFC2026 [1]. 13 Internet-Drafts are working documents of the Internet Engineering 14 Task Force (IETF), its areas, and its working groups. Note that other 15 groups may also distribute working documents as Internet-Drafts. 16 Internet-Drafts are draft documents valid for a maximum of six months 17 and may be updated, replaced, or made obsolete by other documents at 18 any time. It is inappropriate to use Internet- Drafts as reference 19 material or to cite them other than as "work in progress." 21 The list of current Internet-Drafts can be accessed at 22 http://www.ietf.org/ietf/1id-abstracts.txt. 24 The list of Internet-Draft Shadow Directories can be accessed at 25 http://www.ietf.org/shadow.html. 27 Abstract 29 This memo defines a portion of the Management Information Base (MIB) 30 designed for use with network management protocols in TCP/IP-based 31 internets. 32 In particular, this MIB specifies the objects used for managing the 33 results of the IPPM metrics measures, for pushing alarms, and for 34 reporting the measures results. 36 Table of Contents 38 1. Introduction................................................2 39 2. The IPPM Framework..........................................3 40 3. The SNMP Management Framework...............................3 41 4. Overview....................................................5 42 4.1. Textual Conventions.........................................6 43 4.2 Structure of the MIB.........................................8 44 4.3 Row identification in an application namespace..............10 45 4.4 Relationship of IPPM REPORTING MIB tables...................11 46 5 Measurement architectures...................................12 47 5.1 Proxy architecture..........................................12 48 5.2 Reporting architecture......................................13 49 5.3 Gateway architecture........................................15 50 5.4 Security....................................................15 51 6 Reporting mode integration..................................16 52 6.1 Integration.................................................16 53 6.2 Setup of the measure network................................16 54 6.3 Setup of a measurement report...............................16 55 6.4 Updating the history of the MIB.............................17 56 6.5 Report download and upload..................................17 57 6.6 Default value...............................................17 58 7 Definition..................................................17 59 8 Security Considerations.....................................71 60 8.1 VACM Access control.........................................71 61 8.2 Privacy.....................................................74 62 8.3 Measurement aspects.........................................74 63 8.4 Management aspects..........................................75 64 9 Document management.........................................75 65 9.1 Open issues.................................................76 66 9.2 Changes done since release 02...............................76 67 10 References..................................................77 68 11 Acknowledgments.............................................78 69 12 Authors Addresses...........................................78 71 1. Introduction 72 This memo defines a MIB for managing network measurements based upon 73 the IP performance metrics specified by the IPPM Working Group. 75 The definition of objects in the IPPM MIB are built on notions 76 introduced and discussed in the IPPM Framework document, RFC 2330 77 [ii]. 79 This memo defines a Management Information Base (MIB), and as such it 80 is intended to be respectful of the "Boilerplate for IETF MIBs" 81 defined in http://www.ops.ietf.org/mib-boilerplate.html. 83 There are companion documents to the IPPM-REPORTING-MIB both in the 84 Transport Area (See section 2), and in the Operations and Management 85 Area (See section 3). The reader should be familiar with these 86 documents. 88 2. The IPPM Framework 90 The IPPM Framework consists of 3 major components: 92 A general framework for defining performance metrics, as described in 93 the Framework for IP Performance Metrics, RFC 2330 [2]; 95 A set of standardized metrics which conform to this framework: The 96 IPPM Metrics for Measuring Connectivity, RFC 2678 [iii]; The One-way 97 Delay Metric for IPPM, RFC 2679 [iv]; The One-way Packet Loss Metric 98 for IPPM, RFC 2680 [v]; The Round-trip Delay Metric for IPPM, RFC 99 2681 [vi]. 101 Emerging metrics that are being specified in respect of this 102 framework. 104 3. The SNMP Management Framework 106 The SNMP Management Framework consists of five major components: 108 An overall architecture, described in RFC 2571 [2]. 110 Mechanisms for describing and naming objects and events for the 111 purpose of management. The first version of this Structure of 112 Management Information (SMI) is called SMIv1 and described in STD 16, 113 RFC 1155 [3], STD 16, RFC 1212 [4] and RFC 1215 [5]. The second 114 version, called SMIv2, is described in STD 58, RFC 2578 [6], STD 58, 115 RFC 2579 [7] and STD 58, RFC 2580 [8]. 117 Message protocols for transferring management information. The 118 first version of the SNMP message protocol is called SNMPv1 and 119 described in STD 15, RFC 1157 [9]. A second version of the SNMP 120 message protocol, which is not an Internet standards track protocol, 121 is called SNMPv2c and described in RFC 1901 [10] and RFC 1906 [11]. 122 The third version of the message protocol is called SNMPv3 and 123 described in RFC 1906 [11], RFC 2572 [12] and RFC 2574 [13]. 125 Protocol operations for accessing management information. The 126 first set of protocol operations and associated PDU formats is 127 described in STD 15, RFC 1157 [9]. A second set of protocol 128 operations and associated PDU formats is described in RFC 1905 [14]. 130 A set of fundamental applications described in RFC 2573 [15] and 131 the view-based access control mechanism described in RFC 2575 [16]. 133 A more detailed introduction to the current SNMP Management Framework 134 can be found in RFC 2570 [17]. 136 Managed objects are accessed via a virtual information store, termed 137 the Management Information Base or MIB. Objects in the MIB are 138 defined using the mechanisms defined in the SMI. 140 This memo specifies a MIB module that is compliant to the SMIv2. A 141 MIB conforming to the SMIv1 can be produced through the appropriate 142 translations. The resulting translated MIB must be semantically 143 equivalent, except where objects or events are omitted because no 144 translation is possible (use of Counter64). Some machine readable 145 information in SMIv2 will be converted into textual descriptions in 146 SMIv1 during the translation process. However, this loss of machine 147 readable information is not considered to change the semantics of the 148 MIB. 150 Managed objects are accessed via a virtual information store, termed 151 the Management Information Base or MIB. Objects in the MIB are 152 defined using the subset of Abstract Syntax Notation One (ASN.1) 153 defined in the SMI. In particular, each object type is named by an 154 OBJECT IDENTIFIER, an administratively assigned name. 156 The object type together with an object instance serves to uniquely 157 identify a specific instantiation of the object. For human 158 convenience, we often use a textual string, termed the descriptor, to 159 refer to the object type. 161 4. Overview 163 Although the number of measurement devices that implement IPPM 164 metrics is growing, there is not currently any standardized 165 management interface to manage remotely the measurement of these 166 metrics. This memo defines a Management Information Base for managing 167 the measurement of IPPM metrics. 169 To permit metrics to be referenced by other MIBs and other protocols, 170 the IPPM WG has defined a registry of the current metrics and a 171 framework for the integration of future metrics in the [IPPM metrics 172 registry]. 174 As the specification of new metrics is a continuous process, this 175 memo defines a framework for the integration of the future 176 standardized metrics. 178 The MIB architecture is inspired by the RMON model [xxiii],[xxiv] 179 which specifies the MIB for the monitoring of a single point of 180 measure. The IPPM-REPORTING-MIB differs from this model in that IPPM 181 metrics measurement involves several points of measure and requires 182 common references for time and for measure identification. 184 The IPPM-REPORTING-MIB introduces a framework where each application 185 identifies its measures in an owner namespace. The administrator may 186 grant access to a measure, or set of measures to another owner via 187 view based access control. As a result, one owner may compute 188 aggregated metrics on another owner�s network measures. 190 Different architectures may be used to perform metric measurements, 191 using a control protocol and a test protocol. Different control 192 frameworks are suitable for performing measurements. The memo lists 193 them, while also looking for a way to integrate them with the IPPM- 194 REPORTING-MIB. This section is for informational purposes only, and 195 is intended to help to specify the relationship among the test 196 protocol, the control protocol and the IPPM-REPORTING-MIB. 198 Special care has been taken to provide a reporting mode suitable for 199 control protocols and test protocols. It addresses the need to 200 provide access to results for the applications. Moreover, it may be 201 used to reduce the number of control frameworks. 203 This MIB is intended to handle multiple concurrent sessions by SNMP 204 applications. However, the SNMP requests are not necessarily to be 205 handled explicitly by the measurement devices, but can be sent to 206 middleware performing an aggregation function. This allows for 207 continuous collection of measurements and statistics computation. 209 4.1. Textual Conventions 211 Seven types of data are introduced as textual conventions in this 212 document: IppmOwnerString, TimeUnit,TypeP, TypePaddress, 213 GMTTimeStamp, IppmStandardMetrics and IppmReportDefinition. 215 4.1.1 IppmOwnerString 217 This octet string is used to represent the owners of the various 218 measures and reports in the measurement system. 220 4.1.2 TimeUnit 222 This textual convention is used to indicate a unit of time, ranging 223 from nanosecond, microsecond, millisecond, second, hour, day, week, 224 month, and year. 226 4.1.3 TypeP and TypePaddress 228 Section 13 of the IPPM framework [2] introduces the generic notion of 229 a "packet of type P" because in some contexts the metric's value 230 depends on the type of the packets involved in the metric. In the 231 definition of a metric, the type P will be explicitly defined, 232 partially defined, or left generic. Measurement of metrics defined 233 with generic type P are made specific when performing actual 234 measurements. It is important that one be conscious of the exact type 235 of traffic being measured. 237 The standardization of the management of the IPPM measures relies on 238 the capability to finely and unambiguously configure the type P of 239 the packets, and the parameters of the protocol suites of the type P. 241 RMON2 introduced the concept of protocol identifiers. RFC2895 [xxv] 242 specifies a macro for the definition of protocol identifier. The 243 RFC2896 [xxvi] defines the protocol identifiers for different 244 protocol encapsulation trees. 246 The type P implementation relies on the MACRO PROTOCOL-IDENTIFIER 247 defined for identifying protocol suites in RMON2. It is achieved by 248 defining the TypeP and the TypePaddress as new syntax in SMIv2 249 TEXTUAL-CONVENTION. 251 4.1.3.1 Internet addresses 253 The section 14 of the IPPM framework defines (for the usual case of a 254 unidirectional path through the Internet) the term "Src" and "Dst". 255 "Src" denotes the IP address of the beginning of the path, and "Dst" 256 denotes the IP address of the end. 258 The section 3 of the RMON PI Reference specifies the Protocol 259 Identifier Encoding rules, which consists briefly in a recursive 260 length value format. "Src" and "Dst" are protocol identifier 261 parameters. Their values are encoded in separated fields using the 262 encoding rules of the protocol identifier, but without trailing 263 parameters. 265 The packet encapsulation defined in an instance of TypeP embeds the 266 format of "Src" and "Dst" and their values. The type and value of 267 these addresses depend on the type P of the packet, IP version 4, 268 IPV6, IP in IP... Both participate in the completion of the packet 269 encoding. 271 Examples: 273 RFC2896 defines the protocol identifiers ip and ipip4. Should there 274 be an Internet tunnel end-point of the IP address 192.168.1.1 in the 275 tunnel 128.2.6.7. the TypeP of the source address of the tunnel, Src, 276 is 'ip.ipip4'. The encoding of 'ip.ipip4' using the RFC2895 rules 277 adds a trailer 2.0.0. It means that an instance of this protocol 278 identifier has 2 parameters, which values will be set only when 279 implemented. In the IPPM TypeP context these 2 parameters are 280 provided in Src (or Dst). In the current example the value of Src is 281 "192.168.1.1 128.2.6.7". 283 4.1.4 GMTTimeStamp 285 This textual convention defines the time at which an event occurred. 286 It is very similar to the NTP timestamp format except that it 287 represents the time elapsed since January 1st, 2000 instead of 288 January 1st, 1900. 290 4.1.5 IppmStandardMetrics 292 Each standard metric is identified in the IPPM-METRICS-REGISTRY under 293 the node rfc in a chronological order. This textual convention 294 defines an octet string to permit several metrics to be performed in 295 a single measure. 297 4.1.6 Report definition 299 A report consists of sending, or logging, a subset of results of 300 measurements that have been taken over a period of time. The report 301 consists of actions that are taken on the measurement results. An 302 action is performed either: 304 + For each result 305 + On the results corresponding to a measurement cycle 306 + On the results available at the measurement completion. 308 To preserve the scalability of the whole measurement system, it 309 limits: 311 + The amount of data sent to the applications 312 + The bandwidth consumption for uploading the result 313 + The number of alarms sent to the applications 314 + The amount of data saved in the point of measure 316 The comparison of the measures results in a metric threshold that 317 identifies particular measure values and times that directly impact 318 service availability. 320 The comparison of the duration of repeated events with a duration 321 threshold identifies particular measure values and times that 322 directly affect an SLA. 324 The combination of IPPM metric results, threshold events, and event 325 filtering provides a very efficient mechanism to report results, 326 events, and alarms. 328 A report is described using the TEXTUAL-CONVENTION 329 IppmReportDefinition. The report setup must not dramatically increase 330 the amount of data needed by the control protocol to setup a measure: 332 + A basic report is defined in the object ippmReportSetupDefinition; 333 + More elaborate reports are described using a metric threshold to 334 generate alarms and events. 335 + Pushing of alarms and reports requires a management station 336 address to which the data will be sent. 337 + SLA alarms are described using an events duration threshold. 339 The TEXTUAL-CONVENTION IppmReportDefinition specifies the list of 340 events and actions that are used to create a report. 342 4.2 Structure of the MIB 344 The MIB is arranged as follow: 346 - ippmSystem 348 - ippmOwners 350 - ippmHistory 352 - ippmNetMeasure 354 - ippmAggrMeasure 356 - ippmReport 358 - ippmNotifications 360 4.2.1 The ippmSystem Group 362 This group consists of a set of parameters describing the clock 363 synchronization at a particular point of measure over time, as well 364 as the system clock where the IPPM-REPORTING-MIB agent resides. 366 This group is critical to the implementation of the IPPM MIB. 368 Section 6.3. of the IPPM Framework states that 369 "Those who develop such measurement methodologies should strive to: 370 + Minimize their uncertainties/errors, 371 + Understand and document the sources of uncertainty/error, and 372 + Quantify the amounts of uncertainty/error." 374 The aim of this group is to have these values available to compute 375 reliable statistics. The implementation of this group is mandatory, 376 whether the time synchronization is automatic or not. 378 4.2.2 The ippmOwners Group 380 This group identifies an owner, or group of owners that have access 381 to measurements on a probe. 383 4.2.3 The ippmMeasure Group 385 This group contains all the IPPM metrics that are registered and 386 available for use by the agent. 388 The measurement entity describes in the ippmMetricsTable of the SNMP 389 agent the local implementation of the standardized metrics. All 390 standardized metrics should be displayed in this table, with the 391 ippmMetricCapabilities object defining whether the metric is 392 implemented or not. 394 4.2.4 The ippmHistory Group 396 The results of any given measure are stored in the ippmHistoryTable. 397 The indexing is such that there is an entry in this table for each 398 result of a given measure for a given metric. 400 4.2.5 The ippmNetMeasure Group 402 The control protocol registers a description of the existing network 403 measures in the ippmNetMeasureTable. 405 This group displays the network measures defined by the control 406 protocol. The results are saved in the ippmHistoryTable. 408 ippmNetMeasureTable is a reflection of the configuration of the 409 network measure. 411 4.2.6 The ippmAggrMeasure Group 413 ippmAggrMeasureTable is responsible for the consolidation, or 414 aggregation, of results previously measured and saved in the 415 ippmHistoryTable. The aggregated results are saved in the 416 ippmHistoryTable and may be used for higher aggregated measures. 418 4.2.7 The Report Group 420 This group displays the existing reports of the measures collected. 421 The ippmReportSetupTable is responsible for the configuration of the 422 reports. 423 The reports are saved in the ippmReportTable, or sent directly to the 424 applications. 426 4.2.8 The Notification Group 428 The Notification group specifies a list of valid notifications. They 429 are used to generate alarms,or reports, to the applications. 431 4.3 Row identification in an application namespace 433 The control protocol, or the test protocol, adds rows in the 434 namespace of the corresponding measure. 436 An object instance identifier in an owner namespace is defined as a 437 list of objects in the clause INDEX where the first object type is 438 IppmOwnerString. 440 As the OBJECT IDENTIFIER, which identifies the instance, begins with 441 the owner value, the remaining values of the index fields may be 442 chosen independently from one namespace to another. 444 This allows the user to choose arbitrary values for the remaining 445 fields of the INDEX clause without checking that the values of these 446 fields exists in the MIB tables. This allows the owner to use the 447 same values across MIB implementations. 449 Thus, it avoids polling to determine the next free index. Also, as a 450 consequence, two applications will never find the same free index 451 value. 453 The usage of owner namespace increases the speed of the management 454 operations while reducing bandwidth consumption and CPU load in the 455 agents and applications. 457 Measurements are requested by management applications. An instance of 458 an object managed by a management station is identified by the 459 management station IppmOwnerString and the private index provided by 460 the MS. 462 As the MS manages its private range of indices, it simply chooses one 463 when it wishes to create a new control entry. For the same reason, 464 the setup of a measure on several points of measures consists of 465 simply sending the same copy of the measure setup to the different 466 points of measures involved. 468 4.4 Relationship of IPPM REPORTING MIB tables 470 There is inherently a relationship between various tables in the IPPM 471 REPORTING MIB, and as such, the data integrity must be assured. This 472 relationship is depicted in the following examples. 474 4.4.1 Relationship between the Owners Table and the aggregated 475 measure table 477 The owners table contains the list of "owners" that can create and 478 activate remotely aggregated measures in an IPPM agent or read the 479 existing network measures. 481 It is recommended to make use of "view based access control" in order 482 to restrict access to this table. For example, the master user 483 "administrator" may be given "write" privileges on the 484 ippmOwnersTable, whereas all others are restricted to "read" access. 485 The user "administrator" can then setup the list of other users that 486 have access to measures. 488 There must be at least 1 owner in the owners' table. This owner may 489 be either setup by default by the IPPM agent, or configured as stated 490 above. 492 An owner may have multiple corresponding entries in the network and 493 aggregated measure tables. Each entry in the measure table is 494 associated with one, and only one, entry in the owners' table. That 495 is to say, that a defined measure may NOT have multiple owners. 497 Thus, we have a 1:N relationship between the owners' table and a 498 measure table. 500 4.4.2 Relationship between the Network Measure Table and the 501 Aggregated Measure Table 503 The network measure table is read-only, thus entries in this table 504 must be populated by the agent upon startup. 505 The agent could potentially read a database that contains network 506 measures configured by a 3rd party proprietary management system that 507 directly interacts with the points of measure. However, the "owner" 508 of the measure be defined in the owners table. 510 The aggregated measure table allows for an "owner" to create 511 aggregated measures (such as average, minimum, maximum) on existing 512 measures. An owner may even create aggregated measures on network 513 measures that are owned by other owners. However, it is recommended 514 to use view based access control to grant access of network measures 515 to owners in the system. 517 5 Measurement architectures 519 There are three main measurement architectures. 521 5.1 Proxy architecture 523 . +----+ +----+ 524 . |NMS1| |NMS2| 525 . +----+ +----+ 526 . ^ ^ 527 . | | 528 . +----------+ +----------+ 529 . | | 530 . SNMP or Sibling 531 . | | 532 . v v 533 . +--------------------------+ 534 . | IPPM-REPORTING-MIB agent | 535 . +--------------------------+ 536 . ^ ^ 537 . | | 538 . OWDP-Control 539 . | | 540 . +----------+ +----------+ 541 . | | 542 . v v 543 .+----------------+ +------------------+ 544 .| Packets-Sender |--OWDP-Test-->| Packets-Receiver | 545 .+----------------+ +------------------+ 547 In this architecture, the different NMS�s query the IPPM-REPORTING- 548 MIB agent for measurements. The agent controls whether the NMS is 549 granted access to perform the measure requested. Each NMS accesses 550 the results of its measurements in the IPPM-REPORTING-MIB statistics 551 table. 553 The measurement setup/teardown and the data collection are done using 554 the control protocol and the test protocol. 556 In this mode the NMS does not depend on the control protocol nor on 557 the test protocol. The entities involved in the measurement do not 558 need to implement the IPPM-REPORTING-MIB nor SNMP. This mode allows 559 for lightweight implementation in the point of measure, and also for 560 heterogeneous control protocols to coexist. 562 Finally, the proxy is a checkpoint where measurement activity may be 563 logged, and where access to measurement setups may be tightly 564 controlled. Thus, it provides a reliable architecture to manage the 565 security of a measurement system. 567 5.2 Reporting architecture 569 In this architecture the SNMP protocol is only used to read the 570 results of the measurements in the IPPM-REPORTING-MIB History Table, 571 and also to inform the NMS that an event has occurred. 573 . +----+ +----+ 574 . |NMS1| |NMS2| 575 . +----+ +----+ 576 . ^ ^ ^ ^ 577 . | | | | 578 . SNMP| SNMP| 579 . | | | | 580 . | | | | 581 . | OWDP | OWDP 582 . |Control |Control 583 . | | | | 584 . | | +------------------------------+ 585 . | | | | | 586 . | | +--|---------------------------+ | 587 . | | | | | | 588 . | +--|--|------------------------+ | | 589 . | | | | | | | 590 . +--------+---------------------+ | | 591 . | | | | | | | | 592 . | | | | | | | | 593 . v v v v v v v v 594 . +------------------+ +------------------+ 595 . |IPPM-REPORTING-MIB| |IPPM-REPORTING-MIB| 596 . | agent | | agent | 597 . +------------------+ +------------------+ 598 . | Packets-Sender |--OWDP-Test-->| Packets-Receiver | 599 . +------------------+ +------------------+ 601 The activation of a measure by the control protocol or the test 602 protocol creates a measure in the IPPM-REPORTING-MIB Network Measure 603 table. The table in question may be not accessible by SNMP. In this 604 case, a list of the measure identifiers (owner, index) is handled by 605 the measurement software. 607 Each timestamped result of the measure is logged in the IPPM- 608 REPORTING-MIB History table in order to allow read access to the 609 NMS�s and event handling. 611 On completion, the measurement results are managed according to the 612 measure setup: 613 + The results may be sent to an NMS; 614 + They may be dropped from the IPPM-REPORTING-MIB History table. 616 In this mode, it is recommended to use an SNMPv2 Inform PDU to send 617 reporting events because it ensures that the entire block of the 618 result is received. There is no control using SNMP Trap PDU. 620 5.3 Gateway architecture 622 The gateway architecture combines the proxy mode and the reporting 623 mode. 625 . +-------+ +------+ 626 . | NMS1 | | NMS2 | 627 . +-------+ +------+ 628 . ^ ^ 629 . | | 630 . SNMP SNMP 631 . | | 632 . | +----------------------------------------+ 633 . | | | 634 . +-------------+ +------------------+ 635 . | | | | | 636 . +----------------------------------------+ | 637 . | | | | | | 638 . | | v v | | 639 . | | +------------------------+ | | 640 . | | | IPPM-REPORTING-MIB | | | 641 . | | | Gateway | | | 642 . | | +------------------------+ | | 643 . | | | control server | | | 644 . | | +------------------------+ | | 645 . | | ^ ^ | | 646 . | | | | | | 647 . | | OWDP-Control protocol | | 648 . | | | | | | 649 . | | +-----+ +-------+ | | 650 . | | | | | | 651 . v v v v v v 652 . +-------------+---------+ +--------+-------------+ 653 . | IPPM- | Packets | |Packets | IPPM | 654 . |REPORTING-MIB| Sender | |Receiver|REPORTING-MIB| 655 . | agent | |-OWDP-Test->| | agent | 656 . +-------------+---------+ +--------+-------------+ 658 The NMS measurement queries are registered in the IPPM-REPORTING-MIB 659 gateway and performed by the control and the test protocol. The NMS 660 directly consults the result in the corresponding IPPM REPORTING MIB 661 agent of the points of measure. 663 5.4 Security 665 The proxy mode provides flexibility and control of the access to the 666 points of measure, while allowing lightweight control protocol and 667 test protocol implementations in the points of measure. Different 668 security rules may be applied to the NMS domain and to measurement 669 system domains. 671 The reporting mode has 2 security domains: 673 + The control of the measurement setups relies on the control 674 and the test protocol security mechanisms; 675 + The control of access to the results depends on the SNMP 676 security mechanisms such as community strings, but may also be 677 restricted using VACM for customized access. 679 The gateway mode security relies on the security of the proxy mode 680 and of the reporting mode. 682 6 Reporting mode integration 684 The IPPM-REPORTING-MIB standardizes the parameters that: 686 + Define the configuration of the IPPM metrics measures; 687 + Define the format of the results of the measure; 688 + Define the report of the IPPM metric measures results. 690 It introduces the concept of owner namespace to allow for fast 691 configuration and reporting across multiple points of measurement. 693 A measure is a distributed object describing a task to be performed 694 by the control and the test protocols. A measure is identified by its 695 owner and its owner index. This identifier is the same in all the 696 points of measure. As the owner chooses the index, there is no need 697 for negotiation between the NMS and the points of measure before 698 activating the measure. 700 A measure is primarily defined by its identifier, the metrics to 701 measure, the description of the end point addresses and the 702 description of the scheduling of the measure. 704 The description of the measure is distributed to the points of 705 measure involved. The distribution may not be synchronized. 707 6.1 Integration 709 The integration of the IPPM-REPORTING-MIB, and the test and control 710 protocols consists in pushing the network measure setup/teardown 711 parameters and the result values from the measurement software to the 712 IPPM-REPORTING-MIB agent. 714 6.2 Setup of the measure network 716 The measurement system updates the MIB on creation of a network 717 measure. 719 6.3 Setup of a measurement report 720 A measurement report setup describes events and data to include in 721 the report. A report is read by an NMS in the ippmReportTable, or 722 pushed to a NMS using a SNMP Inform PDU, an email, or a SMS. 724 Different types of reports may be combined: 726 + A trivial report defines the results to be saved in the 727 ippmReportTable; 728 + A basic report defines the host to which the results are pushed 729 on completion of the measure; 730 + An alarm report defines a threshold on the results of the 731 measure. A message is sent to a host when the result rises above, 732 or falls below the threshold; 733 + An SLA report defines a threshold on the results of the 734 measure. The report consists of the results of the measure (time 735 and value) of the filtered events. The reports are sent at each 736 measurement cycle, or when the measure completes. 738 6.4 Updating the history of the MIB 740 Results have to be written by the measurement task in the agent 741 implementing the IPPM REPORTING MIB. 743 Adding the results of a measurement consists in the transfer of the 744 result from the measurement software to the SNMP agent. The protocol 745 that provides the result may be the control protocol, or the test 746 protocol. 748 6.5 Report download and upload 750 A report is read in the ippmReportTable using SNMP, or pushed by the 751 IPPM_MIB agent using a SNMP Inform PDU, an email or a SMS. 753 6.6 Default value 755 The default values correspond to IP version 4. 757 7 Definition 759 IPPM-REPORTING-MIB DEFINITIONS ::= BEGIN 761 IMPORTS 762 MODULE-IDENTITY, 763 NOTIFICATION-TYPE, 764 OBJECT-TYPE, 765 experimental ,Integer32 766 FROM SNMPv2-SMI 767 -- 768 -- ippm 769 -- FROM IPPM-REGISTRY 770 -- 771 InetAddressType, 772 InetAddress 773 FROM INET-ADDRESS-MIB 774 SnmpAdminString 775 FROM SNMP-FRAMEWORK-MIB 776 RowStatus, 777 StorageType, 778 TEXTUAL-CONVENTION 779 FROM SNMPv2-TC 780 MODULE-COMPLIANCE, 781 OBJECT-GROUP, 782 NOTIFICATION-GROUP 783 FROM SNMPv2-CONF; 785 ippmReportingMib MODULE-IDENTITY 786 LAST-UPDATED "200306291200Z" -- June, 2003 787 ORGANIZATION "France Telecom - R&D" 788 CONTACT-INFO 789 "Emile Stephan 790 France Telecom - R&D 791 2, Avenue Pierre Marzin 792 Technopole Anticipa 793 22307 Lannion Cedex 794 FRANCE 795 Tel: + 33 2 96 05 36 10 796 E-mail: emile.stephan@francetelecom.com 798 Jessie Jewitt 799 France Telecom - R&D 800 801 Gateway Blvd. Suit 500 801 South San Francisco, CA 94080 802 Tel : 1 650 875-1524 803 E-mail : jessie.jewitt@rd.francetelecom.com" 805 DESCRIPTION 806 " This memo defines a portion of the Management Information Base 807 (MIB) for use with network management protocols in TCP/IP-based 808 internets. In particular, it specifies the objects used for 809 managing the results of the IPPM metrics measurements, alarms and 810 reporting of measurement results." 812 REVISION "200210181200Z" -- 18 October 2002 813 DESCRIPTION 814 "General cleanup 815 Change 5 tables to read write" 817 REVISION "200302141200Z" -- 14 February 2003 818 DESCRIPTION 819 "Modifications based upon feedback from IETF-55" 821 REVISION "200306291200Z" -- 29 June 2003 822 DESCRIPTION 823 "Adaptation to VACM, preparation of the final version" 825 ::= { experimental 10001 } 827 ippm OBJECT IDENTIFIER ::= { experimental 10000 } 829 -- 830 -- TEXTUAL-CONVENTION 831 -- 833 IppmOwnerString ::= TEXTUAL-CONVENTION 834 STATUS current 835 DESCRIPTION 836 "An OwnerString, which length is limited to 32." 837 SYNTAX OCTET STRING (SIZE (0..32)) 839 TimeUnit ::= TEXTUAL-CONVENTION 840 STATUS current 841 DESCRIPTION 842 "A enumerated list of time units." 843 SYNTAX INTEGER { 844 year(1), 845 month(2), 846 week(3), 847 day(4), 848 hour(5), 849 second(6), 850 millisecond(7), 851 microsecond(8), 852 nanosecond(9) 853 } 854 -- 855 -- 857 IppmStandardMetrics ::= TEXTUAL-CONVENTION 858 STATUS current 859 DESCRIPTION 860 " Each standard metric is identified in the IPPM-METRICS- 861 REGISTRY under the node rfc in chronological order. In order to 862 allow for 863 several metrics to be calculated in a single measure, there is an 864 need 865 to describe in a bit string the metrics to be measured. 866 This textual convention defines an octet string that gathers in a 867 bit string a sequence of bits. The bit order corresponds to the 868 order 869 of the metric identifiers in the registry. 870 The first bit of the string has the index 0. The index 1 871 corresponds to the first metric of the registry 872 (instantaneousUnidirectionalConnectivity ). 874 Example: 875 One-way-Delay(6) is identified as the leaf number 6 of the node 876 rfc of the 877 registry. One-way-Packet-Loss(12) is identified as the leaf 878 number 12 of the node 879 rfc of the registry. A network measure performing both One-way- 880 Delay(6) and One- 881 way-Packet-Loss(12) will be described as '0001000001000000'b, 882 '1040'B. 883 " 884 SYNTAX OCTET STRING 886 GMTTimeStamp ::= TEXTUAL-CONVENTION 887 STATUS current 888 DESCRIPTION 889 "The value at which a specific occurrence happened. The specific 890 occurrence must be defined in the description of any object 891 defined using this type. 893 field octets contents range 894 ----- ------ -------- ----- 895 1 1-4 second since 1 Jan 2000 0H00* 0..2^31 - 1 896 2 5-8 fractional part of the second* 0..2^32 - 1 897 * the value is in network-byte order 899 The timestamp format is directly inspired from the NTP timestamp 900 format. 901 It differs because it counts the second since 1 Jan 2000 0H00 902 instead of 1 Jan 1900 0H00. The most significant bit of the part 903 that represents the second is reserved. It will wrap in year 2068 904 (The NTP timestamp will wrap in year 2036). 906 This bit is set to indicate if the fractional part of the second 907 contains a precision field and a synchronization field as 908 initially proposed in the OWAMP draft. 910 When this bit is not set the resolution is maximal. 912 The maximal resolution is close to 250 picoseconds. 914 The precision of the timestamp must be provided in another field. 915 " 916 SYNTAX OCTET STRING (SIZE (8)) 918 TypeP ::= TEXTUAL-CONVENTION 919 STATUS current 920 DESCRIPTION 921 "This textual convention is a display string used to describe the 922 protocol encapsulation list of a packet, and is used as the value 923 of the SYNTAX clause for the type of the Src and Dst of an IPPM 924 measure. The RFC2895 specifies a macro named PROTOCOL-IDENTIFIER 925 for the definition of protocol identifiers, while its companion 926 document, the RFC2896 defines a set of protocol identifiers. 928 TypeP is defined as a display string. It consists of a list of 929 dot separated protocol names. Each protocol name has been 930 previously defined using the macro PROTOCOL-IDENTIFIER of the RFC 931 2895. 933 Examples: 934 The RFC2896 defines the protocol identifiers 'ether2', 'ip', 935 'ipip4', 'udp', 'tcp', 'telnet'... 937 The TypeP of the source address corresponding to telnet is the 938 string 'ip.tcp.telnet'. 940 The TypeP of the source address corresponding to UDP packets sent 941 in an IP tunnel is the string 'ip.ipip4.udp'. 943 Note: 944 An IPPM measure is active, so generally a TypeP value does not 945 describe the link layer (i.e. ether2...). Valid Internet packets 946 are sent from Src to Dst. Then the choice of the link layer 947 relies on the Internet stack." 948 SYNTAX OCTET STRING (SIZE (0..512)) 950 TypePaddress ::= TEXTUAL-CONVENTION 951 DISPLAY-HINT "255a" 952 STATUS current 953 DESCRIPTION 954 "This textual convention is a Display string used to describe the 955 parameters of the protocol encapsulation list of a packet, 956 basically the address. 958 TypePaddress is defined as a display string. It consists in a 959 list of space separated parameter list. Each parameter in the 960 list corresponds to a parameter of a PROTOCOL-IDENTIFIER of the 961 TypeP. 962 Example: 963 The TypeP 'ip.ipip4' has 2 parameters. A valid TypePaddress value 964 is '192.168.1.1 128.2.6.7'." 965 SYNTAX OCTET STRING (SIZE (0..512)) 967 IppmReportDefinition ::= TEXTUAL-CONVENTION 968 STATUS current 969 DESCRIPTION 970 " A report definition is a list of statements describing a report. A 971 statement is part of this process if its bit in the definition is set 972 to '1'. For all bit values that are set to one, a report will be 973 generated. 975 The report process uses results saved in the history table. Threshold 976 values are provided by the report setup. 978 Given that not all results from a metric measurement are 979 pertinent to a particular report, and that the size of the report 980 must be limited whenever possible, the guidelines for the definition 981 of a report are as follows: 983 + Select the events for consideration (1); 984 + Configure filters to select pertinent values (2); 985 + Describe the way the report is delivered (3); 986 + Describe clean up actions to perform on report completion (4); 988 -1- events 990 Events determine when a report is processed. Events are 991 exclusive. The possible values are: 993 onSingleton: 994 The report is processed each time a new result of the measurement 995 occurs. 997 onMeasureCycle: 998 The report is processed each time a cycle of measure is 999 completed. 1001 onMeasureCompletion: 1002 The report is processed at the end of the measurement. 1004 -2- filters 1005 Filters determine if a result belongs to a report. 1006 ReportInBandResults and ReportOutBandResults are exclusive. The 1007 usage of ReportInBandResults and ReportOutBandResults exclude the 1008 usage of ReportAboveResults and ReportBelowResults. 1009 Possible values are: 1011 reportUpAndDownResults: 1012 Report contiguous results that are on opposite sides of 1013 the up and down metric threshold. 1015 ReportInBandResults: 1017 Report results lower than the high metric threshold 1018 field of the report setup and greater than the low 1019 metric threshold field of the report setup. 1021 ReportOutBandResults: 1022 Report results greater than the high metric threshold 1023 field of the report setup and lower than the low metric 1024 threshold field of the report setup. 1026 ReportAboveResults: 1027 Report results greater than the high metric threshold 1028 field of the report setup. 1030 ReportBelowResults: 1031 Report results lower than the low metric threshold field 1032 of the report setup. 1034 reportExceededEventsDuration: 1035 Save the results of the metric only if the current 1036 filter triggers repeatedly for a series of contiguous 1037 results during more than 1038 ippmReportSetupDurationThreshold seconds. 1040 -3- deliver 1042 Even though report delivery statements are not exclusive, care 1043 should be taken to limit the number of report methods to 2. The 1044 delivery methods are: 1046 inIppmReportTable: 1047 Store the report in the local ippmReportTable. 1048 NOTE WELL: Results are not stored in the report table if 1049 this flag is not set. 1051 inSNMPv2TrapPDU: 1052 Send the report using a SNMPv2-Trap-PDU. 1054 inInformRequestPDU: 1055 Send the report using a SNMP InformRequest-PDU. 1057 inEmail: 1058 Send the report using an email. 1060 inSMS: 1061 Send the report using a SMS. 1063 -4- Cleanup 1064 onReportDeliveryClearReport(12): 1066 Remove all the results corresponding to this measure 1067 from the ippmReportTable when the report has been 1068 delivered. 1070 " 1071 SYNTAX BITS { 1072 none(0), -- reserved 1073 onSingleton(1), 1074 onMeasureCycle(2), 1075 onMeasureCompletion(3), 1076 reportUpAndDownResults(4), 1077 reportInBandResults(5), 1078 reportOutBandResults(6), 1079 reportAboveResults(7), 1080 reportBelowResults(8), 1081 reportExceededEventsDuration(9), 1082 inIppmReportTable(10), 1083 inSNMPv2TrapPDU(11), 1084 inInformRequestPDU(12), 1085 inEmail(13), 1086 inSMS(14), 1087 onReportDeliveryClearReport(15) 1088 } 1090 -- 1091 -- IPPM Notifications 1092 -- 1093 ippmNotifications OBJECT IDENTIFIER ::= { ippm 0 } 1095 -- 1096 -- IPPM Conformance 1097 -- 1098 ippmConformance OBJECT IDENTIFIER ::= { ippm 1 } 1100 -- 1101 -- IPPM Mib objects definitions 1102 -- 1104 ippmSystem OBJECT IDENTIFIER ::= { ippmReportingMib 1 } 1105 ippmOwners OBJECT IDENTIFIER ::= { ippmReportingMib 2 } 1106 ippmHistory OBJECT IDENTIFIER ::= { ippmReportingMib 3 } 1107 ippmMeasure OBJECT IDENTIFIER ::= { ippmReportingMib 4 } 1108 ippmReport OBJECT IDENTIFIER ::= { ippmReportingMib 5 } 1110 -- 1111 -- ippmSystem Group 1112 -- 1113 -- 1114 ippmSystemTime OBJECT-TYPE 1115 SYNTAX GMTTimeStamp 1116 MAX-ACCESS read-only 1117 STATUS current 1118 DESCRIPTION 1119 "The current time of the system running the IPPM REPORTING MIB 1120 SNMP agent. 1121 When the agent is running in proxy mode is it the current time of the 1122 proxy agent. 1123 When the agent is located in the probe, it is the current time 1124 of the probe agent. " 1125 ::= { ippmSystem 1 } 1127 ippmSystemSynchronizationType OBJECT-TYPE 1128 SYNTAX INTEGER { 1129 other(0), 1130 ntp(1), 1131 gps(2), 1132 cdma(3) 1133 } 1134 MAX-ACCESS read-only 1135 STATUS current 1136 DESCRIPTION 1137 "ippmSystemSynchronizationType describes the mechanism 1138 used to synchronize the system running the IPPM REPORTING MIB 1139 SNMP agent. 1141 Other(0) 1142 The synchronization process must be defined 1143 in the ippmSystemSynchonizationDescription. 1145 Ntp(1) 1146 The system is synchronized using the network 1147 time protocol. The NTP synchronization must be described 1148 in the ippmSystemSynchonizationDescription. 1150 Gps(2) 1151 The system is synchronized using the GPS clocks. 1153 Cdma(3) 1154 The system is synchronized using the CDMA clocks." 1155 ::= { ippmSystem 2 } 1157 ippmSystemSynchronizationDesc OBJECT-TYPE 1158 SYNTAX SnmpAdminString 1159 MAX-ACCESS read-only 1160 STATUS current 1161 DESCRIPTION 1162 "The description of the synchronization process of the system 1163 running the IPPM REPORTING MIB SNMP agent." 1165 ::= { ippmSystem 3 } 1167 ippmSystemClockResolution OBJECT-TYPE 1168 SYNTAX Integer32 1169 MAX-ACCESS read-only 1170 -- UNITS "picoseconds" 1171 STATUS current 1172 DESCRIPTION 1173 "ippmSystemClockResolution provides the precision of the clock 1174 used for the measures . The unit is the picosecond. For example, 1175 the clock on an old Unix host might advance only once every 10 1176 msec, and thus have a resolution of 10 msec. So its resolution is 1177 100000 picosecond and the value of ippmSystemClockResolution is 1178 100000." 1179 ::= { ippmSystem 4 } 1181 ippmSystemOperationalStatus OBJECT-TYPE 1182 SYNTAX INTEGER { 1183 unknown(0), 1184 up(1), 1185 down(2) 1186 } 1187 MAX-ACCESS read-only 1188 STATUS current 1189 DESCRIPTION 1190 "This object describes the status of the system running the IPPM 1191 REPORTING MIB SNMP agent. It does not describe end points measurement 1192 status. 1193 unknown(0) 1194 up(1) means service is operational and available for general use. 1195 down(2) means the proxy is not available for use. 1196 " 1197 ::= { ippmSystem 5 } 1199 ippmSynchronizationTable OBJECT-TYPE 1200 SYNTAX SEQUENCE OF IppmSynchronizationEntry 1201 MAX-ACCESS not-accessible 1202 STATUS current 1203 DESCRIPTION 1204 "This table registers the event related to the synchronization of 1205 the points of measure. Each event is described in an 1206 ippmSynchronizationEntry. 1207 ippmSynchronizationTable is mandatory. 1208 ippmSynchronizationTable content is read only." 1209 ::= { ippmSystem 6 } 1211 ippmSynchronizationEntry OBJECT-TYPE 1212 SYNTAX IppmSynchronizationEntry 1213 MAX-ACCESS not-accessible 1214 STATUS current 1215 DESCRIPTION 1216 "An entry describes a modification of the synchronization status. 1217 " 1218 INDEX { ippmPointOfMeasureIndex, ippmSynchronizationIndex } 1219 ::= { ippmSynchronizationTable 1 } 1221 IppmSynchronizationEntry ::= 1222 SEQUENCE { 1223 ippmSynchronizationIndex Integer32, 1224 ippmSynchronizationTime GMTTimeStamp, 1225 ippmSynchronizationStratum Integer32, 1226 ippmSynchronizationResolution Integer32 1227 } 1229 ippmSynchronizationIndexOBJECT-TYPE 1230 SYNTAX Integer32 (1 .. 65535) 1231 MAX-ACCESS not-accessible 1232 STATUS current 1233 DESCRIPTION 1234 "An index that identifies the synchronization events in 1235 chronological order." 1236 ::= { ippmSynchronizationEntry 1 } 1238 ippmSynchronizationTime OBJECT-TYPE 1239 SYNTAX GMTTimeStamp 1241 MAX-ACCESS read-only 1242 STATUS current 1243 DESCRIPTION 1244 "The time when the synchronization event occurs." 1245 ::= { ippmSynchronizationEntry 2 } 1247 ippmSynchronizationStratum OBJECT-TYPE 1248 SYNTAX Integer32 1249 MAX-ACCESS read-only 1250 STATUS current 1251 DESCRIPTION 1252 "The stratum level of the clock computed when the synchronization 1253 event occurs." 1254 ::= { ippmSynchronizationEntry 3 } 1256 ippmSynchronizationResolution OBJECT-TYPE 1257 SYNTAX Integer32 1258 UNITS "NanoSeconds" 1259 MAX-ACCESS read-only 1260 STATUS current 1261 DESCRIPTION 1262 "The new time resolution computed after the synchronization event 1263 occurred." 1264 ::= { ippmSynchronizationEntry 4 } 1266 ippmPointOfMeasureTable OBJECT-TYPE 1267 SYNTAX SEQUENCE OF IppmPointOfMeasureEntry 1268 MAX-ACCESS not-accessible 1269 STATUS current 1270 DESCRIPTION 1271 " This table is the list of measurement end points available in 1272 the measurement system. 1274 Proxy mode: 1275 It is the list of the measurement end points of the set of probes 1276 for which the IPPM proxy provides an SNMP interface. 1278 IPPM MIB implemented in a probe: 1279 It is the list of the measurement end points of the probe. 1281 The ippmPointOfMeasureTable content is read only. This implies 1282 that the measurement software handles the table internally 1284 ippmPointOfMeasureTable is mandatory." 1285 ::= { ippmSystem 7 } 1287 ippmPointOfMeasureEntry OBJECT-TYPE 1288 SYNTAX IppmPointOfMeasureEntry 1289 MAX-ACCESS not-accessible 1290 STATUS current 1291 DESCRIPTION 1292 " An entry may be the management address of a middleware in 1293 charge of the management of a set of probes. It may the 1294 management address of a probe that contains several line cards. 1296 An entry describes the capability of a point of measure. The 1297 description may make the use of wildcards to define multiple 1298 capabilities." 1299 INDEX { ippmPointOfMeasureIndex } 1300 ::= { ippmPointOfMeasureTable 1 } 1302 IppmPointOfMeasureEntry ::= SEQUENCE { 1303 ippmPointOfMeasureIndex Integer32, 1304 ippmPointOfMeasureMgmtAddrType InetAddressType, 1305 ippmPointOfMeasureMgmtAddress InetAddress, 1306 ippmPointOfMeasureTypePAddress TypeP, 1307 ippmPointOfMeasureAddress InetAddress, 1308 ippmPointOfMeasureMetrics IppmStandardMetrics 1309 } 1310 ippmPointOfMeasureIndex OBJECT-TYPE 1311 SYNTAX Integer32 (1 .. 65535) 1312 MAX-ACCESS not-accessible 1313 STATUS current 1314 DESCRIPTION 1315 "A local index that identifies an entry of the points of measures 1316 table." 1317 ::= { ippmPointOfMeasureEntry 1 } 1319 ippmPointOfMeasureMgmtAddrType OBJECT-TYPE 1320 SYNTAX InetAddressType 1321 MAX-ACCESS read-only 1322 STATUS current 1323 DESCRIPTION 1324 "The address type associated with the management address." 1325 ::= { ippmPointOfMeasureEntry 2 } 1327 ippmPointOfMeasureMgmtAddress OBJECT-TYPE 1328 SYNTAX InetAddress (SIZE (1..128)) 1329 MAX-ACCESS read-only 1330 STATUS current 1331 DESCRIPTION 1332 "The management address on the point of measure" 1333 ::= { ippmPointOfMeasureEntry 3 } 1335 ippmPointOfMeasureTypePAddress OBJECT-TYPE 1336 SYNTAX TypeP 1337 MAX-ACCESS read-only 1338 STATUS current 1339 DESCRIPTION 1340 "Defines the type P address of the point of measure." 1341 DEFVAL { "ip" } 1342 ::= { ippmPointOfMeasureEntry 4 } 1344 ippmPointOfMeasureAddress OBJECT-TYPE 1345 SYNTAX InetAddress 1346 MAX-ACCESS read-only 1347 STATUS current 1348 DESCRIPTION 1349 "Specifies the address of the point of measure. 1351 It is represented as an octet string with specific semantics and 1352 length as identified by the ippmPointOfMeasureTypePAddress. 1354 For example, if the ippmPointOfMeasureTypePAddress indicates an 1355 encapsulation of 'ip', this object length is 4, followed by the 4 1356 octets of the IP address, in network byte order." 1358 ::= { ippmPointOfMeasureEntry 5} 1360 ippmPointOfMeasureMetrics OBJECT-TYPE 1361 SYNTAX IppmStandardMetrics 1362 MAX-ACCESS read-only 1363 STATUS current 1364 DESCRIPTION 1365 "Metrics supported by this point of measure." 1366 ::= { ippmPointOfMeasureEntry 6 } 1368 ippmMetricTable OBJECT-TYPE 1369 SYNTAX SEQUENCE OF IppmMetricEntry 1370 MAX-ACCESS not-accessible 1371 STATUS current 1372 DESCRIPTION 1373 "This table is mandatory. It describes the current 1374 implementation. Each IPPM standardized metric must be described 1375 in the table. 1376 ippmMetricTable content is read only." 1377 ::= { ippmSystem 8 } 1379 ippmMetricEntry OBJECT-TYPE 1380 SYNTAX IppmMetricEntry 1381 MAX-ACCESS not-accessible 1382 STATUS current 1383 DESCRIPTION 1384 "An entry describes the static capabilities of a metric 1385 implementation." 1386 INDEX { ippmMetricIndex } 1387 ::= { ippmMetricTable 1 } 1389 IppmMetricEntry ::= 1390 SEQUENCE { 1391 ippmMetricIndex Integer32, 1392 ippmMetricCapabilities INTEGER, 1393 ippmMetricType INTEGER, 1394 ippmMetricUnit INTEGER, 1395 ippmMetricDescription SnmpAdminString 1396 } 1398 ippmMetricIndex OBJECT-TYPE 1399 SYNTAX Integer32 (1.. 65535) 1400 MAX-ACCESS not-accessible 1401 STATUS current 1402 DESCRIPTION 1403 "ippmMetricIndex defines an unambiguous index for each 1404 standardized metric. It identifies a metric. Its value is the 1405 value of the node of the metric in an IPPM registry. This value 1406 is the same in any implementation of the IPPM REPORTING MIB. 1408 Example: 1409 In the IPPM-METRICS-REGISTRY, onewayPacketLossAverage is 1410 registered as the node 14 of ippmMetricsRegistry.metrics.rfc. 1411 Consequently the index of the metric onewayPacketLossAverage in 1412 the IppmMetricTable will always be '14'" 1413 ::= { ippmMetricEntry 1 } 1415 ippmMetricCapabilities OBJECT-TYPE 1416 SYNTAX INTEGER { 1417 notImplemented(0), 1418 implemented(1) 1419 } 1420 MAX-ACCESS read-only 1421 STATUS current 1422 DESCRIPTION 1423 "A value of notImplemented implies the metric is not implemented. 1424 A value of implemented implies the metric is implemented either 1425 in the proxy or the point of measure itself. 1426 Example: if the aggregated metric is not implemented in the point 1427 of measure it may be implemented in the proxy." 1428 DEFVAL { implemented } 1429 ::= { ippmMetricEntry 2 } 1431 ippmMetricType OBJECT-TYPE 1432 SYNTAX INTEGER { 1433 network(0), 1434 aggregated(1) 1435 } 1436 MAX-ACCESS read-only 1437 STATUS current 1438 DESCRIPTION 1439 "Indicates the metric type, whether it is network or aggregated" 1440 DEFVAL { aggregated } 1441 ::= { ippmMetricEntry 3 } 1443 ippmMetricUnit OBJECT-TYPE 1444 SYNTAX INTEGER { 1445 noUnit(0), 1446 second(1), 1447 millisecond(2), 1448 microsecond(3), 1449 nanosecond(4), 1450 percentage(5), 1451 packet(6), 1452 byte(7), 1453 kilobyte(8), 1454 megabyte(9) 1455 } 1456 MAX-ACCESS read-only 1457 STATUS current 1458 DESCRIPTION 1459 "The unit used in the current entity for the results of the 1460 measurement of this metric." 1461 ::= { ippmMetricEntry 4 } 1463 ippmMetricDescription OBJECT-TYPE 1464 SYNTAX SnmpAdminString 1465 MAX-ACCESS read-only 1466 STATUS current 1467 DESCRIPTION 1468 "A textual description of the metric implementation following the exact 1469 name of this metric in the registry. For example: 1470 oneWayDelay: text ." 1471 ::= { ippmMetricEntry 5 } 1473 -- 1474 -- ippmOwners Group 1475 -- 1476 -- The ippmOwners objects are responsible for managing 1477 -- the owners access to the measurements. 1478 -- 1479 -- 1480 ippmOwnersTable OBJECT-TYPE 1481 SYNTAX SEQUENCE OF IppmOwnersEntry 1482 MAX-ACCESS not-accessible 1483 STATUS current 1484 DESCRIPTION 1485 "A management entity wishing to create and activate remote Ippm 1486 measurements in an agent must previously be registered in the 1487 ippmOwnersTable. 1488 ippmOwnersTable content is read-create. It contains at least the 1489 owner 'monitor'. �� 1490 ::= { ippmOwners 1 } 1492 ippmOwnersEntry OBJECT-TYPE 1493 SYNTAX IppmOwnersEntry 1494 MAX-ACCESS not-accessible 1495 STATUS current 1496 DESCRIPTION 1497 "The description of the resources granted to an SNMP application. 1499 For example, an instance of ippmOwnersOwner with an 1500 IppmOwnerString 'acme', which represents the 14th owner created 1501 in ippmOwnersTable would be named ippmOwnersEntryOwner.14. 1503 Notes: 1505 The ippmOwnersIndex value is a local index managed directly by 1506 the agent. The management application must poll to get the next 1507 available index value. 1508 It is not used in anyway in other IPPM tables." 1509 INDEX { ippmOwnersIndex } 1510 ::= { ippmOwnersTable 1 } 1512 IppmOwnersEntry ::= SEQUENCE { 1513 ippmOwnersIndex Integer32, 1514 ippmOwnersOwner IppmOwnerString, 1515 ippmOwnersGrantedMetrics IppmStandardMetrics, 1516 ippmOwnersQuota Integer32, 1517 ippmOwnersIpAddressType InetAddressType, 1518 ippmOwnersIpAddress InetAddress, 1519 ippmOwnersEmail SnmpAdminString, 1520 ippmOwnersSMS SnmpAdminString, 1521 ippmOwnersStatus RowStatus 1522 } 1524 ippmOwnersIndex OBJECT-TYPE 1525 SYNTAX Integer32 (1.. 65535) 1526 MAX-ACCESS not-accessible 1527 STATUS current 1528 DESCRIPTION 1529 "An arbitrary index that identifies an entry in the owners 1530 table." 1531 ::= { ippmOwnersEntry 1 } 1533 ippmOwnersOwner OBJECT-TYPE 1534 SYNTAX IppmOwnerString 1535 MAX-ACCESS read-create 1536 STATUS current 1537 DESCRIPTION 1538 "The owner described by this entry." 1539 ::= { ippmOwnersEntry 2 } 1541 ippmOwnersGrantedMetrics OBJECT-TYPE 1542 SYNTAX IppmStandardMetrics 1543 MAX-ACCESS read-create 1544 STATUS current 1545 DESCRIPTION 1546 " Defines the metrics granted to an owner for which measurements 1547 can be performed." 1548 ::= { ippmOwnersEntry 3 } 1550 ippmOwnersQuota OBJECT-TYPE 1551 SYNTAX Integer32 1552 MAX-ACCESS read-create 1553 STATUS current 1554 DESCRIPTION 1555 " The maximum number of records that this owner may have in the history 1556 table and/or in the report table.�� 1557 ::= { ippmOwnersEntry 4 } 1559 ippmOwnersIpAddressType OBJECT-TYPE 1560 SYNTAX InetAddressType { 1561 ipv4(1) , 1562 ipv6(2), 1563 dns(16) 1564 } 1565 MAX-ACCESS read-create 1566 STATUS current 1567 DESCRIPTION 1568 "The IP address type of the management entity corresponding to 1569 this owner. 1570 InetAddressType is restricted to ipv4(1),ipv6(2)and dns(16). " 1571 ::= { ippmOwnersEntry 5 } 1573 ippmOwnersIpAddress OBJECT-TYPE 1574 SYNTAX InetAddress (SIZE (1..128)) 1575 MAX-ACCESS read-create 1576 STATUS current 1577 DESCRIPTION 1578 "The IP address of the management entity corresponding to this 1579 owner." 1580 ::= { ippmOwnersEntry 6 } 1582 ippmOwnersEmail OBJECT-TYPE 1583 SYNTAX SnmpAdminString 1584 MAX-ACCESS read-create 1585 STATUS current 1586 DESCRIPTION 1587 "The email address of the management entity corresponding to this 1588 owner." 1589 ::= { ippmOwnersEntry 7 } 1591 ippmOwnersSMS OBJECT-TYPE 1592 SYNTAX SnmpAdminString 1593 MAX-ACCESS read-create 1594 STATUS current 1595 DESCRIPTION 1596 "The SMS phone number of the management entity corresponding to 1597 this owner." 1598 ::= { ippmOwnersEntry 8 } 1600 ippmOwnersStatus OBJECT-TYPE 1601 SYNTAX RowStatus 1602 MAX-ACCESS read-create 1603 STATUS current 1604 DESCRIPTION 1605 "The status of this table entry." 1606 ::= { ippmOwnersEntry 9 } 1608 -- ippmHistory Group 1609 -- 1610 -- 1612 -- 1613 -- ippmHistoryTable 1614 -- 1616 ippmHistoryTable OBJECT-TYPE 1617 SYNTAX SEQUENCE OF IppmHistoryEntry 1618 MAX-ACCESS not-accessible 1619 STATUS current 1620 DESCRIPTION 1621 "The table containing the measurement results." 1622 ::= { ippmHistory 1 } 1624 ippmHistoryEntry OBJECT-TYPE 1625 SYNTAX IppmHistoryEntry 1626 MAX-ACCESS not-accessible 1627 STATUS current 1628 DESCRIPTION 1629 "An ippmHistoryEntry entry is one of the results of a measure 1630 identified by ippmHistoryMeasureOwner, ippmHistoryMeasureIndex, 1631 ippmHistoryMetricIndex and ippmHistoryIndex. 1633 In the index : 1635 + ippmHistoryMeasureOwner identifies the owner of the measure; 1637 + ippmHistoryMeasureIndex identifies the measure in the owner 1638 namespace; 1640 + ippmHistoryMetricIndex identifies the metric measured by the 1641 measure. The metric is described in the corresponding entry of 1642 the n ippmMetricTable; 1644 + ippmHistoryIndex is the local index of the result on the 1645 history table." 1647 INDEX { ippmHistoryMeasureOwner, ippmHistoryMeasureIndex, 1648 ippmHistoryMetricIndex, ippmHistoryIndex } 1649 ::= { ippmHistoryTable 1 } 1651 IppmHistoryEntry ::= 1652 SEQUENCE { 1653 ippmHistoryMeasureOwner IppmOwnerString, 1654 ippmHistoryMeasureIndex Integer32, 1655 ippmHistoryMetricIndex Integer32, 1656 ippmHistoryIndex Integer32, 1657 ippmHistorySequence Integer32, 1658 ippmHistoryTimestamp GMTTimeStamp, 1659 ippmHistoryValue Integer32 1660 } 1662 ippmHistoryMeasureOwner OBJECT-TYPE 1663 SYNTAX IppmOwnerString 1664 MAX-ACCESS not-accessible 1665 STATUS current 1666 DESCRIPTION 1667 "The owner of the measure that produced this result." 1668 ::= { ippmHistoryEntry 1 } 1670 ippmHistoryMeasureIndex OBJECT-TYPE 1671 SYNTAX Integer32 (1.. 65535) 1672 MAX-ACCESS not-accessible 1673 STATUS current 1674 DESCRIPTION 1675 " The owner index of the measure that produced this result." 1676 ::= { ippmHistoryEntry 2 } 1678 ippmHistoryMetricIndex OBJECT-TYPE 1679 SYNTAX Integer32 (1.. 65535) 1680 MAX-ACCESS not-accessible 1681 STATUS current 1682 DESCRIPTION 1683 " ippmHistoryMetricIndex identifies the metric measured by the 1684 measure. The metric is described in the corresponding entry of 1685 the ippmMetricTable." 1686 ::= { ippmHistoryEntry 3 } 1688 ippmHistoryIndex OBJECT-TYPE 1689 SYNTAX Integer32 (1.. 65535) 1690 MAX-ACCESS not-accessible 1691 STATUS current 1692 DESCRIPTION 1693 " A local index that identifies a result in the history table." 1694 ::= { ippmHistoryEntry 4 } 1696 ippmHistorySequence OBJECT-TYPE 1697 SYNTAX Integer32 (0.. 65535) 1698 MAX-ACCESS read-only 1699 STATUS current 1700 DESCRIPTION 1701 "ippmHistorySequence is the sequence index of the measurement 1702 results for a metric. 1704 Network metrics: 1705 It's the sequence index of a measurement packet. Typically, it 1706 identifies the order of the packet in the stream of packets sends 1707 by the source. 1709 Aggregated metrics: 1710 It is the sequence index of the computed aggregated metric 1711 result." 1712 ::= { ippmHistoryEntry 5 } 1714 ippmHistoryTimestamp OBJECT-TYPE 1715 SYNTAX GMTTimeStamp 1716 MAX-ACCESS read-only 1717 STATUS current 1718 DESCRIPTION 1719 "The timestamp when the measurement occured." 1720 ::= { ippmHistoryEntry 6 } 1722 ippmHistoryValue OBJECT-TYPE 1723 SYNTAX Integer32 1724 MAX-ACCESS read-only 1725 STATUS current 1726 DESCRIPTION 1727 "The observed value of the measurement." 1728 ::= { ippmHistoryEntry 7 } 1730 -- 1731 -- ippmMeasure Group 1732 -- 1734 -- 1735 -- 1736 -- ippmNetMeasureTable 1737 -- 1738 -- 1740 ippmNetMeasureTable OBJECT-TYPE 1741 SYNTAX SEQUENCE OF IppmNetMeasureEntry 1742 MAX-ACCESS not-accessible 1743 STATUS current 1744 DESCRIPTION 1745 "A entry is a measurement that performs network measures and 1746 provides results. 1747 It performs several metric measurements per packet exchange. Each 1748 step of a measure produces a singleton result per metric. The 1749 time of the measurement and the value of the metric are saved in 1750 the ippmHistoryTable." 1751 ::= { ippmMeasure 1 } 1753 ippmNetMeasureEntry OBJECT-TYPE 1754 SYNTAX IppmNetMeasureEntry 1755 MAX-ACCESS not-accessible 1756 STATUS current 1757 DESCRIPTION 1758 " Typically the configuration operation sets both the values of 1759 the new IppmNetMeasureEntry. 1760 The IppmNetMeasureTable is mandatory. 1762 The IppmNetMeasureTable content is read only. It means that the 1763 measurement software handles the table internally. The setup of 1764 the network measure is not permitted through the IPPM REPORTING 1765 MIB. OWAP provides a setup protocol to enable and teardown 1766 networks measures. 1768 The ippmNetMeasureMetrics is set to a list of metrics to be 1769 computed from the same raw packet exchange. Each step of 1770 measurement delivers a singleton per chosen metric. Results are 1771 timestamped and saved in the ippmHistoryTable. 1773 The ippmNetMeasureTable typical usage consists in providing 1774 network measure indices in order to allow aggregated measures to 1775 perform aggregation on the results of network measures.�� 1777 INDEX { ippmNetMeasureOwner, ippmNetMeasureIndex } 1778 ::= { ippmNetMeasureTable 1 } 1780 IppmNetMeasureEntry ::= SEQUENCE { 1781 ippmNetMeasureOwner IppmOwnerString, 1782 ippmNetMeasureIndex Integer32, 1783 ippmNetMeasureName SnmpAdminString, 1784 ippmNetMeasureMetrics IppmStandardMetrics, 1785 ippmNetMeasureBeginTime GMTTimeStamp, 1786 ippmNetMeasureCollectionRateUnit TimeUnit, 1787 ippmNetMeasureCollectionRate Integer32, 1788 ippmNetMeasureDurationUnit TimeUnit, 1789 ippmNetMeasureDuration Integer32, 1790 ippmNetMeasureHistorySize Integer32, 1791 ippmNetMeasureFailureMgmtMode INTEGER, 1792 ippmNetMeasureResultsMgmt Integer32, 1793 ippmNetMeasureSrcTypeP TypeP, 1794 ippmNetMeasureSrc TypePaddress, 1795 ippmNetMeasureDstTypeP TypeP, 1796 ippmNetMeasureDst TypePaddress, 1797 ippmNetMeasureTxMode Integer32, 1798 ippmNetMeasureTxPacketRateUnit Integer32, 1799 ippmNetMeasureTxPacketRate INTEGER, 1800 ippmNetMeasureDevtnOrBurstSize Integer32, 1801 ippmNetMeasureMedOrIntBurstSize Integer32, 1802 ippmNetMeasureLossTimeout Integer32, 1803 ippmNetMeasureL3PacketSize Integer32, 1804 ippmNetMeasureDataPattern OCTET STRING, 1805 ippmNetMeasureMap SnmpAdminString, 1806 ippmNetMeasureSingletons INTEGER, 1807 ippmNetMeasureOperState INTEGER 1808 } 1810 ippmNetMeasureOwner OBJECT-TYPE 1811 SYNTAX IppmOwnerString 1812 MAX-ACCESS not-accessible 1813 STATUS current 1814 DESCRIPTION 1815 "The owner of the network measurement." 1816 ::= { ippmNetMeasureEntry 1 } 1818 ippmNetMeasureIndex OBJECT-TYPE 1819 SYNTAX Integer32 (1.. 65535) 1820 MAX-ACCESS not-accessible 1821 STATUS current 1822 DESCRIPTION 1823 "The owner index of the network measure. " 1824 ::= { ippmNetMeasureEntry 2 } 1826 ippmNetMeasureName OBJECT-TYPE 1827 SYNTAX SnmpAdminString 1828 MAX-ACCESS read-only 1829 STATUS current 1830 DESCRIPTION 1831 "The name of the metric instance. It illustrates the specificity 1832 of the metric and includes the metric and the TypeP. 1834 Example: 1835 IP-TCP-HTTP-One-way-Delay: free text " 1836 ::= { ippmNetMeasureEntry 3 } 1838 ippmNetMeasureMetrics OBJECT-TYPE 1839 SYNTAX IppmStandardMetrics 1840 MAX-ACCESS read-only 1841 STATUS current 1842 DESCRIPTION 1843 "Defines the metrics to compute within this measure. ONLY network 1844 metrics of the same type are allowed in this field. 1845 A measure may be configured for the result of different metric 1846 singletons to be archived in the ippmHistoryTable. The 1847 ippmMetricIndex of the created result has the value of the bit 1848 index of the corresponding ippmMeasureMetrics as explained above 1849 in the ippmMetricIndex definition. 1851 Example: 1852 A measure asking for One-way-Delay(6) and One-way-Packet-Loss(12) 1853 generated a flow of singletons which are logged in the 1854 ippmHistoryTable. The singletons created for the One-way-Delay 1855 measure have a value of ippmMetricIndex of 6 while the created 1856 singletons for the One-way-Packet-Loss measure have a value of 1857 ippmMetricIndex of 12. 1859 One measure may perform simultaneously 1860 either several network metrics 1861 either several aggregated metrics 1863 " 1864 -- { one-way-Delay, one-way-Packet-Loss } 1865 DEFVAL { ��0000001000001�� } 1866 ::= { ippmNetMeasureEntry 4 } 1868 ippmNetMeasureBeginTime OBJECT-TYPE 1869 SYNTAX GMTTimeStamp 1870 MAX-ACCESS read-only 1871 STATUS current 1872 DESCRIPTION 1873 "Specifies the time at which the measurement begins." 1874 ::= { ippmNetMeasureEntry 5 } 1876 ippmNetMeasureCollectionRateUnit OBJECT-TYPE 1877 SYNTAX TimeUnit 1878 MAX-ACCESS read-only 1879 STATUS current 1880 DESCRIPTION 1881 "Specifies the unit of the measurement period." 1882 DEFVAL { second } 1883 ::= { ippmNetMeasureEntry 6 } 1885 ippmNetMeasureCollectionRate OBJECT-TYPE 1886 SYNTAX Integer32 1887 MAX-ACCESS read-only 1888 STATUS current 1889 DESCRIPTION 1890 "Gives the period used to collect singletons from the point of 1891 measures. 1892 This value is used as the cycle period in the report." 1893 DEFVAL { 60 } 1894 ::= { ippmNetMeasureEntry 7 } 1896 ippmNetMeasureDurationUnit OBJECT-TYPE 1897 SYNTAX TimeUnit 1898 MAX-ACCESS read-only 1899 STATUS current 1900 DESCRIPTION 1901 "Specifies the measurement duration unit." 1902 DEFVAL { second } 1903 ::= { ippmNetMeasureEntry 8 } 1905 ippmNetMeasureDuration OBJECT-TYPE 1906 SYNTAX Integer32 1907 MAX-ACCESS read-only 1908 STATUS current 1909 DESCRIPTION 1910 "Specifies the measurement duration." 1911 DEFVAL { 120 } 1912 ::= { ippmNetMeasureEntry 9 } 1914 ippmNetMeasureHistorySize OBJECT-TYPE 1915 SYNTAX Integer32 1916 MAX-ACCESS read-only 1917 STATUS current 1918 DESCRIPTION 1919 "Specifies the maximum number of results saved for each metric of 1920 this measure. 1921 Overflow condition will be managed by the object 1922 ippmNetMeasureResultsMgmt. " 1924 ::= { ippmNetMeasureEntry 10 } 1926 ippmNetMeasureFailureMgmtMode OBJECT-TYPE 1927 SYNTAX INTEGER { 1928 auto(1), 1929 manual(2), 1930 discarded(3) 1931 } 1932 MAX-ACCESS read-only 1933 STATUS current 1934 DESCRIPTION 1935 "This object defines whether this row and the measure controlled 1936 by this row are kept in volatile storage and lost upon reboot or 1937 if this row is backed up 1938 by non-volatile or permanent storage. 1939 'auto' 1940 continue the measurement and erase the older entries in the 1941 history. 1942 'manual' 1943 continue the measurement and erase the older entries in the 1944 history. 1945 'discarded' 1946 continue the measurement and erase the older entries in the 1947 history. 1949 Possible values are: other(1), volatile(2), nonVolatile(3), 1950 permanent(4) 1952 Network: " 1953 DEFVAL { auto } 1954 ::= { ippmNetMeasureEntry 11 } 1956 ippmNetMeasureResultsMgmt OBJECT-TYPE 1957 SYNTAX INTEGER { 1958 wrap(1), 1959 suspend(2), 1960 delete(3) 1961 } 1962 MAX-ACCESS read-only 1963 STATUS current 1964 DESCRIPTION 1965 " 1966 Action to take when the log is full. The user may choose 1967 to either wrap, in which case the agent writes over existing 1968 records. The user may choose to suspend writing to the log in the 1969 event that he wishes to archive the data. The resume action 1970 causes the agent to begin to write in thelog, and assumes the 1971 data has been cleared. 1972 This object indicates the way the measurement results are managed 1973 when the owner quota has been exceeded: 1974 'wrap' 1975 continue the measurement and erase the older entries in the 1976 history. 1977 'suspend' 1978 stop the measure and keep the results in the history. 1979 'delete' 1980 remove the results from the history. 1981 " 1982 ::= { ippmNetMeasureEntry 12 } 1984 ippmNetMeasureSrcTypeP OBJECT-TYPE 1985 SYNTAX TypeP 1986 MAX-ACCESS read-only 1987 STATUS current 1988 DESCRIPTION 1989 "Defines the type P of the source address of the packets sent by 1990 the measure." 1991 DEFVAL { "ip" } 1992 ::= { ippmNetMeasureEntry 13 } 1994 ippmNetMeasureSrc OBJECT-TYPE 1995 SYNTAX TypePaddress 1996 MAX-ACCESS read-only 1997 STATUS current 1998 DESCRIPTION 1999 "Specifies the address of the source of the measure. 2000 It is represented as a list of parameters corresponding to those 2001 of the PROTOCOL IDENTIFIER sets in ippmNetMeasureSrcTypeP." 2002 ::= { ippmNetMeasureEntry 14} 2004 ippmNetMeasureDstTypeP OBJECT-TYPE 2005 SYNTAX TypeP 2006 MAX-ACCESS read-only 2007 STATUS current 2008 DESCRIPTION 2009 "Defines the type P of the destination address of the packets 2010 sent by the measure." 2011 DEFVAL { "ip" } 2012 ::= { ippmNetMeasureEntry 15 } 2014 ippmNetMeasureDst OBJECT-TYPE 2015 SYNTAX TypePaddress 2016 MAX-ACCESS read-only 2017 STATUS current 2018 DESCRIPTION 2019 "Specifies the address of the destination of the measure. 2020 It is represented as a list of parameters corresponding to those 2021 of the PROTOCOL IDENTIFIER set in ippmNetMeasureDstTypeP." 2022 ::= { ippmNetMeasureEntry 16 } 2024 ippmNetMeasureTxMode OBJECT-TYPE 2025 SYNTAX INTEGER { 2026 other(0), 2027 periodic(1), 2028 poisson(2), 2029 multiburst(3) 2030 } 2031 MAX-ACCESS read-only 2032 STATUS current 2033 DESCRIPTION 2034 "The transmit mode used to send the packets: 2035 'other' 2036 The rule used to send the packets is unknown. 2037 'periodic' 2038 Packets are sent periodically at ippmNetMeasureTxPacketRate 2039 rate. 2040 'poisson' 2041 Packets are sent using a Poisson law, the median is the value 2042 of ippmNetMeasureMedOrIntBurstSize, the deviation is 2043 ippmNetMeasureDevtnOrBurstSize. 2044 'multiburst' 2045 Packets are sent bursty at ippmNetMeasureTxPacketRate. The 2046 size of the burst is made of ippmNetMeasureDevtnOrBurstSize 2047 packets. 2048 Between 2 consecutive bursts, transmission stops during the time 2049 needed to send ippmNetMeasureInterBurstPacketsNb. 2051 " 2052 ::= { ippmNetMeasureEntry 17 } 2054 ippmNetMeasureTxPacketRateUnit OBJECT-TYPE 2055 SYNTAX TimeUnit 2056 MAX-ACCESS read-only 2057 STATUS current 2058 DESCRIPTION 2059 "The packet rate unit used to send the packets." 2060 ::= { ippmNetMeasureEntry 18 } 2062 ippmNetMeasureTxPacketRate OBJECT-TYPE 2063 SYNTAX Integer32 2064 MAX-ACCESS read-only 2065 STATUS current 2066 DESCRIPTION 2067 "The rate the packets are sent." 2068 ::= { ippmNetMeasureEntry 19 } 2070 ippmNetMeasureDevtnOrBurstSize OBJECT-TYPE 2071 SYNTAX Integer32 2072 MAX-ACCESS read-only 2073 STATUS current 2074 DESCRIPTION 2075 "Indicates the average number of packets per seconds sent using a 2076 poisson law. 2078 ippmNetMeasurePoissonRate can not be used conjointly with 2079 ippmNetMeasureClockPattern." 2080 DEFVAL { 30 } 2081 ::= { ippmNetMeasureEntry 20 } 2083 ippmNetMeasureMedOrIntBurstSize OBJECT-TYPE 2084 SYNTAX Integer32 2085 MAX-ACCESS read-only 2086 STATUS current 2087 DESCRIPTION 2088 "According to the transmit mode, this value indicates the average 2089 number of packets per seconds sent using a poisson law, or the 2090 number of packets to wait between consecutive bursts." 2091 DEFVAL { 30 } 2092 ::= { ippmNetMeasureEntry 21 } 2094 ippmNetMeasureLossTimeout OBJECT-TYPE 2095 SYNTAX Integer32 2096 MAX-ACCESS read-only 2097 STATUS current 2098 -- UNITS "Milliseconds" 2099 DESCRIPTION 2100 "Specifies the delay after which the packet is considered lost by the 2101 sink." 2102 DEFVAL { 10 } 2103 ::= { ippmNetMeasureEntry 22 } 2105 ippmNetMeasureL3PacketSize OBJECT-TYPE 2106 SYNTAX Integer32 2107 MAX-ACCESS read-only 2108 STATUS current 2109 DESCRIPTION 2110 "Specifies the size of the packets counted at the IP network 2111 layer in regards to the TypeP definition. 2113 Example: For a TypeP 'ip ipip4' the L3 size will be the size of 2114 the packet at ipip4 level. 2115 " 2116 DEFVAL { 64 } 2117 ::= { ippmNetMeasureEntry 23 } 2119 ippmNetMeasureDataPattern OBJECT-TYPE 2120 SYNTAX OCTET STRING 2121 MAX-ACCESS read-only 2122 STATUS current 2123 DESCRIPTION 2124 "The pattern used to fill the payload of the packet." 2125 DEFVAL { 'FF'H } 2126 ::= { ippmNetMeasureEntry 24 } 2128 ippmNetMeasureMap OBJECT-TYPE 2129 SYNTAX SnmpAdminString 2130 MAX-ACCESS read-only 2131 STATUS current 2132 DESCRIPTION 2133 "A administrative name of a network management map to which the measure 2134 belongs." 2135 DEFVAL { "" } 2137 ::= { ippmNetMeasureEntry 25 } 2139 ippmNetMeasureSingletons OBJECT-TYPE 2140 SYNTAX Integer32 2141 MAX-ACCESS read-only 2142 STATUS current 2143 DESCRIPTION 2144 "Reports the number of singletons performed per metric by the 2145 measure since the beginning of the measure. This parameters is 2146 required for aggregation." 2147 ::= { ippmNetMeasureEntry 26 } 2149 ippmNetMeasureOperState OBJECT-TYPE 2150 SYNTAX INTEGER { 2151 unknown(0), 2152 running(1), 2153 stopped(2) 2154 } 2155 MAX-ACCESS read-only 2156 STATUS current 2157 DESCRIPTION 2158 "Reports the operational status of the network measure.�� 2159 ::= { ippmNetMeasureEntry 27 } 2161 -- 2162 -- 2163 -- ippmAggrMeasureTable 2164 -- 2165 -- 2167 ippmAggrMeasureTable OBJECT-TYPE 2168 SYNTAX SEQUENCE OF IppmAggrMeasureEntry 2169 MAX-ACCESS not-accessible 2170 STATUS current 2171 DESCRIPTION 2172 " An aggregated measure summarizes the results of previous 2173 network or aggregated measures. The results may be saved in the 2174 ippmHistoryTable. 2176 Each step of the calculation for the measure produces a singleton 2177 result per metric." 2178 ::= { ippmMeasure 2 } 2180 ippmAggrMeasureEntry OBJECT-TYPE 2181 SYNTAX IppmAggrMeasureEntry 2182 MAX-ACCESS not-accessible 2183 STATUS current 2184 DESCRIPTION 2185 "Typically the configuration operation sets the value of 2186 theIppmAggrMeasureEntry. 2188 ippmAggrMeasureTable is mandatory. 2190 The ippmAggrMeasureMetrics defines the metric to compute. 2191 The results of the measure to summarize are identified by: 2192 + ippmAggrMeasureHistoryOwner, 2193 + ippmAggrMeasureHistoryOwnerIndex and 2194 + ippmAggrMeasureHistoryMetric 2196 The aggregated task starts at ippmMeasureBeginTime and ends after 2197 ippmMeasureDuration. An aggregated result is performed and saved 2198 in the ippmHistoryTable for each ippmMeasureCollectionRate tick. 2199 " 2200 INDEX { ippmAggrMeasureOwner, ippmAggrMeasureIndex } 2201 ::= { ippmAggrMeasureTable 1 } 2203 IppmAggrMeasureEntry ::= SEQUENCE { 2204 ippmAggrMeasureOwner IppmOwnerString, 2205 ippmAggrMeasureIndex Integer32, 2206 ippmAggrMeasureName SnmpAdminString, 2207 ippmAggrMeasureMetrics IppmStandardMetrics, 2208 ippmAggrMeasureBeginTime GMTTimeStamp, 2209 ippmAggrMeasureAggrPeriodUnit TimeUnit, 2210 ippmAggrMeasureAggrPeriod Integer32, 2211 ippmAggrMeasureDurationUnit TimeUnit, 2212 ippmAggrMeasureDuration Integer32, 2213 ippmAggrMeasureHistorySize Integer32, 2214 ippmAggrMeasureStorageType StorageType, 2215 ippmAggrMeasureHistoryOwner IppmOwnerString, 2216 ippmAggrMeasureHistoryOwnerIndex Integer32, 2217 ippmAggrMeasureHistoryMetric Integer32, 2218 ippmAggrMeasureAdminState Integer32, 2219 ippmAggrMeasureFastReport OBJECT IDENTIFIER, 2220 ippmAggrMeasureMap SnmpAdminString, 2221 ippmAggrMeasureResultsMgmt Integer32, 2222 ippmAggrMeasureStatus RowStatus 2223 } 2224 ippmAggrMeasureOwner OBJECT-TYPE 2225 SYNTAX IppmOwnerString 2226 MAX-ACCESS not-accessible 2227 STATUS current 2228 DESCRIPTION 2229 "The owner who has configured this entry." 2230 ::= { ippmAggrMeasureEntry 1 } 2232 ippmAggrMeasureIndex OBJECT-TYPE 2233 SYNTAX Integer32 (1.. 65535) 2234 MAX-ACCESS not-accessible 2235 STATUS current 2236 DESCRIPTION 2237 "The owner index of the measure. The value is managed by the 2238 owner." 2239 ::= { ippmAggrMeasureEntry 2 } 2241 ippmAggrMeasureName OBJECT-TYPE 2242 SYNTAX SnmpAdminString 2243 MAX-ACCESS read-create 2244 STATUS current 2245 DESCRIPTION 2246 "The name of the instance of the metric. It illustrates the 2247 specificity of the metric and includes the metric and the typeP. 2249 example: IP-port-HTTP-connectivity" 2250 ::= { ippmAggrMeasureEntry 3 } 2252 ippmAggrMeasureMetrics OBJECT-TYPE 2253 SYNTAX IppmStandardMetrics 2254 MAX-ACCESS read-create 2255 STATUS current 2256 DESCRIPTION 2257 "Defines the metrics to compute within this aggregated measure. 2259 ONLY aggregated metrics of the same type are allowed in this 2260 field. 2261 A measure may be configured for the result of different metric 2262 singletons to be archived in the ippmHistoryTable. The 2263 ippmMetricIndex of the created result has the value of the bit 2264 index of the corresponding ippmAggrMeasureMetrics as explained 2265 above in the ippmMetricIndex definition. 2267 Example: 2268 A measure asking for One-way-Delay(6) and One-way-Packet-Loss(12) 2269 generated a flow of singletons which are logged in the 2270 ippmHistoryTable. The singletons created for the One-way-Delay 2271 measure have a value of ippmMetricIndex of 6 while the created 2272 singletons for the One-way-Packet-Loss measure have a value of 2273 ippmMetricIndex of 12. 2274 " 2275 ::= { ippmAggrMeasureEntry 4 } 2277 ippmAggrMeasureBeginTime OBJECT-TYPE 2278 SYNTAX GMTTimeStamp 2279 MAX-ACCESS read-create 2280 STATUS current 2281 DESCRIPTION 2282 "Specifies the time at which the aggregated measure starts." 2283 ::= { ippmAggrMeasureEntry 5 } 2285 ippmAggrMeasureAggrPeriodUnit OBJECT-TYPE 2286 SYNTAX TimeUnit 2287 MAX-ACCESS read-create 2288 STATUS current 2289 DESCRIPTION 2290 "Specifies the unit of the aggregated measure period." 2291 DEFVAL { second } 2292 ::= { ippmAggrMeasureEntry 6 } 2294 ippmAggrMeasureAggrPeriod OBJECT-TYPE 2295 SYNTAX Integer32 2296 MAX-ACCESS read-create 2297 STATUS current 2298 DESCRIPTION 2299 "Specifies the amount of time between 2 measurement action 2300 intervals. The action is specific to the semantic of the measure. 2302 Network metrics: 2304 The ippmNetMeasureClockPattern transforms the flow of periodical 2305 instants as a flow of unpredictable instants of measurement 2306 packet emission. 2308 As the source and the sink share the definition of the clock of 2309 the measure, as the sending timestamp is part of the measurement 2310 packet, the sink have the information to verify that the stream 2311 of packets generated by the source respects the clock law. 2313 Aggregated metrics: 2315 They are performed periodically on a sequence of results of other 2316 measures. The period corresponds to the interval between two 2317 successive computations of the metric. The value of 2318 ippmHistoryTimestamp result of a aggregated metric computed 2319 corresponds to the value of the ippmHistoryTimestamp of the last 2320 metric result of the sequence used in to compute the aggregated 2321 metric." 2322 DEFVAL { 60 } 2323 ::= { ippmAggrMeasureEntry 7 } 2325 ippmAggrMeasureDurationUnit OBJECT-TYPE 2326 SYNTAX TimeUnit 2327 MAX-ACCESS read-create 2328 STATUS current 2329 DESCRIPTION 2330 "Specifies the unit of the measure duration." 2331 DEFVAL { second } 2332 ::= { ippmAggrMeasureEntry 8 } 2334 ippmAggrMeasureDuration OBJECT-TYPE 2335 SYNTAX Integer32 2336 MAX-ACCESS read-create 2337 STATUS current 2338 DESCRIPTION 2339 "Specifies the duration of the measure." 2340 DEFVAL { 120 } 2341 ::= { ippmAggrMeasureEntry 9 } 2343 ippmAggrMeasureHistorySize OBJECT-TYPE 2344 SYNTAX Integer32 2345 MAX-ACCESS read-create 2346 STATUS current 2347 DESCRIPTION 2348 "Specifies the maximum number of results saved for each metric of 2349 this measure. Overflow condition will be managed by the object 2350 ippmAggrMeasureResultsMgmt. " 2351 ::= { ippmAggrMeasureEntry 10 } 2353 ippmAggrMeasureStorageType OBJECT-TYPE 2354 SYNTAX StorageType 2355 MAX-ACCESS read-create 2356 STATUS current 2357 DESCRIPTION 2358 "This object defines whether this row and the measure controlled 2359 by this row are kept in volatile storage and lost upon reboot or 2360 if this row is backed up 2361 by non-volatile or permanent storage. 2362 Possible values are: other(1), volatile(2), nonVolatile(3), 2363 permanent(4), readOnly(5)." 2364 DEFVAL { nonVolatile } 2365 ::= { ippmAggrMeasureEntry 11 } 2367 ippmAggrMeasureResultsMgmt OBJECT-TYPE 2368 SYNTAX INTEGER { 2369 wrap(1), 2370 suspend(2) 2371 } 2372 MAX-ACCESS read-only 2373 STATUS current 2374 DESCRIPTION 2375 "This object displays the way the history of the aggregated 2376 measure is managed. 2377 'wrap' 2378 continue the measure and erase the older entries in the 2379 history. 2380 'suspend' 2381 stop the measure and keep the results in the history. 2382 " 2383 DEFVAL { wrap } 2384 ::= { ippmAggrMeasureEntry 12 } 2386 ippmAggrMeasureHistoryOwner OBJECT-TYPE 2387 SYNTAX IppmOwnerString 2388 MAX-ACCESS read-create 2389 STATUS current 2390 DESCRIPTION 2391 "The owner of the measure to summarize. " 2392 ::= { ippmAggrMeasureEntry 13 } 2394 ippmAggrMeasureHistoryOwnerIndex OBJECT-TYPE 2395 SYNTAX Integer32 (1.. 65535) 2396 MAX-ACCESS read-create 2397 STATUS current 2398 DESCRIPTION 2399 "The owner index of the measure to summarize. " 2400 ::= { ippmAggrMeasureEntry 14 } 2402 ippmAggrMeasureHistoryMetric OBJECT-TYPE 2403 SYNTAX Integer32 2404 MAX-ACCESS read-create 2405 STATUS current 2406 DESCRIPTION 2407 "The metric of the measure to summarize. " 2408 ::= { ippmAggrMeasureEntry 15 } 2410 ippmAggrMeasureAdminState OBJECT-TYPE 2411 SYNTAX INTEGER { 2412 start(0), 2413 stop(1) 2414 } 2415 MAX-ACCESS read-create 2416 STATUS current 2417 DESCRIPTION 2418 "This object controls the activity of the aggregated measure. 2419 'start' 2420 The aggregated measure is started. 2421 'stop' 2422 The aggregated measure is stopped. 2423 " 2424 ::= { ippmAggrMeasureEntry 16 } 2426 ippmAggrMeasureFastReport OBJECT-TYPE 2427 SYNTAX OBJECT IDENTIFIER 2428 MAX-ACCESS read-create 2429 STATUS current 2430 DESCRIPTION 2431 "A fast report is required in order to verify quickly that a 2432 measure is running well. 2433 The feature 'fast report' is active if IppmAggrMeasureFastReport 2434 is not null and points to a notification. 2435 A fast report consists of sending by email to the owner of the 2436 measure, a table of the results of all the metrics computed by 2437 this aggregated measure. The owner email address is read from the 2438 ippmOwnersTable. 2440 ippmAggrMeasureFastReport identifies the notification which 2441 defines the header of the report. 2443 The results part of the report is made of the a column of results 2444 per metrics. Results are separated using commas. 2446 To avoid disaster, an aggregated measure using a fast report must 2447 have a cycle of aggregation greater than or equal to 1 second and 2448 should not sent more than an email every 5 minutes and should not 2449 sent more than 12 emails." 2450 -- DEFVAL { 0.0 } 2451 ::= { ippmAggrMeasureEntry 17 } 2453 ippmAggrMeasureMap OBJECT-TYPE 2454 SYNTAX SnmpAdminString 2455 MAX-ACCESS read-create 2456 STATUS current 2457 DESCRIPTION 2458 "This object allows for classification of the measure. It is 2459 typically the name of an administrative map. 2460 " 2461 DEFVAL { "" } 2462 ::= { ippmAggrMeasureEntry 18 } 2464 ippmAggrMeasureStatus OBJECT-TYPE 2465 SYNTAX RowStatus 2466 MAX-ACCESS read-create 2467 STATUS current 2468 DESCRIPTION 2469 "The status of this table entry. Once the entry status is set to 2470 active, the associate entry cannot be modified. 2472 The creation of an aggregated measure forced the creation of the 2473 corresponding entry in ippmMeasureTable." 2474 ::= { ippmAggrMeasureEntry 19 } 2476 -- 2477 -- ippmReport Group 2478 -- 2480 ippmReportPathToResults OBJECT-TYPE 2481 SYNTAX SnmpAdminString 2482 MAX-ACCESS read-only 2483 STATUS current 2484 DESCRIPTION 2485 " It is typically an URL describing the file location where the 2486 results are logged. " 2487 ::= { ippmReport 1 } 2489 -- 2490 -- 2491 -- ippmReportSetupTable 2492 -- 2493 -- 2495 ippmReportSetupTable OBJECT-TYPE 2496 SYNTAX SEQUENCE OF IppmReportSetupEntry 2497 MAX-ACCESS not-accessible 2498 STATUS current 2499 DESCRIPTION 2500 "The ippmReportSetupTable is a list of definition of reports. It 2501 defines the results of network or aggregated measures that are to 2502 be reported. A report is saved in the ippmReportTable, or sent to 2503 an application using a SNMP Trap, a SNMP inform PDU, an email, or 2504 a SMS. The reporting task is not intended to be a batch action 2505 processed at the end of the measure. It is coupled with threshold 2506 detections and event filtering to deliver application level 2507 events and data, while preserving scalability. 2509 " 2510 ::= { ippmReport 2 } 2512 ippmReportSetupEntry OBJECT-TYPE 2513 SYNTAX IppmReportSetupEntry 2514 MAX-ACCESS not-accessible 2515 STATUS current 2516 DESCRIPTION 2517 "The report applies to the results of a measure as defined in 2518 either the network measure table, or the aggregated measure 2519 table. 2521 The ippmReportSetupDefinition describes the data and the events 2522 to include in the report. The definition consists of a list of 2523 tasks to perform on the results of the measure. 2525 A report is associated to a network measure or to an aggregated 2526 measure. 2528 Note 1: To associate a report to an existing measure the manager 2529 suspends the measure by setting either the ippmNetMeasureStatus 2530 or the ippmAggrMeasureStatus to 'notInService'. Then one sets the 2531 report fields and activates the measure by setting the 2532 corresponding MeasureStatus to 'active'. 2534 Note 2: A report is tied to a measure. The period of the measure" 2535 INDEX { ippmReportSetupOwner, ippmReportSetupIndex } 2536 ::= { ippmReportSetupTable 1 } 2538 IppmReportSetupEntry ::= 2539 SEQUENCE { 2540 ippmReportSetupOwner IppmOwnerString, 2541 ippmReportSetupIndex Integer32, 2542 ippmReportSetupMeasureOwner IppmOwnerString, 2543 ippmReportSetupMeasureIndex Integer32, 2544 ippmReportSetupMeasureMetric Integer32, 2545 ippmReportSetupDefinition IppmReportDefinition, 2546 ippmReportSetupUpDownThreshold Integer32, 2547 ippmReportSetupLowThreshold Integer32, 2548 ippmReportSetupHighThreshold Integer32, 2549 ippmReportSetupDurationThresUnit TimeUnit, 2550 ippmReportSetupDurationThreshold Integer32, 2551 ippmReportSetupReportSize Integer32, 2552 ippmReportSetupResultsMgmt Integer32, 2553 ippmReportSetupNMS SnmpAdminString, 2554 ippmReportSetupNotification OBJECT IDENTIFIER, 2555 ippmReportSetupMap SnmpAdminString, 2556 ippmReportSetupStatus RowStatus 2557 } 2559 ippmReportSetupOwner OBJECT-TYPE 2560 SYNTAX IppmOwnerString 2561 MAX-ACCESS not-accessible 2562 STATUS current 2563 DESCRIPTION 2564 "The owner who has configured this report entry." 2565 ::= { ippmReportSetupEntry 1 } 2567 ippmReportSetupIndex OBJECT-TYPE 2568 SYNTAX Integer32 (1.. 65535) 2569 MAX-ACCESS not-accessible 2570 STATUS current 2571 DESCRIPTION 2572 "The owner index of the report entry. The value is managed by the 2573 owner." 2574 ::= { ippmReportSetupEntry 2 } 2576 ippmReportSetupMeasureOwner OBJECT-TYPE 2577 SYNTAX IppmOwnerString 2578 MAX-ACCESS read-create 2579 STATUS current 2580 DESCRIPTION 2581 "The owner of the measure to report." 2582 ::= { ippmReportSetupEntry 3 } 2584 ippmReportSetupMeasureIndex OBJECT-TYPE 2585 SYNTAX Integer32 (1.. 65535) 2586 MAX-ACCESS read-create 2587 STATUS current 2588 DESCRIPTION 2589 "The index of the measure to report." 2590 ::= { ippmReportSetupEntry 4 } 2592 ippmReportSetupMeasureMetric OBJECT-TYPE 2593 SYNTAX Integer32 (1.. 65535) 2594 MAX-ACCESS read-create 2595 STATUS current 2596 DESCRIPTION 2597 "The metric of the measure to report." 2598 ::= { ippmReportSetupEntry 5 } 2600 ippmReportSetupDefinition OBJECT-TYPE 2601 SYNTAX IppmReportDefinition 2602 MAX-ACCESS read-create 2603 STATUS current 2604 DESCRIPTION 2605 "In order to properly define a report, one must provide 2606 information to: 2607 + Select the events to consider for reporting; 2608 + Configure filters to select pertinent values; 2609 + Describe the way the report is delivered; 2610 + Describe clean up actions to perform on report completion; 2612 The format of a report sent to a NMS is described in a 2613 notification defined in the ippmNotifications node. 2615 The event and the filter selected in the report definition 2616 determines the notification to refer: 2617 + Up and Down filter report format is ippmUpAndDownReport; 2618 + Inband filter report format is ippmInBandReport; 2619 + Outband filter report format is ippmOutBandReport; 2620 + Above filter report format is ippmAboveReport; 2621 + Below filter report format is ippmBelowReport; 2622 + Any filter and reportExceededEventsDuration report format is 2623 ippmEventsDurationExceededReport; 2624 + Any filter and the event onMeasureCompletion report format is 2625 ippmCompletedMeasureReport; 2627 Example 1: 2628 Consider a report definition, which reports on the fly, up and 2629 down result events of a metric measure: 2631 ippmReportSetupDefinition { 2632 onSingleton, 2633 reportUpAndDownMetricResults, 2634 inSNMPv2TrapPDU 2635 } 2637 The value of the threshold is given by 2638 ippmReportSetupUpDownThreshold. It has the value '5' in this 2639 example. 2641 Being a flow of results { 3.3 3.2 3.2 5.1 5.3 5.6 6.3 5.2 4.0 3.8 2642 ...}, the report process will send 2 traps: 2643 + The first one carries the results 3.2 and 5.1 2644 corresponding to a down to up event; 2645 + The second one carries the results 5.2 and 4.0 of the 2646 up to down event 2647 UpAndDown 2649 Example 2: 2650 Consider the report definition, which reports per measure cycle 2651 in a SNMP informRequestPDU, up and down results events of a 2652 metric measure: 2653 : 2655 ippmReportSetupDefinition { 2656 onMeasureCycle, 2657 reportUpAndDownMetricResults, 2658 inInformRequestPDU, 2659 onReportDeliveryClearReport 2660 } 2661 The value of the threshold is given by 2662 ippmReportSetupUpDownThreshold. It has the value '5' in this 2663 example. 2664 The cycle of measure of the measure setup is set to 10 results. 2666 Being a flow of 10 results { 3.3 3.2 3.2 5.1 5.3 5.6 6.3 5.2 4.0 2667 3.8 ... }, the report process will send one InformRequestPDU that 2668 carries the couples (3.2, 5.1) and (5.2 ,4.0) corresponding to 2669 the first down to up event and to the second up to down event, 2670 respectively. 2671 " 2672 ::= { ippmReportSetupEntry 6 } 2674 ippmReportSetupUpDownThreshold OBJECT-TYPE 2675 SYNTAX Integer32 2676 MAX-ACCESS read-create 2677 STATUS current 2678 DESCRIPTION 2679 "An event is generated when the result of the measure exceeds the 2680 value of ippmReportSetupMetricThreshold. 2681 The threshold has the same unit as the metric. The metric unit is 2682 recorded in the object ippmMetricsUnit of this metric entry in 2683 the ippmMetricTable. 2684 " 2685 ::= { ippmReportSetupEntry 7 } 2687 ippmReportSetupLowThreshold OBJECT-TYPE 2688 SYNTAX Integer32 2689 MAX-ACCESS read-create 2690 STATUS current 2691 DESCRIPTION 2692 "An event is generated when the result of the measure of the 2693 metric is lower that the value of ippmReportSetupLowThreshold. 2694 The threshold has the same unit as the metric. The metric unit is 2695 recorded in the object ippmMetricsUnit of this metric entry in 2696 the ippmMetricTable. 2697 " 2698 ::= { ippmReportSetupEntry 8 } 2700 ippmReportSetupHighThreshold OBJECT-TYPE 2701 SYNTAX Integer32 2702 MAX-ACCESS read-create 2703 STATUS current 2704 DESCRIPTION 2705 "An event is generated when the result of the measure of the 2706 metric exceeds the value of ippmReportSetupHighThreshold. 2708 The threshold has the same unit as the metric. The metric unit is 2709 recorded in the object ippmMetricsUnit of this metric entry in 2710 the ippmMetricTable. 2711 " 2712 ::= { ippmReportSetupEntry 9 } 2714 ippmReportSetupDurationThresUnit OBJECT-TYPE 2715 SYNTAX TimeUnit 2716 MAX-ACCESS read-create 2717 STATUS current 2718 DESCRIPTION 2719 "The unit of the duration threshold." 2720 ::= { ippmReportSetupEntry 10 } 2722 ippmReportSetupDurationThreshold OBJECT-TYPE 2723 SYNTAX Integer32 2724 MAX-ACCESS read-create 2725 STATUS current 2726 DESCRIPTION 2727 "An event is generated when contiguous results of the measure are 2728 over the ippmReportSetupUpDownThreshold, during 2729 ippmReportSetupDurationThreshold seconds. 2731 Performance: 2732 To improve the performance of the system, the report process may 2733 be synchronized with the cycle of collection of network measure 2734 or with the period of aggregation of an aggregate measure." 2736 DEFVAL { 15 } 2737 ::= { ippmReportSetupEntry 11 } 2739 ippmReportSetupReportSize OBJECT-TYPE 2740 SYNTAX Integer32 2741 MAX-ACCESS read-create 2742 STATUS current 2743 DESCRIPTION 2744 "Specifies the maximum number of results saved for each metric of 2745 this measure. The history of each metric is managed as a circular 2746 table. The newest result overwrites the oldest one when the 2747 history granted to this metric measure is full. 2749 The management of the results may be optimized if synchronized 2750 with the reports steps of this measure. " 2751 ::= { ippmReportSetupEntry 12 } 2753 ippmReportSetupResultsMgmt OBJECT-TYPE 2754 SYNTAX INTEGER { 2755 wrap(1), 2756 suspend(2), 2757 delete(3) 2758 } 2759 MAX-ACCESS read-create 2760 STATUS current 2761 DESCRIPTION 2762 " 2763 Action to take when the report log is full. The user may choose 2764 to either wrap, in which case the agent writes over existing 2765 records. The user may choose to suspend writing to the log in the 2766 event that he wishes to archive the data. The resume action 2767 causes the agent to begin to write in the report log, and assumes 2768 the data has been cleared 2769 This object indicates the way the measure results are managed 2770 when the owner quota is over: 2771 'wrap' 2772 continue the measure and erase the older entries in the 2773 history. 2774 'suspend' 2775 stop the measure and keep the results in the history. 2776 'delete' 2777 remove the results from the history. 2778 " 2779 ::= { ippmReportSetupEntry 13 } 2781 ippmReportSetupNMS OBJECT-TYPE 2782 SYNTAX SnmpAdminString 2783 MAX-ACCESS read-create 2784 STATUS current 2785 DESCRIPTION 2786 "The recipient of the report may be provided in the setup. By 2787 default the recipient of the report is the owner of the measure. 2788 Its addresses are recorded in the ippmOwnersTable. 2789 The type of ippmReportSetupNMS is not InetAddress because the 2790 report may be sent using SMS or fax. 2791 " 2792 ::= { ippmReportSetupEntry 14 } 2794 ippmReportSetupNotification OBJECT-TYPE 2795 SYNTAX OBJECT IDENTIFIER 2796 MAX-ACCESS read-create 2797 STATUS current 2798 DESCRIPTION 2799 "Even though the notification to use is defined in the report 2800 definition, the object ippmReportSetupNotification provides 2801 flexibility to select another notification. " 2802 -- DEFVAL { 0.0 } 2803 ::= { ippmReportSetupEntry 15 } 2805 ippmReportSetupMap OBJECT-TYPE 2806 SYNTAX SnmpAdminString 2807 MAX-ACCESS read-create 2808 STATUS current 2809 DESCRIPTION 2810 "An administrative name of a map to which the report belongs." 2811 DEFVAL { "" } 2812 ::= { ippmReportSetupEntry 16 } 2814 ippmReportSetupStatus OBJECT-TYPE 2815 SYNTAX RowStatus 2816 MAX-ACCESS read-create 2817 STATUS current 2818 DESCRIPTION 2819 "The status of this table entry. " 2820 ::= { ippmReportSetupEntry 17 } 2822 -- 2823 -- ippmReportTable 2824 -- 2826 ippmReportTable OBJECT-TYPE 2827 SYNTAX SEQUENCE OF IppmReportEntry 2828 MAX-ACCESS not-accessible 2829 STATUS current 2830 DESCRIPTION 2831 "The ippmReportTable logs the results of the reports. The results 2832 consist of a subset of the results of a measure as described in 2833 the report definition. The activation of an up and down filtering 2834 in the report definition limits the results logged to those 2835 corresponding to major events. Otherwise, the ippmReportTable is 2836 identical to the ippmHistoryTable." 2838 ::= { ippmReport 3 } 2840 ippmReportEntry OBJECT-TYPE 2841 SYNTAX IppmReportEntry 2842 MAX-ACCESS not-accessible 2843 STATUS current 2844 DESCRIPTION 2845 "A report is a list of results of a measure. This sample is 2846 associated with the ippmReportSetupEntry which has set up the 2847 report. An ippmReportEntry entry is one of the results of a 2848 measure to report. 2850 An ippmReportEntry entry is one of the results of a measure 2851 identified by ippmReportMeasureOwner, ippmReportMeasureIndex, 2852 ippmReportMetricIndex and ippmReportIndex. 2854 In the index: 2856 + ippmReportMeasureOwner identifies the owner of the measure; 2858 + ippmReportMeasureIndex identifies the measure in the owner 2859 namespace; 2861 + ippmReportMetricIndex identifies the metric measured in 2862 ippmMetricTable; 2864 + ippmReportIndex is the local index of the result on the report 2865 table." 2867 INDEX { ippmReportMeasureOwner, ippmReportMeasureIndex, 2868 ippmReportMetricIndex, ippmReportIndex } 2869 ::= { ippmReportTable 1 } 2871 IppmReportEntry ::= 2872 SEQUENCE { 2873 ippmReportMeasureOwner IppmOwnerString, 2874 ippmReportMeasureIndex Integer32, 2875 ippmReportMetricIndex Integer32, 2876 ippmReportIndex Integer32, 2877 ippmReportSequence Integer32, 2878 ippmReportTimestamp GMTTimeStamp, 2879 ippmReportValue Integer32 2880 } 2882 ippmReportMeasureOwner OBJECT-TYPE 2883 SYNTAX IppmOwnerString 2884 MAX-ACCESS not-accessible 2885 STATUS current 2886 DESCRIPTION 2887 "The owner of the measure that produced this result." 2888 ::= { ippmReportEntry 1 } 2890 ippmReportMeasureIndex OBJECT-TYPE 2891 SYNTAX Integer32 (1.. 65535) 2892 MAX-ACCESS not-accessible 2893 STATUS current 2894 DESCRIPTION 2895 " The owner index of the measure that produced this result." 2896 ::= { ippmReportEntry 2 } 2898 ippmReportMetricIndex OBJECT-TYPE 2899 SYNTAX Integer32 (1.. 65535) 2900 MAX-ACCESS not-accessible 2901 STATUS current 2902 DESCRIPTION 2903 " ippmReportMetricIndex identifies the metric measured by the 2904 measure. The metric is described in the corresponding entry of 2905 the ippmMetricTable." 2906 ::= { ippmReportEntry 3 } 2908 ippmReportIndex OBJECT-TYPE 2909 SYNTAX Integer32 (1.. 65535) 2910 MAX-ACCESS not-accessible 2911 STATUS current 2912 DESCRIPTION 2913 "The local index of the result of a metric measure" 2914 ::= { ippmReportEntry 4 } 2916 ippmReportSequence OBJECT-TYPE 2917 SYNTAX Integer32 (0.. 65535) 2918 MAX-ACCESS read-only 2919 STATUS current 2920 DESCRIPTION 2922 " ippmReportSequence is the sequence index of the measurement 2923 results of the measure of a metric. 2925 Network metrics: 2927 It's the sequence index of a measurement packet. Typically, it 2928 identifies the order of the packet in the stream of packets sends 2929 by the source. 2931 Aggregated metrics: 2933 It is the sequence index of the aggregated metric results 2934 computed." 2935 ::= { ippmReportEntry 5 } 2937 ippmReportTimestamp OBJECT-TYPE 2938 SYNTAX GMTTimeStamp 2939 MAX-ACCESS read-only 2940 STATUS current 2941 DESCRIPTION 2942 "The instant of the measure of the result." 2943 ::= { ippmReportEntry 6 } 2945 ippmReportValue OBJECT-TYPE 2946 SYNTAX Integer32 2947 MAX-ACCESS read-only 2948 STATUS current 2949 DESCRIPTION 2950 "The value." 2951 ::= { ippmReportEntry 7 } 2953 -- 2954 -- IPPM Notifications 2955 -- 2957 ippmUpAndDownReport NOTIFICATION-TYPE 2958 OBJECTS { 2959 ippmReportSetupDefinition, 2960 ippmMetricType, 2961 ippmMetricUnit, 2962 ippmMetricDescription, 2963 ippmHistoryTimestamp, 2964 ippmHistorySequence, 2965 ippmHistoryValue, 2966 ippmReportPathToResults 2967 } 2968 STATUS current 2969 DESCRIPTION 2970 "A notification sent because 2 contiguous results are on opposite 2971 sides of the metric threshold value. 2973 The notification contains the instances of the ippmHistoryValue 2974 object that exceeded the threshold. 2975 The notification contains the instances of the 2976 ippmHistoryTimestamp identifying the time the event occurred. 2977 ippmReportPathToResults is a link to the file name, which 2978 contains detailled results corresponding to this event." 2979 ::= { ippmNotifications 1 } 2981 ippmInBandReport NOTIFICATION-TYPE 2982 OBJECTS { 2983 ippmReportSetupDefinition, 2984 ippmMetricType, 2985 ippmMetricUnit, 2986 ippmMetricDescription, 2987 ippmHistoryTimestamp, 2988 ippmHistorySequence, 2989 ippmHistoryValue, 2990 ippmReportPathToResults 2991 } 2992 STATUS current 2993 DESCRIPTION 2994 "A notification sent because the value of the measure is under 2995 the high threshold value and greater than the low threshold 2996 value. 2997 The notification contains the instances of the ippmHistoryValue 2998 object that exceeded the threshold. 2999 The notification contains the instances of the 3000 ippmHistoryTimestamp identifying the time the event occurred. 3001 ippmReportPathToResults is a link to the file name, which 3002 contains detailled results corresponding to this event." 3003 ::= { ippmNotifications 2 } 3005 ippmOutBandReport NOTIFICATION-TYPE 3006 OBJECTS { 3007 ippmReportSetupDefinition, 3008 ippmMetricType, 3009 ippmMetricUnit, 3010 ippmMetricDescription, 3011 ippmHistoryTimestamp, 3012 ippmHistorySequence, 3013 ippmHistoryValue, 3014 ippmReportPathToResults 3015 } 3016 STATUS current 3017 DESCRIPTION 3018 "A notification sent because the result of the measure is either 3019 greater than the high threshold or lower than the low threshold. 3020 The notification contains the instances of the ippmHistoryValue 3021 object that exceeded the threshold. 3022 The notification contains the instances of the 3023 ippmHistoryTimestamp identifying the time the event occurred. 3024 ippmReportPathToResults is a link to the file name, which 3025 contains detailled results corresponding to this event." 3026 ::= { ippmNotifications 3 } 3028 ippmAboveReport NOTIFICATION-TYPE 3029 OBJECTS { 3030 ippmReportSetupDefinition, 3031 ippmMetricType, 3032 ippmMetricUnit, 3033 ippmMetricDescription, 3034 ippmHistoryTimestamp, 3035 ippmHistorySequence, 3036 ippmHistoryValue, 3037 ippmReportPathToResults 3038 } 3039 STATUS current 3040 DESCRIPTION 3041 " The notification contains the instances of the ippmHistoryValue 3042 object that exceeded the threshold. 3044 The notification contains the instances of the 3045 ippmHistoryTimestamp identifying the time the event occurred. 3046 ippmReportPathToResults is a link to the file name, which 3047 contains detailled results corresponding to this event." 3048 ::= { ippmNotifications 4 } 3050 ippmBelowReport NOTIFICATION-TYPE 3051 OBJECTS { 3052 ippmReportSetupDefinition, 3053 ippmMetricType, 3054 ippmMetricUnit, 3055 ippmMetricDescription, 3056 ippmHistoryTimestamp, 3057 ippmHistorySequence, 3058 ippmHistoryValue, 3059 ippmReportPathToResults 3060 } 3061 STATUS current 3062 DESCRIPTION 3063 " 3064 The notification contains the instances of the ippmHistoryValue 3065 object that exceeded the threshold. 3066 The notification contains the instances of the 3067 ippmHistoryTimestamp identifying the time the event occurred. 3068 ippmReportPathToResults is a link to the file name, which 3069 contains detailled results corresponding to this event." 3070 ::= { ippmNotifications 5 } 3072 ippmEventsDurationExceededReport NOTIFICATION-TYPE 3073 OBJECTS { 3074 ippmReportSetupDefinition, 3075 ippmMetricType, 3076 ippmMetricUnit, 3077 ippmMetricDescription, 3078 ippmHistoryTimestamp, 3079 ippmHistorySequence, 3080 ippmHistoryValue 3081 } 3082 STATUS current 3083 DESCRIPTION 3084 "A notification sent when the duration of continuously rising 3085 metric threshold exceeds the ippmReportSetupDurationThreshold 3086 value. 3088 The notification contains the instances of the ippmReportValue 3089 object that exceeded the threshold. 3091 The notification contains the instances of the 3092 ippmReportTimestamp identifying the time the event occurred. 3093 ippmReportPathToResults is a link to the file name, which 3094 contains detailled results corresponding to this event. 3095 " 3096 ::= { ippmNotifications 6 } 3098 ippmCompletedMeasureReport NOTIFICATION-TYPE 3099 OBJECTS { 3100 ippmReportSetupDefinition, 3101 ippmMetricType, 3102 ippmMetricUnit, 3103 ippmMetricDescription, 3104 ippmHistoryTimestamp, 3105 ippmHistorySequence, 3106 ippmHistoryValue, 3107 ippmReportPathToResults 3108 } 3109 STATUS current 3110 DESCRIPTION 3111 "A notification sent when a measure completes. 3112 The index of the included ippmReportSetupDefinition object 3113 identifies the ippmMeasureEntry and the ippmResultSetupEntry that 3114 specified the report. 3116 ippmReportPathToResults is a link to the file name, which 3117 contains the results of this measure cycle." 3118 ::= { ippmNotifications 7 } 3120 ippmAggrMeasureHistoryFull NOTIFICATION-TYPE 3121 OBJECTS { 3122 ippmAggrMeasureName, 3123 ippmMetricType, 3124 ippmMetricUnit, 3125 ippmMetricDescription, 3126 ippmHistoryTimestamp, 3127 ippmHistorySequence, 3128 ippmHistoryValue 3130 } 3131 STATUS current 3132 DESCRIPTION 3133 " A notification sent when the size of the history of a metric of 3134 a aggregated measure exceeds ippmAggrMeasureHistorySize. The 3135 agent will then manage the reports according to the policy 3136 described in ippmAggrMeasureResultsMgmt." 3137 ::= { ippmNotifications 8 } 3139 ippmNetMeasureHistoryFull NOTIFICATION-TYPE 3140 OBJECTS { 3141 ippmNetMeasureName, 3142 ippmMetricType, 3143 ippmMetricUnit, 3144 ippmMetricDescription, 3145 ippmHistoryTimestamp, 3146 ippmHistorySequence, 3147 ippmHistoryValue 3149 } 3150 STATUS current 3151 DESCRIPTION 3152 " A notification sent when the size of the history of a metric of 3153 a network measure exceeded ippmNetMeasureHistorySize. Then the 3154 agent manages the records according to the policy described in 3155 ippmNetMeasureResultsMgmt." 3156 ::= { ippmNotifications 9 } 3158 ippmReportLogFull NOTIFICATION-TYPE 3159 OBJECTS { 3160 -- iIppmReportMetricIndex, 3161 ippmReportSetupResultsMgmt, 3162 ippmReportTimestamp, 3163 ippmReportSequence, 3164 ippmReportValue 3165 } 3166 STATUS current 3167 DESCRIPTION 3168 "A notification sent when the size of the report of a metric of a 3169 measure exceeded ippmReportSetupReportSize. Then the agent 3170 manages the reports according to the policy described in 3171 ippmReportSetupResultsMgmt." 3172 ::= { ippmNotifications 10 } 3174 -- 3175 -- IPPM MIB Conformance statements 3176 -- 3178 ippmCompliances OBJECT IDENTIFIER ::={ ippmConformance 1 } 3180 ippmGroups OBJECT IDENTIFIER ::={ ippmConformance 2 } 3182 ippmProxyInterDomainCompliances MODULE-COMPLIANCE 3183 STATUS current 3184 DESCRIPTION 3185 "The compliance statement for SNMP entities which implement the 3186 IPPM MIB as a proxy in interdomain. The implementation of the 3187 VACM control is mandatory." 3189 MODULE -- this module 3190 MANDATORY-GROUPS { 3191 ippmSystemGroup, ippmNetMeasureGroup, ippmHistoryGroup, 3192 ippmAggrMeasureGroup, ippmReportGroup, ippmNotificationGroup 3193 } 3194 ::= { ippmCompliances 1 } 3196 ippmProxyCompliances MODULE-COMPLIANCE 3197 STATUS current 3198 DESCRIPTION 3199 "The compliance statement for SNMP entities which implement the 3200 IPPM MIB as a proxy." 3201 MODULE -- this module 3202 MANDATORY-GROUPS { 3203 ippmSystemGroup, ippmNetMeasureGroup, ippmHistoryGroup, 3204 ippmAggrMeasureGroup, ippmReportGroup, ippmNotificationGroup 3205 } 3206 GROUP ippmOwnersGroup 3207 DESCRIPTION 3208 "The ippmOwnersGroup is needed if VACM is not implemented." 3209 ::= { ippmCompliances 2 } 3211 ippmProbeCompliances MODULE-COMPLIANCE 3212 STATUS current 3213 DESCRIPTION 3214 "The compliance statement for SNMP entities which implement the 3215 IPPM MIB in a probe." 3216 MODULE -- this module 3217 MANDATORY-GROUPS { 3218 ippmSystemGroup, ippmNetMeasureGroup, ippmHistoryGroup 3219 } 3220 ::= { ippmCompliances 3 } 3222 ippmSystemGroup OBJECT-GROUP 3223 OBJECTS { 3224 ippmSystemSynchronizationDesc, 3225 ippmSystemTime, 3226 ippmSystemSynchronizationType, 3227 ippmSystemClockResolution, 3228 ippmSynchronizationTime, 3229 ippmSynchronizationStratum, 3230 ippmSynchronizationResolution, 3231 ippmPointOfMeasureMgmtAddrType, 3232 ippmPointOfMeasureMgmtAddress, 3233 ippmPointOfMeasureTypePAddress, 3234 ippmPointOfMeasureAddress, 3235 ippmSystemOperationalStatus, 3236 ippmPointOfMeasureMetrics, 3237 ippmMetricCapabilities, 3238 ippmMetricType, 3239 ippmMetricUnit, 3240 ippmMetricDescription 3241 } 3242 STATUS current 3243 DESCRIPTION 3244 "The IPPM System Group" 3245 ::= { ippmGroups 1} 3247 ippmNetMeasureGroup OBJECT-GROUP 3248 OBJECTS { 3249 ippmNetMeasureName, 3250 ippmNetMeasureMetrics, 3251 ippmNetMeasureBeginTime, 3252 ippmNetMeasureCollectionRateUnit, 3253 ippmNetMeasureCollectionRate, 3254 ippmNetMeasureDurationUnit, 3255 ippmNetMeasureDuration, 3256 ippmNetMeasureHistorySize, 3257 ippmNetMeasureFailureMgmtMode, 3258 ippmNetMeasureResultsMgmt, 3259 ippmNetMeasureSrcTypeP, 3260 ippmNetMeasureSrc, 3261 ippmNetMeasureDstTypeP, 3262 ippmNetMeasureDst, 3263 ippmNetMeasureTxMode, 3264 ippmNetMeasureTxPacketRateUnit, 3265 ippmNetMeasureTxPacketRate, 3266 ippmNetMeasureDevtnOrBurstSize, 3267 ippmNetMeasureMedOrIntBurstSize, 3268 ippmNetMeasureLossTimeout, 3269 ippmNetMeasureL3PacketSize, 3270 ippmNetMeasureDataPattern, 3271 ippmNetMeasureMap, 3272 ippmNetMeasureSingletons, 3273 ippmNetMeasureOperState 3274 } 3275 STATUS current 3276 DESCRIPTION 3277 "The IPPM Network Measure Group" 3278 ::= { ippmGroups 3} 3280 ippmHistoryGroup OBJECT-GROUP 3281 OBJECTS { 3282 ippmHistorySequence, 3283 ippmHistoryTimestamp, 3284 ippmHistoryValue 3286 } 3287 STATUS current 3288 DESCRIPTION 3289 "The IPPM History Group" 3290 ::= { ippmGroups 4} 3292 ippmAggrMeasureGroup OBJECT-GROUP 3293 OBJECTS { 3294 ippmAggrMeasureName, 3295 ippmAggrMeasureMetrics, 3296 ippmAggrMeasureBeginTime, 3297 ippmAggrMeasureAggrPeriodUnit, 3298 ippmAggrMeasureAggrPeriod, 3299 ippmAggrMeasureDurationUnit, 3300 ippmAggrMeasureDuration, 3301 ippmAggrMeasureHistorySize, 3302 ippmAggrMeasureStorageType, 3303 ippmAggrMeasureHistoryOwner, 3304 ippmAggrMeasureHistoryOwnerIndex, 3305 ippmAggrMeasureHistoryMetric, 3306 ippmAggrMeasureAdminState, 3307 ippmAggrMeasureFastReport, 3308 ippmAggrMeasureMap, 3309 ippmAggrMeasureResultsMgmt, 3310 ippmAggrMeasureStatus 3311 } 3312 STATUS current 3313 DESCRIPTION 3314 "The IPPM AggregatedMeasure Group" 3315 ::= { ippmGroups 5} 3317 ippmReportGroup OBJECT-GROUP 3318 OBJECTS { 3319 ippmReportSetupMeasureOwner, 3320 ippmReportSetupMeasureIndex, 3321 ippmReportSetupMeasureMetric, 3322 ippmReportSetupDefinition, 3323 ippmReportSetupUpDownThreshold, 3324 ippmReportSetupLowThreshold, 3325 ippmReportSetupHighThreshold, 3326 ippmReportSetupDurationThresUnit, 3327 ippmReportSetupDurationThreshold, 3328 ippmReportSetupReportSize, 3329 ippmReportSetupResultsMgmt, 3330 ippmReportSetupNMS, 3331 ippmReportSetupNotification, 3332 ippmReportSetupMap, 3333 ippmReportSetupStatus, 3334 ippmReportPathToResults, 3335 ippmReportSequence, 3336 ippmReportTimestamp, 3337 ippmReportValue 3338 } 3339 STATUS current 3340 DESCRIPTION 3341 "The IPPM Report Group" 3342 ::= { ippmGroups 6} 3344 ippmOwnersGroup OBJECT-GROUP 3345 OBJECTS { 3346 ippmOwnersOwner, 3347 ippmOwnersGrantedMetrics, 3348 ippmOwnersQuota, 3349 ippmOwnersIpAddressType, 3350 ippmOwnersIpAddress, 3351 ippmOwnersEmail, 3352 ippmOwnersSMS, 3353 ippmOwnersStatus 3354 } 3355 STATUS current 3356 DESCRIPTION 3357 "The IPPM Owners Group" 3358 ::= { ippmGroups 7} 3360 ippmNotificationGroup NOTIFICATION-GROUP 3361 NOTIFICATIONS { 3362 ippmUpAndDownReport, 3363 ippmInBandReport, 3364 ippmOutBandReport, 3365 ippmAboveReport, 3366 ippmBelowReport, 3367 ippmEventsDurationExceededReport, 3368 ippmCompletedMeasureReport, 3369 ippmAggrMeasureHistoryFull, 3370 ippmNetMeasureHistoryFull, 3371 ippmReportLogFull 3372 } 3373 STATUS current 3374 DESCRIPTION 3375 "The IPPM Notification Group" 3376 ::= { ippmGroups 8} 3378 END 3380 8 Security Considerations 3382 8.1 VACM Access control 3383 View Based Access Control, or VACM may be used to restrict access to 3384 certain objects, or even object instances within tables. For example, 3385 one may: 3387 + Give an 'administrator' write access to the ippmOwnersTable, 3388 whereas all other users may only have read access 3389 + Give access to individual rows in the network measure, aggregated 3390 measure, history, and report table to particular owners based upon 3391 indexing on an 'owners name', and even upon a particular measure. 3392 This will be illustrated below. 3393 + Give access of one owner�s measure, and associated results, to 3394 another owner in order to create an aggregated measure based upon the 3395 results. 3397 8.1.1 Example of implementing VACM control for the IPPM-REPORTING-MIB 3399 The following example illustrates how one could use VACM to restrict 3400 access to particular objects within the MIB. It uses syntax specific 3401 to a particular agent development toolkit, but may be generalized 3402 using the concepts as defined in the VACM MIB. 3404 In this example, we have two NMS users, namely user1=owner1 and 3405 user2=owner2: 3406 1) First we define the two users and their host addresses: 3407 com2sec owner1 owner1computer@ private 3408 com2sec owner2 owner2computer@ private 3410 2) We then define SNMPv2c groups 3411 group owner1 v2c owner1 3412 group owner2 v2c owner2 3413 view notif included ippmNotifications ff 3415 3.1) For the user owner1, we now define the views for which he will 3416 have read access 3417 # covers PointOfMeasureTable SynchronizationTable and all scalars 3418 view owner1read included ippmSystem ff 3419 # covers OwnersTable 3420 view owner1read included ippmOwners ff 3421 # covers MetricsTable 3422 view owner1read included ippmMeasure ff 3423 # covers NetworkMeasureTable 3424 view owner1read included 3425 ippmNetMeasureOwner.6.111.119.110.101.114.49 ff.df.c0 3426 # covers AggrMeasureTable 3427 view owner1read included 3428 ippmAggrMeasureOwner.6.111.119.110.101.114.49 ff.df.c0 3430 3.2) We will now define the views for which owner1 will have write 3431 access 3432 view owner1write included 3433 ippmAggrMeasureOwner.6.111.119.110.101.114.49 ff.df.c0 3435 # covers ReportSetupTable 3436 view owner1read included 3437 ippmReportSetupOwner.6.111.119.110.101.114.49 ff.df.c0 3438 view owner1write included 3439 ippmReportSetupOwner.6.111.119.110.101.114.49 ff.df.c0 3440 # covers HistoryTable 3441 view owner1read included 3442 ippmHistoryMeasureOwner.6.111.119.110.101.114.49 ff.df.c0 3443 # covers ReportTable 3444 view owner1read included 3445 ippmReportOwner.6.111.119.110.101.114.49 ff.df.c0 3447 3.3) For owner2, we will define the views for which he has read 3448 access 3449 view owner2read included ippmSystem ff 3450 view owner2read included ippmOwners ff 3451 view owner2read included ippmMeasure ff 3452 # covers NetworkMeasureTable plus let's say the owner1 network 3453 measure of index X 3454 view owner2read included 3455 ippmNetMeasureOwner.6.111.119.110.101.114.50 ff.df.c0 3456 view owner2read included 3457 ippmNetMeasureOwner.6.111.119.110.101.114.49.X ff.df.e0 3458 # covers AggrMeasureTable plus let's say the OWNER1 aggregated 3459 measure of index Y 3460 view owner2read included 3461 ippmAggrMeasureOwner.6.111.119.110.101.114.50 ff.df.c0 3462 view owner2read included 3463 ippmAggrMeasureOwner.6.111.119.110.101.114.49.Y ff.df.e0 3464 3.4) For owner2, we will define the views for which he has write 3465 access 3466 view owner2write included 3467 ippmAggrMeasureOwner.6.111.119.110.101.114.50 ff.df.c0 3468 # covers ReportSetupTable 3469 view owner2read included 3470 ippmReportSetupOwner.6.111.119.110.101.114.50 ff.df.c0 3471 view owner2write included 3472 ippmReportSetupOwner.6.111.119.110.101.114.50 ff.df.c0 3473 # covers HistoryTable plus OWNER1 related X network measure results 3474 and OWNER1 related Y aggregated measure results 3475 view owner2read included 3476 ippmHistoryMeasureOwner.6.111.119.110.101.114.50 ff.df.c0 3477 view owner2read included 3478 ippmHistoryMeasureOwner.6.111.119.110.101.114.49.X ff.df.e0 3479 view owner2read included 3480 ippmHistoryMeasureOwner.6.111.119.110.101.114.49.Y ff.df.e0 3481 # covers ReportTable 3482 view owner2read included 3483 ippmReportOwner.6.111.119.110.101.114.50 ff.df.c0 3485 3.5) Now we give the two users access to the views defined above. 3486 Note that owner1 and owner2 have read access to owner1read and 3487 owner2read views respectively. They have write access to owner1write 3488 and owner2write view respectively. And they both have access to all 3489 the notifications. 3491 access owner1 "" any noauth exact owner1read 3492 owner1write notif 3493 access owner2 "" any noauth exact owner2read 3494 owner2write notif 3496 8.2 Privacy 3498 The privacy concerns of network measurement are intrinsically limited 3499 by the active measurements. Unlike passive measurements, there can be 3500 no release of existing user data. 3502 8.3 Measurement aspects 3504 Conducting Internet measurements raises both security and privacy 3505 concerns. This memo does not specify an implementation of the 3506 metrics, so it does not directly affect the security of the Internet 3507 nor of applications that run on the Internet. However, 3508 implementations of these metrics must be mindful of security and 3509 privacy concerns. 3511 There are two types of security concerns: potential harm caused by 3512 the measurements, and potential harm to the measurements. The 3513 measurements could cause harm because they are active, and inject 3514 packets into the network. The measurement parameters MUST be 3515 carefully selected so that the measurements inject trivial amounts of 3516 additional traffic into the networks they measure. If they inject 3517 "too much" traffic, they can skew the results of the measurement, and 3518 in extreme cases cause congestion and denial of service. 3520 The measurements themselves could be harmed by routers giving 3521 measurement traffic a different priority than "normal" traffic, or by 3522 an attacker injecting artificial measurement traffic. If routers can 3523 recognize measurement traffic and treat it separately, the 3524 measurements will not reflect actual user traffic. If an attacker 3525 injects artificial traffic that is accepted as legitimate, the loss 3526 rate will be artificially lowered. Therefore, the measurement 3527 methodologies SHOULD include appropriate techniques to reduce the 3528 probability measurement traffic can be distinguished from "normal" 3529 traffic. 3531 Authentication techniques, such as digital signatures, may be used 3532 where appropriate to guard against injected traffic attacks. 3534 8.4 Management aspects 3536 There are a number of management objects defined in this MIB that 3537 have a MAX-ACCESS clause of read-write and/or read-only. Such objects 3538 may be considered sensitive or vulnerable in some network 3539 environments. The support for SET operations in a non-secure 3540 environment without proper protection can have a negative effect on 3541 network operations. 3543 SNMPv1 by itself is not a secure environment. Even if the network 3544 itself is secure (for example by using IPSec), even then, there is no 3545 control as to who on the secure network is allowed to access and 3546 GET/SET (read/change/create/delete) the objects in this MIB. 3548 It is recommended that the implementors consider the security 3549 features as provided by the SNMPv3 framework. Specifically, the use 3550 of the User-based Security Model RFC 2574 [18] and the View-based 3551 Access Control Model RFC 2575 [21] is recommended. 3553 It is then a customer/user responsibility to ensure that the SNMP 3554 entity giving access to an instance of this MIB, is properly 3555 configured to give access to the objects only to those principals 3556 (users) that have legitimate rights to indeed GET or SET 3557 (change/create/delete) them. 3559 9 Document management 3560 9.1 Open issues 3562 Defval 0 for an OID ? 3563 Usage of accessible-for-notify for an index ? 3564 Subtype of InetAddress ? 3566 9.2 Changes done since release 02 3568 + Security/VACM: 3569 sharing table removed; 3570 ippmMeasure merged with networkMeasure and AggrMeasure to have 3571 all networkMeasure objects in read only. 3572 Indexes belong to the table; 3573 remove all reference to SNMPv1 ...inSNMPTrapPDU 3575 + System: 3576 ippmSystemOperationalStatus added 3578 ippmSynchronizationTable adapted for proxy mode: 3579 ippmPointOfMeasureIndex added to the index of 3580 ippmSystemCurrentSynchronization removed from system 3582 capabilities: 3583 ippmPointOfMeasureMetrics added to 3584 IppmPointOfMeasureEntry; 3585 ippmMetricType added to ippmMetricsTable; 3587 + Owners 3588 ippmMetricMaxHistorySize replaced with quota in ippmOwnersTable; 3590 + ippmOnHistoryFullAction replaced with resultsMgmt in aggr and network.; 3592 + network measure: 3593 ippmNetMeasureOperState added to indicate the state of the network 3594 measure 3595 state; 3596 added burst mode; 3597 state of the measure: nb of singletons collected and oper status 3598 added; 3600 +aggregated metric: 3601 fast report added to get raw results by email; 3603 + report setup: 3604 onReportDeliveryClearHistory removed from IppmReportDefinition; 3606 + Map field added to network, aggr and report tables to help to map 3607 on topology map or admin view. 3609 10 References 3611 [1] Bradner, S., "The Internet Standards Process -- Revision 3", BCP 3612 9, RFC 2026, October 1996. 3614 [2] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for 3615 Describing SNMP Management Frameworks", RFC 2571, April 1999. 3617 [3] Rose, M., and K. McCloghrie, "Structure and Identification of 3618 Management Information for TCP/IP-based Internets", STD 16, RFC 3619 1155, May 1990. 3621 [4] Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD 16, 3622 RFC 1212, March 1991. 3624 [5] M. Rose, "A Convention for Defining Traps for use with the SNMP", 3625 RFC 1215, March 1991. 3627 [6] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, 3628 M., and S. Waldbusser, "Structure of Management Information 3629 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 3631 [7] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, 3632 M., and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, 3633 RFC 2579, April 1999. 3635 [8] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, 3636 M., and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, 3637 RFC 2580, April 1999. 3639 [9] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple 3640 Network Management Protocol", STD 15, RFC 1157, May 1990. 3642 [10] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, 3643 "Introduction to Community-based SNMPv2", RFC 1901, January 1996. 3645 [11] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, 3646 "Transport Mappings for Version 2 of the Simple Network Management 3647 Protocol (SNMPv2)", RFC 1906, January 1996. 3649 [12]Case, J., Harrington D., Presuhn R., and B. Wijnen, "Message 3650 Processing and Dispatching for the Simple Network Management 3651 Protocol (SNMP)", RFC 2572, April 1999. 3653 [13] Blumenthal, U., and B. Wijnen, "User-based Security Model (USM) 3654 for version 3 of the Simple Network Management Protocol (SNMPv3)", 3655 RFC 2574, April 1999. 3657 [14] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Protocol 3658 Operations for Version 2 of the Simple Network Management Protocol 3659 (SNMPv2)", RFC 1905, January 1996. 3661 [15] Levi, D., Meyer, P., and B. Stewart, "SNMPv3 Applications", RFC 3662 2573, April 1999. 3664 [16] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-basedAccess 3665 Control Model (VACM) for the Simple Network Management Protocol 3666 (SNMP)", RFC 2575, April 1999. 3668 [17] Case, J., Mundy, R., Partain, D., and B. Stewart, "Introduction 3669 to Version 3 of the Internet-standard Network Management 3670 Framework", RFC 2570, April 1999. 3672 11 Acknowledgments 3674 A Kerbe. 3676 12 Authors Addresses 3678 Emile STEPHAN 3679 France Telecom R & D 3680 2 avenue Pierre Marzin 3681 F-22307 Lannion cedex 3682 Phone: (+ 33) 2 96 05 11 11 3683 Email: emile.stephan@francetelecom.com 3685 Jessie Jewitt 3686 France Telecom R & D 3687 801 Gateway Blvd. Suit 500 3688 South San Francisco, CA 94080 3689 Tel : 1 650 875-1524 3690 Email : jessie.jewitt@francetelecom.com 3692 Full Copyright Statement 3694 "Copyright (C) The Internet Society (2001). All Rights Reserved. 3696 This document and translations of it may be copied and furnished to 3697 others, and derivative works that comment on or otherwise explain it 3698 or assist its implementation may be prepared, copied, published and 3699 distributed, in whole or in part, without restriction of any kind, 3700 provided that the above copyright notice and this paragraph are 3701 included on all such copies and derivative works. However, this 3702 document itself may not be modified in any way, such as by removing 3703 the copyright notice or references to the Internet Society or other 3704 Internet organizations, except as needed for the purpose of 3705 developing Internet standards in which case the procedures for 3706 copyrights defined in the Internet Standards process must be 3707 followed, or as required to translate it into languages other than 3708 English. 3710 The limited permissions granted above are perpetual and will not be 3711 revoked by the Internet Society or its successors or assigns. 3713 This document and the information contained herein is provided on an 3714 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 3715 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 3716 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 3717 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 3718 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.