Standard view Table view

ENTITY-MIB

Monitored by Observium 
        The MIB module for representing multiple logical
entities supported by a single SNMP agent.
        
Copyright (c) 2013 IETF Trust and the persons identified
as authors of the code.  All rights reserved.
        
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info).
Observium actively monitors this MIB
Observium uses this MIB in discovery or polling workflows on applicable devices.
Discovery Inventory Memory Polling Processors Sensors
Explore Observium network monitoring
Source file
ENTITY-MIB
Last revised
Identity
entityMIB
Base OID
1.3.6.1.2.1.47
Imported Objects
IANA-ENTITY-MIB IANAPhysicalClass
SNMP-FRAMEWORK-MIB SnmpAdminString
SNMPv2-CONF MODULE-COMPLIANCE NOTIFICATION-GROUP OBJECT-GROUP
SNMPv2-SMI Integer32 mib-2 MODULE-IDENTITY NOTIFICATION-TYPE OBJECT-TYPE
SNMPv2-TC AutonomousType DateAndTime RowPointer TAddress TDomain TEXTUAL-CONVENTION TimeStamp TruthValue
UUID-TC-MIB UUIDorZero
Net-SNMP examples using the rfc MIB directory Show commands

These commands use the standard Observium installation path and load the selected MIB variant before the RFC and Net-SNMP directories.

Translate the module identity
/usr/bin/snmptranslate -Pud -Ir -On -m 'ENTITY-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'ENTITY-MIB::entityMIB'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'ENTITY-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'ENTITY-MIB::entityMIB'
How SNMP, Net-SNMP, MIB paths, and variants work
Objects (53)
15 directly used by Observium
entityMIB
.1.3.6.1.2.1.47
entityMIBObjects
.1.3.6.1.2.1.47.1
entityPhysical
.1.3.6.1.2.1.47.1.1
entPhysicalTable
.1.3.6.1.2.1.47.1.1.1
entPhysicalEntry OBS ✓
entPhysicalIndex
 .1.3.6.1.2.1.47.1.1.1.1
entPhysicalIndex
PhysicalIndex
 .1.3.6.1.2.1.47.1.1.1.1.1
entPhysicalSoftwareRev OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.10
entPhysicalSerialNum OBS ✓ r/w
OctetString
 .1.3.6.1.2.1.47.1.1.1.1.11
entPhysicalMfgName OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.12
entPhysicalModelName OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.13
entPhysicalAlias OBS ✓ r/w
OctetString
 .1.3.6.1.2.1.47.1.1.1.1.14
entPhysicalAssetID r/w
OctetString
 .1.3.6.1.2.1.47.1.1.1.1.15
entPhysicalIsFRU
SNMPv2-TCTruthValue
 .1.3.6.1.2.1.47.1.1.1.1.16
entPhysicalMfgDate
SNMPv2-TCDateAndTime
 .1.3.6.1.2.1.47.1.1.1.1.17
entPhysicalUris r/w
OctetString
 .1.3.6.1.2.1.47.1.1.1.1.18
entPhysicalUUID
UUID-TC-MIBUUIDorZero
 .1.3.6.1.2.1.47.1.1.1.1.19
entPhysicalDescr OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.2
entPhysicalVendorType OBS ✓
SNMPv2-TCAutonomousType
 .1.3.6.1.2.1.47.1.1.1.1.3
entPhysicalContainedIn OBS ✓
PhysicalIndexOrZero
 .1.3.6.1.2.1.47.1.1.1.1.4
entPhysicalClass OBS ✓
IANA-ENTITY-MIBIANAPhysicalClass
 .1.3.6.1.2.1.47.1.1.1.1.5
entPhysicalParentRelPos OBS ✓
Integer32
 .1.3.6.1.2.1.47.1.1.1.1.6
entPhysicalName OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.7
entPhysicalHardwareRev OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.8
entPhysicalFirmwareRev OBS ✓
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.1.1.1.9
entityLogical
.1.3.6.1.2.1.47.1.2
entLogicalTable
.1.3.6.1.2.1.47.1.2.1
entLogicalEntry
entLogicalIndex
 .1.3.6.1.2.1.47.1.2.1.1
entLogicalIndex
Integer32
 .1.3.6.1.2.1.47.1.2.1.1.1
