Table of Contents

Physical Table
Physical Entity Table
Physical Mapping Table
Last Change TimeStamp

ENTITY MIB File

This chapter describes the individual MIB objects that comprise the PXM45-specific MIB files. The ENTITY MIB resides in the ENTITY-MIB.my file. This MIB module represents multiple logical entities supported by a single SNMP agent.

Contents of this chapter include:

• Physical Table

• Physical Entity Table

• Physical Mapping Table

• Last Change TimeStamp

Physical Table

The physical table defines the textual conventions.

Note   The physical table group does not contain any object identifiers.

Physical Table MIB objects are listed in Table 2-1.

Table 2-1: Physical Table MIB Objects

Name	Syntax	Description		Default Value
PhysicalIndex	Integer (1..2147483647)	Specifies an arbitrary value that uniquely identifies the physical entity. The value can be a small positive integer; index values for different physical entities are not necessarily contiguous. Status: current		none
PhysicalClass	Integer {other(1), unknown(2), chassis(3), backplane(4), container(5), (for example, a chassis slot or daughter-card holder) powerSupply(6), fan(7), sensor(8), module(9), (for example, a plug-in card or daughter-card) port(10), stack(11) (for example, a stack of multiple chassis entities)}	Specifies an enumerated value that provides an indication of the general hardware type of a particular physical entity. There are no restrictions as to the number of entPhysicalEntries of each entPhysicalClass, which must be instantiated by an agent. The following defines the enumeration: other—Needs to know the physical entity class. It does not match any of the supported values. unknown—Needs to know the physical entity class. It is unknown to the agent. chassis—Needs to know if the physical entity class is an overall container for networking equipment. Any class of physical entity except a stack is contained within a chassis, and a chassis is contained only within a stack. backplane—Needs to know if the physical entity class is a device for aggregating and forwarding networking traffic, such as a shared backplane in a modular ethernet switch. An agent can model a backplane as a single physical entity, which is actually implemented as multiple discrete physical components (within a chassis or stack). container—Needs to know if the physical entity class is capable of containing one or more removable physical entities, possibly of different types. For example, each (empty or full) slot in a chassis is modeled as a container. All removable physical entities are modeled within a container entity, such as field-replaceable modules, fans, or power supplies. All known containers are modeled by the agent, including empty containers.		none
PhysicalClass (continued)		powerSupply—Needs to know if the physical entity class is a power-supplying component. fan—Needs to know if the physical entity class is a fan or other heat-reduction component. sensor—Needs to know if the physical entity class is a sensor, such as a temperature sensor within a router chassis. module—Needs to know if the physical entity class is a self-contained sub-system. If it is removable, it is modeled within a container entity; otherwise, it is modeled directly within another physical entity, for example, a chassis or another module. port—Needs to know if the physical entity class is a networking port, capable of receiving or transmitting networking traffic. stack—Needs to know if the physical entity class is a super-container (possibly virtual), intended to group together multiple chassis entities. A stack is realized by a virtual cable, a real interconnect cable, attached to multiple chassis, or is comprised of multiple interconnect cables. A stack is not modeled within any other physical entities, but a stack is contained within another stack. Only chassis entities are contained within a stack. Status: current
SnmpEngineId OrNone	Octet String (SIZE(0..32))—empty string or SnmpEngineID	Specifies a specially formatted SnmpEngineID string for use with the ENTITY MIB. If an instance of syntax object SnmpEngineIdOrNone has a non-zero length, the object encoding and semantics are defined by the SnmpEngineID textual convention (refer to RFC 2571). If an instance of syntax object SnmpEngineIdOrNone contains a zero-length string, no appropriate SnmpEngineID is associated with the logical entity (that is SNMPv3 is not supported). Status: current		none

Physical Entity Table

The object identifier is listed in Table 2-2.

Table 2-2: Physical Entity Table Object Identifiers

