draft-ietf-entmib-v3-06.txt   draft-ietf-entmib-v3-07.txt 
Entity MIB Working Group Andy Bierman Entity MIB Working Group Andy Bierman
Internet Draft Keith McCloghrie Internet Draft Keith McCloghrie
Cisco Systems, Inc. Cisco Systems, Inc.
07 January 2005 19 January 2005
Entity MIB (Version 3) Entity MIB (Version 3)
<draft-ietf-entmib-v3-06.txt> <draft-ietf-entmib-v3-07.txt>
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of RFC 3668. aware will be disclosed, in accordance with Section 6 of RFC 3668.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet- other groups may also distribute working documents as
Drafts. Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six Internet-Drafts are draft documents valid for a maximum of six
months and may be updated, replaced, or obsoleted by other months and may be updated, replaced, or obsoleted by other
documents at any time. It is inappropriate to use Internet-Drafts documents at any time. It is inappropriate to use Internet-Drafts
as reference material or to cite them other than as "work in as reference material or to cite them other than as "work in
progress." progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/1id-abstracts.html http://www.ietf.org/1id-abstracts.html
skipping to change at page 9, line 18 skipping to change at page 9, line 18
other agents. That is, the entLogicalTAddress and entLogicalTDomain other agents. That is, the entLogicalTAddress and entLogicalTDomain
objects in the entLogicalTable are provided to support an objects in the entLogicalTable are provided to support an
historical multiplexing mechanism, not to identify other SNMP historical multiplexing mechanism, not to identify other SNMP
agents. agents.
Note that the Entity MIB is a single-scoped MIB, in the event an Note that the Entity MIB is a single-scoped MIB, in the event an
agent represents the MIB in different naming scopes. agent represents the MIB in different naming scopes.
2.10. Re-Configuration of Entities 2.10. Re-Configuration of Entities
Most of the MIB objects defined in this MIB have at most a read- Most of the MIB objects defined in this MIB have at most a
only MAX-ACCESS clause. This is a conscious decision by the read-only MAX-ACCESS clause. This is a conscious decision by the
working group to limit this MIB's scope. The second version of the working group to limit this MIB's scope. The second version of the
Entity MIB allows a network administrator to configure some common Entity MIB allows a network administrator to configure some common
attributes of physical components. attributes of physical components.
2.11. Textual Convention Change 2.11. Textual Convention Change
Version 1 of the Entity MIB contains three MIB objects defined with Version 1 of the Entity MIB contains three MIB objects defined with
the (now obsolete) DisplayString textual convention. In version 2 the (now obsolete) DisplayString textual convention. In version 2
of the Entity MIB, the syntax for these objects has been updated to of the Entity MIB, the syntax for these objects has been updated to
use the (now preferred) SnmpAdminString textual convention. use the (now preferred) SnmpAdminString textual convention.
skipping to change at page 11, line 4 skipping to change at page 11, line 4
- entPhysicalAlias - entPhysicalAlias
This string can be used by an NMS as a non-volatile identifier for This string can be used by an NMS as a non-volatile identifier for
the physical component. Maintaining a non-volatile string for every the physical component. Maintaining a non-volatile string for every
physical component represented in the entPhysicalTable can be physical component represented in the entPhysicalTable can be
costly and unnecessary. An agent may algorithmically generate costly and unnecessary. An agent may algorithmically generate
'entPhysicalAlias' strings for particular entries (e.g., based on 'entPhysicalAlias' strings for particular entries (e.g., based on
the entPhysicalClass value). the entPhysicalClass value).
- entPhysicalAssetID - entPhysicalAssetID
This string is provided to store a user-specific asset identifier This string is provided to store a user-specific asset identifier
for removable physical components. In order to reduce the non- for removable physical components. In order to reduce the
volatile storage needed by a particular agent, a network non-volatile storage needed by a particular agent, a network
administrator should only assign asset identifiers to physical administrator should only assign asset identifiers to physical
entities which are field-replaceable (i.e., not permanently entities which are field-replaceable (i.e., not permanently
contained within another physical entity). contained within another physical entity).
- entPhysicalSerialNum - entPhysicalSerialNum
This string is provided to store a vendor-specific serial number This string is provided to store a vendor-specific serial number
string for physical components. This is a writable object in case string for physical components. This is a writable object in case
an agent cannot identify the serial numbers of all installed an agent cannot identify the serial numbers of all installed
physical entities, and a network administrator wishes to configure physical entities, and a network administrator wishes to configure
the non-volatile serial number strings manually (via an NMS the non-volatile serial number strings manually (via an NMS
application). application).
Version 3 of the Entity MIB provides two additional MIB objects for Version 3 of the Entity MIB provides two additional MIB objects for
each physical entity: each physical entity:
- entPhysicalMfgDate - entPhysicalMfgDate
This object contains the date of manufacturing of the managed This object contains the date of manufacturing of the managed
entity. If the manufacturing date is unknown or not supported the entity. If the manufacturing date is unknown or not supported the
object is not instantiated. object is not instantiated. The special value '0000000000000000'H
may also be returned in this case.
- entPhysicalUris - entPhysicalUris
This object provides additional identification information about This object provides additional identification information about
the physical entity. the physical entity.
The object contains one or more Uniform Resource Identifiers (URIs) The object contains one or more Uniform Resource Identifiers (URIs)
and therefore the syntax of this object must conform to RFC 2396 and therefore the syntax of this object must conform to RFC 2396
[RFC2396] section 2. Uniform Resource Names (URNs), RFC 3406 [RFC2396] section 2. Uniform Resource Names (URNs), RFC 3406
[RFC3406], are resource identifiers with the specific requirements [RFC3406], are resource identifiers with the specific requirements
for enabling location independent identification of a resource, as for enabling location independent identification of a resource, as
skipping to change at page 16, line 23 skipping to change at page 16, line 23
TDomain, TAddress, TEXTUAL-CONVENTION, TDomain, TAddress, TEXTUAL-CONVENTION,
AutonomousType, RowPointer, TimeStamp, TruthValue, AutonomousType, RowPointer, TimeStamp, TruthValue,
DateAndTime DateAndTime
FROM SNMPv2-TC FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
FROM SNMPv2-CONF FROM SNMPv2-CONF
SnmpAdminString SnmpAdminString
FROM SNMP-FRAMEWORK-MIB; FROM SNMP-FRAMEWORK-MIB;
entityMIB MODULE-IDENTITY entityMIB MODULE-IDENTITY
LAST-UPDATED "200501070000Z" LAST-UPDATED "200501190000Z"
ORGANIZATION "IETF ENTMIB Working Group" ORGANIZATION "IETF ENTMIB Working Group"
CONTACT-INFO CONTACT-INFO
" WG E-mail: entmib@ietf.org " WG E-mail: entmib@ietf.org
Mailing list subscription info: Mailing list subscription info:
http://www.ietf.org/mailman/listinfo/entmib http://www.ietf.org/mailman/listinfo/entmib
Andy Bierman Andy Bierman
Cisco Systems Inc. Cisco Systems Inc.
170 West Tasman Drive 170 West Tasman Drive
San Jose, CA 95134 San Jose, CA 95134
skipping to change at page 17, line 7 skipping to change at page 17, line 7
DESCRIPTION DESCRIPTION
"The MIB module for representing multiple logical "The MIB module for representing multiple logical
entities supported by a single SNMP agent. entities supported by a single SNMP agent.
Copyright (C) The Internet Society (2005). This Copyright (C) The Internet Society (2005). This
version of this MIB module is part of RFC xxxx; see version of this MIB module is part of RFC xxxx; see
the RFC itself for full legal notices." the RFC itself for full legal notices."
-- RFC Ed.: replace xxxx with actual RFC number & remove this notice -- RFC Ed.: replace xxxx with actual RFC number & remove this notice
REVISION "200501070000Z" REVISION "200501190000Z"
DESCRIPTION DESCRIPTION
"Initial Version of Entity MIB (Version 3). "Initial Version of Entity MIB (Version 3).
This revision obsoletes RFC 2737. This revision obsoletes RFC 2737.
Additions: Additions:
- cpu(12) enumeration added to PhysicalClass TC - cpu(12) enumeration added to PhysicalClass TC
- DISPLAY-HINT clause to PhysicalIndex TC
- PhysicalIndexOrZero TC - PhysicalIndexOrZero TC
- entPhysicalMfgDate object - entPhysicalMfgDate object
- entPhysicalUris object - entPhysicalUris object
Changes: Changes:
- entPhysicalContainedIn SYNTAX changed from - entPhysicalContainedIn SYNTAX changed from
INTEGER to PhysicalIndexOrZero INTEGER to PhysicalIndexOrZero
This version published as RFC xxxx." This version published as RFC xxxx."
-- RFC Ed.: replace xxxx with actual RFC number & remove this notice -- RFC Ed.: replace xxxx with actual RFC number & remove this notice
skipping to change at page 17, line 45 skipping to change at page 17, line 46
entityMIBObjects OBJECT IDENTIFIER ::= { entityMIB 1 } entityMIBObjects OBJECT IDENTIFIER ::= { entityMIB 1 }
-- MIB contains four groups -- MIB contains four groups
entityPhysical OBJECT IDENTIFIER ::= { entityMIBObjects 1 } entityPhysical OBJECT IDENTIFIER ::= { entityMIBObjects 1 }
entityLogical OBJECT IDENTIFIER ::= { entityMIBObjects 2 } entityLogical OBJECT IDENTIFIER ::= { entityMIBObjects 2 }
entityMapping OBJECT IDENTIFIER ::= { entityMIBObjects 3 } entityMapping OBJECT IDENTIFIER ::= { entityMIBObjects 3 }
entityGeneral OBJECT IDENTIFIER ::= { entityMIBObjects 4 } entityGeneral OBJECT IDENTIFIER ::= { entityMIBObjects 4 }
-- Textual Conventions -- Textual Conventions
PhysicalIndex ::= TEXTUAL-CONVENTION PhysicalIndex ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"An arbitrary value which uniquely identifies the physical "An arbitrary value which uniquely identifies the physical
entity. The value should be a small positive integer; index entity. The value should be a small positive integer; index
values for different physical entities are not necessarily values for different physical entities are not necessarily
contiguous." contiguous."
SYNTAX Integer32 (1..2147483647) SYNTAX Integer32 (1..2147483647)
PhysicalIndexOrZero ::= TEXTUAL-CONVENTION PhysicalIndexOrZero ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This textual convention is an extension of the "This textual convention is an extension of the
PhysicalIndex convention which defines a greater than zero PhysicalIndex convention which defines a greater than zero
value used to identify a physical entity. This extension value used to identify a physical entity. This extension
permits the additional value of zero. The semantics of the permits the additional value of zero. The semantics of the
value zero are object-specific and must therefore be defined value zero are object-specific and must therefore be defined
as part of the description of any object which uses this as part of the description of any object which uses this
syntax. Examples of the usage of this extension are syntax. Examples of the usage of this extension are
situations where none or all physical entities need to be situations where none or all physical entities need to be
skipping to change at page 19, line 13 skipping to change at page 19, line 16
a modular ethernet switch. Note that an agent may model a a modular ethernet switch. Note that an agent may model a
backplane as a single physical entity, which is actually backplane as a single physical entity, which is actually
implemented as multiple discrete physical components (within implemented as multiple discrete physical components (within
a chassis or stack). a chassis or stack).
The enumeration 'container' is applicable if the physical The enumeration 'container' is applicable if the physical
entity class is capable of containing one or more removable entity class is capable of containing one or more removable
physical entities, possibly of different types. For example, physical entities, possibly of different types. For example,
each (empty or full) slot in a chassis will be modeled as a each (empty or full) slot in a chassis will be modeled as a
container. Note that all removable physical entities should container. Note that all removable physical entities should
be modeled within a container entity, such as field- be modeled within a container entity, such as
replaceable modules, fans, or power supplies. Note that all field-replaceable modules, fans, or power supplies. Note
known containers should be modeled by the agent, including that all known containers should be modeled by the agent,
empty containers. including empty containers.
The enumeration 'powerSupply' is applicable if the physical The enumeration 'powerSupply' is applicable if the physical
entity class is a power-supplying component. entity class is a power-supplying component.
The enumeration 'fan' is applicable if the physical entity The enumeration 'fan' is applicable if the physical entity
class is a fan or other heat-reduction component. class is a fan or other heat-reduction component.
The enumeration 'sensor' is applicable if the physical The enumeration 'sensor' is applicable if the physical
entity class is some sort of sensor, such as a temperature entity class is some sort of sensor, such as a temperature
sensor within a router chassis. sensor within a router chassis.
skipping to change at page 27, line 21 skipping to change at page 27, line 25
(e.g., the repeater ports within a repeater module), do not (e.g., the repeater ports within a repeater module), do not
need their own unique serial number. An agent does not have need their own unique serial number. An agent does not have
to provide write access for such entities, and may return a to provide write access for such entities, and may return a
zero-length string. zero-length string.
If write access is implemented for an instance of If write access is implemented for an instance of
entPhysicalSerialNum, and a value is written into the entPhysicalSerialNum, and a value is written into the
instance, the agent must retain the supplied value in the instance, the agent must retain the supplied value in the
entPhysicalSerialNum instance associated with the same entPhysicalSerialNum instance associated with the same
physical entity for as long as that entity remains physical entity for as long as that entity remains
instantiated. This includes instantiations across all re- instantiated. This includes instantiations across all
initializations/reboots of the network management system, re-initializations/reboots of the network management system,
including those which result in a change of the physical including those which result in a change of the physical
entity's entPhysicalIndex value." entity's entPhysicalIndex value."
::= { entPhysicalEntry 11 } ::= { entPhysicalEntry 11 }
entPhysicalMfgName OBJECT-TYPE entPhysicalMfgName OBJECT-TYPE
SYNTAX SnmpAdminString SYNTAX SnmpAdminString
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The name of the manufacturer of this physical component. "The name of the manufacturer of this physical component.
skipping to change at page 28, line 37 skipping to change at page 28, line 40
of entPhysicalAlias associated with that entity is set to of entPhysicalAlias associated with that entity is set to
the zero-length string. However, agent may set the value to the zero-length string. However, agent may set the value to
a locally unique default value, instead of a zero-length a locally unique default value, instead of a zero-length
string. string.
If write access is implemented for an instance of If write access is implemented for an instance of
entPhysicalAlias, and a value is written into the instance, entPhysicalAlias, and a value is written into the instance,
the agent must retain the supplied value in the the agent must retain the supplied value in the
entPhysicalAlias instance associated with the same physical entPhysicalAlias instance associated with the same physical
entity for as long as that entity remains instantiated. entity for as long as that entity remains instantiated.
This includes instantiations across all re- This includes instantiations across all
initializations/reboots of the network management system, re-initializations/reboots of the network management system,
including those which result in a change of the physical including those which result in a change of the physical
entity's entPhysicalIndex value." entity's entPhysicalIndex value."
::= { entPhysicalEntry 14 } ::= { entPhysicalEntry 14 }
entPhysicalAssetID OBJECT-TYPE entPhysicalAssetID OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..32)) SYNTAX SnmpAdminString (SIZE (0..32))
MAX-ACCESS read-write MAX-ACCESS read-write
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object is a user-assigned asset tracking identifier "This object is a user-assigned asset tracking identifier
skipping to change at page 29, line 25 skipping to change at page 29, line 27
module), do not need their own unique asset tracking module), do not need their own unique asset tracking
identifier. An agent does not have to provide write access identifier. An agent does not have to provide write access
for such entities, and may instead return a zero-length for such entities, and may instead return a zero-length
string. string.
If write access is implemented for an instance of If write access is implemented for an instance of
entPhysicalAssetID, and a value is written into the entPhysicalAssetID, and a value is written into the
instance, the agent must retain the supplied value in the instance, the agent must retain the supplied value in the
entPhysicalAssetID instance associated with the same entPhysicalAssetID instance associated with the same
physical entity for as long as that entity remains physical entity for as long as that entity remains
instantiated. This includes instantiations across all re- instantiated. This includes instantiations across all
initializations/reboots of the network management system, re-initializations/reboots of the network management system,
including those which result in a change of the physical including those which result in a change of the physical
entity's entPhysicalIndex value. entity's entPhysicalIndex value.
If no asset tracking information is associated with the If no asset tracking information is associated with the
physical component, then this object will contain a zero- physical component, then this object will contain a
length string." zero-length string."
::= { entPhysicalEntry 15 } ::= { entPhysicalEntry 15 }
entPhysicalIsFRU OBJECT-TYPE entPhysicalIsFRU OBJECT-TYPE
SYNTAX TruthValue SYNTAX TruthValue
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object indicates whether or not this physical entity "This object indicates whether or not this physical entity
is considered a 'field replaceable unit' by the vendor. If is considered a 'field replaceable unit' by the vendor. If
this object contains the value 'true(1)' then this this object contains the value 'true(1)' then this
skipping to change at page 30, line 10 skipping to change at page 30, line 11
all entPhysicalEntries which represent components that are all entPhysicalEntries which represent components that are
permanently contained within a field replaceable unit, the permanently contained within a field replaceable unit, the
value 'false(2)' should be returned for this object." value 'false(2)' should be returned for this object."
::= { entPhysicalEntry 16 } ::= { entPhysicalEntry 16 }
entPhysicalMfgDate OBJECT-TYPE entPhysicalMfgDate OBJECT-TYPE
SYNTAX DateAndTime SYNTAX DateAndTime
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The manufacturing date for the physical entity. The value "This object contains the date of manufacturing of the
'0000000000000000'H is returned if the manufacturing date of managed entity. If the manufacturing date is unknown or not
the entity in unknown." supported the object is not instantiated. The special value
'0000000000000000'H may also be returned in this case."
::= { entPhysicalEntry 17 } ::= { entPhysicalEntry 17 }
entPhysicalUris OBJECT-TYPE entPhysicalUris OBJECT-TYPE
SYNTAX OCTET STRING SYNTAX OCTET STRING
MAX-ACCESS read-write MAX-ACCESS read-write
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object contains additional identification information "This object contains additional identification information
about the physical entity. The object contains URIs and about the physical entity. The object contains URIs and
therefore the syntax of this object must conform to RFC therefore the syntax of this object must conform to RFC
skipping to change at page 32, line 35 skipping to change at page 32, line 38
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS deprecated STATUS deprecated
DESCRIPTION DESCRIPTION
"An SNMPv1 or SNMPv2C community-string which can be used to "An SNMPv1 or SNMPv2C community-string which can be used to
access detailed management information for this logical access detailed management information for this logical
entity. The agent should allow read access with this entity. The agent should allow read access with this
community string (to an appropriate subset of all managed community string (to an appropriate subset of all managed
objects) and may also return a community string based on the objects) and may also return a community string based on the
privileges of the request used to read this object. Note privileges of the request used to read this object. Note
that an agent may return a community string with read-only that an agent may return a community string with read-only
privileges, even if this object is accessed with a read- privileges, even if this object is accessed with a
write community string. However, the agent must take care read-write community string. However, the agent must take
not to return a community string which allows more care not to return a community string which allows more
privileges than the community string used to access this privileges than the community string used to access this
object. object.
A compliant SNMP agent may wish to conserve naming scopes by A compliant SNMP agent may wish to conserve naming scopes by
representing multiple logical entities in a single 'default' representing multiple logical entities in a single 'default'
naming scope. This is possible when the logical entities naming scope. This is possible when the logical entities
represented by the same value of entLogicalCommunity have no represented by the same value of entLogicalCommunity have no
object instances in common. For example, 'bridge1' and object instances in common. For example, 'bridge1' and
'repeater1' may be part of the main naming scope, but at 'repeater1' may be part of the main naming scope, but at
least one additional community string is needed to represent least one additional community string is needed to represent
skipping to change at page 64, line 7 skipping to change at page 64, line 7
View-based Access Control Model RFC 2575 [RFC2575] is recommended. View-based Access Control Model RFC 2575 [RFC2575] is recommended.
It is then a customer/user responsibility to ensure that the SNMP It is then a customer/user responsibility to ensure that the SNMP
entity giving access to an instance of this MIB, is properly entity giving access to an instance of this MIB, is properly
configured to give access to the objects only to those principals configured to give access to the objects only to those principals
(users) that have legitimate rights to indeed GET or SET (users) that have legitimate rights to indeed GET or SET
(change/create/delete) them. (change/create/delete) them.
6. IANA Considerations 6. IANA Considerations
This document has no actions for IANA. The MIB module in this document uses the following IANA-assigned
OBJECT IDENTIFIER values recorded in the SMI Numbers registry:
Descriptor OBJECT IDENTIFIER value
---------- -----------------------
entityMIB { mib-2 47 }
Editor's Note (to be removed prior to publication): this draft
makes no additional requests of the IANA.
7. Acknowledgements 7. Acknowledgements
This memo has been produced by the IETF's Entity MIB working group. This memo has been produced by the IETF's Entity MIB working group.
8. References 8. References
8.1. Normative References 8.1. Normative References
[RFC2026] [RFC2026]
 End of changes. 

This html diff was produced by rfcdiff 1.23, available from http://www.levkowetz.com/ietf/tools/rfcdiff/