entLogicalDescr
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.2.1.1.2
entLogicalType
SNMPv2-TCAutonomousType
 .1.3.6.1.2.1.47.1.2.1.1.3
entLogicalCommunity deprecated
OctetString
 .1.3.6.1.2.1.47.1.2.1.1.4
entLogicalTAddress
SNMPv2-TCTAddress
 .1.3.6.1.2.1.47.1.2.1.1.5
entLogicalTDomain
SNMPv2-TCTDomain
 .1.3.6.1.2.1.47.1.2.1.1.6
entLogicalContextEngineID
SnmpEngineIdOrNone
 .1.3.6.1.2.1.47.1.2.1.1.7
entLogicalContextName
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.47.1.2.1.1.8
entityMapping
.1.3.6.1.2.1.47.1.3
entLPMappingTable
.1.3.6.1.2.1.47.1.3.1
entLPMappingEntry
entLogicalIndexentLPPhysicalIndex
 .1.3.6.1.2.1.47.1.3.1.1
entLPPhysicalIndex
PhysicalIndex
 .1.3.6.1.2.1.47.1.3.1.1.1
entAliasMappingTable
.1.3.6.1.2.1.47.1.3.2
entAliasMappingEntry
entPhysicalIndexentAliasLogicalIndexOrZero
 .1.3.6.1.2.1.47.1.3.2.1
entAliasLogicalIndexOrZero
Integer32
 .1.3.6.1.2.1.47.1.3.2.1.1
entAliasMappingIdentifier OBS ✓
SNMPv2-TCRowPointer
 .1.3.6.1.2.1.47.1.3.2.1.2
entPhysicalContainsTable
.1.3.6.1.2.1.47.1.3.3
entPhysicalContainsEntry
entPhysicalIndexentPhysicalChildIndex
 .1.3.6.1.2.1.47.1.3.3.1
entPhysicalChildIndex
PhysicalIndex
 .1.3.6.1.2.1.47.1.3.3.1.1
entityGeneral
.1.3.6.1.2.1.47.1.4
entLastChangeTime
SNMPv2-TCTimeStamp
 .1.3.6.1.2.1.47.1.4.1
entityMIBTraps
.1.3.6.1.2.1.47.2
entityMIBTrapPrefix
.1.3.6.1.2.1.47.2.0
entityConformance
.1.3.6.1.2.1.47.3
entityCompliances
.1.3.6.1.2.1.47.3.1
entityGroups
.1.3.6.1.2.1.47.3.2
Dependencies (6) 6 direct Show tree and compile order Hide dependency details

Each imported module is resolved in the importing module's source directory first, then through the normal default-variant rules.

Dependency tree
Dependency-first compile order
  1. SNMPv2-SMIrfc
  2. SNMPv2-TCrfc
  3. IANA-ENTITY-MIBrfc
  4. SNMPv2-CONFrfc
  5. SNMP-FRAMEWORK-MIBrfc
  6. UUID-TC-MIBrfc
  7. ENTITY-MIBrfcselected
Type Definitions (4)
PhysicalClass
Enumeration
other(1)
unknown(2)
chassis(3)
backplane(4)
container(5)
powerSupply(6)
fan(7)
sensor(8)
module(9)
port(10)
stack(11)
cpu(12)
PhysicalIndex
Integer32 range: 1..2147483647
PhysicalIndexOrZero
Integer32 range: 0..2147483647
SnmpEngineIdOrNone
OctetString range: 0..32
Conformance Groups (10)
entityPhysicalGroup
entPhysicalDescr entPhysicalVendorType entPhysicalContainedIn entPhysicalClass entPhysicalParentRelPos entPhysicalName
The collection of objects used to represent physical
system components for which a single agent provides
management information.
 .1.3.6.1.2.1.47.3.2.1
entityLogicalGroup deprecated
entLogicalDescr entLogicalType entLogicalCommunity entLogicalTAddress entLogicalTDomain
The collection of objects used to represent the list of
logical entities for which a single agent provides
management information.
 .1.3.6.1.2.1.47.3.2.2
entityMappingGroup
entLPPhysicalIndex entAliasMappingIdentifier entPhysicalChildIndex
The collection of objects used to represent the
associations between multiple logical entities, physical
components, interfaces, and port identifiers for which a
single agent provides management information.
 .1.3.6.1.2.1.47.3.2.3
