idnits 2.17.1 draft-ietf-entmib-ext-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Cannot find the required boilerplate sections (Copyright, IPR, etc.) in this document. Expected boilerplate is as follows today (2024-03-29) according to https://trustee.ietf.org/license-info : IETF Trust Legal Provisions of 28-dec-2009, Section 6.a: This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 2: Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 3: This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing document type: Expected "INTERNET-DRAFT" in the upper left hand corner of the first page ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories. == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an 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. Miscellaneous warnings: ---------------------------------------------------------------------------- -- 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 (March 1998) is 9511 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) ** Downref: Normative reference to an Historic RFC: RFC 1157 ** Obsolete normative reference: RFC 1902 (Obsoleted by RFC 2578) ** Obsolete normative reference: RFC 1903 (Obsoleted by RFC 2579) ** Obsolete normative reference: RFC 1904 (Obsoleted by RFC 2580) ** Obsolete normative reference: RFC 1905 (Obsoleted by RFC 3416) ** Obsolete normative reference: RFC 2037 (Obsoleted by RFC 2737) ** Obsolete normative reference: RFC 2233 (Obsoleted by RFC 2863) ** Obsolete normative reference: RFC 2271 (Obsoleted by RFC 2571) ** Obsolete normative reference: RFC 2272 (Obsoleted by RFC 2572) ** Obsolete normative reference: RFC 2273 (Obsoleted by RFC 2573) ** Obsolete normative reference: RFC 2274 (Obsoleted by RFC 2574) ** Obsolete normative reference: RFC 2275 (Obsoleted by RFC 2575) Summary: 22 errors (**), 0 flaws (~~), 1 warning (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Draft Entity MIB Extensions March 1998 4 5 Entity MIB Extensions 7 12 March 1998 9 Andy Bierman 10 Cisco Systems Inc. 11 abierman@cisco.com 13 Keith McCloghrie 14 Cisco Systems Inc. 15 kzm@cisco.com 17 Status of this Memo 19 This document is an Internet-Draft. Internet-Drafts are working 20 documents of the Internet Engineering Task Force (IETF), its areas, and 21 its working groups. Note that other groups may also distribute working 22 documents as Internet-Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six months 25 and may be updated, replaced, or obsoleted by other documents at any 26 time. It is inappropriate to use Internet- Drafts as reference material 27 or to cite them other than as ``work in progress.'' 29 To learn the current status of any Internet-Draft, please check the 30 ``1id-abstracts.txt'' listing contained in the Internet- Drafts Shadow 31 Directories on ds.internic.net (US East Coast), nic.nordu.net (Europe), 32 ftp.isi.edu (US West Coast), or munnari.oz.au (Pacific Rim). 34 1. Introduction 36 This memo defines an experimental portion of the Management Information 37 Base (MIB) for use with network management protocols in the Internet 38 community. In particular, it describes managed objects used for 39 managing multiple logical and physical entities managed by a single SNMP 40 agent. 42 Draft Entity MIB Extensions March 1998 44 2. The SNMP Network Management Framework 46 The SNMP Network Management Framework presently consists of six major 47 components. They are: 49 o the overall architecture, described in RFC 2271 [RFC2271]. 51 o the SMI, described in RFC 1902 [RFC1902], - the mechanisms used for 52 describing and naming objects for the purpose of management. 54 o the MIB-II, STD 17, RFC 1213 [RFC1213], - the core set of managed 55 objects for the Internet suite of protocols. 57 o the protocol, RFC 1157 [RFC1157] and/or RFC 1905 [RFC1905] and/or 58 RFC 2272 [RFC2272] -- the protocol for accessing managed 59 information. 61 o the user-based security model defined in RFC 2274 [RFC2274]. 63 o the view-based access control model defined in RFC 2275 [RFC2275]. 65 Textual conventions are defined in RFC 1903 [RFC1903], and conformance 66 statements are defined in RFC 1904 [RFC1904]. Common applications are 67 defined in RFC 2273 [RFC2273]. 69 The Framework permits new objects to be defined for the purpose of 70 experimentation and evaluation. 72 This memo specifies a MIB module that is compliant to the SNMPv2 SMI. A 73 semantically identical MIB conforming to the SNMPv1 SMI can be produced 74 through the appropriate translation. 76 2.1. Object Definitions 78 Managed objects are accessed via a virtual information store, termed the 79 Management Information Base or MIB. Objects in the MIB are defined 80 using the subset of Abstract Syntax Notation One (ASN.1) defined in the 81 SMI. In particular, each object type is named by an OBJECT IDENTIFIER, 82 an administratively assigned name. The object type together with an 83 object instance serves to uniquely identify a specific instantiation of 84 the object. For human convenience, we often use a textual string, 85 termed the descriptor, to refer to the object type. 87 Draft Entity MIB Extensions March 1998 89 3. Overview 91 There is a need for a standardized way of providing non-volatile, 92 administratively assigned identifiers for physical components 93 represented with the Entity MIB [RFC2037]. There is also a need to 94 align the Entity MIB with the SNMPv3 administrative framework [RFC2271]. 96 This document defines extensions to the Entity MIB to address these 97 needs. 99 4. Entity MIB Extensions 101 4.1. MIB Structure 103 The Entity Extensions MIB contains two group: 105 - Entity Physical Extensions Group 107 - Entity Logical Extensions Group 109 4.1.1. Entity Physical Extensions Group 111 This group contains a single table, called the entPhysicalXTable, which 112 augments the entPhysicalTable. Each entPhysicalXEntry provides a 113 writable string object, 'entPhysicalAlias', which can be used by an NMS 114 as a non-volatile 'alias' (or label) for the physical component. 116 The entPhysicalAlias object is different from the ifAlias version in 117 several ways: 119 - SnmpAdminString SYNTAX 120 The Interfaces MIB [RFC2233] version is defined as a DisplayString 121 [RFC1903]. The Entity MIB [RFC2037] version is defined as an 122 SnmpAdminString [RFC2271]. 124 - SIZE (0..32) 125 The maximum length of the entPhysicalAlias string is half that of 126 the ifAlias object. 128 - MIN-ACCESS read-only 129 Maintaining a non-volatile string for every physical component 130 represented in the entPhysicalTable can be costly and unnecessary. 131 An agent may choose to algorithmically generate entPhysicalAlias 133 Draft Entity MIB Extensions March 1998 135 strings for particular entries (based on the entPhysicalClass 136 value). 138 4.1.2. Entity Logical Extensions Group 140 This group contains a single table, called the entLogicalXTable, which 141 augments the entLogicalTable. Each entLogicalXEntry provides two read- 142 only strings identifying the contextEngineID and contextName [RFC2271]. 143 These strings can be used in SNMPv3 PDUs [RFC2272] to access management 144 information held by the indicated SNMP agent, associated with each 145 logical entity. 147 4.2. Definitions 149 ENTITY-EXTENSIONS-MIB DEFINITIONS ::= BEGIN 151 IMPORTS 152 MODULE-IDENTITY, OBJECT-TYPE 153 FROM SNMPv2-SMI 154 MODULE-COMPLIANCE, OBJECT-GROUP 155 FROM SNMPv2-CONF 156 SnmpEngineID, SnmpAdminString 157 FROM SNMP-FRAMEWORK-MIB 158 entityMIBObjects, entPhysicalEntry, entLogicalEntry, 159 entityCompliances, entityGroups, entityPhysicalGroup 160 FROM ENTITY-MIB; 162 entityXMIB MODULE-IDENTITY 163 LAST-UPDATED "9803110000Z" 164 ORGANIZATION "IETF Entity MIB Working Group" 165 CONTACT-INFO 166 "IETF Entity MIB WG Mailing List 167 WG Subscribe: 168 majordomo@cisco.com 169 message body: subscribe entmib 170 WG Discussion: 171 entmib@cisco.com 172 WG Archive: 173 ftp://ftpeng.cisco.com/ftp/entmib/entmib 175 Andy Bierman 176 Cisco Systems Inc. 177 170 West Tasman Drive 179 Draft Entity MIB Extensions March 1998 181 San Jose, CA 95134 182 408-527-3711 183 abierman@cisco.com 185 Keith McCloghrie 186 Cisco Systems Inc. 187 170 West Tasman Drive 188 San Jose, CA 95134 189 408-526-5260 190 kzm@cisco.com" 191 DESCRIPTION 192 "The extension MIB module for physical entity information." 193 ::= { experimental xx } 195 -- 196 -- New Entity MIB Object Groups 197 -- 198 entityPhysicalX OBJECT IDENTIFIER ::= { entityMIBObjects 5 } 199 entityLogicalX OBJECT IDENTIFIER ::= { entityMIBObjects 6 } 201 -- *********************************************************** 202 -- 203 -- E N T I T Y P H Y S I C A L E X T E N S I O N S 204 -- 205 -- *********************************************************** 207 -- entPhysicalTable extensions 208 entPhysicalXTable OBJECT-TYPE 209 SYNTAX SEQUENCE OF EntPhysicalXEntry 210 MAX-ACCESS not-accessible 211 STATUS current 212 DESCRIPTION 213 "This table contains one row per physical element 214 represented in the entPhysicalTable." 215 ::= { entityPhysicalX 1 } 217 entPhysicalXEntry OBJECT-TYPE 218 SYNTAX EntPhysicalXEntry 219 MAX-ACCESS not-accessible 220 STATUS current 221 DESCRIPTION 222 "Information about a particular physical entity." 223 AUGMENTS { entPhysicalEntry } 224 ::= { entPhysicalXTable 1 } 226 Draft Entity MIB Extensions March 1998 228 EntPhysicalXEntry ::= SEQUENCE { 229 entPhysicalAlias SnmpAdminString 230 } 232 entPhysicalAlias OBJECT-TYPE 233 SYNTAX SnmpAdminString (SIZE (0..32)) 234 MAX-ACCESS read-write 235 STATUS current 236 DESCRIPTION 237 "This object is an 'alias' name for the physical entity as 238 specified by a network manager, and provides a non-volatile 239 'handle' for the physical entity. 241 On the first instantiation of an physical entity, the value 242 of entPhysicalAlias associated with that entity is set to 243 the zero-length string. An agent may instead choose to set 244 the value to a locally unique default value instead of a 245 zero-length string. 247 If write access is implemented for an instance of 248 entPhysicalAlias, and a value is written into the instance, 249 the agent must retain the supplied value in the 250 entPhysicalAlias instance associated with the same physical 251 entity for as long as that entity remains instantiated, 252 including across all re-initializations/reboots of the 253 network management system, including those which result in a 254 change of the physical entity's entPhysicalIndex value." 255 ::= { entPhysicalXEntry 1 } 257 -- *********************************************************** 258 -- 259 -- E N T I T Y L O G I C A L E X T E N S I O N S 260 -- 261 -- *********************************************************** 263 -- entLogicalTable extensions 264 entLogicalXTable OBJECT-TYPE 265 SYNTAX SEQUENCE OF EntLogicalXEntry 266 MAX-ACCESS not-accessible 267 STATUS current 268 DESCRIPTION 269 "This table contains one row per logical entity represented 270 in the entLogicalTable." 271 ::= { entityLogicalX 1 } 273 Draft Entity MIB Extensions March 1998 275 entLogicalXEntry OBJECT-TYPE 276 SYNTAX EntLogicalXEntry 277 MAX-ACCESS not-accessible 278 STATUS current 279 DESCRIPTION 280 "Information about a particular logical entity." 281 AUGMENTS { entLogicalEntry } 282 ::= { entLogicalXTable 1 } 284 EntLogicalXEntry ::= SEQUENCE { 285 entLogicalContextEngineID SnmpEngineID, 286 entLogicalContextName SnmpAdminString 287 } 289 entLogicalContextEngineID OBJECT-TYPE 290 SYNTAX SnmpEngineID 291 MAX-ACCESS read-only 292 STATUS current 293 DESCRIPTION 294 "The contextEngineID that can be used to send an SNMPv3 295 message concerning information held by this logical entity, 296 to the address specified by the associated 297 'entLogicalTAddress/entLogicalTDomain' pair." 298 ::= { entLogicalXEntry 1 } 300 entLogicalContextName OBJECT-TYPE 301 SYNTAX SnmpAdminString 302 MAX-ACCESS read-only 303 STATUS current 304 DESCRIPTION 305 "The contextName that can be used to send an SNMPv3 message 306 concerning information held by this logical entity, to the 307 address specified by the associated 308 'entLogicalTAddress/entLogicalTDomain' pair." 309 ::= { entLogicalXEntry 2 } 311 -- conformance information 312 -- compliance statements 314 entityPhysicalXCompliance MODULE-COMPLIANCE 315 STATUS current 316 DESCRIPTION 317 "The compliance statement for SNMP entities which implement 318 the Entity MIB PhysicalX Extensions. 319 MODULE -- this module 321 Draft Entity MIB Extensions March 1998 323 MANDATORY-GROUPS { 324 entityPhysicalGroup, 325 entityPhysicalXGroup 326 } 328 OBJECT entPhysicalAlias 329 MIN-ACCESS read-only 330 DESCRIPTION 331 "Write access is required if the associated 332 entPhysicalClass value is equal to 'chassis(3)'. 333 Otherwise, write access is not required." 334 ::= { entityCompliances 2 } 336 entityLogicalXCompliance MODULE-COMPLIANCE 337 STATUS current 338 DESCRIPTION 339 "The compliance statement for SNMP entities which implement 340 the Entity MIB LogicalX Extensions. 341 MODULE -- this module 342 MANDATORY-GROUPS { 343 entityLogicalGroup, 344 entityLogicalXGroup 345 } 346 ::= { entityCompliances 3 } 348 -- MIB groupings 349 entityPhysicalXGroup OBJECT-GROUP 350 OBJECTS { 351 entPhysicalAlias 352 } 353 STATUS current 354 DESCRIPTION 355 "The collection of objects which are used to represent 356 extended physical component information for which a single 357 agent provides management information." 358 ::= { entityGroups 6 } 360 entityLogicalXGroup OBJECT-GROUP 361 OBJECTS { 362 entLogicalContextEngineID, 363 entLogicalContextName, 364 } 365 STATUS current 366 DESCRIPTION 368 Draft Entity MIB Extensions March 1998 370 "The collection of objects which are used to represent 371 extended logical entity information for which a single agent 372 provides management information." 373 ::= { entityGroups 7 } 375 END 376 Draft Entity MIB Extensions March 1998 378 5. References 380 [RFC1157] 381 Case, J., M. Fedor, M. Schoffstall, J. Davin, "Simple Network 382 Management Protocol", RFC 1157, SNMP Research, Performance Systems 383 International, MIT Laboratory for Computer Science, May 1990. 385 [RFC1213] 386 McCloghrie, K., and M. Rose, Editors, "Management Information Base 387 for Network Management of TCP/IP-based internets: MIB-II", STD 17, 388 RFC 1213, Hughes LAN Systems, Performance Systems International, 389 March 1991. 391 [RFC1902] 392 SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and 393 S. Waldbusser, "Structure of Management Information for version 2 394 of the Simple Network Management Protocol (SNMPv2)", RFC 1902, 395 January 1996. 397 [RFC1903] 398 SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and 399 S. Waldbusser, "Textual Conventions for version 2 of the Simple 400 Network Management Protocol (SNMPv2)", RFC 1903, January 1996. 402 [RFC1904] 403 SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and 404 S. Waldbusser, "Conformance Statements for version 2 of the Simple 405 Network Management Protocol (SNMPv2)", RFC 1904, January 1996. 407 [RFC1905] 408 SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and 409 S. Waldbusser, "Protocol Operations for version 2 of the Simple 410 Network Management Protocol (SNMPv2)", RFC 1905, January 1996. 412 [RFC2037] 413 McCloghrie, K., Bierman, A., "Entity MIB using SMIv2", RFC 2037, 414 Cisco Systems, October 1996. 416 [RFC2233] 417 McCloghrie, K., and Kastenholtz, F., "Interfaces Group Evolution", 418 RFC 2233, Cisco Systems, FTP Software, November 1997. 420 [RFC2271] 421 Harrington D., Presuhn, R., Wijnen, B., "An Architecture for 422 Describing SNMP Management Frameworks", RFC 2271, Cabletron 424 Draft Entity MIB Extensions March 1998 426 Systems, BMC Software, Inc., IBM T.J. Watson Research, January 427 1998. 429 [RFC2272] 430 Harrington D., Presuhn, R., Wijnen, B., "Message Processing and 431 Dispatching for the Simple Network Management Protocol (SNMP)", RFC 432 2272, Cabletron Systems, BMC Software, Inc., IBM T.J. Watson 433 Research, January 1998. 435 [RFC2273] 436 Levi D., Meyer P., Stewart, B., "SNMPv3 Applications", RFC 2273, 437 SNMP Research, Inc., Secure Computing Corporation, Cisco Systems, 438 January 1998. 440 [RFC2274] 441 Blumenthal, U., Wijnen, B., "User-based Security Model (USM) for 442 version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 443 2274, IBM T. J. Watson Research, January 1998. 445 [RFC2275] 446 Wijnen, B., Presuhn, R., McCloghrie, K., "View-based Access Control 447 Model (VACM) for the Simple Network Management Protocol (SNMP)", 448 RFC 2275, IBM T.J. Watson Research, BMC Software, Inc., Cisco 449 Systems, Inc., January 1998. 451 Draft Entity MIB Extensions March 1998 453 6. Security Considerations 455 No additional security concerns are introduced due to implementation of 456 this MIB module. Refer to RFC 2037 [RFC2037] for information on any 457 security issues related to the Entity MIB. 459 7. Author's Address 461 Andy Bierman 462 Cisco Systems, Inc. 463 170 West Tasman Drive 464 San Jose, CA 95134 465 Phone: 408-527-3711 466 Email: abierman@cisco.com 468 Keith McCloghrie 469 Cisco Systems, Inc. 470 170 West Tasman Drive 471 San Jose, CA 95134 472 Phone: 408-526-5260 473 Email: kzm@cisco.com 475 Draft Entity MIB Extensions March 1998 477 Table of Contents 479 1 Introduction .................................................... 1 480 2 The SNMP Network Management Framework ........................... 2 481 2.1 Object Definitions ............................................ 2 482 3 Overview ........................................................ 3 483 4 Entity MIB Extensions ........................................... 3 484 4.1 MIB Structure ................................................. 3 485 4.1.1 Entity Physical Extensions Group ............................ 3 486 4.1.2 Entity Logical Extensions Group ............................. 4 487 4.2 Definitions ................................................... 4 488 5 References ...................................................... 10 489 6 Security Considerations ......................................... 12 490 7 Author's Address ................................................ 12