idnits 2.17.1 draft-cole-manet-report-mib-02.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** You're using the IETF Trust Provisions' Section 6.b License Notice from 12 Sep 2009 rather than the newer Notice from 28 Dec 2009. (See https://trustee.ietf.org/license-info/) 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 : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 2 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 589 has weird spacing: '...oup and b) ad...' == Line 1463 has weird spacing: '...ll only be in...' == Line 1759 has weird spacing: '...ticular probe...' == 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 (March 2, 2010) is 5169 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'TODO' is mentioned on line 2697, but not defined == Missing Reference: 'RFC2819' is mentioned on line 528, but not defined == Missing Reference: 'RFC2856' is mentioned on line 534, but not defined == Missing Reference: 'RFC3411' is mentioned on line 537, but not defined == Missing Reference: 'RFC4001' is mentioned on line 541, but not defined == Missing Reference: 'RFC4149' is mentioned on line 545, but not defined == Missing Reference: 'RFC2681' is mentioned on line 703, but not defined == Missing Reference: 'RFC3393' is mentioned on line 704, but not defined == Missing Reference: 'RFC2679' is mentioned on line 705, but not defined ** Obsolete undefined reference: RFC 2679 (Obsoleted by RFC 7679) == Missing Reference: 'RFC2680' is mentioned on line 706, but not defined ** Obsolete undefined reference: RFC 2680 (Obsoleted by RFC 7680) == Missing Reference: 'RFC3432' is mentioned on line 706, but not defined == Missing Reference: 'RFC 2021' is mentioned on line 2071, but not defined ** Obsolete undefined reference: RFC 2021 (Obsoleted by RFC 4502) == Missing Reference: 'TODOs' is mentioned on line 2856, but not defined -- Obsolete informational reference (is this intentional?): RFC 1757 (Obsoleted by RFC 2819) -- Obsolete informational reference (is this intentional?): RFC 2021 (Obsoleted by RFC 4502) Summary: 5 errors (**), 0 flaws (~~), 18 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force R. Cole 3 Internet-Draft Johns Hopkins University 4 Intended status: Standards Track J. Macker 5 Expires: September 3, 2010 Naval Research Laboratory 6 A. Morton 7 AT&T Laboratories 8 March 2, 2010 10 Definition of Managed Objects for Performance Reporting 11 draft-cole-manet-report-mib-02 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 counter and 19 gauge objects for performance monitoring. This allows a management 20 station to instruct a device to build off-line reports to be 21 collected asynchronously by the management station. 23 Status of This Memo 25 This Internet-Draft is submitted to IETF in full conformance with the 26 provisions of BCP 78 and BCP 79. 28 Internet-Drafts are working documents of the Internet Engineering 29 Task Force (IETF), its areas, and its working groups. Note that 30 other groups may also distribute working documents as Internet- 31 Drafts. 33 Internet-Drafts are draft documents valid for a maximum of six months 34 and may be updated, replaced, or obsoleted by other documents at any 35 time. It is inappropriate to use Internet-Drafts as reference 36 material or to cite them other than as "work in progress." 38 The list of current Internet-Drafts can be accessed at 39 http://www.ietf.org/ietf/1id-abstracts.txt. 41 The list of Internet-Draft Shadow Directories can be accessed at 42 http://www.ietf.org/shadow.html. 44 This Internet-Draft will expire on September 3, 2010. 46 Copyright Notice 48 Copyright (c) 2010 IETF Trust and the persons identified as the 49 document authors. All rights reserved. 51 This document is subject to BCP 78 and the IETF Trust's Legal 52 Provisions Relating to IETF Documents 53 (http://trustee.ietf.org/license-info) in effect on the date of 54 publication of this document. Please review these documents 55 carefully, as they describe your rights and restrictions with respect 56 to this document. Code Components extracted from this document must 57 include Simplified BSD License text as described in Section 4.e of 58 the Trust Legal Provisions and are provided without warranty as 59 described in the BSD License. 61 Table of Contents 63 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 64 2. The Internet-Standard Management Framework . . . . . . . . . . 4 65 3. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 4 66 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 67 4.1. REPORT-MIB Management Model . . . . . . . . . . . . . . . 4 68 4.2. Terms . . . . . . . . . . . . . . . . . . . . . . . . . . 9 69 5. Structure of the MIB Module . . . . . . . . . . . . . . . . . 9 70 5.1. Textual Conventions . . . . . . . . . . . . . . . . . . . 10 71 5.2. The Statistics Group . . . . . . . . . . . . . . . . . . . 10 72 5.3. The Sampled Group . . . . . . . . . . . . . . . . . . . . 11 73 5.4. The History Group . . . . . . . . . . . . . . . . . . . . 11 74 5.5. The Notifications Group . . . . . . . . . . . . . . . . . 11 75 6. Relationship to Other MIB Modules . . . . . . . . . . . . . . 11 76 6.1. Relationship to the SNMPv2-MIB . . . . . . . . . . . . . . 12 77 6.2. Relationship to the IF-MIB . . . . . . . . . . . . . . . . 12 78 6.3. MIB modules required for IMPORTS . . . . . . . . . . . . . 12 79 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 12 80 8. Security Considerations . . . . . . . . . . . . . . . . . . . 57 81 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 59 82 10. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 60 83 11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 60 84 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 60 85 12.1. Normative References . . . . . . . . . . . . . . . . . . . 60 86 12.2. Informative References . . . . . . . . . . . . . . . . . . 60 87 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 61 88 Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . . 62 89 Appendix C. . . . . . . . . . . . . . . . . . . . . . . . . . . 63 91 1. Introduction 93 This memo defines a portion of the Management Information Base (MIB) 94 for use with network management protocols in the Internet community. 95 In particular, it describes objects for configuring autonomous, off- 96 line report generation for performance monitoring on any device 97 supporting MIBs containing variables that resolve to type Integer32 98 (i.e., Integer32, Counter, Gauge, or TimeTicks). This should be 99 useful to devices or networks where efficient use of bandwidth is of 100 concern or where intermittent connectivity is common. Hence, the 101 REPORT-MIB is useful for devices managed over some Mobile Ad-Hoc 102 Networks (MANETs) or Disruption Tolerant Networks (DTNs). 104 The REPORT-MIB offers three types of off-line reporting. One type 105 offering reports which present statistical analysis of the objects 106 being tracked; found within the reportStatsGroup. The second type 107 offering a means to collect sampled data related to defined MIB 108 objects. This second type of reporting is contained in the 109 reportSampledGroup. The third offering reports which present 110 (collect) raw data values and their time of change from the objects 111 being tracked; found within the reportHistoryGroup. 113 For statistical reporting, the REPORT-MIB borrows from the RMON 114 [RFC1757] ReportsControl and Reports Tables. Here the 115 reportStatsCapabilitiesGroup defines the capabilities of the device 116 with respect performance monitoring and statistical analysis. Some 117 analysis is hard-coded into the definition of the 118 reportStatsDataGroup while the device can also advertise extended 119 statistical reporting via the reportMetricExtDefTable. The 120 reportsControlTable specifies the report metrics, the Object ID to 121 monitor and other aspects of the statistical report development and 122 storage. 124 For the collection of sampled data, the REPORT-MIB draws directly 125 from the usrHistoryGroup from RMON 2 [RFC2021]. Here the 126 reportSampledControlTable allows the user to define aspects of the 127 report for sampled data, including the number of MIB objects to be 128 sampled and the nature of the sampling frequency and overall report 129 duration. This group uses the notion of buckets, which contained 130 sampled data from a set of idetified MIB objects sampled at the same 131 time point. The report consists of the buckets each containing sets 132 of sampled data from the same MIB objects but at differing sampling 133 times. The reportSampledObjectTable allows the user to identify the 134 multiple MIB objects to be sampled. The reportSampledDataTable 135 contains the storage of the reported sampled data contained within 136 buckets, one for each sampling instance. 138 For the collection of raw data, the REPORT-MIB contains a 139 reportHistoryGroup comprised of the reportHistoryControlTable for 140 control of historical data reports and the reportHistoryDataTable for 141 the storage of the historical reports. 143 Various compliance groups which allow for development of raw data 144 collection reports, collection of sampled data reports or only 145 statistical data reports, or all combinations. 147 2. The Internet-Standard Management Framework 149 For a detailed overview of the documents that describe the current 150 Internet-Standard Management Framework, please refer to section 7 of 151 RFC 3410 [RFC3410]. 153 Managed objects are accessed via a virtual information store, termed 154 the Management Information Base or MIB. MIB objects are generally 155 accessed through the Simple Network Management Protocol (SNMP). 156 Objects in the MIB are defined using the mechanisms defined in the 157 Structure of Management Information (SMI). This memo specifies a MIB 158 module that is compliant to the SMIv2, which is described in STD 58, 159 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 160 [RFC2580]. 162 3. Conventions 164 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 165 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 166 document are to be interpreted as described in RFC 2119 [RFC2119]. 168 4. Overview 170 The Reporting MIB ... and notifications. 172 4.1. REPORT-MIB Management Model 174 This section describes the management model for the Reporting MIB 175 process. First, the model for the reportStatsGroup is presented. 176 Then the model for the reportSampledGroup and the reportHistoryGroup 177 are presented. 179 Figure 1 illustrates a potential use of the REPORT-MIB for the 180 generation of off-line, remotely generated reports. The management 181 station on the left hand side of the illustration instructs the 182 remote device to create reports through manipulation of the 183 ReportCntrl Objects in the REPORT-MIB resident on the remote device. 184 The reports instruct the device to monitor the status of specified 185 counters (on other MIBs) periodically and to generate a set of 186 metrics describing the temporal behavior of those counter values. 188 The reports are stored locally until the management station decides 189 to pull them off the device. The figure shows a case where the 190 REPORT-MIB generates a notification that Report_2 has completed, 191 prompting the management station to pull Report_2 from the device. 193 Mgmt Device 194 Station 195 REPORT-MIB MIB_1 196 +---------+ +-----+ 197 | | | | 198 Build_Rep_1 |+-------+| +--+ | 199 +----------------->||cntrl_1||<------>|PC| | 200 |+-------+|<-+ +--+--+ 201 | | | 202 | | | MIB_2 203 | | | +-----+ 204 | | | | 205 | | | +--+ | 206 | | +---->|PC| | 207 Build_Rep_2 |+-------+| +-->+--+--+ 208 +----------------->||cntrl_2||<---+ 209 |+-------+| 210 | | 211 | | 212 Build_Rep_3 |+-------+| 213 +----------------->||cntrl_3||<---+ MIB_n 214 |+-------+| | +-----+ 215 | | | | | 216 |+-----+ | | +--+ | 217 ||Rep_1| | +-->|PC| | 218 |+-----+ | +--+--+ 219 | | 220 |+-----+ | 221 <------------------||Rep_2| | 222 Notf_Rep_2 |+-----+ | 223 | | 224 |+-----+ | 225 ||Rep_3| | 226 |+-----+ | 227 Get_Rep_2 | | 228 +----------------->| | 229 | | 230 <-----------------+| | 231 Send_Rep_2 +---------+ 233 Figure 1: REPORT-MIB front-end report generation process. 235 The REPORT-MIB's reportStatsGroup defines specifically a set of 236 metrics which are computed within all reports. It also allows for 237 the specification of metric extensions which are local to the 238 specific implementation of the REPORT-MIB. These are identified in 239 the reportStatsCapabilitiesGroup metricExtension Table. 241 Each metric has an associated Object ID of type counter associated 242 with it. The control table specifies a report interval and a bin 243 interval. The report interval is an integral multiple of the bin 244 interval. For each bin interval, the device identifies the change in 245 the counter value over the bin interval (called x_i) and then 246 computes the associated metric, e.g., sum, sum of the square, etc, 247 over the set {x_i}. It maintains the sum of these computations 248 within the metric objects in the 'reportStatsDataTable'. Once the 249 report interval is complete, the management station has enough 250 information to compute a set of interesting and useful statistics. 252 The computational model of the reportStatsGroup of the REPORT-MIB is 253 illustrated in the figure below. The important controls are a) the 254 contrlInterval, b) the cntrlBinInterval, c) the specific 255 counterObjectId, and d) the metric. In the figure x_i represents the 256 ith value of the counter change, i.e., x_i = counterValue(t_i+1) - 257 counterValue(t_i). The metrics reported are then computed from the 258 set (x_i). Three examples are identified in the figure, e.g., 259 StatSumX, StatSumSq and StatMaxX. Other existing and potential 260 metrics are discussed below. 262 | 263 |<--------------------- cntrlInterval ---------------------------->| 264 | | 266 | | | | | | | | 267 | x_0 | x_1 | x_2 | x_3 | ... |x_n-2|x_n-1| 268 +-----+-----+-----+-----+--- ---+-----+-----+ 270 ^ ^ ^ ^ ^ ^ ^ ^ 271 t_0 t_1 t_2 t_3 t_4 t_n-2 t_n-1 t_n 273 where t_i - t_i-1 = cntrlBinInterval 274 n = cntrlInterval / cntrlBinInterval 276 StatSumX = Sum(x_i) from i=0, ..., n-1 277 StatSumSq = Sum((x_i)^2) from i=0, ..., n-1 278 StatMaxX = Max(x_i) for i=0, ..., n-1 280 Figure 2: REPORT-MIB statistical analysis computation process. 282 The following observations and analysis techniques are not all 283 inclusive. Rather these are the ones we have come up with at the 284 time of writing this document. 286 o Number - 288 o Frequency - 290 o The time interval is that specified in the control table. It is 291 not a metric datum, but it is associated with the metric sample - 293 o Maximum - 295 o Minimum - 297 o Range - 299 o Arithmetic Mean - 301 o Root Mean Square - 303 o Variance - 305 o Standard Deviation - 307 o Slope of a least-squares line - 309 o These are accessible from the statistical datum provided by this 310 MIB module. 312 The REPORT-MIB also provides for the collection of sampled data 313 instead of statistical data. It does this by importing (copying) the 314 usrHistory group from RMON2 [RFC2021] which allows for the generation 315 of reports collecting the sampled object values binned for the 316 purpose of aggregation and efficiency of collection. These are 317 defined within the reportSampledGroup. The model used for this type 318 of report generation is based upon three tables. The 319 reportSampledControlTable defines aspects of the report generation 320 related to duration of the reporting interval, the bin (or bucket) 321 sizes for the report, and the number of object values collected for 322 each bucket. The reportUsrHistoryObjectTable identifies the specific 323 MIB objects whose values and binned within the report. And the 324 reportSampledDataTable contains the binned data values collected for 325 the report. 327 The REPORT-MIB also provides for the collection of historical data 328 instead of statistical or sampled data. It does this by defining the 329 reportHistoryControlTable for the control of the historical reports 330 and the reportHistoryDataTable for the storage of the historical 331 reports. 333 4.2. Terms 335 The following definitions apply throughout this document: 337 o Capabilities - Objects related to the capabilities of the device 338 and MIB implemented on the device. Some objects are explicitly 339 defined within the REPORT-MIB. Other capabilities can be exposed 340 through the REPORT-MIB, but which are not explicitly defined 341 within this document. These later capabilities include objects, 342 e.g., for new metrics. 344 o Control - Objects defined within this document which set the 345 parameters for specific reports to be generated offline on the the 346 remote managed device. 348 o Data - Objects which hold the report data, either statistical, 349 sampled or raw history data. 351 5. Structure of the MIB Module 353 This section presents the structure of the REPORT-MIB module. The 354 objects are arranged into the following groups: 356 o reportMIBNotifications - defines the notifications associated with 357 the REPORT-MIB. 359 o reportMIBObjects - defines the objects forming the basis for the 360 REPORT MIB. These objects are divided up by function into the 361 following groups: 363 o 365 * Statistics Group - This group contains the objects which 366 support the generation of reports of a statistical nature. 368 * Sampled Group - This group contains the objects which support 369 the generation (collection) of reports exposing sampled data 370 values. 372 * History Group - This group contains the objects which support 373 the generation (collection) of historical reports exposing raw 374 data values. 376 o reportMIBConformance - Defines a variety of conformance of 377 implementations of this REPORT-MIB. 379 5.1. Textual Conventions 381 The textual conventions used in the REPORT-MIB are as follows. The 382 RowStatus textual convention is imported from RFC 2579 [RFC2579]. 384 5.2. The Statistics Group 386 The REPORT-MIB device has a .... 388 o StatsCapabilities - ... 390 o StatsControl - ... 392 o StatsData - ... 394 The reportStatsCapabilitiesGroup contains ..... 396 The reportStatsControlGroup contains ..... 398 The reportStatsDataGroup contains ... As and example of how the 399 metrics are to be computed within the REPORT-MIB, consider the 400 standard metric object 'reportStatsDataStatSumX'. For each bin 401 interval defined by the object reportCntrlReportsBinInterval, the 402 change in the value of the counter pointed to by the Object ID 403 reportCntrlReportsPriObjID is calculated. Then this (delta) value is 404 added to the current value of the value contained in the object 405 'reportStatsDataStatSumX'. Then, if interested in computing the 406 average change in this object (sampled each bin interval) for the 407 duration of the report, the management station simply divides 408 reportStatsDataStatSumX by reportStatsDataStatN. Although this is a 409 trivial example because the value of reportAggrReportStatSumX is 410 simple the difference in the counter reportCntrolReportsPriObjID at 411 the start and the end of the total report interval, the other metrics 412 defined are not as trivial. 414 The objects 'reportStatsDataOverflowStatSumX' and 415 'reportStatsDataHCSumX' are borrowed from RMON and exist to handle 416 integer overflow situations where, e.g., 'reportStatsDataStatSumX' 417 overruns its maximum vary numerous times. 419 Computations and utility of the other standard metrics are as 420 follows: 422 o reportStatsDataStatSumXSq - 424 o reportStatsDataStatMaximum - 425 o reportStatsDataStatMinimum - 427 o reportStatsDataStatSumSq - 429 o reportStatsDataStatSumIX - 431 o reportStatsDataStatSumIXSq - 433 5.3. The Sampled Group 435 The Sampled Group contains tables which .... 437 o reportSampledControlTable - 439 o reportSampledObjectTable - 441 o reportSampledDataTable - 443 The reportSampledControlTable contains ..... 445 The reportSampledObjectsTable contains ..... 447 The reportSampledDataTable contains ..... 449 5.4. The History Group 451 The History Group contains tables which .... 453 o reportHistoryControlTable - 455 o reportHistoryDataTable - 457 The reportHistoryControlTable contains ..... 459 The reportHistoryDataTable contains ..... 461 5.5. The Notifications Group 463 The Notifications Subtree contains the list of notifications 464 supported within the REPORT-MIB and their intended purpose or 465 utility. This group is currently empty. 467 6. Relationship to Other MIB Modules 469 [TODO]: The text of this section specifies the relationship of the 470 MIB modules contained in this document to other standards, 471 particularly to standards containing other MIB modules. Definitions 472 imported from other MIB modules and other MIB modules that SHOULD be 473 implemented in conjunction with the MIB module contained within this 474 document are identified in this section. 476 6.1. Relationship to the SNMPv2-MIB 478 The 'system' group in the SNMPv2-MIB [RFC3418] is defined as being 479 mandatory for all systems, and the objects apply to the entity as a 480 whole. The 'system' group provides identification of the management 481 entity and certain other system-wide data. The REPORT-MIB does not 482 duplicate those objects. 484 6.2. Relationship to the IF-MIB 486 [TODO] This section is included as an example; If the MIB module is 487 not an adjunct of the Interface MIB, then this section should be 488 removed. 490 6.3. MIB modules required for IMPORTS 492 [TODO]: Citations are not permitted within a MIB module, but any 493 module mentioned in an IMPORTS clause or document mentioned in a 494 REFERENCE clause is a Normative reference, and must be cited 495 someplace within the narrative sections. If there are imported items 496 in the MIB module, such as Textual Conventions, that are not already 497 cited, they can be cited in text here. Since relationships to other 498 MIB modules should be described in the narrative text, this section 499 is typically used to cite modules from which Textual Conventions are 500 imported. 502 The following REPORT-MIB module IMPORTS objects from SNMPv2-SMI 503 [RFC2578], SNMPv2-TC [RFC2579], SNMPv2-CONF [RFC2580], and IF-MIB 504 [RFC2863] 506 7. Definitions 508 REPORT-MIB DEFINITIONS ::= BEGIN 510 IMPORTS 512 ZeroBasedCounter32 513 FROM RMON2-MIB -- [RFC2021] 515 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, 516 Counter32, Gauge32, Unsigned32, Integer32, mib-2 517 FROM SNMPv2-SMI -- [RFC2578] 519 TEXTUAL-CONVENTION, RowStatus, TruthValue, 520 TimeStamp, StorageType 521 FROM SNMPv2-TC -- [RFC2579] 523 MODULE-COMPLIANCE, OBJECT-GROUP, 524 NOTIFICATION-GROUP 525 FROM SNMPv2-CONF -- [RFC2580] 527 OwnerString 528 FROM RMON-MIB -- [RFC2819] 530 InterfaceIndexOrZero 531 FROM IF-MIB -- [RFC2863] 533 ZeroBasedCounter64 534 FROM HCNUM-TC -- [RFC2856] 536 SnmpAdminString 537 FROM SNMP-FRAMEWORK-MIB -- [RFC3411] 539 InetAddress, InetAddressType, 540 InetAddressPrefixLength 541 FROM INET-ADDRESS-MIB -- [RFC4001] 543 SspmClockSource, SspmClockMaxSkew, 544 SspmMicroSeconds 545 FROM SSPM-MIB -- [RFC4149] 546 ; 548 reportMIB MODULE-IDENTITY 549 LAST-UPDATED "201003021300Z" -- March 02, 2010 550 ORGANIZATION "IETF MANET Working Group" 551 CONTACT-INFO 552 "WG E-Mail: manet@ietf.org 554 WG Chairs: ian.chakeres@gmail.com 555 jmacker@nrl.navy.mil 557 Editors: Robert G. Cole 558 Johns Hopkins University 559 Department of Computer Science 560 3400 N. Charles Street 561 Baltimore, MD 21218 562 USA 563 +1 443 910-4420 564 rgcole01@comcast.net 565 Joseph Macker 566 Naval Research Laboratory 567 Washington, D.C. 20375 568 USA 569 macker@itd.nrl.navy.mil 571 Al Morton 572 AT&T Laboratories 573 Middletown, N.J. 07724 574 USA 575 amorton@att.com" 576 DESCRIPTION 577 "This MIB module contains managed object definitions for 578 the autonmous reporting of performance object counters. 579 Copyright (C) The IETF Trust (2009). This version 580 of this MIB module is part of RFC xxxx; see the RFC 581 itself for full legal notices." 583 -- Revision History 584 REVISION "201003021300Z" -- March 02, 2010 585 DESCRIPTION 586 "The third draft of this MIB module published as 587 draft-cole-manet-report-mib-02.txt. Significant 588 revisions to this draft include a) changed naming 589 of usrHistoryGroup to sampledGroup and b) added 590 a historyGroup." 591 REVISION "200910251300Z" -- October 25, 2009 592 DESCRIPTION 593 "The second draft of this MIB module published as 594 draft-cole-manet-report-mib-01.txt. Significant 595 revisions to this draft include a) the inclusion of 596 raw data collection borrow blatently from the 597 usrHistory Group within RMON2, b) the deletion of 598 the CurrentHistoryTable from version -00, 599 c) modifications to the overall structure of the 600 MIB, and d) the definition of various Compliance 601 options for implementations related to this MIB." 602 REVISION "200904281300Z" -- April 28, 2009 603 DESCRIPTION 604 "Initial draft of this MIB module published as 605 draft-cole-manet-report-mib-00.txt." 606 -- RFC-Editor assigns XXXX 607 ::= { mib-2 998 } -- to be assigned by IANA 609 -- TEXTUAL CONVENTIONs 610 ReportMetricDefID ::= TEXTUAL-CONVENTION 611 DISPLAY-HINT "d" 612 STATUS current 613 DESCRIPTION 614 "An index that identifies through reference to a specific 615 statistical metrics. 616 " 617 SYNTAX Unsigned32 (1..2147483647) 619 -- 620 -- Top-Level Object Identifier Assignments 621 -- 623 reportMIBNotifications OBJECT IDENTIFIER ::= { reportMIB 0 } 624 reportMIBObjects OBJECT IDENTIFIER ::= { reportMIB 1 } 625 reportMIBConformance OBJECT IDENTIFIER ::= { reportMIB 2 } 627 -- The reportMIBObjects Assignments: 628 -- reportStatsGroup - 1 629 -- reportSampledGroup - 2 630 -- reportHistoryGroup - 3 632 reportStatsGroup OBJECT IDENTIFIER ::= { reportMIBObjects 1 } 634 -- Then, the reportStatsGroup assignments are : 635 -- reportStatsCapabilitiesGroup - 1 636 -- reportStatsControlGroup - 2 637 -- reportStatsDataGroup - 3 639 -- reportStatsCapabilitiesGroup 640 -- This group contains the REPORT objects that identify specific 641 -- capabilities within this device related to REPORT functions. 643 reportCapabilitiesGroup OBJECT IDENTIFIER ::= { reportStatsGroup 1 } 645 reportClockResolution OBJECT-TYPE 646 SYNTAX SspmMicroSeconds 647 MAX-ACCESS read-only 648 STATUS current 649 -- UNITS Microseconds 650 DESCRIPTION 651 "A read-only variable indicating the resolution 652 of the measurements possible by this device." 653 ::= { reportCapabilitiesGroup 1 } 655 reportClockMaxSkew OBJECT-TYPE 656 SYNTAX SspmClockMaxSkew 657 MAX-ACCESS read-only 658 STATUS current 659 -- UNITS Seconds 660 DESCRIPTION 661 "A read-only variable indicating the maximum 662 offset error due to skew of the local clock 663 over the time interval 86400 seconds, in seconds." 664 ::= { reportCapabilitiesGroup 2 } 666 reportClockSource OBJECT-TYPE 667 SYNTAX SspmClockSource 668 MAX-ACCESS read-only 669 STATUS current 670 DESCRIPTION 671 "A read-only variable indicating the source of the clock. 672 This is provided to allow a user to determine how accurate 673 the timing mechanism is compared with other devices." 674 ::= { reportCapabilitiesGroup 3 } 676 reportMetricDirLastChange OBJECT-TYPE 677 SYNTAX TimeStamp 678 MAX-ACCESS read-only 679 STATUS current 680 DESCRIPTION 681 "The value of sysUpTime at the time the 682 reportTransMetricDirTable was last modified, through 683 modifications of the reportTransMetricDirConfig object." 684 ::= { reportCapabilitiesGroup 4 } 686 -- REPORT Metric Extensions Definition Table 688 reportMetricExtDefTable OBJECT-TYPE 689 SYNTAX SEQUENCE OF ReportMetricExtDefEntry 690 MAX-ACCESS not-accessible 691 STATUS current 692 DESCRIPTION 693 "The reportMetricExtDefTable describes the metrics 694 available to the REPORT-MIB. The reportMetricExtDefTable 695 can define metrics by referencing existing IETF, 696 ITU, and other standards organizations' documents, 697 including enterprise-specific documents. 699 Examples of appropriate references include the 700 ITU-T Recommendation Y.1540 [Y.1540] on IP 701 packet transfer performance metrics and the 702 IETF documents from the IPPM WG; e.g., RFC2681 703 on the round trip delay metric [RFC2681] or 704 RFC3393 on the delay variation metric [RFC3393]. 705 Other examples include RFC2679 [RFC2679], RFC2680 706 [RFC2680], and RFC3432 [RFC3432]. Although no 707 specific metric is mandatory, implementations 708 should, at a minimum, support a round-trip delay 709 and a round-trip loss metric. 711 This table contains one row per metric supported by this 712 agent, and it should be populated during system 713 initialization." 714 ::= { reportCapabilitiesGroup 5 } 716 reportMetricExtDefEntry OBJECT-TYPE 717 SYNTAX ReportMetricExtDefEntry 718 MAX-ACCESS not-accessible 719 STATUS current 720 DESCRIPTION 721 "Information about a particular metric." 722 INDEX { reportMetricExtDefID } 723 ::= { reportMetricExtDefTable 1 } 725 ReportMetricExtDefEntry ::= SEQUENCE { 726 reportMetricExtDefID ReportMetricDefID, 727 reportMetricExtDefType INTEGER, 728 reportMetricExtDefName SnmpAdminString, 729 reportMetricExtDefOperation SnmpAdminString, 730 reportMetricExtDefReference SnmpAdminString 731 } 733 reportMetricExtDefID OBJECT-TYPE 734 SYNTAX ReportMetricDefID 735 MAX-ACCESS not-accessible 736 STATUS current 737 DESCRIPTION 738 "The index for this entry. This object identifies 739 the particular metric in this MIB module." 740 ::= { reportMetricExtDefEntry 1 } 742 reportMetricExtDefType OBJECT-TYPE 743 SYNTAX INTEGER { 744 other(1), 745 singleObjMetric(2), 746 multipleObjMetric(3) 748 } 749 MAX-ACCESS read-only 750 STATUS current 751 DESCRIPTION 752 "The basic type of metric indicated by this entry. 754 The value 'other(1)' indicates that this metric cannot be 755 characterized by any of the remaining enumerations specified 756 for this object. 758 The value 'connectMetric(2)' indicates that this metric 759 measures connectivity characteristics. 761 The value 'delayMetric(3)' indicates that this metric 762 measures delay characteristics. 763 " 764 ::= { reportMetricExtDefEntry 2 } 766 reportMetricExtDefName OBJECT-TYPE 767 SYNTAX SnmpAdminString 768 MAX-ACCESS read-only 769 STATUS current 770 DESCRIPTION 771 "The textual name of this metric. For example, if 772 this reportMetricDefEntry identified the IPPM metric for 773 round trip delay, then this object should contain 774 the value, e.g., 'Type-P-Round-Trip-Delay'." 775 ::= { reportMetricExtDefEntry 3 } 777 reportMetricExtDefOperation OBJECT-TYPE 778 SYNTAX SnmpAdminString 779 MAX-ACCESS read-only 780 STATUS current 781 DESCRIPTION 782 "The textual description of the operations necessary 783 to compute this metric. For example, if 784 this reportMetricDefEntry identified the IPPM metric for 785 round trip delay, then this object should contain 786 the value, e.g., 'Type-P-Round-Trip-Delay'." 787 ::= { reportMetricExtDefEntry 4 } 789 reportMetricExtDefReference OBJECT-TYPE 790 SYNTAX SnmpAdminString 791 MAX-ACCESS read-only 792 STATUS current 793 DESCRIPTION 794 "This object contains a reference to the document that 795 defines this metric. If this document is available online 796 via electronic download, then a de-referencable URL 797 should be specified in this object. The implementation 798 must support an HTTP URL type and may support additional 799 types of de-referencable URLs such as an FTP type. 801 For example, if this reportMetricDefName identified the IPPM 802 metric 'Type-P-Round-Trip-Delay', then this object should 803 contain the value, e.g., 804 'http://www.ietf.org/rfc/rfc2681.txt'." 805 ::= { reportMetricExtDefEntry 5 } 807 -- Stats Control Group 808 -- This and the following tables are modeled 809 -- after the report control and collection 810 -- capabilities found in RMON II, RFC XXXX 812 reportStatsControlGroup OBJECT IDENTIFIER ::= {reportStatsGroup 2} 814 reportStatsControlTable OBJECT-TYPE 815 SYNTAX SEQUENCE OF ReportStatsControlEntry 816 MAX-ACCESS not-accessible 817 STATUS current 818 DESCRIPTION 819 "The reportStatsControlTable is the controlling entry 820 that manages the population of studies in the 821 Report for selected time intervals. 823 Note that this is not like the typical RMON 824 controlTable and dataTable in which each entry creates 825 its own data table. Each entry in this table enables the 826 creation of multiple data tables on a study basis. For each 827 interval, the study is updated in place, and the current 828 data content of the table becomes invalid. 830 The control table entries are persistent across 831 system reboots." 832 ::= { reportStatsControlGroup 1 } 834 reportStatsControlEntry OBJECT-TYPE 835 SYNTAX ReportStatsControlEntry 836 MAX-ACCESS not-accessible 837 STATUS current 838 DESCRIPTION 839 "A conceptual row in the reportStatsControlTable. 841 An example of the indexing of this entry is 842 reportGenReportCntrInterval.1" 843 INDEX { reportStatsControlIndex } 844 ::= { reportStatsControlTable 1 } 846 ReportStatsControlEntry ::= SEQUENCE { 847 reportStatsControlIndex Unsigned32, 848 reportStatsControlInterval Unsigned32, 849 reportStatsControlBinInterval Unsigned32, 850 reportStatsControlPriObjID OBJECT IDENTIFIER, 851 reportStatsControlSecObj1ID OBJECT IDENTIFIER, 852 reportStatsControlSecObj2ID OBJECT IDENTIFIER, 853 reportStatsControlSecObj3ID OBJECT IDENTIFIER, 854 reportStatsControlSecObj4ID OBJECT IDENTIFIER, 855 reportStatsControlSecObj5ID OBJECT IDENTIFIER, 856 reportStatsControlMetricExt1 ReportMetricDefID, 857 reportStatsControlMetricExt2 ReportMetricDefID, 858 reportStatsControlMetricExt3 ReportMetricDefID, 859 reportStatsControlMetricExt4 ReportMetricDefID, 860 reportStatsControlMetricExt5 ReportMetricDefID, 861 reportStatsControlReqReports Unsigned32, 862 reportStatsControlGrantedReports Unsigned32, 863 reportStatsControlStartTime TimeStamp, 864 reportStatsControlReportNumber Unsigned32, 865 reportStatsControlInsertsDenied Counter32, 866 reportStatsControlOwner OwnerString, 867 reportStatsControlStorageType StorageType, 868 reportStatsControlStatus RowStatus 869 } 871 reportStatsControlIndex OBJECT-TYPE 872 SYNTAX Unsigned32 (1..65535) 873 MAX-ACCESS not-accessible 874 STATUS current 875 DESCRIPTION 876 "An index that uniquely identifies an entry in the 877 reportStatsControlTable. Each such entry defines a unique 878 report whose results are placed in the reportGenReportTable 879 on behalf of this reportStatsControlEntry." 880 ::= { reportStatsControlEntry 1 } 882 reportStatsControlInterval OBJECT-TYPE 883 SYNTAX Unsigned32 884 UNITS "Seconds" 885 MAX-ACCESS read-create 886 STATUS current 887 DESCRIPTION 888 "The interval in seconds over which data is accumulated before 889 being aggregated into a report in the reportGenReportTable. 890 All reports with the same reportStatsControlIndex will be 891 based on the same interval. 893 The value of the reportStatsControlInterval should be 894 an integral multiple of the value of the 895 reportStatsControlBinInterval. 897 This object may not be modified if the associated 898 reportStatsControlStatus object is equal to active(1)." 899 DEFVAL { 3600 } 900 ::= { reportStatsControlEntry 2 } 902 reportStatsControlBinInterval OBJECT-TYPE 903 SYNTAX Unsigned32 904 UNITS "Seconds" 905 MAX-ACCESS read-create 906 STATUS current 907 DESCRIPTION 908 "The interval in seconds between which the value of the 909 reportStatsControlPriObjID and SecObjIDs are polled 910 for the purpose of generating the metric values associated 911 with this report. All reports with the same 912 reportStatsControlIndex will be based on the 913 same bin interval. 915 This object may not be modified if the associated 916 reportStatsControlStatus object is equal to active(1)." 917 DEFVAL { 3600 } 918 ::= { reportStatsControlEntry 3 } 920 reportStatsControlPriObjID OBJECT-TYPE 921 SYNTAX OBJECT IDENTIFIER 922 MAX-ACCESS read-create 923 STATUS current 924 DESCRIPTION 925 "This identifies the primary counter object to be 926 monitored within this report. 928 This object may not be modified if the associated 929 reportStatsControlStatus object is equal to active(1)." 930 ::= { reportStatsControlEntry 4 } 932 reportStatsControlSecObj1ID OBJECT-TYPE 933 SYNTAX OBJECT IDENTIFIER 934 MAX-ACCESS read-create 935 STATUS current 936 DESCRIPTION 937 "This identifies the secondary counter object to be 938 monitored within this report associated with the 939 specified reportStatsControlMetricExt1. If the 940 reportStatsControlMetricExt1 is a simple metric, then 941 the value of this reportStatsControlSecObj1ID is 942 set to '0'. 944 This object may not be modified if the associated 945 reportStatsControlStatus object is equal to active(1)." 946 ::= { reportStatsControlEntry 5 } 948 reportStatsControlSecObj2ID OBJECT-TYPE 949 SYNTAX OBJECT IDENTIFIER 950 MAX-ACCESS read-create 951 STATUS current 952 DESCRIPTION 953 "This identifies the secondary counter object to be 954 monitored within this report associated with the 955 specified reportStatsControlMetricExt2. If the 956 reportStatsControlMetricExt2 is a simple metric, then 957 the value of this reportStatsControlSecObj2ID is 958 set to '0'. 960 This object may not be modified if the associated 961 reportStatsControlStatus object is equal to active(1)." 962 ::= { reportStatsControlEntry 6 } 964 reportStatsControlSecObj3ID OBJECT-TYPE 965 SYNTAX OBJECT IDENTIFIER 966 MAX-ACCESS read-create 967 STATUS current 968 DESCRIPTION 969 "This identifies the secondary counter object to be 970 monitored within this report associated with the 971 specified reportStatsControlMetricExt3. If the 972 reportStatsControlMetricExt3 is a simple metric, then 973 the value of this reportStatsControlSecObj3ID is 974 set to '0'. 976 This object may not be modified if the associated 977 reportStatsControlStatus object is equal to active(1)." 978 ::= { reportStatsControlEntry 7 } 980 reportStatsControlSecObj4ID OBJECT-TYPE 981 SYNTAX OBJECT IDENTIFIER 982 MAX-ACCESS read-create 983 STATUS current 984 DESCRIPTION 985 "This identifies the secondary counter object to be 986 monitored within this report associated with the 987 specified reportStatsControlMetricExt4. If the 988 reportStatsControlMetricExt4 is a simple metric, then 989 the value of this reportStatsControlSecObj4ID is 990 set to '0'. 992 This object may not be modified if the associated 993 reportStatsControlStatus object is equal to active(1)." 994 ::= { reportStatsControlEntry 8 } 996 reportStatsControlSecObj5ID OBJECT-TYPE 997 SYNTAX OBJECT IDENTIFIER 998 MAX-ACCESS read-create 999 STATUS current 1000 DESCRIPTION 1001 "This identifies the secondary counter object to be 1002 monitored within this report associated with the 1003 specified reportStatsControlMetricExt5. If the 1004 reportStatsControlMetricExt5 is a simple metric, then 1005 the value of this reportStatsControlSecObj5ID is 1006 set to '0'. 1008 This object may not be modified if the associated 1009 reportStatsControlStatus object is equal to active(1)." 1010 ::= { reportStatsControlEntry 9 } 1012 reportStatsControlMetricExt1 OBJECT-TYPE 1013 SYNTAX ReportMetricDefID 1014 MAX-ACCESS read-create 1015 STATUS current 1016 DESCRIPTION 1017 "This identifies the first metric extension placed 1018 in the reportGenReportTable. If no metric extension 1019 is requested, then this object value is set to '0'. 1021 If this metric is defined on a single counter object, 1022 then only the reportStatsControlPriObjID is set, while 1023 the value of the reportStatsControlSecObjID is 1024 set to '0'. Else, the reportStatsControlSecObjID 1025 is set in accoradance with the instruction in the 1026 definition of the metric extension found in the 1027 reportCapabilitiesMetwircExtTable above. 1029 This object may not be modified if the associated 1030 reportStatsControlStatus object is equal to active(1)." 1031 ::= { reportStatsControlEntry 10 } 1033 reportStatsControlMetricExt2 OBJECT-TYPE 1034 SYNTAX ReportMetricDefID 1035 MAX-ACCESS read-create 1036 STATUS current 1037 DESCRIPTION 1038 "This identifies the first metric extension placed 1039 in the reportGenReportTable. If no metric extension 1040 is requested, then this object value is set to '0'. 1042 If this metric is defined on a single counter object, 1043 then only the reportStatsControlPriObjID is set, while 1044 the value of the reportStatsControlSecObjID is 1045 set to '0'. Else, the reportStatsControlSecObjID 1046 is set in accoradance with the instruction in the 1047 definition of the metric extension found in the 1048 reportCapabilitiesMetwircExtTable above. 1050 This object may not be modified if the associated 1051 reportStatsControlStatus object is equal to active(1)." 1052 ::= { reportStatsControlEntry 11 } 1054 reportStatsControlMetricExt3 OBJECT-TYPE 1055 SYNTAX ReportMetricDefID 1056 MAX-ACCESS read-create 1057 STATUS current 1058 DESCRIPTION 1059 "This identifies the first metric extension placed 1060 in the reportGenReportTable. If no metric extension 1061 is requested, then this object value is set to '0'. 1063 If this metric is defined on a single counter object, 1064 then only the reportStatsControlPriObjID is set, while 1065 the value of the reportStatsControlSecObjID is 1066 set to '0'. Else, the reportStatsControlSecObjID 1067 is set in accoradance with the instruction in the 1068 definition of the metric extension found in the 1069 reportCapabilitiesMetwircExtTable above. 1071 This object may not be modified if the associated 1072 reportStatsControlStatus object is equal to active(1)." 1073 ::= { reportStatsControlEntry 12 } 1075 reportStatsControlMetricExt4 OBJECT-TYPE 1076 SYNTAX ReportMetricDefID 1077 MAX-ACCESS read-create 1078 STATUS current 1079 DESCRIPTION 1080 "This identifies the first metric extension placed 1081 in the reportGenReportTable. If no metric extension 1082 is requested, then this object value is set to '0'. 1084 If this metric is defined on a single counter object, 1085 then only the reportStatsControlPriObjID is set, while 1086 the value of the reportStatsControlSecObjID is 1087 set to '0'. Else, the reportStatsControlSecObjID 1088 is set in accoradance with the instruction in the 1089 definition of the metric extension found in the 1090 reportCapabilitiesMetwircExtTable above. 1092 This object may not be modified if the associated 1093 reportStatsControlStatus object is equal to active(1)." 1094 ::= { reportStatsControlEntry 13 } 1096 reportStatsControlMetricExt5 OBJECT-TYPE 1097 SYNTAX ReportMetricDefID 1098 MAX-ACCESS read-create 1099 STATUS current 1100 DESCRIPTION 1101 "This identifies the first metric extension placed 1102 in the reportGenReportTable. If no metric extension 1103 is requested, then this object value is set to '0'. 1105 If this metric is defined on a single counter object, 1106 then only the reportStatsControlPriObjID is set, while 1107 the value of the reportStatsControlSecObjID is 1108 set to '0'. Else, the reportStatsControlSecObjID 1109 is set in accoradance with the instruction in the 1110 definition of the metric extension found in the 1111 reportCapabilitiesMetwircExtTable above. 1113 This object may not be modified if the associated 1114 reportStatsControlStatus object is equal to active(1)." 1115 ::= { reportStatsControlEntry 14 } 1117 reportStatsControlReqReports OBJECT-TYPE 1118 SYNTAX Unsigned32 (1..65535) 1119 MAX-ACCESS read-create 1120 STATUS current 1121 DESCRIPTION 1122 "The number of saved reports requested to be allocated on 1123 behalf of this entry. 1125 This object may not be modified if the associated 1126 reportStatsControlStatus object is equal to active(1)." 1127 ::= { reportStatsControlEntry 15 } 1129 reportStatsControlGrantedReports OBJECT-TYPE 1130 SYNTAX Unsigned32 (0..65535) 1131 MAX-ACCESS read-only 1132 STATUS current 1133 DESCRIPTION 1134 "The number of saved reports the agent has allocated based 1135 on the requested amount in reportStatsControlReqReports. 1136 Because each report can have many entries, the total number 1137 of entries allocated will be this number multiplied by the 1138 value of reportStatsControlGrantedSize, or by 1 if that 1139 object doesn't exist. 1141 When the associated reportStatsControlReqReports object is 1142 created or modified, the agent should set this object as 1143 closely to the requested value as is possible for the 1144 particular implementation and available resources. When 1145 considering available resources, the agent must consider its 1146 ability to allocate this many reports, each with the number 1147 of entries represented by reportStatsControlGrantedSize, or 1148 by 1 if that object doesn't exist. 1150 Note that although the storage required for each report may 1151 fluctuate due to changing conditions, the agent must continue 1152 to have storage available to satisfy the full report size for 1153 all reports, when necessary. Further, the agent must not 1154 lower this value except as a result of a set to the 1155 associated reportStatsControlReqSize object." 1156 ::= { reportStatsControlEntry 16 } 1158 reportStatsControlStartTime OBJECT-TYPE 1159 SYNTAX TimeStamp 1160 MAX-ACCESS read-only 1161 STATUS current 1162 DESCRIPTION 1163 "The value of sysUpTime when the system began processing the 1164 report in progress. Note that the report in progress is not 1165 available. 1167 This object may be used by the management station to figure 1168 out the start time for all previous reports saved for this 1169 reportStatsControlEntry, as reports are started at fixed 1170 intervals." 1171 ::= { reportStatsControlEntry 17 } 1173 reportStatsControlReportNumber OBJECT-TYPE 1174 SYNTAX Unsigned32 1175 MAX-ACCESS read-only 1176 STATUS current 1177 DESCRIPTION 1178 "The number of the report in progress. When an 1179 reportStatsControlEntry is activated, the first report will 1180 be numbered zero." 1181 ::= { reportStatsControlEntry 18 } 1183 reportStatsControlInsertsDenied OBJECT-TYPE 1184 SYNTAX Counter32 1185 MAX-ACCESS read-only 1186 STATUS current 1187 DESCRIPTION 1188 "The number of attempts to add an entry to reports for 1189 this ReportStatsControlEntry that failed because the 1190 number of entries would have exceeded 1191 reportStatsControlGrantedSize. 1193 This number is valuable in determining if enough 1194 entries have been allocated for reports 1195 in light of fluctuating network 1196 usage. Note that an entry that is denied will 1197 often be attempted again, so this number will 1198 not predict the exact number of additional entries 1199 needed, but it can be used to 1200 understand the relative magnitude of the problem. 1202 Also note that there is no ordering specified for 1203 the entries in the report; 1204 thus, there are no rules for which entries 1205 will be omitted when not enough entries are available. 1206 As a consequence, the agent is not required 1207 to delete 'least valuable' entries first." 1208 ::= { reportStatsControlEntry 19 } 1210 reportStatsControlOwner OBJECT-TYPE 1211 SYNTAX OwnerString 1212 MAX-ACCESS read-create 1213 STATUS current 1214 DESCRIPTION 1215 "The entity that configured this entry and is 1216 therefore using the resources assigned to it. 1218 This object may not be modified if the associated 1219 reportStatsControlStatus object is equal to active(1)." 1220 ::= { reportStatsControlEntry 20 } 1222 reportStatsControlStorageType OBJECT-TYPE 1223 SYNTAX StorageType 1224 MAX-ACCESS read-create 1225 STATUS current 1226 DESCRIPTION 1227 "The storage type of this reportStatsControlEntry. If the 1228 value of this object is 'permanent', no objects in this row 1229 need to be writable." 1230 ::= { reportStatsControlEntry 21 } 1232 reportStatsControlStatus OBJECT-TYPE 1233 SYNTAX RowStatus 1234 MAX-ACCESS read-create 1235 STATUS current 1236 DESCRIPTION 1237 "The status of this performance control entry. 1239 An entry may not exist in the active state unless each 1240 object in the entry has an appropriate value. 1242 Once this object is set to active(1), no objects in the 1243 reportStatsControlTable can be changed. 1245 If this object is not equal to active(1), all associated 1246 entries in the reportGenReportTable shall be deleted." 1247 ::= { reportStatsControlEntry 22 } 1249 -- Stats Data Group 1251 reportStatsDataGroup OBJECT IDENTIFIER ::= { reportStatsGroup 3 } 1253 -- Report Stats Data Table 1255 reportStatsDataTable OBJECT-TYPE 1256 SYNTAX SEQUENCE OF ReportStatsDataEntry 1257 MAX-ACCESS not-accessible 1258 STATUS current 1259 DESCRIPTION 1260 "This table contains completed 1261 studies for each of the control table entries in 1262 reportAggrReportCntrlTable. These studies are 1263 provided based on the selections and parameters 1264 found for the entry in the 1265 reportAggregateReportsCntrlTable. 1267 The performance statistics are specified in the 1268 reportTransMetricDirTable associated with the 1269 application in question and indexed by 1270 appLocalIndex and reportTransMetricIndex." 1271 ::= { reportStatsDataGroup 1 } 1273 reportStatsDataEntry OBJECT-TYPE 1274 SYNTAX ReportStatsDataEntry 1275 MAX-ACCESS not-accessible 1276 STATUS current 1277 DESCRIPTION 1278 "A conceptual row in the reportStatsDataTable. 1280 The reportStatsControlIndex value in the 1281 index identifies the reportStatsControlEntry 1282 on whose behalf this entry was created. 1284 The reportStatsDataIndex value in the index 1285 identifies which report 1286 (in the series of reports) this entry is a part of. 1288 The reportStatsDataServerAddress value in the 1289 index identifies the network layer address of the 1290 device generatung this report. 1292 An example of the indexing of this entry is 1293 reportStatsDataStatN.3.15.34.262.18.4.128.2.6.7.3256521" 1294 INDEX { reportStatsControlIndex, 1295 reportStatsDataIndex 1296 } 1297 ::= { reportStatsDataTable 1 } 1299 ReportStatsDataEntry ::= SEQUENCE { 1300 reportStatsDataIndex Unsigned32, 1301 reportStatsDataServerAddress OCTET STRING, 1302 reportStatsDataStatN ZeroBasedCounter32, 1303 reportStatsDataStatSumX ZeroBasedCounter32, 1304 reportStatsDataOverflowStatSumX ZeroBasedCounter32, 1305 reportStatsDataHCStatSumX ZeroBasedCounter64, 1306 reportStatsDataStatMaximum ZeroBasedCounter32, 1307 reportStatsDataStatMinimum ZeroBasedCounter32, 1308 reportStatsDataStatSumSq ZeroBasedCounter32, 1309 reportStatsDataOverflowStatSumSq ZeroBasedCounter32, 1310 reportStatsDataHCStatSumSq ZeroBasedCounter64, 1311 reportStatsDataStatSumIX ZeroBasedCounter32, 1312 reportStatsDataOverflowStatSumIX ZeroBasedCounter32, 1313 reportStatsDataHCStatSumIX ZeroBasedCounter64, 1314 reportStatsDataStatSumIXSq ZeroBasedCounter32, 1315 reportStatsDataOverflowStatSumIXSq ZeroBasedCounter32, 1316 reportStatsDataHCStatSumIXSq ZeroBasedCounter64, 1317 reportStatsDataStatMetricExt1 ZeroBasedCounter32, 1318 reportStatsDataStatMetricExt2 ZeroBasedCounter32, 1319 reportStatsDataStatMetricExt3 ZeroBasedCounter32, 1320 reportStatsDataStatMetricExt4 ZeroBasedCounter32, 1321 reportStatsDataStatMetricExt5 ZeroBasedCounter32 1322 } 1324 reportStatsDataIndex OBJECT-TYPE 1325 SYNTAX Unsigned32 (1..2147483647) 1326 MAX-ACCESS not-accessible 1327 STATUS current 1328 DESCRIPTION 1329 "The value of reportAggrReportCntrlNumber for the report to 1330 which this entry belongs." 1331 ::= { reportStatsDataEntry 1 } 1333 -- [Note: Need to revisit the syntax for this object of type 'address'.] 1334 reportStatsDataServerAddress OBJECT-TYPE 1335 SYNTAX OCTET STRING (SIZE (0..108)) 1336 MAX-ACCESS not-accessible 1337 STATUS current 1338 DESCRIPTION 1339 "The network layer address of the server host in this 1340 conversation. 1342 This is represented as an octet string with specific 1343 semantics and length as identified by the 1344 protocolDirLocalIndex component of the index. 1346 Because this object is an index variable, it is encoded in 1347 the index according to the index encoding rules. For 1348 example, if the protocolDirLocalIndex indicates an 1349 encapsulation of IPv4, this object is encoded as a length 1350 octet of 4, followed by the 4 octets of the IPv4 address, 1351 in network byte order. 1353 If the associated reportAggrReportCntrlAggrType is equal to 1354 application(4) or client(2), then this object will be a null 1355 string and will be encoded simply as a length octet of 0." 1356 ::= { reportStatsDataEntry 2 } 1358 reportStatsDataStatN OBJECT-TYPE 1359 SYNTAX ZeroBasedCounter32 1360 MAX-ACCESS read-only 1361 STATUS current 1362 DESCRIPTION 1363 "The count of the total number of data points for the 1364 specified metric. This number is simply the value of 1365 reportCntrlReportsInterval divided by the value of 1366 reportCntrlReportsBinInterval, which should be integer 1367 valued. 1368 " 1369 ::= { reportStatsDataEntry 3 } 1371 reportStatsDataStatSumX OBJECT-TYPE 1372 SYNTAX ZeroBasedCounter32 1373 MAX-ACCESS read-only 1374 STATUS current 1375 DESCRIPTION 1376 "The sum of all the data point values for the specified 1377 metric. This number always represents the total values 1378 of the statistical datum analyzed. Each metric 1379 specifies the exact meaning of this object. 1380 This value represents the results of one metric and is 1381 related directly to the specific parameters of the metric 1382 and the Server and Client addresses involved." 1383 ::= { reportStatsDataEntry 4 } 1385 reportStatsDataOverflowStatSumX OBJECT-TYPE 1386 SYNTAX ZeroBasedCounter32 1387 MAX-ACCESS read-only 1388 STATUS current 1389 DESCRIPTION 1390 "The number of times the associated 1391 reportAggrReportStatSumX counter has overflowed. 1392 Note that this object will only be instantiated if the 1393 associated reportAggrReportHCStatSumX object is also 1394 instantiated for a particular dataSource." 1395 ::= { reportStatsDataEntry 5 } 1397 reportStatsDataHCStatSumX OBJECT-TYPE 1398 SYNTAX ZeroBasedCounter64 1399 MAX-ACCESS read-only 1400 STATUS current 1401 DESCRIPTION 1402 "The high-capacity version of reportAggrReportStatSumX. 1403 Note that this object will only be instantiated if the 1404 agent supports High Capacity monitoring for a particular 1405 dataSource." 1406 ::= { reportStatsDataEntry 6 } 1408 reportStatsDataStatMaximum OBJECT-TYPE 1409 SYNTAX ZeroBasedCounter32 1410 MAX-ACCESS read-only 1411 STATUS current 1412 DESCRIPTION 1413 "The single maximum data point value observed during the 1414 study period for the specified metric. This number always 1415 represents the maximum value of any single statistical 1416 datum analyzed. Each metric specifies the exact meaning 1417 of this object. 1419 This value represents the results of one metric and is 1420 related directly to the specific parameters of the metric 1421 and the Server and Client addresses involved." 1422 ::= { reportStatsDataEntry 7 } 1424 reportStatsDataStatMinimum OBJECT-TYPE 1425 SYNTAX ZeroBasedCounter32 1426 MAX-ACCESS read-only 1427 STATUS current 1428 DESCRIPTION 1429 "The single minimum data point value observed during the 1430 study period for the specified metric. This number always 1431 represents the minimum value of any single statistical 1432 datum analyzed. Each metric specifies the exact meaning 1433 of this object. 1435 This value represents the results of one metric and is 1436 related directly to the specific parameters of the metric 1437 and the Server and Client addresses involved." 1438 ::= { reportStatsDataEntry 8 } 1440 reportStatsDataStatSumSq OBJECT-TYPE 1441 SYNTAX ZeroBasedCounter32 1442 MAX-ACCESS read-only 1443 STATUS current 1444 DESCRIPTION 1445 "The sum of all the squared data point values for the 1446 specified metric. This number always represents the 1447 total of the squared values of the statistical datum 1448 analyzed. Each metric specifies the exact meaning of 1449 this object. 1451 This value represents the results of one metric and is 1452 related directly to the specific parameters of the metric 1453 and the Server and Client addresses involved." 1454 ::= { reportStatsDataEntry 9 } 1456 reportStatsDataOverflowStatSumSq OBJECT-TYPE 1457 SYNTAX ZeroBasedCounter32 1458 MAX-ACCESS read-only 1459 STATUS current 1460 DESCRIPTION 1461 "The number of times the associated 1462 reportAggrReportStatSumSq counter has overflowed. 1463 Note that this object will only be instantiated if 1464 the associated reportAggrReportHCStatSumSq object 1465 is also instantiated for a particular dataSource." 1466 ::= { reportStatsDataEntry 10 } 1468 reportStatsDataHCStatSumSq OBJECT-TYPE 1469 SYNTAX ZeroBasedCounter64 1470 MAX-ACCESS read-only 1471 STATUS current 1472 DESCRIPTION 1473 "The high-capacity version of reportAggrReportStatSumSq. 1474 Note that this object will only be instantiated if the 1475 agent supports High Capacity monitoring for a particular 1476 dataSource." 1477 ::= { reportStatsDataEntry 11 } 1479 reportStatsDataStatSumIX OBJECT-TYPE 1480 SYNTAX ZeroBasedCounter32 1481 MAX-ACCESS read-only 1482 STATUS current 1483 DESCRIPTION 1484 "For each interval, each data point is associated with a 1485 value I, I = 1..N where N is the number of data points; 1486 reportAggrReportStatSumIX is the multiplication of the 1487 data point value with the current I. This value 1488 along with the other statistics values allow the 1489 calculation of the slope of the least-squares line 1490 through the data points." 1491 ::= { reportStatsDataEntry 12 } 1493 reportStatsDataOverflowStatSumIX OBJECT-TYPE 1494 SYNTAX ZeroBasedCounter32 1495 MAX-ACCESS read-only 1496 STATUS current 1497 DESCRIPTION 1498 "The number of times the associated 1499 reportAggrReportStatSumIX counter has overflowed. 1500 Note that this object will only be instantiated if the 1501 associated reportAggrReportHCStatSumIX object is also 1502 instantiated for a particular dataSource." 1503 ::= { reportStatsDataEntry 13 } 1505 reportStatsDataHCStatSumIX OBJECT-TYPE 1506 SYNTAX ZeroBasedCounter64 1507 MAX-ACCESS read-only 1508 STATUS current 1509 DESCRIPTION 1510 "The high-capacity version of reportAggrReportStatSumIX. 1511 Note that this object will only be instantiated if the 1512 agent supports High Capacity monitoring for a particular 1513 dataSource." 1514 ::= { reportStatsDataEntry 14 } 1516 reportStatsDataStatSumIXSq OBJECT-TYPE 1517 SYNTAX ZeroBasedCounter32 1518 MAX-ACCESS read-only 1519 STATUS current 1520 DESCRIPTION 1521 "For each interval, each data point is associated with a 1522 value I, I = 1..N where N is the number of data points; 1523 reportAggrReportStatSumIXSq is the multiplication 1524 of the data point value squared with the current I. 1525 This value along with the other statistics 1526 values allow the calculation of the slope of 1527 the least-squares line through the data points." 1528 ::= { reportStatsDataEntry 15 } 1530 reportStatsDataOverflowStatSumIXSq OBJECT-TYPE 1531 SYNTAX ZeroBasedCounter32 1532 MAX-ACCESS read-only 1533 STATUS current 1534 DESCRIPTION 1535 "The number of times the associated 1536 reportAggrReportStatSumIXSq counter has overflowed. 1537 Note that this object will only be instantiated if the 1538 associated reportAggrReportHCStatSumIXSq object is also 1539 instantiated for a particular dataSource." 1540 ::= { reportStatsDataEntry 16 } 1542 reportStatsDataHCStatSumIXSq OBJECT-TYPE 1543 SYNTAX ZeroBasedCounter64 1544 MAX-ACCESS read-only 1545 STATUS current 1546 DESCRIPTION 1547 "The high-capacity version of reportAggrReportStatSumIXSq. 1548 Note that this object will only be instantiated if the 1549 agent supports High Capacity monitoring for a particular 1550 dataSource." 1551 ::= { reportStatsDataEntry 17 } 1553 reportStatsDataStatMetricExt1 OBJECT-TYPE 1554 SYNTAX ZeroBasedCounter32 1555 MAX-ACCESS read-only 1556 STATUS current 1557 DESCRIPTION 1558 "The .... for the MetricExt1. 1559 " 1560 ::= { reportStatsDataEntry 18 } 1562 reportStatsDataStatMetricExt2 OBJECT-TYPE 1563 SYNTAX ZeroBasedCounter32 1564 MAX-ACCESS read-only 1565 STATUS current 1566 DESCRIPTION 1567 "The .... for the MetricExt2. 1568 " 1569 ::= { reportStatsDataEntry 19 } 1571 reportStatsDataStatMetricExt3 OBJECT-TYPE 1572 SYNTAX ZeroBasedCounter32 1573 MAX-ACCESS read-only 1574 STATUS current 1575 DESCRIPTION 1576 "The .... for the MetricExt3. 1577 " 1578 ::= { reportStatsDataEntry 20 } 1580 reportStatsDataStatMetricExt4 OBJECT-TYPE 1581 SYNTAX ZeroBasedCounter32 1582 MAX-ACCESS read-only 1583 STATUS current 1584 DESCRIPTION 1585 "The .... for the MetricExt4. 1586 " 1587 ::= { reportStatsDataEntry 21 } 1589 reportStatsDataStatMetricExt5 OBJECT-TYPE 1590 SYNTAX ZeroBasedCounter32 1591 MAX-ACCESS read-only 1592 STATUS current 1593 DESCRIPTION 1594 "The .... for the MetricExt5. 1595 " 1596 ::= { reportStatsDataEntry 22 } 1598 reportSampledGroup OBJECT IDENTIFIER ::= { reportMIBObjects 2 } 1599 -- Then, the reportSampledGroup assignments are : 1600 -- reportSampledControlTable - 1 1601 -- reportSampledObjectTable - 2 1602 -- reportSampledDataTable - 3 1604 -- REPORT-MIB Editors' Note: 1605 -- The reportSampledGroup is copied from the usrHistory 1606 -- group documented in RMON2 [RFC2021]. We have perserved all of 1607 -- the annotations and object descriptions, as any changes would 1608 -- only diminish the quality of the development. The only changes 1609 -- made were to the naming of the objects themselves. Here we have 1610 -- merely prefixed the original names with 'report' and changed the 1611 -- 'usrHistory' to 'Sampled' as we felt this better reflected the 1612 -- the nature of the capability being offered by this group. 1613 -- The remainder of this group development is essentially 1614 -- copied from [RFC2021]: 1616 -- 1617 -- Sampled Collection Group (reportSampledGroup) 1618 -- 1619 -- The reportSampled group combines mechanisms seen in the alarm and 1620 -- history groups to provide user-specified samplying collection, 1621 -- utilizing two additional control tables and one additional data 1622 -- table. This function has traditionally been done by NMS 1623 -- applications, via periodic polling. The reportSampled group allows 1624 -- this task to be offloaded to a remote managed device. 1625 -- 1626 -- Data (an ASN.1 INTEGER based object) is collected in the same 1627 -- manner as any data table (e.g. etherHistoryTable) except 1628 -- that the user specifies the MIB instances to be collected and their 1629 -- sampling frequency. Objects are collected in 1630 -- bucket-groups, with the intent that all MIB 1631 -- instances in the same bucket-group are collected as atomically as 1632 -- possible by the remote managed device. 1633 -- 1634 -- The reportSampledControlTable is a one-dimensional read-create table. 1635 -- Each row configures a collection of sampling buckets; the creation of a 1636 -- row in this table will cause one or more associated instances in 1637 -- the reportSampledObjectTable to be created. The user specifies the 1638 -- number of bucket elements (rows in the reportSampledObjectTable) 1639 -- requested, as well as the number of buckets requested. 1640 -- 1641 -- The reportSampledObjectTable is a 2-d read-write table. 1642 -- Each row configures a single MIB instance to be collected. 1643 -- All rows with the same major index constitute a bucket-group. 1644 -- 1645 -- The reportSampledTable is a 3-d read-only table containing 1646 -- the data of associated reportSampledControlEntries. Each 1647 -- entry represents the value of a single MIB instance 1648 -- during a specific sampling interval (or the rate of 1649 -- change during the interval). 1650 -- 1651 -- A sample value is stored in two objects - an absolute value and 1652 -- a status object. This allows numbers from -(2G-1) to +4G to be 1653 -- stored. The status object also indicates whether a sample is 1654 -- valid. This allows data collection to continue if periodic 1655 -- retrieval of a particular instance fails for any reason. 1656 -- 1657 -- Row Creation Order Relationships 1658 -- 1659 -- The static nature of the reportSampledObjectTable creates 1660 -- some row creation/modification issues. The rows in this 1661 -- table need to be set before the associated 1662 -- reportSampledControlEntry can be activated. 1663 -- 1664 -- Note that the reportSampledObject entries associated with a 1665 -- particular reportSampledControlEntry are not required to 1666 -- be active before the control entry is activated. However, 1667 -- the reportSampled data entries associated with an inactive 1668 -- reportSampledObject entry will be inactive (i.e. 1669 -- reportSampledValStatus == valueNotAvailable). 1670 -- 1672 reportSampledControlTable OBJECT-TYPE 1673 SYNTAX SEQUENCE OF SampledControlEntry 1674 MAX-ACCESS not-accessible 1675 STATUS current 1676 DESCRIPTION 1677 "A list of data-collection configuration entries." 1678 ::= { reportSampledGroup 1 } 1680 reportSampledControlEntry OBJECT-TYPE 1681 SYNTAX SampledControlEntry 1682 MAX-ACCESS not-accessible 1683 STATUS current 1684 DESCRIPTION 1685 "A list of parameters that set up a group of user-defined 1686 MIB objects to be sampled periodically (called a 1687 bucket-group). 1689 For example, an instance of reportSampledControlInterval 1690 might be named reportSampledControlInterval.1" 1691 INDEX { reportSampledControlIndex } 1692 ::= { reportSampledControlTable 1 } 1694 SampledControlEntry ::= SEQUENCE { 1695 reportSampledControlIndex Integer32, 1696 reportSampledControlObjects Integer32, 1697 reportSampledControlBucketsRequested Integer32, 1698 reportSampledControlBucketsGranted Integer32, 1699 reportSampledControlInterval Integer32, 1700 reportSampledControlOwner OwnerString, 1701 reportSampledControlStatus RowStatus 1702 } 1704 reportSampledControlIndex OBJECT-TYPE 1705 SYNTAX Integer32 (1..65535) 1706 MAX-ACCESS not-accessible 1707 STATUS current 1708 DESCRIPTION 1709 "An index that uniquely identifies an entry in the 1710 reportSampledControlTable. Each such entry defines a 1711 set of samples at a particular interval for a specified 1712 set of MIB instances available from the managed system." 1713 ::= { reportSampledControlEntry 1 } 1715 reportSampledControlObjects OBJECT-TYPE 1716 SYNTAX Integer32 (1..65535) 1717 MAX-ACCESS read-create 1718 STATUS current 1719 DESCRIPTION 1720 "The number of MIB objects to be collected 1721 in the portion of reportSampledTable associated with this 1722 reportSampledControlEntry. 1724 This object may not be modified if the associated instance 1725 of reportSampledControlStatus is equal to active(1)." 1726 ::= { reportSampledControlEntry 2 } 1728 reportSampledControlBucketsRequested OBJECT-TYPE 1729 SYNTAX Integer32 (1..65535) 1730 MAX-ACCESS read-create 1731 STATUS current 1732 DESCRIPTION 1733 "The requested number of discrete time intervals 1734 over which data is to be saved in the part of the 1735 reportSampledTable associated with this 1736 reportSampledControlEntry. 1738 When this object is created or modified, the probe 1739 should set reportSampledControlBucketsGranted as closely to 1740 this object as is possible for the particular probe 1741 implementation and available resources." 1743 DEFVAL { 50 } 1744 ::= { reportSampledControlEntry 3 } 1746 reportSampledControlBucketsGranted OBJECT-TYPE 1747 SYNTAX Integer32 (1..65535) 1748 MAX-ACCESS read-only 1749 STATUS current 1750 DESCRIPTION 1751 "The number of discrete sampling intervals 1752 over which data shall be saved in the part of 1753 the reportSampledTable associated with this 1754 reportSampledControlEntry. 1756 When the associated reportSampledControlBucketsRequested 1757 object is created or modified, the probe should set 1758 this object as closely to the requested value as is 1759 possible for the particular probe implementation and 1760 available resources. The probe must not lower this 1761 value except as a result of a modification to the associated 1762 reportSampledControlBucketsRequested object. 1764 The associated reportSampledControlBucketsRequested object 1765 should be set before or at the same time as this object 1766 to allow the probe to accurately estimate the resources 1767 required for this reportSampledControlEntry. 1769 There will be times when the actual number of buckets 1770 associated with this entry is less than the value of 1771 this object. In this case, at the end of each sampling 1772 interval, a new bucket will be added to the 1773 reportSampledTable. 1775 When the number of buckets reaches the value of this object 1776 and a new bucket is to be added to the reportSampledTable, 1777 the oldest bucket associated with this 1778 reportSampledControlEntry shall be deleted by the agent 1779 so that the new bucket can be added. 1781 When the value of this object changes to a value less than 1782 the current value, entries are deleted from the 1783 reportSampledTable associated with this 1784 reportSampledControlEntry. Enough of the oldest 1785 of these entries shall be deleted by the 1786 agent so that their number remains less than or equal to the 1787 new value of this object. 1789 When the value of this object changes to a value greater 1790 than the current value, the number of associated 1791 reportSampled entries may be allowed to grow." 1792 ::= { reportSampledControlEntry 4 } 1794 reportSampledControlInterval OBJECT-TYPE 1795 SYNTAX Integer32 (1..2147483647) 1796 MAX-ACCESS read-create 1797 STATUS current 1798 DESCRIPTION 1799 "The interval in seconds over which the data is 1800 sampled for each bucket in the part of the reportSampled 1801 table associated with this reportSampledControlEntry. 1803 Because the counters in a bucket may overflow at their 1804 maximum value with no indication, a prudent manager will 1805 take into account the possibility of overflow in any of 1806 the associated counters. It is important to consider the 1807 minimum time in which any counter could overflow on a 1808 particular media type and set the 1809 reportSampledControlInterval object to a value less 1810 than this interval. 1812 This object may not be modified if the associated 1813 reportSampledControlStatus object is equal to active(1)." 1814 DEFVAL { 1800 } 1815 ::= { reportSampledControlEntry 5 } 1817 reportSampledControlOwner OBJECT-TYPE 1818 SYNTAX OwnerString 1819 MAX-ACCESS read-create 1820 STATUS current 1821 DESCRIPTION 1822 "The entity that configured this entry and is 1823 therefore using the resources assigned to it." 1824 ::= { reportSampledControlEntry 6 } 1826 reportSampledControlStatus OBJECT-TYPE 1827 SYNTAX RowStatus 1828 MAX-ACCESS read-create 1829 STATUS current 1830 DESCRIPTION 1831 "The status of this variable history control entry. 1833 An entry may not exist in the active state unless all 1834 objects in the entry have an appropriate value. 1836 If this object is not equal to active(1), all associated 1837 entries in the reportSampledTable shall be deleted." 1839 ::= { reportSampledControlEntry 7 } 1841 -- Object table 1843 reportSampledObjectTable OBJECT-TYPE 1844 SYNTAX SEQUENCE OF SampledObjectEntry 1845 MAX-ACCESS not-accessible 1846 STATUS current 1847 DESCRIPTION 1848 "A list of data-collection configuration entries." 1849 ::= { reportSampledGroup 2 } 1851 reportSampledObjectEntry OBJECT-TYPE 1852 SYNTAX SampledObjectEntry 1853 MAX-ACCESS not-accessible 1854 STATUS current 1855 DESCRIPTION 1856 "A list of MIB instances to be sampled periodically. 1858 Entries in this table are created when an associated 1859 reportSampledControlObjects object is created. 1861 The reportSampledControlIndex value in the index is 1862 that of the associated reportSampledControlEntry. 1864 For example, an instance of reportSampledObjectVariable 1865 might be reportSampledObjectVariable.1.3" 1866 INDEX { reportSampledControlIndex, reportSampledObjectIndex } 1867 ::= { reportSampledObjectTable 1 } 1869 SampledObjectEntry ::= SEQUENCE { 1870 reportSampledObjectIndex Integer32, 1871 reportSampledObjectVariable OBJECT IDENTIFIER, 1872 reportSampledObjectSampleType INTEGER 1873 } 1875 reportSampledObjectIndex OBJECT-TYPE 1876 SYNTAX Integer32 (1..65535) 1877 MAX-ACCESS not-accessible 1878 STATUS current 1879 DESCRIPTION 1880 "An index used to uniquely identify an entry in the 1881 reportSampledObject table. Each such entry defines a 1882 MIB instance to be collected periodically." 1883 ::= { reportSampledObjectEntry 1 } 1885 reportSampledObjectVariable OBJECT-TYPE 1886 SYNTAX OBJECT IDENTIFIER 1887 MAX-ACCESS read-create 1888 STATUS current 1889 DESCRIPTION 1890 "The object identifier of the particular variable to be 1891 sampled. 1893 Only variables that resolve to an ASN.1 primitive type of 1894 Integer32 (Integer32, Counter, Gauge, or TimeTicks) may be 1895 sampled. 1897 Because SNMP access control is articulated entirely in terms 1898 of the contents of MIB views, no access control mechanism 1899 exists that can restrict the value of this object to identify 1900 only those objects that exist in a particular MIB view. 1901 Because there is thus no acceptable means of restricting the 1902 read access that could be obtained through the user history 1903 mechanism, the probe must only grant write access to this 1904 object in those views that have read access to all objects on 1905 the probe. 1907 During a set operation, if the supplied variable name is not 1908 available in the selected MIB view, a badValue error must be 1909 returned. 1911 This object may not be modified if the associated 1912 reportSampledControlStatus object is equal to active(1)." 1913 ::= { reportSampledObjectEntry 2 } 1915 reportSampledObjectSampleType OBJECT-TYPE 1916 SYNTAX INTEGER { 1917 absoluteValue(1), 1918 deltaValue(2) 1919 } 1920 MAX-ACCESS read-create 1921 STATUS current 1922 DESCRIPTION 1923 "The method of sampling the selected variable for storage in 1924 the reportSampledTable. 1926 If the value of this object is absoluteValue(1), the value of 1927 the selected variable will be copied directly into the history 1928 bucket. 1930 If the value of this object is deltaValue(2), the value of the 1931 selected variable at the last sample will be subtracted from 1932 the current value, and the difference will be stored in the 1933 history bucket. If the associated reportSampledObjectVariable 1934 instance could not be obtained at the previous sample 1935 interval, then a delta sample is not possible, and the value 1936 of the associated reportSampledValStatus object for this 1937 interval will be valueNotAvailable(1). 1939 This object may not be modified if the associated 1940 reportSampledControlStatus object is equal to active(1)." 1941 ::= { reportSampledObjectEntry 3 } 1943 -- data table 1945 reportSampledTable OBJECT-TYPE 1946 SYNTAX SEQUENCE OF SampledEntry 1947 MAX-ACCESS not-accessible 1948 STATUS current 1949 DESCRIPTION 1950 "A list of user defined history entries." 1951 ::= { reportSampledGroup 3 } 1953 reportSampledEntry OBJECT-TYPE 1954 SYNTAX SampledEntry 1955 MAX-ACCESS not-accessible 1956 STATUS current 1957 DESCRIPTION 1958 "A historical sample of user-defined variables. This sample 1959 is associated with the reportSampledControlEntry which set 1960 up the parameters for a regular collection of these samples. 1962 The reportSampledControlIndex value in the index identifies 1963 the reportSampledControlEntry on whose behalf this entry 1964 was created. 1966 The reportSampledObjectIndex value in the index identifies 1967 the reportSampledObjectEntry on whose behalf this entry 1968 was created. 1970 For example, an instance of reportSampledAbsValue, which 1971 represents the 14th sample of a variable collected as 1972 specified by reportSampledControlEntry.1 and 1973 reportSampledObjectEntry.1.5, would be named 1974 reportSampledAbsValue.1.14.5" 1975 INDEX { reportSampledControlIndex, reportSampledSampleIndex, 1976 reportSampledObjectIndex } 1977 ::= { reportSampledTable 1 } 1979 SampledEntry ::= SEQUENCE { 1980 reportSampledSampleIndex Integer32, 1981 reportSampledIntervalStart TimeStamp, 1982 reportSampledIntervalEnd TimeStamp, 1983 reportSampledAbsValue Gauge32, 1984 reportSampledValStatus INTEGER 1985 } 1987 reportSampledSampleIndex OBJECT-TYPE 1988 SYNTAX Integer32 (1..2147483647) 1989 MAX-ACCESS not-accessible 1990 STATUS current 1991 DESCRIPTION 1992 "An index that uniquely identifies the particular sample this 1993 entry represents among all samples associated with the same 1994 reportSampledControlEntry. This index starts at 1 and 1995 increases by one as each new sample is taken." 1996 ::= { reportSampledEntry 1 } 1998 reportSampledIntervalStart OBJECT-TYPE 1999 SYNTAX TimeStamp 2000 MAX-ACCESS read-only 2001 STATUS current 2002 DESCRIPTION 2003 "The value of sysUpTime at the start of the interval over 2004 which this sample was measured. If the probe keeps track of 2005 the time of day, it should start the first sample of the 2006 history at a time such that when the next hour of the day 2007 begins, a sample is started at that instant. 2009 Note that following this rule may require the probe to delay 2010 collecting the first sample of the history, as each sample 2011 must be of the same interval. Also note that the sample which 2012 is currently being collected is not accessible in this table 2013 until the end of its interval." 2014 ::= { reportSampledEntry 2 } 2016 reportSampledIntervalEnd OBJECT-TYPE 2017 SYNTAX TimeStamp 2018 MAX-ACCESS read-only 2019 STATUS current 2020 DESCRIPTION 2021 "The value of sysUpTime at the end of the interval over which 2022 this sample was measured." 2023 ::= { reportSampledEntry 3 } 2025 reportSampledAbsValue OBJECT-TYPE 2026 SYNTAX Gauge32 2027 MAX-ACCESS read-only 2028 STATUS current 2029 DESCRIPTION 2030 "The absolute value (i.e. unsigned value) of the 2031 user-specified statistic during the last sampling period. The 2032 value during the current sampling period is not made available 2033 until the period is completed. 2035 To obtain the true value for this sampling interval, the 2036 associated instance of reportSampledValStatus must 2037 be checked, and reportSampledAbsValue adjusted as necessary. 2039 If the MIB instance could not be accessed during the sampling 2040 interval, then this object will have a value of zero and the 2041 associated instance of reportSampledValStatus will be set to 2042 'valueNotAvailable(1)'." 2043 ::= { reportSampledEntry 4 } 2045 reportSampledValStatus OBJECT-TYPE 2046 SYNTAX INTEGER { 2047 valueNotAvailable(1), 2048 valuePositive(2), 2049 valueNegative(3) 2050 } 2051 MAX-ACCESS read-only 2052 STATUS current 2053 DESCRIPTION 2054 "This object indicates the validity and sign of the data in 2055 the associated instance of reportSampledAbsValue. 2057 If the MIB instance could not be accessed during the sampling 2058 interval, then 'valueNotAvailable(1)' will be returned. 2060 If the sample is valid and actual value of the sample is 2061 greater than or equal to zero then 'valuePositive(2)' is 2062 returned. 2064 If the sample is valid and the actual value of the sample is 2065 less than zero, 'valueNegative(3)' will be returned. The 2066 associated instance of reportSampledAbsValue should be 2067 multiplied by -1 to obtain the true sample value." 2068 ::= { reportSampledEntry 5 } 2070 -- REPORT-MIB Editors' Note: This ends the copy of definitions from 2071 -- the usrHistory group from RMON2 [RFC 2021]. 2073 reportHistoryGroup OBJECT IDENTIFIER ::= { reportMIBObjects 3 } 2075 -- Then, the reportHistoryGroup assignments are : 2076 -- reportHistoryControlTable - 1 2077 -- reportHistoryDataTable - 2 2079 -- Notes: The history group is intended to track changes in 2080 -- identified objects ot type counter, gauge, other. Each, 2081 -- time the object is updated in the associated MIB, the 2082 -- history group stores a table entry in the associated 2083 -- historyDataTable capturing the time the change was 2084 -- made to the identified object. 2086 -- The historyControl Table ... 2087 -- 2088 -- The historyData Table .... 2090 reportHistoryControlEntry OBJECT-TYPE 2091 SYNTAX HistoryControlEntry 2092 MAX-ACCESS not-accessible 2093 STATUS current 2094 DESCRIPTION 2095 "A list of parameters that set up the collection 2096 of a history of changes 2097 in the user-defined MIB objects. 2099 For example, an instance of reportHistoryControlInterval 2100 might be named reportHistoryControlInterval.1" 2101 INDEX { reportHistoryControlIndex } 2102 ::= { reportHistoryControlTable 1 } 2104 HistoryControlEntry ::= SEQUENCE { 2105 reportHistoryControlIndex Integer32, 2106 reportHistoryControlObject Integer32, 2107 reportHistoryControlSizeRequested Integer32, 2108 reportHistoryControlSizeGranted Integer32, 2109 reportHistoryControlInterval Integer32, 2110 reportHistoryControlOwner OwnerString, 2111 reportHistoryControlStatus RowStatus 2112 } 2114 reportHistoryControlIndex OBJECT-TYPE 2115 SYNTAX Integer32 (1..65535) 2116 MAX-ACCESS not-accessible 2117 STATUS current 2118 DESCRIPTION 2119 "An index that uniquely identifies an entry in the 2120 reportHistoryControlTable. Each such entry defines a 2121 set of histories at a particular interval for a specified 2122 MIB object instance available from the managed system." 2123 ::= { reportHistoryControlEntry 1 } 2125 reportHistoryControlObject OBJECT-TYPE 2126 SYNTAX Integer32 (1..65535) 2127 MAX-ACCESS read-create 2128 STATUS current 2129 DESCRIPTION 2130 "The MIB object to be monitored for the collection 2131 histories in the reportHistoryDataTable associated with this 2132 reportHistoryControlEntry. 2134 This object may not be modified if the associated instance 2135 of reportHistoryControlStatus is equal to active(1)." 2136 ::= { reportHistoryControlEntry 2 } 2138 reportHistoryControlRequested OBJECT-TYPE 2139 SYNTAX Integer32 (1..65535) 2140 MAX-ACCESS read-create 2141 STATUS current 2142 DESCRIPTION 2143 "The requested maximum number of history entries 2144 to be saved in the 2145 reportHistoryDataTable associated with this 2146 reportHistoryControlEntry. 2148 When this object is created or modified, the device 2149 should set reportHistoryControlSizeGranted as closely to 2150 this object as is possible for the particular device 2151 implementation and available resources." 2152 DEFVAL { 50 } 2153 ::= { reportHistoryControlEntry 3 } 2155 reportHistoryControlSizeGranted OBJECT-TYPE 2156 SYNTAX Integer32 (1..65535) 2157 MAX-ACCESS read-only 2158 STATUS current 2159 DESCRIPTION 2160 "The maximum allowed number of discrete history entries 2161 in the reportHistoryTable associated with this 2162 reportHistoryControlEntry. 2164 When the associated reportHistoryControlSizeRequested 2165 object is created or modified, the device should set 2166 this object as closely to the requested value as is 2167 possible for the particular device implementation and 2168 available resources. The device must not lower this 2169 value except as a result of a modification to the associated 2170 reportHistoryControlSizeRequested object. 2172 The associated reportHistoryControlSizeRequested object 2173 should be set before or at the same time as this object 2174 to allow the device to accurately estimate the resources 2175 required for this reportHistoryControlEntry. 2177 When the number of histories reaches the value of this object 2178 and a new history is to be added to the reportHistoryTable, 2179 the oldest history associated with this 2180 reportHistoryControlEntry shall be deleted by the agent 2181 so that the new history can be added." 2182 ::= { reportHistoryControlEntry 4 } 2184 reportHistoryControlInterval OBJECT-TYPE 2185 SYNTAX Integer32 (1..2147483647) 2186 MAX-ACCESS read-create 2187 STATUS current 2188 DESCRIPTION 2189 "The interval in seconds over which the data histories 2190 are to be re4corded in the part of the reportHistory 2191 table associated with this reportHistoryControlEntry. 2193 This object may not be modified if the associated 2194 reportHistoryControlStatus object is equal to active(1)." 2195 DEFVAL { 1800 } 2196 ::= { reportHistoryControlEntry 5 } 2198 reportHistoryControlOwner OBJECT-TYPE 2199 SYNTAX OwnerString 2200 MAX-ACCESS read-create 2201 STATUS current 2202 DESCRIPTION 2203 "The entity that configured this entry and is 2204 therefore using the resources assigned to it." 2205 ::= { reportHistoryControlEntry 6 } 2207 reportHistoryControlStatus OBJECT-TYPE 2208 SYNTAX RowStatus 2209 MAX-ACCESS read-create 2210 STATUS current 2211 DESCRIPTION 2212 "The status of this variable history control entry. 2214 An entry may not exist in the active state unless all 2215 objects in the entry have an appropriate value. 2217 If this object is not equal to active(1), all associated 2218 entries in the reportHistoryTable shall be deleted." 2219 ::= { reportHistoryControlEntry 7 } 2221 -- data table 2223 reportHistoryTable OBJECT-TYPE 2224 SYNTAX SEQUENCE OF HistoryEntry 2225 MAX-ACCESS not-accessible 2226 STATUS current 2227 DESCRIPTION 2228 "A list of user defined history entries." 2229 ::= { reportHistoryGroup 3 } 2231 reportHistoryEntry OBJECT-TYPE 2232 SYNTAX HistoryEntry 2233 MAX-ACCESS not-accessible 2234 STATUS current 2235 DESCRIPTION 2236 "A historical trail of user-defined variables. This list 2237 is associated with the reportHistoryControlEntry which set 2238 up the parameters for a regular collection of these samples. 2240 The reportHistoryControlIndex value in the index identifies 2241 the reportHistoryControlEntry on whose behalf this entry 2242 was created. This also identifies the MIB object 2243 being tracked by this reportHistoryEntry. 2245 For example, an instance of reportHistory... 2246 " 2247 INDEX { reportHistoryControlIndex, 2248 reportHistoryDataIndex } 2249 ::= { reportHistoryTable 1 } 2251 HistoryEntry ::= SEQUENCE { 2252 reportHistoryDataIndex Integer32, 2253 reportHistoryDataChangeTime TimeStamp, 2254 reportHistoryDataValueType INTEGER, 2255 reportHistoryDataValue string, 2256 reportHistoryDataValStatus INTEGER 2257 } 2259 reportHistoryDataIndex OBJECT-TYPE 2260 SYNTAX Integer32 (1..2147483647) 2261 MAX-ACCESS not-accessible 2262 STATUS current 2263 DESCRIPTION 2264 "An index that uniquely identifies the particular sample this 2265 entry represents among all historical entries 2266 associated with the same 2267 reportHistoryControlEntry. This index starts at 1 and 2268 increases by one as each new sample is taken." 2269 ::= { reportHistoryEntry 1 } 2271 reportHistoryDataChangeTime OBJECT-TYPE 2272 SYNTAX TimeStamp 2273 MAX-ACCESS read-only 2274 STATUS current 2275 DESCRIPTION 2276 "The value of sysUpTime at the time that the MIB object was 2277 updated." 2278 ::= { reportHistoryEntry 2 } 2280 -- Note: May want to move this to the reportHistoryControlTable, 2281 -- as it is too redundant in this table. Also, need to reconsider 2282 -- the best way to indicate type and to represent values. 2283 reportHistoryDataValueType OBJECT-TYPE 2284 SYNTAX INTEGER 2285 MAX-ACCESS read-only 2286 STATUS current 2287 DESCRIPTION 2288 "The type of the data value stored in the 2289 reportHistoryDataValue string. The user identifies 2290 the MIB object to be tracked by this table. 2291 Various types of objects can be track, so the 2292 application needs to know the data type being 2293 stored. Types supported include counter, gauge, 2294 integer, float. 2295 " 2296 ::= { reportHistoryEntry 3 } 2298 reportHistoryDataValue OBJECT-TYPE 2299 SYNTAX string, 2300 MAX-ACCESS read-only 2301 STATUS current 2302 DESCRIPTION 2303 "The absolute value of the 2304 user-specified MIB object tracked by this 2305 table entry. 2307 If the MIB instance could not be accessed .... 2308 " 2310 ::= { reportHistoryEntry 4 } 2312 -- Note: Need to consider in detail the ability of the 2313 -- device to track the times of object change in 2314 -- enough detial to be useful. What happens if the 2315 -- device gets too busy and delays updating MIB object 2316 -- values tracked by this table entry. Needs more work. 2317 reportHistoryDataValStatus OBJECT-TYPE 2318 SYNTAX INTEGER { 2319 valueAvailable(1), 2320 valueDelayed(2) 2321 } 2322 MAX-ACCESS read-only 2323 STATUS current 2324 DESCRIPTION 2325 "This object indicates the validity of the data in 2326 the associated instance of reportHistoryAbsValue. 2328 If the MIB instance could not be accessed promptely, 2329 then 'valueDelayed(2)' will be returned. 2331 If the sample is valid and actual value of the sample 2332 was promptly recorded, then 'valueAvailable(1)' is 2333 returned. 2334 " 2335 ::= { reportHistoryEntry 5 } 2337 -- 2338 -- Notifications 2339 -- 2341 -- Note: What notifications do we want for this MIB? 2342 -- Checkout what is done in the APM-MIB for Notifications? 2344 -- 2345 -- Compliance Statements 2346 -- 2348 -- [Note: Current thoughts on Conformance follow: 2349 -- Mandatory for Stats will include no extensions, 2350 -- or high capacity objects. 2351 -- Hence, the reports will have only the hard-coded statistics. 2352 -- Optional for Stats will be extensions definition table and high 2353 -- capacity objects. 2354 -- 2355 -- Mandatory for Sampled will include all. 2356 -- 2357 -- Mandatory for History will include all.] 2359 reportCompliances OBJECT IDENTIFIER ::= { reportMIBConformance 1 } 2360 reportMIBGroups OBJECT IDENTIFIER ::= { reportMIBConformance 2 } 2362 reportStatsBasicCompliance MODULE-COMPLIANCE 2363 STATUS current 2364 DESCRIPTION "The Stats basic implementation requirements for 2365 managed network entities that implement 2366 the REPORT process." 2367 MODULE -- this module 2368 MANDATORY-GROUPS {reportStatsCapabilitiesBaseObjectsGroup, 2369 reportStatsControlBaseObjectsGroup, 2370 reportStatsDataBaseObjectsGroup } 2371 ::= { reportCompliances 1 } 2373 reportStatsHCCompliance MODULE-COMPLIANCE 2374 STATUS current 2375 DESCRIPTION "The HC implementation requirements for 2376 managed network entities that implement 2377 the REPORT process." 2378 MODULE -- this module 2379 MANDATORY-GROUPS {reportStatsCapabilitiesBaseObjectsGroup, 2380 reportStatsControlBaseObjectsGroup, 2381 reportStatsDataBaseObjectsGroup, 2382 reportStatsDataHCObjectsGroup } 2383 ::= { reportCompliances 2 } 2385 reportStatsExtendedMetricsCompliance MODULE-COMPLIANCE 2386 STATUS current 2387 DESCRIPTION "The extended metrics implementation requirements for 2388 managed network entities that implement 2389 the REPORT process." 2390 MODULE -- this module 2391 MANDATORY-GROUPS {reportStatsCapabilitiesBaseObjectsGroup, 2392 reportStatsControlBaseObjectsGroup, 2393 reportStatsDataBaseObjectsGroup, 2394 reportStatsExtendedMetricsCapabilitiesObjectsGroup, 2395 reportStatsExtendedMetricsControlObjectsGroup, 2396 reportStatsExtendedMetricsDataObjectsGroup } 2397 ::= { reportCompliances 3 } 2399 reportSampledBasicCompliance MODULE-COMPLIANCE 2400 STATUS current 2401 DESCRIPTION "The Sampled basic implementation requirements for 2402 managed network entities that implement 2403 the REPORT process." 2404 MODULE -- this module 2405 MANDATORY-GROUPS {reportSampledCapabilitiesBaseObjectsGroup, 2406 reportSampledControlBaseObjectsGroup, 2407 reportSampledObjectIDBaseObjectsGroup, 2408 reportSampledDataBaseObjectsGroup } 2409 ::= { reportCompliances 4 } 2411 reportHistoryBasicCompliance MODULE-COMPLIANCE 2412 STATUS current 2413 DESCRIPTION "The History basic implementation requirements for 2414 managed network entities that implement 2415 the REPORT process." 2416 MODULE -- this module 2417 MANDATORY-GROUPS {reportHistoryControlBaseObjectsGroup, 2418 reportHistoryDataBaseObjectsGroup } 2419 ::= { reportCompliances 5 } 2421 -- Units of Conformance 2423 reportStatsCapabilitiesBaseObjectsGroup OBJECT-GROUP 2424 OBJECTS { 2425 reportClockResolution, 2426 reportClockMaxSkew, 2427 reportClockSource 2428 } 2429 STATUS current 2430 DESCRIPTION 2431 "Set of REPORT configuration objects implemented 2432 in this module." 2433 ::= { reportMIBGroups 1 } 2435 reportStatsControlBaseObjectsGroup OBJECT-GROUP 2436 OBJECTS { 2437 reportStatsControlInterval, 2438 reportStatsControlBinInterval, 2439 reportStatsControlPriObjID, 2440 reportStatsControlReqReports, 2441 reportStatsControlGrantedReports, 2442 reportStatsControlStartTime, 2443 reportStatsControlReportNumber, 2444 reportStatsControlInsertsDenied, 2445 reportStatsControlOwner, 2446 reportStatsControlStorageType, 2447 reportStatsControlStatus 2448 } 2449 STATUS current 2450 DESCRIPTION 2451 "Set of REPORT Stats Control base objects implemented 2452 in this module." 2453 ::= { reportMIBGroups 2 } 2455 reportStatsDataBaseObjectsGroup OBJECT-GROUP 2456 OBJECTS { 2457 reportStatsDataServerAddress, 2458 reportStatsDataStatN, 2459 reportStatsDataStatSumX, 2460 reportStatsDataOverflowStatSumX, 2461 reportStatsDataStatMaximum, 2462 reportStatsDataStatMinimum, 2463 reportStatsDataStatSumSq, 2464 reportStatsDataOverflowStatSumSq, 2465 reportStatsDataStatSumIX, 2466 reportStatsDataOverflowStatSumIX, 2467 reportStatsDataStatSumIXSq, 2468 reportStatsDataOverflowStatSumIXSq 2469 } 2470 STATUS current 2471 DESCRIPTION 2472 "Set of REPORT state objects implemented 2473 in this module." 2474 ::= { reportMIBGroups 3 } 2476 reportStatsDataHCObjectsGroup OBJECT-GROUP 2477 OBJECTS { 2478 reportStatsDataHCStatSumX, 2479 reportStatsDataHCStatSumSq, 2480 reportStatsDataHCStatSumIX, 2481 reportStatsDataHCStatSumIXSq 2482 } 2483 STATUS current 2484 DESCRIPTION 2485 "Set of REPORT state objects implemented 2486 in this module." 2487 ::= { reportMIBGroups 4 } 2489 reportStatsExtendedMetricsCapabilitiesObjectsGroup OBJECT-GROUP 2490 OBJECTS { 2491 reportMetricExtDefType, 2492 reportMetricExtDefName, 2493 reportMetricExtDefOperation, 2494 reportMetricExtDefReference, 2495 reportMetricDirLastChange 2496 } 2497 STATUS current 2498 DESCRIPTION 2499 "Set of REPORT state objects implemented 2500 in this module." 2501 ::= { reportMIBGroups 5 } 2503 reportStatsExtendedMetricsControlObjectsGroup OBJECT-GROUP 2504 OBJECTS { 2505 reportStatsControlSecObj1ID, 2506 reportStatsControlSecObj2ID, 2507 reportStatsControlSecObj3ID, 2508 reportStatsControlSecObj4ID, 2509 reportStatsControlSecObj5ID, 2510 reportStatsControlMetricExt1, 2511 reportStatsControlMetricExt2, 2512 reportStatsControlMetricExt3, 2513 reportStatsControlMetricExt4, 2514 reportStatsControlMetricExt5 2515 } 2516 STATUS current 2517 DESCRIPTION 2518 "Set of REPORT state objects implemented 2519 in this module." 2520 ::= { reportMIBGroups 6 } 2522 reportStatsExtendedMetricsDataObjectsGroup OBJECT-GROUP 2523 OBJECTS { 2524 reportStatsDataStatMetricExt1, 2525 reportStatsDataStatMetricExt2, 2526 reportStatsDataStatMetricExt3, 2527 reportStatsDataStatMetricExt4, 2528 reportStatsDataStatMetricExt5 2529 } 2530 STATUS current 2531 DESCRIPTION 2532 "Set of REPORT state objects implemented 2533 in this module." 2534 ::= { reportMIBGroups 7 } 2536 reportSampledControlBaseObjectsGroup OBJECT-GROUP 2537 OBJECTS { 2538 reportSampledControlObjects, 2539 reportSampledControlBucketsRequested, 2540 reportSampledControlBucketsGranted, 2541 reportSampledControlInterval, 2542 reportSampledControlOwner, 2543 reportSampledControlStatus 2544 } 2545 STATUS current 2546 DESCRIPTION 2547 "Set of REPORT state objects implemented 2548 in this module." 2549 ::= { reportMIBGroups 8 } 2551 reportSampledObjectIDBaseObjectsGroup OBJECT-GROUP 2552 OBJECTS { 2553 reportSampledObjectVariable, 2554 reportSampledObjectSampleType 2555 } 2556 STATUS current 2557 DESCRIPTION 2558 "Set of REPORT state objects implemented 2559 in this module." 2560 ::= { reportMIBGroups 9 } 2562 reportSampledDataBaseObjectsGroup OBJECT-GROUP 2563 OBJECTS { 2564 reportSampledIntervalStart, 2565 reportSampledIntervalEnd, 2566 reportSampledAbsValue, 2567 reportSampledValStatus 2568 } 2569 STATUS current 2570 DESCRIPTION 2571 "Set of REPORT state objects implemented 2572 in this module." 2573 ::= { reportMIBGroups 10 } 2575 reportHistoryControlBaseObjectsGroup OBJECT-GROUP 2576 OBJECTS { 2577 reportHistoryControlObjects, 2578 reportHistoryControlSizeRequested, 2579 reportHistoryControlSizeGranted, 2580 reportHistoryControlInterval, 2581 reportHistoryControlOwner, 2582 reportHistoryControlStatus 2583 } 2584 STATUS current 2585 DESCRIPTION 2586 "Set of REPORT state objects implemented 2587 in this module." 2588 ::= { reportMIBGroups 11 } 2589 reportHistoryDataBaseObjectsGroup OBJECT-GROUP 2590 OBJECTS { 2591 reportHistoryDataChangeTime, 2592 reportHistoryDataValueType, 2593 reportHistoryDataValue, 2594 reportHistoryDataValStatus 2595 } 2596 STATUS current 2597 DESCRIPTION 2598 "Set of REPORT state objects implemented 2599 in this module." 2600 ::= { reportMIBGroups 12 } 2602 END 2604 8. Security Considerations 2606 [TODO] Each specification that defines one or more MIB modules MUST 2607 contain a section that discusses security considerations relevant to 2608 those modules. This section MUST be patterned after the latest 2609 approved template (available at 2610 http://www.ops.ietf.org/mib-security.html). Remember that the 2611 objective is not to blindly copy text from the template, but rather 2612 to think and evaluate the risks/vulnerabilities and then state/ 2613 document the result of this evaluation. 2615 [TODO] if you have any read-write and/or read-create objects, please 2616 include the following boilerplate paragraph. 2618 There are a number of management objects defined in this MIB module 2619 with a MAX-ACCESS clause of read-write and/or read-create. Such 2620 objects may be considered sensitive or vulnerable in some network 2621 environments. The support for SET operations in a non-secure 2622 environment without proper protection can have a negative effect on 2623 network operations. These are the tables and objects and their 2624 sensitivity/vulnerability: 2626 o [TODO] writable MIB objects that could be especially disruptive if 2627 abused MUST be explicitly listed by name and the associated 2628 security risks MUST be spelled out; RFC 2669 has a very good 2629 example. 2631 o [TODO] list the writable tables and objects and state why they are 2632 sensitive. 2634 [TODO] else if there are no read-write objects in your MIB module, 2635 use the following boilerplate paragraph. 2637 There are no management objects defined in this MIB module that have 2638 a MAX-ACCESS clause of read-write and/or read-create. So, if this 2639 MIB module is implemented correctly, then there is no risk that an 2640 intruder can alter or create any management objects of this MIB 2641 module via direct SNMP SET operations. 2643 [TODO] if you have any sensitive readable objects, please include the 2644 following boilerplate paragraph. 2646 Some of the readable objects in this MIB module (i.e., objects with a 2647 MAX-ACCESS other than not-accessible) may be considered sensitive or 2648 vulnerable in some network environments. It is thus important to 2649 control even GET and/or NOTIFY access to these objects and possibly 2650 to even encrypt the values of these objects when sending them over 2651 the network via SNMP. These are the tables and objects and their 2652 sensitivity/vulnerability: 2654 o [TODO] you must explicitly list by name any readable objects that 2655 are sensitive or vulnerable and the associated security risks MUST 2656 be spelled out (for instance, if they might reveal customer 2657 information or violate personal privacy laws such as those of the 2658 European Union if exposed to unauthorized parties) 2660 o [TODO] list the tables and objects and state why they are 2661 sensitive. 2663 [TODO] discuss what security the protocol used to carry the 2664 information should have. The following three boilerplate paragraphs 2665 should not be changed without very good reason. Changes will almost 2666 certainly require justification during IESG review. 2668 SNMP versions prior to SNMPv3 did not include adequate security. 2669 Even if the network itself is secure (for example by using IPSec), 2670 even then, there is no control as to who on the secure network is 2671 allowed to access and GET/SET (read/change/create/delete) the objects 2672 in this MIB module. 2674 It is RECOMMENDED that implementers consider the security features as 2675 provided by the SNMPv3 framework (see [RFC3410], section 8), 2676 including full support for the SNMPv3 cryptographic mechanisms (for 2677 authentication and privacy). 2679 Further, deployment of SNMP versions prior to SNMPv3 is NOT 2680 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 2681 enable cryptographic security. It is then a customer/operator 2682 responsibility to ensure that the SNMP entity giving access to an 2683 instance of this MIB module is properly configured to give access to 2684 the objects only to those principals (users) that have legitimate 2685 rights to indeed GET or SET (change/create/delete) them. 2687 9. IANA Considerations 2689 [TODO] In order to comply with IESG policy as set forth in 2690 http://www.ietf.org/ID-Checklist.html, every Internet-Draft that is 2691 submitted to the IESG for publication MUST contain an IANA 2692 Considerations section. The requirements for this section vary 2693 depending what actions are required of the IANA. see RFC4181 section 2694 3.5 for more information on writing an IANA clause for a MIB module 2695 document. 2697 [TODO] select an option and provide the necessary details. 2699 Option #1: 2701 The MIB module in this document uses the following IANA-assigned 2702 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 2704 Descriptor OBJECT IDENTIFIER value 2705 ---------- ----------------------- 2707 sampleMIB { mib-2 XXX } 2709 Option #2: 2711 Editor's Note (to be removed prior to publication): the IANA is 2712 requested to assign a value for "XXX" under the 'mib-2' subtree and 2713 to record the assignment in the SMI Numbers registry. When the 2714 assignment has been made, the RFC Editor is asked to replace "XXX" 2715 (here and in the MIB module) with the assigned value and to remove 2716 this note. 2718 Note well: prior to official assignment by the IANA, a draft document 2719 MUST use placeholders (such as "XXX" above) rather than actual 2720 numbers. See RFC4181 Section 4.5 for an example of how this is done 2721 in a draft MIB module. 2723 Option #3: 2725 This memo includes no request to IANA. 2727 10. Contributors 2729 This MIB document uses the template authored by D. Harrington which 2730 is based on contributions from the MIB Doctors, especially Juergen 2731 Schoenwaelder, Dave Perkins, C.M.Heard and Randy Presuhn. 2733 11. Acknowledgements 2735 We would like to thank Bert Wijnen and Andy Bierman for pointing out 2736 the existence of the usrHistory group within RMON2 and in answering 2737 our numerous questions on the usrHistory group. Further, we wish to 2738 thank U. Herberg for his forcing additions to this MIB through his 2739 thoughtful consideration of performance monitoring requirements for 2740 other MIBs, e.g., NHDP and OLSR MIBs. 2742 12. References 2744 12.1. Normative References 2746 [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group 2747 MIB", RFC 2863, June 2000. 2749 [RFC3418] Presuhn, R., "Management Information Base (MIB) for the 2750 Simple Network Management Protocol (SNMP)", STD 62, 2751 RFC 3418, December 2002. 2753 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2754 Requirement Levels", BCP 14, RFC 2119, March 1997. 2756 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 2757 Schoenwaelder, Ed., "Structure of Management Information 2758 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 2760 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 2761 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 2762 STD 58, RFC 2579, April 1999. 2764 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 2765 "Conformance Statements for SMIv2", STD 58, RFC 2580, 2766 April 1999. 2768 12.2. Informative References 2770 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 2771 "Introduction and Applicability Statements for Internet- 2772 Standard Management Framework", RFC 3410, December 2002. 2774 [RFC1757] Waldbusser, S., "Remote Network Monitoring Management 2775 Information Base", RFC 1757, February 1995. 2777 [RFC2021] Waldbusser, S., "Remote Network Monitoring Management 2778 Information Base Version 2 using SMIv2", RFC 2021, 2779 January 1997. 2781 Appendix A. Change Log 2783 Changes from -01 to -02 draft. 2785 1. Restructured the MIB somewhat to now offer the three reporting 2786 capabilities in increasing order of detail: a) statistical 2787 reports, b) sampled reports, and c) historical reports. 2789 2. Renamed the usrHistoryGroup and elements to samplingGroup. This 2790 is in line with its actual capabilities. 2792 3. Added a new historyGroup which provides a history of change 2793 events. 2795 4. Updated the4 Conformance section to reflect the above changes and 2796 additions. But did not yet run smilint to check MIB syntax. 2798 Changes from -00 to -01 draft. 2800 1. Added (copied) the usrHistory group from RMON2 into the REPORT- 2801 MIB. 2803 2. Restructured the MIB to account for the inclusion of the 2804 reportSampledGroup. 2806 3. Dropped the reportCurReportsTable as this did not make sense 2807 within the context of the REPORT-MIB. 2809 4. Added the Compliance and Conformance material. Defined several 2810 Compliance Groups to all for base implementations of the REPORT- 2811 MIB for only statistical reports, for only historical reports or 2812 for both. Allow for enhanced implementations to address higher 2813 capacity issues and extension to metric reporting for statistical 2814 reporting. 2816 5. Ran the MIB through the smilint checker and in the process 2817 corrected numerous typos, ommisions, TEXTUAL CONVENTIONS, 2818 IMPORTS, etc. 2820 6. Updated main text to reflect changes. 2822 Appendix B. Open Issues 2824 This section contains the set of open issues related to the 2825 development and design of the REPORT-MIB. This section will not be 2826 present in the final version of the MIB and will be removed once all 2827 the open issues have been resolved. 2829 1. Need to add an index associated with object IDs of interest 2830 which are conatined within a table, e.g., IfPacketsIn in an 2831 InterfaceTable which is indexed by IfIndex. 2833 2. Specify the set of metrics for default support. Done. 2835 3. Clean up the Table indexing. Specifically, what uniquely 2836 defines a report? 2838 4. Complete notification group. 2840 5. Complete conformance group. Done but not yet checked by 2841 smilint. 2843 6. Work on the relationship to other MIBs, IF-MIB, NHDP-MIB. 2845 7. Update the text of the document to reflect the final state of 2846 the MIB. 2848 8. Identify all objects requiring non-volatile storage in their 2849 DESCRIPTION clauses. 2851 9. Incorporate parameter relationship conditions into their 2852 DESCRIPTION clauses. 2854 10. Complete the security analysis and section. 2856 11. Cleanup all the [TODOs] from the MIB template. 2858 Appendix C. 2860 *************************************************************** 2861 * Note to the RFC Editor (to be removed prior to publication) * 2862 * * 2863 * 1) The reference to RFCXXXX within the DESCRIPTION clauses * 2864 * of the MIB module point to this draft and are to be * 2865 * assigned by the RFC Editor. * 2866 * * 2867 * 2) The reference to RFCXXX2 throughout this document point * 2868 * to the current draft-ietf-manet-report-xx.txt. This * 2869 * need to be replaced with the XXX RFC number. * 2870 * * 2871 *************************************************************** 2873 Authors' Addresses 2875 Robert G. Cole 2876 Johns Hopkins University 2877 3400 North Charles Street 2878 Baltimore, Maryland 21218 2879 USA 2881 Phone: +1 443 910 4420 2882 EMail: rgcole01@comcast.net 2883 URI: http://www.cs.jhu.edu/~rgcole/ 2885 Joseph Macker 2886 Naval Research Laboratory 2887 Washington, D.C. 20375 2888 USA 2890 EMail: macker@itd.nrl.navy.mil 2892 Al Morton 2893 AT&T Laboratories 2894 Middletown, N.J. 07724 2895 USA 2897 EMail: amorton@att.com