Internet Engineering Task Force R. Cole Internet-Draft US Army CERDEC Intended status: Experimental J. Macker Expires:May 4, 2013June 10, 2015 Naval Research Laboratory A. Bierman YumaWorks, Inc.November 05, 2012December 7, 2014 Definition of Managed Objects for Performance Reportingdraft-ietf-manet-report-mib-03draft-ietf-manet-report-mib-04 Abstract This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it describes objects for configuring autonomous report generation on any device that supports MIBs containingcounter and gaugeobjects that resolve to type Integer32 (i.e., Integer32, Counter, Gauge, or TimeTicks). to be used for performance monitoring. This allows a management station to instruct a device to build off-line reports to be collected either through notifications to the management station or queried asynchronously by the management station.Further, this REPORT-SAMPLED-MIB can be configured in a proxy configuration where the report generation is performed on a device in close network proximity to the device containing the referenced counter objects.Hence, this capability allows network operators to reduce the SNMP polling traffic burden on Mobile Ad-Hoc and Disruption Tolerant Networks which istypicalproblematic of SNMP performance management applications. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire onMay 4, 2013.June 10, 2015. Copyright Notice Copyright (c)20122014 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. The Internet-Standard Management Framework . . . . . . . . . . 3 3. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 4 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4.1.REPORT-SAMPLED-MIBreportSampledMIB Module Management Model . . . . . . . . .. .4 4.2. Terms . . . . . . . . . . . . . . . . . . . . . . . . . .65 5. Structure of the MIB Module . . . . . . . . . . . . . . . . . 6 5.1. Textual Conventions . . . . . . . . . . . . . . . . . . .67 5.2.The Sampled Group .Tables and Indexing . . . . . . . . . . . . . . . . . . . 75.3. The Notifications Group . . . . . . . .6. Relationship to Other MIB Modules . . . . . . . . .7 5.4. Tables and Indexing. . . . . 8 6.1. Relationship to the SNMPv2-MIB . . . . . . . . . . . . . .7 6.8 6.2. Relationship toOther MIB Modulesthe RMON2-MIB . . . . . . . . . . . . . .8 6.1.9 6.3. Relationship to theSNMPv2-MIB . . .DISMAN-EVENT-MIB . . . . . . . . . . . 96.2.6.4. Relationship to theRMON2-MIBDISMAN-EXPRESSION-MIB . . . . . . . .. . . . . . 9 6.3.10 6.5. MIB modules required for IMPORTS . . . . . . . . . . . . .910 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . .911 8. Security Considerations . . . . . . . . . . . . . . . . . . .2126 9. Applicability Statement . . . . . . . . . . . . . . . . . . .2429 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . .2530 11. Contributors . . . . . . . . . . . . . . . . . . . . . . . . .2530 12. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . .2530 13. References . . . . . . . . . . . . . . . . . . . . . . . . . .2530 13.1. Normative References . . . . . . . . . . . . . . . . . . .2530 13.2. Informative References . . . . . . . . . . . . . . . . . .2631 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . .2631 Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . .2833 Appendix C. . . . . . . . . . . . . . . . . . . . . . . . . . .2834 1. Introduction This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it describes objects for configuring autonomous, off- line report generation for performance monitoring on any device supporting MIBs containing variables that resolve to type Integer32 (i.e., Integer32, Counter, Gauge, or TimeTicks). ThisREPORT- SAMPLED-MIBreportSampledMIB module allows for the report generation to occur on the same device as containing the referenced counterobject or on a device in close network proximity to the device with the referenced counterobject. This should be useful to devices or networks where efficient use of bandwidth is of concern or where intermittent connectivity is common. Hence, theREPORT-SAMPLED-MIBreportSampledMIB module is useful for devices managed over some Mobile Ad-Hoc Networks (MANETs) or Disruption Tolerant Networks (DTNs). This version of theREPORT-SAMPLED-MIBreportSampledMIB module offers one type ofoff-lineoff- line reporting. The MIB offers a means to collect sampleddatameasurements related to defined MIB objects. This type of reporting is contained in thereportSampledGroup.reportSampledMibObjects. Other types of report data are possible, including statisticaldata and historicaldata. However, it was felt wise to focus on a more limited scope off-line reporting capability and gain experimental use and application prior to expending energy developing a more extensive off line reporting capability.For the collection of sampled data, the REPORT-SAMPLED-MIB draws directly from the usrHistoryGroup from RMON 2 [RFC2021] through application of the 'AUGMENTS' clause. . Here the reportSampledControlTable allows the user to define aspects of the report for sampled data, includingThe reportSampledMIB module relies upon thenumber of MIB objectsdismanEventMIB module RFC 2981 [RFC2981] tobe sampled andmonitor thenatureprogress of reports being developed within thesampling frequencyreportSampledMIB module andoverall report duration. This group uses the notion of buckets, which contain sampled data from a set of identified MIB objects sampled at the same time point. The report consists of the buckets, eachto trigger an events, i.e., notifications containingsets of sampled data from the selected MIB objects butreports, at thespecific samplingappropriate times.The reportSampledObjectTable allowsThis is discussed below in more detail in theusersection entitled 'Relationship toidentifythemultiple MIBDISMAN-EVENT-MIB'. Further, more sophisticated performance objectsto be sampled. The reportSampledDataTable containsfor monitoring from thestorage ofreportSampledMIB module can be defined through thereported sampled data contained within buckets, one bucket for each time sampling instance.dismanExpressionMIB module RFC 2982 [RFC2982] 2. The Internet-Standard Management Framework For a detailed overview of the documents that describe the current Internet-Standard Management Framework, please refer to section 7 of RFC 3410 [RFC3410]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. MIB objects are generally accessed through the Simple Network Management Protocol (SNMP). Objects in the MIB are defined using the mechanisms defined in the Structure of Management Information (SMI). This memo specifies a MIB module that is compliant to the SMIv2, which is described in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 [RFC2580]. 3. Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119]. 4. Overview TheREPORT-SAMPLED-MIBreportSampledMIB module references performance objects in other MIBs(and in other devices)and generates off-line performance reports related to those referenced objects. TheREPORT-SAMPLED-MIBreportSampledMIB module can be coincident with the other MIBor can residemodules onanother device in close network proximity tothe same device containing the referenced performance related object. 4.1.REPORT-SAMPLED-MIBreportSampledMIB Module Management Model This section describes the management model for theREPORT-SAMPLED- MIBreportSampledMIB module process.Figure 1 illustrates a potential use ofThe reportSampledMIB module objects are primarily contained within four tables. These are: o reportSampledControlTable - this is theREPORT-SAMPLED-MIB forcontrol table within thegenerationreportSampledMIB module. This identifies the OIDs to be monitored which define the core ofoff-line, remotely generated reports.the Reports. Themanagement station oncontrol table sets theleft hand side ofsampling frequency for theillustration instructsMeasurements and theremote device to create reports through manipulationnumber of Measurements that will define each Report. o reportSampledCurrentReportsStatusTable - This table tracks theReportCntrl Objects in the REPORT-SAMPLED-MIB resident onstatus, i.e., theremote device. The reports instructcurrent number of collected Measurements per each Study. This information can be used by thedevicedismanEventMIB module to determine when to trigger a notification tomonitorthestatus of specified counters (on other MIBsReport owner containing the Measurements andpotentially on other devicesassociated data comprising the just completed Report. o reportSampledCurrentReportsTable - This table holds the Measurements for the Reports which are inclose network proximity) periodically.current development. o reportSampledHistoricalReportsTable - This table holds the completed Reports for each Study for archival purposes, i.e., the Study owners can perform table walks to retrieve archived Reports or Studies. Thereports are stored locally untilbelow figure illustrates themanagement station decidesfour main tables within the reportSampledMIB module. Further, if the dismanEventMIB module is so configured topull them offgenerate triggered notifications, thedevice. Thebelow figureshows a case wherehighlights the 'boolean trigger' and theREPORT-SAMPLED-MIB generates anotificationthat Report_2 has completed, promptinggeneration. The figure further illustrates themanagement station to pull Report_2movement of completed Reports from thedevice. Mgmt Device Station REPORT-SAMPLED-MIB MIB_1 +---------+ +-----+reportSampledCurrentReportsTable to the reportSampledHistoricalReportsTable upon Report Completion. +---------------------------------------------------+ | reportSampledControlEntry | | { reportSampledStudyStudyIndex } |Build_Rep_1 |+-------+| +--+|+----------------->||cntrl_1||<------>|PC|||+-------+|<-+ +--+--+| | | reportSampledStudyNumberReportMeasurements------>----+ +---------------------------------------------------+ | (boolean +---------------------------------------------------+ trigger)->--+ | reportSampledCurrentReportsStatusEntry |MIB_2| | |+-----+{ reportSampledStudyStudyIndex } | | | | | | |+--+| | |+---->|PC||Build_Rep_2 |+-------+| +-->+--+--+ +----------------->||cntrl_2||<---+ |+-------+|| reportSampledNumberOfMeasurementsForCurrentReport--->---+ | +---------------------------------------------------+ | V +---------------------------------------------------+ |Build_Rep_3 |+-------+| +----------------->||cntrl_3||<---+ MIB_n |+-------+||+-----+reportSampledCurrentReportsEntry | | | { reportSampledStudyStudyIndex, |---->--------+ | reportSampledCurrentMeasurementIndex } ||+-----+| |+--+|-->---+ |||Rep_1|+---------------------------------------------------+ |+-->|PC|||+-----+(move) |+--+--++---------------------------------------------------+ | ||+-----+|<------------------||Rep_2|reportSampledHistoricalReportsEntry |Notf_Rep_2 |+-----+| | ||+-----+{ reportSampledStudyStudyIndex, |||Rep_3|||+-----+|Get_Rep_2| reportSampledHistoricalReportIndex, |<--+ |+----------------->|| reportSampledHistoricalMeasurementIndex } | |<-----------------+||Send_Rep_2 +---------+ Figure 1: REPORT-SAMPLED-MIB front-end report generation process. This version of the REPORT-SAMPLED-MIB provides for the collection of sampled data instead of statistical data. It does this by augmenting the usrHistory group from RMON2 [RFC2021] which allows for the generation of reports collecting the sampled object values binned for the purpose of aggregation and efficiency of collection. These are defined within the reportSampledGroup. The model used for this type of report generation is based upon three tables. The reportSampledControlTable defines aspects of the report generation related to duration of the reporting interval, the bin (or bucket) sizes for the report, and the number of object values collected for each bucket. The reportUsrHistoryObjectTable identifies the specific MIB objects whose values are binned within the report. And the reportSampledDataTable contains the binned data values collected for the report.| | +---------------------------------------------------+ | V (notifications) 4.2. Terms The following definitions apply throughout this document: oControlSampled -Objects defined within this document which set the parameters for specific reports to be generated offlineperiodic measurement of target OIDs. o Measurement - a single instance of a sampling event. o Report - a collection of consecutive Measurements on the same Sampled target OID. o Study - a series of Reports on theremote managed device.same Sampled target OID. oDataCurrent Report -Objectsa Report whichholdis in thesampled report data.process of being developed. o A Completed Report - contains a pre-defined number of Sampled Measurements. o Historical Report - a Report which has previously Completed, and is being stored locally for archival purposes. 5. Structure of the MIB Module This section presents the structure of theREPORT-SAMPLED-MIBreportSampledMIB module. The objects are arranged into the following groups: oreportSampledMIBNotificationsreportSampledMibNotifications - defines the notifications associated with theREPORT-SAMPLED-MIB.reportSampledMIB module. These objects define notifications which track the behavior of the reportSampledMib module. A single notification is defined in the reportSampledMIB module which reports a series of failed measurement attempts in the process of building a Report. Associated with this notification is a control object which defines a threshold of failures which would initiate the notification. These notifications do not cover the triggered notifications which carry the performance Reports generated by the reportSampledMib module. These triggered notifications are defined through the use of the dismanEventMIB module. oreportSampledMIBObjectsreportSampledMibObjects - defines the objects forming the basis for theREPORT-SAMPLED-MIB.reportSampledMIB module. These objects are basically divided up by function into the followinggroups (currently only one group is defined): ofour tables: *Sampled GroupreportSampledControlTable - This group contains the objects which support the generation (collection) ofreportsStudies comprising of Reports exposing sampleddataMeasurement values.o reportSampledMIBConformance* reportSampledCurrentReportsStatusTable -Defines a variety of conformance of implementations of this REPORT-SAMPLED-MIB. 5.1. Textual Conventions No textual conventions are used in the REPORT-SAMPLED-MIB. 5.2. The Sampled Group The Sampled GroupThis group containstables which allows forthedevelopment of reports based upon sampling the referenced counterobjectsat specified intervals. The development of this group within the REPORT-SAMPLED-MIBwhichaugments the User History group from the RMON 2 MIB [RFC2021]. The Sampled Group is composed of: o reportSampledControlTable - allows for the setting oftrack theparameterscollection of Measurements for current (in-progress) Reports. This table allows thereport. o reportSampledObjectTable - sets the referenced objectsdismanEventMIB module tobe sampled during the test. With this capability, the management application can reference multiple objects, all ofset triggers for Completed Reports whichare sampled duringit can then send to thetest and reported outreport owner throughthe reportSampledData Table. o reportSampledDataTabletriggered notifications. * reportSampledCurrentReportsTable - This group contains thereports. 5.3. The Notifications Group The Notifications Sub-tree containsobjects which represent thelist of notifications supported withinMeasurement data associated with Current (in-progress) Reports. Once theREPORT-SAMPLED-MIB and their intended purpose or utility. The single notification defined within this MIB moduleReport completes, it is moved to the'reportSampledNewDataReport'.reportSampledHistoricalReportsTable for archival purposes. * reportSampledHistoricalReportsTable - Thisnotification is sent by the agent upon completion of a given report on the device. The notificationgroup contains thefollowing objects: 'usrHistoryControlOwner',objects which represent archived Completed Reports. This allows theentity that configured thisreportentry, and the 'reportSampledReportIndex', the index of the dataowners to asynchronously retrieve Reports via tableforwalks if so desired. o reportSampledMibConformance - Defines a single basic conformance of implementations of thisreport. Collectively, these objects allow the management application to pull the completed report fromreportSampledMIB module. 5.1. Textual Conventions No textual conventions are defined in theagent. 5.4.reportSampledMIB module. 5.2. Tables and Indexing TheREPORT-SAMPLED-MIBreportSampledMIB module containsa number offour tables which control and record data relatedto:to the creation, notification and storage of Reports. Specifically: o the control and generation of remote performancereports,Reports, i.e., reportSampledControlTable o thestoragestatus ofremote performance reports,the Current Reports' development, i.e., reportSampledCurrentReportsStatusTable, o the Current Reports development and interim data, i.e., reportSampledCurrentReportsTable, and o thenotificationhistorical storage of remotereport completion.performance Reports, i.e. reportSampledHistoricalReportsTable. TheREPORT-SAMPLED-MIBreportSampledMIB module's tables are indexed via the following constructs: ousrHistoryControlIndexreportSampledStudyIndex -from the RMON2-MIB [RFC2021],an index that uniquely identifiesan entry in the usrHistoryControlTable. Each such entry defines a set of samples ata particularinterval for a specified setStudy. The Study is comprised ofMIB instances available frommultiple Reports, themanaged system.number of Reports being stored is defined by the reportSampledStudyMaximumNumberOfHistoricalReports object. ousrHistoryObjectIndexreportSampledCurrentMeasurementIndex -from the RMON2-MIB,an indexused tothat uniquelyidentifyidentifies anentry in the usrHistoryObject table from the RMON2-MIB. Each such entry definesatomic Measurement associated with aMIB instance to be collected periodically.Report. oreportSampledReportIndexreportSampledHistoricalReportIndex - an index that uniquely identifiesthe particular reportanentry is associated with among the set of reports requested through the reportSampledControlNumber inarchived Completed Report resident within thereportSampledControlEntry.reportSampledHistoricalReportsTable. oreportSampledSampleIndexreportSampledHistoricalMeasurementIndex - an index that uniquely identifiesthe particular sample this entry represents among all samples associated with the same reportSampledControlEntry.an atomic Measurement comprising an archived Completed Report. These tables and their indexing are: o reportSampledControlTable - this table contains a list of data- collection configuration entries defining aspects of thereports.studies and their reports to be generated. These include, e.g., number ofreports, their start and stop times,reports per study, the number Reports to be archived, etc. This table'AUGMENTShas 'INDEX {usrHistoryControlEntryreportSampledStudyIndex }'. oreportSampledObjectTablereportSampledCurrentReportsStatusTable - this table containsa listobjects which track the development ofdata- collection configuration entriescurrent Reports, e.g., the number of current Measurements collected for each Report under development. This table has 'INDEX { reportSampledStudyIndex }'. For each (active) Study, there exists only one Current Report under development. o reportSampledCurrentReportsTable - this table contains the Measurements whichidentify specific MIB entries on other devices to monitor.are developing the Current Reports. This table'AUGMENTShas 'INDEX {usrHistoryObjectEntryreportSampledStudyIndex, reportSampledCurrentMeasurementIndex }'. oreportSampledTablereportSampledHistoricalReportsTable - this table containsa list of historical samples collected forthereport.Reports which have completed. This table has 'INDEX {usrHistoryControlIndex, reportSampledReportIndex, reportSampledSampleIndex, usrHistoryObjectIndexreportSampledStudyIndex, reportSampledHistoricalReportIndex, reportSampledHistoricalMeasurementIndex }'. 6. Relationship to Other MIB Modules The text of this section specifies the relationship of the MIB modules contained in this document to other standards, particularly to standards containing other MIB modules. Definitions imported from other MIB modules and other MIB modules that SHOULD be implemented in conjunction with the MIB module contained within this document are identified in this section. 6.1. Relationship to the SNMPv2-MIB The 'system' group in the SNMPv2-MIB [RFC3418] is defined as being mandatory for all systems, and the objects apply to the entity as a whole. The 'system' group provides identification of the management entity and certain other system-wide data. TheREPORT-SAMPLED-MIBreportSampledMIB module does not duplicate those objects. 6.2. Relationship to the RMON2-MIB TheREPORT-SAMPLED-MIBreportSampledMIB module is closely related to and was inspired by the the RMON2-MIB module [RFC2021] usrHistoryGroup.Specifically,The use of control tables to establish thereportSampledGroup is a direct copyperiodic collection of measurement data for creation of performance reports was pulled from earlier work on theRMON2 User History Group, withRMON2-MIB module. 6.3. Relationship to thenames changedDISMAN-EVENT-MIB The reportSampledMIB module was developed tocomplyfundamentally work with thenaming conventionsdismanEventMIB module RFC 2981 [RFC2981] in order to offer a complete and efficient off-line reporting capability for bandwidth challenged networks such as Mobile Ad-Hoc Networks (MANETs). This is accomplished through defining trigger test and associated notification actions indexed by mteOwner, mteTriggerName, mteObjectsName and mteEventName within theREPORT-SAMPLED-MIB. Further,dismanEventMIB module. Specifically (within thedesigndismanEventMIB module): In the mteTriggerTable andusespecifically by setting o 'mteTriggerTest == boolean(1)', o 'mteTriggerSampleType == absoluteValue(1)', o 'mteTriggerValueID == reportSampledNumberOfMeasurementsForCurrentReport', o 'mteTriggerValueIDWildcard == false(1)', o 'mteTriggerFrequency == 0.5*reportSampledStudySamplingInterval', and o 'mteTriggerEnabled == true'. In the mteTriggerBooleanTable and specifically by setting o 'mteTriggerBooleanComparison == equal(2)', o 'mteTriggerBooleanValue == value of reportSampledStudyNumberReportMeasurements', and o 'mteTriggerBooleanStartup == false'. In thecontrol tablesmteObjectsTable and specifically by setting o 'mteObjectsID == reportSampledCurrentMeasurementValue' and reportSampledCurrentMeasurementTime' and reportSampledCurrentMeasurementStatus' with o 'mteObjectsIDWildcard == true' // for each. In the mteEventTable and specifically by setting o 'mteEventActions == notification(0)' and o 'mteEventEnabled == true' // for each. In the mteEventNotificationTable and specifically by setting o 'mteEventNotification == mteTriggerFired' and the appropriate names for the o 'mteEventNotificationObjectOwner == mteOwner' and o 'mteEventNotificationObjects == mteObjectsName'. These settings within theREPORT- SAMPLED-MIB draw exactly fromdismanEventMIB module will result in notifications generated by thedefinition of these table structuresdismanEventMIB module which will carry the recently completed reportSampledMIB module reports. Set up properly, the dismanEventMIB module will trigger a notification each time the reportSampledCurrentTable contains a completed Report. This Report will be sent in a notification containing three columns of theearlier RMON MIBs throughreportSampledCurrentTable, i.e., the Value, the Time and the Status, due to the use ofthe 'AUGMENTS' clausewildcarding within the'reportSampledControlTable'dismanEventMIB module. Simultaneously, the reportSampledMIB module will move the completed Current Report into the reportSampledHistoricalReportsTable and restart collection for the'reportSampledTable' in this MIB module. 6.3.next Report within the reportSampledCurrentReportsTable. 6.4. Relationship to the DISMAN-EXPRESSION-MIB In conjunction with the dismanExpressionMIB module RFC 2982 [RFC2982], the reportSampledMIB module can be used to develop reports on relatively sophisticated object expressions. 6.5. MIB modules required for IMPORTS Citations are not permitted within a MIB module, but any module mentioned in an IMPORTS clause or document mentioned in a REFERENCE clause is a Normative reference, and must be cited someplace within the narrative sections. Therefore, the imported items in this MIB module, such as Textual Conventions, that are not already cited, are cited in this section. Since relationships to other MIB modules should be described in the narrative text, this section will cite modules from which Textual Conventions are imported. TheREPORT-SAMPLED-MIBreportSampledMIB module IMPORTS objects from SNMPv2-SMI [RFC2578], SNMPv2-TC [RFC2579], SNMPv2-CONF [RFC2580],IF-MIB [RFC2863],SNMP- FRAMEWORK-MIB [RFC3411], andINET-ADDRESS-MIB [RFC4001]. Significantly, the REPORT-SAMPLED-MIB module also IMPORTS objects from the RMON2-MIB module [RFC2021].SNMPv2-MIB [RFC3418]. 7. Definitions REPORT-SAMPLED-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, Gauge32, Integer32, experimental FROM SNMPv2-SMI -- [RFC2578] TimeStamp FROM SNMPv2-TC -- [RFC2579] sysUpTime FROM SNMPv2-MIB -- [RFC3418] SnmpAdminString FROM SNMP-FRAMEWORK-MIB -- [RFC3411] MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF -- [RFC2580]usrHistoryControlEntry, usrHistoryObjectEntry, usrHistoryControlIndex, usrHistoryControlOwner, usrHistoryObjectIndex -- usrHistoryControlObjects, usrHistoryControlBucketsRequested, -- usrHistoryControlBucketsGranted, usrHistoryControlInterval, -- usrHistoryControlStatus, -- usrHistoryObjectVariable, usrHistoryObjectSampleType FROM RMON2-MIB -- [RFC2021] InetAddress, InetAddressType FROM INET-ADDRESS-MIB -- [RFC4001]; reportSampledMIB MODULE-IDENTITY LAST-UPDATED"201211051300Z""201412011300Z" --November 05, 2012December 01, 2014 ORGANIZATION "IETF MANET Working Group" CONTACT-INFO "WG E-Mail: manet@ietf.org WG Chairs: sratliff@cisco.com jmacker@nrl.navy.mil Editors: Robert G. Cole US Army CERDEC 6010 Frankford Road Aberdeen Proving Ground, MD 21005 USA +1 443 395-8744 robert.g.cole@us.army.mil Joseph Macker Naval Research Laboratory Washington, D.C. 20375 USA macker@itd.nrl.navy.mil Andy Bierman YumaWorks, Inc. andy@yumaworks.com" DESCRIPTION "This MIB module contains managed object definitions for the autonmous reporting of performance object counters. Copyright (C) The IETF Trust (2009). This version of this MIB module is part of RFC xxxx; see the RFC itself for full legal notices." -- Revision History REVISION "201412011300Z" -- December 01, 2014 DESCRIPTION "The ninth draft of this MIB module published as draft-ietf-manet-report-mib-04.txt. Revisions to this draft include a) A major restructuring of the MIB module in order to leverage the dismanEventMIB module for the automatic notification of Completed Reports. b) Efforts to incorporate this MIB module into the DISMAN management architecture. " REVISION "201211051300Z" -- November 05, 2012 DESCRIPTION "The seventh draft of this MIB module published as draft-ietf-manet-report-mib-03.txt. Revisions to this draft include a) Added a 'Tables and Indexing' section to the body of this document. b) Added an 'Applicability Statement' section to the body of this document." REVISION "201201311300Z" -- January 31, 2012 DESCRIPTION "The sixth draft of this MIB module published asdraft-ietf-manet-report-mib-02.txt.Revisions to this draft include a) Pulled the statistical and historical reporting from the MIB module and left only the sampled reporting, in order to greatly simplify the first instance of this reporting MIB module. b) Renamed the module, theREPORT-SAMPLED-MIBreportSampledMIB module. c) Leveraged the RMON2-MIB module more effectively through the use of the AUGMENTS clause. d) Changed the module to 'experimental'." REVISION "201102171300Z" -- February 17, 2011 DESCRIPTION "The fifth draft of this MIB module published as draft-ietf-manet-report-mib-01.txt. This document has been promoted to a MANET Working Group draft. Revisions to this draft include a) Proposed changes to the statsReport table to simplify communications between device and mgmt application, b) Added Notifications, c) Changed the reporting structure of the Sampled and the History reporting to align with the structure of the Statistics reports for the purpose of allowing for efficient notification and collection of data reports. d) Ran through smilint to clean up all errors and most warning. A few still remain." REVISION "201007051300Z" -- July 05, 2010 DESCRIPTION "The fourth draft of this MIB module published as draft-ietf-manet-report-mib-00.txt. This document has been promoted to a MANET Working Group draft. Significant revisions to this draft include a) added support for proxy configurations through the addition of address objects associated with the referenced counter objects associated with the performance reports." REVISION "201003021300Z" -- March 02, 2010 DESCRIPTION "The third draft of this MIB module published as draft-cole-manet-report-mib-02.txt. Significant revisions to this draft include a) changed naming of usrHistoryGroup to sampledGroup and b) added a historyGroup." REVISION "200910251300Z" -- October 25, 2009 DESCRIPTION "The second draft of this MIB module published as draft-cole-manet-report-mib-01.txt. Significant revisions to this draft include a) the inclusion of raw data collection borrow blatently from the usrHistory Group within RMON2, b) the deletion of the CurrentHistoryTable from version -00, c) modifications to the overall structure of the MIB, and d) the definition of various Compliance options for implementations related to this MIB." REVISION "200904281300Z" -- April 28, 2009 DESCRIPTION "Initial draft of this MIB module published as draft-cole-manet-report-mib-00.txt." -- RFC-Editor assigns XXXX ::= { experimental 998 } -- to be assigned by IANA -- TEXTUAL CONVENTIONs -- None -- -- Top-Level Object Identifier Assignments --reportSampledMIBNotificationsreportSampledMibNotifications OBJECT IDENTIFIER ::= { reportSampledMIB 0 }reportSampledMIBObjectsreportSampledMibObjects OBJECT IDENTIFIER ::= { reportSampledMIB 1 }reportSampledMIBConformancereportSampledMibConformance OBJECT IDENTIFIER ::= { reportSampledMIB 2 }reportSampledGroup OBJECT IDENTIFIER ::= { reportSampledMIBObjects 1 }--Then, the reportSampledGroupThe reportSampledMibObjects assignments are : -- reportSampledControlTable - 1 --reportSampledObjectTablereportSampledCurrentReportsStatusTable - 2 --reportSampledDataTablereportSampledCurrentReportsTable - 3 -- reportSampledHistoricalReportsTable - 4 -- -- The Control Table -- reportSampledControlTable OBJECT-TYPE SYNTAX SEQUENCE OFSampledControlEntryreportSampledControlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Alist of data-collection configuration entries. Thistableaugments the 'usrHistoryControlTable' from RMON2-MIB (RFC 2021)."to configure measurement Studies which are comprised of multiple Reports." REFERENCE"RFC 2021 - Remote Network Monitoring Management Information Base Version 2 (RMON2-MIB), Waldbusser, S., January 1997.""tbd." ::= {reportSampledGroupreportSampledMibObjects 1 } reportSampledControlEntry OBJECT-TYPE SYNTAXSampledControlEntryReportSampledControlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A list of parameters thatset up a groupcontrol the creation ofuser-defined MIBoff-line performance Studies. The objects in this table are persistent and when written the device SHOULD save the change tobe sampled periodically (called a bucket-group).non-volatile storage. Forexample, an instance of reportSampledControlInterval might be named reportSampledControlInterval.1" AUGMENTSfurther information on the storage behavior for these objects, refer to the description for the reportSampledStudyEntryStatus object." INDEX {usrHistoryControlEntryreportSampledStudyIndex } ::= { reportSampledControlTable 1 }SampledControlEntryReportSampledControlEntry ::= SEQUENCE {reportSampledControlRequestedNumberreportSampledStudyIndex Integer32,reportSampledControlReportNumber Integer32reportSampledStudyOwner SnmpAdminString, reportSampledStudyName SnmpAdminString, reportSampledStudyOid Integer32, reportSampledStudySamplingInterval Integer32, reportSampledStudyNumberReportMeasurements Integer32, reportSampledStudyMaximumNumberOfHistoricalReports Integer32, reportSampledStudyEntryStatus RowStatus }reportSampledControlRequestedNumberreportSampledStudyIndex OBJECT-TYPE SYNTAX Integer32 (1..127) MAX-ACCESS not-accessible STATUS current DESCRIPTION "A unique index that identifies a specific performace Study. Each Study is comprised of multiple Reports. Each Report is comprised of multiple atomic Measurements on a specified object." ::= { reportSampledControlEntry 1 } reportSampledStudyOwner OBJECT-TYPE SYNTAX SnmpAdminString (SIZE (0..32)) MAX-ACCESS read-create STATUS current DESCRIPTION "Thenumberowner ofreports to be generated and stored by this agent for this report request. This object may not be modified iftheassociated reportSampledControlStatusStudy." DEFVAL { ''H } ::= { reportSampledControlEntry 2 } reportSampledStudyName OBJECT-TYPE SYNTAX SnmpAdminString (SIZE (0..32)) MAX-ACCESS read-create STATUS current DESCRIPTION "The name of the Study." DEFVAL { ''H } ::= { reportSampledControlEntry 3 } reportSampledStudyOid OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION "The target OID of the Study. Each Study makes periodic Measurements on a specified object which isequallocal toactive(1)."this device. Currently, the objects of study are limited to objects that resolve to Integer32 (i.e., Integer32, Counter, Gauge, or TimeTicks)." ::= { reportSampledControlEntry 4 } reportSampledStudySamplingInterval OBJECT-TYPE SYNTAX Integer32 (1..2147483647) UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The time (in seconds) between sampled Measurement instances." DEFVAL {110 } ::= { reportSampledControlEntry15 }reportSampledControlReportNumberreportSampledStudyNumberReportMeasurements OBJECT-TYPE SYNTAX Integer32(1..127)(1..2147483647) UNITS "count" MAX-ACCESSread-onlyread-create STATUS current DESCRIPTION "The number oftheMeaurements per Report for this Study." DEFVAL { 10 } ::= { reportSampledControlEntry 6 } reportSampledStudyMaximumNumberOfHistoricalReports OBJECT-TYPE SYNTAX Integer32 (1..2147483647) UNITS "count" MAX-ACCESS read-create STATUS currentreportDESCRIPTION "The number of Historical Reports to archive locally for this specific Study. The Historical Reports are archived locally inprogress.the reportSampledHistoricalReportsTable (below)." DEFVAL { 10 } ::= { reportSampledControlEntry 7 } reportSampledStudyEntryStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This object permits management of this table by facilitating actions such as row creation, construction, and destruction. Thefirst report is assignedvalue of this object has no effect on whether other objects in this conceptual row can be modified. An entry may not exist in the 'active' state unless all objects in the entry have anumber equaldefined appropriate value. For objects with DEFVAL clauses, the management station does not need to'1'. Each successive report numberspecify the value of these objects in order for the row to transit to the 'active' state; the default value for these objects isincremented by unity. Whenused. For objects that do not have DEFVAL clauses, then thelast reportnetwork manager MUST specify the value of these objects prior to this row transitioning to the 'active' state. When this object transitions to 'active', all objects in this row SHOULD be written to non-volatile (stable) storage. Read-create objects in this row MAY be modified. When an object in a row with smfCfgIfRowStatus of 'active' iscompleted,changed, then the updated value MUST be reflected in SMF and this new object value MUST be written to non-volatile storage. If this object issetnot equal toreportSampledControlRequestedNumber + 1."'active', all associated entries in the reportSampledCurrentReportsStatusTable, the reportSampledCurrentReportsTable, and the reportSampledHistoricalReportsTable MUST be deleted." ::= { reportSampledControlEntry28 } --Object table reportSampledObjectTable-- the Current Reports Status Table -- reportSampledCurrentReportsStatusTable OBJECT-TYPE SYNTAX SEQUENCE OFSampledObjectEntryreportSampledCurrentReportsStatusEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Alist of data-collection configuration entries. Thistableaugmentsto tracking the'usrHistoryObjectTable' fromprogress of measurements of current reports in development. Of particular note is theRMON2-MIB (RFC 2021)."object reportSampledNumberOfMeasurementsForCurrentReport which can be compared to the value of the object reportSampledStudyNumberReportMeasurements by the dismanEventMIB module and generate triggered notifications to the Study owner containing the recently Completed Reports." REFERENCE"RFC 2021 - Remote Network Monitoring Management Information Base Version 2 (RMON2-MIB), Waldbusser, S., January 1997.""tbd." ::= {reportSampledGroupreportSampledMibObjects 2 }reportSampledObjectEntryreportSampledCurrentReportsStatusEntry OBJECT-TYPE SYNTAXSampledObjectEntryReportSampledCurrentReportsStatusEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A list ofMIB instances to be sampled periodically. Entries in this table are created when an associated reportSampledControlObjects object is created. The usrHistoryControlIndex value in the index isparameters thatoftrack theassociated reportSampledControlEntry. For example, an instancestatus ofreportSampledObjectVariable might be reportSampledObjectVariable.1.3" AUGMENTScurrent Reports in development." INDEX {usrHistoryObjectEntryreportSampledStudyIndex } ::= {reportSampledObjectTablereportSampledCurrentReportsStatusTable 1 }SampledObjectEntryReportSampledCurrentReportsStatusEntry ::= SEQUENCE {reportSampledObjectIpAddrType InetAddressType, reportSampledObjectIPAddress InetAddressreportSampledNumberOfCurrentReport Integer32, reportSampledNumberOfMeasurementsForCurrentReport Integer32 }reportSampledObjectIpAddrTypereportSampledNumberOfCurrentReport OBJECT-TYPE SYNTAXInetAddressTypeInteger32 (1..2147483647) UNITS "count" MAX-ACCESSread-createread-only STATUS current DESCRIPTION"This identifies"The number within theIP address typeStudy series of this current Report. For each new Report within theIP address associated withStudy, this value MIUST increment by one. For thesecondary counter object to be monitored withinfirst Report in thisreport. OnlyStudy, thevalues ipv4(1) and ipv6(2) are supported. Thisinitial value of this objectmay notMUST bemodified if the associated reportStatsControlStatus object is equalset to one. The value MUST wrap back toactive(1)."one when the value has reached the maximum." ::= {reportSampledObjectEntryreportSampledCurrentReportsStatusEntry 1 }reportSampledObjectIPAddressreportSampledNumberOfMeasurementsForCurrentReport OBJECT-TYPE SYNTAXInetAddress (SIZE(4|16))Integer32 (1..2147483647) UNITS "count" MAX-ACCESSread-createread-only STATUS current DESCRIPTION"This identifies the IP addree"The number ofthe secondary counterMeasurements collected so far for for this specific Report. The initial value of this objecttoMUST bemonitored withinone. The value MUST increment be one for each attempted Measurement. The maximum value for thisreport. Thisobjectmay notis reportSampledStudyNumberReportMeasurements. Once this value is reached and the next Measurement is attempted, the Current Report is considered Completed, the agent MUST copy the Completed Report's data from the reportSampledCurrentReportsTable into the reportSampledHistoricalReportsTable, and the next Measurement (strating the next Report in the Study series) MUST bemodified ifnumbered with theassociated reportStatsControlStatusvalue of this objectis equal to active(1)."as one." ::= {reportSampledObjectEntryreportSampledCurrentReportsStatusEntry 2 } --data table reportSampledTable-- the Current Reports Table -- reportSampledCurrentReportsTable OBJECT-TYPE SYNTAX SEQUENCE OFSampledEntryReportSampledCurrentReportsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A list ofuser defined history entries."measurements being collected for active Reports." REFERENCE " TBD." ::= {reportSampledGroupreportSampledMibObjects 3 }reportSampledEntryreportSampledCurrentReportsEntry OBJECT-TYPE SYNTAXSampledEntryReportSampledCurrentReportsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Ahistorical samplelist ofuser-defined variables. This sample is associated with the reportSampledControlEntry which set upentries storing theparameters for a regular collection of these samples. The usrHistoryControlIndex value,measurements from active Reports. Once an active, current Report completes (when theRMON2-MIB (RFC 2021), invalue of theindex identifiesassociated reportSampledNumberOfMeasurementsForCurrentReport equals thereportSampledControlEntry on whose behalf this entry was created. The usrHistoryObjectIndexvalueinof theindex identifiesassociated reportSampledStudyNumberReportMeasurements), thereportSampledObjectEntry on whose behalf this entry was created. For example, an instance of reportSampledAbsValue, which representsagent MUST move the14th sample of a variable collected as specified by reportSampledControlEntry.1 and reportSampledObjectEntry.1.5, would be named reportSampledAbsValue.1.14.5" REFERENCE "RFC 2021 - Remote Network Monitoring Management Information Base Version 2 (RMON2-MIB), Waldbusser, S., January 1997."Report's data from the reportSampledCurrentReportsTable to the reportSampledHistoricalReportTable." INDEX {usrHistoryControlIndex, reportSampledReportIndex, reportSampledSampleIndex, usrHistoryObjectIndexreportSampledStudyIndex, reportSampledCurrentMeasurementIndex } ::= {reportSampledTablereportSampledCurrentReportsTable 1 }SampledEntryReportSampledCurrentReportsEntry ::= SEQUENCE {reportSampledReportIndexreportSampledCurrentMeasurementIndex Integer32,reportSampledReportIDreportSampledCurrentMeasurementValue Integer32,reportSampledSampleIndex Integer32, reportSampledIntervalStart TimeStamp, reportSampledIntervalEnd TimeStamp, reportSampledAbsValue Gauge32, reportSampledValStatusreportSampledCurrentMeasurementTime sysUpTime, reportSampledCurrentMeasurementStatus INTEGER }reportSampledReportIndexreportSampledCurrentMeasurementIndex OBJECT-TYPE SYNTAX Integer32(1..127)(1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An indexthat uniquely identifiesfor this table which represents theparticular reportnumber of Measurements collected so far for for thisentrycurrent Report. The initial value of this object MUST be one. The value MUST increment be one for each attempted Measurement. The maximum value for this object isassociated with amongreportSampledStudyNumberReportMeasurements. Once this value is reached and theset of reports requested throughnext Measurement is attempted, thereportSampledControlNumber inCurrent Report is considered Completed, thereportSampledControlEntry. This index starts at 1agent MUST copy the Completed Report's data from the reportSampledCurrentReportsTable into the reportSampledHistoricalReportsTable, andincreases by onethe next Measurement (strating the next Report in the Study series) MUST be numbered with the value of this object aseach new report is generated."one." ::= {reportSampledEntryreportSampledCurrentReportsEntry 1 }reportSampledReportIDreportSampledCurrentMeasurementValue OBJECT-TYPE SYNTAX Integer32(1..127)(1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION"An ID that uniquely identifies"A single measurement for this Study for this Current Report. The objects identifying theparticular reportmeasurement MUST resolve to type Integer32 (i.e., Integer32, Counter, Gauge, or TimeTicks). to be used for performance monitoring on thisentry is associated with amongdevice." ::= { reportSampledCurrentReportsEntry 2 } reportSampledCurrentMeasurementTime OBJECT-TYPE SYNTAX sysUpTime MAX-ACCESS read-only STATUS current DESCRIPTION "The systemUpTime of thesetdevice on which the measurement was made for this Measurement." ::= { reportSampledCurrentReportsEntry 3 } reportSampledCurrentMeasurementStatus OBJECT-TYPE SYNTAX INTEGER { valueNotAvailable(1), valuePositive(2), valueNegative(3) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the validity and sign ofreports requested throughthereportSampledControlNumberdata in thereportSampledControlEntry. This ID is setassociated value recorded by the reportSampledCurrentMeasurementValue object." ::= { reportSampledCurrentReportsEntry 4 } -- -- Historical Reports Table -- reportSampledHistoricalReportsTable OBJECT-TYPE SYNTAX SEQUENCE OF ReportSampledHistoricalReportsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table archiving non-active Reports for each defined Study up toequala maximum number of Reports per Study." ::= { reportSampledMibObjects 4 } reportSampledHistoricalReportsEntry OBJECT-TYPE SYNTAX ReportSampledHistoricalReportsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A list of entries storing the measurements from Completed Reports. Once an active, current Report completes (when the value of thereportSampledReportIndex."associated reportSampledNumberOfMeasurementsForCurrentReport equals the value of the associated reportSampledStudyNumberReportMeasurements), the agent MUST move the Report's data from the reportSampledCurrentReportsTable to this reportSampledHistoricalReportTable." REFERENCE " TBD. " INDEX { reportSampledStudyIndex, reportSampledHistoricalReportIndex, reportSampledHistoricalMeasurementIndex } ::= {reportSampledEntry 2reportSampledHistoricalReportsTable 1 } ReportSampledHistoricalReportsEntry ::= SEQUENCE { reportSampledHistoricalReportIndex Integer32, reportSampledHistoricalMeasurementIndex Integer32, reportSampledHistoricalMeasurementValue Integer32, reportSampledHistoricalMeasurementTime sysUpTime, reportSampledHistoricalMeasurementStatus INTEGER }reportSampledSampleIndexreportSampledHistoricalReportIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An index that uniquely identifies the particularsampleReport archived in thisentry represents among all samples associated withtable for thesame reportSampledControlEntry. This index starts at 1 and increasesspecific Study (identified byone as each new sample is taken."the reportSampledStudyIndex)." ::= {reportSampledEntry 3reportSampledHistoricalReportsEntry 1 }reportSampledIntervalStartreportSampledHistoricalMeasurementIndex OBJECT-TYPE SYNTAXTimeStampInteger32 (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION"The value of sysUpTime at the start of the interval over which this sample was measured. If the probe keeps track of the time of day, it should start the first sample of the history at a time such"An index thatwhen the next hour of the day begins,uniquely identifies asample is started at that instant. Note that following this rule may require the probe to delay collecting the first sample of the history, as each sample must be of the same interval. Also note that the sample which is currently being collected is not accessibleMeasurement for a specific Report achived in this tableuntil the end of its interval."for a Specific Study." ::= {reportSampledEntry 4reportSampledHistoriclReportsEntry 2 }reportSampledIntervalEndreportSampledHistoricalReportsValue OBJECT-TYPE SYNTAXTimeStampInteger32(1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION"The value of sysUpTime at the end of"A single measurement for this Study for this Completed Report. The objects identifying theinterval over whichmeasurement MUST resolve to type Integer32 (i.e., Integer32, Counter, Gauge, or TimeTicks). to be used for performance monitoring on thissample was measured."device." ::= {reportSampledEntry 5reportSampledHistoriclReportsEntry 3 }reportSampledAbsValuereportSampledHistoricalMeasurementTime OBJECT-TYPE SYNTAXGauge32sysUpTime MAX-ACCESS read-only STATUS current DESCRIPTION "Theabsolute value (i.e. unsigned value)systemUpTime of theuser-specified statistic during the last sampling period. The value duringdevice on which thecurrent sampling period is notmeasurement was madeavailable until the period is completed. To obtain the true valuefor thissampling interval, the associated instance of reportSampledValStatus must be checked, and reportSampledAbsValue adjusted as necessary. If the MIB instance could not be accessed during the sampling interval, then this object will have a value of zero and the associated instance of reportSampledValStatus will be set to 'valueNotAvailable(1)'."Measurement." ::= {reportSampledEntry 6reportSampledHistoriclReportsEntry 5 }reportSampledValStatusreportSampledHistoricalMeasurementStatus OBJECT-TYPE SYNTAX INTEGER { valueNotAvailable(1), valuePositive(2), valueNegative(3) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the validity and sign of the data in the associatedinstance of reportSampledAbsValue. If the MIB instance could not be accessed during the sampling interval, then 'valueNotAvailable(1)' will be returned. If the sample is valid and actualvalueof the sample is greater than or equal to zero then 'valuePositive(2)' is returned. If the sample is valid and the actual value of the sample is less than zero, 'valueNegative(3)' will be returned. The associated instance of reportSampledAbsValue should be multipliedrecorded by-1 to obtainthetrue sample value."reportSampledHistoricalMeasurementValue object." ::= {reportSampledEntry 7reportSampledHistoriclReportsEntry 5 } -- -- Notifications -- -- The following notification objects to define issues with making -- and storing measurements. -- Actions which report data, i.e., Reports, are to be handled by -- the dismanEventMIB module. reportSampledNotificationObjects OBJECT IDENTIFIER ::={reportSampledMIBNotifications{reportSampledMibNotifications 0} reportSampledNotificationControl OBJECT IDENTIFIER ::= {reportSampledMibNotifications 1} -- -- reportSampledNotificationObjectsreportSampledNewDataReport-- reportSampledDataCollectionFailure NOTIFICATION-TYPE OBJECTS {usrHistoryControlOwner,reportSampledStudyOwner, -- The entity that -- configured thisentry reportSampledReportIDStudy reportSampledStudyName, -- TheIDname of the Study -- that is failing to -- collect measurement datatable forreportSampledStudyOid -- The Object ID being -- monitored in thisreportStudy } STATUS current DESCRIPTION"reportSampledNewDataReport"The reportSampledDataCollectionFailure is a notification sent when the number of consecutive measurement failures within anew report is completed fromCurrent Report, as indicated by consecutive values of thereportSampledControlTable. The notification carriesreportSampledCurrentMeasurementStatus being set to 'valueNotAvailable(1)', exceeds theindex fromvalue of thecontrol table that established this report andthreshold value defined in theindex fromreportSampledDataCollectionFailureThreshold object." ::= { reportSampledNotificationObjects 1 } -- -- nhdpNotificationsControl -- reportSampledDataCollectionFailureThreshold OBJECT-TYPE SYNTAX Integer32 (1..255) UNITS "count" MAX-ACCESS read-write STATUS current DESCRIPTION "A threshold value for thedata table that holds this report. Indicationnumber of consecutive measurement failures within a Current Report as indicated by consecutive values of thenew report is whenreportSampledCurrentMeasurementStatus being being set to 'valueNotAvailable(1)' which exceed thereportSampledControlReportNumbervalue of this threshold. A value of '255' for this threshold indicates that the reportSampledDataCollectionFailure notification isincremented."never to be sent. " DEFVAL { 10 } ::= {reportSampledNotificationObjectsnhdpNotificationsControl 1 } -- -- Compliance Statements -- -- Mandatory compliance forSampledthe reportSampledMIB module will -- includeall.all objects defined within the module. reportSampledCompliances OBJECT IDENTIFIER ::= { reportSampledMIBConformance 1 } reportSampledMIBGroups OBJECT IDENTIFIER ::= { reportSampledMIBConformance 2 } reportSampledCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "TheSampledreportSampled basic implementation requirements for managed network entities that implement the REPORT Sampled process." MODULE -- this module MANDATORY-GROUPS { reportSampledLocalGroup } ::= { reportSampledCompliances 1 }reportSampledNotificationCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The Sampled Notification implementation requirements for managed network entities that implement the REPORT process." MODULE--this module MANDATORY-GROUPS { reportSampledNotificationObjectGroup } ::= { reportSampledCompliances 2 }-- Units of Conformance -- reportSampledLocalGroup OBJECT-GROUP OBJECTS {reportSampledControlRequestedNumber, reportSampledControlReportNumber, reportSampledObjectIpAddrType, reportSampledObjectIPAddress, reportSampledReportID, reportSampledIntervalStart, reportSampledIntervalEnd, reportSampledAbsValue, reportSampledValStatus } STATUS current DESCRIPTION "Set of REPORT state objects implemented in this module." ::= { reportSampledMIBGroups 1 } --reportSampledImportedGroup OBJECT-GROUP -- OBJECTS { -- usrHistoryControlObjects, -- usrHistoryControlBucketsRequested, -- usrHistoryControlBucketsGranted, -- usrHistoryControlInterval, -- usrHistoryControlOwner, -- usrHistoryControlStatus, -- usrHistoryObjectVariable, -- usrHistoryObjectSampleType --reportSampledStudyOwner, reportSampledStudyName, reportSampledStudyOid, reportSampledStudySamplingInterval, reportSampledStudyNumberReportMeasurements, reportSampledStudyMaximumNumberOfHistoricalReports, reportSampledStudyEntryStatus, reportSampledNumberOfCurrentReport, reportSampledNumberOfMeasurementsForCurrentReport, reportSampledCurrentMeasurementValue, reportSampledCurrentMeasurementTime, reportSampledCurrentMeasurementStatus, reportSampledHistoricalMeasurementValue, reportSampledHistoricalMeasurementTime, reportSampledHistoricalMeasurementStatus, reportSampledDataCollectionFailure, reportSampledDataCollectionFailureThreshold }--STATUS current--DESCRIPTION-- "Set"The basic set ofREPORT stateobjectsimplemented --inthis module." --::= { reportSampledMIBGroups 2 } reportSampledNotificationObjectGroup NOTIFICATION-GROUP NOTIFICATIONS { reportSampledNewDataReport } STATUS current DESCRIPTION "Set of REPORT notificationsthie reportSampledMIB module to be implemented inthis module fororder to meet theSampled reports."minimal compliance conditions." ::= { reportSampledMIBGroups31 } END 8. Security Considerations ThisREPORT-SAMPLED-MIBreportSampledMIB module defines a capability where the local device may poll otherremote devices to collect performance data accessible through otherMIB modules on theremote devices.device to collect performance data. These capabilities defined within theREPORT-SAMPLED-MIBreportSampledMIB module are control-able by a network management application through SNMP. As such, a network management application could potentially use theREPORT-SAMPLED-MIBreportSampledMIB module as a mechanism to implement a limited Distributed Denial-of-Service (DDoS) attack against remotedevices.devices by overloading their SNMP processing. Care should be taken to secure access to theREPORT-SAMPLED-MIBreportSampledMIB module agent. Specifically, access control mechanisms and authentication mechanisms (via SNMPv3) should always be used for SNMP SET operations. Further, some objects may contain data deemed sensitive and authentication and encryption mechanisms (via SNMPv3) should be used for SNMP GET operations. There are a number of management objects defined in this MIB module with a MAX-ACCESS clause of read-write and/or read-create. Such objects may be considered sensitive or vulnerable in some network environments. The support for SET operations in a non-secure environment without proper protection can have a negative effect on network operations. These are the tables and objects and their sensitivity/vulnerability: o The reportSampledControlTable is a writable table whose columnar objects are read-create. The following objects with MAX ACCESS of read-create and their security sensitivities are: o *usrHistoryControlBucketRequestedreportSampledStudyOwner - this object is an administrative string which identifies therequested numberthe owner ofbuckets (or intervals) requested for each identified object for each report instance. As such, this related tothetotal device memory necessaryStudy. * reportSampledStudyName - this object is an administrative string which gives a name toholdthecollected data forStudy defined by theidentified reports. The device must determine whether it hasobjects in this table. * reportSampledStudyOid - this object identifies thenecessary storage. If not,the Object ID from another MIB module resident on this local devicecan indicatewhich forms theavailable storage throughmeasurement basis for the Study. Depending upon theusrHistoryControlBucketGrantedobjectwithinand the associated process responsible for its maintenance, polling thistable. The deviceobject too frequently may place an undo burden on the process resulting in diminishing its overall ability toprotect itself against memory overruns.perform its operation. *usrHistoryControlIntervalreportSampledStudySamplingInterval - this object identifies the time interval being sampling events. If set too low, the device may not be able to sample the object on remote devices fast enough to satisfy the requested interval. Further, setting this value too low could be used to overwhelm the processing capabilities of the remote agent, resulting in a form of Denial-of-Service (DoS) attack. *reportSampledControlRequestedNumberreportSampledStudyNumberReportsMeasurements - this object identifies the requested number ofconsecutive reports ofmeasurements (and associated storage/memory) for each identified object for each Study instance. As such, thistyperelated tobe generated and stored in this device. When,thevalue of this object should be considered in the local device's estimates oftotal device memoryconsumption relatednecessary to hold the collected data for the identified reports. The device must determine whether it has the necessary storage. If not, the device can reject thiscontrol table row.value when requested by returning the .... to protect itself against memory overruns. *usrHistoryControlOwnerreportSampledStudyMaximumNumberOfHistoricalReports - thisobjects provides a name associated withobject identifies thepresumed identityrequested number ofthe application configuringReports for each identified object for each Study instance. As such, thisreport. Ifrelated to thelocaltotal deviceor management applications attribute any authoritymemory necessary to hold thevalues contained in this object, thencollected data for the identified reports. The device must determine whether itis critical to secure access to setting or modifyinghas thevalue ofnecessary storage. If not, the device can reject thisobject.value when requested by returning the .... to protect itself against memory overruns. *usrHistoryControlStatusreportSampledStudyEntryStatus - this is the RowStatus object controlling the configuration of this table row. o ThereportSampledObjectTablereportSampledCurrentReportsStatusTable is awritableread-only tablewhose columnar objects are read-create.containing state information. Thefollowing objects with MAX ACCESS of read-create and their security sensitivities are: o * usrHistoryObjectVariable -information in thisobject identifies the specific OID on a (potentially) remote agent whose counter or gauge values areTable relates tobe collected for the reports. If, for whatever reason,performance measurements on thevaluesunderlying Mobile Ad- Hoc Network (MANET). As such, some of thisOID collected within the report isinformation may be deemedsensitive, then the SNMP GET operations issuedsensitive tocollect these values should use SNMPv3 authenticationthe overall performance of the MANET andencryption mechanismstoprotect. * reportSampledObjectIpAddrType -the organization to which the MANET belongs. o The reportSampledCurrentReportsTable is a read-only table containing state information. The information in thisobject identifiesTable relates to performance measurements on theaddress type associated withunderlying Mobile Ad- Hoc Network (MANET). As such, some of this information may be deemed sensitive to theaddressoverall performance of theagent whose OID data is being collected forMANET and to thereport. * reportSampledObjectIpAddress -organization to which the MANET belongs. o The reportSampledHistoricalReportsStatusTable is a read-only table containing state information. The information in thisobject identifiesTable relates to performance measurements on theaddress associated withunderlying Mobile Ad- Hoc Network (MANET). As such, some of this information may be deemed sensitive to theaddressoverall performance of theagent whose OID data is being collected forMANET and to thereport. Iforganization to which theaddressMANET belongs. o The reportSampledDataCollectionFailure notification object reports information regarding the inability of theremote devices is deemed sensitive, thenreportSampledMIB module from completing its configured reporting mission, including theSNMP SETs which write orspecific information that theSNMP GET which collectmodule is failing to collect. To some organizations this informationshouldmay beprotected using SNMPv3 authenticationdeemed sensitive to its mission and may want to protect this information through encryption mechanisms.* usrHistoryObjectSampleType - thiso The reportSampledDataCollectionFailureThreshold objectidentifiescontrols the ability of theway in which data values aredevice to report information regarding the inability of the reportSampledMIB module from completing its configured reporting mission. If set to low, notifications may bestored withinproduced too frequently causing processor burdens to thereports.agent and the collecting manager, and generating too much management traffic for a bandwidth constrained MANET to support. If set too high, notifications may not be produced frequently enough for the collecting manager to properly track the MANET system performance. SNMP versions prior to SNMPv3 did not include adequate security. Even if the network itself is secure (for example by using IPSec), even then, there is no control as to who on the secure network is allowed to access and GET/SET (read/change/create/delete) the objects in this MIB module. It is RECOMMENDED that implementers consider the security features as provided by the SNMPv3 framework (see [RFC3410], section 8), including full support for the SNMPv3 cryptographic mechanisms (for authentication and privacy). Further, deployment of SNMP versions prior to SNMPv3 is NOT RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to enable cryptographic security. It is then a customer/operator responsibility to ensure that the SNMP entity giving access to an instance of this MIB module is properly configured to give access to the objects only to those principals (users) that have legitimate rights to indeed GET or SET (change/create/delete) them. 9. Applicability Statement This document describes objects for configuring parameters of the remote report generation process on a router orcloseother device. This MIB module, denotedREPORT-SAMPLED-MIB,reportSampledMIB module, also reports performance information and notifications. TheREPORT-SAMPLED-MIBreportSampledMIB module provides for the remote control, collection and notification of performance reports on devices. As such, it eliminates the need for periodic polling for counters from remote management stations as a means for generating performance reports. This is hoped to greatly reduce management overhead on the MANET. This sections provides some examples of how this MIB module can be used in MANET network deployments. A fuller discussion of MANET network management use cases and challenges will be provided elsewhere. In the following, two scenarios arelistedidentified where this MIB module isuseful, i.e.,useful. This list is not complete and other scenarios are possible. o For Mobile vehicles with Low Bandwidth Satellite Link to a FixedNOCNetwork Operations Center (NOC) - Here the vehicles carrying the MANET routers carry multiple wireless interfaces, one of which is a relatively low-bandwidth on-the-move satellite connection which interconnects a fix NOC to the nodes of the MANET.Standards-basedStandards- based methods for monitoring and fault management from the fixed NOC are necessary for this deployment option. However, to reduce polling overhead over the low bandwidth communications links, theREPORT-SAMPLED-MIBreportSampledMIB module can be deployed the remote MANET nodes for the remote generation of performance reports. o For Fixed NOC and Mobile Local Manager in Larger Vehicles - for larger vehicles, a hierarchical network management arrangement is useful. Centralized network management is performed from a fixed NOC while localmanagementmanagement, as provided by this reportSampledMIB module is performed locally from within the vehicles.Standards-basedStandards- based methods for configuration, monitoring, fault and performance management are necessary for this deployment option. 10. IANA Considerations The MIB module in this document uses the following IANA-assigned OBJECT IDENTIFIER values recorded in the SMI Numbers registry: Descriptor OBJECT IDENTIFIER value ---------- ----------------------- reportSampledMIB { experimental XXX } 11. Contributors This MIB document uses the template authored by D. Harrington which is based on contributions from the MIB Doctors, especially Juergen Schoenwaelder, Dave Perkins, C.M.Heard and Randy Presuhn. 12. Acknowledgements We would like to thank Bert Wijnen for pointing out the existence of the usrHistory group within RMON2 and in answering our numerous questions on the usrHistory group. Further, we wish to thank U. Herberg for promoting additions to this MIB through his thoughtful consideration of performance monitoring requirements for other MIBs within the MANET WG, e.g., NHDP and OLSR MIBs. 13. References 13.1. Normative References [RFC2021] Waldbusser, S., "Remote Network Monitoring Management Information Base Version 2 using SMIv2", RFC 2021, January 1997.[RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group MIB", RFC 2863, June 2000. [RFC3418] Presuhn, R., "Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)", STD 62, RFC 3418, December 2002.[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999.[RFC4001] Daniele, M., Haberman, B., Routhier, S.,[RFC2981] Kavasseri, R., "Event MIB", RFC 2981, October 2000. [RFC2982] Kavasseri, R., "Distributed Management Expression MIB", RFC 2982, October 2000. [RFC3411] Harrington, D., Presuhn, R., andJ. Schoenwaelder, "Textual ConventionsB. Wijnen, "An Architecture forInternetDescribing Simple NetworkAddresses",Management Protocol (SNMP) Management Frameworks", STD 62, RFC4001, February 2005.3411, December 2002. [RFC3418] Presuhn, R., "Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)", STD 62, RFC 3418, December 2002. 13.2. Informative References [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, "Introduction and Applicability Statements for Internet- Standard Management Framework", RFC 3410, December 2002. Appendix A. Change Log Changes from draft-ietf-manet-report-mib-03 to draft-ietf-manet-report-mib-04 draft. 1. This version 04 of the reportSampledMIB module represents a fairly significant restructuring of the MIB module. This restructuring was necessary in order to align the remote distributed reporting capabilities of this MIB module with the prior DISMAN Working Group (WG) efforts at the IETF. 2. The reportSampledCurrentReportsStatusTable was added to allow a network manager to automate notifications of completed reports from this MIB module using the dismanEventMIB module. 3. The notifications in this reportSampledMIB module were reduced to only notifications related to the operation of the data collections and no longer addressing the reporting of the performance data itself. This later data is now carried in notifications under the control of the dismanEventMIB module. Changes from draft-ietf-manet-report-mib-01 to draft-ietf-manet-report-mib-02 draft. 1. Stripped the Statistical and the Historical Reports from this draft in order to greatly simplify the initial development and experiments of this MIB module. 2. Changed the RFC category to Experimental. 3. Completed the Security section. 4. Relied upon the AUGMENTS statement to simplify further this MIB definition. Changes from draft-ietf-manet-report-mib-00 to draft-ietf-manet-report-mib-01 draft. 1. Proposed additions to the statsReports in order to potentially simplify data transmission to management applications. 2. Added some Notification definitions and their relationship to the three reports' structure, i.e., statsReports, sampledReports, and historyReports. 3. In the process of adding notifications for the Sampled and the History reports, decided to restructure the reports from their previously rolling storage model to the fixed interval reporting used all along in the Statistics reporting. This allows the agent to notify the management application that a report has completed and that it is ready to be pulled from the agent storage. 4. Ran MIB through smilint checker and cleaned up all errors and most warnings. A few warnings remain to be addressed. 5. Cleaned up textual material. Changes from draft-cole-manet-report-mib-02 to draft-ietf-manet-report-mib-00 draft. 1. Major change was the incorporation of the IP address objects associated with all objects of type 'OBJECT IDENTIFIER'. This allows theREPORT-SAMPLED-MIBreportSampledMIB module to exist as a proxy report generation capability on a device separate but in close proximity to the device monitoring the referenced object. 2. Cleaned up the up front text, reducing the repetition with the object descriptions in the MIB. 3. Worked on and added sections discussing the relationship to other MIBs. Changes from draft-cole-manet-report-mib-01 to draft-cole-manet-report-mib-02 draft. 1. Restructured the MIB somewhat to now offer the three reporting capabilities in increasing order of detail: a) statistical reports, b) sampled reports, and c) historical reports. 2. Renamed the usrHistoryGroup and elements to samplingGroup. This is in line with its actual capabilities. 3. Added a new historyGroup which provides a history of change events. 4. Updated the4 Conformance section to reflect the above changes and additions. But did not yet run smilint to check MIB syntax. Changes from draft-cole-manet-report-mib-00 to draft-cole-manet-report-mib-01 draft. 1. Added (copied) the usrHistory group from RMON2 into theREPORT- SAMPLED-MIB.reportSampledMIB module. 2. Restructured the MIB to account for the inclusion of thereportSampledGroup.reportSampledMibObjects. 3. Dropped the reportCurReportsTable as this did not make sense within the context of theREPORT-SAMPLED-MIB.reportSampledMIB module. 4. Added the Compliance and Conformance material. Defined several Compliance Groups to all for base implementations of theREPORT- SAMPLED-MIBreportSampledMIB module for only statistical reports, for only historical reports or for both. Allow for enhanced implementations to address higher capacity issues and extension to metric reporting for statistical reporting. 5. Ran the MIB through the smilint checker and in the process corrected numerous typos, omissions, TEXTUAL CONVENTIONS, IMPORTS, etc. 6. Updated main text to reflect changes. Appendix B. Open Issues This section contains the set of open issues related to the development and design of theREPORT-SAMPLED-MIB.reportSampledMIB module. This section will not be present in the final version of the MIB and will be removed once all the open issues have been resolved. 1. Provide references within the REFERENCE clauses in the MIB module. 2. Identify all objects requiring non-volatile storage in their DESCRIPTION clauses. 3. Request an initial review of this MIB module by a MIB Doctor familiar with the work of the DISMAN WG, preferably an author of the dismanEventMIB module. Appendix C. *************************************************************** * Note to the RFC Editor (to be removed prior to publication) * * * * 1) The reference to RFCXXXX within the DESCRIPTION clauses * * of the MIB module point to this draft and are to be * * assigned by the RFC Editor. * * * * 2) The reference to RFCXXX2 throughout this document point * * to the current draft-ietf-manet-report-xx.txt. This * * need to be replaced with the XXX RFC number. * * * *************************************************************** Authors' Addresses Robert G. Cole US Army CERDEC 6010 Frankford Road Aberdeen Proving Ground, Maryland 21005 USA Phone: +1 443 395 8744 EMail: robert.g.cole@us.army.milURI: http://www.cs.jhu.edu/~rgcole/Joseph Macker Naval Research Laboratory Washington, D.C. 20375 USA EMail: macker@itd.nrl.navy.mil Andy Bierman YumaWorks, Inc. Redwood City, CA 94065 EMail: andy@yumaworks.com