entityGeneralGroup
entLastChangeTime
The collection of objects used to represent general entity
information for which a single agent provides management
information.
 .1.3.6.1.2.1.47.3.2.4
entityNotificationsGroup
entConfigChange
The collection of notifications used to indicate Entity MIB
data consistency and general status information.
 .1.3.6.1.2.1.47.3.2.5
entityPhysical2Group
entPhysicalHardwareRev entPhysicalFirmwareRev entPhysicalSoftwareRev entPhysicalSerialNum entPhysicalMfgName entPhysicalModelName entPhysicalAlias entPhysicalAssetID entPhysicalIsFRU
The collection of objects used to represent physical
system components for which a single agent provides
management information. This group augments the objects
contained in the entityPhysicalGroup.
 .1.3.6.1.2.1.47.3.2.6
entityLogical2Group
entLogicalDescr entLogicalType entLogicalTAddress entLogicalTDomain entLogicalContextEngineID entLogicalContextName
The collection of objects used to represent the
list of logical entities for which a single SNMP entity
provides management information.
 .1.3.6.1.2.1.47.3.2.7
entityPhysical3Group
entPhysicalMfgDate entPhysicalUris
The collection of objects used to represent physical
system components for which a single agent provides
management information. This group augments the objects
contained in the entityPhysicalGroup.
 .1.3.6.1.2.1.47.3.2.8
entityPhysical4Group
entPhysicalUUID
The collection of objects used to represent physical
system components for which a single agent provides
management information. This group augments the objects
contained in the entityPhysicalGroup and
entityPhysicalCRGroup.
 .1.3.6.1.2.1.47.3.2.9
entityPhysicalCRGroup
entPhysicalClass entPhysicalName
The collection of objects used to represent physical
system components for constrained resourced devices,
for which a single agent provides management
information.
 .1.3.6.1.2.1.47.3.2.10
Compliance Statements (5)

OID .1.3.6.1.2.1.47.3.1.1
The compliance statement for SNMP entities that implement
version 1 of the Entity MIB.
Required groups
mandatory entityPhysicalGroup
mandatory entityLogicalGroup
mandatory entityMappingGroup
mandatory entityGeneralGroup
mandatory entityNotificationsGroup

OID .1.3.6.1.2.1.47.3.1.2
The compliance statement for SNMP entities that implement
version 2 of the Entity MIB.
Required groups
mandatory entityPhysicalGroup
mandatory entityPhysical2Group
mandatory entityGeneralGroup
mandatory entityNotificationsGroup
optional entityLogical2Group Implementation of this group is not mandatory for agents
that model all MIB object instances within a single naming
scope.
optional entityMappingGroup Implementation of the entPhysicalContainsTable is mandatory
for all agents. Implementation of the entLPMappingTable and
entAliasMappingTables are not mandatory for agents that
model all MIB object instances within a single naming scope.

Note that the entAliasMappingTable may be useful for all
agents; however, implementation of the entityLogicalGroup or
entityLogical2Group is required to support this table.
Object refinements
ObjectAccessSyntaxDescription
entPhysicalSerialNum noaccess
Read and write access is not required for agents that
cannot identify serial number information for physical
entities and/or cannot provide non-volatile storage for
NMS-assigned serial numbers.

Write access is not required for agents that can identify
serial number information for physical entities but cannot
provide non-volatile storage for NMS-assigned serial
numbers.

Write access is not required for physical entities for which
the associated value of the entPhysicalIsFRU object is equal
to 'false(2)'.
entPhysicalAlias readonly
Write access is required only if the associated
entPhysicalClass value is equal to 'chassis(3)'.
entPhysicalAssetID noaccess
Read and write access is not required for agents that
cannot provide non-volatile storage for NMS-assigned asset
identifiers.

Write access is not required for physical entities for which
the associated value of the entPhysicalIsFRU object is equal
to 'false(2)'.
entPhysicalClass
IANA-ENTITY-MIBIANAPhysicalClass
other(1), unknown(2), chassis(3), backplane(4), container(5), powerSupply(6), fan(7), sensor(8), module(9), port(10), stack(11)
Implementation of the 'cpu(12)' enumeration is not
required.