Name	Object Identifier
EntPhysicalTable	::= { entityPhysical 1 }
entPhysicalEntry	::= { entPhysicalTable 1 }
entPhysicalIndex	::= { entPhysicalEntry 1 }
entPhysicalDescr	::= { entPhysicalEntry 2 }
entPhysicalVendorType	::= { entPhysicalEntry 3 }
entPhysicalContainedIn	::= { entPhysicalEntry 4 }
entPhysicalClass	::= { entPhysicalEntry 5 }
entPhysicalParentRelPos	::= { entPhysicalEntry 6 }
entPhysicalName	::= { entPhysicalEntry 7 }
entPhysicalHardwareRev	::= { entPhysicalEntry 8 }
entPhysicalFirmwareRev	::= { entPhysicalEntry 9 }
entPhysicalSoftwareRev	::= { entPhysicalEntry 10 }
entPhysicalSerialNum	::= { entPhysicalEntry 11 }
entPhysicalMfgName	::= { entPhysicalEntry 12 }
entPhysicalModelName	::= { entPhysicalEntry 13 }
entPhysicalAlias	::= { entPhysicalEntry 14 }
entPhysicalAssetID	::= { entPhysicalEntry 15 }
entPhysicalIsFRU	::= { entPhysicalEntry 16 }

The MIB objects are described in Table 2-3.

Table 2-3: Physical Entity Table MIB Objects

