CISCO-ENERGYWISE-MIB

The MIB is used to manage and optimize power usage
in networks. 

Cisco EnergyWise is a specification of data, discovery and
protocols for managing power on and between network devices.

An entity is Cisco EnergyWise compatible, if it complies with
Cisco EnergyWise specification.

A Cisco EnergyWise entity is characterized by the power related
attributes of a physical entity present in ENTITY-MIB. 

Cisco EnergyWise solves the problem of Network Power
Management.   One of goals of Cisco EnergyWise is to manage
power on network level.  Some solutions in FCAPS have focused
on
managing a single element but Cisco EnergyWise provides the
capability to handle the management of a network of devices, as
well as a single device. 

Concepts and Definitions:
=========================
Cisco EnergyWise Entity: A physical entity that is part of the
network that provides power or draws power from another 
part of the network.

Cisco EnergyWise Level: A uniform way to classify power
settings on an EnergyWise entity.  Levels are guidelines for
the manufacturers of entity (e.g., shut, hibernate, sleep,
standby).

Cisco EnergyWise Usage: The consumption of power by a Cisco
EnergyWise entity in watts.

    Current         The current power consumption by an 
                    Cisco EnergyWise entity.

    Provisioned     The maximum power a Cisco EnergyWise
                    entity can draw in the current level.

    Usage Vector    A vector 0..10 representing the maximum
                    power a Cisco EnergyWise entity can draw at
                    each level. 

    Delta Vector    This defines a vector 0..10 representing
                    the difference between the Current and
                    Usage Vector for each level.

Cisco EnergyWise Entity Power Unit: This is used to represent
smaller or larger quantities of Cisco EnergyWise usage and
conforms to the standard prefixes for the SI (System
International) units of measure.  The value represents an
exponent of 10.

    For example, if current usage of an EnergyWise entity is 
    3, it could be 3 W, 3 mW, 3 KW, 3 MW depending on the value
    of Cisco EnergyWise power unit, i.e. 0, -3, 3, or 6 
    respectively.

Cisco EnergyWise Domain: A collection of entities that is
divided into manageable sets.  Switch, IP phones, IP cameras,
lighting controllers can be Cisco EnergyWise entities, all part
of a domain.  A domain can contain multiple devices.

Cisco EnergyWise Entity Importance: The importance attribute of
an entity enables the management station to differentiate other
Cisco EnergyWise entities in the domain with a different
business context.  This also provides a choice to the
administrators to manage power in context of importance.

    For example, assuming we have 2 phones deployed in a
    enterprise.  One phone is in a shared spare office and one 
    used by trader generating lot of money as part of core
    business of enterprise.

    This clearly demonstrates that the phone used by trader is
    more important than the phone used in the spare office.

Nanny Vector: A vector of bits, representing different features
(E.g., sleep, wakeup, shutdown) supported on a Cisco
EnergyWise entity.  Setting of some of the features on the
Cisco EnergyWise entity can be managed by itself, but for some
others, a parent has to nanny.

Nanny: An EnergyWise entity acts on behalf of another 
another Cisco EnergyWise entity.

Cisco EnergyWise Parent: A Cisco EnergyWise entity that does
not have a nanny vector.  This entity can manage all its power
setting for itself as well as for Cisco EnergyWise entities
contained in it.  The contained in relationship is same as
defined in ENTITY-MIB. 

Cisco EnergyWise Child: A Cisco EnergyWise entity that has a
nanny vector.  It requires a Cisco EnergyWise parent to serve
as nanny.  Depending on the nanny vector a Cisco EnergyWise
child can be fully or partially managed.  

Cisco EnergyWise Neighbor: A Cisco EnergyWise entity to which
Cisco EnergyWise protocol events can be forwarded to.  An
entity can either discover a neighbor using a discovery
protocol, or the neighbor can be configured as a static
neighbor
by the Management station.  A Cisco EnergyWise parent may also
nanny a Cisco EnergyWise neighbor.

    For example, A Cisco EnergyWise compatible entity like an
    IP phone, connected to a port on the switch, can provide a 
    nanny vector to the switch to serve as a nanny.

Cisco EnergyWise Proxy: A device attached to a port that does
not understand the Cisco EnergyWise protocol, but has the
provision to manage power through network APIs or a proprietary
protocol.  

A Proxy is always configured on a port.  It allows the
Cisco EnergyWise protocol to be used with other non networking
devices that draw power indirectly. 

    For example, a Lutron controller (building lighting 
    controller) is a nonnetworking device which does not
    understand Cisco EnergyWise protocol.  However, it runs a 
    proprietary BACNET protocol.

