module ENTITY-STATE-MIB {
yang-version 1;
namespace
"urn:ietf:params:xml:ns:yang:smiv2:ENTITY-STATE-MIB";
prefix entity-state-mib;
import ENTITY-MIB {
prefix entity-mib;
}
import ENTITY-STATE-TC-MIB {
prefix entity-state;
}
import SNMPv2-TC {
prefix smiv2;
}
import yang-smi {
prefix smi;
}
organization
"IETF Entity MIB Working Group";
contact
" 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 "2005-11-22" {
description
"Initial version, published as RFC 4268.";
}
container entStateObjects {
smi:oid "1.3.6.1.2.1.131.1";
list entStateEntry {
smi:oid "1.3.6.1.2.1.131.1.1.1";
key "entPhysicalIndex";
description
"State information about this physical entity.";
leaf entPhysicalIndex {
type leafref {
path "/entity-mib:entityPhysical/entity-mib:entPhysicalEntry/entity-mib:entPhysicalIndex";
}
description
"Automagically generated leafref leaf.";
}
leaf entStateLastChanged {
smi:oid "1.3.6.1.2.1.131.1.1.1.1";
type smiv2:DateAndTime;
config false;
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.";
}
leaf entStateAdmin {
smi:oid "1.3.6.1.2.1.131.1.1.1.2";
type entity-state:EntityAdminState;
description
"The administrative state for this entity.
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.";
}
leaf entStateOper {
smi:oid "1.3.6.1.2.1.131.1.1.1.3";
type entity-state:EntityOperState;
config false;
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
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'.";
}
leaf entStateUsage {
smi:oid "1.3.6.1.2.1.131.1.1.1.4";
type entity-state:EntityUsageState;
config false;
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'.";
}
leaf entStateAlarm {
smi:oid "1.3.6.1.2.1.131.1.1.1.5";
type entity-state:EntityAlarmStatus;
config false;
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
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.";
}
leaf entStateStandby {
smi:oid "1.3.6.1.2.1.131.1.1.1.6";
type entity-state:EntityStandbyStatus;
config false;
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'.";
}
} // list entStateEntry
} // container entStateObjects
notification entStateOperEnabled {
smi:oid "1.3.6.1.2.1.131.0.1";
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.";
container entStateOperEnabled-entStateAdmin {
leaf entPhysicalIndex {
type leafref {
path "/entity-mib:entityPhysical/entity-mib:entPhysicalEntry/entity-mib:entPhysicalIndex";
}
config false;
description
"Automagically generated leafref leaf.";
}
leaf entStateAdmin {
smi:oid "1.3.6.1.2.1.131.1.1.1.2";
type entity-state:EntityAdminState;
config false;
description
"The administrative state for this entity.
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.";
}
} // container entStateOperEnabled-entStateAdmin
container entStateOperEnabled-entStateAlarm {
leaf entPhysicalIndex {
type leafref {
path "/entity-mib:entityPhysical/entity-mib:entPhysicalEntry/entity-mib:entPhysicalIndex";
}
config false;
description
"Automagically generated leafref leaf.";
}
leaf entStateAlarm {
smi:oid "1.3.6.1.2.1.131.1.1.1.5";
type entity-state:EntityAlarmStatus;
config false;
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
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.";
}
} // container entStateOperEnabled-entStateAlarm
} // notification entStateOperEnabled
notification entStateOperDisabled {
smi:oid "1.3.6.1.2.1.131.0.2";
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.";
container entStateOperDisabled-entStateAdmin {
leaf entPhysicalIndex {
type leafref {
path "/entity-mib:entityPhysical/entity-mib:entPhysicalEntry/entity-mib:entPhysicalIndex";
}
config false;
description
"Automagically generated leafref leaf.";
}
leaf entStateAdmin {
smi:oid "1.3.6.1.2.1.131.1.1.1.2";
type entity-state:EntityAdminState;
config false;
description
"The administrative state for this entity.
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.";
}
} // container entStateOperDisabled-entStateAdmin
container entStateOperDisabled-entStateAlarm {
leaf entPhysicalIndex {
type leafref {
path "/entity-mib:entityPhysical/entity-mib:entPhysicalEntry/entity-mib:entPhysicalIndex";
}
config false;
description
"Automagically generated leafref leaf.";
}
leaf entStateAlarm {
smi:oid "1.3.6.1.2.1.131.1.1.1.5";
type entity-state:EntityAlarmStatus;
config false;
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
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.";
}
} // container entStateOperDisabled-entStateAlarm
} // notification entStateOperDisabled
} // module ENTITY-STATE-MIB