Name	Syntax	Description		Default Value
EntPhysicalTable	Sequence of EntPhysicalEntry	Contains one row per physical entity. There is always at least one row for an overall physical entity. Max-Access: not-accessible Status: current		none
entPhysicalEntry	entPhysicalEntry	Provides information about a particular physical entity. Each entry provides objects entPhysicalDescr, entPhysicalVendorType, and entPhysicalClass to help a Network Management System (NMS) identify and characterize the entry. The objects entPhysicalContainedIn and entPhysicalParentRelPos relate this entry to other entries in this table. For the OID1 values assigned to the entPhysicalVendorType, see Table 1-5. Max-Access: not-accessible Status: current The index contains entPhysicalIndex.		none
entPhysicalIndex	PhysicalIndex	Specifies the index for this entry. Max-Access: not-accessible Status: current		none
entPhysicalDescr	SnmpAdminString	Provides a textual description for a physical entity. This object contains a string that identifies the manufacturer's name for the physical entity, and is set to a different value for each version or model of the physical entity. Max-Access: read-only Status: current		none
entPhysicalVendorType	AutonomousType	Indicates the vendor-specific hardware type of the physical entity. Note   This is different from the definition of MIB-II's sysObjectID. An agent sets this object to a enterprise-specific registration identifier value indicating the specific equipment type in detail. The associated instance of entPhysicalClass is used to indicate the general type of hardware device. If no vendor-specific registration identifier exists for this physical entity, or the value is unknown by this agent, the value { 0 0 } is returned. For OID values of this object, see Table 1-5. Max-Access: read-only Status: current		none
entPhysicalContainedIn	Integer (0..2147483647)	Specifies the value of entPhysicalIndex for the physical entity containing this object. A value of zero indicates this physical entity is not contained in any other physical entity. Note   The set of containment relationships defines a strict hierarchy; that is, recursion is not allowed. In the event a physical entity is contained by more than one physical entity (for example, double-wide modules), this object can identify the containing entity with the lowest value of entPhysicalIndex. Max-Access: read-only Status: current		none
entPhysicalClass	PhysicalClass	Indicates the general hardware type of the physical entity. An agent can set this object to the standard enumeration value that most accurately indicates the general class of the physical entity, or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, the value other(1) is returned. If the value is unknown by this agent, the value unknown(2) is returned. Max-Access: read-only Status: current		none
entPhysicalParentRelPos	Integer (-1..2147483647)	Indicates the relative position of this child component among all its sibling components. Sibling components are defined as entPhysicalEntries, which share the same instance values of each of the entPhysicalContainedIn and entPhysicalClass objects. A NMS can use this object to identify the relative ordering for all sibling components of a particular parent (identified by the entPhysicalContainedIn instance in each sibling entry). This value can match any external labeling of the physical component if possible. For example, for a container (card slot) labeled as slot #3, entPhysicalParentRelPos should have the value 3. Note   The entPhysicalEntry for the module plugged in slot 3 can have an entPhysicalParentRelPos value of 1. If the physical position of this component does not match any external numbering or visible ordering, user documentation or other external reference material should be used to determine the parent-relative position. If this is not possible, the agent should assign a consistent (but possibly arbitrary) ordering to a given set of sibling components, based on internal representation of the components.		none
entPhysicalParentRelPos (continued)		If the agent cannot determine the parent-relative position, or if the associated value of entPhysicalContainedIn is zero, the value -1 is returned. Otherwise, a non-negative integer is returned, which indicates the parent-relative position of this physical entity. Parent-relative ordering normally starts from 1 and continues to N. For example, N represents the highest positioned child entity. If the physical entities, for example, slots, are labeled from a starting position of zero, the first sibling is associated with a entPhysicalParentRelPos value 0. Note   This ordering can be sparse or dense, depending on agent implementation. The actual values returned are not globally meaningful, as each parent component can use different numbering algorithms. The ordering is meaningful only among siblings of the same parent component. The agent can retain parent-relative position values across reboots, either through algorithmic assignment or use of non-volatile storage. Max-Access: read-only Status: current
entPhysicalName	SnmpAdminString	Specifies the textual name of the physical entity. The value of this object can be the name of the component as assigned by the local device, and can be suitable for use in commands entered at the device's console. This can be a text name, such as console, or a simple component number (for example, port or module number) such as 1, depending on the physical component naming syntax of the device. If there is no local name, or this object is not applicable, this object contains a zero-length string. Note   The value of entPhysicalName for two physical entities can be the same in the event that the console interface does not distinguish between them, for example, slot-1 and the card in slot-1. Max-Access: read-only Status: current		none
entPhysicalHardwareRev	SnmpAdminString	Specifies the vendor-specific hardware revision string for the physical entity. The preferred value is the hardware revision identifier printed on the component itself (if present). Note   If revision information is stored internally in a non-printable format, (for example, binary), the agent must convert the information to a printable format in an implementation-specific manner. If no specific hardware revision string is associated with the physical component, or this information is unknown to the agent, this object can contain a zero-length string. Max-Access: read-only Status: current		none
entPhysicalFirmwareRev	SnmpAdminString	Specifies the vendor-specific firmware revision string for the physical entity. Note   If revision information is stored internally in a non-printable forma (for example, binary), the agent must convert the information to a printable format in an implementation-specific manner. If no specific firmware programs are associated with the physical component, or this information is unknown to the agent, this object can contain a zero-length string. Max-Access: read-only Status: current		none
entPhysicalSoftwareRev	SnmpAdminString	Specifies the vendor-specific software revision string for the physical entity. Note   If revision information is stored internally in a non-printable format (for example, binary), the agent must convert the information to a printable format in an implementation-specific manner. If no specific software programs are associated with the physical component, or this information is unknown to the agent, this object can contain a zero-length string. Max-Access: read-only Status: current		none
entPhysicalSerialNum	SnmpAdminString (SIZE (0..32))	Specifies the vendor-specific serial number string for the physical entity. The preferred value is the serial number string printed on the component itself (if present). On the first instantiation of an physical entity, the associated value entPhysicalSerialNum is set to the correct vendor-assigned serial number, if this information is available to the agent. If a serial number is unknown or non-existent, the entPhysicalSerialNum is set to a zero-length string instead. Note   The implementations can identify the serial numbers of all installed physical entities, which do not provide write access to the entPhysicalSerialNum object. Agents which cannot provide non-volatile storage for the entPhysicalSerialNum strings are not required to implement write access for this object. Not every physical component has a serial number, or needs one. Physical entities for which the associated value of the entPhysicalIsFRU object is equal to false(2), for example, the repeater ports within a repeater module, do not need their own unique serial number. An agent does not need to provide write access for such entities, and can return a zero-length string. If write access is implemented for an instance of entPhysicalSerialNum, and a value is written into the instance, the agent must retain the supplied value in the entPhysicalSerialNum instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all reinitializations and reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value. Max-Access: read-write Status: current		none
entPhysicalMfgName	SnmpAdminString	Specifies the manufacturer's name of the physical component. The preferred value is the manufacturer name string printed on the component itself (if present). Note   The comparisons between instances of the entPhysicalModelName, entPhysicalFirmwareRev, entPhysicalSoftwareRev, and the entPhysicalSerialNum objects, are only meaningful among entPhysicalEntries with the same value of entPhysicalMfgName. If the manufacturer name string associated with the physical component is unknown to the agent, this object contains a zero-length string. Max-Access: read-only Status: current		none
entPhysicalModelName	SnmpAdminString	Specifies the model name identifier string associated with this physical component. It is different for each vendor. The preferred value is the manufacturer-visible part number, which is printed on the component itself. If the model name string associated with the physical component is unknown to the agent, this object contains a zero-length string. Max-Access: read-only Status: current		none
entPhysicalAlias	SnmpAdminString (SIZE (0..32))	Specifies an alias name for the physical entity as specified by a network manager, and provides a non-volatile handle for the physical entity. On the first instantiation of a physical entity, the value of entPhysicalAlias is set to the zero-length string. However, the agent sets the value to a locally unique default value; instead of, a zero-length string. If write access is implemented for an instance of entPhysicalAlias, and a value is written into the instance, the agent must retain the supplied value in the entPhysicalAlias instance associated with the same physical entity. This includes instantiations across all reinitializations and reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value. Max-Access: read-write Status: current		none
entPhysicalAssetID	SnmpAdminString (SIZE (0..32))	Specifies a user-assigned asset tracking identifier for the physical entity as specified by a network manager, and provides non-volatile storage of this information. On the first instantiation of a physical entity, the value entPhysicalAssetID is set to the zero-length string. Not every physical component will have an asset tracking identifier, or even need one. Physical entities where the associated value of the entPhysicalIsFRU object is equal to false(2) (that is, the repeater ports within a repeater module), do not need their own unique asset tracking identifier. An agent does not have to provide write access for such entities, and may instead return a zero-length string. If write access is implemented for an instance of entPhysicalAssetID, and a value is written into the instance, the agent must retain the supplied value in the entPhysicalAssetID instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all reinitializations and reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value. If no asset tracking information is associated with the physical component, this object contains a zero-length string. Max-Access: read-write Status: current		none
entPhysicalIsFRU	TruthValue	Indicates whether or not this physical entity is considered a field replaceable unit by the vendor. If this object contains the value true(1), this entPhysicalEntry identifies a field replaceable unit. For all entPhysicalEntries which represent components that are permanently contained within a field replaceable unit, the value false(2) is returned for this object. Max-Access: read-only Status: current		none

