idnits 2.17.1 draft-ietf-entmib-v3-04.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: ---------------------------------------------------------------------------- ** 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 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? == 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.) == There are 6 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 2558 has weird spacing: '...imed to perta...' -- 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 (22 January 2004) is 7399 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: 'RFC2574' is mentioned on line 2713, but not defined ** Obsolete undefined reference: RFC 2574 (Obsoleted by RFC 3414) == Missing Reference: 'RFC2575' is mentioned on line 2714, but not defined ** Obsolete undefined reference: RFC 2575 (Obsoleted by RFC 3415) -- Obsolete informational reference (is this intentional?): RFC 1493 (Obsoleted by RFC 4188) -- Obsolete informational reference (is this intentional?): RFC 1516 (Obsoleted by RFC 2108) -- Obsolete informational reference (is this intentional?): RFC 2037 (Obsoleted by RFC 2737) -- Obsolete informational reference (is this intentional?): RFC 2737 (Obsoleted by RFC 4133) Summary: 7 errors (**), 0 flaws (~~), 6 warnings (==), 6 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Entity MIB Working Group Andy Bierman 2 Internet Draft Keith McCloghrie 3 Cisco Systems, Inc. 4 22 January 2004 6 Entity MIB (Version 3) 8 10 Status of this Memo 12 This document is an Internet-Draft and is in full conformance with all 13 provisions of Section 10 of RFC2026 [RFC2026]. 15 Internet-Drafts are working documents of the Internet Engineering Task 16 Force (IETF), its areas, and its working groups. Note that other groups 17 may also distribute working documents as Internet-Drafts. 19 Internet-Drafts are draft documents valid for a maximum of six months 20 and may be updated, replaced, or obsoleted by other documents at any 21 time. It is inappropriate to use Internet- Drafts as reference material 22 or to cite them other than as "work 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 Distribution of this document is unlimited. Please send comments to the 31 Entity MIB Working Group, . 33 1. Copyright Notice 35 Copyright (C) The Internet Society (2004). All Rights Reserved. 37 "Abstract" 39 This memo defines a portion of the Management Information Base (MIB) for 40 use with network management protocols in the Internet community. In 41 particular, it describes managed objects used for managing multiple 42 logical and physical entities managed by a single SNMP agent. This 43 document specifies version 3 of the Entity MIB, which obsoletes version 44 2 (RFC 2737). 46 2. Table of Contents 48 1 Copyright Notice ................................................ 1 49 2 Table of Contents ............................................... 2 50 3 The SNMP Management Framework ................................... 3 51 4 Overview ........................................................ 3 52 4.1 Terms ......................................................... 4 53 4.2 Relationship to Community Strings ............................. 5 54 4.3 Relationship to SNMP Contexts ................................. 6 55 4.4 Relationship to Proxy Mechanisms .............................. 6 56 4.5 Relationship to a Chassis MIB ................................. 6 57 4.6 Relationship to the Interfaces MIB ............................ 7 58 4.7 Relationship to the Other MIBs ................................ 7 59 4.8 Relationship to Naming Scopes ................................. 7 60 4.9 Multiple Instances of the Entity MIB .......................... 8 61 4.10 Re-Configuration of Entities ................................. 8 62 4.11 Textual Convention Change .................................... 9 63 4.12 MIB Structure ................................................ 9 64 4.12.1 entityPhysical Group ....................................... 9 65 4.12.2 entityLogical Group ........................................ 10 66 4.12.3 entityMapping Group ........................................ 11 67 4.12.4 entityGeneral Group ........................................ 11 68 4.12.5 entityNotifications Group .................................. 12 69 4.13 Multiple Agents .............................................. 12 70 4.14 Changes Since RFC 2037 ....................................... 12 71 4.14.1 Textual Conventions ........................................ 12 72 4.14.2 New entPhysicalTable Objects ............................... 12 73 4.14.3 New entLogicalTable Objects ................................ 13 74 4.14.4 Bugfixes ................................................... 13 75 4.15 Changes Since RFC 2737 ....................................... 13 76 4.15.1 Textual Conventions ........................................ 13 77 4.15.2 Deprecated Objects ......................................... 13 78 4.15.3 Bugfixes ................................................... 14 79 5 Definitions ..................................................... 15 80 6 Usage Examples .................................................. 46 81 6.1 Router/Bridge ................................................. 46 82 6.2 Repeaters ..................................................... 52 83 7 Intellectual Property ........................................... 60 84 8 Acknowledgements ................................................ 60 85 9 Normative References ............................................ 60 86 10 Informative References ......................................... 61 87 11 Security Considerations ........................................ 63 88 12 Authors' Addresses ............................................. 65 89 13 Full Copyright Statement ....................................... 66 91 3. The SNMP Management Framework 93 For a detailed overview of the documents that describe the current 94 Internet-Standard Management Framework, please refer to section 7 of RFC 95 3410 [RFC3410]. 97 Managed objects are accessed via a virtual information store, termed the 98 Management Information Base or MIB. MIB objects are generally accessed 99 through the Simple Network Management Protocol (SNMP). Objects in the 100 MIB are defined using the mechanisms defined in the Structure of 101 Management Information (SMI). This memo specifies a MIB module that is 102 compliant to the SMIv2, which is described in STD 58, RFC 2578 103 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 [RFC2580]. 105 4. Overview 107 There is a need for a standardized way of representing a single agent 108 which supports multiple instances of one MIB. This is presently true 109 for at least 3 standard MIBs, and is likely to become true for more and 110 more MIBs as time passes. For example: 112 - multiple instances of a bridge supported within a single device 113 having a single agent; 115 - multiple repeaters supported by a single agent; 117 - multiple OSPF backbone areas, each one operating as part of its own 118 Autonomous System, and each identified by the same area-id (e.g., 119 0.0.0.0), supported inside a single router with one agent. 121 The fact that it is a single agent in each of these cases implies there 122 is some relationship which binds all of these entities together. 123 Effectively, there is some "overall" physical entity which houses the 124 sum of the things managed by that one agent, i.e., there are multiple 125 "logical" entities within a single physical entity. Sometimes, the 126 overall physical entity contains multiple (smaller) physical entities 127 and each logical entity is associated with a particular physical entity. 128 Sometimes, the overall physical entity is a "compound" of multiple 129 physical entities (e.g., a stack of stackable hubs). 131 What is needed is a way to determine exactly what logical entities are 132 managed by the agent (with some version of SNMP), and thereby to be able 133 to communicate with the agent about a particular logical entity. When 134 different logical entities are associated with different physical 135 entities within the overall physical entity, it is also useful to be 136 able to use this information to distinguish between logical entities. 138 In these situations, there is no need for varbinds for multiple logical 139 entities to be referenced in the same SNMP message (although that might 140 be useful in the future). Rather, it is sufficient, and in some 141 situations preferable, to have the context/community in the message 142 identify the logical entity to which the varbinds apply. 144 Version 2 of this MIB addresses new requirements that have emerged since 145 the publication of the first Entity MIB (RFC 2037 [RFC2037]). There is 146 a need for a standardized way of providing non-volatile, 147 administratively assigned identifiers for physical components 148 represented with the Entity MIB. There is also a need to align the 149 Entity MIB with the SNMPv3 administrative framework (STD 62, RFC 3411 150 [RFC3411]). Implementation experience has shown that additional 151 physical component attributes are also desirable. 153 Version 3 of this MIB addresses new requirements that have emerged since 154 the publication of the second Entity MIB (RFC 2737 [RFC2737]). There is 155 a need for identifying physical entities which are central processing 156 units (CPUs) and a need to provide a textual convention which identifies 157 an entPhysicalIndex value or zero, where the value zero has application- 158 specific semantics. 160 4.1. Terms 162 Some new terms are used throughout this document: 164 - Naming Scope 165 A "naming scope" represents the set of information that may be 166 potentially accessed through a single SNMP operation. All instances 167 within the naming scope share the same unique identifier space. 168 For SNMPv1, a naming scope is identified by the value of the 169 associated 'entLogicalCommunity' instance. For SNMPv3, the term 170 'context' is used instead of 'naming scope'. The complete 171 definition of an SNMP context can be found in section 3.3.1 of RFC 172 3411 [RFC3411]. 174 - Multi-Scoped Object 175 A MIB object, for which identical instance values identify 176 different managed information in different naming scopes, is called 177 a "multi-scoped" MIB object. 179 - Single-Scoped Object 180 A MIB object, for which identical instance values identify the same 181 managed information in different naming scopes, is called a 182 "single-scoped" MIB object. 184 - Logical Entity 185 A managed system contains one or more logical entities, each 186 represented by at most one instantiation of each of a particular 187 set of MIB objects. A set of management functions is associated 188 with each logical entity. Examples of logical entities include 189 routers, bridges, print-servers, etc. 191 - Physical Entity 192 A "physical entity" or "physical component" represents an 193 identifiable physical resource within a managed system. Zero or 194 more logical entities may utilize a physical resource at any given 195 time. It is an implementation-specific manner as to which physical 196 components are represented by an agent in the EntPhysicalTable. 197 Typically, physical resources (e.g., communications ports, 198 backplanes, sensors, daughter-cards, power supplies, the overall 199 chassis) which can be managed via functions associated with one or 200 more logical entities are included in the MIB. 202 - Containment Tree 203 Each physical component may be modeled as 'contained' within 204 another physical component. A "containment-tree" is the conceptual 205 sequence of entPhysicalIndex values which uniquely specifies the 206 exact physical location of a physical component within the managed 207 system. It is generated by 'following and recording' each 208 'entPhysicalContainedIn' instance 'up the tree towards the root', 209 until a value of zero indicating no further containment is found. 211 4.2. Relationship to Community Strings 213 For community-based SNMP, distinguishing between different logical 214 entities is one (but not the only) purpose of the community string (RFC 215 1157 [RFC1157]). This is accommodated by representing each community 216 string as a logical entity. 218 Note that different logical entities may share the same naming scope 219 (and therefore the same values of entLogicalCommunity). This is 220 possible, providing they have no need for the same instance of a MIB 221 object to represent different managed information. 223 4.3. Relationship to SNMP Contexts 225 Version 2 of the Entity MIB contains support for associating SNMPv3 226 contexts with logical entities. Two new MIB objects, defining an 227 SnmpEngineID and ContextName pair, are used together to identify an SNMP 228 context associated with a logical entity. This context can be used (in 229 conjunction with the entLogicalTAddress and entLogicalTDomain MIB 230 objects) to send SNMPv3 messages on behalf of a particular logical 231 entity. 233 4.4. Relationship to Proxy Mechanisms 235 The Entity MIB is designed to allow functional component discovery. The 236 administrative relationships between different logical entities are not 237 visible in any Entity MIB tables. An NMS cannot determine whether MIB 238 instances in different naming scopes are realized locally or remotely 239 (e.g., via some proxy mechanism) by examining any particular Entity MIB 240 objects. 242 The management of administrative framework functions is not an explicit 243 goal of the Entity MIB WG at this time. This new area of functionality 244 may be revisited after some operational experience with the Entity MIB 245 is gained. 247 Note that for community-based versions of SNMP, a network administrator 248 will likely be able to associate community strings with naming scopes 249 with proprietary mechanisms, as a matter of configuration. There are no 250 mechanisms for managing naming scopes defined in this MIB. 252 4.5. Relationship to a Chassis MIB 254 Some readers may recall that a previous IETF working group attempted to 255 define a Chassis MIB. No consensus was reached by that working group, 256 possibly because its scope was too broad. As such, it is not the 257 purpose of this MIB to be a "Chassis MIB replacement", nor is it within 258 the scope of this MIB to contain all the information which might be 259 necessary to manage a "chassis". On the other hand, the entities 260 represented by an implementation of this MIB might well be contained in 261 a chassis. 263 4.6. Relationship to the Interfaces MIB 265 The Entity MIB contains a mapping table identifying physical components 266 that have 'external values' (e.g., ifIndex) associated with them within 267 a given naming scope. This table can be used to identify the physical 268 location of each interface in the ifTable (RFC 2863 [RFC2863]). Since 269 ifIndex values in different contexts are not related to one another, the 270 interface to physical component associations are relative to the same 271 logical entity within the agent. 273 The Entity MIB also contains 'entPhysicalName' and 'entPhysicalAlias' 274 objects, which approximate the semantics of the 'ifName' and 'ifAlias' 275 objects (respectively) from the Interfaces MIB [RFC2863], for all types 276 of physical components. 278 4.7. Relationship to the Other MIBs 280 The Entity MIB contains a mapping table identifying physical components 281 that have identifiers from other standard MIBs associated with them. 282 For example, this table can be used along with the physical mapping 283 table to identify the physical location of each repeater port in the 284 rptrPortTable, or each interface in the ifTable. 286 4.8. Relationship to Naming Scopes 288 There is some question as to which MIB objects may be returned within a 289 given naming scope. MIB objects which are not multi-scoped within a 290 managed system are likely to ignore context information in 291 implementation. In such a case, it is likely such objects will be 292 returned in all naming scopes (e.g., not just the 'default' naming scope 293 or the SNMPv3 default context). 295 For example, a community string used to access the management 296 information for logical device 'bridge2' may allow access to all the 297 non-bridge related objects in the 'default' naming scope, as well as a 298 second instance of the Bridge MIB (RFC 1493 [RFC1493]). 300 It is an implementation-specific matter as to the isolation of single- 301 scoped MIB objects by the agent. An agent may wish to limit the objects 302 returned in a particular naming scope to just the multi-scoped objects 303 in that naming scope (e.g., system group and the Bridge MIB). In this 304 case, all single-scoped management information would belong to a common 305 naming scope (e.g., 'default'), which itself may contain some multi- 306 scoped objects (e.g., system group). 308 4.9. Multiple Instances of the Entity MIB 310 It is possible that more than one agent exists in a managed system, and 311 in such cases, multiple instances of the Entity MIB (representing the 312 same managed objects) may be available to an NMS. 314 In order to reduce complexity for agent implementation, multiple 315 instances of the Entity MIB are not required to be equivalent or even 316 consistent. An NMS may be able to 'align' instances returned by 317 different agents by examining the columns of each table, but vendor- 318 specific identifiers and (especially) index values are likely to be 319 different. Each agent may be managing different subsets of the entire 320 chassis as well. 322 When all of a physically-modular device is represented by a single 323 agent, the entry for which entPhysicalContainedIn has the value zero 324 would likely have 'chassis' as the value of its entPhysicalClass; 325 alternatively, for an agent on a module where the agent represents only 326 the physical entities on that module (not those on other modules), the 327 entry for which entPhysicalContainedIn has the value zero would likely 328 have 'module' as the value of its entPhysicalClass. 330 An agent implementation of the entLogicalTable is not required to 331 contain information about logical entities managed primarily by other 332 agents. That is, the entLogicalTAddress and entLogicalTDomain objects in 333 the entLogicalTable are provided to support an historical multiplexing 334 mechanism, not to identify other SNMP agents. 336 Note that the Entity MIB is a single-scoped MIB, in the event an agent 337 represents the MIB in different naming scopes. 339 4.10. Re-Configuration of Entities 341 Most of the MIB objects defined in this MIB have at most a read-only 342 MAX-ACCESS clause. This is a conscious decision by the working group to 343 limit this MIB's scope. The second version of the Entity MIB allows a 344 network administrator to configure some common attributes of physical 345 components. 347 4.11. Textual Convention Change 349 Version 1 of the Entity MIB contains three MIB objects defined with the 350 (now obsolete) DisplayString textual convention. In version 2 of the 351 Entity MIB, the syntax for these objects has been updated to use the 352 (now preferred) SnmpAdminString textual convention. 354 The working group realizes that this change is not strictly supported by 355 SMIv2. In our judgment, the alternative of deprecating the old objects 356 and defining new objects would have a more adverse impact on backward 357 compatibility and interoperability, given the particular semantics of 358 these objects. 360 4.12. MIB Structure 362 The Entity MIB contains five groups of MIB objects: 364 - entityPhysical group 365 Describes the physical entities managed by a single agent. 367 - entityLogical group 368 Describes the logical entities managed by a single agent. 370 - entityMapping group 371 Describes the associations between the physical entities, logical 372 entities, interfaces, and non-interface ports managed by a single 373 agent. 375 - entityGeneral group 376 Describes general system attributes shared by potentially all types 377 of entities managed by a single agent. 379 - entityNotifications group 380 Contains status indication notifications. 382 4.12.1. entityPhysical Group 384 This group contains a single table to identify physical system 385 components, called the entPhysicalTable. 387 The entPhysicalTable contains one row per physical entity, and must 388 always contain at least one row for an "overall" physical entity, which 389 should have an entPhysicalClass value of 'stack(11)', 'chassis(3)' or 390 'module(9)'. 392 Each row is indexed by an arbitrary, small integer, and contains a 393 description and type of the physical entity. It also optionally 394 contains the index number of another entPhysicalEntry indicating a 395 containment relationship between the two. 397 Version 2 of the Entity MIB provides additional MIB objects for each 398 physical entity. Some common read-only attributes have been added, as 399 well as three writable string objects. 401 - entPhysicalAlias 402 This string can be used by an NMS as a non-volatile identifier for 403 the physical component. Maintaining a non-volatile string for every 404 physical component represented in the entPhysicalTable can be 405 costly and unnecessary. An agent may algorithmically generate 406 'entPhysicalAlias' strings for particular entries (e.g., based on 407 the entPhysicalClass value). 409 - entPhysicalAssetID 410 This string is provided to store a user-specific asset identifier 411 for removable physical components. In order to reduce the non- 412 volatile storage needed by a particular agent, a network 413 administrator should only assign asset identifiers to physical 414 entities which are field-replaceable (i.e., not permanently 415 contained within another physical entity). 417 - entPhysicalSerialNum 418 This string is provided to store a vendor-specific serial number 419 string for physical components. This is a writable object in case 420 an agent cannot identify the serial numbers of all installed 421 physical entities, and a network administrator wishes to configure 422 the non-volatile serial number strings manually (via an NMS 423 application). 425 4.12.2. entityLogical Group 427 This group contains a single table to identify logical entities, called 428 the entLogicalTable. 430 The entLogicalTable contains one row per logical entity. Each row is 431 indexed by an arbitrary, small integer and contains a name, description, 432 and type of the logical entity. It also contains information to allow 433 access to the MIB information for the logical entity. This includes SNMP 434 versions that use a community name (with some form of implied context 435 representation) and SNMP versions that use the SNMP ARCH [RFC3411] 436 method of context identification. 438 If a agent represents multiple logical entities with this MIB, then this 439 group must be implemented for all logical entities known to the agent. 441 If an agent represents a single logical entity, or multiple logical 442 entities within a single naming scope, then implementation of this group 443 may be omitted by the agent. 445 4.12.3. entityMapping Group 447 This group contains three tables to identify associations between 448 different system components. 450 The entLPMappingTable contains mappings between entLogicalIndex values 451 (logical entities) and entPhysicalIndex values (the physical components 452 supporting that entity). A logical entity can map to more than one 453 physical component, and more than one logical entity can map to (share) 454 the same physical component. If an agent represents a single logical 455 entity, or multiple logical entities within a single naming scope, then 456 implementation of this table may be omitted by the agent. Note that 457 this table is deprecated in version 3 of the Entity MIB. 459 The entAliasMappingTable contains mappings between entLogicalIndex, 460 entPhysicalIndex pairs and 'alias' object identifier values. This 461 allows resources managed with other MIBs (e.g., repeater ports, bridge 462 ports, physical and logical interfaces) to be identified in the physical 463 entity hierarchy. Note that each alias identifier is only relevant in a 464 particular naming scope. If an agent represents a single logical 465 entity, or multiple logical entities within a single naming scope, then 466 implementation of this table may be omitted by the agent. Note that 467 this table is deprecated in version 3 of the Entity MIB. 469 The entPhysicalContainsTable contains simple mappings between 470 'entPhysicalContainedIn' values for each container/'containee' 471 relationship in the managed system. The indexing of this table allows an 472 NMS to quickly discover the 'entPhysicalIndex' values for all children 473 of a given physical entity. 475 4.12.4. entityGeneral Group 477 This group contains general information relating to the other object 478 groups. 480 At this time, the entGeneral group contains a single scalar object 481 (entLastChangeTime), which represents the value of sysUptime when any 482 part of the Entity MIB configuration last changed. 484 4.12.5. entityNotifications Group 486 This group contains notification definitions relating to the overall 487 status of the Entity MIB instantiation. 489 4.13. Multiple Agents 491 Even though a primary motivation for this MIB is to represent the 492 multiple logical entities supported by a single agent, it is also 493 possible to use it to represent multiple logical entities supported by 494 multiple agents (in the same "overall" physical entity). Indeed, it is 495 implicit in the SNMP architecture, that the number of agents is 496 transparent to a network management station. 498 However, there is no agreement at this time as to the degree of 499 cooperation which should be expected for agent implementations. 500 Therefore, multiple agents within the same managed system are free to 501 implement the Entity MIB independently. (Refer the section on "Multiple 502 Instances of the Entity MIB" for more details). 504 4.14. Changes Since RFC 2037 506 4.14.1. Textual Conventions 508 The PhysicalClass TC text has been clarified, and a new enumeration to 509 support 'stackable' components has been added. The SnmpEngineIdOrNone 510 TC has been added to support SNMPv3. 512 4.14.2. New entPhysicalTable Objects 514 The entPhysicalHardwareRev, entPhysicalFirmwareRev, and 515 entPhysicalSoftwareRev objects have been added for revision 516 identification. 518 The entPhysicalSerialNum, entPhysicalMfgName, entPhysicalModelName, and 519 entPhysicalIsFru objects have been added for better vendor 520 identification for physical components. The entPhysicalSerialNum object 521 can be set by a management station in the event the agent cannot 522 identify this information. 524 The entPhysicalAlias and entPhysicalAssetID objects have been added for 525 better user component identification. These objects are intended to be 526 set by a management station and preserved by the agent across restarts. 528 4.14.3. New entLogicalTable Objects 530 The entLogicalContextEngineID and entLogicalContextName objects have 531 been added to provide an SNMP context for SNMPv3 access on behalf of a 532 logical entity. 534 4.14.4. Bugfixes 536 A bug was fixed in the entLogicalCommunity object. The subrange was 537 incorrect (1..255) and is now (0..255). The description clause has also 538 been clarified. This object is now deprecated. 540 The entLastChangeTime object description has been changed to generalize 541 the events which cause an update to the last change timestamp. 543 The syntax was changed from DisplayString to SnmpAdminString for the 544 entPhysicalDescr, entPhysicalName, and entLogicalDescr objects. 546 4.15. Changes Since RFC 2737 548 4.15.1. Textual Conventions 550 The PhysicalIndexOrZero TC has been added to allow objects to reference 551 an entPhysicalIndex value or zero. The PhysicalClass TC has been 552 extended to support a new enumeration for central processing units. 554 4.15.2. Deprecated Objects 556 The entLPMappingTable has been deprecated because no implementations 557 have been found which support this table. The entLPPhysicalIndex has 558 been removed from the entityMappingGroup. This OBJECT-GROUP has been 559 updated (entityMappingGroupRev1) as well as the Entity MIB MODULE- 560 CONFORMANCE statement. 562 The entAliasMappingTable has been deprecated because two independent 563 implementations have not been found which support this table. The 564 entAliasMappingIdentifier object has been removed from the 565 entityMappingGroup. This OBJECT-GROUP has been updated 566 (entityMappingGroupRev1) as well as the Entity MIB MODULE-CONFORMANCE 567 statement. 569 4.15.3. Bugfixes 571 The syntax was changed from INTEGER to Integer32 for the 572 entPhysicalParentRelPos, entLogicalIndex, and entAliasLogicalIndexOrZero 573 objects, and from INTEGER to PhysicalIndexOrZero for the 574 entPhysicalContainedIn object. 576 5. Definitions 578 ENTITY-MIB DEFINITIONS ::= BEGIN 580 IMPORTS 581 MODULE-IDENTITY, OBJECT-TYPE, mib-2, NOTIFICATION-TYPE, 582 Integer32 583 FROM SNMPv2-SMI 584 TDomain, TAddress, TEXTUAL-CONVENTION, 585 AutonomousType, RowPointer, TimeStamp, TruthValue 586 FROM SNMPv2-TC 587 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP 588 FROM SNMPv2-CONF 589 SnmpAdminString 590 FROM SNMP-FRAMEWORK-MIB; 592 entityMIB MODULE-IDENTITY 593 LAST-UPDATED "200401210000Z" 594 ORGANIZATION "IETF ENTMIB Working Group" 595 CONTACT-INFO 596 " WG E-mail: entmib@ietf.org 597 Mailing list subscription info: 598 http://www.ietf.org/mailman/listinfo/entmib 600 Andy Bierman 601 Cisco Systems Inc. 602 170 West Tasman Drive 603 San Jose, CA 95134 604 +1 408-527-3711 605 abierman@cisco.com 607 Keith McCloghrie 608 Cisco Systems Inc. 609 170 West Tasman Drive 610 San Jose, CA 95134 611 +1 408-526-5260 612 kzm@cisco.com" 614 DESCRIPTION 615 "The MIB module for representing multiple logical 616 entities supported by a single SNMP agent. 618 Copyright (C) The Internet Society (2003). This 619 version of this MIB module is part of RFC xxxx; see 620 the RFC itself for full legal notices." 622 REVISION "200401210000Z" 623 DESCRIPTION 624 "Initial Version of Entity MIB (Version 3). 625 This revision obsoletes RFC 2737. 626 Additions: 627 - cpu(12) enumeration added to PhysicalClass TC 628 - PhysicalIndexOrZero TC 629 Changes: 630 - entLPMappingTable deprecated 631 - entAliasMappingTable deprecated 632 - entPhysicalContainedIn SYNTAX changed from 633 INTEGER to PhysicalIndexOrZero 635 This version published as RFC xxxx (to be 636 assigned by the RFC Editor)." 637 REVISION "199912070000Z" 638 DESCRIPTION 639 "Initial Version of Entity MIB (Version 2). 640 This revision obsoletes RFC 2037. 641 This version published as RFC 2737." 643 REVISION "199610310000Z" 644 DESCRIPTION 645 "Initial version (version 1), published as 646 RFC 2037." 647 ::= { mib-2 47 } 649 entityMIBObjects OBJECT IDENTIFIER ::= { entityMIB 1 } 651 -- MIB contains four groups 652 entityPhysical OBJECT IDENTIFIER ::= { entityMIBObjects 1 } 653 entityLogical OBJECT IDENTIFIER ::= { entityMIBObjects 2 } 654 entityMapping OBJECT IDENTIFIER ::= { entityMIBObjects 3 } 655 entityGeneral OBJECT IDENTIFIER ::= { entityMIBObjects 4 } 657 -- Textual Conventions 658 PhysicalIndex ::= TEXTUAL-CONVENTION 659 STATUS current 660 DESCRIPTION 661 "An arbitrary value which uniquely identifies the physical 662 entity. The value should be a small positive integer; index 663 values for different physical entities are not necessarily 664 contiguous." 665 SYNTAX Integer32 (1..2147483647) 667 PhysicalIndexOrZero ::= TEXTUAL-CONVENTION 668 STATUS current 669 DESCRIPTION 670 "This textual convention is an extension of the 671 PhysicalIndex convention which defines a greater than zero 672 value used to identify a physical entity. This extension 673 permits the additional value of zero. The semantics of the 674 value zero are object-specific and must therefore be defined 675 as part of the description of any object which uses this 676 syntax. Examples of the usage of this extension are 677 situations where none or all physical entities need to be 678 referenced." 679 SYNTAX Integer32 (0..2147483647) 681 PhysicalClass ::= TEXTUAL-CONVENTION 682 STATUS current 683 DESCRIPTION 684 "An enumerated value which provides an indication of the 685 general hardware type of a particular physical entity. 686 There are no restrictions as to the number of 687 entPhysicalEntries of each entPhysicalClass, which must be 688 instantiated by an agent. 690 The enumeration 'other' is applicable if the physical entity 691 class is known, but does not match any of the supported 692 values. 694 The enumeration 'unknown' is applicable if the physical 695 entity class is unknown to the agent. 697 The enumeration 'chassis' is applicable if the physical 698 entity class is an overall container for networking 699 equipment. Any class of physical entity except a stack may 700 be contained within a chassis, and a chassis may only be 701 contained within a stack. 703 The enumeration 'backplane' is applicable if the physical 704 entity class is some sort of device for aggregating and 705 forwarding networking traffic, such as a shared backplane in 706 a modular ethernet switch. Note that an agent may model a 707 backplane as a single physical entity, which is actually 708 implemented as multiple discrete physical components (within 709 a chassis or stack). 711 The enumeration 'container' is applicable if the physical 712 entity class is capable of containing one or more removable 713 physical entities, possibly of different types. For example, 714 each (empty or full) slot in a chassis will be modeled as a 715 container. Note that all removable physical entities should 716 be modeled within a container entity, such as field- 717 replaceable modules, fans, or power supplies. Note that all 718 known containers should be modeled by the agent, including 719 empty containers. 721 The enumeration 'powerSupply' is applicable if the physical 722 entity class is a power-supplying component. 724 The enumeration 'fan' is applicable if the physical entity 725 class is a fan or other heat-reduction component. 727 The enumeration 'sensor' is applicable if the physical 728 entity class is some sort of sensor, such as a temperature 729 sensor within a router chassis. 731 The enumeration 'module' is applicable if the physical 732 entity class is some sort of self-contained sub-system. If 733 it is removable, then it should be modeled within a 734 container entity, otherwise it should be modeled directly 735 within another physical entity (e.g., a chassis or another 736 module). 738 The enumeration 'port' is applicable if the physical entity 739 class is some sort of networking port, capable of receiving 740 and/or transmitting networking traffic. 742 The enumeration 'stack' is applicable if the physical entity 743 class is some sort of super-container (possibly virtual), 744 intended to group together multiple chassis entities. A 745 stack may be realized by a 'virtual' cable, a real 746 interconnect cable, attached to multiple chassis, or may in 747 fact be comprised of multiple interconnect cables. A stack 748 should not be modeled within any other physical entities, 749 but a stack may be contained within another stack. Only 750 chassis entities should be contained within a stack. 752 The enumeration 'cpu' is applicable if the physical entity 753 class is some sort of central processing unit." 754 SYNTAX INTEGER { 755 other(1), 756 unknown(2), 757 chassis(3), 758 backplane(4), 759 container(5), -- e.g., chassis slot or daughter-card holder 760 powerSupply(6), 761 fan(7), 762 sensor(8), 763 module(9), -- e.g., plug-in card or daughter-card 764 port(10), 765 stack(11), -- e.g., stack of multiple chassis entities 766 cpu(12) 767 } 769 SnmpEngineIdOrNone ::= TEXTUAL-CONVENTION 770 STATUS current 771 DESCRIPTION 772 "A specially formatted SnmpEngineID string for use with the 773 Entity MIB. 775 If an instance of an object of SYNTAX SnmpEngineIdOrNone has 776 a non-zero length, then the object encoding and semantics 777 are defined by the SnmpEngineID textual convention (see STD 778 62, RFC 3411 [RFC3411]). 780 If an instance of an object of SYNTAX SnmpEngineIdOrNone 781 contains a zero-length string, then no appropriate 782 SnmpEngineID is associated with the logical entity (i.e., 783 SNMPv3 not supported)." 784 SYNTAX OCTET STRING (SIZE(0..32)) -- empty string or SnmpEngineID 786 -- The Physical Entity Table 787 entPhysicalTable OBJECT-TYPE 788 SYNTAX SEQUENCE OF EntPhysicalEntry 789 MAX-ACCESS not-accessible 790 STATUS current 791 DESCRIPTION 792 "This table contains one row per physical entity. There is 793 always at least one row for an 'overall' physical entity." 794 ::= { entityPhysical 1 } 796 entPhysicalEntry OBJECT-TYPE 797 SYNTAX EntPhysicalEntry 798 MAX-ACCESS not-accessible 799 STATUS current 800 DESCRIPTION 801 "Information about a particular physical entity. 803 Each entry provides objects (entPhysicalDescr, 804 entPhysicalVendorType, and entPhysicalClass) to help an NMS 805 identify and characterize the entry, and objects 806 (entPhysicalContainedIn and entPhysicalParentRelPos) to help 807 an NMS relate the particular entry to other entries in this 808 table." 809 INDEX { entPhysicalIndex } 810 ::= { entPhysicalTable 1 } 812 EntPhysicalEntry ::= SEQUENCE { 813 entPhysicalIndex PhysicalIndex, 814 entPhysicalDescr SnmpAdminString, 815 entPhysicalVendorType AutonomousType, 816 entPhysicalContainedIn PhysicalIndexOrZero, 817 entPhysicalClass PhysicalClass, 818 entPhysicalParentRelPos Integer32, 819 entPhysicalName SnmpAdminString, 820 entPhysicalHardwareRev SnmpAdminString, 821 entPhysicalFirmwareRev SnmpAdminString, 822 entPhysicalSoftwareRev SnmpAdminString, 823 entPhysicalSerialNum SnmpAdminString, 824 entPhysicalMfgName SnmpAdminString, 825 entPhysicalModelName SnmpAdminString, 826 entPhysicalAlias SnmpAdminString, 827 entPhysicalAssetID SnmpAdminString, 828 entPhysicalIsFRU TruthValue 829 } 831 entPhysicalIndex OBJECT-TYPE 832 SYNTAX PhysicalIndex 833 MAX-ACCESS not-accessible 834 STATUS current 835 DESCRIPTION 836 "The index for this entry." 837 ::= { entPhysicalEntry 1 } 839 entPhysicalDescr OBJECT-TYPE 840 SYNTAX SnmpAdminString 841 MAX-ACCESS read-only 842 STATUS current 843 DESCRIPTION 844 "A textual description of physical entity. This object 845 should contain a string which identifies the manufacturer's 846 name for the physical entity, and should be set to a 847 distinct value for each version or model of the physical 848 entity. " 849 ::= { entPhysicalEntry 2 } 851 entPhysicalVendorType OBJECT-TYPE 852 SYNTAX AutonomousType 853 MAX-ACCESS read-only 854 STATUS current 855 DESCRIPTION 856 "An indication of the vendor-specific hardware type of the 857 physical entity. Note that this is different from the 858 definition of MIB-II's sysObjectID. 860 An agent should set this object to a enterprise-specific 861 registration identifier value indicating the specific 862 equipment type in detail. The associated instance of 863 entPhysicalClass is used to indicate the general type of 864 hardware device. 866 If no vendor-specific registration identifier exists for 867 this physical entity, or the value is unknown by this agent, 868 then the value { 0 0 } is returned." 869 ::= { entPhysicalEntry 3 } 871 entPhysicalContainedIn OBJECT-TYPE 872 SYNTAX PhysicalIndexOrZero 873 MAX-ACCESS read-only 874 STATUS current 875 DESCRIPTION 876 "The value of entPhysicalIndex for the physical entity which 877 'contains' this physical entity. A value of zero indicates 878 this physical entity is not contained in any other physical 879 entity. Note that the set of 'containment' relationships 880 define a strict hierarchy; that is, recursion is not 881 allowed. 883 In the event a physical entity is contained by more than one 884 physical entity (e.g., double-wide modules), this object 885 should identify the containing entity with the lowest value 886 of entPhysicalIndex." 887 ::= { entPhysicalEntry 4 } 889 entPhysicalClass OBJECT-TYPE 890 SYNTAX PhysicalClass 891 MAX-ACCESS read-only 892 STATUS current 893 DESCRIPTION 894 "An indication of the general hardware type of the physical 895 entity. 897 An agent should set this object to the standard enumeration 898 value which most accurately indicates the general class of 899 the physical entity, or the primary class if there is more 900 than one. 902 If no appropriate standard registration identifier exists 903 for this physical entity, then the value 'other(1)' is 904 returned. If the value is unknown by this agent, then the 905 value 'unknown(2)' is returned." 906 ::= { entPhysicalEntry 5 } 908 entPhysicalParentRelPos OBJECT-TYPE 909 SYNTAX Integer32 (-1..2147483647) 910 MAX-ACCESS read-only 911 STATUS current 912 DESCRIPTION 913 "An indication of the relative position of this 'child' 914 component among all its 'sibling' components. Sibling 915 components are defined as entPhysicalEntries which share the 916 same instance values of each of the entPhysicalContainedIn 917 and entPhysicalClass objects. 919 An NMS can use this object to identify the relative ordering 920 for all sibling components of a particular parent 921 (identified by the entPhysicalContainedIn instance in each 922 sibling entry). 924 This value should match any external labeling of the 925 physical component if possible. For example, for a container 926 (e.g., card slot) labeled as 'slot #3', 927 entPhysicalParentRelPos should have the value '3'. Note 928 that the entPhysicalEntry for the module plugged in slot 3 929 should have an entPhysicalParentRelPos value of '1'. 931 If the physical position of this component does not match 932 any external numbering or clearly visible ordering, then 933 user documentation or other external reference material 934 should be used to determine the parent-relative position. If 935 this is not possible, then the the agent should assign a 936 consistent (but possibly arbitrary) ordering to a given set 937 of 'sibling' components, perhaps based on internal 938 representation of the components. 940 If the agent cannot determine the parent-relative position 941 for some reason, or if the associated value of 942 entPhysicalContainedIn is '0', then the value '-1' is 943 returned. Otherwise a non-negative integer is returned, 944 indicating the parent-relative position of this physical 945 entity. 947 Parent-relative ordering normally starts from '1' and 948 continues to 'N', where 'N' represents the highest 949 positioned child entity. However, if the physical entities 950 (e.g., slots) are labeled from a starting position of zero, 951 then the first sibling should be associated with a 952 entPhysicalParentRelPos value of '0'. Note that this 953 ordering may be sparse or dense, depending on agent 954 implementation. 956 The actual values returned are not globally meaningful, as 957 each 'parent' component may use different numbering 958 algorithms. The ordering is only meaningful among siblings 959 of the same parent component. 961 The agent should retain parent-relative position values 962 across reboots, either through algorithmic assignment or use 963 of non-volatile storage." 964 ::= { entPhysicalEntry 6 } 966 entPhysicalName OBJECT-TYPE 967 SYNTAX SnmpAdminString 968 MAX-ACCESS read-only 969 STATUS current 970 DESCRIPTION 971 "The textual name of the physical entity. The value of this 972 object should be the name of the component as assigned by 973 the local device and should be suitable for use in commands 974 entered at the device's `console'. This might be a text 975 name, such as `console' or a simple component number (e.g., 976 port or module number), such as `1', depending on the 977 physical component naming syntax of the device. 979 If there is no local name, or this object is otherwise not 980 applicable, then this object contains a zero-length string. 982 Note that the value of entPhysicalName for two physical 983 entities will be the same in the event that the console 984 interface does not distinguish between them, e.g., slot-1 985 and the card in slot-1." 986 ::= { entPhysicalEntry 7 } 988 entPhysicalHardwareRev OBJECT-TYPE 989 SYNTAX SnmpAdminString 990 MAX-ACCESS read-only 991 STATUS current 992 DESCRIPTION 993 "The vendor-specific hardware revision string for the 994 physical entity. The preferred value is the hardware 995 revision identifier actually printed on the component itself 996 (if present). 998 Note that if revision information is stored internally in a 999 non-printable (e.g., binary) format, then the agent must 1000 convert such information to a printable format, in an 1001 implementation-specific manner. 1003 If no specific hardware revision string is associated with 1004 the physical component, or this information is unknown to 1005 the agent, then this object will contain a zero-length 1006 string." 1007 ::= { entPhysicalEntry 8 } 1009 entPhysicalFirmwareRev OBJECT-TYPE 1010 SYNTAX SnmpAdminString 1011 MAX-ACCESS read-only 1012 STATUS current 1013 DESCRIPTION 1014 "The vendor-specific firmware revision string for the 1015 physical entity. 1017 Note that if revision information is stored internally in a 1018 non-printable (e.g., binary) format, then the agent must 1019 convert such information to a printable format, in an 1020 implementation-specific manner. 1022 If no specific firmware programs are associated with the 1023 physical component, or this information is unknown to the 1024 agent, then this object will contain a zero-length string." 1025 ::= { entPhysicalEntry 9 } 1027 entPhysicalSoftwareRev OBJECT-TYPE 1028 SYNTAX SnmpAdminString 1029 MAX-ACCESS read-only 1030 STATUS current 1031 DESCRIPTION 1032 "The vendor-specific software revision string for the 1033 physical entity. 1035 Note that if revision information is stored internally in a 1036 non-printable (e.g., binary) format, then the agent must 1037 convert such information to a printable format, in an 1038 implementation-specific manner. 1040 If no specific software programs are associated with the 1041 physical component, or this information is unknown to the 1042 agent, then this object will contain a zero-length string." 1043 ::= { entPhysicalEntry 10 } 1045 entPhysicalSerialNum OBJECT-TYPE 1046 SYNTAX SnmpAdminString (SIZE (0..32)) 1047 MAX-ACCESS read-write 1048 STATUS current 1049 DESCRIPTION 1050 "The vendor-specific serial number string for the physical 1051 entity. The preferred value is the serial number string 1052 actually printed on the component itself (if present). 1054 On the first instantiation of an physical entity, the value 1055 of entPhysicalSerialNum associated with that entity is set 1056 to the correct vendor-assigned serial number, if this 1057 information is available to the agent. If a serial number 1058 is unknown or non-existent, the entPhysicalSerialNum will be 1059 set to a zero-length string instead. 1061 Note that implementations which can correctly identify the 1062 serial numbers of all installed physical entities do not 1063 need to provide write access to the entPhysicalSerialNum 1064 object. Agents which cannot provide non-volatile storage for 1065 the entPhysicalSerialNum strings are not required to 1066 implement write access for this object. 1068 Not every physical component will have a serial number, or 1069 even need one. Physical entities for which the associated 1070 value of the entPhysicalIsFRU object is equal to 'false(2)' 1071 (e.g., the repeater ports within a repeater module), do not 1072 need their own unique serial number. An agent does not have 1073 to provide write access for such entities, and may return a 1074 zero-length string. 1076 If write access is implemented for an instance of 1077 entPhysicalSerialNum, and a value is written into the 1078 instance, the agent must retain the supplied value in the 1079 entPhysicalSerialNum instance associated with the same 1080 physical entity for as long as that entity remains 1081 instantiated. This includes instantiations across all re- 1082 initializations/reboots of the network management system, 1083 including those which result in a change of the physical 1084 entity's entPhysicalIndex value." 1085 ::= { entPhysicalEntry 11 } 1087 entPhysicalMfgName OBJECT-TYPE 1088 SYNTAX SnmpAdminString 1089 MAX-ACCESS read-only 1090 STATUS current 1091 DESCRIPTION 1092 "The name of the manufacturer of this physical component. 1093 The preferred value is the manufacturer name string actually 1094 printed on the component itself (if present). 1096 Note that comparisons between instances of the 1097 entPhysicalModelName, entPhysicalFirmwareRev, 1098 entPhysicalSoftwareRev, and the entPhysicalSerialNum 1099 objects, are only meaningful amongst entPhysicalEntries with 1100 the same value of entPhysicalMfgName. 1102 If the manufacturer name string associated with the physical 1103 component is unknown to the agent, then this object will 1104 contain a zero-length string." 1105 ::= { entPhysicalEntry 12 } 1107 entPhysicalModelName OBJECT-TYPE 1108 SYNTAX SnmpAdminString 1109 MAX-ACCESS read-only 1110 STATUS current 1111 DESCRIPTION 1112 "The vendor-specific model name identifier string associated 1113 with this physical component. The preferred value is the 1114 customer-visible part number, which may be printed on the 1115 component itself. 1117 If the model name string associated with the physical 1118 component is unknown to the agent, then this object will 1119 contain a zero-length string." 1120 ::= { entPhysicalEntry 13 } 1122 entPhysicalAlias OBJECT-TYPE 1123 SYNTAX SnmpAdminString (SIZE (0..32)) 1124 MAX-ACCESS read-write 1125 STATUS current 1126 DESCRIPTION 1127 "This object is an 'alias' name for the physical entity as 1128 specified by a network manager, and provides a non-volatile 1129 'handle' for the physical entity. 1131 On the first instantiation of an physical entity, the value 1132 of entPhysicalAlias associated with that entity is set to 1133 the zero-length string. However, agent may set the value to 1134 a locally unique default value, instead of a zero-length 1135 string. 1137 If write access is implemented for an instance of 1138 entPhysicalAlias, and a value is written into the instance, 1139 the agent must retain the supplied value in the 1140 entPhysicalAlias instance associated with the same physical 1141 entity for as long as that entity remains instantiated. 1142 This includes instantiations across all re- 1143 initializations/reboots of the network management system, 1144 including those which result in a change of the physical 1145 entity's entPhysicalIndex value." 1146 ::= { entPhysicalEntry 14 } 1148 entPhysicalAssetID OBJECT-TYPE 1149 SYNTAX SnmpAdminString (SIZE (0..32)) 1150 MAX-ACCESS read-write 1151 STATUS current 1152 DESCRIPTION 1153 "This object is a user-assigned asset tracking identifier 1154 for the physical entity as specified by a network manager, 1155 and provides non-volatile storage of this information. 1157 On the first instantiation of an physical entity, the value 1158 of entPhysicalAssetID associated with that entity is set to 1159 the zero-length string. 1161 Not every physical component will have a asset tracking 1162 identifier, or even need one. Physical entities for which 1163 the associated value of the entPhysicalIsFRU object is equal 1164 to 'false(2)' (e.g., the repeater ports within a repeater 1165 module), do not need their own unique asset tracking 1166 identifier. An agent does not have to provide write access 1167 for such entities, and may instead return a zero-length 1168 string. 1170 If write access is implemented for an instance of 1171 entPhysicalAssetID, and a value is written into the 1172 instance, the agent must retain the supplied value in the 1173 entPhysicalAssetID instance associated with the same 1174 physical entity for as long as that entity remains 1175 instantiated. This includes instantiations across all re- 1176 initializations/reboots of the network management system, 1177 including those which result in a change of the physical 1178 entity's entPhysicalIndex value. 1180 If no asset tracking information is associated with the 1181 physical component, then this object will contain a zero- 1182 length string." 1183 ::= { entPhysicalEntry 15 } 1185 entPhysicalIsFRU OBJECT-TYPE 1186 SYNTAX TruthValue 1187 MAX-ACCESS read-only 1188 STATUS current 1189 DESCRIPTION 1190 "This object indicates whether or not this physical entity 1191 is considered a 'field replaceable unit' by the vendor. If 1192 this object contains the value 'true(1)' then this 1193 entPhysicalEntry identifies a field replaceable unit. For 1194 all entPhysicalEntries which represent components that are 1195 permanently contained within a field replaceable unit, the 1196 value 'false(2)' should be returned for this object." 1197 ::= { entPhysicalEntry 16 } 1199 -- The Logical Entity Table 1200 entLogicalTable OBJECT-TYPE 1201 SYNTAX SEQUENCE OF EntLogicalEntry 1202 MAX-ACCESS not-accessible 1203 STATUS current 1204 DESCRIPTION 1205 "This table contains one row per logical entity. For agents 1206 which implement more than one naming scope, at least one 1207 entry must exist. Agents which instantiate all MIB objects 1208 within a single naming scope are not required to implement 1209 this table." 1210 ::= { entityLogical 1 } 1212 entLogicalEntry OBJECT-TYPE 1213 SYNTAX EntLogicalEntry 1214 MAX-ACCESS not-accessible 1215 STATUS current 1216 DESCRIPTION 1217 "Information about a particular logical entity. Entities 1218 may be managed by this agent or other SNMP agents (possibly) 1219 in the same chassis." 1220 INDEX { entLogicalIndex } 1221 ::= { entLogicalTable 1 } 1223 EntLogicalEntry ::= SEQUENCE { 1224 entLogicalIndex Integer32, 1225 entLogicalDescr SnmpAdminString, 1226 entLogicalType AutonomousType, 1227 entLogicalCommunity OCTET STRING, 1228 entLogicalTAddress TAddress, 1229 entLogicalTDomain TDomain, 1230 entLogicalContextEngineID SnmpEngineIdOrNone, 1231 entLogicalContextName SnmpAdminString 1232 } 1234 entLogicalIndex OBJECT-TYPE 1235 SYNTAX Integer32 (1..2147483647) 1236 MAX-ACCESS not-accessible 1237 STATUS current 1238 DESCRIPTION 1239 "The value of this object uniquely identifies the logical 1240 entity. The value should be a small positive integer; index 1241 values for different logical entities are are not 1242 necessarily contiguous." 1243 ::= { entLogicalEntry 1 } 1245 entLogicalDescr OBJECT-TYPE 1246 SYNTAX SnmpAdminString 1247 MAX-ACCESS read-only 1248 STATUS current 1249 DESCRIPTION 1250 "A textual description of the logical entity. This object 1251 should contain a string which identifies the manufacturer's 1252 name for the logical entity, and should be set to a distinct 1253 value for each version of the logical entity. " 1254 ::= { entLogicalEntry 2 } 1256 entLogicalType OBJECT-TYPE 1257 SYNTAX AutonomousType 1258 MAX-ACCESS read-only 1259 STATUS current 1260 DESCRIPTION 1261 "An indication of the type of logical entity. This will 1262 typically be the OBJECT IDENTIFIER name of the node in the 1263 SMI's naming hierarchy which represents the major MIB 1264 module, or the majority of the MIB modules, supported by the 1265 logical entity. For example: 1266 a logical entity of a regular host/router -> mib-2 1267 a logical entity of a 802.1d bridge -> dot1dBridge 1268 a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt 1269 If an appropriate node in the SMI's naming hierarchy cannot 1270 be identified, the value 'mib-2' should be used." 1271 ::= { entLogicalEntry 3 } 1273 entLogicalCommunity OBJECT-TYPE 1274 SYNTAX OCTET STRING (SIZE (0..255)) 1275 MAX-ACCESS read-only 1276 STATUS deprecated 1277 DESCRIPTION 1278 "An SNMPv1 or SNMPv2C community-string which can be used to 1279 access detailed management information for this logical 1280 entity. The agent should allow read access with this 1281 community string (to an appropriate subset of all managed 1282 objects) and may also return a community string based on the 1283 privileges of the request used to read this object. Note 1284 that an agent may return a community string with read-only 1285 privileges, even if this object is accessed with a read- 1286 write community string. However, the agent must take care 1287 not to return a community string which allows more 1288 privileges than the community string used to access this 1289 object. 1291 A compliant SNMP agent may wish to conserve naming scopes by 1292 representing multiple logical entities in a single 'default' 1293 naming scope. This is possible when the logical entities 1294 represented by the same value of entLogicalCommunity have no 1295 object instances in common. For example, 'bridge1' and 1296 'repeater1' may be part of the main naming scope, but at 1297 least one additional community string is needed to represent 1298 'bridge2' and 'repeater2'. 1300 Logical entities 'bridge1' and 'repeater1' would be 1301 represented by sysOREntries associated with the 'default' 1302 naming scope. 1304 For agents not accessible via SNMPv1 or SNMPv2C, the value 1305 of this object is the empty string. This object may also 1306 contain an empty string if a community string has not yet 1307 been assigned by the agent, or no community string with 1308 suitable access rights can be returned for a particular SNMP 1309 request. 1311 Note that this object is deprecated. Agents which implement 1312 SNMPv3 access should use the entLogicalContextEngineID and 1313 entLogicalContextName objects to identify the context 1314 associated with each logical entity. SNMPv3 agents may 1315 return a zero-length string for this object, or may continue 1316 to return a community string (e.g., tri-lingual agent 1317 support)." 1318 ::= { entLogicalEntry 4 } 1320 entLogicalTAddress OBJECT-TYPE 1321 SYNTAX TAddress 1322 MAX-ACCESS read-only 1323 STATUS current 1324 DESCRIPTION 1325 "The transport service address by which the logical entity 1326 receives network management traffic, formatted according to 1327 the corresponding value of entLogicalTDomain. 1329 For snmpUDPDomain, a TAddress is 6 octets long, the initial 1330 4 octets containing the IP-address in network-byte order and 1331 the last 2 containing the UDP port in network-byte order. 1332 Consult 'Transport Mappings for the Simple Network 1333 Management Protocol' (STD 62, RFC 3417 [RFC3417]) for 1334 further information on snmpUDPDomain." 1335 ::= { entLogicalEntry 5 } 1337 entLogicalTDomain OBJECT-TYPE 1338 SYNTAX TDomain 1339 MAX-ACCESS read-only 1340 STATUS current 1341 DESCRIPTION 1342 "Indicates the kind of transport service by which the 1343 logical entity receives network management traffic. 1344 Possible values for this object are presently found in the 1345 Transport Mappings for Simple Network Management Protocol' 1346 (STD 62, RFC 3417 [RFC3417])." 1347 ::= { entLogicalEntry 6 } 1349 entLogicalContextEngineID OBJECT-TYPE 1350 SYNTAX SnmpEngineIdOrNone 1351 MAX-ACCESS read-only 1352 STATUS current 1353 DESCRIPTION 1354 "The authoritative contextEngineID that can be used to send 1355 an SNMP message concerning information held by this logical 1356 entity, to the address specified by the associated 1357 'entLogicalTAddress/entLogicalTDomain' pair. 1359 This object, together with the associated 1360 entLogicalContextName object, defines the context associated 1361 with a particular logical entity, and allows access to SNMP 1362 engines identified by a contextEngineId and contextName 1363 pair. 1365 If no value has been configured by the agent, a zero-length 1366 string is returned, or the agent may choose not to 1367 instantiate this object at all." 1368 ::= { entLogicalEntry 7 } 1370 entLogicalContextName OBJECT-TYPE 1371 SYNTAX SnmpAdminString 1372 MAX-ACCESS read-only 1373 STATUS current 1374 DESCRIPTION 1375 "The contextName that can be used to send an SNMP message 1376 concerning information held by this logical entity, to the 1377 address specified by the associated 1378 'entLogicalTAddress/entLogicalTDomain' pair. 1380 This object, together with the associated 1381 entLogicalContextEngineID object, defines the context 1382 associated with a particular logical entity, and allows 1383 access to SNMP engines identified by a contextEngineId and 1384 contextName pair. 1386 If no value has been configured by the agent, a zero-length 1387 string is returned, or the agent may choose not to 1388 instantiate this object at all." 1389 ::= { entLogicalEntry 8 } 1391 entLPMappingTable OBJECT-TYPE 1392 SYNTAX SEQUENCE OF EntLPMappingEntry 1393 MAX-ACCESS not-accessible 1394 STATUS deprecated 1395 DESCRIPTION 1396 "This table contains zero or more rows of logical entity to 1397 physical equipment associations. For each logical entity 1398 known by this agent, there are zero or more mappings to the 1399 physical resources which are used to realize that logical 1400 entity. 1402 An agent should limit the number and nature of entries in 1403 this table such that only meaningful and non-redundant 1404 information is returned. For example, in a system which 1405 contains a single power supply, mappings between logical 1406 entities and the power supply are not useful and should not 1407 be included. 1409 Also, only the most appropriate physical component which is 1410 closest to the root of a particular containment tree should 1411 be identified in an entLPMapping entry. 1413 For example, suppose a bridge is realized on a particular 1414 module, and all ports on that module are ports on this 1415 bridge. A mapping between the bridge and the module would be 1416 useful, but additional mappings between the bridge and each 1417 of the ports on that module would be redundant (since the 1418 entPhysicalContainedIn hierarchy can provide the same 1419 information). If, on the other hand, more than one bridge 1420 was utilizing ports on this module, then mappings between 1421 each bridge and the ports it used would be appropriate. 1423 Also, in the case of a single backplane repeater, a mapping 1424 for the backplane to the single repeater entity is not 1425 necessary." 1426 ::= { entityMapping 1 } 1428 entLPMappingEntry OBJECT-TYPE 1429 SYNTAX EntLPMappingEntry 1430 MAX-ACCESS not-accessible 1431 STATUS deprecated 1432 DESCRIPTION 1433 "Information about a particular logical entity to physical 1434 equipment association. Note that the nature of the 1435 association is not specifically identified in this entry. 1436 It is expected that sufficient information exists in the 1437 MIBs used to manage a particular logical entity to infer how 1438 physical component information is utilized." 1439 INDEX { entLogicalIndex, entLPPhysicalIndex } 1440 ::= { entLPMappingTable 1 } 1442 EntLPMappingEntry ::= SEQUENCE { 1443 entLPPhysicalIndex PhysicalIndex 1444 } 1446 entLPPhysicalIndex OBJECT-TYPE 1447 SYNTAX PhysicalIndex 1448 MAX-ACCESS read-only 1449 STATUS deprecated 1450 DESCRIPTION 1451 "The value of this object identifies the index value of a 1452 particular entPhysicalEntry associated with the indicated 1453 entLogicalEntity." 1454 ::= { entLPMappingEntry 1 } 1456 -- logical entity/component to alias table 1457 entAliasMappingTable OBJECT-TYPE 1458 SYNTAX SEQUENCE OF EntAliasMappingEntry 1459 MAX-ACCESS not-accessible 1460 STATUS deprecated 1461 DESCRIPTION 1462 "This table contains zero or more rows, representing 1463 mappings of logical entity and physical component to 1464 external MIB identifiers. Each physical port in the system 1465 may be associated with a mapping to an external identifier, 1466 which itself is associated with a particular logical 1467 entity's naming scope. A 'wildcard' mechanism is provided 1468 to indicate that an identifier is associated with more than 1469 one logical entity." 1470 ::= { entityMapping 2 } 1472 entAliasMappingEntry OBJECT-TYPE 1473 SYNTAX EntAliasMappingEntry 1474 MAX-ACCESS not-accessible 1475 STATUS deprecated 1476 DESCRIPTION 1477 "Information about a particular physical equipment, logical 1478 entity to external identifier binding. Each logical 1479 entity/physical component pair may be associated with one 1480 alias mapping. The logical entity index may also be used as 1481 a 'wildcard' (refer to the entAliasLogicalIndexOrZero object 1482 DESCRIPTION clause for details.) 1484 Note that only entPhysicalIndex values which represent 1485 physical ports (i.e. associated entPhysicalClass value is 1486 'port(10)') are permitted to exist in this table." 1487 INDEX { entPhysicalIndex, entAliasLogicalIndexOrZero } 1488 ::= { entAliasMappingTable 1 } 1490 EntAliasMappingEntry ::= SEQUENCE { 1491 entAliasLogicalIndexOrZero Integer32, 1492 entAliasMappingIdentifier RowPointer 1493 } 1495 entAliasLogicalIndexOrZero OBJECT-TYPE 1496 SYNTAX Integer32 (0..2147483647) 1497 MAX-ACCESS not-accessible 1498 STATUS deprecated 1499 DESCRIPTION 1500 "The value of this object identifies the logical entity 1501 which defines the naming scope for the associated instance 1502 of the 'entAliasMappingIdentifier' object. 1504 If this object has a non-zero value, then it identifies the 1505 logical entity named by the same value of entLogicalIndex. 1507 If this object has a value of zero, then the mapping between 1508 the physical component and the alias identifier for this 1509 entAliasMapping entry is associated with all unspecified 1510 logical entities. That is, a value of zero (the default 1511 mapping) identifies any logical entity which does not have 1512 an explicit entry in this table for a particular 1513 entPhysicalIndex/entAliasMappingIdentifier pair. 1515 For example, to indicate that a particular interface (e.g., 1516 physical component 33) is identified by the same value of 1517 ifIndex for all logical entities, the following instance 1518 might exist: 1520 entAliasMappingIdentifier.33.0 = ifIndex.5 1522 In the event an entPhysicalEntry is associated differently 1523 for some logical entities, additional entAliasMapping 1524 entries may exist, e.g.: 1526 entAliasMappingIdentifier.33.0 = ifIndex.6 1527 entAliasMappingIdentifier.33.4 = ifIndex.1 1528 entAliasMappingIdentifier.33.5 = ifIndex.1 1529 entAliasMappingIdentifier.33.10 = ifIndex.12 1531 Note that entries with non-zero entAliasLogicalIndexOrZero 1532 index values have precedence over any zero-indexed entry. In 1533 this example, all logical entities except 4, 5, and 10, 1534 associate physical entity 33 with ifIndex.6." 1535 ::= { entAliasMappingEntry 1 } 1537 entAliasMappingIdentifier OBJECT-TYPE 1538 SYNTAX RowPointer 1539 MAX-ACCESS read-only 1540 STATUS deprecated 1541 DESCRIPTION 1542 "The value of this object identifies a particular conceptual 1543 row associated with the indicated entPhysicalIndex and 1544 entLogicalIndex pair. 1546 Since only physical ports are modeled in this table, only 1547 entries which represent interfaces or ports are allowed. If 1548 an ifEntry exists on behalf of a particular physical port, 1549 then this object should identify the associated 'ifEntry'. 1550 For repeater ports, the appropriate row in the 1551 'rptrPortGroupTable' should be identified instead. 1553 For example, suppose a physical port was represented by 1554 entPhysicalEntry.3, entLogicalEntry.15 existed for a 1555 repeater, and entLogicalEntry.22 existed for a bridge. Then 1556 there might be two related instances of 1557 entAliasMappingIdentifier: 1558 entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2 1559 entAliasMappingIdentifier.3.22 == ifIndex.17 1560 It is possible that other mappings (besides interfaces and 1561 repeater ports) may be defined in the future, as required. 1563 Bridge ports are identified by examining the Bridge MIB and 1564 appropriate ifEntries associated with each 'dot1dBasePort', 1565 and are thus not represented in this table." 1566 ::= { entAliasMappingEntry 2 } 1568 -- physical mapping table 1569 entPhysicalContainsTable OBJECT-TYPE 1570 SYNTAX SEQUENCE OF EntPhysicalContainsEntry 1571 MAX-ACCESS not-accessible 1572 STATUS current 1573 DESCRIPTION 1574 "A table which exposes the container/'containee' 1575 relationships between physical entities. This table provides 1576 all the information found by constructing the virtual 1577 containment tree for a given entPhysicalTable, but in a more 1578 direct format. 1580 In the event a physical entity is contained by more than one 1581 other physical entity (e.g., double-wide modules), this 1582 table should include these additional mappings, which cannot 1583 be represented in the entPhysicalTable virtual containment 1584 tree." 1585 ::= { entityMapping 3 } 1587 entPhysicalContainsEntry OBJECT-TYPE 1588 SYNTAX EntPhysicalContainsEntry 1589 MAX-ACCESS not-accessible 1590 STATUS current 1591 DESCRIPTION 1592 "A single container/'containee' relationship." 1593 INDEX { entPhysicalIndex, entPhysicalChildIndex } 1594 ::= { entPhysicalContainsTable 1 } 1596 EntPhysicalContainsEntry ::= SEQUENCE { 1597 entPhysicalChildIndex PhysicalIndex 1598 } 1600 entPhysicalChildIndex OBJECT-TYPE 1601 SYNTAX PhysicalIndex 1602 MAX-ACCESS read-only 1603 STATUS current 1604 DESCRIPTION 1605 "The value of entPhysicalIndex for the contained physical 1606 entity." 1607 ::= { entPhysicalContainsEntry 1 } 1609 -- last change time stamp for the whole MIB 1610 entLastChangeTime OBJECT-TYPE 1611 SYNTAX TimeStamp 1612 MAX-ACCESS read-only 1613 STATUS current 1614 DESCRIPTION 1615 "The value of sysUpTime at the time a conceptual row is 1616 created, modified, or deleted in any of these tables: 1617 - entPhysicalTable 1618 - entLogicalTable 1619 - entLPMappingTable 1620 - entAliasMappingTable 1621 - entPhysicalContainsTable 1622 " 1623 ::= { entityGeneral 1 } 1625 -- Entity MIB Trap Definitions 1626 entityMIBTraps OBJECT IDENTIFIER ::= { entityMIB 2 } 1627 entityMIBTrapPrefix OBJECT IDENTIFIER ::= { entityMIBTraps 0 } 1629 entConfigChange NOTIFICATION-TYPE 1630 STATUS current 1631 DESCRIPTION 1632 "An entConfigChange notification is generated when the value 1633 of entLastChangeTime changes. It can be utilized by an NMS 1634 to trigger logical/physical entity table maintenance polls. 1636 An agent should not generate more than one entConfigChange 1637 'notification-event' in a given time interval (five seconds 1638 is the suggested default). A 'notification-event' is the 1639 transmission of a single trap or inform PDU to a list of 1640 notification destinations. 1642 If additional configuration changes occur within the 1643 throttling period, then notification-events for these 1644 changes should be suppressed by the agent until the current 1645 throttling period expires. At the end of a throttling 1646 period, one notification-event should be generated if any 1647 configuration changes occurred since the start of the 1648 throttling period. In such a case, another throttling period 1649 is started right away. 1651 An NMS should periodically check the value of 1652 entLastChangeTime to detect any missed entConfigChange 1653 notification-events, e.g., due to throttling or transmission 1654 loss." 1655 ::= { entityMIBTrapPrefix 1 } 1657 -- conformance information 1658 entityConformance OBJECT IDENTIFIER ::= { entityMIB 3 } 1660 entityCompliances OBJECT IDENTIFIER ::= { entityConformance 1 } 1661 entityGroups OBJECT IDENTIFIER ::= { entityConformance 2 } 1663 -- compliance statements 1664 entityCompliance MODULE-COMPLIANCE 1665 STATUS deprecated 1666 DESCRIPTION 1667 "The compliance statement for SNMP entities which implement 1668 version 1 of the Entity MIB." 1669 MODULE -- this module 1670 MANDATORY-GROUPS { 1671 entityPhysicalGroup, 1672 entityLogicalGroup, 1673 entityMappingGroup, 1674 entityGeneralGroup, 1675 entityNotificationsGroup 1676 } 1677 ::= { entityCompliances 1 } 1679 entity2Compliance MODULE-COMPLIANCE 1680 STATUS deprecated 1681 DESCRIPTION 1682 "The compliance statement for SNMP entities which implement 1683 version 2 of the Entity MIB." 1684 MODULE -- this module 1685 MANDATORY-GROUPS { 1686 entityPhysicalGroup, 1687 entityPhysical2Group, 1688 entityGeneralGroup, 1689 entityNotificationsGroup 1690 } 1691 GROUP entityLogical2Group 1692 DESCRIPTION 1693 "Implementation of this group is not mandatory for agents 1694 which model all MIB object instances within a single naming 1695 scope." 1697 GROUP entityMappingGroup 1698 DESCRIPTION 1699 "Implementation of the entPhysicalContainsTable is mandatory 1700 for all agents. Implementation of the entLPMappingTable and 1701 entAliasMappingTables are not mandatory for agents which 1702 model all MIB object instances within a single naming scope. 1704 Note that the entAliasMappingTable may be useful for all 1705 agents, however implementation of the entityLogicalGroup or 1706 entityLogical2Group is required to support this table." 1708 OBJECT entPhysicalSerialNum 1709 MIN-ACCESS not-accessible 1710 DESCRIPTION 1711 "Read and write access is not required for agents which 1712 cannot identify serial number information for physical 1713 entities, and/or cannot provide non-volatile storage for 1714 NMS-assigned serial numbers. 1716 Write access is not required for agents which can identify 1717 serial number information for physical entities, but cannot 1718 provide non-volatile storage for NMS-assigned serial 1719 numbers. 1721 Write access is not required for physical entities for 1722 physical entities for which the associated value of the 1723 entPhysicalIsFRU object is equal to 'false(2)'." 1725 OBJECT entPhysicalAlias 1726 MIN-ACCESS read-only 1727 DESCRIPTION 1728 "Write access is required only if the associated 1729 entPhysicalClass value is equal to 'chassis(3)'." 1731 OBJECT entPhysicalAssetID 1732 MIN-ACCESS not-accessible 1733 DESCRIPTION 1734 "Read and write access is not required for agents which 1735 cannot provide non-volatile storage for NMS-assigned asset 1736 identifiers. 1738 Write access is not required for physical entities for which 1739 the associated value of entPhysicalIsFRU is equal to 1740 'false(2)'." 1742 OBJECT entPhysicalClass 1743 SYNTAX INTEGER { 1744 other(1), 1745 unknown(2), 1746 chassis(3), 1747 backplane(4), 1748 container(5), 1749 powerSupply(6), 1750 fan(7), 1751 sensor(8), 1752 module(9), 1753 port(10), 1754 stack(11) 1755 } 1756 DESCRIPTION 1757 "Implementation of the 'cpu(12)' enumeration is not 1758 required." 1760 ::= { entityCompliances 2 } 1762 entity3Compliance MODULE-COMPLIANCE 1763 STATUS current 1764 DESCRIPTION 1765 "The compliance statement for SNMP entities which implement 1766 version 3 of the Entity MIB." 1767 MODULE -- this module 1768 MANDATORY-GROUPS { 1769 entityPhysicalGroup, 1770 entityPhysical2Group, 1771 entityGeneralGroup, 1772 entityNotificationsGroup 1773 } 1774 GROUP entityLogical2Group 1775 DESCRIPTION 1776 "Implementation of this group is not mandatory for agents 1777 which model all MIB object instances within a single naming 1778 scope." 1780 GROUP entityMappingGroupRev1 1781 DESCRIPTION 1782 "Implementation of the entPhysicalContainsTable is mandatory 1783 for all agents. Implementation of the entAliasMappingTable 1784 is not mandatory for agents which model all MIB object 1785 instances within a single naming scope. 1787 Note that the entAliasMappingTable may be useful for all 1788 agents, however implementation of the entityLogicalGroup or 1789 entityLogical2Group is required to support this table." 1791 OBJECT entPhysicalSerialNum 1792 MIN-ACCESS not-accessible 1793 DESCRIPTION 1794 "Read and write access is not required for agents which 1795 cannot identify serial number information for physical 1796 entities, and/or cannot provide non-volatile storage for 1797 NMS-assigned serial numbers. 1799 Write access is not required for agents which can identify 1800 serial number information for physical entities, but cannot 1801 provide non-volatile storage for NMS-assigned serial 1802 numbers. 1804 Write access is not required for physical entities for 1805 physical entities for which the associated value of the 1806 entPhysicalIsFRU object is equal to 'false(2)'." 1808 OBJECT entPhysicalAlias 1809 MIN-ACCESS read-only 1810 DESCRIPTION 1811 "Write access is required only if the associated 1812 entPhysicalClass value is equal to 'chassis(3)'." 1814 OBJECT entPhysicalAssetID 1815 MIN-ACCESS not-accessible 1816 DESCRIPTION 1817 "Read and write access is not required for agents which 1818 cannot provide non-volatile storage for NMS-assigned asset 1819 identifiers. 1821 Write access is not required for physical entities for which 1822 the associated value of entPhysicalIsFRU is equal to 1823 'false(2)'." 1824 ::= { entityCompliances 3 } 1826 -- MIB groupings 1827 entityPhysicalGroup OBJECT-GROUP 1828 OBJECTS { 1829 entPhysicalDescr, 1830 entPhysicalVendorType, 1831 entPhysicalContainedIn, 1832 entPhysicalClass, 1833 entPhysicalParentRelPos, 1834 entPhysicalName 1835 } 1836 STATUS current 1837 DESCRIPTION 1838 "The collection of objects which are used to represent 1839 physical system components, for which a single agent 1840 provides management information." 1841 ::= { entityGroups 1 } 1843 entityLogicalGroup OBJECT-GROUP 1844 OBJECTS { 1845 entLogicalDescr, 1846 entLogicalType, 1847 entLogicalCommunity, 1848 entLogicalTAddress, 1849 entLogicalTDomain 1850 } 1851 STATUS deprecated 1852 DESCRIPTION 1853 "The collection of objects which are used to represent the 1854 list of logical entities for which a single agent provides 1855 management information." 1856 ::= { entityGroups 2 } 1858 entityMappingGroup OBJECT-GROUP 1859 OBJECTS { 1860 entLPPhysicalIndex, 1861 entAliasMappingIdentifier, 1862 entPhysicalChildIndex 1863 } 1864 STATUS deprecated 1865 DESCRIPTION 1866 "The collection of objects which are used to represent the 1867 associations between multiple logical entities, physical 1868 components, interfaces, and port identifiers for which a 1869 single agent provides management information." 1870 ::= { entityGroups 3 } 1872 entityGeneralGroup OBJECT-GROUP 1873 OBJECTS { 1874 entLastChangeTime 1875 } 1877 STATUS current 1878 DESCRIPTION 1879 "The collection of objects which are used to represent 1880 general entity information for which a single agent provides 1881 management information." 1882 ::= { entityGroups 4 } 1884 entityNotificationsGroup NOTIFICATION-GROUP 1885 NOTIFICATIONS { entConfigChange } 1886 STATUS current 1887 DESCRIPTION 1888 "The collection of notifications used to indicate Entity MIB 1889 data consistency and general status information." 1890 ::= { entityGroups 5 } 1892 entityPhysical2Group OBJECT-GROUP 1893 OBJECTS { 1894 entPhysicalHardwareRev, 1895 entPhysicalFirmwareRev, 1896 entPhysicalSoftwareRev, 1897 entPhysicalSerialNum, 1898 entPhysicalMfgName, 1899 entPhysicalModelName, 1900 entPhysicalAlias, 1901 entPhysicalAssetID, 1902 entPhysicalIsFRU 1903 } 1904 STATUS current 1905 DESCRIPTION 1906 "The collection of objects which are used to represent 1907 physical system components, for which a single agent 1908 provides management information. This group augments the 1909 objects contained in the entityPhysicalGroup." 1910 ::= { entityGroups 6 } 1912 entityLogical2Group OBJECT-GROUP 1913 OBJECTS { 1914 entLogicalDescr, 1915 entLogicalType, 1916 entLogicalTAddress, 1917 entLogicalTDomain, 1918 entLogicalContextEngineID, 1919 entLogicalContextName 1920 } 1921 STATUS current 1922 DESCRIPTION 1923 "The collection of objects which are used to represent the 1924 list of logical entities for which a single SNMP entity 1925 provides management information." 1926 ::= { entityGroups 7 } 1928 entityMappingGroupRev1 OBJECT-GROUP 1929 OBJECTS { 1930 entPhysicalChildIndex 1931 } 1932 STATUS current 1933 DESCRIPTION 1934 "The collection of objects which are used to represent the 1935 associations between multiple logical entities, physical 1936 components, interfaces, and port identifiers for which a 1937 single agent provides management information." 1938 ::= { entityGroups 8 } 1940 END 1941 6. Usage Examples 1943 The following sections iterate the instance values for two example 1944 networking devices. These examples are kept simple to make them more 1945 understandable. Auxiliary components, such as fans, sensors, empty 1946 slots, and sub-modules are not shown, but might be modeled in real 1947 implementations. 1949 6.1. Router/Bridge 1951 A router containing two slots. Each slot contains a 3 port 1952 router/bridge module. Each port is represented in the ifTable. There 1953 are two logical instances of OSPF running and two logical bridges: 1955 Physical entities -- entPhysicalTable: 1956 1 Field-replaceable physical chassis: 1957 entPhysicalDescr.1 == 'Acme Chassis Model 100' 1958 entPhysicalVendorType.1 == acmeProducts.chassisTypes.1 1959 entPhysicalContainedIn.1 == 0 1960 entPhysicalClass.1 == chassis(3) 1961 entPhysicalParentRelPos.1 == 0 1962 entPhysicalName.1 == '100-A' 1963 entPhysicalHardwareRev.1 == 'A(1.00.02)' 1964 entPhysicalSoftwareRev.1 == '' 1965 entPhysicalFirmwareRev.1 == '' 1966 entPhysicalSerialNum.1 == 'C100076544' 1967 entPhysicalMfgName.1 == 'Acme' 1968 entPhysicalModelName.1 == '100' 1969 entPhysicalAlias.1 == 'cl-SJ17-3-006:rack1:rtr-U3' 1970 entPhysicalAssetID.1 == '0007372293' 1971 entPhysicalIsFRU.1 == true(1) 1973 2 slots within the chassis: 1974 entPhysicalDescr.2 == 'Acme Chassis Slot Type AA' 1975 entPhysicalVendorType.2 == acmeProducts.slotTypes.1 1976 entPhysicalContainedIn.2 == 1 1977 entPhysicalClass.2 == container(5) 1978 entPhysicalParentRelPos.2 == 1 1979 entPhysicalName.2 == 'S1' 1980 entPhysicalHardwareRev.2 == 'B(1.00.01)' 1981 entPhysicalSoftwareRev.2 == '' 1982 entPhysicalFirmwareRev.2 == '' 1983 entPhysicalSerialNum.2 == '' 1984 entPhysicalMfgName.2 == 'Acme' 1985 entPhysicalModelName.2 == 'AA' 1986 entPhysicalAlias.2 == '' 1987 entPhysicalAssetID.2 == '' 1988 entPhysicalIsFRU.2 == false(2) 1990 entPhysicalDescr.3 == 'Acme Chassis Slot Type AA' 1991 entPhysicalVendorType.3 = acmeProducts.slotTypes.1 1992 entPhysicalContainedIn.3 == 1 1993 entPhysicalClass.3 == container(5) 1994 entPhysicalParentRelPos.3 == 2 1995 entPhysicalName.3 == 'S2' 1996 entPhysicalHardwareRev.3 == '1.00.07' 1997 entPhysicalSoftwareRev.3 == '' 1998 entPhysicalFirmwareRev.3 == '' 1999 entPhysicalSerialNum.3 == '' 2000 entPhysicalMfgName.3 == 'Acme' 2001 entPhysicalModelName.3 == 'AA' 2002 entPhysicalAlias.3 == '' 2003 entPhysicalAssetID.3 == '' 2004 entPhysicalIsFRU.3 == false(2) 2006 2 Field-replaceable modules: 2007 Slot 1 contains a module with 3 ports: 2008 entPhysicalDescr.4 == 'Acme Router-100' 2009 entPhysicalVendorType.4 == acmeProducts.moduleTypes.14 2010 entPhysicalContainedIn.4 == 2 2011 entPhysicalClass.4 == module(9) 2012 entPhysicalParentRelPos.4 == 1 2013 entPhysicalName.4 == 'M1' 2014 entPhysicalHardwareRev.4 == '1.00.07' 2015 entPhysicalSoftwareRev.4 == '1.4.1' 2016 entPhysicalFirmwareRev.4 == 'A(1.1)' 2017 entPhysicalSerialNum.4 == 'C100087363' 2018 entPhysicalMfgName.4 == 'Acme' 2019 entPhysicalModelName.4 == 'R100-FE' 2020 entPhysicalAlias.4 == 'rtr-U3:m1:SJ17-3-eng' 2021 entPhysicalAssetID.4 == '0007372462' 2022 entPhysicalIsFRU.4 == true(1) 2024 entPhysicalDescr.5 == 'Acme Ethernet-100 Port' 2025 entPhysicalVendorType.5 == acmeProducts.portTypes.2 2026 entPhysicalContainedIn.5 == 4 2027 entPhysicalClass.5 == port(10) 2028 entPhysicalParentRelPos.5 == 1 2029 entPhysicalName.5 == 'P1' 2030 entPhysicalHardwareRev.5 == 'G(1.02)' 2031 entPhysicalSoftwareRev.5 == '' 2032 entPhysicalFirmwareRev.5 == '1.1' 2033 entPhysicalSerialNum.5 == '' 2034 entPhysicalMfgName.5 == 'Acme' 2035 entPhysicalModelName.5 == 'FE-100' 2036 entPhysicalAlias.5 == '' 2037 entPhysicalAssetID.5 == '' 2038 entPhysicalIsFRU.5 == false(2) 2040 entPhysicalDescr.6 == 'Acme Ethernet-100 Port' 2041 entPhysicalVendorType.6 == acmeProducts.portTypes.2 2042 entPhysicalContainedIn.6 == 4 2043 entPhysicalClass.6 == port(10) 2044 entPhysicalParentRelPos.6 == 2 2045 entPhysicalName.6 == 'P2' 2046 entPhysicalHardwareRev.6 == 'G(1.02)' 2047 entPhysicalSoftwareRev.6 == '' 2048 entPhysicalFirmwareRev.6 == '1.1' 2049 entPhysicalSerialNum.6 == '' 2050 entPhysicalMfgName.6 == 'Acme' 2051 entPhysicalModelName.6 == 'FE-100' 2052 entPhysicalAlias.6 == '' 2053 entPhysicalAssetID.6 == '' 2054 entPhysicalIsFRU.6 == false(2) 2056 entPhysicalDescr.7 == 'Acme Router-100 FDDI-Port' 2057 entPhysicalVendorType.7 == acmeProducts.portTypes.3 2058 entPhysicalContainedIn.7 == 4 2059 entPhysicalClass.7 == port(10) 2060 entPhysicalParentRelPos.7 == 3 2061 entPhysicalName.7 == 'P3' 2062 entPhysicalHardwareRev.7 == 'B(1.03)' 2063 entPhysicalSoftwareRev.7 == '2.5.1' 2064 entPhysicalFirmwareRev.7 == '2.5F' 2065 entPhysicalSerialNum.7 == '' 2066 entPhysicalMfgName.7 == 'Acme' 2067 entPhysicalModelName.7 == 'FDDI-100' 2068 entPhysicalAlias.7 == '' 2069 entPhysicalAssetID.7 == '' 2070 entPhysicalIsFRU.7 == false(2) 2072 Slot 2 contains another 3-port module: 2073 entPhysicalDescr.8 == 'Acme Router-100 Comm Module' 2074 entPhysicalVendorType.8 == acmeProducts.moduleTypes.15 2075 entPhysicalContainedIn.8 == 3 2076 entPhysicalClass.8 == module(9) 2077 entPhysicalParentRelPos.8 == 1 2078 entPhysicalName.8 == 'M2' 2079 entPhysicalHardwareRev.8 == '2.01.00' 2080 entPhysicalSoftwareRev.8 == '3.0.7' 2081 entPhysicalFirmwareRev.8 == 'A(1.2)' 2082 entPhysicalSerialNum.8 == 'C100098732' 2083 entPhysicalMfgName.8 == 'Acme' 2084 entPhysicalModelName.8 == 'C100' 2085 entPhysicalAlias.8 == 'rtr-U3:m2:SJ17-2-eng' 2086 entPhysicalAssetID.8 == '0007373982' 2087 entPhysicalIsFRU.8 == true(1) 2089 entPhysicalDescr.9 == 'Acme Fddi-100 Port' 2090 entPhysicalVendorType.9 == acmeProducts.portTypes.5 2091 entPhysicalContainedIn.9 == 8 2092 entPhysicalClass.9 == port(10) 2093 entPhysicalParentRelPos.9 == 1 2094 entPhysicalName.9 == 'FDDI Primary' 2095 entPhysicalHardwareRev.9 == 'CC(1.07)' 2096 entPhysicalSoftwareRev.9 == '2.0.34' 2097 entPhysicalFirmwareRev.9 == '1.1' 2098 entPhysicalSerialNum.9 == '' 2099 entPhysicalMfgName.9 == 'Acme' 2100 entPhysicalModelName.9 == 'FDDI-100' 2101 entPhysicalAlias.9 == '' 2102 entPhysicalAssetID.9 == '' 2103 entPhysicalIsFRU.9 == false(2) 2105 entPhysicalDescr.10 == 'Acme Ethernet-100 Port' 2106 entPhysicalVendorType.10 == acmeProducts.portTypes.2 2107 entPhysicalContainedIn.10 == 8 2108 entPhysicalClass.10 == port(10) 2109 entPhysicalParentRelPos.10 == 2 2110 entPhysicalName.10 == 'Ethernet A' 2111 entPhysicalHardwareRev.10 == 'G(1.04)' 2112 entPhysicalSoftwareRev.10 == '' 2113 entPhysicalFirmwareRev.10 == '1.3' 2114 entPhysicalSerialNum.10 == '' 2115 entPhysicalMfgName.10 == 'Acme' 2116 entPhysicalModelName.10 == 'FE-100' 2117 entPhysicalAlias.10 == '' 2118 entPhysicalAssetID.10 == '' 2119 entPhysicalIsFRU.10 == false(2) 2120 entPhysicalDescr.11 == 'Acme Ethernet-100 Port' 2121 entPhysicalVendorType.11 == acmeProducts.portTypes.2 2122 entPhysicalContainedIn.11 == 8 2123 entPhysicalClass.11 == port(10) 2124 entPhysicalParentRelPos.11 == 3 2125 entPhysicalName.11 == 'Ethernet B' 2126 entPhysicalHardwareRev.11 == 'G(1.04)' 2127 entPhysicalSoftwareRev.11 == '' 2128 entPhysicalFirmwareRev.11 == '1.3' 2129 entPhysicalSerialNum.11 == '' 2130 entPhysicalMfgName.11 == 'Acme' 2131 entPhysicalModelName.11 == 'FE-100' 2132 entPhysicalAlias.11 == '' 2133 entPhysicalAssetID.11 == '' 2134 entPhysicalIsFRU.11 == false(2) 2136 Logical entities -- entLogicalTable; no SNMPv3 support 2137 2 OSPF instances: 2138 entLogicalDescr.1 == 'Acme OSPF v1.1' 2139 entLogicalType.1 == ospf 2140 entLogicalCommunity.1 == 'public-ospf1' 2141 entLogicalTAddress.1 == 124.125.126.127:161 2142 entLogicalTDomain.1 == snmpUDPDomain 2143 entLogicalContextEngineID.1 == '' 2144 entLogicalContextName.1 == '' 2146 entLogicalDescr.2 == 'Acme OSPF v1.1' 2147 entLogicalType.2 == ospf 2148 entLogicalCommunity.2 == 'public-ospf2' 2149 entLogicalTAddress.2 == 124.125.126.127:161 2150 entLogicalTDomain.2 == snmpUDPDomain 2151 entLogicalContextEngineID.2 == '' 2152 entLogicalContextName.2 == '' 2154 2 logical bridges: 2155 entLogicalDescr.3 == 'Acme Bridge v2.1.1' 2156 entLogicalType.3 == dot1dBridge 2157 entLogicalCommunity.3 == 'public-bridge1' 2158 entLogicalTAddress.3 == 124.125.126.127:161 2159 entLogicalTDomain.3 == snmpUDPDomain 2160 entLogicalContextEngineID.3 == '' 2161 entLogicalContextName.3 == '' 2163 entLogicalDescr.4 == 'Acme Bridge v2.1.1' 2164 entLogicalType.4 == dot1dBridge 2165 entLogicalCommunity.4 == 'public-bridge2' 2166 entLogicalTAddress.4 == 124.125.126.127:161 2167 entLogicalTDomain.4 == snmpUDPDomain 2168 entLogicalContextEngineID.4 == '' 2169 entLogicalContextName.4 == '' 2171 Logical to Physical Mappings: 2172 1st OSPF instance: uses module 1-port 1 2173 entLPPhysicalIndex.1.5 == 5 2175 2nd OSPF instance: uses module 2-port 1 2176 entLPPhysicalIndex.2.9 == 9 2178 1st bridge group: uses module 1, all ports 2180 [ed. -- Note that these mappings are included in the table since 2181 another logical entity (1st OSPF) utilizes one of the 2182 ports. If this were not the case, then a single mapping 2183 to the module (e.g., entLPPhysicalIndex.3.4) would be 2184 present instead. ] 2185 entLPPhysicalIndex.3.5 == 5 2186 entLPPhysicalIndex.3.6 == 6 2187 entLPPhysicalIndex.3.7 == 7 2189 2nd bridge group: uses module 2, all ports 2190 entLPPhysicalIndex.4.9 == 9 2191 entLPPhysicalIndex.4.10 == 10 2192 entLPPhysicalIndex.4.11 == 11 2194 Physical to Logical to MIB Alias Mappings -- entAliasMappingTable: 2195 Example 1: ifIndex values are global to all logical entities 2196 entAliasMappingIdentifier.5.0 == ifIndex.1 2197 entAliasMappingIdentifier.6.0 == ifIndex.2 2198 entAliasMappingIdentifier.7.0 == ifIndex.3 2199 entAliasMappingIdentifier.9.0 == ifIndex.4 2200 entAliasMappingIdentifier.10.0 == ifIndex.5 2201 entAliasMappingIdentifier.11.0 == ifIndex.6 2203 Example 2: ifIndex values are not shared by all logical entities 2204 entAliasMappingIdentifier.5.0 == ifIndex.1 2205 entAliasMappingIdentifier.5.3 == ifIndex.101 2206 entAliasMappingIdentifier.6.0 == ifIndex.2 2207 entAliasMappingIdentifier.6.3 == ifIndex.102 2208 entAliasMappingIdentifier.7.0 == ifIndex.3 2209 entAliasMappingIdentifier.7.3 == ifIndex.103 2210 entAliasMappingIdentifier.9.0 == ifIndex.4 2211 entAliasMappingIdentifier.9.3 == ifIndex.204 2212 entAliasMappingIdentifier.10.0 == ifIndex.5 2213 entAliasMappingIdentifier.10.3 == ifIndex.205 2214 entAliasMappingIdentifier.11.0 == ifIndex.6 2215 entAliasMappingIdentifier.11.3 == ifIndex.206 2217 Physical Containment Tree -- entPhysicalContainsTable 2218 chassis has two containers: 2219 entPhysicalChildIndex.1.2 == 2 2220 entPhysicalChildIndex.1.3 == 3 2222 container 1 has a module: 2223 entPhysicalChildIndex.2.4 == 4 2225 container 2 has a module: 2226 entPhysicalChildIndex.3.8 == 8 2228 module 1 has 3 ports: 2229 entPhysicalChildIndex.4.5 == 5 2230 entPhysicalChildIndex.4.6 == 6 2231 entPhysicalChildIndex.4.7 == 7 2233 module 2 has 3 ports: 2234 entPhysicalChildIndex.8.9 == 9 2235 entPhysicalChildIndex.8.10 == 10 2236 entPhysicalChildIndex.1.11 == 11 2238 6.2. Repeaters 2240 A 3-slot Hub with 2 backplane ethernet segments. Slot three is empty, 2241 and the remaining slots contain ethernet repeater modules. 2243 Note that this example assumes an older Repeater MIB implementation, 2244 (RFC 1516 [RFC1516]) rather than the new Repeater MIB (RFC 2108 2245 [RFC2108]). The new version contains an object called 'rptrPortRptrId', 2246 which should be used to identify repeater port groupings, rather than 2247 with community strings or contexts. 2249 Physical entities -- entPhysicalTable: 2250 1 Field-replaceable physical chassis: 2251 entPhysicalDescr.1 == 'Acme Chassis Model 110' 2252 entPhysicalVendorType.1 == acmeProducts.chassisTypes.2 2253 entPhysicalContainedIn.1 == 0 2254 entPhysicalClass.1 == chassis(3) 2255 entPhysicalParentRelPos.1 == 0 2256 entPhysicalName.1 == '110-B' 2257 entPhysicalHardwareRev.1 == 'A(1.02.00)' 2258 entPhysicalSoftwareRev.1 == '' 2259 entPhysicalFirmwareRev.1 == '' 2260 entPhysicalSerialNum.1 == 'C100079294' 2261 entPhysicalMfgName.1 == 'Acme' 2262 entPhysicalModelName.1 == '110' 2263 entPhysicalAlias.1 == 'bldg09:floor1:rptr18:0067eea0229f' 2264 entPhysicalAssetID.1 == '0007386327' 2265 entPhysicalIsFRU.1 == true(1) 2267 2 Chassis Ethernet Backplanes: 2268 entPhysicalDescr.2 == 'Acme Ethernet Backplane Type A' 2269 entPhysicalVendorType.2 == acmeProducts.backplaneTypes.1 2270 entPhysicalContainedIn.2 == 1 2271 entPhysicalClass.2 == backplane(4) 2272 entPhysicalParentRelPos.2 == 1 2273 entPhysicalName.2 == 'B1' 2274 entPhysicalHardwareRev.2 == 'A(2.04.01)' 2275 entPhysicalSoftwareRev.2 == '' 2276 entPhysicalFirmwareRev.2 == '' 2277 entPhysicalSerialNum.2 == '' 2278 entPhysicalMfgName.2 == 'Acme' 2279 entPhysicalModelName.2 == 'BK-A' 2280 entPhysicalAlias.2 == '' 2281 entPhysicalAssetID.2 == '' 2282 entPhysicalIsFRU.2 == false(2) 2284 entPhysicalDescr.3 == 'Acme Ethernet Backplane Type A' 2285 entPhysicalVendorType.3 == acmeProducts.backplaneTypes.1 2286 entPhysicalContainedIn.3 == 1 2287 entPhysicalClass.3 == backplane(4) 2288 entPhysicalParentRelPos.3 == 2 2289 entPhysicalName.3 == 'B2' 2290 entPhysicalHardwareRev.3 == 'A(2.04.01)' 2291 entPhysicalSoftwareRev.3 == '' 2292 entPhysicalFirmwareRev.3 == '' 2293 entPhysicalSerialNum.3 == '' 2294 entPhysicalMfgName.3 == 'Acme' 2295 entPhysicalModelName.3 == 'BK-A' 2296 entPhysicalAlias.3 == '' 2297 entPhysicalAssetID.3 == '' 2298 entPhysicalIsFRU.3 == false(2) 2300 3 slots within the chassis: 2301 entPhysicalDescr.4 == 'Acme Hub Slot Type RB' 2302 entPhysicalVendorType.4 == acmeProducts.slotTypes.5 2303 entPhysicalContainedIn.4 == 1 2304 entPhysicalClass.4 == container(5) 2305 entPhysicalParentRelPos.4 == 1 2306 entPhysicalName.4 == 'Slot 1' 2307 entPhysicalHardwareRev.4 == 'B(1.00.03)' 2308 entPhysicalSoftwareRev.4 == '' 2309 entPhysicalFirmwareRev.4 == '' 2310 entPhysicalSerialNum.4 == '' 2311 entPhysicalMfgName.4 == 'Acme' 2312 entPhysicalModelName.4 == 'RB' 2313 entPhysicalAlias.4 == '' 2314 entPhysicalAssetID.4 == '' 2315 entPhysicalIsFRU.4 == false(2) 2317 entPhysicalDescr.5 == 'Acme Hub Slot Type RB' 2318 entPhysicalVendorType.5 == acmeProducts.slotTypes.5 2319 entPhysicalContainedIn.5 == 1 2320 entPhysicalClass.5 == container(5) 2321 entPhysicalParentRelPos.5 == 2 2322 entPhysicalName.5 == 'Slot 2' 2323 entPhysicalHardwareRev.5 == 'B(1.00.03)' 2324 entPhysicalSoftwareRev.5 == '' 2325 entPhysicalFirmwareRev.5 == '' 2326 entPhysicalSerialNum.5 == '' 2327 entPhysicalMfgName.5 == 'Acme' 2328 entPhysicalModelName.5 == 'RB' 2329 entPhysicalAlias.5 == '' 2330 entPhysicalAssetID.5 == '' 2331 entPhysicalIsFRU.5 == false(2) 2333 entPhysicalDescr.6 == 'Acme Hub Slot Type RB' 2334 entPhysicalVendorType.6 == acmeProducts.slotTypes.5 2335 entPhysicalContainedIn.6 == 1 2336 entPhysicalClass.6 == container(5) 2337 entPhysicalParentRelPos.6 == 3 2338 entPhysicalName.6 == 'Slot 3' 2339 entPhysicalHardwareRev.6 == 'B(1.00.03)' 2340 entPhysicalSoftwareRev.6 == '' 2341 entPhysicalFirmwareRev.6 == '' 2342 entPhysicalSerialNum.6 == '' 2343 entPhysicalMfgName.6 == 'Acme' 2344 entPhysicalModelName.6 == 'RB' 2345 entPhysicalAlias.6 == '' 2346 entPhysicalAssetID.6 == '' 2347 entPhysicalIsFRU.6 == false(2) 2349 Slot 1 contains a plug-in module with 4 10-BaseT ports: 2350 entPhysicalDescr.7 == 'Acme 10Base-T Module 114' 2351 entPhysicalVendorType.7 == acmeProducts.moduleTypes.32 2352 entPhysicalContainedIn.7 == 4 2353 entPhysicalClass.7 == module(9) 2354 entPhysicalParentRelPos.7 == 1 2355 entPhysicalName.7 == 'M1' 2356 entPhysicalHardwareRev.7 == 'A(1.02.01)' 2357 entPhysicalSoftwareRev.7 == '1.7.2' 2358 entPhysicalFirmwareRev.7 == 'A(1.5)' 2359 entPhysicalSerialNum.7 == 'C100096244' 2360 entPhysicalMfgName.7 == 'Acme' 2361 entPhysicalModelName.7 = '114' 2362 entPhysicalAlias.7 == 'bldg09:floor1:eng' 2363 entPhysicalAssetID.7 == '0007962951' 2364 entPhysicalIsFRU.7 == true(1) 2366 entPhysicalDescr.8 == 'Acme 10Base-T Port RB' 2367 entPhysicalVendorType.8 == acmeProducts.portTypes.10 2368 entPhysicalContainedIn.8 == 7 2369 entPhysicalClass.8 == port(10) 2370 entPhysicalParentRelPos.8 == 1 2371 entPhysicalName.8 == 'Ethernet-A' 2372 entPhysicalHardwareRev.8 == 'A(1.04F)' 2373 entPhysicalSoftwareRev.8 == '' 2374 entPhysicalFirmwareRev.8 == '1.4' 2375 entPhysicalSerialNum.8 == '' 2376 entPhysicalMfgName.8 == 'Acme' 2377 entPhysicalModelName.8 == 'RB' 2378 entPhysicalAlias.8 == '' 2379 entPhysicalAssetID.8 == '' 2380 entPhysicalIsFRU.8 == false(2) 2382 entPhysicalDescr.9 == 'Acme 10Base-T Port RB' 2383 entPhysicalVendorType.9 == acmeProducts.portTypes.10 2384 entPhysicalContainedIn.9 == 7 2385 entPhysicalClass.9 == port(10) 2386 entPhysicalParentRelPos.9 == 2 2387 entPhysicalName.9 == 'Ethernet-B' 2388 entPhysicalHardwareRev.9 == 'A(1.04F)' 2389 entPhysicalSoftwareRev.9 == '' 2390 entPhysicalFirmwareRev.9 == '1.4' 2391 entPhysicalSerialNum.9 == '' 2392 entPhysicalMfgName.9 == 'Acme' 2393 entPhysicalModelName.9 = 'RB' 2394 entPhysicalAlias.9 == '' 2395 entPhysicalAssetID.9 == '' 2396 entPhysicalIsFRU.9 == false(2) 2398 entPhysicalDescr.10 == 'Acme 10Base-T Port RB' 2399 entPhysicalVendorType.10 == acmeProducts.portTypes.10 2400 entPhysicalContainedIn.10 == 7 2401 entPhysicalClass.10 == port(10) 2402 entPhysicalParentRelPos.10 == 3 2403 entPhysicalName.10 == 'Ethernet-C' 2404 entPhysicalHardwareRev.10 == 'B(1.02.07)' 2405 entPhysicalSoftwareRev.10 == '' 2406 entPhysicalFirmwareRev.10 == '1.4' 2407 entPhysicalSerialNum.10 == '' 2408 entPhysicalMfgName.10 == 'Acme' 2409 entPhysicalModelName.10 == 'RB' 2410 entPhysicalAlias.10 == '' 2411 entPhysicalAssetID.10 == '' 2412 entPhysicalIsFRU.10 == false(2) 2414 entPhysicalDescr.11 == 'Acme 10Base-T Port RB' 2415 entPhysicalVendorType.11 == acmeProducts.portTypes.10 2416 entPhysicalContainedIn.11 == 7 2417 entPhysicalClass.11 == port(10) 2418 entPhysicalParentRelPos.11 == 4 2419 entPhysicalName.11 == 'Ethernet-D' 2420 entPhysicalHardwareRev.11 == 'B(1.02.07)' 2421 entPhysicalSoftwareRev.11 == '' 2422 entPhysicalFirmwareRev.11 == '1.4' 2423 entPhysicalSerialNum.11 == '' 2424 entPhysicalMfgName.11 == 'Acme' 2425 entPhysicalModelName.11 == 'RB' 2426 entPhysicalAlias.11 == '' 2427 entPhysicalAssetID.11 == '' 2428 entPhysicalIsFRU.11 == false(2) 2430 Slot 2 contains another ethernet module with 2 ports. 2431 entPhysicalDescr.12 == 'Acme 10Base-T Module Model 4' 2432 entPhysicalVendorType.12 == acmeProducts.moduleTypes.30 2433 entPhysicalContainedIn.12 = 5 2434 entPhysicalClass.12 == module(9) 2435 entPhysicalParentRelPos.12 == 1 2436 entPhysicalName.12 == 'M2' 2437 entPhysicalHardwareRev.12 == 'A(1.01.07)' 2438 entPhysicalSoftwareRev.12 == '1.8.4' 2439 entPhysicalFirmwareRev.12 == 'A(1.8)' 2440 entPhysicalSerialNum.12 == 'C100102384' 2441 entPhysicalMfgName.12 == 'Acme' 2442 entPhysicalModelName.12 == '4' 2443 entPhysicalAlias.12 == 'bldg09:floor1:devtest' 2444 entPhysicalAssetID.12 == '0007968462' 2445 entPhysicalIsFRU.12 == true(1) 2447 entPhysicalDescr.13 == 'Acme 802.3 AUI Port' 2448 entPhysicalVendorType.13 == acmeProducts.portTypes.11 2449 entPhysicalContainedIn.13 == 12 2450 entPhysicalClass.13 == port(10) 2451 entPhysicalParentRelPos.13 == 1 2452 entPhysicalName.13 == 'AUI' 2453 entPhysicalHardwareRev.13 == 'A(1.06F)' 2454 entPhysicalSoftwareRev.13 == '' 2455 entPhysicalFirmwareRev.13 == '1.5' 2456 entPhysicalSerialNum.13 == '' 2457 entPhysicalMfgName.13 == 'Acme' 2458 entPhysicalModelName.13 == '' 2459 entPhysicalAlias.13 == '' 2460 entPhysicalAssetID.13 == '' 2461 entPhysicalIsFRU.13 == false(2) 2463 entPhysicalDescr.14 == 'Acme 10Base-T Port RD' 2464 entPhysicalVendorType.14 == acmeProducts.portTypes.14 2465 entPhysicalContainedIn.14 == 12 2466 entPhysicalClass.14 == port(10) 2467 entPhysicalParentRelPos.14 == 2 2468 entPhysicalName.14 == 'E2' 2469 entPhysicalHardwareRev.14 == 'B(1.01.02)' 2470 entPhysicalSoftwareRev.14 == '' 2471 entPhysicalFirmwareRev.14 == '2.1' 2472 entPhysicalSerialNum.14 == '' 2473 entPhysicalMfgName.14 == 'Acme' 2474 entPhysicalModelName.14 == '' 2475 entPhysicalAlias.14 == '' 2476 entPhysicalAssetID.14 == '' 2477 entPhysicalIsFRU.14 == false(2) 2479 Logical entities -- entLogicalTable; with SNMPv3 support 2480 Repeater 1--comprised of any ports attached to backplane 1 2481 entLogicalDescr.1 == 'Acme repeater v3.1' 2482 entLogicalType.1 == snmpDot3RptrMgt 2483 entLogicalCommunity.1 'public-repeater1' 2484 entLogicalTAddress.1 == 124.125.126.127:161 2485 entLogicalTDomain.1 == snmpUDPDomain 2486 entLogicalContextEngineID.1 == '80000777017c7d7e7f'H 2487 entLogicalContextName.1 == 'repeater1' 2489 Repeater 2--comprised of any ports attached to backplane 2: 2490 entLogicalDescr.2 == 'Acme repeater v3.1' 2491 entLogicalType.2 == snmpDot3RptrMgt 2492 entLogicalCommunity.2 == 'public-repeater2' 2493 entLogicalTAddress.2 == 124.125.126.127:161 2494 entLogicalTDomain.2 == snmpUDPDomain 2495 entLogicalContextEngineID.2 == '80000777017c7d7e7f'H 2496 entLogicalContextName.2 == 'repeater2' 2498 Logical to Physical Mappings -- entLPMappingTable: 2500 repeater1 uses backplane 1, slot 1-ports 1 & 2, slot 2-port 1 2501 [ed. -- Note that a mapping to the module is not included, 2502 since in this example represents a port-switchable hub. 2503 Even though all ports on the module could belong to the 2504 same repeater as a matter of configuration, the LP port 2505 mappings should not be replaced dynamically with a single 2506 mapping for the module (e.g., entLPPhysicalIndex.1.7). 2507 If all ports on the module shared a single backplane connection, 2508 then a single mapping for the module would be more appropriate. ] 2510 entLPPhysicalIndex.1.2 == 2 2511 entLPPhysicalIndex.1.8 == 8 2512 entLPPhysicalIndex.1.9 == 9 2513 entLPPhysicalIndex.1.13 == 13 2515 repeater2 uses backplane 2, slot 1-ports 3 & 4, slot 2-port 2 2516 entLPPhysicalIndex.2.3 == 3 2517 entLPPhysicalIndex.2.10 == 10 2518 entLPPhysicalIndex.2.11 == 11 2519 entLPPhysicalIndex.2.14 == 14 2521 Physical to Logical to MIB Alias Mappings -- entAliasMappingTable: 2522 Repeater Port Identifier values are shared by both repeaters: 2523 entAliasMappingIdentifier.8.0 == rptrPortGroupIndex.1.1 2524 entAliasMappingIdentifier.9.0 == rptrPortGroupIndex.1.2 2525 entAliasMappingIdentifier.10.0 == rptrPortGroupIndex.1.3 2526 entAliasMappingIdentifier.11.0 == rptrPortGroupIndex.1.4 2527 entAliasMappingIdentifier.13.0 == rptrPortGroupIndex.2.1 2528 entAliasMappingIdentifier.14.0 == rptrPortGroupIndex.2.2 2530 Physical Containment Tree -- entPhysicalContainsTable 2531 chassis has two backplanes and three containers: 2532 entPhysicalChildIndex.1.2 == 2 2533 entPhysicalChildIndex.1.3 == 3 2534 entPhysicalChildIndex.1.4 == 4 2535 entPhysicalChildIndex.1.5 == 5 2536 entPhysicalChildIndex.1.6 == 6 2538 container 1 has a module: 2539 entPhysicalChildIndex.4.7 == 7 2541 container 2 has a module 2542 entPhysicalChildIndex.5.12 == 12 2543 [ed. - in this example, container 3 is empty.] 2545 module 1 has 4 ports: 2546 entPhysicalChildIndex.7.8 == 8 2547 entPhysicalChildIndex.7.9 == 9 2548 entPhysicalChildIndex.7.10 == 10 2549 entPhysicalChildIndex.7.11 == 11 2551 module 2 has 2 ports: 2552 entPhysicalChildIndex.12.13 == 13 2553 entPhysicalChildIndex.12.14 == 14 2555 7. Intellectual Property 2557 The IETF takes no position regarding the validity or scope of any 2558 intellectual property or other rights that might be claimed to pertain 2559 to the implementation or use of the technology described in this 2560 document or the extent to which any license under such rights might or 2561 might not be available; neither does it represent that it has made any 2562 effort to identify any such rights. Information on the IETF's 2563 procedures with respect to rights in standards-track and standards- 2564 related documentation can be found in BCP-11. Copies of claims of 2565 rights made available for publication and any assurances of licenses to 2566 be made available, or the result of an attempt made to obtain a general 2567 license or permission for the use of such proprietary rights by 2568 implementors or users of this specification can be obtained from the 2569 IETF Secretariat. 2571 The IETF invites any interested party to bring to its attention any 2572 copyrights, patents or patent applications, or other proprietary rights 2573 which may cover technology that may be required to practice this 2574 standard. Please address the information to the IETF Executive 2575 Director. 2577 8. Acknowledgements 2579 This memo has been produced by the IETF's Entity MIB working group. 2581 9. Normative References 2583 [RFC2026] 2584 Bradner, S., "The Internet Standards Process -- Revision 3", RFC 2585 2026, October, 1996. 2587 [RFC2578] 2588 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., 2589 and S. Waldbusser, "Structure of Management Information Version 2 2590 (SMIv2)", STD 58, RFC 2578, April 1999. 2592 [RFC2579] 2593 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., 2594 and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 2595 2579, April 1999. 2597 [RFC2580] 2598 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., 2599 and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, RFC 2600 2580, April 1999. 2602 [RFC3411] 2603 Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for 2604 Describing Simple Network Management Protocol (SNMP) Management 2605 Frameworks", STD 62, RFC 3411, December 2002. 2607 [RFC3417] 2608 R. Presuhn, Ed., "Transport Mappings for the Simple Network 2609 Management Protocol (SNMP)", STD 62, RFC 3417, December 2002. 2611 10. Informative References 2613 [RFC1157] 2614 Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple Network 2615 Management Protocol", STD 15, RFC 1157, May 1990. 2617 [RFC1493] 2618 Decker, E., Langille, P., Rijsinghani, A., and K. McCloghrie, 2619 "Definitions of Managed Objects for Bridges", RFC 1493, July, 1993. 2621 [RFC1516] 2622 McMaster, D., and K. McCloghrie, "Definitions of Managed Objects 2623 for IEEE 802.3 Repeater Devices", RFC 1516, September, 1993. 2625 [RFC2037] 2626 McCloghrie, K., and A. Bierman, "Entity MIB using SMIv2", RFC 2037, 2627 October 1996. 2629 [RFC2108] 2630 de Graaf, K., Romascanu, D., McMaster, D., and K. McCloghrie, 2631 "Definitions of Managed Objects for IEEE 802.3 Repeater Devices 2632 using SMIv2", RFC 2108, February, 1997. 2634 [RFC2863] 2635 McCloghrie, K., and F. Kastenholz, "The Interfaces Group MIB", RFC 2636 2863, June, 2000. 2638 [RFC2737] 2639 McCloghrie, K., and A. Bierman, "Entity MIB (Version 2)", RFC 2737, 2640 December 1999. 2642 [RFC3410] 2643 Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction and 2644 Applicability Statements for Internet- Standard Management 2645 Framework", RFC 3410, December 2002. 2647 11. Security Considerations 2649 There are a number of management objects defined in this MIB that have a 2650 MAX-ACCESS clause of read-write and/or read-create. Such objects may be 2651 considered sensitive or vulnerable in some network environments. The 2652 support for SET operations in a non-secure environment without proper 2653 protection can have a negative effect on network operations. 2655 There are a number of managed objects in this MIB that may contain 2656 sensitive information. These are: 2658 entPhysicalDescr 2659 entPhysicalVendorType 2660 entPhysicalHardwareRev 2661 entPhysicalFirmwareRev 2662 entPhysicalSoftwareRev 2663 entPhysicalSerialNum 2664 entPhysicalMfgName 2665 entPhysicalModelName 2667 These objects expose information about the physical entities within a 2668 managed system, which may be used to identify the vendor, model, and 2669 version information of each system component. 2671 entPhysicalAssetID 2673 This object can allow asset identifiers for various system components to 2674 be exposed, in the event this MIB object is actually configured by an 2675 NMS application. 2677 entLogicalDescr 2678 entLogicalType 2680 These objects expose the type of logical entities present in the managed 2681 system. 2683 entLogicalCommunity 2685 This object exposes community names associated with particular logical 2686 entities within the system. 2688 entLogicalTAddress 2689 entLogicalTDomain 2691 These objects expose network addresses that can be used to communicate 2692 with an SNMP agent on behalf of particular logical entities within the 2693 system. 2695 entLogicalContextEngineID 2696 entLogicalContextName 2698 These objects identify the authoritative SNMP engine that contains 2699 information on behalf of particular logical entities within the system. 2701 It is thus important to control even GET access to these objects and 2702 possibly to even encrypt the values of these object when sending them 2703 over the network via SNMP. Not all versions of SNMP provide features 2704 for such a secure environment. 2706 SNMPv1 by itself is not a secure environment. Even if the network 2707 itself is secure (for example by using IPSec), even then, there is no 2708 control as to who on the secure network is allowed to access and GET/SET 2709 (read/change/create/delete) the objects in this MIB. 2711 It is recommended that the implementers consider the security features 2712 as provided by the SNMPv3 framework. Specifically, the use of the User- 2713 based Security Model RFC 2574 [RFC2574] and the View-based Access 2714 Control Model RFC 2575 [RFC2575] is recommended. 2716 It is then a customer/user responsibility to ensure that the SNMP entity 2717 giving access to an instance of this MIB, is properly configured to give 2718 access to the objects only to those principals (users) that have 2719 legitimate rights to indeed GET or SET (change/create/delete) them. 2721 12. Authors' Addresses 2723 Andy Bierman 2724 Cisco Systems, Inc. 2725 170 West Tasman Drive 2726 San Jose, CA 95134 USA 2727 Phone: +1 408-527-3711 2728 Email: abierman@cisco.com 2730 Keith McCloghrie 2731 Cisco Systems, Inc. 2732 170 West Tasman Drive 2733 San Jose, CA 95134 USA 2734 Phone: +1 408-526-5260 2735 Email: kzm@cisco.com 2737 13. Full Copyright Statement 2739 Copyright (C) The Internet Society (2004). All Rights Reserved. 2741 This document and translations of it may be copied and furnished to 2742 others, and derivative works that comment on or otherwise explain it or 2743 assist in its implementation may be prepared, copied, published and 2744 distributed, in whole or in part, without restriction of any kind, 2745 provided that the above copyright notice and this paragraph are included 2746 on all such copies and derivative works. However, this document itself 2747 may not be modified in any way, such as by removing the copyright notice 2748 or references to the Internet Society or other Internet organizations, 2749 except as needed for the purpose of developing Internet standards in 2750 which case the procedures for copyrights defined in the Internet 2751 Standards process must be followed, or as required to translate it into 2752 languages other than English. 2754 The limited permissions granted above are perpetual and will not be 2755 revoked by the Internet Society or its successors or assigns. 2757 This document and the information contained herein is provided on an "AS 2758 IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK 2759 FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 2760 LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT 2761 INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR 2762 FITNESS FOR A PARTICULAR PURPOSE.