The following diagram represents the relationship between 
cewEntTable and cewNeighborTable, 
cewEntTable and cewProxyTable.


                      Points to a 
--------------------- nbr entry for    ---------------------
| EntPhyIdx | NbrId | which it does    | NbrId |  Name     |
--------------------- Nanny            ---------------------
| 101       |   1   |----------------->|    1  | IP-Phone1 |
---------------------                  ---------------------
| 102       |   0   |                  |    2  | Switch1   |
---------------------                  ---------------------
| 103       |   3   |----------------->|    3  | IP-Phone2 |
---------------------                  ---------------------
| 104       |   0   |----------        |       |           |
---------------------         |        ---------------------
| 105       |   0   |-----    |        |       |           |
---------------------    |    |        ---------------------
                         |    |
Points to proxy          |    |   -----------------------------
entry configured         |    |   | EntPhyIdx | PrxyId | Name |
on this port.            |    |  -----------------------------
                         |    |-->|  104      |  1     | LC1  |
                         |        -----------------------------
                         |        |           |        |      |
                         |        -----------------------------
                         -------> |  105      |  3     | BL2  |
                                  -----------------------------
                                  |           |        |      |
                                  -----------------------------

Cisco EnergyWise Event: It is a policy that can be either
configured on a Cisco EnergyWise entity or received from
other Cisco EnergyWise entities.  Using this, a Cisco
EnergyWise entity can adjust its power settings according
to some criteria, typically time.

    For example, a Management station can configure an
    EnergyWise event on a switch to control devices in branch 
    offices, to go to power level standby at 8pm and power
    level full at 7am.

Cisco Energywise Query: It is a Cisco Energywise CLI used to
get
power information from the entire Energywise Domain. Queries
are
delivered, hop by hop, through the Domain using the established
neighbor information. Authentication is by the domain's shared
secret, and only authenticated queries can be sent to
EndPoints. EnergyWise supports various kinds of queries,
including set, collect, sum and delta.
   set: changes or turns off power usage levels
   collect: retrieves power usage information (in watts) from
the cloud.  
   sum: aggregates power information across multiple Members
and Endpoints. 
   delta: runs what if calculations.

Cisco EnergyWise Neighbor Id : The Cisco EnergyWise Neighbor's
unique Id is made up of two parts:-
    UDI: Unique Device Indentification of the Cisco EnergyWise
Neighbor.
    EntPhysicalIndex: The Entity Physical Index of the Cisco
EnergyWise Neighbor.
A combination of these two values provide a unique Id for the
Cisco EnergyWise Neighbor.

Imported Objects

