draft-ietf-entmib-state-07.txt   rfc4268.txt 
Entity MIB Working Group S. Chisholm Network Working Group S. Chisholm
Internet Draft Nortel Networks Request for Comments: 4268 Nortel Networks
Document: draft-ietf-entmib-state-07.txt D. Perkins Category: Standards Track D. Perkins
Category: Standards Track SNMPinfo SNMPinfo
Expiration Date: July 2005 January 2005 November 2005
Entity State MIB Entity State MIB
Status of this Memo Status of This Memo
By submitting this Internet-Draft, I certify that any applicable
patent or other IPR claims of which I am aware have been disclosed, or
will be disclosed, and any of which I become aware will be disclosed,
in accordance with RFC 3668.
This document is an Internet-Draft and is in full conformance
with all provisions of Section 10 of RFC2026.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as
Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six
months and may be updated, replaced, or obsoleted by other
documents at any time. It is inappropriate to use Internet-
Drafts as reference material or to cite them other than as
"work in progress."
The list of current Internet-Drafts can be accessed at This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
http://www.ietf.org/ietf/1id-abstracts.txt Copyright Notice
The list of Internet-Draft Shadow Directories can be accessed at Copyright (C) The Internet Society (2005).
http://www.ietf.org/shadow.html.
Abstract Abstract
This memo defines a portion of the Management Information Base (MIB) This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in the Internet community. for use with network management protocols in the Internet community.
In particular, it describes extensions to the Entity MIB to In particular, it describes extensions to the Entity MIB to provide
provide information about the state of physical entities. information about the state of physical entities.
In addition, this memo defines a set of Textual Conventions to
represent various states of an entity. The intent is that these
Textual Conventions will be imported and used in MIB modules that
would otherwise define their own representations.
Table of Contents Table of Contents
1. The Internet-Standard Management Framework 1. The Internet-Standard Management Framework ......................2
2. Entity State 2. Entity State ....................................................2
2.1. Hierarchical State Management 2.1. Hierarchical State Management ..............................3
2.2. Entity Redundancy 2.2. Entity Redundancy ..........................................3
2.3. Physical Entity Users 2.3. Physical Entity Users ......................................3
2.4. Physical Class Behaviour 2.4. Physical Class Behavior ....................................4
3. Relationship to Other MIBs 3. Relation to Other MIBs ..........................................4
3.1. Relation to Interfaces MIB 3.1. Relation to the Interfaces MIB .............................4
3.2. Relation to Alarm MIB 3.2. Relation to Alarm MIB ......................................5
3.3. Relation to Bridge MIB 3.3. Relation to Bridge MIB .....................................5
3.4. Relation to Host Resource MIB 3.4. Relation to the Host Resources MIB .........................5
4. Textual Conventions 4. Textual Conventions .............................................6
5. Definitions 5. Definitions .................................................... 9
6. Security Considerations 6. Security Considerations ........................................16
7. Intellectual Property 7. Acknowledgements ...............................................17
8. IANA Considerations 8. References .....................................................17
9. Authors' Addresses 8.1. Normative References ......................................17
10. Acknowledgements 8.2. Informative References ....................................18
11. References
12. Full Copyright Statement
1. The Internet-Standard Management Framework 1. The Internet-Standard Management Framework
For a detailed overview of the documents that describe the current For a detailed overview of the documents that describe the current
Internet-Standard Management Framework, please refer to section 7 of Internet-Standard Management Framework, please refer to section 7 of
RFC 3410 [RFC3410]. RFC 3410 [RFC3410].
Managed objects are accessed via a virtual information store, termed Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. MIB objects are generally the Management Information Base or MIB. MIB objects are generally
accessed through the Simple Network Management Protocol (SNMP). accessed through the Simple Network Management Protocol (SNMP).
Objects in the MIB are defined using the mechanisms defined in the Objects in the MIB are defined using the mechanisms defined in the
Structure of Management Information (SMI). This memo specifies a MIB Structure of Management Information (SMI). This memo specifies a MIB
module that is compliant to the SMIv2, which is described in STD 58, module that is compliant to the SMIv2, which is described in STD 58,
RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580
[RFC2580]. [RFC2580].
2. Entity State 2. Entity State
The goal in adding state objects to the Entity MIB [RFC2737] is to The goal in adding state objects to the Entity MIB [RFC4133] is to
define a useful subset of the possible state attributes that could define a useful subset of the possible state attributes that could be
be tracked for a given entity that both fit into the state models tracked for a given entity and that both fit into the state models
such as those used in the Interfaces MIB [RFC2863] as well as such as those used in the Interfaces MIB [RFC2863] as well as
leverage existing well-deployed models. The entStateTable contains leverage existing well-deployed models. The entStateTable contains
state objects that are a subset of the popular ISO/OSI states that state objects that are a subset of the popular ISO/OSI states that
are also defined in ITU's X.731 specification [X.731]. Objects are are also defined in ITU's X.731 specification [X.731]. Objects are
defined to capture administrative, operational and usage states. In defined to capture administrative, operational, and usage states. In
addition there are further state objects defined to provide addition, there are further state objects defined to provide more
additional information for these three basic states. information for these three basic states.
Administrative state indicates permission to use or prohibition Administrative state indicates permission to use or prohibition
against using the entity and is imposed through the management against using the entity and is imposed through the management
services. services.
Operational state indicates whether or not the entity is physically Operational state indicates whether or not the entity is physically
installed and working. Note that unlike the ifOperStatus [RFC2863], installed and working. Note that unlike the ifOperStatus [RFC2863],
this operational state is independent of the administrative state. this operational state is independent of the administrative state.
Usage state indicates whether or not the entity is in use at a Usage state indicates whether or not the entity is in use at a
skipping to change at page 3, line 53 skipping to change at page 3, line 11
capacity to serve additional users. In the context of this MIB, the capacity to serve additional users. In the context of this MIB, the
usage state refers to the ability of an entity to service other usage state refers to the ability of an entity to service other
entities within its containment hierarchy. entities within its containment hierarchy.
Alarm state indicates whether or not there are any alarms active Alarm state indicates whether or not there are any alarms active
against the entity. In addition to those alarm states defined in against the entity. In addition to those alarm states defined in
X.731 [X.731], warning and indeterminate status are also defined to X.731 [X.731], warning and indeterminate status are also defined to
provide a more complete mapping to the Alarm MIB [RFC3877]. provide a more complete mapping to the Alarm MIB [RFC3877].
Standby state indicates whether the entity is currently running as Standby state indicates whether the entity is currently running as
hot standby, cold standby or is currently providing service. hot standby or cold standby or is currently providing service.
The terms state and status are used interchangeably in this memo. The terms "state" and "status" are used interchangeably in this memo.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119]. document are to be interpreted as described in RFC 2119 [RFC2119].
2.1 Hierarchical State Management 2.1. Hierarchical State Management
Physical entities exist within a containment hierarchy. Physical Physical entities exist within a containment hierarchy. Physical
containment is defined by the entPhysicalContainedIn containment is defined by the entPhysicalContainedIn object[RFC4133].
object[RFC2737]. This raises some interesting issues not addressed This raises some interesting issues not addressed in existing work on
in existing work on state management. state management.
There are two types of state for an entity: There are two types of state for an entity:
1) The state of the entity independent of the states of its parents 1) The state of the entity independent of the states of its parents
and children in its containment hierarchy. This is often referred to and children in its containment hierarchy. This is often referred to
as raw state. as raw state.
2) The state of the entity, as it may be influenced by the state of 2) The state of the entity, as it may be influenced by the state of
its parents and children. This is often referred to as computed its parents and children. This is often referred to as computed
state. state.
All state objects in this memo are raw state. All state objects in this memo are raw state.
2.2 Entity Redundancy 2.2. Entity Redundancy
While this memo is not attempting to address the entire problem While this memo is not attempting to address the entire problem space
space around redundancy, the entStateStandby object provides an around redundancy, the entStateStandby object provides an important
important piece of state information for entities, which helps piece of state information for entities, which helps identify which
identify which pieces of redundant equipment are currently providing pieces of redundant equipment are currently providing service, and
service, and which are waiting in either hot or cold standby mode. which are waiting in either hot or cold standby mode.
2.3 Physical Entity Users 2.3. Physical Entity Users
There are three ways to define the 'user' of a physical entity There are three ways to define the 'user' of a physical entity
1. Direct Containment in physical hierarchy 1. Direct containment in physical hierarchy
2. Anywhere in physical hierarchy 2. Anywhere in physical hierarchy
3. As defined by a means outside the scope of this MIB. This could 3. As defined by a means outside the scope of this MIB. This could
include logical interfaces that could run on a port, software that include logical interfaces that could run on a port, software that
could run on a module, etc. could run on a module, etc.
Administrative, operational, alarm and standby state use all three Administrative, operational, alarm, and standby state use all three
definitions of 'user'. Usage state only supports the concept of definitions of 'user'. Usage state supports only the concept of
direct containment to simplify implementations of this object. direct containment to simplify implementations of this object.
2.4 Physical Class Behaviour 2.4. Physical Class Behavior
This MIB makes no effort to standardize on the behaviours and This MIB makes no effort to standardize the behaviors and
characteristics of the various physical classes [RFC2737], but characteristics of the various physical classes [RFC4133], but rather
rather how this information is reported. In looking at real-world how this information is reported. In looking at real-world products,
products, items within the same physical class vary substantially. items within the same physical class vary substantially. The MIB has
The MIB has therefore provided guidance on how to support objects therefore provided guidance on how to support objects where a
where a particular instance of a physical class can not support part particular instance of a physical class cannot support part or all of
or all of a particular state. a particular state.
3 Relation to other MIBs 3. Relation to Other MIBs
3.1 Relationship to the Interfaces MIB 3.1. Relation to the Interfaces MIB
The Interfaces MIB [RFC2863] defines the ifAdminStatus object, which The Interfaces MIB [RFC2863] defines the ifAdminStatus object, which
has states of up, down and testing and the ifOperStatus object, has states of up, down, and testing, and the ifOperStatus object,
which has states of up, down, testing, unknown, dormant, notPresent which has states of up, down, testing, unknown, dormant, notPresent,
and lowerLayerDown. and lowerLayerDown.
An ifAdminStatus of 'up' is equivalent to setting the entStateAdmin An ifAdminStatus of 'up' is equivalent to setting the entStateAdmin
object to 'unlocked'. An ifAdminStatus of 'down' is equivalent to object to 'unlocked'. An ifAdminStatus of 'down' is equivalent to
setting the entStateAdmin object to either 'locked' or setting the entStateAdmin object to either 'locked' or
'shuttingDown', depending on a systems interpretation of 'down'. 'shuttingDown', depending on a system's interpretation of 'down'.
An ifOperStatus of 'up' is equivalent to an entStateOper value of An ifOperStatus of 'up' is equivalent to an entStateOper value of
'enabled'. An ifOperStatus of 'down' due to operational failure is 'enabled'. An ifOperStatus of 'down' due to operational failure is
equivalent to an entStateOper value of 'disabled'. An ifOperStatus equivalent to an entStateOper value of 'disabled'. An ifOperStatus
of 'down' due to being administratively disabled is equivalent to an of 'down' due to being administratively disabled is equivalent to an
entStateAdmin value of 'locked' and an entStateOper value of either entStateAdmin value of 'locked' and an entStateOper value of either
'enabled' or 'disabled' depending on whether there are any known 'enabled' or 'disabled' depending on whether there are any known
issues that would prevent the entity from becoming operational when issues that would prevent the entity from becoming operational when
its entStateAdmin is set to 'unlocked'. An ifOperStatus of its entStateAdmin is set to 'unlocked'. An ifOperStatus of 'unknown'
'unknown' is equivalent to an entStateOper value of 'unknown'. The is equivalent to an entStateOper value of 'unknown'. The
ifOperStatus values of 'testing' and 'dormant' are not explicitly ifOperStatus values of 'testing' and 'dormant' are not explicitly
supported by this MIB, but the state objects will be able to reflect supported by this MIB, but the state objects will be able to reflect
other aspects of the entities administrative and operational state. other aspects of the entities' administrative and operational state.
The ifOperStatus values of 'notPresent' and 'lowerLayerDown' are in The ifOperStatus values of 'notPresent' and 'lowerLayerDown' are in
some ways computed states and so are therefore not supported in this some ways computed states and so are therefore not supported in this
MIB. They can though be computed by examining the states of entities MIB. They can, though, be computed by examining the states of
within this objects containment hierarchy and other available entities within this object's containment hierarchy and other
related states. available related states.
3.2 Relation to Alarm MIB 3.2. Relation to Alarm MIB
The entStateAlarm object indicates whether or not there are any The entStateAlarm object indicates whether or not there are any
active alarms against this entity. If there are active alarms, then active alarms against this entity. If there are active alarms, then
the alarmActiveTable in the Alarm MIB [Alarm MIB] should be searched the alarmActiveTable in the Alarm MIB [RFC3877] should be searched
for rows whose alarmActiveResourceId matches this entPhysicalIndex. for rows whose alarmActiveResourceId matches this entPhysicalIndex.
Alternatively, if the alarmActiveTable is queried first and an Alternatively, if the alarmActiveTable is queried first and an active
active alarm with a value of alarmActiveResourceId that matches this alarm with a value of alarmActiveResourceId that matches this
entPhysicalIndex is found, then entStateAlarm can be used to quickly entPhysicalIndex is found, then entStateAlarm can be used to quickly
determine if there are additional active alarms with a different determine if there are additional active alarms with a different
severity against this physical entity. severity against this physical entity.
3.3 Relation to Bridge MIB 3.3 Relation to Bridge MIB
For entities of physical type of 'port' that support the For entities of physical type of 'port' that support the
dot1dStpPortEnable object in the Bridge MIB [RFC1493], a value of dot1dStpPortEnable object in the Bridge MIB [RFC4188], a value of
'enabled' is equivalent to setting the entStateAdmin object to 'enabled' is equivalent to setting the entStateAdmin object to
'unlocked'. Setting dot1dStpPortEnable to 'disabled' is equivalent 'unlocked'. Setting dot1dStpPortEnable to 'disabled' is equivalent
to setting the entStateAdmin object to 'locked'. to setting the entStateAdmin object to 'locked'.
3.4 Relation to the Host Resources MIB 3.4 Relation to the Host Resources MIB
The hrDeviceStatus object in the Host Resources MIB [RFC2790] The hrDeviceStatus object in the Host Resources MIB [RFC2790]
provides an operational state for devices. For entities that provides an operational state for devices. For entities that
logically correspond to the concept of a device, a value of logically correspond to the concept of a device, a value of 'unknown'
'unknown' for hrDeviceStatus corresponds to an entStateOper value of for hrDeviceStatus corresponds to an entStateOper value of 'unknown'.
'unknown'. A value of 'running' corresponds to an entStateOper value A value of 'running' corresponds to an entStateOper value of
of 'enabled'. A value of 'warning' also corresponds to an 'enabled'. A value of 'warning' also corresponds to an entStateOper
entStateOper value of 'enabled', but with appropriate bits set in value of 'enabled', but with appropriate bits set in the
the entStateAlarm object to indicate the alarms corresponding to the entStateAlarm object to indicate the alarms corresponding to the
unusual error condition detected. A value of 'testing' or 'down' is unusual error condition detected. A value of 'testing' or 'down' is
equivalent to an entStateOper value of 'disabled'. equivalent to an entStateOper value of 'disabled'.
4. Textual Conventions 4. Textual Conventions
ENTITY-STATE-TC-MIB DEFINITIONS ::= BEGIN ENTITY-STATE-TC-MIB DEFINITIONS ::= BEGIN
IMPORTS IMPORTS
MODULE-IDENTITY, mib-2 FROM SNMPv2-SMI MODULE-IDENTITY, mib-2 FROM SNMPv2-SMI
TEXTUAL-CONVENTION FROM SNMPv2-TC; TEXTUAL-CONVENTION FROM SNMPv2-TC;
entityStateTc MODULE-IDENTITY entityStateTc MODULE-IDENTITY
LAST-UPDATED "200501230000Z" LAST-UPDATED "200511220000Z"
ORGANIZATION "IETF Entity MIB Working Group" ORGANIZATION "IETF Entity MIB Working Group"
CONTACT-INFO CONTACT-INFO
"General Discussion: entmib@ietf.org "General Discussion: entmib@ietf.org
To Subscribe: To Subscribe:
http://www.ietf.org/mailman/listinfo/entmib http://www.ietf.org/mailman/listinfo/entmib
http://www.ietf.org/html.charters/entmib-charter.html http://www.ietf.org/html.charters/entmib-charter.html
Sharon Chisholm Sharon Chisholm
Nortel Networks Nortel Networks
PO Box 3511 Station C PO Box 3511 Station C
Ottawa, Ont. K1Y 4H7 Ottawa, Ont. K1Y 4H7
Canada Canada
schishol@nortelnetworks.com schishol@nortel.com
Chisholm & Perkins Standards Track
2005
David T. Perkins David T. Perkins
548 Qualbrook Ct 548 Qualbrook Ct
San Jose, CA 95110 San Jose, CA 95110
USA USA
Phone: 408 394-8702 Phone: 408 394-8702
dperkins@snmpinfo.com" dperkins@snmpinfo.com"
DESCRIPTION DESCRIPTION
"This MIB defines state textual conventions. "This MIB defines state textual conventions.
Copyright (C) The Internet Society 2005. This Copyright (C) The Internet Society 2005. This version
version of this MIB module is part of RFC 4268; see the RFC
of this MIB module is part of RFC yyyy; see the RFC
itself for full legal notices." itself for full legal notices."
-- RFC Ed.: replace yyyy with actual RFC number & remove REVISION "200511220000Z"
-- this note
REVISION "200501230000Z"
DESCRIPTION DESCRIPTION
"Initial version, published as RFC yyyy." "Initial version, published as RFC 4268."
-- RFC-Editor assigns yyyy ::= { mib-2 130 }
::= { mib-2 XX } -- to be assigned by IANA
EntityAdminState ::= TEXTUAL-CONVENTION EntityAdminState ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
" Represents the various possible administrative states. " Represents the various possible administrative states.
A value of 'locked' means the resource is administratively A value of 'locked' means the resource is administratively
prohibited from use. A value of 'shuttingDown' means that prohibited from use. A value of 'shuttingDown' means that
usage is administratively limited to current instances of usage is administratively limited to current instances of
use. A value of 'unlocked' means the resource is not use. A value of 'unlocked' means the resource is not
skipping to change at page 9, line 4 skipping to change at page 8, line 34
implementation, may make the other values in this bit implementation, may make the other values in this bit
string not meaningful. string not meaningful.
When the value of 'critical' is set, one or more critical When the value of 'critical' is set, one or more critical
alarms are active against the resource. When the value alarms are active against the resource. When the value
of 'major' is set, one or more major alarms are active of 'major' is set, one or more major alarms are active
against the resource. When the value of 'minor' is set, against the resource. When the value of 'minor' is set,
one or more minor alarms are active against the resource. one or more minor alarms are active against the resource.
When the value of 'warning' is set, one or more warning When the value of 'warning' is set, one or more warning
alarms are active against the resource. When the value alarms are active against the resource. When the value
of 'indeterminate' is set, one or more alarms whose of of 'indeterminate' is set, one or more alarms of whose
perceived severity cannot be determined are active perceived severity cannot be determined are active
against this resource. against this resource.
A value of 'unknown' means that this resource is A value of 'unknown' means that this resource is
unable to report alarm state." unable to report alarm state."
SYNTAX BITS SYNTAX BITS
{ {
unknown (0), unknown (0),
underRepair (1), underRepair (1),
critical(2), critical(2),
skipping to change at page 9, line 21 skipping to change at page 9, line 4
{ {
unknown (0), unknown (0),
underRepair (1), underRepair (1),
critical(2), critical(2),
major(3), major(3),
minor(4), minor(4),
-- The following are not defined in X.733 -- The following are not defined in X.733
warning (5), warning (5),
indeterminate (6) indeterminate (6)
} }
EntityStandbyStatus ::= TEXTUAL-CONVENTION EntityStandbyStatus ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
" Represents the possible values of standby status. " Represents the possible values of standby status.
A value of 'hotStandby' means the resource is not A value of 'hotStandby' means the resource is not
providing service, but it will be immediately able to providing service, but it will be immediately able to
take over the role of the resource to be backed-up, take over the role of the resource to be backed up,
without the need for initialization activity, and will without the need for initialization activity, and will
contain the same information as the resource to be contain the same information as the resource to be
backed up. A value of 'coldStandy' means that the backed up. A value of 'coldStandy' means that the
resource is to back-up another resource, but will not resource is to back up another resource, but will not
be immediately able to take over the role of a resource be immediately able to take over the role of a resource
to be backed up, and will require some initialization to be backed up, and will require some initialization
activity. A value of 'providingService' means the activity. A value of 'providingService' means the
resource is providing service. A value of resource is providing service. A value of
'unknown' means that this resource is unable to 'unknown' means that this resource is unable to
report standby state." report standby state."
SYNTAX INTEGER SYNTAX INTEGER
{ {
unknown (1), unknown (1),
hotStandby (2), hotStandby (2),
skipping to change at page 10, line 17 skipping to change at page 9, line 50
FROM SNMPv2-TC FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
FROM SNMPv2-CONF FROM SNMPv2-CONF
entPhysicalIndex entPhysicalIndex
FROM ENTITY-MIB FROM ENTITY-MIB
EntityAdminState, EntityOperState, EntityUsageState, EntityAdminState, EntityOperState, EntityUsageState,
EntityAlarmStatus, EntityStandbyStatus EntityAlarmStatus, EntityStandbyStatus
FROM ENTITY-STATE-TC-MIB; FROM ENTITY-STATE-TC-MIB;
entityStateMIB MODULE-IDENTITY entityStateMIB MODULE-IDENTITY
LAST-UPDATED "200501230000Z" LAST-UPDATED "200511220000Z"
ORGANIZATION "IETF Entity MIB Working Group" ORGANIZATION "IETF Entity MIB Working Group"
CONTACT-INFO CONTACT-INFO
" General Discussion: entmib@ietf.org " General Discussion: entmib@ietf.org
To Subscribe: To Subscribe:
http://www.ietf.org/mailman/listinfo/entmib http://www.ietf.org/mailman/listinfo/entmib
http://www.ietf.org/html.charters/entmib-charter.html http://www.ietf.org/html.charters/entmib-charter.html
Sharon Chisholm Sharon Chisholm
Nortel Networks Nortel Networks
PO Box 3511 Station C PO Box 3511 Station C
Ottawa, Ont. K1Y 4H7 Ottawa, Ont. K1Y 4H7
Canada Canada
schishol@nortelnetworks.com schishol@nortel.com
David T. Perkins David T. Perkins
548 Qualbrook Ct 548 Qualbrook Ct
San Jose, CA 95110 San Jose, CA 95110
USA USA
Phone: 408 394-8702 Phone: 408 394-8702
dperkins@snmpinfo.com dperkins@snmpinfo.com
" "
DESCRIPTION DESCRIPTION
"This MIB defines a state extension to the Entity MIB. "This MIB defines a state extension to the Entity MIB.
Copyright (C) The Internet Society 2005. This version Copyright (C) The Internet Society 2005. This version
of this MIB module is part of RFC yyyy; see the RFC of this MIB module is part of RFC 4268; see the RFC
itself for full legal notices." itself for full legal notices."
-- RFC Ed.: replace yyyy with actual RFC number & remove REVISION "200511220000Z"
-- this note
REVISION "200501230000Z"
DESCRIPTION DESCRIPTION
"Initial version, published as RFC YYYY." "Initial version, published as RFC 4268."
-- RFC-Editor assigns yyyy ::= { mib-2 131 }
::= { mib-2 XX } -- to be assigned by IANA
-- Entity State Objects -- Entity State Objects
entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 } entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 }
entStateTable OBJECT-TYPE entStateTable OBJECT-TYPE
SYNTAX SEQUENCE OF EntStateEntry SYNTAX SEQUENCE OF EntStateEntry
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"A table of information about state/status of entities. "A table of information about state/status of entities.
This is a sparse augment of the entPhysicalTable. Entries This is a sparse augment of the entPhysicalTable. Entries
appear in this table for values of appear in this table for values of
entPhysicalClass [RFC2737] that in this implementation entPhysicalClass [RFC4133] that in this implementation
are able to report any of the state or status stored in are able to report any of the state or status stored in
this table. this table.
" "
::= { entStateObjects 1 } ::= { entStateObjects 1 }
entStateEntry OBJECT-TYPE entStateEntry OBJECT-TYPE
SYNTAX EntStateEntry SYNTAX EntStateEntry
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"State information about this physical entity." "State information about this physical entity."
INDEX { entPhysicalIndex } INDEX { entPhysicalIndex }
skipping to change at page 14, line 8 skipping to change at page 14, line 5
SYNTAX EntityAlarmStatus SYNTAX EntityAlarmStatus
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The alarm status for this entity. It does not include "The alarm status for this entity. It does not include
the alarms raised on child components within its the alarms raised on child components within its
containment hierarchy. containment hierarchy.
A value of 'unknown' means that this entity is A value of 'unknown' means that this entity is
unable to report alarm state. Note that this differs unable to report alarm state. Note that this differs
from 'indeterminate' which means that that alarm state from 'indeterminate', which means that alarm state
is supported and there are alarms against this entity, is supported and there are alarms against this entity,
but the severity of some of the alarms is not known but the severity of some of the alarms is not known.
If no bits are set, then this entity supports reporting If no bits are set, then this entity supports reporting
of alarms, but there are currently no active alarms of alarms, but there are currently no active alarms
against this entity. against this entity."
"
::= { entStateEntry 5 } ::= { entStateEntry 5 }
entStateStandby OBJECT-TYPE entStateStandby OBJECT-TYPE
SYNTAX EntityStandbyStatus SYNTAX EntityStandbyStatus
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The standby status for this entity. "The standby status for this entity.
Some entities will exhibit only a subset of the Some entities will exhibit only a subset of the
skipping to change at page 14, line 50 skipping to change at page 14, line 46
"An entStateOperEnabled notification signifies that the "An entStateOperEnabled notification signifies that the
SNMP entity, acting in an agent role, has detected that SNMP entity, acting in an agent role, has detected that
the entStateOper object for one of its entities has the entStateOper object for one of its entities has
transitioned into the 'enabled' state. transitioned into the 'enabled' state.
The entity this notification refers can be identified by The entity this notification refers can be identified by
extracting the entPhysicalIndex from one of the extracting the entPhysicalIndex from one of the
variable bindings. The entStateAdmin and entStateAlarm variable bindings. The entStateAdmin and entStateAlarm
varbinds may be examined to find out additional varbinds may be examined to find out additional
information on the administrative state at the time of information on the administrative state at the time of
the operation state change as well to find out whether the operation state change as well as to find out whether
there were any known alarms against the entity at that there were any known alarms against the entity at that
time that may explain why the physical entity has become time that may explain why the physical entity has become
operationally disabled." operationally disabled."
::= { entStateNotifications 1 } ::= { entStateNotifications 1 }
entStateOperDisabled NOTIFICATION-TYPE entStateOperDisabled NOTIFICATION-TYPE
OBJECTS { entStateAdmin, OBJECTS { entStateAdmin,
entStateAlarm } entStateAlarm }
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"An entStateOperDisabled notification signifies that the "An entStateOperDisabled notification signifies that the
SNMP entity, acting in an agent role, has detected that SNMP entity, acting in an agent role, has detected that
the entStateOper object for one of its entities has the entStateOper object for one of its entities has
transitioned into the 'disabled' state. transitioned into the 'disabled' state.
The entity this notification refers can be identified by The entity this notification refers can be identified by
extracting the entPhysicalIndex from one of the extracting the entPhysicalIndex from one of the
variable bindings. The entStateAdmin and entStateAlarm variable bindings. The entStateAdmin and entStateAlarm
varbinds may be examined to find out additional varbinds may be examined to find out additional
information on the administrative state at the time of information on the administrative state at the time of
the operation state change as well to find out whether the operation state change as well as to find out whether
there were any known alarms against the entity at that there were any known alarms against the entity at that
time that may have affect on the physical entity's time that may affect the physical entity's
ability to stay operationally enabled." ability to stay operationally enabled."
::= { entStateNotifications 2 } ::= { entStateNotifications 2 }
-- Conformance and Compliance -- Conformance and Compliance
entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 2 } entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 2 }
entStateCompliances OBJECT IDENTIFIER entStateCompliances OBJECT IDENTIFIER
::= { entStateConformance 1 } ::= { entStateConformance 1 }
skipping to change at page 16, line 29 skipping to change at page 16, line 32
} }
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Standard Entity State Notification group." "Standard Entity State Notification group."
::= { entStateGroups 2} ::= { entStateGroups 2}
END END
6. Security Considerations 6. Security Considerations
There is one management object - entStateAdmin - defined in this MIB The ENTITY-STATE-TC-MIB defined in section 4 does not define any
that has a MAX-ACCESS clause of read-write. The object may be management objects. Instead, it defines a set of textual conventions
considered sensitive or vulnerable in some network environments. that may be used by other MIB modules to define management objects.
The support for SET operations in a non-secure environment without Meaningful security considerations can only be written in the MIB
proper protection can have a negative effect on network operations. modules that define management objects. The ENTITY-STATE-TC-MIB has
therefore no impact on the security of the Internet.
Note that setting the entStateAdmin to 'locked' or 'shuttingDown' The ENTITY-STATE-MIB defined in section 5 defines one management
can cause disruption of services ranging from those running on a object -- entStateAdmin -- that has a MAX-ACCESS clause of read-
port to those on an entire device, depending on the type of entity. write. The object may be considered sensitive or vulnerable in some
Access to this object should be properly protected. 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.
Access to the objects defined in this MIB allows one to figure out Access to the objects defined in this MIB allows one to figure out
what the active and standby resources in a network are. This what the active and standby resources in a network are. This
information can be used to optimize attacks on networks so even information can be used to optimize attacks on networks so even
read-only access to this MIB should be properly protected. read-only access to this MIB should be properly protected.
SNMP versions prior to SNMPv3 did not include adequate security. SNMP versions prior to SNMPv3 did not include adequate security.
Even if the network itself is secure (for example by using IPSec), 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 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 allowed to access and GET/SET (read/change/create/delete) the objects
objects in this MIB module. in this MIB module.
It is RECOMMENDED that implementers consider the security features It is RECOMMENDED that implementers consider the security features as
as provided by the SNMPv3 framework (see [RFC3410], section 8), provided by the SNMPv3 framework (see [RFC3410], section 8),
including full support for the SNMPv3 cryptographic mechanisms (for including full support for the SNMPv3 cryptographic mechanisms (for
authentication and privacy). authentication and privacy).
Further, deployment of SNMP versions prior to SNMPv3 is NOT Further, deployment of SNMP versions prior to SNMPv3 is NOT
RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to
enable cryptographic security. It is then a customer/operator enable cryptographic security. It is then a customer/operator
responsibility to ensure that the SNMP entity giving access to an responsibility to ensure that the SNMP entity giving access to an
instance of this MIB module is properly configured to give access to instance of this MIB module is properly configured to give access to
the objects only to those principals (entities) that have legitimate the objects only to those principals (entities) that have legitimate
rights to indeed GET or SET (change/create/delete) them. rights to indeed GET or SET (change/create/delete) them.
7. Intellectual Property 7. Acknowledgements
The IETF takes no position regarding the validity or scope of any
intellectual property 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; neither does it represent that it
has made any effort to identify any such rights. Information on the
IETF's procedures with respect to rights in standards-track and
standards-related documentation can be found in BCP-11. Copies of
claims of rights made available for publication 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 implementors or users of this specification
can be obtained from the IETF Secretariat.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights which may cover technology that may be required to practice
this standard. Please address the information to the IETF Executive
Director.
8. IANA Considerations
This draft requires no action on the part of IANA other than the
allocation of the MIB OID from which to root this MIB. This section
should be removed prior to publication as and RFC.
9. Authors' Addresses
Sharon Chisholm
Nortel Networks
PO Box 3511, Station C
Ottawa, Ontario, K1Y 4H7
Canada
Email: schishol@nortelnetworks.com
David T. Perkins
548 Qualbrook Ct
San Jose, CA 95110
USA
Phone: 408 394-8702
Email: dperkins@snmpinfo.com
10. Acknowledgments
This document is a product of the Entity MIB Working Group. This document is a product of the Entity MIB Working Group.
11. References 8. References
11.1 Normative 8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M. and S. Waldbusser, "Structure of Management Rose, M., and S. Waldbusser, "Structure of Management
Information Version 2 (SMIv2)", STD 58, RFC 2578, April Information Version 2 (SMIv2)", STD 58, RFC 2578, April
1999. 1999.
[RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M. and S. Waldbusser, "Textual Conventions for Rose, M., and S. Waldbusser, "Textual Conventions for
SMIv2", STD 58, RFC 2579, April 1999. SMIv2", STD 58, RFC 2579, April 1999.
[RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M. and S. Waldbusser, "Conformance Statements for Rose, M., and S. Waldbusser, "Conformance Statements for
SMIv2", STD 58, RFC 2580, April 1999. SMIv2", STD 58, RFC 2580, April 1999.
[RFC2737] McCloghrie, K., Bierman, A., "Entity MIB (Version 2)", [RFC4133] Bierman, A. and K. McCloghrie, "Entity MIB (Version 3)",
December 1999. [Note to RFC Editor: If later version of RFC 4133, August 2005.
RFC2727 is available at time of publication, please update this
references]
11.2 Informative References
[RFC1493] Decker, E., Langille, P., Rijsinghani, A., McCloghrie, K., 8.2. Informative References
"Definitions of Managed Objects for Bridges", RFC 1493,
July 1993
[RFC2790] Waldbusser, S., Grillo, P., "Host Resources MIB", [RFC2790] Waldbusser, S. and P. Grillo, "Host Resources MIB", RFC
RFC 2790, March 2000 2790, March 2000.
[RFC2863] McCloghrie, K., Kastenholz, F., "The Interfaces Group [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group
MIB using SMIv2", RFC2863, June 2000 MIB using SMIv2", RFC 2863, June 2000.
[RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart,
"Introduction and Applicability Statements for Internet- "Introduction and Applicability Statements for Internet-
Standard Management Framework", RFC 3410, December 2002. Standard Management Framework", RFC 3410, December 2002.
[RFC3877] Chisholm, S., Romascanu, D., "Alarm Management Information [RFC3877] Chisholm, S. and D. Romascanu, "Alarm Management
Base (MIB)", RFC 3877, September 2004 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 [X.731] ITU Recommendation X.731, "Information Technology - Open
Systems Interconnection - System Management: State Systems Interconnection - System Management: State
Management Function", 1992 Management Function", 1992.
12. Full Copyright Statement Authors' Addresses
Copyright (C) The Internet Society (2005). This document is subject Sharon Chisholm
to the rights, licenses and restrictions contained in BCP 78, and Nortel Networks
except as set forth therein, the authors retain all their rights." PO Box 3511, Station C
Ottawa, Ontario, K1Y 4H7
Canada
"This document and the information contained herein are provided on EMail: schishol@nortel.com
an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE
REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE David T. Perkins
INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR 548 Qualbrook Ct
IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF San Jose, CA 95110
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED USA
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE."
Phone: 408 394-8702
EMail: dperkins@snmpinfo.com
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.
 End of changes. 76 change blocks. 
225 lines changed or deleted 163 lines changed or added

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