idnits 2.17.1 draft-ietf-manet-report-mib-04.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 607 has weird spacing: '...oup and b) ad...' == Line 909 has weird spacing: '...entTime sysU...' == Line 1009 has weird spacing: '...entTime sys...' == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document date (December 7, 2014) is 3426 days in the past. Is this intentional? Checking references for intended status: Experimental ---------------------------------------------------------------------------- ** Obsolete normative reference: RFC 2021 (Obsoleted by RFC 4502) Summary: 1 error (**), 0 flaws (~~), 5 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force R. Cole 3 Internet-Draft US Army CERDEC 4 Intended status: Experimental J. Macker 5 Expires: June 10, 2015 Naval Research Laboratory 6 A. Bierman 7 YumaWorks, Inc. 8 December 7, 2014 10 Definition of Managed Objects for Performance Reporting 11 draft-ietf-manet-report-mib-04 13 Abstract 15 This memo defines a portion of the Management Information Base (MIB) 16 for use with network management protocols in the Internet community. 17 In particular, it describes objects for configuring autonomous report 18 generation on any device that supports MIBs containing objects that 19 resolve to type Integer32 (i.e., Integer32, Counter, Gauge, or 20 TimeTicks). to be used for performance monitoring. This allows a 21 management station to instruct a device to build off-line reports to 22 be collected either through notifications to the management station 23 or queried asynchronously by the management station. Hence, this 24 capability allows network operators to reduce the SNMP polling 25 traffic burden on Mobile Ad-Hoc and Disruption Tolerant Networks 26 which is problematic of SNMP performance management applications. 28 Status of This Memo 30 This Internet-Draft is submitted in full conformance with the 31 provisions of BCP 78 and BCP 79. 33 Internet-Drafts are working documents of the Internet Engineering 34 Task Force (IETF). Note that other groups may also distribute 35 working documents as Internet-Drafts. The list of current Internet- 36 Drafts is at http://datatracker.ietf.org/drafts/current/. 38 Internet-Drafts are draft documents valid for a maximum of six months 39 and may be updated, replaced, or obsoleted by other documents at any 40 time. It is inappropriate to use Internet-Drafts as reference 41 material or to cite them other than as "work in progress." 43 This Internet-Draft will expire on June 10, 2015. 45 Copyright Notice 47 Copyright (c) 2014 IETF Trust and the persons identified as the 48 document authors. All rights reserved. 50 This document is subject to BCP 78 and the IETF Trust's Legal 51 Provisions Relating to IETF Documents 52 (http://trustee.ietf.org/license-info) in effect on the date of 53 publication of this document. Please review these documents 54 carefully, as they describe your rights and restrictions with respect 55 to this document. Code Components extracted from this document must 56 include Simplified BSD License text as described in Section 4.e of 57 the Trust Legal Provisions and are provided without warranty as 58 described in the Simplified BSD License. 60 Table of Contents 62 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 63 2. The Internet-Standard Management Framework . . . . . . . . . . 3 64 3. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 4 65 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 66 4.1. reportSampledMIB Module Management Model . . . . . . . . . 4 67 4.2. Terms . . . . . . . . . . . . . . . . . . . . . . . . . . 5 68 5. Structure of the MIB Module . . . . . . . . . . . . . . . . . 6 69 5.1. Textual Conventions . . . . . . . . . . . . . . . . . . . 7 70 5.2. Tables and Indexing . . . . . . . . . . . . . . . . . . . 7 71 6. Relationship to Other MIB Modules . . . . . . . . . . . . . . 8 72 6.1. Relationship to the SNMPv2-MIB . . . . . . . . . . . . . . 8 73 6.2. Relationship to the RMON2-MIB . . . . . . . . . . . . . . 9 74 6.3. Relationship to the DISMAN-EVENT-MIB . . . . . . . . . . . 9 75 6.4. Relationship to the DISMAN-EXPRESSION-MIB . . . . . . . . 10 76 6.5. MIB modules required for IMPORTS . . . . . . . . . . . . . 10 77 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 11 78 8. Security Considerations . . . . . . . . . . . . . . . . . . . 26 79 9. Applicability Statement . . . . . . . . . . . . . . . . . . . 29 80 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 30 81 11. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 30 82 12. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 30 83 13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 30 84 13.1. Normative References . . . . . . . . . . . . . . . . . . . 30 85 13.2. Informative References . . . . . . . . . . . . . . . . . . 31 86 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 31 87 Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . . 33 88 Appendix C. . . . . . . . . . . . . . . . . . . . . . . . . . . 34 90 1. Introduction 92 This memo defines a portion of the Management Information Base (MIB) 93 for use with network management protocols in the Internet community. 94 In particular, it describes objects for configuring autonomous, off- 95 line report generation for performance monitoring on any device 96 supporting MIBs containing variables that resolve to type Integer32 97 (i.e., Integer32, Counter, Gauge, or TimeTicks). This 98 reportSampledMIB module allows for the report generation to occur on 99 the same device as containing the referenced counter object. This 100 should be useful to devices or networks where efficient use of 101 bandwidth is of concern or where intermittent connectivity is common. 102 Hence, the reportSampledMIB module is useful for devices managed over 103 some Mobile Ad-Hoc Networks (MANETs) or Disruption Tolerant Networks 104 (DTNs). 106 This version of the reportSampledMIB module offers one type of off- 107 line reporting. The MIB offers a means to collect sampled 108 measurements related to defined MIB objects. This type of reporting 109 is contained in the reportSampledMibObjects. Other types of report 110 data are possible, including statistical data. However, it was felt 111 wise to focus on a more limited scope off-line reporting capability 112 and gain experimental use and application prior to expending energy 113 developing a more extensive off line reporting capability. 115 The reportSampledMIB module relies upon the dismanEventMIB module RFC 116 2981 [RFC2981] to monitor the progress of reports being developed 117 within the reportSampledMIB module and to trigger an events, i.e., 118 notifications containing reports, at the appropriate times. This is 119 discussed below in more detail in the section entitled 'Relationship 120 to the DISMAN-EVENT-MIB'. Further, more sophisticated performance 121 objects for monitoring from the reportSampledMIB module can be 122 defined through the dismanExpressionMIB module RFC 2982 [RFC2982] 124 2. The Internet-Standard Management Framework 126 For a detailed overview of the documents that describe the current 127 Internet-Standard Management Framework, please refer to section 7 of 128 RFC 3410 [RFC3410]. 130 Managed objects are accessed via a virtual information store, termed 131 the Management Information Base or MIB. MIB objects are generally 132 accessed through the Simple Network Management Protocol (SNMP). 133 Objects in the MIB are defined using the mechanisms defined in the 134 Structure of Management Information (SMI). This memo specifies a MIB 135 module that is compliant to the SMIv2, which is described in STD 58, 136 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 137 [RFC2580]. 139 3. Conventions 141 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 142 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 143 document are to be interpreted as described in RFC 2119 [RFC2119]. 145 4. Overview 147 The reportSampledMIB module references performance objects in other 148 MIBs and generates off-line performance reports related to those 149 referenced objects. The reportSampledMIB module can be coincident 150 with the other MIB modules on the same device containing the 151 referenced performance related object. 153 4.1. reportSampledMIB Module Management Model 155 This section describes the management model for the reportSampledMIB 156 module process. 158 The reportSampledMIB module objects are primarily contained within 159 four tables. These are: 161 o reportSampledControlTable - this is the control table within the 162 reportSampledMIB module. This identifies the OIDs to be monitored 163 which define the core of the Reports. The control table sets the 164 sampling frequency for the Measurements and the number of 165 Measurements that will define each Report. 167 o reportSampledCurrentReportsStatusTable - This table tracks the 168 status, i.e., the current number of collected Measurements per 169 each Study. This information can be used by the dismanEventMIB 170 module to determine when to trigger a notification to the Report 171 owner containing the Measurements and associated data comprising 172 the just completed Report. 174 o reportSampledCurrentReportsTable - This table holds the 175 Measurements for the Reports which are in current development. 177 o reportSampledHistoricalReportsTable - This table holds the 178 completed Reports for each Study for archival purposes, i.e., the 179 Study owners can perform table walks to retrieve archived Reports 180 or Studies. 182 The below figure illustrates the four main tables within the 183 reportSampledMIB module. Further, if the dismanEventMIB module is so 184 configured to generate triggered notifications, the below figure 185 highlights the 'boolean trigger' and the notification generation. 186 The figure further illustrates the movement of completed Reports from 187 the reportSampledCurrentReportsTable to the 188 reportSampledHistoricalReportsTable upon Report Completion. 190 +---------------------------------------------------+ 191 | reportSampledControlEntry | 192 | { reportSampledStudyStudyIndex } | 193 | | 194 | | 195 | reportSampledStudyNumberReportMeasurements------>----+ 196 +---------------------------------------------------+ | 197 (boolean 198 +---------------------------------------------------+ trigger)->--+ 199 | reportSampledCurrentReportsStatusEntry | | | 200 | { reportSampledStudyStudyIndex } | | | 201 | | | | 202 | | | | 203 | reportSampledNumberOfMeasurementsForCurrentReport--->---+ | 204 +---------------------------------------------------+ | 205 V 206 +---------------------------------------------------+ | 207 | reportSampledCurrentReportsEntry | | 208 | { reportSampledStudyStudyIndex, |---->--------+ 209 | reportSampledCurrentMeasurementIndex } | | 210 | |-->---+ | 211 +---------------------------------------------------+ | | 212 (move) | 213 +---------------------------------------------------+ | | 214 | reportSampledHistoricalReportsEntry | | | 215 | { reportSampledStudyStudyIndex, | | | 216 | reportSampledHistoricalReportIndex, |<--+ | 217 | reportSampledHistoricalMeasurementIndex } | | 218 | | | 219 +---------------------------------------------------+ | 220 V 221 (notifications) 223 4.2. Terms 225 The following definitions apply throughout this document: 227 o Sampled - periodic measurement of target OIDs. 229 o Measurement - a single instance of a sampling event. 231 o Report - a collection of consecutive Measurements on the same 232 Sampled target OID. 234 o Study - a series of Reports on the same Sampled target OID. 236 o Current Report - a Report which is in the process of being 237 developed. 239 o A Completed Report - contains a pre-defined number of Sampled 240 Measurements. 242 o Historical Report - a Report which has previously Completed, and 243 is being stored locally for archival purposes. 245 5. Structure of the MIB Module 247 This section presents the structure of the reportSampledMIB module. 248 The objects are arranged into the following groups: 250 o reportSampledMibNotifications - defines the notifications 251 associated with the reportSampledMIB module. These objects define 252 notifications which track the behavior of the reportSampledMib 253 module. A single notification is defined in the reportSampledMIB 254 module which reports a series of failed measurement attempts in 255 the process of building a Report. Associated with this 256 notification is a control object which defines a threshold of 257 failures which would initiate the notification. These 258 notifications do not cover the triggered notifications which carry 259 the performance Reports generated by the reportSampledMib module. 260 These triggered notifications are defined through the use of the 261 dismanEventMIB module. 263 o reportSampledMibObjects - defines the objects forming the basis 264 for the reportSampledMIB module. These objects are basically 265 divided up by function into the following four tables: 267 * reportSampledControlTable - This group contains the objects 268 which support the generation (collection) of Studies comprising 269 of Reports exposing sampled Measurement values. 271 * reportSampledCurrentReportsStatusTable - This group contains 272 the objects which track the collection of Measurements for 273 current (in-progress) Reports. This table allows the 274 dismanEventMIB module to set triggers for Completed Reports 275 which it can then send to the report owner through triggered 276 notifications. 278 * reportSampledCurrentReportsTable - This group contains the 279 objects which represent the Measurement data associated with 280 Current (in-progress) Reports. Once the Report completes, it 281 is moved to the reportSampledHistoricalReportsTable for 282 archival purposes. 284 * reportSampledHistoricalReportsTable - This group contains the 285 objects which represent archived Completed Reports. This 286 allows the report owners to asynchronously retrieve Reports via 287 table walks if so desired. 289 o reportSampledMibConformance - Defines a single basic conformance 290 of implementations of this reportSampledMIB module. 292 5.1. Textual Conventions 294 No textual conventions are defined in the reportSampledMIB module. 296 5.2. Tables and Indexing 298 The reportSampledMIB module contains four tables which control and 299 record data related to the creation, notification and storage of 300 Reports. Specifically: 302 o the control and generation of remote performance Reports, i.e., 303 reportSampledControlTable 305 o the status of the Current Reports' development, i.e., 306 reportSampledCurrentReportsStatusTable, 308 o the Current Reports development and interim data, i.e., 309 reportSampledCurrentReportsTable, and 311 o the historical storage of remote performance Reports, i.e. 312 reportSampledHistoricalReportsTable. 314 The reportSampledMIB module's tables are indexed via the following 315 constructs: 317 o reportSampledStudyIndex - an index that uniquely identifies a 318 particular Study. The Study is comprised of multiple Reports, the 319 number of Reports being stored is defined by the 320 reportSampledStudyMaximumNumberOfHistoricalReports object. 322 o reportSampledCurrentMeasurementIndex - an index that uniquely 323 identifies an atomic Measurement associated with a Report. 325 o reportSampledHistoricalReportIndex - an index that uniquely 326 identifies an archived Completed Report resident within the 327 reportSampledHistoricalReportsTable. 329 o reportSampledHistoricalMeasurementIndex - an index that uniquely 330 identifies an atomic Measurement comprising an archived Completed 331 Report. 333 These tables and their indexing are: 335 o reportSampledControlTable - this table contains a list of data- 336 collection configuration entries defining aspects of the studies 337 and their reports to be generated. These include, e.g., number of 338 reports per study, the number Reports to be archived, etc. This 339 table has 'INDEX { reportSampledStudyIndex }'. 341 o reportSampledCurrentReportsStatusTable - this table contains 342 objects which track the development of current Reports, e.g., the 343 number of current Measurements collected for each Report under 344 development. This table has 'INDEX { reportSampledStudyIndex }'. 345 For each (active) Study, there exists only one Current Report 346 under development. 348 o reportSampledCurrentReportsTable - this table contains the 349 Measurements which are developing the Current Reports. This table 350 has 'INDEX { reportSampledStudyIndex, 351 reportSampledCurrentMeasurementIndex }'. 353 o reportSampledHistoricalReportsTable - this table contains the 354 Reports which have completed. This table has 'INDEX { 355 reportSampledStudyIndex, reportSampledHistoricalReportIndex, 356 reportSampledHistoricalMeasurementIndex }'. 358 6. Relationship to Other MIB Modules 360 The text of this section specifies the relationship of the MIB 361 modules contained in this document to other standards, particularly 362 to standards containing other MIB modules. Definitions imported from 363 other MIB modules and other MIB modules that SHOULD be implemented in 364 conjunction with the MIB module contained within this document are 365 identified in this section. 367 6.1. Relationship to the SNMPv2-MIB 369 The 'system' group in the SNMPv2-MIB [RFC3418] is defined as being 370 mandatory for all systems, and the objects apply to the entity as a 371 whole. The 'system' group provides identification of the management 372 entity and certain other system-wide data. The reportSampledMIB 373 module does not duplicate those objects. 375 6.2. Relationship to the RMON2-MIB 377 The reportSampledMIB module is closely related to and was inspired by 378 the the RMON2-MIB module [RFC2021] usrHistoryGroup. The use of 379 control tables to establish the periodic collection of measurement 380 data for creation of performance reports was pulled from earlier work 381 on the RMON2-MIB module. 383 6.3. Relationship to the DISMAN-EVENT-MIB 385 The reportSampledMIB module was developed to fundamentally work with 386 the dismanEventMIB module RFC 2981 [RFC2981] in order to offer a 387 complete and efficient off-line reporting capability for bandwidth 388 challenged networks such as Mobile Ad-Hoc Networks (MANETs). This is 389 accomplished through defining trigger test and associated 390 notification actions indexed by mteOwner, mteTriggerName, 391 mteObjectsName and mteEventName within the dismanEventMIB module. 392 Specifically (within the dismanEventMIB module): 394 In the mteTriggerTable and specifically by setting 396 o 'mteTriggerTest == boolean(1)', 398 o 'mteTriggerSampleType == absoluteValue(1)', 400 o 'mteTriggerValueID == 401 reportSampledNumberOfMeasurementsForCurrentReport', 403 o 'mteTriggerValueIDWildcard == false(1)', 405 o 'mteTriggerFrequency == 0.5*reportSampledStudySamplingInterval', 406 and 408 o 'mteTriggerEnabled == true'. 410 In the mteTriggerBooleanTable and specifically by setting 412 o 'mteTriggerBooleanComparison == equal(2)', 414 o 'mteTriggerBooleanValue == value of 415 reportSampledStudyNumberReportMeasurements', and 417 o 'mteTriggerBooleanStartup == false'. 419 In the mteObjectsTable and specifically by setting 420 o 'mteObjectsID == reportSampledCurrentMeasurementValue' and 421 reportSampledCurrentMeasurementTime' and 422 reportSampledCurrentMeasurementStatus' with 424 o 'mteObjectsIDWildcard == true' // for each. 426 In the mteEventTable and specifically by setting 428 o 'mteEventActions == notification(0)' and 430 o 'mteEventEnabled == true' // for each. 432 In the mteEventNotificationTable and specifically by setting 434 o 'mteEventNotification == mteTriggerFired' and the appropriate 435 names for the 437 o 'mteEventNotificationObjectOwner == mteOwner' and 439 o 'mteEventNotificationObjects == mteObjectsName'. 441 These settings within the dismanEventMIB module will result in 442 notifications generated by the dismanEventMIB module which will carry 443 the recently completed reportSampledMIB module reports. 445 Set up properly, the dismanEventMIB module will trigger a 446 notification each time the reportSampledCurrentTable contains a 447 completed Report. This Report will be sent in a notification 448 containing three columns of the reportSampledCurrentTable, i.e., the 449 Value, the Time and the Status, due to the use of wildcarding within 450 the dismanEventMIB module. 452 Simultaneously, the reportSampledMIB module will move the completed 453 Current Report into the reportSampledHistoricalReportsTable and 454 restart collection for the next Report within the 455 reportSampledCurrentReportsTable. 457 6.4. Relationship to the DISMAN-EXPRESSION-MIB 459 In conjunction with the dismanExpressionMIB module RFC 2982 460 [RFC2982], the reportSampledMIB module can be used to develop reports 461 on relatively sophisticated object expressions. 463 6.5. MIB modules required for IMPORTS 465 Citations are not permitted within a MIB module, but any module 466 mentioned in an IMPORTS clause or document mentioned in a REFERENCE 467 clause is a Normative reference, and must be cited someplace within 468 the narrative sections. Therefore, the imported items in this MIB 469 module, such as Textual Conventions, that are not already cited, are 470 cited in this section. Since relationships to other MIB modules 471 should be described in the narrative text, this section will cite 472 modules from which Textual Conventions are imported. 474 The reportSampledMIB module IMPORTS objects from SNMPv2-SMI 475 [RFC2578], SNMPv2-TC [RFC2579], SNMPv2-CONF [RFC2580], SNMP- 476 FRAMEWORK-MIB [RFC3411], and SNMPv2-MIB [RFC3418]. 478 7. Definitions 480 REPORT-SAMPLED-MIB DEFINITIONS ::= BEGIN 482 IMPORTS 484 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, 485 Gauge32, Integer32, experimental 486 FROM SNMPv2-SMI -- [RFC2578] 488 TimeStamp 489 FROM SNMPv2-TC -- [RFC2579] 491 sysUpTime 492 FROM SNMPv2-MIB -- [RFC3418] 494 SnmpAdminString 495 FROM SNMP-FRAMEWORK-MIB -- [RFC3411] 497 MODULE-COMPLIANCE, OBJECT-GROUP, 498 NOTIFICATION-GROUP 499 FROM SNMPv2-CONF -- [RFC2580] 500 ; 502 reportSampledMIB MODULE-IDENTITY 503 LAST-UPDATED "201412011300Z" -- December 01, 2014 504 ORGANIZATION "IETF MANET Working Group" 505 CONTACT-INFO 506 "WG E-Mail: manet@ietf.org 508 WG Chairs: sratliff@cisco.com 509 jmacker@nrl.navy.mil 511 Editors: Robert G. Cole 512 US Army CERDEC 513 6010 Frankford Road 514 Aberdeen Proving Ground, MD 21005 515 USA 516 +1 443 395-8744 517 robert.g.cole@us.army.mil 519 Joseph Macker 520 Naval Research Laboratory 521 Washington, D.C. 20375 522 USA 523 macker@itd.nrl.navy.mil 525 Andy Bierman 526 YumaWorks, Inc. 527 andy@yumaworks.com" 528 DESCRIPTION 529 "This MIB module contains managed object definitions for 530 the autonmous reporting of performance object counters. 531 Copyright (C) The IETF Trust (2009). This version 532 of this MIB module is part of RFC xxxx; see the RFC 533 itself for full legal notices." 535 -- Revision History 536 REVISION "201412011300Z" -- December 01, 2014 537 DESCRIPTION 538 "The ninth draft of this MIB module published as 539 draft-ietf-manet-report-mib-04.txt. 541 Revisions to this draft include 542 a) A major restructuring of the MIB module in order 543 to leverage the dismanEventMIB module for the 544 automatic notification of Completed Reports. 545 b) Efforts to incorporate this MIB module 546 into the DISMAN management architecture. 547 " 548 REVISION "201211051300Z" -- November 05, 2012 549 DESCRIPTION 550 "The seventh draft of this MIB module published as 551 draft-ietf-manet-report-mib-03.txt. 553 Revisions to this draft include 554 a) Added a 'Tables and Indexing' section to the 555 body of this document. 556 b) Added an 'Applicability Statement' section 557 to the body of this document." 558 REVISION "201201311300Z" -- January 31, 2012 559 DESCRIPTION 560 "The sixth draft of this MIB module published as 561 Revisions to this draft include 562 a) Pulled the statistical and historical reporting 563 from the MIB module and left only the sampled 564 reporting, in order to greatly simplify the 565 first instance of this reporting MIB module. 566 b) Renamed the module, the reportSampledMIB module. 567 c) Leveraged the RMON2-MIB module more effectively 568 through the use of the AUGMENTS clause. 569 d) Changed the module to 'experimental'." 570 REVISION "201102171300Z" -- February 17, 2011 571 DESCRIPTION 572 "The fifth draft of this MIB module published as 573 draft-ietf-manet-report-mib-01.txt. This document 574 has been promoted to a MANET Working Group 575 draft. 577 Revisions to this draft include 578 a) Proposed changes to the statsReport table to 579 simplify communications between device and 580 mgmt application, 581 b) Added Notifications, 582 c) Changed the reporting structure of the 583 Sampled and the History reporting 584 to align with the structure of the 585 Statistics reports for the purpose of 586 allowing for efficient notification and 587 collection of data reports. 588 d) Ran through smilint to clean up all errors 589 and most warning. A few still remain." 590 REVISION "201007051300Z" -- July 05, 2010 591 DESCRIPTION 592 "The fourth draft of this MIB module published as 593 draft-ietf-manet-report-mib-00.txt. This document 594 has been promoted to a MANET Working Group 595 draft. 597 Significant revisions to this draft include 598 a) added support for proxy configurations through 599 the addition of address objects associated with 600 the referenced counter objects associated with the 601 performance reports." 602 REVISION "201003021300Z" -- March 02, 2010 603 DESCRIPTION 604 "The third draft of this MIB module published as 605 draft-cole-manet-report-mib-02.txt. Significant 606 revisions to this draft include a) changed naming 607 of usrHistoryGroup to sampledGroup and b) added 608 a historyGroup." 609 REVISION "200910251300Z" -- October 25, 2009 610 DESCRIPTION 611 "The second draft of this MIB module published as 612 draft-cole-manet-report-mib-01.txt. Significant 613 revisions to this draft include a) the inclusion of 614 raw data collection borrow blatently from the 615 usrHistory Group within RMON2, b) the deletion of 616 the CurrentHistoryTable from version -00, 617 c) modifications to the overall structure of the 618 MIB, and d) the definition of various Compliance 619 options for implementations related to this MIB." 620 REVISION "200904281300Z" -- April 28, 2009 621 DESCRIPTION 622 "Initial draft of this MIB module published as 623 draft-cole-manet-report-mib-00.txt." 624 -- RFC-Editor assigns XXXX 625 ::= { experimental 998 } -- to be assigned by IANA 627 -- TEXTUAL CONVENTIONs 628 -- None 630 -- 631 -- Top-Level Object Identifier Assignments 632 -- 633 reportSampledMibNotifications OBJECT IDENTIFIER 634 ::= { reportSampledMIB 0 } 635 reportSampledMibObjects OBJECT IDENTIFIER 636 ::= { reportSampledMIB 1 } 637 reportSampledMibConformance OBJECT IDENTIFIER 638 ::= { reportSampledMIB 2 } 640 -- The reportSampledMibObjects assignments are : 641 -- reportSampledControlTable - 1 642 -- reportSampledCurrentReportsStatusTable - 2 643 -- reportSampledCurrentReportsTable - 3 644 -- reportSampledHistoricalReportsTable - 4 646 -- 647 -- The Control Table 648 -- 649 reportSampledControlTable OBJECT-TYPE 650 SYNTAX SEQUENCE OF reportSampledControlEntry 651 MAX-ACCESS not-accessible 652 STATUS current 653 DESCRIPTION 654 "A table to configure measurement Studies which 655 are comprised of multiple Reports." 656 REFERENCE 657 "tbd." 658 ::= { reportSampledMibObjects 1 } 660 reportSampledControlEntry OBJECT-TYPE 661 SYNTAX ReportSampledControlEntry 662 MAX-ACCESS not-accessible 663 STATUS current 664 DESCRIPTION 665 "A list of parameters that control the creation of 666 off-line performance Studies. 668 The objects in this table are persistent and when 669 written the device SHOULD save the change to 670 non-volatile storage. For further information 671 on the storage behavior for these objects, refer 672 to the description for the reportSampledStudyEntryStatus 673 object." 674 INDEX { reportSampledStudyIndex } 675 ::= { reportSampledControlTable 1 } 677 ReportSampledControlEntry ::= SEQUENCE { 678 reportSampledStudyIndex Integer32, 679 reportSampledStudyOwner SnmpAdminString, 680 reportSampledStudyName SnmpAdminString, 681 reportSampledStudyOid Integer32, 682 reportSampledStudySamplingInterval Integer32, 683 reportSampledStudyNumberReportMeasurements Integer32, 684 reportSampledStudyMaximumNumberOfHistoricalReports Integer32, 685 reportSampledStudyEntryStatus RowStatus 686 } 688 reportSampledStudyIndex OBJECT-TYPE 689 SYNTAX Integer32 (1..127) 690 MAX-ACCESS not-accessible 691 STATUS current 692 DESCRIPTION 693 "A unique index that identifies a specific performace 694 Study. Each Study is comprised of multiple 695 Reports. Each Report is comprised of multiple 696 atomic Measurements on a specified object." 697 ::= { reportSampledControlEntry 1 } 699 reportSampledStudyOwner OBJECT-TYPE 700 SYNTAX SnmpAdminString (SIZE (0..32)) 701 MAX-ACCESS read-create 702 STATUS current 703 DESCRIPTION 704 "The owner of the Study." 705 DEFVAL { ''H } 706 ::= { reportSampledControlEntry 2 } 708 reportSampledStudyName OBJECT-TYPE 709 SYNTAX SnmpAdminString (SIZE (0..32)) 710 MAX-ACCESS read-create 711 STATUS current 712 DESCRIPTION 713 "The name of the Study." 714 DEFVAL { ''H } 715 ::= { reportSampledControlEntry 3 } 717 reportSampledStudyOid OBJECT-TYPE 718 SYNTAX OBJECT IDENTIFIER 719 MAX-ACCESS read-create 720 STATUS current 721 DESCRIPTION 722 "The target OID of the Study. Each Study makes 723 periodic Measurements on a specified object 724 which is local to this device. Currently, the 725 objects of study are limited to objects that 726 resolve to Integer32 (i.e., Integer32, Counter, 727 Gauge, or TimeTicks)." 728 ::= { reportSampledControlEntry 4 } 730 reportSampledStudySamplingInterval OBJECT-TYPE 731 SYNTAX Integer32 (1..2147483647) 732 UNITS "seconds" 733 MAX-ACCESS read-create 734 STATUS current 735 DESCRIPTION 736 "The time (in seconds) between sampled Measurement 737 instances." 738 DEFVAL { 10 } 739 ::= { reportSampledControlEntry 5 } 741 reportSampledStudyNumberReportMeasurements OBJECT-TYPE 742 SYNTAX Integer32 (1..2147483647) 743 UNITS "count" 744 MAX-ACCESS read-create 745 STATUS current 746 DESCRIPTION 747 "The number of Meaurements per Report for this Study." 749 DEFVAL { 10 } 750 ::= { reportSampledControlEntry 6 } 752 reportSampledStudyMaximumNumberOfHistoricalReports OBJECT-TYPE 753 SYNTAX Integer32 (1..2147483647) 754 UNITS "count" 755 MAX-ACCESS read-create 756 STATUS current 757 DESCRIPTION 758 "The number of Historical Reports to archive locally 759 for this specific Study. The Historical Reports are 760 archived locally in the 761 reportSampledHistoricalReportsTable (below)." 762 DEFVAL { 10 } 763 ::= { reportSampledControlEntry 7 } 765 reportSampledStudyEntryStatus OBJECT-TYPE 766 SYNTAX RowStatus 767 MAX-ACCESS read-create 768 STATUS current 769 DESCRIPTION 770 "This object permits management of this table 771 by facilitating actions such as row creation, 772 construction, and destruction. The value of 773 this object has no effect on whether other 774 objects in this conceptual row can be 775 modified. 777 An entry may not exist in the 'active' state unless all 778 objects in the entry have a defined appropriate value. For 779 objects with DEFVAL clauses, the management station 780 does not need to specify the value of these objects in order 781 for the row to transit to the 'active' state; the default 782 value for these objects is used. For objects that do not 783 have DEFVAL clauses, then the network manager MUST 784 specify the value of these objects prior to this row 785 transitioning to the 'active' state. 787 When this object transitions to 'active', all objects 788 in this row SHOULD be written to non-volatile (stable) 789 storage. Read-create objects in this row MAY be modified. 790 When an object in a row with smfCfgIfRowStatus of 'active' 791 is changed, then the updated value MUST be reflected in SMF 792 and this new object value MUST be written to non-volatile 793 storage. 795 If this object is not equal to 'active', all associated 796 entries in the reportSampledCurrentReportsStatusTable, 797 the reportSampledCurrentReportsTable, and the 798 reportSampledHistoricalReportsTable MUST be deleted." 799 ::= { reportSampledControlEntry 8 } 801 -- 802 -- the Current Reports Status Table 803 -- 804 reportSampledCurrentReportsStatusTable OBJECT-TYPE 805 SYNTAX SEQUENCE OF reportSampledCurrentReportsStatusEntry 806 MAX-ACCESS not-accessible 807 STATUS current 808 DESCRIPTION 809 "A table to tracking the progress of measurements of current 810 reports in development. Of particular note is the object 811 reportSampledNumberOfMeasurementsForCurrentReport which 812 can be compared to the value of the object 813 reportSampledStudyNumberReportMeasurements by the 814 dismanEventMIB module and generate triggered 815 notifications to the Study owner containing the 816 recently Completed Reports." 817 REFERENCE 818 "tbd." 819 ::= { reportSampledMibObjects 2 } 821 reportSampledCurrentReportsStatusEntry OBJECT-TYPE 822 SYNTAX ReportSampledCurrentReportsStatusEntry 823 MAX-ACCESS not-accessible 824 STATUS current 825 DESCRIPTION 826 "A list of parameters that track the status of 827 current Reports in development." 828 INDEX { reportSampledStudyIndex } 829 ::= { reportSampledCurrentReportsStatusTable 1 } 831 ReportSampledCurrentReportsStatusEntry ::= SEQUENCE { 832 reportSampledNumberOfCurrentReport Integer32, 833 reportSampledNumberOfMeasurementsForCurrentReport Integer32 834 } 836 reportSampledNumberOfCurrentReport OBJECT-TYPE 837 SYNTAX Integer32 (1..2147483647) 838 UNITS "count" 839 MAX-ACCESS read-only 840 STATUS current 841 DESCRIPTION 842 "The number within the Study series of this 843 current Report. For each new Report within 844 the Study, this value MIUST increment by 845 one. For the first Report in this Study, 846 the initial value of this object MUST be 847 set to one. The value MUST wrap back to one 848 when the value has reached the maximum." 849 ::= { reportSampledCurrentReportsStatusEntry 1 } 851 reportSampledNumberOfMeasurementsForCurrentReport OBJECT-TYPE 852 SYNTAX Integer32 (1..2147483647) 853 UNITS "count" 854 MAX-ACCESS read-only 855 STATUS current 856 DESCRIPTION 857 "The number of Measurements collected so far for 858 for this specific Report. The initial value 859 of this object MUST be one. The value MUST 860 increment be one for each attempted Measurement. 861 The maximum value for this object is 862 reportSampledStudyNumberReportMeasurements. 863 Once this value is reached and the next 864 Measurement is attempted, the Current Report is 865 considered Completed, the agent MUST copy 866 the Completed Report's data from the 867 reportSampledCurrentReportsTable into the 868 reportSampledHistoricalReportsTable, and the 869 next Measurement (strating the next Report in the 870 Study series) MUST be numbered with the value of 871 this object as one." 872 ::= { reportSampledCurrentReportsStatusEntry 2 } 874 -- 875 -- the Current Reports Table 876 -- 877 reportSampledCurrentReportsTable OBJECT-TYPE 878 SYNTAX SEQUENCE OF ReportSampledCurrentReportsEntry 879 MAX-ACCESS not-accessible 880 STATUS current 881 DESCRIPTION 882 "A list of measurements being collected for active 883 Reports." 884 REFERENCE 885 " TBD." 886 ::= { reportSampledMibObjects 3 } 888 reportSampledCurrentReportsEntry OBJECT-TYPE 889 SYNTAX ReportSampledCurrentReportsEntry 890 MAX-ACCESS not-accessible 891 STATUS current 892 DESCRIPTION 893 "A list of entries storing the measurements from 894 active Reports. Once an active, current Report 895 completes (when the value of the associated 896 reportSampledNumberOfMeasurementsForCurrentReport 897 equals the value of the associated 898 reportSampledStudyNumberReportMeasurements), the 899 agent MUST move the Report's data from the 900 reportSampledCurrentReportsTable to the 901 reportSampledHistoricalReportTable." 902 INDEX { reportSampledStudyIndex, 903 reportSampledCurrentMeasurementIndex } 904 ::= { reportSampledCurrentReportsTable 1 } 906 ReportSampledCurrentReportsEntry ::= SEQUENCE { 907 reportSampledCurrentMeasurementIndex Integer32, 908 reportSampledCurrentMeasurementValue Integer32, 909 reportSampledCurrentMeasurementTime sysUpTime, 910 reportSampledCurrentMeasurementStatus INTEGER 911 } 913 reportSampledCurrentMeasurementIndex OBJECT-TYPE 914 SYNTAX Integer32 (1..2147483647) 915 MAX-ACCESS not-accessible 916 STATUS current 917 DESCRIPTION 918 "An index for this table which represents 919 the number of Measurements collected so far for 920 for this current Report. The initial value 921 of this object MUST be one. The value MUST 922 increment be one for each attempted Measurement. 923 The maximum value for this object is 924 reportSampledStudyNumberReportMeasurements. 925 Once this value is reached and the next 926 Measurement is attempted, the Current Report is 927 considered Completed, the agent MUST copy 928 the Completed Report's data from the 929 reportSampledCurrentReportsTable into the 930 reportSampledHistoricalReportsTable, and the 931 next Measurement (strating the next Report in the 932 Study series) MUST be numbered with the value of 933 this object as one." 934 ::= { reportSampledCurrentReportsEntry 1 } 936 reportSampledCurrentMeasurementValue OBJECT-TYPE 937 SYNTAX Integer32 (1..2147483647) 938 MAX-ACCESS read-only 939 STATUS current 940 DESCRIPTION 941 "A single measurement for this Study for 942 this Current Report. The objects identifying 943 the measurement MUST resolve to type Integer32 944 (i.e., Integer32, Counter, Gauge, or TimeTicks). 945 to be used for performance monitoring on this device." 946 ::= { reportSampledCurrentReportsEntry 2 } 948 reportSampledCurrentMeasurementTime OBJECT-TYPE 949 SYNTAX sysUpTime 950 MAX-ACCESS read-only 951 STATUS current 952 DESCRIPTION 953 "The systemUpTime of the device on which the 954 measurement was made for this Measurement." 955 ::= { reportSampledCurrentReportsEntry 3 } 957 reportSampledCurrentMeasurementStatus OBJECT-TYPE 958 SYNTAX INTEGER { 959 valueNotAvailable(1), 960 valuePositive(2), 961 valueNegative(3) 962 } 963 MAX-ACCESS read-only 964 STATUS current 965 DESCRIPTION 966 "This object indicates the validity and sign of the 967 data in the associated value recorded by the 968 reportSampledCurrentMeasurementValue object." 969 ::= { reportSampledCurrentReportsEntry 4 } 971 -- 972 -- Historical Reports Table 973 -- 974 reportSampledHistoricalReportsTable OBJECT-TYPE 975 SYNTAX SEQUENCE OF ReportSampledHistoricalReportsEntry 976 MAX-ACCESS not-accessible 977 STATUS current 978 DESCRIPTION 979 "A table archiving non-active Reports for each 980 defined Study up to a maximum number of Reports 981 per Study." 982 ::= { reportSampledMibObjects 4 } 984 reportSampledHistoricalReportsEntry OBJECT-TYPE 985 SYNTAX ReportSampledHistoricalReportsEntry 986 MAX-ACCESS not-accessible 987 STATUS current 988 DESCRIPTION 989 "A list of entries storing the measurements from 990 Completed Reports. Once an active, current Report 991 completes (when the value of the associated 992 reportSampledNumberOfMeasurementsForCurrentReport 993 equals the value of the associated 994 reportSampledStudyNumberReportMeasurements), the 995 agent MUST move the Report's data from the 996 reportSampledCurrentReportsTable to this 997 reportSampledHistoricalReportTable." 998 REFERENCE 999 " TBD. " 1000 INDEX { reportSampledStudyIndex, 1001 reportSampledHistoricalReportIndex, 1002 reportSampledHistoricalMeasurementIndex } 1003 ::= { reportSampledHistoricalReportsTable 1 } 1005 ReportSampledHistoricalReportsEntry ::= SEQUENCE { 1006 reportSampledHistoricalReportIndex Integer32, 1007 reportSampledHistoricalMeasurementIndex Integer32, 1008 reportSampledHistoricalMeasurementValue Integer32, 1009 reportSampledHistoricalMeasurementTime sysUpTime, 1010 reportSampledHistoricalMeasurementStatus INTEGER 1011 } 1013 reportSampledHistoricalReportIndex OBJECT-TYPE 1014 SYNTAX Integer32 (1..2147483647) 1015 MAX-ACCESS not-accessible 1016 STATUS current 1017 DESCRIPTION 1018 "An index that uniquely identifies the particular Report 1019 archived in this table for the specific Study 1020 (identified by the reportSampledStudyIndex)." 1021 ::= { reportSampledHistoricalReportsEntry 1 } 1023 reportSampledHistoricalMeasurementIndex OBJECT-TYPE 1024 SYNTAX Integer32 (1..2147483647) 1025 MAX-ACCESS read-only 1026 STATUS current 1027 DESCRIPTION 1028 "An index that uniquely identifies a Measurement for 1029 a specific Report achived in this table for a 1030 Specific Study." 1031 ::= { reportSampledHistoriclReportsEntry 2 } 1033 reportSampledHistoricalReportsValue OBJECT-TYPE 1034 SYNTAX Integer32(1..2147483647) 1035 MAX-ACCESS read-only 1036 STATUS current 1037 DESCRIPTION 1038 "A single measurement for this Study for 1039 this Completed Report. The objects identifying 1040 the measurement MUST resolve to type Integer32 1041 (i.e., Integer32, Counter, Gauge, or TimeTicks). 1042 to be used for performance monitoring on this device." 1043 ::= { reportSampledHistoriclReportsEntry 3 } 1045 reportSampledHistoricalMeasurementTime OBJECT-TYPE 1046 SYNTAX sysUpTime 1047 MAX-ACCESS read-only 1048 STATUS current 1049 DESCRIPTION 1050 "The systemUpTime of the device on which the 1051 measurement was made for this Measurement." 1052 ::= { reportSampledHistoriclReportsEntry 5 } 1054 reportSampledHistoricalMeasurementStatus OBJECT-TYPE 1055 SYNTAX INTEGER { 1056 valueNotAvailable(1), 1057 valuePositive(2), 1058 valueNegative(3) 1059 } 1060 MAX-ACCESS read-only 1061 STATUS current 1062 DESCRIPTION 1063 "This object indicates the validity and sign of the 1064 data in the associated value recorded by the 1065 reportSampledHistoricalMeasurementValue object." 1066 ::= { reportSampledHistoriclReportsEntry 5 } 1068 -- 1069 -- Notifications 1070 -- 1072 -- The following notification objects to define issues with making 1073 -- and storing measurements. 1075 -- Actions which report data, i.e., Reports, are to be handled by 1076 -- the dismanEventMIB module. 1078 reportSampledNotificationObjects OBJECT IDENTIFIER 1079 ::= {reportSampledMibNotifications 0} 1080 reportSampledNotificationControl OBJECT IDENTIFIER 1081 ::= {reportSampledMibNotifications 1} 1083 -- 1084 -- reportSampledNotificationObjects 1085 -- 1086 reportSampledDataCollectionFailure NOTIFICATION-TYPE 1087 OBJECTS { reportSampledStudyOwner, -- The entity that 1088 -- configured this Study 1089 reportSampledStudyName, -- The name of the Study 1090 -- that is failing to 1091 -- collect measurement data 1092 reportSampledStudyOid -- The Object ID being 1093 -- monitored in this Study 1094 } 1095 STATUS current 1096 DESCRIPTION 1097 "The reportSampledDataCollectionFailure is a notification 1098 sent when the number of consecutive measurement failures 1099 within a Current Report, as indicated by consecutive values 1100 of the reportSampledCurrentMeasurementStatus being set 1101 to 'valueNotAvailable(1)', exceeds the value of the 1102 threshold value defined in the 1103 reportSampledDataCollectionFailureThreshold object." 1104 ::= { reportSampledNotificationObjects 1 } 1106 -- 1107 -- nhdpNotificationsControl 1108 -- 1109 reportSampledDataCollectionFailureThreshold OBJECT-TYPE 1110 SYNTAX Integer32 (1..255) 1111 UNITS "count" 1112 MAX-ACCESS read-write 1113 STATUS current 1114 DESCRIPTION 1115 "A threshold value for the number of 1116 consecutive measurement failures within a 1117 Current Report as indicated by consecutive values 1118 of the reportSampledCurrentMeasurementStatus being 1119 being set to 'valueNotAvailable(1)' which 1120 exceed the value of this threshold. A value of 1121 '255' for this threshold indicates that the 1122 reportSampledDataCollectionFailure notification 1123 is never to be sent. " 1124 DEFVAL { 10 } 1125 ::= { nhdpNotificationsControl 1 } 1127 -- 1128 -- Compliance Statements 1129 -- 1131 -- Mandatory compliance for the reportSampledMIB module will 1132 -- include all objects defined within the module. 1133 reportSampledCompliances OBJECT IDENTIFIER 1134 ::= { reportSampledMIBConformance 1 } 1135 reportSampledMIBGroups OBJECT IDENTIFIER 1136 ::= { reportSampledMIBConformance 2 } 1138 reportSampledCompliance MODULE-COMPLIANCE 1139 STATUS current 1140 DESCRIPTION "The reportSampled basic implementation requirements 1141 for managed network entities that implement 1142 the REPORT Sampled process." 1143 MODULE -- this module 1144 MANDATORY-GROUPS { reportSampledLocalGroup } 1145 ::= { reportSampledCompliances 1 } 1147 -- 1148 -- Units of Conformance 1149 -- 1150 reportSampledLocalGroup OBJECT-GROUP 1151 OBJECTS { 1152 reportSampledStudyOwner, 1153 reportSampledStudyName, 1154 reportSampledStudyOid, 1155 reportSampledStudySamplingInterval, 1156 reportSampledStudyNumberReportMeasurements, 1157 reportSampledStudyMaximumNumberOfHistoricalReports, 1158 reportSampledStudyEntryStatus, 1160 reportSampledNumberOfCurrentReport, 1161 reportSampledNumberOfMeasurementsForCurrentReport, 1163 reportSampledCurrentMeasurementValue, 1164 reportSampledCurrentMeasurementTime, 1165 reportSampledCurrentMeasurementStatus, 1167 reportSampledHistoricalMeasurementValue, 1168 reportSampledHistoricalMeasurementTime, 1169 reportSampledHistoricalMeasurementStatus, 1171 reportSampledDataCollectionFailure, 1172 reportSampledDataCollectionFailureThreshold 1173 } 1174 STATUS current 1175 DESCRIPTION 1176 "The basic set of objects in thie reportSampledMIB module 1177 to be implemented in order to meet the minimal compliance 1178 conditions." 1179 ::= { reportSampledMIBGroups 1 } 1181 END 1183 8. Security Considerations 1185 This reportSampledMIB module defines a capability where the local 1186 device may poll other MIB modules on the device to collect 1187 performance data. These capabilities defined within the 1188 reportSampledMIB module are control-able by a network management 1189 application through SNMP. As such, a network management application 1190 could potentially use the reportSampledMIB module as a mechanism to 1191 implement a limited Distributed Denial-of-Service (DDoS) attack 1192 against remote devices by overloading their SNMP processing. Care 1193 should be taken to secure access to the reportSampledMIB module 1194 agent. Specifically, access control mechanisms and authentication 1195 mechanisms (via SNMPv3) should always be used for SNMP SET 1196 operations. Further, some objects may contain data deemed sensitive 1197 and authentication and encryption mechanisms (via SNMPv3) should be 1198 used for SNMP GET operations. 1200 There are a number of management objects defined in this MIB module 1201 with a MAX-ACCESS clause of read-write and/or read-create. Such 1202 objects may be considered sensitive or vulnerable in some network 1203 environments. The support for SET operations in a non-secure 1204 environment without proper protection can have a negative effect on 1205 network operations. 1207 These are the tables and objects and their sensitivity/vulnerability: 1209 o The reportSampledControlTable is a writable table whose columnar 1210 objects are read-create. The following objects with MAX ACCESS of 1211 read-create and their security sensitivities are: 1213 o 1215 * reportSampledStudyOwner - this object is an administrative 1216 string which identifies the the owner of the Study. 1218 * reportSampledStudyName - this object is an administrative 1219 string which gives a name to the Study defined by the objects 1220 in this table. 1222 * reportSampledStudyOid - this object identifies the the Object 1223 ID from another MIB module resident on this local device which 1224 forms the measurement basis for the Study. Depending upon the 1225 object and the associated process responsible for its 1226 maintenance, polling this object too frequently may place an 1227 undo burden on the process resulting in diminishing its overall 1228 ability to perform its operation. 1230 * reportSampledStudySamplingInterval - this object identifies the 1231 time interval being sampling events. If set too low, the 1232 device may not be able to sample the object on remote devices 1233 fast enough to satisfy the requested interval. Further, 1234 setting this value too low could be used to overwhelm the 1235 processing capabilities of the remote agent, resulting in a 1236 form of Denial-of-Service (DoS) attack. 1238 * reportSampledStudyNumberReportsMeasurements - this object 1239 identifies the requested number of measurements (and associated 1240 storage/memory) for each identified object for each Study 1241 instance. As such, this related to the total device memory 1242 necessary to hold the collected data for the identified 1243 reports. The device must determine whether it has the 1244 necessary storage. If not, the device can reject this value 1245 when requested by returning the .... to protect itself against 1246 memory overruns. 1248 * reportSampledStudyMaximumNumberOfHistoricalReports - this 1249 object identifies the requested number of Reports for each 1250 identified object for each Study instance. As such, this 1251 related to the total device memory necessary to hold the 1252 collected data for the identified reports. The device must 1253 determine whether it has the necessary storage. If not, the 1254 device can reject this value when requested by returning the 1255 .... to protect itself against memory overruns. 1257 * reportSampledStudyEntryStatus - this is the RowStatus object 1258 controlling the configuration of this table row. 1260 o The reportSampledCurrentReportsStatusTable is a read-only table 1261 containing state information. The information in this Table 1262 relates to performance measurements on the underlying Mobile Ad- 1263 Hoc Network (MANET). As such, some of this information may be 1264 deemed sensitive to the overall performance of the MANET and to 1265 the organization to which the MANET belongs. 1267 o The reportSampledCurrentReportsTable is a read-only table 1268 containing state information. The information in this Table 1269 relates to performance measurements on the underlying Mobile Ad- 1270 Hoc Network (MANET). As such, some of this information may be 1271 deemed sensitive to the overall performance of the MANET and to 1272 the organization to which the MANET belongs. 1274 o The reportSampledHistoricalReportsStatusTable is a read-only table 1275 containing state information. The information in this Table 1276 relates to performance measurements on the underlying Mobile Ad- 1277 Hoc Network (MANET). As such, some of this information may be 1278 deemed sensitive to the overall performance of the MANET and to 1279 the organization to which the MANET belongs. 1281 o The reportSampledDataCollectionFailure notification object reports 1282 information regarding the inability of the reportSampledMIB module 1283 from completing its configured reporting mission, including the 1284 specific information that the module is failing to collect. To 1285 some organizations this information may be deemed sensitive to its 1286 mission and may want to protect this information through 1287 encryption mechanisms. 1289 o The reportSampledDataCollectionFailureThreshold object controls 1290 the ability of the device to report information regarding the 1291 inability of the reportSampledMIB module from completing its 1292 configured reporting mission. If set to low, notifications may be 1293 produced too frequently causing processor burdens to the agent and 1294 the collecting manager, and generating too much management traffic 1295 for a bandwidth constrained MANET to support. If set too high, 1296 notifications may not be produced frequently enough for the 1297 collecting manager to properly track the MANET system performance. 1299 SNMP versions prior to SNMPv3 did not include adequate security. 1300 Even if the network itself is secure (for example by using IPSec), 1301 even then, there is no control as to who on the secure network is 1302 allowed to access and GET/SET (read/change/create/delete) the objects 1303 in this MIB module. 1305 It is RECOMMENDED that implementers consider the security features as 1306 provided by the SNMPv3 framework (see [RFC3410], section 8), 1307 including full support for the SNMPv3 cryptographic mechanisms (for 1308 authentication and privacy). 1310 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1311 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1312 enable cryptographic security. It is then a customer/operator 1313 responsibility to ensure that the SNMP entity giving access to an 1314 instance of this MIB module is properly configured to give access to 1315 the objects only to those principals (users) that have legitimate 1316 rights to indeed GET or SET (change/create/delete) them. 1318 9. Applicability Statement 1320 This document describes objects for configuring parameters of the 1321 remote report generation process on a router or other device. This 1322 MIB module, denoted reportSampledMIB module, also reports performance 1323 information and notifications. The reportSampledMIB module provides 1324 for the remote control, collection and notification of performance 1325 reports on devices. As such, it eliminates the need for periodic 1326 polling for counters from remote management stations as a means for 1327 generating performance reports. This is hoped to greatly reduce 1328 management overhead on the MANET. This sections provides some 1329 examples of how this MIB module can be used in MANET network 1330 deployments. A fuller discussion of MANET network management use 1331 cases and challenges will be provided elsewhere. 1333 In the following, two scenarios are identified where this MIB module 1334 is useful. This list is not complete and other scenarios are 1335 possible. 1337 o For Mobile vehicles with Low Bandwidth Satellite Link to a Fixed 1338 Network Operations Center (NOC) - Here the vehicles carrying the 1339 MANET routers carry multiple wireless interfaces, one of which is 1340 a relatively low-bandwidth on-the-move satellite connection which 1341 interconnects a fix NOC to the nodes of the MANET. Standards- 1342 based methods for monitoring and fault management from the fixed 1343 NOC are necessary for this deployment option. However, to reduce 1344 polling overhead over the low bandwidth communications links, the 1345 reportSampledMIB module can be deployed the remote MANET nodes for 1346 the remote generation of performance reports. 1348 o For Fixed NOC and Mobile Local Manager in Larger Vehicles - for 1349 larger vehicles, a hierarchical network management arrangement is 1350 useful. Centralized network management is performed from a fixed 1351 NOC while local management, as provided by this reportSampledMIB 1352 module is performed locally from within the vehicles. Standards- 1353 based methods for configuration, monitoring, fault and performance 1354 management are necessary for this deployment option. 1356 10. IANA Considerations 1358 The MIB module in this document uses the following IANA-assigned 1359 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 1361 Descriptor OBJECT IDENTIFIER value 1362 ---------- ----------------------- 1364 reportSampledMIB { experimental XXX } 1366 11. Contributors 1368 This MIB document uses the template authored by D. Harrington which 1369 is based on contributions from the MIB Doctors, especially Juergen 1370 Schoenwaelder, Dave Perkins, C.M.Heard and Randy Presuhn. 1372 12. Acknowledgements 1374 We would like to thank Bert Wijnen for pointing out the existence of 1375 the usrHistory group within RMON2 and in answering our numerous 1376 questions on the usrHistory group. Further, we wish to thank U. 1377 Herberg for promoting additions to this MIB through his thoughtful 1378 consideration of performance monitoring requirements for other MIBs 1379 within the MANET WG, e.g., NHDP and OLSR MIBs. 1381 13. References 1383 13.1. Normative References 1385 [RFC2021] Waldbusser, S., "Remote Network Monitoring Management 1386 Information Base Version 2 using SMIv2", RFC 2021, 1387 January 1997. 1389 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1390 Requirement Levels", BCP 14, RFC 2119, March 1997. 1392 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 1393 Schoenwaelder, Ed., "Structure of Management Information 1394 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 1396 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 1397 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 1398 STD 58, RFC 2579, April 1999. 1400 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 1401 "Conformance Statements for SMIv2", STD 58, RFC 2580, 1402 April 1999. 1404 [RFC2981] Kavasseri, R., "Event MIB", RFC 2981, October 2000. 1406 [RFC2982] Kavasseri, R., "Distributed Management Expression MIB", 1407 RFC 2982, October 2000. 1409 [RFC3411] Harrington, D., Presuhn, R., and B. Wijnen, "An 1410 Architecture for Describing Simple Network Management 1411 Protocol (SNMP) Management Frameworks", STD 62, RFC 3411, 1412 December 2002. 1414 [RFC3418] Presuhn, R., "Management Information Base (MIB) for the 1415 Simple Network Management Protocol (SNMP)", STD 62, 1416 RFC 3418, December 2002. 1418 13.2. Informative References 1420 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 1421 "Introduction and Applicability Statements for Internet- 1422 Standard Management Framework", RFC 3410, December 2002. 1424 Appendix A. Change Log 1426 Changes from draft-ietf-manet-report-mib-03 to 1427 draft-ietf-manet-report-mib-04 draft. 1429 1. This version 04 of the reportSampledMIB module represents a 1430 fairly significant restructuring of the MIB module. This 1431 restructuring was necessary in order to align the remote 1432 distributed reporting capabilities of this MIB module with the 1433 prior DISMAN Working Group (WG) efforts at the IETF. 1435 2. The reportSampledCurrentReportsStatusTable was added to allow a 1436 network manager to automate notifications of completed reports 1437 from this MIB module using the dismanEventMIB module. 1439 3. The notifications in this reportSampledMIB module were reduced to 1440 only notifications related to the operation of the data 1441 collections and no longer addressing the reporting of the 1442 performance data itself. This later data is now carried in 1443 notifications under the control of the dismanEventMIB module. 1445 Changes from draft-ietf-manet-report-mib-01 to 1446 draft-ietf-manet-report-mib-02 draft. 1448 1. Stripped the Statistical and the Historical Reports from this 1449 draft in order to greatly simplify the initial development and 1450 experiments of this MIB module. 1452 2. Changed the RFC category to Experimental. 1454 3. Completed the Security section. 1456 4. Relied upon the AUGMENTS statement to simplify further this MIB 1457 definition. 1459 Changes from draft-ietf-manet-report-mib-00 to 1460 draft-ietf-manet-report-mib-01 draft. 1462 1. Proposed additions to the statsReports in order to potentially 1463 simplify data transmission to management applications. 1465 2. Added some Notification definitions and their relationship to the 1466 three reports' structure, i.e., statsReports, sampledReports, and 1467 historyReports. 1469 3. In the process of adding notifications for the Sampled and the 1470 History reports, decided to restructure the reports from their 1471 previously rolling storage model to the fixed interval reporting 1472 used all along in the Statistics reporting. This allows the 1473 agent to notify the management application that a report has 1474 completed and that it is ready to be pulled from the agent 1475 storage. 1477 4. Ran MIB through smilint checker and cleaned up all errors and 1478 most warnings. A few warnings remain to be addressed. 1480 5. Cleaned up textual material. 1482 Changes from draft-cole-manet-report-mib-02 to 1483 draft-ietf-manet-report-mib-00 draft. 1485 1. Major change was the incorporation of the IP address objects 1486 associated with all objects of type 'OBJECT IDENTIFIER'. This 1487 allows the reportSampledMIB module to exist as a proxy report 1488 generation capability on a device separate but in close proximity 1489 to the device monitoring the referenced object. 1491 2. Cleaned up the up front text, reducing the repetition with the 1492 object descriptions in the MIB. 1494 3. Worked on and added sections discussing the relationship to other 1495 MIBs. 1497 Changes from draft-cole-manet-report-mib-01 to 1498 draft-cole-manet-report-mib-02 draft. 1500 1. Restructured the MIB somewhat to now offer the three reporting 1501 capabilities in increasing order of detail: a) statistical 1502 reports, b) sampled reports, and c) historical reports. 1504 2. Renamed the usrHistoryGroup and elements to samplingGroup. This 1505 is in line with its actual capabilities. 1507 3. Added a new historyGroup which provides a history of change 1508 events. 1510 4. Updated the4 Conformance section to reflect the above changes and 1511 additions. But did not yet run smilint to check MIB syntax. 1513 Changes from draft-cole-manet-report-mib-00 to 1514 draft-cole-manet-report-mib-01 draft. 1516 1. Added (copied) the usrHistory group from RMON2 into the 1517 reportSampledMIB module. 1519 2. Restructured the MIB to account for the inclusion of the 1520 reportSampledMibObjects. 1522 3. Dropped the reportCurReportsTable as this did not make sense 1523 within the context of the reportSampledMIB module. 1525 4. Added the Compliance and Conformance material. Defined several 1526 Compliance Groups to all for base implementations of the 1527 reportSampledMIB module for only statistical reports, for only 1528 historical reports or for both. Allow for enhanced 1529 implementations to address higher capacity issues and extension 1530 to metric reporting for statistical reporting. 1532 5. Ran the MIB through the smilint checker and in the process 1533 corrected numerous typos, omissions, TEXTUAL CONVENTIONS, 1534 IMPORTS, etc. 1536 6. Updated main text to reflect changes. 1538 Appendix B. Open Issues 1540 This section contains the set of open issues related to the 1541 development and design of the reportSampledMIB module. This section 1542 will not be present in the final version of the MIB and will be 1543 removed once all the open issues have been resolved. 1545 1. Provide references within the REFERENCE clauses in the MIB 1546 module. 1548 2. Identify all objects requiring non-volatile storage in their 1549 DESCRIPTION clauses. 1551 3. Request an initial review of this MIB module by a MIB Doctor 1552 familiar with the work of the DISMAN WG, preferably an author of 1553 the dismanEventMIB module. 1555 Appendix C. 1557 *************************************************************** 1558 * Note to the RFC Editor (to be removed prior to publication) * 1559 * * 1560 * 1) The reference to RFCXXXX within the DESCRIPTION clauses * 1561 * of the MIB module point to this draft and are to be * 1562 * assigned by the RFC Editor. * 1563 * * 1564 * 2) The reference to RFCXXX2 throughout this document point * 1565 * to the current draft-ietf-manet-report-xx.txt. This * 1566 * need to be replaced with the XXX RFC number. * 1567 * * 1568 *************************************************************** 1570 Authors' Addresses 1572 Robert G. Cole 1573 US Army CERDEC 1574 6010 Frankford Road 1575 Aberdeen Proving Ground, Maryland 21005 1576 USA 1578 Phone: +1 443 395 8744 1579 EMail: robert.g.cole@us.army.mil 1581 Joseph Macker 1582 Naval Research Laboratory 1583 Washington, D.C. 20375 1584 USA 1586 EMail: macker@itd.nrl.navy.mil 1587 Andy Bierman 1588 YumaWorks, Inc. 1589 Redwood City, CA 94065 1591 EMail: andy@yumaworks.com