ciscoMgmtCISCO-SMI
EntPhysicalIndexOrZeroCISCO-TC
entityMIBObjects, entPhysicalIndexENTITY-MIB
InetPortNumber, InetAddressType, InetAddressINET-ADDRESS-MIB
SnmpAdminStringSNMP-FRAMEWORK-MIB
MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUPSNMPv2-CONF
OBJECT-TYPE, Counter32, Gauge32, Unsigned32, Integer32, NOTIFICATION-TYPE, MODULE-IDENTITYSNMPv2-SMI
TEXTUAL-CONVENTION, StorageType, TimeStamp, MacAddress, TruthValue, RowStatusSNMPv2-TC
ciscoEnergywiseMIB.1.3.6.1.4.1.9.9.683
ciscoEnergywiseMIBNotifs .1.3.6.1.4.1.9.9.683.0
cewLevelChange .1.3.6.1.4.1.9.9.683.0.1
cewNeighborAdded .1.3.6.1.4.1.9.9.683.0.2
cewNeighborDeleted .1.3.6.1.4.1.9.9.683.0.3
cewEventOccured deprecated.1.3.6.1.4.1.9.9.683.0.4
cewEventOccuredRev1 .1.3.6.1.4.1.9.9.683.0.5
ciscoEnergywiseMIBObjects .1.3.6.1.4.1.9.9.683.1
cewDeviceId .1.3.6.1.4.1.9.9.683.1.1
cewEventTable .1.3.6.1.4.1.9.9.683.1.10
cewEventEntry .1.3.6.1.4.1.9.9.683.1.10.1
cewEventIndex .1.3.6.1.4.1.9.9.683.1.10.1.1
cewEventLevel .1.3.6.1.4.1.9.9.683.1.10.1.2
cewEventRecurrence .1.3.6.1.4.1.9.9.683.1.10.1.3
cewEventTime .1.3.6.1.4.1.9.9.683.1.10.1.4
cewEventStorage .1.3.6.1.4.1.9.9.683.1.10.1.5
cewEventStatus .1.3.6.1.4.1.9.9.683.1.10.1.6
cewEventImportance .1.3.6.1.4.1.9.9.683.1.10.1.7
cewLevelChangeNotifEnable .1.3.6.1.4.1.9.9.683.1.11
cewNeighborAddedNotifEnable .1.3.6.1.4.1.9.9.683.1.12
cewNeighborDeletedNotifEnable .1.3.6.1.4.1.9.9.683.1.13
cewEventOccuredNotifEnable .1.3.6.1.4.1.9.9.683.1.14
cewEventOccuredErrorCode .1.3.6.1.4.1.9.9.683.1.15
cewManagementSecret .1.3.6.1.4.1.9.9.683.1.16
cewEndPointSecret .1.3.6.1.4.1.9.9.683.1.17
cewDomainSecret .1.3.6.1.4.1.9.9.683.1.18
cewProtocol .1.3.6.1.4.1.9.9.683.1.19
cewDeviceNeighborCount .1.3.6.1.4.1.9.9.683.1.2
cewAddressType .1.3.6.1.4.1.9.9.683.1.20
cewAddress .1.3.6.1.4.1.9.9.683.1.21
cewPort .1.3.6.1.4.1.9.9.683.1.22
cewEnable .1.3.6.1.4.1.9.9.683.1.23
cewVersion .1.3.6.1.4.1.9.9.683.1.24
cewDeviceTotalUsage .1.3.6.1.4.1.9.9.683.1.25
cewDeviceTotalUsageUnits .1.3.6.1.4.1.9.9.683.1.26
cewDeviceType .1.3.6.1.4.1.9.9.683.1.27
cewAllowSet .1.3.6.1.4.1.9.9.683.1.28
cewNeighborLevelTable .1.3.6.1.4.1.9.9.683.1.29
cewNeighborLevelEntry .1.3.6.1.4.1.9.9.683.1.29.1
cewNeighborLevelIndex .1.3.6.1.4.1.9.9.683.1.29.1.1
cewNeighborLevelMaxUsage .1.3.6.1.4.1.9.9.683.1.29.1.2
cewNeighborLevelDeltaUsage .1.3.6.1.4.1.9.9.683.1.29.1.3
cewNeighborLevelUnits .1.3.6.1.4.1.9.9.683.1.29.1.4
cewDomainName .1.3.6.1.4.1.9.9.683.1.3
cewMaxImportance .1.3.6.1.4.1.9.9.683.1.4
cewMaxImportanceId .1.3.6.1.4.1.9.9.683.1.5
cewEntTable .1.3.6.1.4.1.9.9.683.1.6
cewEntEntry .1.3.6.1.4.1.9.9.683.1.6.1
cewEntNannyVector .1.3.6.1.4.1.9.9.683.1.6.1.1
cewEntEnergyLevel .1.3.6.1.4.1.9.9.683.1.6.1.10
cewEntEnergyUsageProvisioned .1.3.6.1.4.1.9.9.683.1.6.1.11
cewEntImportanceInt .1.3.6.1.4.1.9.9.683.1.6.1.12
cewEntImportanceExt .1.3.6.1.4.1.9.9.683.1.6.1.13
cewEntImportanceRelative .1.3.6.1.4.1.9.9.683.1.6.1.14
cewEntImportanceParentId .1.3.6.1.4.1.9.9.683.1.6.1.15
cewEntParentId .1.3.6.1.4.1.9.9.683.1.6.1.16
cewEntAdminStatus .1.3.6.1.4.1.9.9.683.1.6.1.17
cewEntOperStatus .1.3.6.1.4.1.9.9.683.1.6.1.18
cewEntConfiguredLevel .1.3.6.1.4.1.9.9.683.1.6.1.19
cewEntNeighborIndex .1.3.6.1.4.1.9.9.683.1.6.1.2
cewEntEnergyUsageCategory .1.3.6.1.4.1.9.9.683.1.6.1.20
cewEntEnergyUsageDirection .1.3.6.1.4.1.9.9.683.1.6.1.21
cewEntAllowSet .1.3.6.1.4.1.9.9.683.1.6.1.22
cewEntActivityCheck .1.3.6.1.4.1.9.9.683.1.6.1.23
cewEntKeyword .1.3.6.1.4.1.9.9.683.1.6.1.3
cewEntName .1.3.6.1.4.1.9.9.683.1.6.1.4
cewEntRoleDescription .1.3.6.1.4.1.9.9.683.1.6.1.5
cewEntFullName .1.3.6.1.4.1.9.9.683.1.6.1.6
cewEntEnergyUnits .1.3.6.1.4.1.9.9.683.1.6.1.7
cewEntEnergyUsage .1.3.6.1.4.1.9.9.683.1.6.1.8
cewEntEnergyUsageCaliber .1.3.6.1.4.1.9.9.683.1.6.1.9
cewLevelTable .1.3.6.1.4.1.9.9.683.1.7
cewLevelEntry .1.3.6.1.4.1.9.9.683.1.7.1
cewLevelIndex .1.3.6.1.4.1.9.9.683.1.7.1.1
cewLevelMaxUsage .1.3.6.1.4.1.9.9.683.1.7.1.2
cewLevelDeltaUsage .1.3.6.1.4.1.9.9.683.1.7.1.3
cewLevelUnits .1.3.6.1.4.1.9.9.683.1.7.1.4
cewProxyTable .1.3.6.1.4.1.9.9.683.1.8
cewProxyEntry .1.3.6.1.4.1.9.9.683.1.8.1
cewProxyId .1.3.6.1.4.1.9.9.683.1.8.1.1
cewProxyAddressType .1.3.6.1.4.1.9.9.683.1.8.1.2
cewProxyAddress .1.3.6.1.4.1.9.9.683.1.8.1.3
cewProxyPort .1.3.6.1.4.1.9.9.683.1.8.1.4
cewProxyClass .1.3.6.1.4.1.9.9.683.1.8.1.5
cewProxyStorage .1.3.6.1.4.1.9.9.683.1.8.1.6
cewProxyStatus .1.3.6.1.4.1.9.9.683.1.8.1.7
cewNeighborTable .1.3.6.1.4.1.9.9.683.1.9
cewNeighborEntry .1.3.6.1.4.1.9.9.683.1.9.1
cewNeighborIndex .1.3.6.1.4.1.9.9.683.1.9.1.1
cewNeighborName .1.3.6.1.4.1.9.9.683.1.9.1.10
cewNeighborConfiguredName .1.3.6.1.4.1.9.9.683.1.9.1.11
cewNeighborRoleDescription .1.3.6.1.4.1.9.9.683.1.9.1.12
cewNeighborConfiguredRoleDesc .1.3.6.1.4.1.9.9.683.1.9.1.13
cewNeighborEnergyLevel .1.3.6.1.4.1.9.9.683.1.9.1.14
cewNeighborConfiguredLevel .1.3.6.1.4.1.9.9.683.1.9.1.15
cewNeighborImportance .1.3.6.1.4.1.9.9.683.1.9.1.16
cewNeighborConfiguredImportance .1.3.6.1.4.1.9.9.683.1.9.1.17
cewNeighborEnergyUnits .1.3.6.1.4.1.9.9.683.1.9.1.18
cewNeighborEnergyUsage .1.3.6.1.4.1.9.9.683.1.9.1.19
cewNeighborId .1.3.6.1.4.1.9.9.683.1.9.1.2
cewNeighborEnergyUsageCategory .1.3.6.1.4.1.9.9.683.1.9.1.20
cewNeighborEnergyUsageDirection .1.3.6.1.4.1.9.9.683.1.9.1.21
cewNeighborMacAddress .1.3.6.1.4.1.9.9.683.1.9.1.22
cewNeighborPhysicalEntityId .1.3.6.1.4.1.9.9.683.1.9.1.23
cewNeighborParentPortIndex .1.3.6.1.4.1.9.9.683.1.9.1.24
cewNeighborType .1.3.6.1.4.1.9.9.683.1.9.1.3
cewNeighborHeartBeat .1.3.6.1.4.1.9.9.683.1.9.1.4
cewNeighborStorage .1.3.6.1.4.1.9.9.683.1.9.1.5
cewNeighborStatus .1.3.6.1.4.1.9.9.683.1.9.1.6
cewNeighborDeviceType .1.3.6.1.4.1.9.9.683.1.9.1.7
cewNeighborKeyword .1.3.6.1.4.1.9.9.683.1.9.1.8
cewNeighborConfiguredKeyword .1.3.6.1.4.1.9.9.683.1.9.1.9
ciscoEnergywiseMIBConform .1.3.6.1.4.1.9.9.683.2
ciscoEnergywiseMIBCompliances .1.3.6.1.4.1.9.9.683.2.1
ciscoEnergywiseMIBGroups .1.3.6.1.4.1.9.9.683.2.2