idnits 2.17.1 draft-irtf-nmrg-get-subtree-mib-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard == It seems as if not all pages are separated by form feeds - found 0 form feeds but 12 pages Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an Abstract section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. ** There are 5 instances of too long lines in the document, the longest one being 4 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (21 October 1999) is 8954 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: '16' is mentioned on line 366, but not defined ** Obsolete normative reference: RFC 2571 (ref. '1') (Obsoleted by RFC 3411) ** Downref: Normative reference to an Informational RFC: RFC 1215 (ref. '4') ** Downref: Normative reference to an Historic RFC: RFC 1157 (ref. '8') ** Downref: Normative reference to an Historic RFC: RFC 1901 (ref. '9') ** Obsolete normative reference: RFC 1906 (ref. '10') (Obsoleted by RFC 3417) ** Obsolete normative reference: RFC 2572 (ref. '11') (Obsoleted by RFC 3412) ** Obsolete normative reference: RFC 2574 (ref. '12') (Obsoleted by RFC 3414) ** Obsolete normative reference: RFC 1905 (ref. '13') (Obsoleted by RFC 3416) ** Obsolete normative reference: RFC 2573 (ref. '14') (Obsoleted by RFC 3413) ** Obsolete normative reference: RFC 2575 (ref. '15') (Obsoleted by RFC 3415) Summary: 15 errors (**), 0 flaws (~~), 4 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Network Working Group Dave Thaler 2 Internet-Draft Microsoft 3 Expires: April 2000 21 October 1999 5 Subtree Retrieval MIB 6 8 Status of this Memo 10 This document is an Internet-Draft and is in full conformance with 11 all provisions of Section 10 of RFC2026. 13 Internet-Drafts are working documents of the Internet Engineering 14 Task Force (IETF), its areas, and its working groups. Note that 15 other groups may also distribute working documents as Internet- 16 Drafts. 18 Internet-Drafts are draft documents valid for a maximum of six 19 months and may be updated, replaced, or obsoleted by other 20 documents at any time. It is inappropriate to use Internet- 21 Drafts as reference material or to cite them other than as "work 22 in progress." 24 The list of current Internet-Drafts can be accessed at 25 http://www.ietf.org/ietf/1id-abstracts.txt 27 The list of Internet-Draft Shadow Directories can be accessed at 28 http://www.ietf.org/shadow.html. 30 Copyright Notice 32 Copyright (C) The Internet Society (1999). All Rights Reserved. 34 Draft GET-SUBTREE MIB October 1999 36 1. Introduction 38 This memo defines a portion of the Management Information Base 39 (MIB) for use with network management protocols in the Internet 40 community. In particular, it describes managed objects used for 41 retrieving a subtree of MIB objects without the overshoot problems 42 of the SNMP GetBulkRequest operation. 44 2. The SNMP Network Management Framework 46 The SNMP Management Framework presently consists of five major 47 components: 49 o An overall architecture, described in RFC 2571 [1]. 51 o Mechanisms for describing and naming objects and events for 52 the purpose of management. The first version of this 53 Structure of Management Information (SMI) is called SMIv1 and 54 described in RFC 1155 [2], RFC 1212 [3] and RFC 1215 [4]. The 55 second version, called SMIv2, is described in RFC 2578 [5], 56 RFC 2579 [6] and RFC 2580 [7]. 58 o Message protocols for transferring management information. 59 The first version of the SNMP message protocol is called 60 SNMPv1 and described in RFC 1157 [8]. A second version of the 61 SNMP message protocol, which is not an Internet standards 62 track protocol, is called SNMPv2c and described in RFC 1901 63 [9] and RFC 1906 [10]. The third version of the message 64 protocol is called SNMPv3 and described in RFC 1906 [10], RFC 65 2572 [11] and RFC 2574 [12]. 67 o Protocol operations for accessing management information. The 68 first set of protocol operations and associated PDU formats 69 is described in RFC 1157 [8]. A second set of protocol 70 operations and associated PDU formats is described in RFC 71 1905 [13]. 73 o A set of fundamental applications described in RFC 2573 [14] 74 and the view-based access control mechanism described in RFC 75 2575 [15]. 77 Managed objects are accessed via a virtual information store, 78 termed the Management Information Base or MIB. Objects in the MIB 79 are defined using the mechanisms defined in the SMI. 81 Draft GET-SUBTREE MIB October 1999 83 This memo specifies a MIB module that is compliant to the SMIv2. A 84 MIB conforming to the SMIv1 can be produced through the 85 appropriate translations. The resulting translated MIB must be 86 semantically equivalent, except where objects or events are 87 omitted because no translation is possible (use of Counter64). 88 Some machine readable information in SMIv2 will be converted into 89 textual descriptions in SMIv1 during the translation process. 90 However, this loss of machine readable information is not 91 considered to change the semantics of the MIB. 93 3. Overview 95 The GetBulkRequest operation in SNMP [13] aims to minimize the 96 number of protocol exchanges required to retrieve a large amount 97 of management information by returning a series of variable 98 bindings in a single response. The requester is required to 99 specify a "max-repetitions" count, and the agent then fills in as 100 many variable bindings as it can without exceeding either this 101 count, or the maximum message size. 103 One problem with retrieving tables with GetBulkRequest is that the 104 manager typically does not know the number of rows in the table, 105 and hence cannot set max-repetitions to the optimal value. As a 106 result, the manager must either set max-repetitions to some huge 107 value, resulting in a potentially large waste of bandwidth when 108 many more variable bindings are returned than are needed 109 (sometimes called "overshoot"), or else must issue multiple 110 GetBulkRequests sequentially to traverse a large table such as the 111 routing table in a backbone router. 113 This document describes a MIB than can be used by an application 114 to retrieve subtrees of information, without any change to the 115 SNMP protocol or SNMP protocol engines, as follows. The 116 application must have been pre-configured as a legal notification 117 target in the SNMP-TARGET-MIB [14]. 119 The MIB described herein provides a table of outstanding 120 GetSubtree operations which allows row creation. To begin a 121 retrieval, an application issues a SetRequest to perform a row 122 creation in this table, which identifies the application 123 (represented by an entry in the snmpTargetAddrTable) as the 124 response destination. This row creation triggers the agent to 125 begin sending Traps containing the requested information to the 126 application. Each trap contains a sequence number object (which 128 Draft GET-SUBTREE MIB October 1999 130 can be used to detect losses), and an flag object signalling 131 whether the trap is the final one in the sequence. Once all 132 information has been sent, the conceptual row is automatically 133 deleted. 135 Furthermore, if the request was in error (e.g., a human entered a 136 different OID from what was intended, causing the application to 137 receive large amounts of unwanted data), the MIB also provides a 138 way to halt an operation in progress, if the agent is able to 139 support this. Halting an operation in progress is accomplished 140 simply by allowing the application to delete the conceptual row 141 corresponding to the outstanding operation. 143 3.1. Limitations 145 The limitations of this approach that come with not changing SNMP 146 include: 148 o To use this MIB to retrieve subtrees of information, the 149 application must be able to issue SETs (at least to this 150 MIB), not just GETs. 152 o The command responder and notification originator need to be 153 tightly coupled, as well as the command generator and 154 notification responder. 156 o The subagent implementing this MIB must be able to call back 157 into the SNMP engine to walk other MIBs, without causing a 158 deadlock. 160 Draft GET-SUBTREE MIB October 1999 162 4. Definitions 164 GET-SUBTREE-MIB DEFINITIONS ::= BEGIN 166 IMPORTS 167 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, 168 Unsigned32, Counter32 FROM SNMPv2-SMI 169 RowStatus, TruthValue FROM SNMPv2-TC 170 MODULE-COMPLIANCE, OBJECT-GROUP, 171 NOTIFICATION-GROUP FROM SNMPv2-CONF 172 SnmpAdminString FROM SNMP-FRAMEWORK-MIB; 174 getSubtreeMIB MODULE-IDENTITY 175 LAST-UPDATED "9907161200Z" 176 ORGANIZATION "IRTF Network Management Research Group" 177 CONTACT-INFO 178 " Dave Thaler 179 Microsoft Corporation 180 One Microsoft Way 181 Redmond, WA 98052-6399 182 EMail: dthaler@dthaler.microsoft.com" 183 DESCRIPTION 184 "This MIB module provides the ability to retrieve an arbitary 185 subtree of OIDs by receiving traps." 186 ::= { XXX } 188 getSubtreeMIBObjects OBJECT IDENTIFIER ::= { getSubtreeMIB 1 } 190 getSubtree OBJECT IDENTIFIER ::= { getSubtreeMIBObjects 1 } 191 getSubtreeTraps OBJECT IDENTIFIER ::= { getSubtreeMIBObjects 2 } 193 getSubtreeTable OBJECT-TYPE 194 SYNTAX SEQUENCE OF GetSubtreeEntry 195 MAX-ACCESS not-accessible 196 STATUS current 197 DESCRIPTION 198 "The (conceptual) table containing information on 199 GET-SUBTREE operations in progress." 200 ::= { getSubtree 1 } 202 getSubtreeEntry OBJECT-TYPE 203 SYNTAX GetSubtreeEntry 204 MAX-ACCESS not-accessible 205 STATUS current 206 DESCRIPTION 208 Draft GET-SUBTREE MIB October 1999 210 "An entry (conceptual row) containing the information on a 211 particular GET-SUBTREE operation in progress." 212 INDEX { getSubtreeIndex } 213 ::= { getSubtreeTable 1 } 215 GetSubtreeEntry ::= SEQUENCE { 216 getSubtreeIndex Unsigned32, 217 getSubtreeTargetAddrName SnmpAdminString, 218 getSubtreeRootOid OBJECT IDENTIFIER, 219 getSubtreeSequenceNumber Counter32, 220 getSubtreeDone TruthValue, 221 getSubtreeStatus RowStatus 222 } 224 getSubtreeIndex OBJECT-TYPE 225 SYNTAX Unsigned32 226 MAX-ACCESS not-accessible 227 STATUS current 228 DESCRIPTION 229 "An integer uniquely identifying the GET-SUBTREE operation in 230 progress. This value should be randomly generated by a 231 manager before attempting to create the row." 232 ::= { getSubtreeEntry 1 } 234 getSubtreeTargetAddrName OBJECT-TYPE 235 SYNTAX SnmpAdminString 236 MAX-ACCESS read-create 237 STATUS current 238 DESCRIPTION 239 "This object selects a management target defined in the 240 snmpTargetAddrTable (in the SNMP-TARGET-MIB). The 241 selected target is defined by an entry in the 242 snmpTargetAddrTable whose index value (snmpTargetAddrName) 243 is equal to this object." 244 ::= { getSubtreeEntry 2 } 246 getSubtreeRootOid OBJECT-TYPE 247 SYNTAX OBJECT IDENTIFIER 248 MAX-ACCESS read-create 249 STATUS current 250 DESCRIPTION 251 "The OID of the subtree to be sent." 252 ::= { getSubtreeEntry 3 } 254 getSubtreeSequenceNumber OBJECT-TYPE 256 Draft GET-SUBTREE MIB October 1999 258 SYNTAX Counter32 259 MAX-ACCESS read-only 260 STATUS current 261 DESCRIPTION 262 "The number of trap responses previously sent for this request." 263 ::= { getSubtreeEntry 4 } 265 getSubtreeDone OBJECT-TYPE 266 SYNTAX TruthValue 267 MAX-ACCESS read-only 268 STATUS current 269 DESCRIPTION 270 "This is set to true in the last trap sent, and is set to 271 false otherwise." 272 ::= { getSubtreeEntry 5 } 274 getSubtreeStatus OBJECT-TYPE 275 SYNTAX RowStatus 276 MAX-ACCESS read-create 277 STATUS current 278 DESCRIPTION 279 "The status of this row, by which new entries may be 280 created, or old entries deleted from this table. Once 281 created, the row may be deleted, but other objects in the 282 row may not be modified. A row will be deleted automatically 283 by the agent once the operation has completed. 285 Creating a row will cause the subtree retrieval operation 286 to commence. If the agent allows aborting operations in 287 progress, deleting a row will cause the operation to halt." 288 ::= { getSubtreeEntry 6 } 290 -- traps 292 getSubtreeTrapPrefix OBJECT IDENTIFIER ::= { getSubtreeTraps 0 } 294 getSubtreeResponse NOTIFICATION-TYPE 295 OBJECTS { getSubtreeSequenceNumber, getSubtreeDone } 296 STATUS current 297 DESCRIPTION 298 "In addition to the two objects above, this trap also 299 contains a series of varbinds containing the next chunk of 300 the subtree. The generating entity will append, in order, 301 as many variables to the variable-bindings field as it can 302 without exceeding the maximum message size, and without going 304 Draft GET-SUBTREE MIB October 1999 306 beyond the subtree of OIDs requested. A series of such 307 traps will be generated until the end of the subtree is 308 reached." 309 ::= { getSubtreeTrapPrefix 1 } 311 -- conformance information 313 getSubtreeMIBConformance 314 OBJECT IDENTIFIER ::= { getSubtreeMIB 2 } 315 getSubtreeMIBCompliances 316 OBJECT IDENTIFIER ::= { getSubtreeMIBConformance 1 } 317 getSubtreeMIBGroups OBJECT IDENTIFIER ::= { getSubtreeMIBConformance 2 } 319 -- compliance statements 321 getSubtreeMIBCompliance MODULE-COMPLIANCE 322 STATUS current 323 DESCRIPTION 324 "The compliance statement for the GetSubtree MIB." 325 MODULE -- this module 326 MANDATORY-GROUPS { getSubtreeObjectGroup, 327 getSubtreeNotificationGroup } 328 ::= { getSubtreeMIBCompliances 1 } 330 -- units of conformance 332 getSubtreeObjectGroup OBJECT-GROUP 333 OBJECTS { getSubtreeTargetAddrName, getSubtreeRootOid, 334 getSubtreeSequenceNumber, getSubtreeDone, 335 getSubtreeStatus } 336 STATUS current 337 DESCRIPTION 338 "A collection of objects to support requests for 339 subtree retrieval operations." 340 ::= { getSubtreeMIBGroups 1 } 342 getSubtreeNotificationGroup NOTIFICATION-GROUP 343 NOTIFICATIONS { getSubtreeResponse } 344 STATUS current 345 DESCRIPTION 346 "The notification which an entity is required to implement." 347 ::= { getSubtreeMIBGroups 2 } 349 END 351 Draft GET-SUBTREE MIB October 1999 353 5. Security Considerations 355 While unauthorized read access to the objects in this MIB is 356 relatively innocuous, unauthorized write access could trigger 357 sending of a potentially large amount of data to an authorized 358 notification receiver, which could be viewed as a denial-of- 359 service attack. 361 Hence, the support for SNMP operations in a non-secure environment 362 without proper protection can have a negative effect on network 363 operations. 365 SNMPv1 by itself is such an insecure environment. Even if the 366 network itself is secure (for example by using IPSec [16]), even 367 then, there is no control as to who on the secure network is 368 allowed to access and SET (change/create/delete) the objects in 369 this MIB. 371 It is recommended that the implementers consider the security 372 features as provided by the SNMPv3 framework. Specifically, the 373 use of the User-based Security Model RFC 2274 [12] and the View- 374 based Access Control Model RFC 2275 [15] is recommended. 376 It is then a customer/user responsibility to ensure that the SNMP 377 entity giving access to this MIB, is properly configured to give 378 access to those objects only to those principals (users) that have 379 legitimate rights to access them. 381 6. Authors' Addresses 383 Dave Thaler 384 Microsoft Corporation 385 One Microsoft Way 386 Redmond, WA 98052-6399 387 Phone: +1 425 703 8835 388 EMail: dthaler@microsoft.com 390 7. References 392 [1] Wijnen, B., Harrington, D., and R. Presuhn, "An Architecture 393 for Describing SNMP Management Frameworks", RFC 2571, 394 Cabletron Systems, Inc., BMC Software, Inc., IBM T. J. Watson 395 Research, April 1999. 397 Draft GET-SUBTREE MIB October 1999 399 [2] Rose, M., and K. McCloghrie, "Structure and Identification of 400 Management Information for TCP/IP-based Internets", STD 16, 401 RFC 1155, Performance Systems International, Hughes LAN 402 Systems, May 1990. 404 [3] Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD 405 16, RFC 1212, Performance Systems International, Hughes LAN 406 Systems, March 1991. 408 [4] M. Rose, "A Convention for Defining Traps for use with the 409 SNMP", RFC 1215, Performance Systems International, March 410 1991. 412 [5] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Structure 413 of Management Information Version 2 (SMIv2)", STD 58, RFC 414 2578, April 1999. 416 [6] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Textual 417 Conventions for SMIv2", STD 58, RFC 2579, April 1999. 419 [7] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 420 "Conformance Statements for SMIv2", STD 58, RFC 2580, April 421 1999. 423 [8] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple 424 Network Management Protocol", STD 15, RFC 1157, SNMP 425 Research, Performance Systems International, Performance 426 Systems International, MIT Laboratory for Computer Science, 427 May 1990. 429 [9] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, 430 "Introduction to Community-based SNMPv2", RFC 1901, SNMP 431 Research, Inc., Cisco Systems, Inc., Dover Beach Consulting, 432 Inc., International Network Services, January 1996. 434 [10] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, 435 "Transport Mappings for Version 2 of the Simple Network 436 Management Protocol (SNMPv2)", RFC 1906, SNMP Research, Inc., 437 Cisco Systems, Inc., Dover Beach Consulting, Inc., 438 International Network Services, January 1996. 440 [11] Case, J., Harrington D., Presuhn R., and B. Wijnen, "Message 441 Processing and Dispatching for the Simple Network Management 442 Protocol (SNMP)", RFC 2572, SNMP Research, Inc., Cabletron 443 Systems, Inc., BMC Software, Inc., IBM T. J. Watson Research, 445 Draft GET-SUBTREE MIB October 1999 447 April 1999. 449 [12] Blumenthal, U., and B. Wijnen, "User-based Security Model 450 (USM) for version 3 of the Simple Network Management Protocol 451 (SNMPv3)", RFC 2574, IBM T. J. Watson Research, April 1999. 453 [13] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, 454 "Protocol Operations for Version 2 of the Simple Network 455 Management Protocol (SNMPv2)", RFC 1905, SNMP Research, Inc., 456 Cisco Systems, Inc., Dover Beach Consulting, Inc., 457 International Network Services, January 1996. 459 [14] Levi, D., Meyer, P., and B. Stewart, "SNMPv3 Applications", 460 RFC 2573, SNMP Research, Inc., Secure Computing Corporation, 461 Cisco Systems, April 1999. 463 [15] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based 464 Access Control Model (VACM) for the Simple Network Management 465 Protocol (SNMP)", RFC 2575, IBM T. J. Watson Research, BMC 466 Software, Inc., Cisco Systems, Inc., April 1999. 468 8. Full Copyright Statement 470 Copyright (C) The Internet Society (1999). All Rights Reserved. 472 This document and translations of it may be copied and furnished 473 to others, and derivative works that comment on or otherwise 474 explain it or assist in its implmentation may be prepared, copied, 475 published and distributed, in whole or in part, without 476 restriction of any kind, provided that the above copyright notice 477 and this paragraph are included on all such copies and derivative 478 works. However, this document itself may not be modified in any 479 way, such as by removing the copyright notice or references to the 480 Internet Society or other Internet organizations, except as needed 481 for the purpose of developing Internet standards in which case the 482 procedures for copyrights defined in the Internet Standards 483 process must be followed, or as required to translate it into 484 languages other than English. 486 The limited permissions granted above are perpetual and will not 487 be revoked by the Internet Society or its successors or assigns. 489 This document and the information contained herein is provided on 490 an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET 492 Draft GET-SUBTREE MIB October 1999 494 ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR 495 IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 496 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 497 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.