OID .1.3.6.1.2.1.47.3.1.3
The compliance statement for SNMP entities that implement
version 3 of the Entity MIB.
Required groups
mandatory entityPhysicalGroup
mandatory entityPhysical2Group
mandatory entityPhysical3Group
mandatory entityGeneralGroup
mandatory entityNotificationsGroup
optional entityLogical2Group Implementation of this group is not mandatory for agents
that model all MIB object instances within a single naming
scope.
optional entityMappingGroup Implementation of the entPhysicalContainsTable is mandatory
for all agents. Implementation of the entLPMappingTable and
entAliasMappingTables are not mandatory for agents that
model all MIB object instances within a single naming scope.

Note that the entAliasMappingTable may be useful for all
agents; however, implementation of the entityLogicalGroup or
entityLogical2Group is required to support this table.
Object refinements
ObjectAccessSyntaxDescription
entPhysicalSerialNum noaccess
Read and write access is not required for agents that
cannot identify serial number information for physical
entities and/or cannot provide non-volatile storage for
NMS-assigned serial numbers.

Write access is not required for agents that can identify
serial number information for physical entities but cannot
provide non-volatile storage for NMS-assigned serial
numbers.

Write access is not required for physical entities for
which the associated value of the entPhysicalIsFRU object
is equal to 'false(2)'.
entPhysicalAlias readonly
Write access is required only if the associated
entPhysicalClass value is equal to 'chassis(3)'.
entPhysicalAssetID noaccess
Read and write access is not required for agents that
cannot provide non-volatile storage for NMS-assigned asset
identifiers.

Write access is not required for physical entities for which
the associated value of entPhysicalIsFRU is equal to
'false(2)'.

OID .1.3.6.1.2.1.47.3.1.4
The compliance statement for SNMP entities that implement
the full version 4 (full compliance) of the Entity MIB.
Required groups
mandatory entityPhysicalGroup
mandatory entityPhysical2Group
mandatory entityPhysical3Group
mandatory entityGeneralGroup
mandatory entityNotificationsGroup
mandatory entityPhysical4Group
optional entityLogical2Group Implementation of this group is not mandatory for agents
that model all MIB object instances within a single naming
scope.
optional entityMappingGroup Implementation of the entPhysicalContainsTable is mandatory
for all agents. Implementation of the entLPMappingTable and
entAliasMappingTables are not mandatory for agents that
model all MIB object instances within a single naming scope.

Note that the entAliasMappingTable may be useful for all
agents; however, implementation of the entityLogicalGroup or
entityLogical2Group is required to support this table.
Object refinements
ObjectAccessSyntaxDescription
entPhysicalSerialNum noaccess
Read and write access is not required for agents that
cannot identify serial number information for physical
entities and/or cannot provide non-volatile storage for
NMS-assigned serial numbers.

Write access is not required for agents that can identify
serial number information for physical entities but cannot
provide non-volatile storage for NMS-assigned serial
numbers.

Write access is not required for physical entities for
which the associated value of the entPhysicalIsFRU object
is equal to 'false(2)'.
entPhysicalAlias readonly
Write access is required only if the associated
entPhysicalClass value is equal to 'chassis(3)'.
entPhysicalAssetID noaccess
Read and write access is not required for agents that
cannot provide non-volatile storage for NMS-assigned asset
identifiers.

Write access is not required for physical entities for which
the associated value of entPhysicalIsFRU is equal to
'false(2)'.

OID .1.3.6.1.2.1.47.3.1.5
The compliance statement for SNMP entities that implement
version 4 of the Entity MIB on devices with constrained
resources.
Required groups
mandatory entityPhysicalCRGroup
mandatory entityPhysical4Group
Notifications / Traps (1)
NameOIDDescription
entConfigChange
.1.3.6.1.2.1.47.2.0.1
An entConfigChange notification is generated when the value
of entLastChangeTime changes. It can be utilized by an NMS
to trigger logical/physical entity table maintenance polls.

An agent should not generate more than one entConfigChange
'notification-event' in a given time interval (five seconds
is the suggested default). A 'notification-event' is the
transmission of a single trap or inform PDU to a list of
notification destinations.

If additional configuration changes occur within the
throttling period, then notification-events for these
changes should be suppressed by the agent until the current
throttling period expires. At the end of a throttling
period, one notification-event should be generated if any
configuration changes occurred since the start of the
throttling period. In such a case, another throttling
period is started right away.

An NMS should periodically check the value of
entLastChangeTime to detect any missed entConfigChange
notification-events, e.g., due to throttling or transmission
loss.