Entity State MIB
RFC 4268
| Document | Type | RFC - Proposed Standard (December 2005) Errata | |
|---|---|---|---|
| Authors | David T. Perkins , Sharon Chisholm | ||
| Last updated | 2020-01-21 | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Formats | |||
| Additional resources | Mailing list discussion | ||
| IESG | Responsible AD | Bert Wijnen | |
| Send notices to | (None) |
RFC 4268
'hotStandby' means the resource is not
providing service, but it will be immediately able to
take over the role of the resource to be backed up,
without the need for initialization activity, and will
contain the same information as the resource to be
backed up. A value of 'coldStandy' means that the
resource is to back up another resource, but will not
be immediately able to take over the role of a resource
to be backed up, and will require some initialization
activity. A value of 'providingService' means the
resource is providing service. A value of
'unknown' means that this resource is unable to
report standby state."
SYNTAX INTEGER
{
unknown (1),
hotStandby (2),
coldStandby (3),
providingService (4)
}
END
5. Definitions
ENTITY-STATE-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, mib-2
FROM SNMPv2-SMI
DateAndTime
FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
FROM SNMPv2-CONF
entPhysicalIndex
FROM ENTITY-MIB
EntityAdminState, EntityOperState, EntityUsageState,
EntityAlarmStatus, EntityStandbyStatus
FROM ENTITY-STATE-TC-MIB;
entityStateMIB MODULE-IDENTITY
LAST-UPDATED "200511220000Z"
ORGANIZATION "IETF Entity MIB Working Group"
Chisholm & Perkins Standards Track [Page 9]
RFC 4268 Entity State MIB November 2005
CONTACT-INFO
" General Discussion: entmib@ietf.org
To Subscribe:
http://www.ietf.org/mailman/listinfo/entmib
http://www.ietf.org/html.charters/entmib-charter.html
Sharon Chisholm
Nortel Networks
PO Box 3511 Station C
Ottawa, Ont. K1Y 4H7
Canada
schishol@nortel.com
David T. Perkins
548 Qualbrook Ct
San Jose, CA 95110
USA
Phone: 408 394-8702
dperkins@snmpinfo.com
"
DESCRIPTION
"This MIB defines a state extension to the Entity MIB.
Copyright (C) The Internet Society 2005. This version
of this MIB module is part of RFC 4268; see the RFC
itself for full legal notices."
REVISION "200511220000Z"
DESCRIPTION
"Initial version, published as RFC 4268."
::= { mib-2 131 }
-- Entity State Objects
entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 }
entStateTable OBJECT-TYPE
SYNTAX SEQUENCE OF EntStateEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of information about state/status of entities.
This is a sparse augment of the entPhysicalTable. Entries
appear in this table for values of
entPhysicalClass [RFC4133] that in this implementation
are able to report any of the state or status stored in
this table.
Chisholm & Perkins Standards Track [Page 10]
RFC 4268 Entity State MIB November 2005
"
::= { entStateObjects 1 }
entStateEntry OBJECT-TYPE
SYNTAX EntStateEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"State information about this physical entity."
INDEX { entPhysicalIndex }
::= { entStateTable 1 }
EntStateEntry ::= SEQUENCE {
entStateLastChanged DateAndTime,
entStateAdmin EntityAdminState,
entStateOper EntityOperState,
entStateUsage EntityUsageState,
entStateAlarm EntityAlarmStatus,
entStateStandby EntityStandbyStatus
}
entStateLastChanged OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of this object is the date and
time when the value of any of entStateAdmin,
entStateOper, entStateUsage, entStateAlarm,
or entStateStandby changed for this entity.
If there has been no change since
the last re-initialization of the local system,
this object contains the date and time of
local system initialization. If there has been
no change since the entity was added to the
local system, this object contains the date and
time of the insertion."
::= { entStateEntry 1 }
entStateAdmin OBJECT-TYPE
SYNTAX EntityAdminState
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The administrative state for this entity.
Chisholm & Perkins Standards Track [Page 11]
RFC 4268 Entity State MIB November 2005
This object refers to an entities administrative
permission to service both other entities within
its containment hierarchy as well other users of
its services defined by means outside the scope
of this MIB.
Setting this object to 'notSupported' will result
in an 'inconsistentValue' error. For entities that
do not support administrative state, all set
operations will result in an 'inconsistentValue'
error.
Some physical entities exhibit only a subset of the
remaining administrative state values. Some entities
cannot be locked, and hence this object exhibits only
the 'unlocked' state. Other entities cannot be shutdown
gracefully, and hence this object does not exhibit the
'shuttingDown' state. A value of 'inconsistentValue'
will be returned if attempts are made to set this
object to values not supported by its administrative
model."
::= { entStateEntry 2 }
entStateOper OBJECT-TYPE
SYNTAX EntityOperState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The operational state for this entity.
Note that unlike the state model used within the
Interfaces MIB [RFC2863], this object does not follow
the administrative state. An administrative state of
down does not predict an operational state
of disabled.
A value of 'testing' means that entity currently being
tested and cannot therefore report whether it is
operational or not.
A value of 'disabled' means that an entity is totally
inoperable and unable to provide service both to entities
within its containment hierarchy, or to other receivers
of its service as defined in ways outside the scope of
this MIB.
A value of 'enabled' means that an entity is fully or
partially operable and able to provide service both to
Chisholm & Perkins Standards Track [Page 12]
RFC 4268 Entity State MIB November 2005
entities within its containment hierarchy, or to other
receivers of its service as defined in ways outside the
scope of this MIB.
Note that some implementations may not be able to
accurately report entStateOper while the
entStateAdmin object has a value other than 'unlocked'.
In these cases, this object MUST have a value
of 'unknown'."
::= { entStateEntry 3 }
entStateUsage OBJECT-TYPE
SYNTAX EntityUsageState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The usage state for this entity.
This object refers to an entity's ability to service more
physical entities in a containment hierarchy. A value
of 'idle' means this entity is able to contain other
entities but that no other entity is currently
contained within this entity.
A value of 'active' means that at least one entity is
contained within this entity, but that it could handle
more. A value of 'busy' means that the entity is unable
to handle any additional entities being contained in it.
Some entities will exhibit only a subset of the
usage state values. Entities that are unable to ever
service any entities within a containment hierarchy will
always have a usage state of 'busy'. Some entities will
only ever be able to support one entity within its
containment hierarchy and will therefore only exhibit
values of 'idle' and 'busy'."
::= { entStateEntry 4 }
entStateAlarm OBJECT-TYPE
SYNTAX EntityAlarmStatus
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The alarm status for this entity. It does not include
the alarms raised on child components within its
containment hierarchy.
A value of 'unknown' means that this entity is
Chisholm & Perkins Standards Track [Page 13]
RFC 4268 Entity State MIB November 2005
unable to report alarm state. Note that this differs
from 'indeterminate', which means that alarm state
is supported and there are alarms against this entity,
but the severity of some of the alarms is not known.
If no bits are set, then this entity supports reporting
of alarms, but there are currently no active alarms
against this entity."
::= { entStateEntry 5 }
entStateStandby OBJECT-TYPE
SYNTAX EntityStandbyStatus
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The standby status for this entity.
Some entities will exhibit only a subset of the
remaining standby state values. If this entity
cannot operate in a standby role, the value of this
object will always be 'providingService'."
::= { entStateEntry 6 }
-- Notifications
entStateNotifications OBJECT IDENTIFIER ::= { entityStateMIB 0 }
entStateOperEnabled NOTIFICATION-TYPE
OBJECTS { entStateAdmin,
entStateAlarm
}
STATUS current
DESCRIPTION
"An entStateOperEnabled notification signifies that the
SNMP entity, acting in an agent role, has detected that
the entStateOper object for one of its entities has
transitioned into the 'enabled' state.
The entity this notification refers can be identified by
extracting the entPhysicalIndex from one of the
variable bindings. The entStateAdmin and entStateAlarm
varbinds may be examined to find out additional
information on the administrative state at the time of
the operation state change as well as to find out whether
there were any known alarms against the entity at that
time that may explain why the physical entity has become
operationally disabled."
::= { entStateNotifications 1 }
Chisholm & Perkins Standards Track [Page 14]
RFC 4268 Entity State MIB November 2005
entStateOperDisabled NOTIFICATION-TYPE
OBJECTS { entStateAdmin,
entStateAlarm }
STATUS current
DESCRIPTION
"An entStateOperDisabled notification signifies that the
SNMP entity, acting in an agent role, has detected that
the entStateOper object for one of its entities has
transitioned into the 'disabled' state.
The entity this notification refers can be identified by
extracting the entPhysicalIndex from one of the
variable bindings. The entStateAdmin and entStateAlarm
varbinds may be examined to find out additional
information on the administrative state at the time of
the operation state change as well as to find out whether
there were any known alarms against the entity at that
time that may affect the physical entity's
ability to stay operationally enabled."
::= { entStateNotifications 2 }
-- Conformance and Compliance
entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 2 }
entStateCompliances OBJECT IDENTIFIER
::= { entStateConformance 1 }
entStateCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for systems supporting
the Entity State MIB."
MODULE -- this module
MANDATORY-GROUPS {
entStateGroup
}
GROUP entStateNotificationsGroup
DESCRIPTION
"This group is optional."
OBJECT entStateAdmin
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
::= { entStateCompliances 1 }
entStateGroups OBJECT IDENTIFIER ::= { entStateConformance 2 }
Chisholm & Perkins Standards Track [Page 15]
RFC 4268 Entity State MIB November 2005
entStateGroup OBJECT-GROUP
OBJECTS {
entStateLastChanged,
entStateAdmin,
entStateOper,
entStateUsage,
entStateAlarm,
entStateStandby
}
STATUS current
DESCRIPTION
"Standard Entity State group."
::= { entStateGroups 1}
entStateNotificationsGroup NOTIFICATION-GROUP
NOTIFICATIONS {
entStateOperEnabled,
entStateOperDisabled
}
STATUS current
DESCRIPTION
"Standard Entity State Notification group."
::= { entStateGroups 2}
END
6. Security Considerations
The ENTITY-STATE-TC-MIB defined in section 4 does not define any
management objects. Instead, it defines a set of textual conventions
that may be used by other MIB modules to define management objects.
Meaningful security considerations can only be written in the MIB
modules that define management objects. The ENTITY-STATE-TC-MIB has
therefore no impact on the security of the Internet.
The ENTITY-STATE-MIB defined in section 5 defines one management
object -- entStateAdmin -- that has a MAX-ACCESS clause of read-
write. The object may be considered sensitive or vulnerable in some
network environments. The support for SET operations in a non-secure
environment without proper protection can have a negative effect on
network operations.
Note that setting the entStateAdmin to 'locked' or 'shuttingDown' can
cause disruption of services ranging from those running on a port to
those on an entire device, depending on the type of entity. Access
to this object should be properly protected.
Chisholm & Perkins Standards Track [Page 16]
RFC 4268 Entity State MIB November 2005
Access to the objects defined in this MIB allows one to figure out
what the active and standby resources in a network are. This
information can be used to optimize attacks on networks so even
read-only access to this MIB should be properly protected.
SNMP versions prior to SNMPv3 did not include adequate security.
Even if the network itself is secure (for example by using IPsec),
even then, there is no control as to who on the secure network is
allowed to access and GET/SET (read/change/create/delete) the objects
in this MIB module.
It is RECOMMENDED that implementers consider the security features as
provided by the SNMPv3 framework (see [RFC3410], section 8),
including full support for the SNMPv3 cryptographic mechanisms (for
authentication and privacy).
Further, deployment of SNMP versions prior to SNMPv3 is NOT
RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to
enable cryptographic security. It is then a customer/operator
responsibility to ensure that the SNMP entity giving access to an
instance of this MIB module is properly configured to give access to
the objects only to those principals (entities) that have legitimate
rights to indeed GET or SET (change/create/delete) them.
7. Acknowledgements
This document is a product of the Entity MIB Working Group.
8. References
8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M., and S. Waldbusser, "Structure of Management
Information Version 2 (SMIv2)", STD 58, RFC 2578, April
1999.
[RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M., and S. Waldbusser, "Textual Conventions for
SMIv2", STD 58, RFC 2579, April 1999.
[RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M., and S. Waldbusser, "Conformance Statements for
SMIv2", STD 58, RFC 2580, April 1999.
Chisholm & Perkins Standards Track [Page 17]
RFC 4268 Entity State MIB November 2005
[RFC4133] Bierman, A. and K. McCloghrie, "Entity MIB (Version 3)",
RFC 4133, August 2005.
8.2. Informative References
[RFC2790] Waldbusser, S. and P. Grillo, "Host Resources MIB", RFC
2790, March 2000.
[RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group
MIB using SMIv2", RFC 2863, June 2000.
[RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart,
"Introduction and Applicability Statements for Internet-
Standard Management Framework", RFC 3410, December 2002.
[RFC3877] Chisholm, S. and D. Romascanu, "Alarm Management
Information Base (MIB)", RFC 3877, September 2004.
[RFC4188] Norseth, K. and E. Bell, "Definitions of Managed Objects
for Bridges", RFC 4188, September 2005.
[X.731] ITU Recommendation X.731, "Information Technology - Open
Systems Interconnection - System Management: State
Management Function", 1992.
Authors' Addresses
Sharon Chisholm
Nortel Networks
PO Box 3511, Station C
Ottawa, Ontario, K1Y 4H7
Canada
EMail: schishol@nortel.com
David T. Perkins
548 Qualbrook Ct
San Jose, CA 95110
USA
Phone: 408 394-8702
EMail: dperkins@snmpinfo.com
Chisholm & Perkins Standards Track [Page 18]
RFC 4268 Entity State MIB November 2005
Full Copyright Statement
Copyright (C) The Internet Society (2005).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at ietf-
ipr@ietf.org.
Acknowledgement
Funding for the RFC Editor function is currently provided by the
Internet Society.
Chisholm & Perkins Standards Track [Page 19]