1OID is defined as an object identifier.

Physical Mapping Table

The object identifier for each MIB object is listed in Table 2-4.

Table 2-4: Physical Mapping Table Object Identifiers

Name	Object Identifier
entPhysicalContainsTable	::= { entityMapping 3 }
entPhysicalContainsEntry	::= { entPhysicalContainsTable 1 }
entPhysicalChildIndex	::= { entPhysicalContainsEntry 1 }

The MIB objects are listed in Table 2-5.

Table 2-5: Physical Mapping Table MIB Objects

Name	Syntax	Description		Default Value
entPhysicalContainsTable	Sequence of entPhysicalContainsEntry	Exposes the container relationships between physical entities. This table provides all the information found by constructing the virtual containment tree for a given entPhysicalTable, but in a more direct format. In the event a physical entity is contained by more than one other physical entity (for example, double-wide modules), this table can include these additional mappings, which cannot be represented in the entPhysicalTable virtual containment tree. Max-Access: not-accessible Status: current		none
entPhysicalContainsEntry	entPhysicalContainsEntry	Indicates a single container and or containee relationship. Max-Access: not-accessible Status: current The indexes are the following: entPhysicalIndex entPhysicalChildIndex		none
entPhysicalChildIndex	PhysicalIndex	Specifies the value entPhysicalIndex for the contained physical entity. Max-Access: read-only Status: current		none

Last Change TimeStamp

The object identifier for the MIB object is shown in Table 2-6.

Table 2-6: Last Change TimeStamp Object Identifier

Name	Object Identifier
entLastChangeTime	::= { entityGeneral 1 }

The MIB object is listed in Table 2-7.

Table 2-7: Last Change TimeStamp MIB Object

Name	Syntax	Description		Default Value
entLastChangeTime	TimeStamp	Specifies the value of sysUpTime when a conceptual row is created, modified, or deleted in these tables: entPhysicalTable entLogicalTable entLPMappingTable entAliasMappingTable entPhysicalContainsTable Max-Access: read-only Status: current		none

Posted: Fri Sep 15 11:57:17 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.