Debian Codegraph @

rfc2037.html

raw
1 <pre>Network Working Group K. McCloghrie
2 Request for Comments: 2037 A. Bierman
3 Category: Standards Track Cisco Systems
4 October 1996
5
6
7 <span class="h1">Entity MIB using SMIv2</span>
8
9 Status of this Memo
10
11 This document specifies an Internet standards track protocol for the
12 Internet community, and requests discussion and suggestions for
13 improvements. Please refer to the current edition of the "Internet
14 Official Protocol Standards" (STD 1) for the standardization state
15 and status of this protocol. Distribution of this memo is unlimited.
16
17 Table of Contents
18
19 <a href="#section-1">1</a>. Introduction .............................................. <a href="#page-2">2</a>
20 <a href="#section-2">2</a>. The SNMP Network Management Framework ..................... <a href="#page-2">2</a>
21 <a href="#section-2.1">2.1</a> Object Definitions ....................................... <a href="#page-2">2</a>
22 <a href="#section-3">3</a>. Overview .................................................. <a href="#page-3">3</a>
23 <a href="#section-3.1">3.1</a> Terms .................................................... <a href="#page-4">4</a>
24 <a href="#section-3.2">3.2</a> Relationship to Community Strings ........................ <a href="#page-5">5</a>
25 <a href="#section-3.3">3.3</a> Relationship to Proxy Mechanisms ......................... <a href="#page-5">5</a>
26 <a href="#section-3.4">3.4</a> Relationship to a Chassis MIB ............................ <a href="#page-5">5</a>
27 <a href="#section-3.5">3.5</a> Relationship to the Interfaces MIB ....................... <a href="#page-6">6</a>
28 <a href="#section-3.6">3.6</a> Relationship to the Other MIBs ........................... <a href="#page-6">6</a>
29 <a href="#section-3.7">3.7</a> Relationship to Naming Scopes ............................ <a href="#page-6">6</a>
30 <a href="#section-3.8">3.8</a> Multiple Instances of the Entity MIB ..................... <a href="#page-7">7</a>
31 <a href="#section-3.9">3.9</a> Re-Configuration of Entities ............................. <a href="#page-7">7</a>
32 <a href="#section-3.10">3.10</a> MIB Structure ........................................... <a href="#page-7">7</a>
33 <a href="#section-3.10.1">3.10.1</a> entityPhysical Group .................................. <a href="#page-8">8</a>
34 <a href="#section-3.10.2">3.10.2</a> entityLogical Group ................................... <a href="#page-8">8</a>
35 <a href="#section-3.10.3">3.10.3</a> entityMapping Group ................................... <a href="#page-8">8</a>
36 <a href="#section-3.10.4">3.10.4</a> entityGeneral Group ................................... <a href="#page-9">9</a>
37 <a href="#section-3.10.5">3.10.5</a> entityNotifications Group ............................. <a href="#page-9">9</a>
38 <a href="#section-3.11">3.11</a> Multiple Agents ......................................... <a href="#page-9">9</a>
39 <a href="#section-4">4</a>. Definitions ............................................... <a href="#page-10">10</a>
40 <a href="#section-5">5</a>. Usage Examples ............................................ <a href="#page-26">26</a>
41 <a href="#section-5.1">5.1</a> Router/Bridge ............................................ <a href="#page-26">26</a>
42 <a href="#section-5.2">5.2</a> Repeaters ................................................ <a href="#page-30">30</a>
43 <a href="#section-6">6</a>. Acknowledgements .......................................... <a href="#page-33">33</a>
44 <a href="#section-7">7</a>. References ................................................ <a href="#page-34">34</a>
45 <a href="#section-8">8</a>. Security Considerations ................................... <a href="#page-35">35</a>
46 <a href="#section-9">9</a>. Authors' Addresses ........................................ <a href="#page-35">35</a>
47
48
49
50
51
52 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
55
56
57 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
58
59 This memo defines a portion of the Management Information Base (MIB)
60 for use with network management protocols in the Internet community.
61 In particular, it describes managed objects used for managing
62 multiple logical and physical entities managed by a single SNMP
63 agent.
64
65 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. The SNMP Network Management Framework</span>
66
67 The SNMP Network Management Framework presently consists of three
68 major components. They are:
69
70 o the SMI, described in <a href="./rfc1902">RFC 1902</a> [<a href="#ref-1" title="&quot;Structure of Management Information for version 2 of the Simple Network Management Protocol (SNMPv2)&quot;">1</a>], - the mechanisms used for
71 describing and naming objects for the purpose of management.
72
73 o the MIB-II, STD 17, <a href="./rfc1213">RFC 1213</a> [<a href="#ref-2" title="&quot;Management Information Base for Network Management of TCP/IP-based internets: MIB-II&quot;">2</a>], - the core set of managed
74 objects for the Internet suite of protocols.
75
76 o the protocol, <a href="./rfc1157">RFC 1157</a> [<a href="#ref-6" title="&quot;Simple Network Management Protocol&quot;">6</a>] and/or <a href="./rfc1905">RFC 1905</a> [<a href="#ref-4" title="&quot;Protocol Operations for version 2 of the Simple Network Management Protocol (SNMPv2)&quot;">4</a>], - the protocol
77 for accessing managed information.
78
79 Textual conventions are defined in <a href="./rfc1903">RFC 1903</a> [<a href="#ref-3" title="&quot;Textual Conventions for version 2 of the Simple Network Management Protocol (SNMPv2)&quot;">3</a>], and conformance
80 statements are defined in <a href="./rfc1904">RFC 1904</a> [<a href="#ref-5" title="&quot;Conformance Statements for version 2 of the Simple Network Management Protocol (SNMPv2)&quot;">5</a>].
81
82 The Framework permits new objects to be defined for the purpose of
83 experimentation and evaluation.
84
85 This memo specifies a MIB module that is compliant to the SNMPv2 SMI.
86 A semantically identical MIB conforming to the SNMPv1 SMI can be
87 produced through the appropriate translation.
88
89 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Object Definitions</span>
90
91 Managed objects are accessed via a virtual information store, termed
92 the Management Information Base or MIB. Objects in the MIB are
93 defined using the subset of Abstract Syntax Notation One (ASN.1)
94 defined in the SMI. In particular, each object type is named by an
95 OBJECT IDENTIFIER, an administratively assigned name. The object
96 type together with an object instance serves to uniquely identify a
97 specific instantiation of the object. For human convenience, we
98 often use a textual string, termed the descriptor, to refer to the
99 object type.
100
101
102
103
104
105
106
107
108 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
111
112
113 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Overview</span>
114
115 There is a need for a standardized way of representing a single agent
116 which supports multiple instances of one MIB. This is presently true
117 for at least 3 standard MIBs, and is likely to become true for more
118 and more MIBs as time passes. For example:
119
120 - multiple instances of a bridge supported within a single
121 device having a single agent;
122
123 - multiple repeaters supported by a single agent;
124
125 - multiple OSPF backbone areas, each one operating as part
126 of its own Autonomous System, and each identified by the
127 same area-id (e.g., 0.0.0.0), supported inside a single
128 router with one agent.
129
130 The fact that it is a single agent in each of these cases implies
131 there is some relationship which binds all of these entities
132 together. Effectively, there is some "overall" physical entity which
133 houses the sum of the things managed by that one agent, i.e., there
134 are multiple "logical" entities within a single physical entity.
135 Sometimes, the overall physical entity contains multiple (smaller)
136 physical entities and each logical entity is associated with a
137 particular physical entity. Sometimes, the overall physical entity
138 is a "compound" of multiple physical entities (e.g., a stack of
139 stackable hubs).
140
141 What is needed is a way to determine exactly what logical entities
142 are managed by the agent (either by SNMPv1 or SNMPv2), and thereby to
143 be able to communicate with the agent about a particular logical
144 entity. When different logical entities are associated with
145 different physical entities within the overall physical entity, it is
146 also useful to be able to use this information to distinguish between
147 logical entities.
148
149 In these situations, there is no need for varbinds for multiple
150 logical entities to be referenced in the same SNMP message (although
151 that might be useful in the future). Rather, it is sufficient, and
152 in some situations preferable, to have the context/community in the
153 message identify the logical entity to which the varbinds apply.
154
155
156
157
158
159
160
161
162
163
164 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
167
168
169 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Terms</span>
170
171 Some new terms are used throughout this document:
172
173 - Naming Scope
174 A "naming scope" represents the set of information that may be
175 potentially accessed through a single SNMP operation. All instances
176 within the naming scope share the same unique identifier space. For
177 SNMPv1, a naming scope is identified by the value of the associated
178 'entLogicalCommunity' instance.
179
180 - Multi-Scoped Object
181 A MIB object, for which identical instance values identify
182 different managed information in different naming scopes, is called
183 a "multi-scoped" MIB object.
184
185 - Single-Scoped Object
186 A MIB object, for which identical instance values identify the same
187 managed information in different naming scopes, is called a
188 "single-scoped" MIB object.
189
190 - Logical Entity
191 A managed system contains one or more logical entities, each
192 represented by at most one instantiation of each of a particular
193 set of MIB objects. A set of management functions is associated
194 with each logical entity. Examples of logical entities include
195 routers, bridges, print-servers, etc.
196
197 - Physical Entity
198 A "physical entity" or "physical component" represents an
199 identifiable physical resource within a managed system. Zero or
200 more logical entities may utilize a physical resource at any given
201 time. It is an implementation-specific manner as to which physical
202 components are represented by an agent in the EntPhysicalTable.
203 Typically, physical resources (e.g. communications ports,
204 backplanes, sensors, daughter-cards, power supplies, the overall
205 chassis) which can be managed via functions associated with one or
206 more logical entities are included in the MIB.
207
208 - Containment Tree
209 Each physical component may optionally be modeled as 'contained'
210 within another physical component. A "containment-tree" is the
211 conceptual sequence of entPhysicalIndex values which uniquely
212 specifies the exact physical location of a physical component
213 within the managed system. It is generated by 'following and
214 recording' each 'entPhysicalContainedIn' instance 'up the tree
215 towards the root', until a value of zero indicating no further
216 containment is found.
217
218
219
220 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
223
224
225 Note that chassis slots, which are capable of accepting one or more
226 module types from one or more vendors, are modeled as containers in
227 this MIB. The value of entPhysicalContainedIn for a particular
228 'module' entity (entPhysicalClass value of 'module(9)') must be
229 equal to an entPhysicalIndex that represents the parent 'container'
230 entity (associated entPhysicalClass value of ('container(5)'). An
231 agent must represent both empty and full containers in the
232 entPhysicalTable.
233
234 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Relationship to Community Strings</span>
235
236 For community-based SNMP, distinguishing between different logical
237 entities is one (but not the only) purpose of the community string
238 [<a href="#ref-6" title="&quot;Simple Network Management Protocol&quot;">6</a>]. This is accommodated by representing each community string as a
239 logical entity.
240
241 Note that different logical entities may share the same naming scope
242 (and therefore the same values of entLogicalCommunity). This is
243 possible, providing they have no need for the same instance of a MIB
244 object to represent different managed information.
245
246 <span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Relationship to Proxy Mechanisms</span>
247
248 The Entity MIB is designed to allow functional component discovery.
249 The administrative relationships between different logical entities
250 are not visible in any Entity MIB tables. An NMS cannot determine
251 whether MIB instances in different naming scopes are realized locally
252 or remotely (e.g. via some proxy mechanism) by examining any
253 particular Entity MIB objects.
254
255 The management of administrative framework functions is not an
256 explicit goal of the Entity MIB WG at this time. This new area of
257 functionality may be revisited after some operational experience with
258 the Entity MIB is gained.
259
260 Note that a network administrator will likely be able to associate
261 community strings with naming scopes with proprietary mechanisms, as
262 a matter of configuration. There are no mechanisms for managing
263 naming scopes defined in this MIB.
264
265 <span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Relationship to a Chassis MIB</span>
266
267 Some readers may recall that a previous IETF working group attempted
268 to define a Chassis MIB. No consensus was reached by that working
269 group, possibly because its scope was too broad. As such, it is not
270 the purpose of this MIB to be a "Chassis MIB replacement", nor is it
271 within the scope of this MIB to contain all the information which
272 might be necessary to manage a "chassis". On the other hand, the
273
274
275
276 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
279
280
281 entities represented by an implementation of this MIB might well be
282 contained in a chassis.
283
284 <span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. Relationship to the Interfaces MIB</span>
285
286 The Entity MIB contains a mapping table identifying physical
287 components that have 'external values' (e.g. ifIndex) associated with
288 them within a given naming scope. This table can be used to identify
289 the physical location of each interface in the ifTable [<a href="#ref-7" title="&quot;Interfaces Group Evolution&quot;">7</a>]. Since
290 ifIndex values in different contexts are not related to one another,
291 the interface to physical component associations are relative to the
292 same logical entity within the agent.
293
294 The Entity MIB also contains an 'entPhysicalName' object, which
295 approximates the semantics of the ifName object from the Interfaces
296 MIB [<a href="#ref-7" title="&quot;Interfaces Group Evolution&quot;">7</a>] for all types of physical components.
297
298 <span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. Relationship to the Other MIBs</span>
299
300 The Entity MIB contains a mapping table identifying physical
301 components that have identifiers from other standard MIBs associated
302 with them. For example, this table can be used along with the
303 physical mapping table to identify the physical location of each
304 repeater port in the rptrPortTable, or each interface in the ifTable.
305
306 <span class="h3"><a class="selflink" id="section-3.7" href="#section-3.7">3.7</a>. Relationship to Naming Scopes</span>
307
308 There is some question as to which MIB objects may be returned within
309 a given naming scope. MIB objects which are not multi-scoped within a
310 managed system are likely to ignore context information in
311 implementation. In such a case, it is likely such objects will be
312 returned in all naming scopes (e.g. not just the 'main' naming
313 scope).
314
315 For example, a community string used to access the management
316 information for logical device 'bridge2' may allow access to all the
317 non-bridge related objects in the 'main' naming scope, as well as a
318 second instance of the Bridge MIB.
319
320 It is an implementation-specific matter as to the isolation of
321 single-scoped MIB objects by the agent. An agent may wish to limit
322 the objects returned in a particular naming scope to just the multi-
323 scoped objects in that naming scope (e.g. system group and the Bridge
324 MIB). In this case, all single-scoped management information would
325 belong to a common naming scope (e.g. 'main'), which itself may
326 contain some multi-scoped objects (e.g. system group).
327
328
329
330
331
332 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
335
336
337 <span class="h3"><a class="selflink" id="section-3.8" href="#section-3.8">3.8</a>. Multiple Instances of the Entity MIB</span>
338
339 It is possible that more than one agent exists in a managed system,
340 and in such cases, multiple instances of the Entity MIB (representing
341 the same managed objects) may be available to an NMS.
342
343 In order to reduce complexity for agent implementation, multiple
344 instances of the Entity MIB are not required to be equivalent or even
345 consistent. An NMS may be able to 'align' instances returned by
346 different agents by examining the columns of each table, but vendor-
347 specific identifiers and (especially) index values are likely to be
348 different. Each agent may be managing different subsets of the entire
349 chassis as well.
350
351 When all of a physically-modular device is represented by a single
352 agent, the entry for which entPhysicalContainedIn has the value zero
353 would likely have 'chassis' as the value of its entPhysicalClass;
354 alternatively, for an agent on a module where the agent represents
355 only the physical entities on that module (not those on other
356 modules), the entry for which entPhysicalContainedIn has the value
357 zero would likely have 'module' as the value of its entPhysicalClass.
358
359 An agent implementation of the entLogicalTable is not required to
360 contain information about logical entities managed primarily by other
361 agents. That is, the entLogicalTAddress and entLogicalTDomain objects
362 in the entLogicalTable are provided to support an historical
363 multiplexing mechanism, not to identify other SNMP agents.
364
365 Note that the Entity MIB is a single-scoped MIB, in the event an
366 agent represents the MIB in different naming scopes.
367
368 <span class="h3"><a class="selflink" id="section-3.9" href="#section-3.9">3.9</a>. Re-Configuration of Entities</span>
369
370 All the MIB objects defined in this MIB have at most a read-only
371 MAX-ACCESS clause, i.e., none are write-able. This is a conscious
372 decision by the working group to limit this MIB's scope. It is
373 possible that this restriction could be lifted after implementation
374 experience, by means of additional tables (using the AUGMENTS clause)
375 for configuration and extended entity information.
376
377 <span class="h3"><a class="selflink" id="section-3.10" href="#section-3.10">3.10</a>. MIB Structure</span>
378
379 The Entity MIB contains five conformance groups:
380
381 - entityPhysical group
382 Describes the physical entities managed by a single agent.
383
384
385
386
387
388 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
391
392
393 - entityLogical group
394 Describes the logical entities managed by a single agent.
395
396 - entityMapping group
397 Describes the associations between the physical entities,
398 logical entities, interfaces, and non-interface ports managed
399 by a single agent.
400
401 -entityGeneral group
402 Describes general system attributes shared by potentially
403 all types of entities managed by a single agent.
404
405 -entityNotifications group
406 Contains status indication notifications.
407
408 <span class="h4"><a class="selflink" id="section-3.10.1" href="#section-3.10.1">3.10.1</a>. entityPhysical Group</span>
409
410 This group contains a single table to identify physical system
411 components, called the entPhysicalTable.
412
413 The entPhysicalTable contains one row per physical entity, and must
414 always contains at least one row for an "overall" physical entity.
415 Each row is indexed by an arbitrary, small integer, and contains a
416 description and type of the physical entity. It also optionally
417 contains the index number of another entPhysicalEntry indicating a
418 containment relationship between the two.
419
420 <span class="h4"><a class="selflink" id="section-3.10.2" href="#section-3.10.2">3.10.2</a>. entityLogical Group</span>
421
422 This group contains a single table to identify logical entities,
423 called the entLogicalTable.
424
425 The entLogicalTable contains one row per logical entity. Each row is
426 indexed by an arbitrary, small integer and contains a name,
427 description, and type of the logical entity. It also contains
428 information to allow SNMPv1 or SNMPv2C [<a href="#ref-9" title="&quot;Introduction to Community-based SNMPv2&quot;">9</a>] access to the MIB
429 information for the logical entity.
430
431 <span class="h4"><a class="selflink" id="section-3.10.3" href="#section-3.10.3">3.10.3</a>. entityMapping Group</span>
432
433 This group contains a three tables to identify associations between
434 different system components.
435
436 The entLPMappingTable contains mappings between entLogicalIndex
437 values (logical entities) and entPhysicalIndex values (the physical
438 components supporting that entity). A logical entity can map to more
439 than one physical component, and more than one logical entity can map
440 to (share) the same physical component.
441
442
443
444 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
447
448
449 The entAliasMappingTable contains mappings between entLogicalIndex,
450 entPhysicalIndex pairs and 'alias' object identifier values. This
451 allows resources managed with other MIBs (e.g. repeater ports, bridge
452 ports, physical and logical interfaces) to be identified in the
453 physical entity hierarchy. Note that each alias identifier is only
454 relevant in a particular naming scope.
455
456
457 The entPhysicalContainsTable contains simple mappings between
458 'entPhysicalContainedIn' values for each container/containee
459 relationship in the managed system. The indexing of this table allows
460 an NMS to quickly discover the 'entPhysicalIndex' values for all
461 children of a given physical entity.
462
463 <span class="h4"><a class="selflink" id="section-3.10.4" href="#section-3.10.4">3.10.4</a>. entityGeneral Group</span>
464
465 This group contains general information relating to the other object
466 groups.
467
468 At this time, the entGeneral group contains a single scalar object
469 (entLastChangeTime), which represents the value of sysUptime when any
470 part of the system configuration last changed.
471
472 <span class="h4"><a class="selflink" id="section-3.10.5" href="#section-3.10.5">3.10.5</a>. entityNotifications Group</span>
473
474 This group contains notification definitions relating to the overall
475 status of the Entity MIB instantiation.
476
477 <span class="h3"><a class="selflink" id="section-3.11" href="#section-3.11">3.11</a>. Multiple Agents</span>
478
479 Even though a primary motivation for this MIB is to represent the
480 multiple logical entities supported by a single agent, it is also
481 possible to use it to represent multiple logical entities supported
482 by multiple agents (in the same "overall" physical entity). Indeed,
483 it is implicit in the SNMP architecture, that the number of agents is
484 transparent to a network management station.
485
486 However, there is no agreement at this time as to the degree of
487 cooperation which should be expected for agent implementations.
488 Therefore, multiple agents within the same managed system are free to
489 implement the Entity MIB independently. (Refer the section on
490 "Multiple Instances of the Entity MIB" for more details).
491
492
493
494
495
496
497
498
499
500 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
503
504
505 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Definitions</span>
506
507 ENTITY-MIB DEFINITIONS ::= BEGIN
508
509 IMPORTS
510 MODULE-IDENTITY, OBJECT-TYPE,
511 mib-2, NOTIFICATION-TYPE
512 FROM SNMPv2-SMI
513 TDomain, TAddress, DisplayString, TEXTUAL-CONVENTION,
514 AutonomousType, RowPointer, TimeStamp
515 FROM SNMPv2-TC
516 MODULE-COMPLIANCE, OBJECT-GROUP
517 FROM SNMPv2-CONF;
518
519 entityMIB MODULE-IDENTITY
520 LAST-UPDATED "9605160000Z"
521 ORGANIZATION "IETF ENTMIB Working Group"
522 CONTACT-INFO
523 " WG E-mail: [email protected]
524 Subscribe: [email protected]
525 msg body: subscribe entmib
526
527 Keith McCloghrie
528 ENTMIB Working Group Chair
529 Cisco Systems Inc.
530 170 West Tasman Drive
531 San Jose, CA 95134
532 408-526-5260
533 [email protected]
534
535 Andy Bierman
536 ENTMIB Working Group Editor
537 Cisco Systems Inc.
538 170 West Tasman Drive
539 San Jose, CA 95134
540 408-527-3711
541 [email protected]"
542 DESCRIPTION
543 "The MIB module for representing multiple logical
544 entities supported by a single SNMP agent."
545 ::= { mib-2 47 }
546
547 entityMIBObjects OBJECT IDENTIFIER ::= { entityMIB 1 }
548
549 -- MIB contains four groups
550
551 entityPhysical OBJECT IDENTIFIER ::= { entityMIBObjects 1 }
552 entityLogical OBJECT IDENTIFIER ::= { entityMIBObjects 2 }
553
554
555
556 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
559
560
561 entityMapping OBJECT IDENTIFIER ::= { entityMIBObjects 3 }
562 entityGeneral OBJECT IDENTIFIER ::= { entityMIBObjects 4 }
563
564
565 -- Textual Conventions
566 PhysicalIndex ::= TEXTUAL-CONVENTION
567 STATUS current
568 DESCRIPTION
569 "An arbitrary value which uniquely identifies the physical
570 entity. The value is a small positive integer; index values
571 for different physical entities are not necessarily
572 contiguous."
573 SYNTAX INTEGER (1..2147483647)
574
575
576 PhysicalClass ::= TEXTUAL-CONVENTION
577 STATUS current
578 DESCRIPTION
579 "An enumerated value which provides an indication of the
580 general hardware type of a particular physical entity."
581 SYNTAX INTEGER {
582 other(1),
583 unknown(2),
584 chassis(3),
585 backplane(4),
586 container(5), -- e.g. slot or daughter-card holder
587 powerSupply(6),
588 fan(7),
589 sensor(8),
590 module(9), -- e.g. plug-in card or daughter-card
591 port(10)
592 }
593
594 -- The Physical Entity Table
595
596 entPhysicalTable OBJECT-TYPE
597 SYNTAX SEQUENCE OF EntPhysicalEntry
598 MAX-ACCESS not-accessible
599 STATUS current
600 DESCRIPTION
601 "This table contains one row per physical entity. There is
602 always at least one row for an 'overall' physical entity."
603 ::= { entityPhysical 1 }
604
605 entPhysicalEntry OBJECT-TYPE
606 SYNTAX EntPhysicalEntry
607 MAX-ACCESS not-accessible
608 STATUS current
609
610
611
612 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
615
616
617 DESCRIPTION
618 "Information about a particular physical entity.
619
620 Each entry provides objects (entPhysicalDescr,
621 entPhysicalVendorType, and entPhysicalClass) to help an NMS
622 identify and characterize the entry, and objects
623 (entPhysicalContainedIn and entPhysicalParentRelPos) to help
624 an NMS relate the particular entry to other entries in this
625 table."
626 INDEX { entPhysicalIndex }
627 ::= { entPhysicalTable 1 }
628
629 EntPhysicalEntry ::= SEQUENCE {
630 entPhysicalIndex PhysicalIndex,
631 entPhysicalDescr DisplayString,
632 entPhysicalVendorType AutonomousType,
633 entPhysicalContainedIn INTEGER,
634 entPhysicalClass PhysicalClass,
635 entPhysicalParentRelPos INTEGER,
636 entPhysicalName DisplayString
637 }
638
639 entPhysicalIndex OBJECT-TYPE
640 SYNTAX PhysicalIndex
641 MAX-ACCESS not-accessible
642 STATUS current
643 DESCRIPTION
644 "The index for this entry."
645 ::= { entPhysicalEntry 1 }
646
647 entPhysicalDescr OBJECT-TYPE
648 SYNTAX DisplayString
649 MAX-ACCESS read-only
650 STATUS current
651 DESCRIPTION
652 "A textual description of physical entity. This object
653 should contain a string which identifies the manufacturer's
654 name for the physical entity, and should be set to a
655 distinct value for each version or model of the physical
656 entity. "
657 ::= { entPhysicalEntry 2 }
658
659 entPhysicalVendorType OBJECT-TYPE
660 SYNTAX AutonomousType
661 MAX-ACCESS read-only
662 STATUS current
663 DESCRIPTION
664 "An indication of the vendor-specific hardware type of the
665
666
667
668 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
671
672
673 physical entity. Note that this is different from the
674 definition of MIB-II's sysObjectID.
675
676 An agent should set this object to a enterprise-specific
677 registration identifier value indicating the specific
678 equipment type in detail. The associated instance of
679 entPhysicalClass is used to indicate the general type of
680 hardware device.
681
682 If no vendor-specific registration identifier exists for
683 this physical entity, or the value is unknown by this agent,
684 then the value { 0 0 } is returned."
685 ::= { entPhysicalEntry 3 }
686
687 entPhysicalContainedIn OBJECT-TYPE
688 SYNTAX INTEGER (0..2147483647)
689 MAX-ACCESS read-only
690 STATUS current
691 DESCRIPTION
692 "The value of entPhysicalIndex for the physical entity which
693 'contains' this physical entity. A value of zero indicates
694 this physical entity is not contained in any other physical
695 entity. Note that the set of 'containment' relationships
696 define a strict hierarchy; that is, recursion is not
697 allowed."
698 ::= { entPhysicalEntry 4 }
699
700 entPhysicalClass OBJECT-TYPE
701 SYNTAX PhysicalClass
702 MAX-ACCESS read-only
703 STATUS current
704 DESCRIPTION
705 "An indication of the general hardware type of the physical
706 entity.
707
708 An agent should set this object to the standard enumeration
709 value which most accurately indicates the general class of
710 the physical entity, or the primary class if there is more
711 than one.
712
713 If no appropriate standard registration identifier exists
714 for this physical entity, then the value 'other(1)' is
715 returned. If the value is unknown by this agent, then the
716 value 'unknown(2)' is returned."
717 ::= { entPhysicalEntry 5 }
718
719 entPhysicalParentRelPos OBJECT-TYPE
720 SYNTAX INTEGER (-1..2147483647)
721
722
723
724 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
727
728
729 MAX-ACCESS read-only
730 STATUS current
731 DESCRIPTION
732 "An indication of the relative position of this 'child'
733 component among all its 'sibling' components. Sibling
734 components are defined as entPhysicalEntries which share the
735 same instance values of each of the entPhysicalContainedIn
736 and entPhysicalClass objects.
737
738 An NMS can use this object to identify the relative ordering
739 for all sibling components of a particular parent
740 (identified by the entPhysicalContainedIn instance in each
741 sibling entry).
742
743 This value should match any external labeling of the
744 physical component if possible. For example, for a module
745 labeled as 'card #3', entPhysicalParentRelPos should have
746 the value '3'.
747
748 If the physical position of this component does not match
749 any external numbering or clearly visible ordering, then
750 user documentation or other external reference material
751 should be used to determine the parent-relative position. If
752 this is not possible, then the the agent should assign a
753 consistent (but possibly arbitrary) ordering to a given set
754 of 'sibling' components, perhaps based on internal
755 representation of the components.
756
757 If the agent cannot determine the parent-relative position
758 for some reason, or if the associated value of
759 entPhysicalContainedIn is '0', then the value '-1' is
760 returned. Otherwise a non-negative integer is returned,
761 indicating the parent-relative position of this physical
762 entity.
763
764 Parent-relative ordering normally starts from '1' and
765 continues to 'N', where 'N' represents the highest
766 positioned child entity. However, if the physical entities
767 (e.g. slots) are labeled from a starting position of zero,
768 then the first sibling should be associated with a
769 entPhysicalParentRelPos value of '0'. Note that this
770 ordering may be sparse or dense, depending on agent
771 implementation.
772
773 The actual values returned are not globally meaningful, as
774 each 'parent' component may use different numbering
775 algorithms. The ordering is only meaningful among siblings
776 of the same parent component.
777
778
779
780 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
783
784
785 The agent should retain parent-relative position values
786 across reboots, either through algorithmic assignment or use
787 of non-volatile storage."
788 ::= { entPhysicalEntry 6 }
789
790
791 entPhysicalName OBJECT-TYPE
792 SYNTAX DisplayString
793 MAX-ACCESS read-only
794 STATUS current
795 DESCRIPTION
796 "The textual name of the physical entity. The value of this
797 object should be the name of the component as assigned by
798 the local device and should be suitable for use in commands
799 entered at the device's `console'. This might be a text
800 name, such as `console' or a simple component number (e.g.
801 port or module number), such as `1', depending on the
802 physical component naming syntax of the device.
803
804 If there is no local name, or this object is otherwise not
805 applicable, then this object contains a zero-length string.
806
807 Note that the value of entPhysicalName for two physical
808 entities will be the same in the event that the console
809 interface does not distinguish between them, e.g., slot-1
810 and the card in slot-1."
811 ::= { entPhysicalEntry 7 }
812
813 -- The Logical Entity Table
814 entLogicalTable OBJECT-TYPE
815 SYNTAX SEQUENCE OF EntLogicalEntry
816 MAX-ACCESS not-accessible
817 STATUS current
818 DESCRIPTION
819 "This table contains one row per logical entity. At least
820 one entry must exist."
821 ::= { entityLogical 1 }
822
823 entLogicalEntry OBJECT-TYPE
824 SYNTAX EntLogicalEntry
825 MAX-ACCESS not-accessible
826 STATUS current
827 DESCRIPTION
828 "Information about a particular logical entity. Entities
829 may be managed by this agent or other SNMP agents (possibly)
830 in the same chassis."
831 INDEX { entLogicalIndex }
832 ::= { entLogicalTable 1 }
833
834
835
836 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
839
840
841 EntLogicalEntry ::= SEQUENCE {
842 entLogicalIndex INTEGER,
843 entLogicalDescr DisplayString,
844 entLogicalType AutonomousType,
845 entLogicalCommunity OCTET STRING,
846 entLogicalTAddress TAddress,
847 entLogicalTDomain TDomain
848 }
849
850 entLogicalIndex OBJECT-TYPE
851 SYNTAX INTEGER (1..2147483647)
852 MAX-ACCESS not-accessible
853 STATUS current
854 DESCRIPTION
855 "The value of this object uniquely identifies the logical
856 entity. The value is a small positive integer; index values
857 for different logical entities are are not necessarily
858 contiguous."
859 ::= { entLogicalEntry 1 }
860
861 entLogicalDescr OBJECT-TYPE
862 SYNTAX DisplayString
863 MAX-ACCESS read-only
864 STATUS current
865 DESCRIPTION
866 "A textual description of the logical entity. This object
867 should contain a string which identifies the manufacturer's
868 name for the logical entity, and should be set to a distinct
869 value for each version of the logical entity. "
870 ::= { entLogicalEntry 2 }
871
872 entLogicalType OBJECT-TYPE
873 SYNTAX AutonomousType
874 MAX-ACCESS read-only
875 STATUS current
876 DESCRIPTION
877 "An indication of the type of logical entity. This will
878 typically be the OBJECT IDENTIFIER name of the node in the
879 SMI's naming hierarchy which represents the major MIB
880 module, or the majority of the MIB modules, supported by the
881 logical entity. For example:
882 a logical entity of a regular host/router -&gt; mib-2
883 a logical entity of a 802.1d bridge -&gt; dot1dBridge
884 a logical entity of a 802.3 repeater -&gt; snmpDot3RptrMgmt
885 If an appropriate node in the SMI's naming hierarchy cannot
886 be identified, the value 'mib-2' should be used."
887 ::= { entLogicalEntry 3 }
888
889
890
891
892 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
895
896
897 entLogicalCommunity OBJECT-TYPE
898 SYNTAX OCTET STRING (SIZE (1..255))
899 MAX-ACCESS read-only
900 STATUS current
901 DESCRIPTION
902 "An SNMPv1 or SNMPv2C community-string which can be used to
903 access detailed management information for this logical
904 entity. The agent should allow read access with this
905 community string (to an appropriate subset of all managed
906 objects) and may also choose to return a community string
907 based on the privileges of the request used to read this
908 object. Note that an agent may choose to return a community
909 string with read-only privileges, even if this object is
910 accessed with a read-write community string. However, the
911 agent must take care not to return a community string which
912 allows more privileges than the community string used to
913 access this object.
914
915 A compliant SNMP agent may wish to conserve naming scopes by
916 representing multiple logical entities in a single 'main'
917 naming scope. This is possible when the logical entities
918 represented by the same value of entLogicalCommunity have no
919 object instances in common. For example, 'bridge1' and
920 'repeater1' may be part of the main naming scope, but at
921 least one additional community string is needed to represent
922 'bridge2' and 'repeater2'.
923
924 Logical entities 'bridge1' and 'repeater1' would be
925 represented by sysOREntries associated with the 'main'
926 naming scope.
927
928 For agents not accessible via SNMPv1 or SNMPv2C, the value
929 of this object is the empty-string."
930 ::= { entLogicalEntry 4 }
931
932 entLogicalTAddress OBJECT-TYPE
933 SYNTAX TAddress
934 MAX-ACCESS read-only
935 STATUS current
936 DESCRIPTION
937 "The transport service address by which the logical entity
938 receives network management traffic, formatted according to
939 the corresponding value of entLogicalTDomain.
940
941 For snmpUDPDomain, a TAddress is 6 octets long, the initial
942 4 octets containing the IP-address in network-byte order and
943 the last 2 containing the UDP port in network-byte order.
944 Consult 'Transport Mappings for Version 2 of the Simple
945
946
947
948 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
951
952
953 Network Management Protocol' (<a href="./rfc1906">RFC 1906</a> [<a href="#ref-8" title="&quot;Transport Mappings for version 2 of the Simple Network Management Protocol (SNMPv2)&quot;">8</a>]) for further
954 information on snmpUDPDomain."
955 ::= { entLogicalEntry 5 }
956
957 entLogicalTDomain OBJECT-TYPE
958 SYNTAX TDomain
959 MAX-ACCESS read-only
960 STATUS current
961 DESCRIPTION
962 "Indicates the kind of transport service by which the
963 logical entity receives network management traffic.
964 Possible values for this object are presently found in the
965 Transport Mappings for SNMPv2 document (<a href="./rfc1906">RFC 1906</a> [<a href="#ref-8" title="&quot;Transport Mappings for version 2 of the Simple Network Management Protocol (SNMPv2)&quot;">8</a>])."
966 ::= { entLogicalEntry 6 }
967
968 entLPMappingTable OBJECT-TYPE
969 SYNTAX SEQUENCE OF EntLPMappingEntry
970 MAX-ACCESS not-accessible
971 STATUS current
972 DESCRIPTION
973 "This table contains zero or more rows of logical entity to
974 physical equipment associations. For each logical entity
975 known by this agent, there are zero or more mappings to the
976 physical resources which are used to realize that logical
977 entity.
978
979 An agent should limit the number and nature of entries in
980 this table such that only meaningful and non-redundant
981 information is returned. For example, in a system which
982 contains a single power supply, mappings between logical
983 entities and the power supply are not useful and should not
984 be included.
985
986 Also, only the most appropriate physical component which is
987 closest to the root of a particular containment tree should
988 be identified in an entLPMapping entry.
989
990 For example, suppose a bridge is realized on a particular
991 module, and all ports on that module are ports on this
992 bridge. A mapping between the bridge and the module would be
993 useful, but additional mappings between the bridge and each
994 of the ports on that module would be redundant (since the
995 entPhysicalContainedIn hierarchy can provide the same
996 information). If, on the other hand, more than one bridge
997 was utilizing ports on this module, then mappings between
998 each bridge and the ports it used would be appropriate.
999
1000 Also, in the case of a single backplane repeater, a mapping
1001
1002
1003
1004 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1007
1008
1009 for the backplane to the single repeater entity is not
1010 necessary."
1011 ::= { entityMapping 1 }
1012
1013 entLPMappingEntry OBJECT-TYPE
1014 SYNTAX EntLPMappingEntry
1015 MAX-ACCESS not-accessible
1016 STATUS current
1017 DESCRIPTION
1018 "Information about a particular logical entity to physical
1019 equipment association. Note that the nature of the
1020 association is not specifically identified in this entry. It
1021 is expected that sufficient information exists in the MIBs
1022 used to manage a particular logical entity to infer how
1023 physical component information is utilized."
1024 INDEX { entLogicalIndex, entLPPhysicalIndex }
1025 ::= { entLPMappingTable 1 }
1026
1027 EntLPMappingEntry ::= SEQUENCE {
1028 entLPPhysicalIndex PhysicalIndex
1029 }
1030
1031 entLPPhysicalIndex OBJECT-TYPE
1032 SYNTAX PhysicalIndex
1033 MAX-ACCESS read-only
1034 STATUS current
1035 DESCRIPTION
1036 "The value of this object identifies the index value of a
1037 particular entPhysicalEntry associated with the indicated
1038 entLogicalEntity."
1039 ::= { entLPMappingEntry 1 }
1040
1041 -- logical entity/component to alias table
1042 entAliasMappingTable OBJECT-TYPE
1043 SYNTAX SEQUENCE OF EntAliasMappingEntry
1044 MAX-ACCESS not-accessible
1045 STATUS current
1046 DESCRIPTION
1047 "This table contains zero or more rows, representing
1048 mappings of logical entity and physical component to
1049 external MIB identifiers. Each physical port in the system
1050 may be associated with a mapping to an external identifier,
1051 which itself is associated with a particular logical
1052 entity's naming scope. A 'wildcard' mechanism is provided to
1053 indicate that an identifier is associated with more than one
1054 logical entity."
1055 ::= { entityMapping 2 }
1056
1057
1058
1059
1060 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1063
1064
1065 entAliasMappingEntry OBJECT-TYPE
1066 SYNTAX EntAliasMappingEntry
1067 MAX-ACCESS not-accessible
1068 STATUS current
1069 DESCRIPTION
1070 "Information about a particular physical equipment, logical
1071 entity to external identifier binding. Each logical
1072 entity/physical component pair may be associated with one
1073 alias mapping. The logical entity index may also be used as
1074 a 'wildcard' (refer to the entAliasLogicalIndexOrZero object
1075 DESCRIPTION clause for details.)
1076
1077 Note that only entPhysicalIndex values which represent
1078 physical ports (i.e. associated entPhysicalClass value is
1079 'port(10)') are permitted to exist in this table."
1080 INDEX { entPhysicalIndex, entAliasLogicalIndexOrZero }
1081 ::= { entAliasMappingTable 1 }
1082
1083 EntAliasMappingEntry ::= SEQUENCE {
1084 entAliasLogicalIndexOrZero INTEGER,
1085 entAliasMappingIdentifier RowPointer
1086 }
1087
1088 entAliasLogicalIndexOrZero OBJECT-TYPE
1089 SYNTAX INTEGER (0..2147483647)
1090 MAX-ACCESS not-accessible
1091 STATUS current
1092 DESCRIPTION
1093 "The value of this object uniquely identifies the logical
1094 entity which defines the naming scope for the associated
1095 instance of the 'entAliasMappingIdentifier' object.
1096
1097 If this object has a non-zero value, then it identifies the
1098 logical entity named by the same value of entLogicalIndex.
1099
1100 If this object has a value of zero, then the mapping between
1101 the physical component and the alias identifier for this
1102 entAliasMapping entry is associated with all unspecified
1103 logical entities. That is, a value of zero (the default
1104 mapping) identifies any logical entity which does not have
1105 an explicit entry in this table for a particular
1106 entPhysicalIndex/entAliasMappingIdentifier pair.
1107
1108 For example, to indicate that a particular interface (e.g.
1109 physical component 33) is identified by the same value of
1110 ifIndex for all logical entities, the following instance
1111 might exist:
1112
1113
1114
1115
1116 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1119
1120
1121 entAliasMappingIdentifier.33.0 = ifIndex.5
1122
1123 In the event an entPhysicalEntry is associated differently
1124 for some logical entities, additional entAliasMapping
1125 entries may exist, e.g.:
1126
1127 entAliasMappingIdentifier.33.0 = ifIndex.6
1128 entAliasMappingIdentifier.33.4 = ifIndex.1
1129 entAliasMappingIdentifier.33.5 = ifIndex.1
1130 entAliasMappingIdentifier.33.10 = ifIndex.12
1131
1132 Note that entries with non-zero entAliasLogicalIndexOrZero
1133 index values have precedence over any zero-indexed entry. In
1134 this example, all logical entities except 4, 5, and 10,
1135 associate physical entity 33 with ifIndex.6."
1136 ::= { entAliasMappingEntry 1 }
1137
1138
1139 entAliasMappingIdentifier OBJECT-TYPE
1140 SYNTAX RowPointer
1141 MAX-ACCESS read-only
1142 STATUS current
1143 DESCRIPTION
1144 "The value of this object identifies a particular conceptual
1145 row associated with the indicated entPhysicalIndex and
1146 entLogicalIndex pair.
1147
1148 Since only physical ports are modeled in this table, only
1149 entries which represent interfaces or ports are allowed. If
1150 an ifEntry exists on behalf of a particular physical port,
1151 then this object should identify the associated 'ifEntry'.
1152 For repeater ports, the appropriate row in the
1153 'rptrPortGroupTable' should be identified instead.
1154
1155 For example, suppose a physical port was represented by
1156 entPhysicalEntry.3, entLogicalEntry.15 existed for a
1157 repeater, and entLogicalEntry.22 existed for a bridge. Then
1158 there might be two related instances of
1159 entAliasMappingIdentifier:
1160 entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2
1161 entAliasMappingIdentifier.3.22 == ifIndex.17
1162 It is possible that other mappings (besides interfaces and
1163 repeater ports) may be defined in the future, as required.
1164
1165 Bridge ports are identified by examining the Bridge MIB and
1166 appropriate ifEntries associated with each 'dot1dBasePort',
1167 and are thus not represented in this table."
1168 ::= { entAliasMappingEntry 2 }
1169
1170
1171
1172 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1175
1176
1177 -- physical mapping table
1178 entPhysicalContainsTable OBJECT-TYPE
1179 SYNTAX SEQUENCE OF EntPhysicalContainsEntry
1180 MAX-ACCESS not-accessible
1181 STATUS current
1182 DESCRIPTION
1183 "A table which exposes the container/containee relationships
1184 between physical entities. This table provides equivalent
1185 information found by constructing the virtual containment
1186 tree for a given entPhysicalTable but in a more direct
1187 format."
1188 ::= { entityMapping 3 }
1189
1190 entPhysicalContainsEntry OBJECT-TYPE
1191 SYNTAX EntPhysicalContainsEntry
1192 MAX-ACCESS not-accessible
1193 STATUS current
1194 DESCRIPTION
1195 "A single container/containee relationship."
1196 INDEX { entPhysicalIndex, entPhysicalChildIndex }
1197 ::= { entPhysicalContainsTable 1 }
1198
1199 EntPhysicalContainsEntry ::= SEQUENCE {
1200 entPhysicalChildIndex PhysicalIndex
1201 }
1202
1203 entPhysicalChildIndex OBJECT-TYPE
1204 SYNTAX PhysicalIndex
1205 MAX-ACCESS read-only
1206 STATUS current
1207 DESCRIPTION
1208 "The value of entPhysicalIndex for the contained physical
1209 entity."
1210 ::= { entPhysicalContainsEntry 1 }
1211
1212 -- last change time stamp for the whole MIB
1213 entLastChangeTime OBJECT-TYPE
1214 SYNTAX TimeStamp
1215 MAX-ACCESS read-only
1216 STATUS current
1217 DESCRIPTION
1218 "The value of sysUpTime at the time any of these events
1219 occur:
1220 * a conceptual row is created or deleted in any
1221 of these tables:
1222 - entPhysicalTable
1223 - entLogicalTable
1224 - entLPMappingTable
1225
1226
1227
1228 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1231
1232
1233 - entAliasMappingTable
1234 - entPhysicalContainsTable
1235
1236 * any instance in the following list of objects
1237 changes value:
1238 - entPhysicalDescr
1239 - entPhysicalVendorType
1240 - entPhysicalContainedIn
1241 - entPhysicalClass
1242 - entPhysicalParentRelPos
1243 - entPhysicalName
1244 - entLogicalDescr
1245 - entLogicalType
1246 - entLogicalCommunity
1247 - entLogicalTAddress
1248 - entLogicalTDomain
1249 - entAliasMappingIdentifier "
1250 ::= { entityGeneral 1 }
1251
1252 -- Entity MIB Trap Definitions
1253 entityMIBTraps OBJECT IDENTIFIER ::= { entityMIB 2 }
1254 entityMIBTrapPrefix OBJECT IDENTIFIER ::= { entityMIBTraps 0 }
1255
1256 entConfigChange NOTIFICATION-TYPE
1257 STATUS current
1258 DESCRIPTION
1259 "An entConfigChange trap is sent when the value of
1260 entLastChangeTime changes. It can be utilized by an NMS to
1261 trigger logical/physical entity table maintenance polls.
1262
1263 An agent must not generate more than one entConfigChange
1264 'trap-event' in a five second period, where a 'trap-event'
1265 is the transmission of a single trap PDU to a list of trap
1266 destinations. If additional configuration changes occur
1267 within the five second 'throttling' period, then these
1268 trap-events should be suppressed by the agent. An NMS should
1269 periodically check the value of entLastChangeTime to detect
1270 any missed entConfigChange trap-events, e.g. due to
1271 throttling or transmission loss."
1272 ::= { entityMIBTrapPrefix 1 }
1273
1274 -- conformance information
1275 entityConformance OBJECT IDENTIFIER ::= { entityMIB 3 }
1276
1277 entityCompliances OBJECT IDENTIFIER ::= { entityConformance 1 }
1278 entityGroups OBJECT IDENTIFIER ::= { entityConformance 2 }
1279
1280 -- compliance statements
1281
1282
1283
1284 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1287
1288
1289 entityCompliance MODULE-COMPLIANCE
1290 STATUS current
1291 DESCRIPTION
1292 "The compliance statement for SNMP entities which implement
1293 the Entity MIB."
1294 MODULE -- this module
1295 MANDATORY-GROUPS { entityPhysicalGroup,
1296 entityLogicalGroup,
1297 entityMappingGroup,
1298 entityGeneralGroup,
1299 entityNotificationsGroup }
1300 ::= { entityCompliances 1 }
1301
1302 -- MIB groupings
1303
1304 entityPhysicalGroup OBJECT-GROUP
1305 OBJECTS {
1306 entPhysicalDescr,
1307 entPhysicalVendorType,
1308 entPhysicalContainedIn,
1309 entPhysicalClass,
1310 entPhysicalParentRelPos,
1311 entPhysicalName
1312 }
1313 STATUS current
1314 DESCRIPTION
1315 "The collection of objects which are used to represent
1316 physical system components, for which a single agent
1317 provides management information."
1318 ::= { entityGroups 1 }
1319
1320 entityLogicalGroup OBJECT-GROUP
1321 OBJECTS {
1322 entLogicalDescr,
1323 entLogicalType,
1324 entLogicalCommunity,
1325 entLogicalTAddress,
1326 entLogicalTDomain
1327 }
1328 STATUS current
1329 DESCRIPTION
1330 "The collection of objects which are used to represent the
1331 list of logical entities for which a single agent provides
1332 management information."
1333 ::= { entityGroups 2 }
1334
1335 entityMappingGroup OBJECT-GROUP
1336 OBJECTS {
1337
1338
1339
1340 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1343
1344
1345 entLPPhysicalIndex,
1346 entAliasMappingIdentifier,
1347 entPhysicalChildIndex
1348 }
1349 STATUS current
1350 DESCRIPTION
1351 "The collection of objects which are used to represent the
1352 associations between multiple logical entities, physical
1353 components, interfaces, and port identifiers for which a
1354 single agent provides management information."
1355 ::= { entityGroups 3 }
1356
1357 entityGeneralGroup OBJECT-GROUP
1358 OBJECTS {
1359 entLastChangeTime
1360 }
1361 STATUS current
1362 DESCRIPTION
1363 "The collection of objects which are used to represent
1364 general entity information for which a single agent provides
1365 management information."
1366 ::= { entityGroups 4 }
1367
1368 entityNotificationsGroup NOTIFICATION-GROUP
1369 NOTIFICATIONS { entConfigChange }
1370 STATUS current
1371 DESCRIPTION
1372 "The collection of notifications used to indicate Entity MIB
1373 data consistency and general status information."
1374 ::= { entityGroups 5 }
1375
1376
1377 END
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1399
1400
1401 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Usage Examples</span>
1402
1403 The following sections iterate the instance values for two example
1404 networking devices. These examples are kept simple to make them more
1405 understandable. Auxiliary components, such as fans, sensors, empty
1406 slots, and sub-modules are not shown, but might be modeled in real
1407 implementations.
1408
1409 <span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Router/Bridge</span>
1410
1411 A router containing two slots. Each slot contains a 3 port
1412 router/bridge module. Each port is represented in the ifTable. There
1413 are two logical instances of OSPF running and two logical bridges:
1414
1415 Physical entities -- entPhysicalTable:
1416 1 Field-replaceable physical chassis:
1417 entPhysicalDescr.1 == "Acme Chassis Model 100"
1418 entPhysicalVendorType.1 == acmeProducts.chassisTypes.1
1419 entPhysicalContainedIn.1 == 0
1420 entPhysicalClass.1 == chassis(3)
1421 entPhysicalParentRelPos.1 == 0
1422 entPhysicalName.1 == '100-A'
1423
1424 2 slots within the chassis:
1425 entPhysicalDescr.2 == "Acme Chassis Slot Type AA"
1426 entPhysicalVendorType.2 == acmeProducts.slotTypes.1
1427 entPhysicalContainedIn.2 == 1
1428 entPhysicalClass.2 == container(5)
1429 entPhysicalParentRelPos.2 == 1
1430 entPhysicalName.2 == 'S1'
1431
1432 entPhysicalDescr.3 == "Acme Chassis Slot Type AA"
1433 entPhysicalVendorType.3 == acmeProducts.slotTypes.1
1434 entPhysicalContainedIn.3 == 1
1435 entPhysicalClass.3 == container(5)
1436 entPhysicalParentRelPos.3 == 2
1437 entPhysicalName.3 == 'S2'
1438
1439 2 Field-replaceable modules:
1440 Slot 1 contains a module with 3 ports:
1441 entPhysicalDescr.4 == "Acme Router-100"
1442 entPhysicalVendorType.4 == acmeProducts.moduleTypes.14
1443 entPhysicalContainedIn.4 == 2
1444 entPhysicalClass.4 == module(9)
1445 entPhysicalParentRelPos.4 == 1
1446 entPhysicalName.4 == 'M1'
1447
1448 entPhysicalDescr.5 == "Acme Ethernet-100 Port Rev G"
1449
1450
1451
1452 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1455
1456
1457 entPhysicalVendorType.5 == acmeProducts.portTypes.2
1458 entPhysicalContainedIn.5 == 4
1459 entPhysicalClass.5 == port(10)
1460 entPhysicalParentRelPos.5 == 1
1461 entPhysicalName.5 == 'P1'
1462
1463 entPhysicalDescr.6 == "Acme Ethernet-100 Port Rev G"
1464 entPhysicalVendorType.6 == acmeProducts.portTypes.2
1465 entPhysicalContainedIn.6 == 4
1466 entPhysicalClass.6 == port(10)
1467 entPhysicalParentRelPos.6 == 2
1468 entPhysicalName.6 == 'P2'
1469
1470 entPhysicalDescr.7 == "Acme Router-100 F-Port: Rev B"
1471 entPhysicalVendorType.7 == acmeProducts.portTypes.3
1472 entPhysicalContainedIn.7 == 4
1473 entPhysicalClass.7 == port(10)
1474 entPhysicalParentRelPos.7 == 3
1475 entPhysicalName.7 == 'P3'
1476
1477 Slot 2 contains another 3-port module:
1478 entPhysicalDescr.8 == "Acme Router-100 Comm Module: Rev C"
1479 entPhysicalVendorType.8 == acmeProducts.moduleTypes.15
1480 entPhysicalContainedIn.8 == 3
1481 entPhysicalClass.8 == module(9)
1482 entPhysicalParentRelPos.8 == 1
1483 entPhysicalName.8 == 'M2'
1484
1485 entPhysicalDescr.9 == "Acme Fddi-100 Port Rev CC"
1486 entPhysicalVendorType.9 == acmeProducts.portTypes.5
1487 entPhysicalContainedIn.9 == 8
1488 entPhysicalClass.9 == port(10)
1489 entPhysicalParentRelPos.9 == 1
1490 entPhysicalName.9 == 'FDDI Primary'
1491
1492 entPhysicalDescr.10 == "Acme Ethernet-100 Port Rev G"
1493 entPhysicalVendorType.10 == acmeProducts.portTypes.2
1494 entPhysicalContainedIn.10 == 8
1495 entPhysicalClass.10 == port(10)
1496 entPhysicalParentRelPos.10 == 2
1497 entPhysicalName.10 == 'Ethernet A'
1498
1499 entPhysicalDescr.11 == "Acme Ethernet-100 Port Rev G"
1500 entPhysicalVendorType.11 == acmeProducts.portTypes.2
1501 entPhysicalContainedIn.11 == 8
1502 entPhysicalClass.11 == port(10)
1503 entPhysicalParentRelPos.11 == 3
1504 entPhysicalName.11 == 'Ethernet B'
1505
1506
1507
1508 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1511
1512
1513 Logical entities -- entLogicalTable
1514 2 OSPF instances:
1515 entLogicalDescr.1 == "Acme OSPF v1.1"
1516 entLogicalType.1 == ospf
1517 entLogicalCommunity.1 == "public-ospf1"
1518 entLogicalTAddress.1 == 124.125.126.127:161
1519 entLogicalTDomain.1 == snmpUDPDomain
1520
1521 entLogicalDescr.2 == "Acme OSPF v1.1"
1522 entLogicalType.2 == ospf
1523 entLogicalCommunity.2 == "public-ospf2"
1524 entLogicalTAddress.2 == 124.125.126.127:161
1525 entLogicalTDomain.2 == snmpUDPDomain
1526
1527 2 logical bridges:
1528 entLogicalDescr.3 == "Acme Bridge v2.1.1"
1529 entLogicalType.3 == dod1dBridge
1530 entLogicalCommunity.3 == "public-bridge1"
1531 entLogicalTAddress.3 == 124.125.126.127:161
1532 entLogicalTDomain.3 == snmpUDPDomain
1533
1534 entLogicalDescr.4 == "Acme Bridge v2.1.1"
1535 entLogicalType.4 == dod1dBridge
1536 entLogicalCommunity.4 == "public-bridge2"
1537 entLogicalTAddress.4 == 124.125.126.127:161
1538 entLogicalTDomain.4 == snmpUDPDomain
1539
1540 Logical to Physical Mappings:
1541 1st OSPF instance: uses module 1-port 1
1542 entLPPhysicalIndex.1.5 == 5
1543
1544 2nd OSPF instance: uses module 2-port 1
1545 entLPPhysicalIndex.2.9 == 9
1546
1547 1st bridge group: uses module 1, all ports
1548
1549 [ed. -- Note that these mappings are included in the table since
1550 another logical entity (1st OSPF) utilizes one of the
1551 ports. If this were not the case, then a single mapping
1552 to the module (e.g. entLPPhysicalIndex.3.4) would be
1553 present instead. ]
1554 entLPPhysicalIndex.3.5 == 5
1555 entLPPhysicalIndex.3.6 == 6
1556 entLPPhysicalIndex.3.7 == 7
1557
1558 2nd bridge group: uses module 2, all ports
1559 entLPPhysicalIndex.4.9 == 9
1560 entLPPhysicalIndex.4.10 == 10
1561
1562
1563
1564 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1567
1568
1569 entLPPhysicalIndex.4.11 == 11
1570
1571 Physical to Logical to MIB Alias Mappings -- entAliasMappingTable:
1572 Example 1: ifIndex values are global to all logical entities
1573 entAliasMappingIdentifier.5.0 == ifIndex.1
1574 entAliasMappingIdentifier.6.0 == ifIndex.2
1575 entAliasMappingIdentifier.7.0 == ifIndex.3
1576 entAliasMappingIdentifier.9.0 == ifIndex.4
1577 entAliasMappingIdentifier.10.0 == ifIndex.5
1578 entAliasMappingIdentifier.11.0 == ifIndex.6
1579
1580 Example 2: ifIndex values are not shared by all logical entities
1581 entAliasMappingIdentifier.5.0 == ifIndex.1
1582 entAliasMappingIdentifier.5.3 == ifIndex.101
1583 entAliasMappingIdentifier.6.0 == ifIndex.2
1584 entAliasMappingIdentifier.6.3 == ifIndex.102
1585 entAliasMappingIdentifier.7.0 == ifIndex.3
1586 entAliasMappingIdentifier.7.3 == ifIndex.103
1587 entAliasMappingIdentifier.9.0 == ifIndex.4
1588 entAliasMappingIdentifier.9.3 == ifIndex.204
1589 entAliasMappingIdentifier.10.0 == ifIndex.5
1590 entAliasMappingIdentifier.10.3 == ifIndex.205
1591 entAliasMappingIdentifier.11.0 == ifIndex.6
1592 entAliasMappingIdentifier.11.3 == ifIndex.206
1593
1594 Physical Containment Tree -- entPhysicalContainsTable
1595 chassis has two containers:
1596 entPhysicalChildIndex.1.2 = 2
1597 entPhysicalChildIndex.1.3 = 3
1598
1599 container 1 has a module:
1600 entPhysicalChildIndex.2.4 = 4
1601
1602 container 2 has a module:
1603 entPhysicalChildIndex.3.8 = 8
1604
1605 module 1 has 3 ports:
1606 entPhysicalChildIndex.4.5 = 5
1607 entPhysicalChildIndex.4.6 = 6
1608 entPhysicalChildIndex.4.7 = 7
1609
1610 module 2 has 3 ports:
1611 entPhysicalChildIndex.8.9 = 9
1612 entPhysicalChildIndex.8.10 = 10
1613 entPhysicalChildIndex.1.11 = 11
1614
1615
1616
1617
1618
1619
1620 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1623
1624
1625 <span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Repeaters</span>
1626
1627 A 3-slot Hub with 2 backplane ethernet segments. Slot three is
1628 empty, and the remaining slots contain ethernet repeater modules.
1629 [ed. -- Note that a replacement for the current Repeater MIB (<a href="./rfc1516">RFC</a>
1630 <a href="./rfc1516">1516</a>) is likely to emerge soon, and it will no longer be necessary to
1631 access repeater MIB data in different naming scopes.]
1632
1633 Physical entities -- entPhysicalTable:
1634 1 Field-replaceable physical chassis:
1635 entPhysicalDescr.1 == "Acme Chassis Model 110"
1636 entPhysicalVendorType.1 == acmeProducts.chassisTypes.2
1637 entPhysicalContainedIn.1 == 0
1638 entPhysicalClass.1 == chassis(3)
1639 entPhysicalParentRelPos.1 == 0
1640 entPhysicalName.1 == '110-B'
1641
1642 2 Chassis Ethernet Backplanes:
1643 entPhysicalDescr.2 == "Acme Ethernet Backplane Type A"
1644 entPhysicalVendorType.2 == acmeProducts.backplaneTypes.1
1645 entPhysicalContainedIn.2 == 1
1646 entPhysicalClass.2 == backplane(4)
1647 entPhysicalParentRelPos.2 == 1
1648 entPhysicalName.2 == 'B1'
1649
1650 entPhysicalDescr.3 == "Acme Ethernet Backplane Type A"
1651 entPhysicalVendorType.3 == acmeProducts.backplaneTypes.1
1652 entPhysicalContainedIn.3 == 1
1653 entPhysicalClass.3 == backplane(4)
1654 entPhysicalParentRelPos.3 == 2
1655 entPhysicalName.3 == 'B2'
1656
1657 3 slots within the chassis:
1658 entPhysicalDescr.4 == "Acme Hub Slot Type RB"
1659 entPhysicalVendorType.4 == acmeProducts.slotTypes.5
1660 entPhysicalContainedIn.4 == 1
1661 entPhysicalClass.4 == container(5)
1662 entPhysicalParentRelPos.4 == 1
1663 entPhysicalName.4 == 'Slot 1'
1664
1665 entPhysicalDescr.5 == "Acme Hub Slot Type RB"
1666 entPhysicalVendorType.5 == acmeProducts.slotTypes.5
1667 entPhysicalContainedIn.5 == 1
1668 entPhysicalClass.5 == container(5)
1669 entPhysicalParentRelPos.5 == 2
1670 entPhysicalName.5 == 'Slot 2'
1671
1672 entPhysicalDescr.6 == "Acme Hub Slot Type RB"
1673
1674
1675
1676 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1679
1680
1681 entPhysicalVendorType.6 == acmeProducts.slotTypes.5
1682 entPhysicalContainedIn.6 == 1
1683 entPhysicalClass.6 == container(5)
1684 entPhysicalParentRelPos.6 == 3
1685 entPhysicalName.6 == 'Slot 3'
1686
1687 Slot 1 contains a plug-in module with 4 10-BaseT ports:
1688 entPhysicalDescr.7 == "Acme 10Base-T Module 114 Rev A"
1689 entPhysicalVendorType.7 == acmeProducts.moduleTypes.32
1690 entPhysicalContainedIn.7 == 4
1691 entPhysicalClass.7 == module(9)
1692 entPhysicalParentRelPos.7 == 1
1693 entPhysicalName.7 == 'M1'
1694
1695 entPhysicalDescr.8 == "Acme 10Base-T Port RB Rev A"
1696 entPhysicalVendorType.8 == acmeProducts.portTypes.10
1697 entPhysicalContainedIn.8 == 7
1698 entPhysicalClass.8 == port(10)
1699 entPhysicalParentRelPos.8 == 1
1700 entPhysicalName.8 == 'Ethernet-A'
1701
1702 entPhysicalDescr.9 == "Acme 10Base-T Port RB Rev A"
1703 entPhysicalVendorType.9 == acmeProducts.portTypes.10
1704 entPhysicalContainedIn.9 == 7
1705 entPhysicalClass.9 == port(10)
1706 entPhysicalParentRelPos.9 == 2
1707 entPhysicalName.9 == 'Ethernet-B'
1708
1709 entPhysicalDescr.10 == "Acme 10Base-T Port RB Rev B"
1710 entPhysicalVendorType.10 == acmeProducts.portTypes.10
1711 entPhysicalContainedIn.10 == 7
1712 entPhysicalClass.10 == port(10)
1713 entPhysicalParentRelPos.10 == 3
1714 entPhysicalName.10 == 'Ethernet-C'
1715
1716 entPhysicalDescr.11 == "Acme 10Base-T Port RB Rev B"
1717 entPhysicalVendorType.11 == acmeProducts.portTypes.10
1718 entPhysicalContainedIn.11 == 7
1719 entPhysicalClass.11 == port(10)
1720 entPhysicalParentRelPos.11 == 4
1721 entPhysicalName.11 == 'Ethernet-D'
1722
1723 Slot 2 contains another ethernet module with 2 ports.
1724 entPhysicalDescr.12 == "Acme 10Base-T Module Model 4 Rev A"
1725 entPhysicalVendorType.12 == acmeProducts.moduleTypes.30
1726 entPhysicalContainedIn.12 = 5
1727 entPhysicalClass.12 == module(9)
1728 entPhysicalParentRelPos.12 == 1
1729
1730
1731
1732 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1735
1736
1737 entPhysicalName.12 == 'M2'
1738
1739 entPhysicalDescr.13 == "Acme 802.3 AUI Port Rev A"
1740 entPhysicalVendorType.13 == acmeProducts.portTypes.11
1741 entPhysicalContainedIn.13 == 12
1742 entPhysicalClass.13 == port(10)
1743 entPhysicalParentRelPos.13 == 1
1744 entPhysicalName.13 == 'AUI'
1745
1746 entPhysicalDescr.14 == "Acme 10Base-T Port RD Rev B"
1747 entPhysicalVendorType.14 == acmeProducts.portTypes.14
1748 entPhysicalContainedIn.14 == 12
1749 entPhysicalClass.14 == port(10)
1750 entPhysicalParentRelPos.14 == 2
1751 entPhysicalName.14 == 'E2'
1752
1753 Logical entities -- entLogicalTable
1754 Repeater 1--comprised of any ports attached to backplane 1
1755 entLogicalDescr.1 == "Acme repeater v3.1"
1756 entLogicalType.1 == snmpDot3RptrMgt
1757 entLogicalCommunity.1 "public-repeater1"
1758 entLogicalTAddress.1 == 124.125.126.127:161
1759 entLogicalTDomain.1 == snmpUDPDomain
1760
1761 Repeater 2--comprised of any ports attached to backplane 2:
1762 entLogicalDescr.2 == "Acme repeater v3.1"
1763 entLogicalType.2 == snmpDot3RptrMgt
1764 entLogicalCommunity.2 == "public-repeater2"
1765 entLogicalTAddress.2 == 124.125.126.127:161
1766 entLogicalTDomain.2 == snmpUDPDomain
1767
1768 Logical to Physical Mappings -- entLPMappingTable:
1769
1770 repeater1 uses backplane 1, slot 1-ports 1 &amp; 2, slot 2-port 1
1771 [ed. -- Note that a mapping to the module is not included,
1772 since in this example represents a port-switchable hub.
1773 Even though all ports on the module could belong to the
1774 same repeater as a matter of configuration, the LP port
1775 mappings should not be replaced dynamically with a single
1776 mapping for the module (e.g. entLPPhysicalIndex.1.7).
1777 If all ports on the module shared a single backplane connection,
1778 then a single mapping for the module would be more appropriate. ]
1779
1780 entLPPhysicalIndex.1.2 == 2
1781 entLPPhysicalIndex.1.8 == 8
1782 entLPPhysicalIndex.1.9 == 9
1783 entLPPhysicalIndex.1.13 == 13
1784
1785
1786
1787
1788 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1791
1792
1793 repeater2 uses backplane 2, slot 1-ports 3 &amp; 4, slot 2-port 2
1794 entLPPhysicalIndex.2.3 == 3
1795 entLPPhysicalIndex.2.10 == 10
1796 entLPPhysicalIndex.2.11 == 11
1797 entLPPhysicalIndex.2.14 == 14
1798
1799 Physical to Logical to MIB Alias Mappings -- entAliasMappingTable:
1800 Repeater Port Identifier values are shared by both repeaters:
1801 entAliasMappingIdentifier.8.0 == rptrPortGroupIndex.1.1
1802 entAliasMappingIdentifier.9.0 == rptrPortGroupIndex.1.2
1803 entAliasMappingIdentifier.10.0 == rptrPortGroupIndex.1.3
1804 entAliasMappingIdentifier.11.0 == rptrPortGroupIndex.1.4
1805 entAliasMappingIdentifier.13.0 == rptrPortGroupIndex.2.1
1806 entAliasMappingIdentifier.14.0 == rptrPortGroupIndex.2.2
1807
1808 Physical Containment Tree -- entPhysicalContainsTable
1809 chassis has two backplanes and three containers:
1810 entPhysicalChildIndex.1.2 = 2
1811 entPhysicalChildIndex.1.3 = 3
1812 entPhysicalChildIndex.1.4 = 4
1813 entPhysicalChildIndex.1.5 = 5
1814 entPhysicalChildIndex.1.6 = 6
1815
1816 container 1 has a module:
1817 entPhysicalChildIndex.4.7 = 7
1818
1819 container 2 has a module
1820 entPhysicalChildIndex.5.12 = 12
1821 [ed. - in this example, container 3 is empty.]
1822
1823 module 1 has 4 ports:
1824 entPhysicalChildIndex.7.8 = 8
1825 entPhysicalChildIndex.7.9 = 9
1826 entPhysicalChildIndex.7.10 = 10
1827 entPhysicalChildIndex.7.11 = 11
1828
1829 module 2 has 2 ports:
1830 entPhysicalChildIndex.12.13 = 13
1831 entPhysicalChildIndex.12.14 = 14
1832
1833 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Acknowledgements</span>
1834
1835 This document was produced by the IETF Entity MIB Working Group.
1836
1837
1838
1839
1840
1841
1842
1843
1844 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1847
1848
1849 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
1850
1851 [<a id="ref-1">1</a>] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
1852 S. Waldbusser, "Structure of Management Information for version 2
1853 of the Simple Network Management Protocol (SNMPv2)", <a href="./rfc1902">RFC 1902</a>,
1854 January 1996.
1855
1856 [<a id="ref-2">2</a>] McCloghrie, K., and M. Rose, Editors, "Management Information Base
1857 for Network Management of TCP/IP-based internets: MIB-II", STD 17,
1858 <a href="./rfc1213">RFC 1213</a>, Hughes LAN Systems, Performance Systems International,
1859 March 1991.
1860
1861 [<a id="ref-3">3</a>] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
1862 S. Waldbusser, "Textual Conventions for version 2 of the Simple
1863 Network Management Protocol (SNMPv2)", <a href="./rfc1903">RFC 1903</a>, January 1996.
1864
1865 [<a id="ref-4">4</a>] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
1866 S. Waldbusser, "Protocol Operations for version 2 of the Simple
1867 Network Management Protocol (SNMPv2)", <a href="./rfc1905">RFC 1905</a>, January 1996.
1868
1869 [<a id="ref-5">5</a>] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
1870 S. Waldbusser, "Conformance Statements for version 2 of the Simple
1871 Network Management Protocol (SNMPv2)", <a href="./rfc1904">RFC 1904</a>, January 1996.
1872
1873 [<a id="ref-6">6</a>] Case, J., M. Fedor, M. Schoffstall, J. Davin, "Simple Network
1874 Management Protocol", <a href="./rfc1157">RFC 1157</a>, SNMP Research, Performance Systems
1875 International, MIT Laboratory for Computer Science, May 1990.
1876
1877 [<a id="ref-7">7</a>] McCloghrie, K., and Kastenholtz, F., "Interfaces Group Evolution",
1878 <a href="./rfc1573">RFC 1573</a>, Hughes LAN Systems, FTP Software, January 1994.
1879
1880 [<a id="ref-8">8</a>] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
1881 S. Waldbusser, "Transport Mappings for version 2 of the Simple
1882 Network Management Protocol (SNMPv2)", <a href="./rfc1906">RFC 1906</a>, January 1996.
1883
1884 [<a id="ref-9">9</a>] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
1885 S. Waldbusser, "Introduction to Community-based SNMPv2", <a href="./rfc1901">RFC 1901</a>,
1886 January 1996.
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900 <span class="grey">McCloghrie &amp; Bierman Standards Track [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc2037">RFC 2037</a> Entity MIB using SMIv2 October 1996</span>
1903
1904
1905 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations</span>
1906
1907 In order to implement this MIB, an agent must make certain management
1908 information available about various logical and physical entities
1909 within a managed system, which may be considered sensitive in some
1910 network environments.
1911
1912 Therefore, a network administrator may wish to employ instance-level
1913 access control, and configure the Entity MIB access (i.e., community
1914 strings in SNMPv1 and SNMPv2C), such that certain instances within
1915 this MIB (e.g., entLogicalCommunity, or entire entLogicalEntries,
1916 entPhysicalEntries, and associated mapping table entries), are
1917 excluded from particular MIB views.
1918
1919 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Authors' Addresses</span>
1920
1921 Keith McCloghrie
1922 Cisco Systems, Inc.
1923 170 West Tasman Drive
1924 San Jose, CA 95134
1925
1926 Phone: 408-526-5260
1927 EMail: [email protected]
1928
1929
1930 Andy Bierman
1931 Cisco Systems, Inc.
1932 170 West Tasman Drive
1933 San Jose, CA 95134
1934
1935 Phone: 408-527-3711
1936 EMail: [email protected]
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956 McCloghrie &amp; Bierman Standards Track [Page 35]
1957 </pre>