EZ5 MIB Catalog

ENERGY-OBJECT-MIB

2015-02-09

Download ENERGY-OBJECT-MIB.txt Open ENERGY-OBJECT-MIB.txt in a new tab

Copyright (c) 2015 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). This MIB is used to monitor power and energy in devices. The tables eoMeterCapabilitiesTable and eoPowerTable are a sparse extension of the eoTable from the ENERGY-OBJECT-CONTEXT-MIB. As a requirement, [RFC7461] SHOULD be implemented. Module Compliance of ENTITY-MIB v4 with respect to entity4CRCompliance MUST be supported which requires implementation of 4 MIB objects: entPhysicalIndex, entPhysicalClass, entPhysicalName and entPhysicalUUID.

SCALARS (1) · TABLES (5) · TRAPS (1)

Scalars (1)

NameOID
eoPowerEnableStatusNotification1.3.6.1.2.1.229.0.1

Tables (5)

NameOID
eoMeterCapabilitiesTable1.3.6.1.2.1.229.1.1
eoPowerTable1.3.6.1.2.1.229.1.2
eoPowerStateTable1.3.6.1.2.1.229.1.3
eoEnergyParametersTable1.3.6.1.2.1.229.1.4
eoEnergyTable1.3.6.1.2.1.229.1.5

Traps (1)

NameOID
eoPowerStateChange1.3.6.1.2.1.229.0.2

END OF TOC

Scalar details

eoPowerEnableStatusNotification

1.3.6.1.2.1.229.0.1

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object controls whether the system produces notifications for eoPowerStateChange. A false value will prevent these notifications from being generated.

Table details

eoMeterCapabilitiesTable

1.3.6.1.2.1.229.1.1

Index: entPhysicalIndex

This table is useful for helping applications determine the monitoring capabilities supported by the local management agents. It is possible for applications to know which tables are usable without going through a trial-and-error process.

from ENTITY-MIB

entPhysicalIndex

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

The index for this entry.

eoMeterCapability

1.3.6.1.2.1.229.1.1.1.1

BITS

An indication of the energy-monitoring capabilities supported by this agent. This object use a BITS syntax and indicates the MIB groups supported by the probe. By reading the value of this object, it is possible to determine the MIB tables supported.

eoPowerTable

1.3.6.1.2.1.229.1.2

Index: entPhysicalIndex

This table lists Energy Objects.

from ENTITY-MIB

entPhysicalIndex

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

The index for this entry.

eoPower

1.3.6.1.2.1.229.1.2.1.1

Integer32 · watts

This object indicates the power measured for the Energy Object. For alternating current, this value is obtained as an average over fixed number of AC cycles. This value is specified in SI units of watts with the magnitude of watts (milliwatts, kilowatts, etc.) indicated separately in eoPowerUnitMultiplier. The accuracy of the measurement is specified in eoPowerAccuracy. The direction of power flow is indicated by the sign on eoPower. If the Energy Object is consuming power, the eoPower value will be positive. If the Energy Object is producing power, the eoPower value will be negative. The eoPower MUST be less than or equal to the maximum power that can be consumed at the Power State specified by eoPowerState. The eoPowerMeasurementCaliber object specifies how the usage value reported by eoPower was obtained. The eoPower value must report 0 if the eoPowerMeasurementCaliber is 'unavailable'. For devices that cannot measure or report power, this option can be used.

eoPowerNameplate

1.3.6.1.2.1.229.1.2.1.2

Unsigned32 · watts

This object indicates the rated maximum consumption for the fully populated Energy Object. The nameplate power requirements are the maximum power numbers given in SI watts and, in almost all cases, are well above the expected operational consumption. Nameplate power is widely used for power provisioning. This value is specified in either units of watts or voltage and current. The units are therefore SI watts or equivalent Volt-Amperes with the magnitude (milliwatts, kilowatts, etc.) indicated separately in eoPowerUnitMultiplier.

eoPowerUnitMultiplier

1.3.6.1.2.1.229.1.2.1.3

UnitMultiplier-24 = yocto-21 = zepto-18 = atto-15 = femto-12 = pico-9 = nano-6 = micro-3 = milli0 = units3 = kilo6 = mega9 = giga12 = tera15 = peta18 = exa21 = zetta24 = yottaThe Unit Multiplier is an integer value that represents the IEEE 61850 Annex A units multiplier associated with the integer units used to measure the power or energy. For example, when used with eoPowerUnitMultiplier, -3 represents 10^-3 or milliwatts.Reference: The International System of Units (SI), National Institute of Standards and Technology, Spec. Publ. 330, August 1991. · Integer32

The magnitude of watts for the usage value in eoPower and eoPowerNameplate.

eoPowerAccuracy

1.3.6.1.2.1.229.1.2.1.4

Integer32 (0..10000) · hundredths of percent

This object indicates a percentage value, in hundredths of a percent, representing the assumed accuracy of the usage reported by eoPower. For example, the value 1010 means the reported usage is accurate to +/- 10.1 percent. This value is zero if the accuracy is unknown or not applicable based upon the measurement method. ANSI and IEC define the following accuracy classes for power measurement: IEC 62053-22 60044-1 class 0.1, 0.2, 0.5, 1 3. ANSI C12.20 class 0.2, 0.5

eoPowerMeasurementCaliber

1.3.6.1.2.1.229.1.2.1.5

INTEGER1 = unavailable2 = unknown3 = actual4 = estimated5 = static · Integer32

This object specifies how the usage value reported by eoPower was obtained: - unavailable(1): Indicates that the usage is not available. In such a case, the eoPower value must be 0 for devices that cannot measure or report power this option can be used. - unknown(2): Indicates that the way the usage was determined is unknown. In some cases, entities report aggregate power on behalf of another device. In such cases it is not known whether the usage reported is actual, estimated, or static. - actual(3): Indicates that the reported usage was measured by the entity through some hardware or direct physical means. The usage data reported is not estimated or static but is the measured consumption rate. - estimated(4): Indicates that the usage was not determined by physical measurement. The value is a derivation based upon the device type, state, and/or current utilization using some algorithm or heuristic. It is presumed that the entity's state and current configuration were used to compute the value. - static(5): Indicates that the usage was not determined by physical measurement, algorithm, or derivation. The usage was reported based upon external tables, specifications, and/or model information. For example, a PC Model X draws 200W, while a PC Model Y draws 210W.

eoPowerCurrentType

1.3.6.1.2.1.229.1.2.1.6

INTEGER1 = ac2 = dc3 = unknown · Integer32

This object indicates whether the eoPower for the Energy Object reports alternating current 'ac', direct current 'dc', or that the current type is unknown.

eoPowerMeasurementLocal

1.3.6.1.2.1.229.1.2.1.7

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates the source of power measurement and can be useful when modeling the power usage of attached devices. The power measurement can be performed by the entity itself or the power measurement of the entity can be reported by another trusted entity using a protocol extension. A value of true indicates the measurement is performed by the entity, whereas false indicates that the measurement was performed by another entity.

eoPowerAdminState

1.3.6.1.2.1.229.1.2.1.8

PowerStateSet0 = other255 = unknown256 = ieee1621257 = ieee1621Off258 = ieee1621Sleep259 = ieee1621On512 = dmtf513 = dmtfOn514 = dmtfSleepLight515 = dmtfSleepDeep516 = dmtfOffHard517 = dmtfOffSoft518 = dmtfHibernate519 = dmtfPowerOffSoft520 = dmtfPowerOffHard521 = dmtfMasterBusReset522 = dmtfDiagnosticInterrapt523 = dmtfOffSoftGraceful524 = dmtfOffHardGraceful525 = dmtfMasterBusResetGraceful526 = dmtfPowerCycleOffSoftGraceful527 = dmtfPowerCycleHardGraceful1024 = eman1025 = emanMechOff1026 = emanSoftOff1027 = emanHibernate1028 = emanSleep1029 = emanStandby1030 = emanReady1031 = emanLowMinus1032 = emanLow1033 = emanMediumMinus1034 = emanMedium1035 = emanHighMinus1036 = emanHighIANAPowerState is a textual convention that describes Power State Sets and Power State Set Values an Energy Object supports. IANA has created a registry of Power State supported by an Energy Object and IANA shall administer the list of Power State Sets and Power States. The Textual Convention assumes that Power States in a Power State Set are limited to 255 distinct values. For a Power State Set S, the named number with the value S * 256 is allocated to indicate the Power State Set. For a Power State X in the Power State Set S, the named number with the value S * 256 + X + 1 is allocated to represent the Power State. Requests for new values should be made to IANA via email (iana@iana.org).Reference: http://www.iana.org/assignments/power-state-sets · Integer32

This object specifies the desired Power State and the Power State Set for the Energy Object. Note that other(0) is not a Power State Set and unknown(255) is not a Power State as such, but simply an indication that the Power State of the Energy Object is unknown. Possible values of eoPowerAdminState within the Power State Set are registered at IANA. A current list of assignments can be found at <http://www.iana.org/assignments/power-state-sets>

eoPowerOperState

1.3.6.1.2.1.229.1.2.1.9

PowerStateSet0 = other255 = unknown256 = ieee1621257 = ieee1621Off258 = ieee1621Sleep259 = ieee1621On512 = dmtf513 = dmtfOn514 = dmtfSleepLight515 = dmtfSleepDeep516 = dmtfOffHard517 = dmtfOffSoft518 = dmtfHibernate519 = dmtfPowerOffSoft520 = dmtfPowerOffHard521 = dmtfMasterBusReset522 = dmtfDiagnosticInterrapt523 = dmtfOffSoftGraceful524 = dmtfOffHardGraceful525 = dmtfMasterBusResetGraceful526 = dmtfPowerCycleOffSoftGraceful527 = dmtfPowerCycleHardGraceful1024 = eman1025 = emanMechOff1026 = emanSoftOff1027 = emanHibernate1028 = emanSleep1029 = emanStandby1030 = emanReady1031 = emanLowMinus1032 = emanLow1033 = emanMediumMinus1034 = emanMedium1035 = emanHighMinus1036 = emanHighIANAPowerState is a textual convention that describes Power State Sets and Power State Set Values an Energy Object supports. IANA has created a registry of Power State supported by an Energy Object and IANA shall administer the list of Power State Sets and Power States. The Textual Convention assumes that Power States in a Power State Set are limited to 255 distinct values. For a Power State Set S, the named number with the value S * 256 is allocated to indicate the Power State Set. For a Power State X in the Power State Set S, the named number with the value S * 256 + X + 1 is allocated to represent the Power State. Requests for new values should be made to IANA via email (iana@iana.org).Reference: http://www.iana.org/assignments/power-state-sets · Integer32

This object specifies the current operational Power State and the Power State Set for the Energy Object. other(0) is not a Power State Set and unknown(255) is not a Power State as such, but simply an indication that the Power State of the Energy Object is unknown. Possible values of eoPowerOperState within the Power State Set are registered at IANA. A current list of assignments can be found at <http://www.iana.org/assignments/power-state-sets>

eoPowerStateEnterReason

1.3.6.1.2.1.229.1.2.1.10

OwnerStringThis data type is used to model an administratively assigned name of the owner of a resource. Implementations must accept values composed of well-formed NVT ASCII sequences. In addition, implementations should accept values composed of well-formed UTF-8 sequences. It is suggested that this name contain one or more of the following: IP address, management station name, network manager's name, location, or phone number. In some cases the agent itself will be the owner of an entry. In these cases, this string shall be set to a string starting with 'monitor'. SNMP access control is articulated entirely in terms of the contents of MIB views; access to a particular SNMP object instance depends only upon its presence or absence in a particular MIB view and never upon its value or the value of related object instances. Thus, objects of this type afford resolution of resource contention only among cooperating managers; they realize no access control function with respect to uncooperative parties. SIZE (0..127) · OCTET STRING

This string object describes the reason for the eoPowerAdminState transition. Alternatively, this string may contain with the entity that configured this Energy Object to this Power State.

eoPowerStateTable

1.3.6.1.2.1.229.1.3

Index: entPhysicalIndex · eoPowerStateIndex

This table enumerates the maximum power usage, in watts, for every single supported Power State of each Energy Object. This table has cross-reference with the eoPowerTable, containing rows describing each Power State for the corresponding Energy Object. For every Energy Object in the eoPowerTable, there is a corresponding entry in this table.

from ENTITY-MIB

entPhysicalIndex

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

The index for this entry.

eoPowerStateIndex

1.3.6.1.2.1.229.1.3.1.1

PowerStateSet0 = other255 = unknown256 = ieee1621257 = ieee1621Off258 = ieee1621Sleep259 = ieee1621On512 = dmtf513 = dmtfOn514 = dmtfSleepLight515 = dmtfSleepDeep516 = dmtfOffHard517 = dmtfOffSoft518 = dmtfHibernate519 = dmtfPowerOffSoft520 = dmtfPowerOffHard521 = dmtfMasterBusReset522 = dmtfDiagnosticInterrapt523 = dmtfOffSoftGraceful524 = dmtfOffHardGraceful525 = dmtfMasterBusResetGraceful526 = dmtfPowerCycleOffSoftGraceful527 = dmtfPowerCycleHardGraceful1024 = eman1025 = emanMechOff1026 = emanSoftOff1027 = emanHibernate1028 = emanSleep1029 = emanStandby1030 = emanReady1031 = emanLowMinus1032 = emanLow1033 = emanMediumMinus1034 = emanMedium1035 = emanHighMinus1036 = emanHighIANAPowerState is a textual convention that describes Power State Sets and Power State Set Values an Energy Object supports. IANA has created a registry of Power State supported by an Energy Object and IANA shall administer the list of Power State Sets and Power States. The Textual Convention assumes that Power States in a Power State Set are limited to 255 distinct values. For a Power State Set S, the named number with the value S * 256 is allocated to indicate the Power State Set. For a Power State X in the Power State Set S, the named number with the value S * 256 + X + 1 is allocated to represent the Power State. Requests for new values should be made to IANA via email (iana@iana.org).Reference: http://www.iana.org/assignments/power-state-sets · Integer32

This object specifies the index of the Power State of the Energy Object within a Power State Set. The semantics of the specific Power State can be obtained from the Power State Set definition.

eoPowerStateMaxPower

1.3.6.1.2.1.229.1.3.1.2

Integer32 · watts

This object indicates the maximum power for the Energy Object at the particular Power State. This value is specified in SI units of watts with the magnitude of the units (milliwatts, kilowatts, etc.) indicated separately in eoPowerStatePowerUnitMultiplier. If the maximum power is not known for a certain Power State, then the value is encoded as 0xFFFFFFFF. For Power States not enumerated, the value of eoPowerStateMaxPower might be interpolated by using the next highest supported Power State.

eoPowerStatePowerUnitMultiplier

1.3.6.1.2.1.229.1.3.1.3

UnitMultiplier-24 = yocto-21 = zepto-18 = atto-15 = femto-12 = pico-9 = nano-6 = micro-3 = milli0 = units3 = kilo6 = mega9 = giga12 = tera15 = peta18 = exa21 = zetta24 = yottaThe Unit Multiplier is an integer value that represents the IEEE 61850 Annex A units multiplier associated with the integer units used to measure the power or energy. For example, when used with eoPowerUnitMultiplier, -3 represents 10^-3 or milliwatts.Reference: The International System of Units (SI), National Institute of Standards and Technology, Spec. Publ. 330, August 1991. · Integer32

The magnitude of watts for the usage value in eoPowerStateMaxPower.

eoPowerStateTotalTime

1.3.6.1.2.1.229.1.3.1.4

TimeTicks

This object indicates the total time in hundredths of a second that the Energy Object has been in this power state since the last reset, as specified in the sysUpTime.

eoPowerStateEnterCount

1.3.6.1.2.1.229.1.3.1.5

Counter32

This object indicates how often the Energy Object has entered this power state, since the last reset of the device as specified in the sysUpTime.

eoEnergyParametersTable

1.3.6.1.2.1.229.1.4

Index: entPhysicalIndex · eoEnergyParametersIndex

This table is used to configure the parameters for energy measurement collection in the table eoEnergyTable. This table allows the configuration of different measurement settings on the same Energy Object. Implementation of this table only makes sense for Energy Objects that an eoPowerMeasurementCaliber of actual.

from ENTITY-MIB

entPhysicalIndex

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

The index for this entry.

eoEnergyParametersIndex

1.3.6.1.2.1.229.1.4.1.2

Integer32 (1..2147483647)

This object specifies the index of the Energy Parameters setting for collection of energy measurements for an Energy Object. An Energy Object can have multiple eoEnergyParametersIndex, depending on the capabilities of the Energy Object

eoEnergyParametersIntervalLength

1.3.6.1.2.1.229.1.4.1.3

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

This object indicates the length of time in hundredths of a second over which to compute the average eoEnergyConsumed measurement in the eoEnergyTable table. The computation is based on the Energy Object's internal sampling rate of power consumed or produced by the Energy Object. The sampling rate is the rate at which the Energy Object can read the power usage and may differ based on device capabilities. The average energy consumption is then computed over the length of the interval. The default value of 15 minutes is a common interval used in industry.

eoEnergyParametersIntervalNumber

1.3.6.1.2.1.229.1.4.1.4

Unsigned32

The number of intervals maintained in the eoEnergyTable. Each interval is characterized by a specific eoEnergyCollectionStartTime, used as an index to the table eoEnergyTable. Whenever the maximum number of entries is reached, the measurement over the new interval replaces the oldest measurement. There is one exception to this rule: when the eoEnergyMaxConsumed and/or eoEnergyMaxProduced are in (one of) the two oldest measurement(s), they are left untouched and the next oldest measurement is replaced.

eoEnergyParametersIntervalMode

1.3.6.1.2.1.229.1.4.1.5

INTEGER1 = period2 = sliding3 = total · Integer32

A control object to define the mode of interval calculation for the computation of the average eoEnergyConsumed or eoEnergyProvided measurement in the eoEnergyTable table. A mode of period(1) specifies non-overlapping periodic measurements. A mode of sliding(2) specifies overlapping sliding windows where the interval between the start of one interval and the next is defined in eoEnergyParametersIntervalWindow. A mode of total(3) specifies non-periodic measurement. In this mode only one interval is used as this is a continuous measurement since the last reset. The value of eoEnergyParametersIntervalNumber should be (1) one and eoEnergyParametersIntervalLength is ignored.

eoEnergyParametersIntervalWindow

1.3.6.1.2.1.229.1.4.1.6

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

The length of the duration window between the starting time of one sliding window and the next starting time in hundredths of seconds, used to compute the average of eoEnergyConsumed, eoEnergyProvided measurements in the eoEnergyTable table. This is valid only when the eoEnergyParametersIntervalMode is sliding(2). The eoEnergyParametersIntervalWindow value should be a multiple of eoEnergyParametersSampleRate.

eoEnergyParametersSampleRate

1.3.6.1.2.1.229.1.4.1.7

Unsigned32 · Milliseconds

The sampling rate, in milliseconds, at which the Energy Object should poll power usage in order to compute the average eoEnergyConsumed, eoEnergyProvided measurements in the table eoEnergyTable. The Energy Object should initially set this sampling rate to a reasonable value, i.e., a compromise between intervals that will provide good accuracy by not being too long, but not so short that they affect the Energy Object performance by requesting continuous polling. If the sampling rate is unknown, the value 0 is reported. The sampling rate should be selected so that eoEnergyParametersIntervalWindow is a multiple of eoEnergyParametersSampleRate. The default value is one second.

eoEnergyParametersStorageType

1.3.6.1.2.1.229.1.4.1.8

StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.) Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32

This variable indicates the storage type for this row.

eoEnergyParametersStatus

1.3.6.1.2.1.229.1.4.1.9

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The status of this row. The eoEnergyParametersStatus is used to start or stop energy usage logging. An entry status may not be active(1) unless all objects in the entry have an appropriate value. If this object is not equal to active, all associated usage-data logged into the eoEnergyTable will be deleted. The data can be destroyed by setting up the eoEnergyParametersStatus to destroy.

eoEnergyTable

1.3.6.1.2.1.229.1.5

Index: eoEnergyParametersIndex · eoEnergyCollectionStartTime

This table lists Energy Object energy measurements. Entries in this table are only created if the corresponding value of object eoPowerMeasurementCaliber is active(3), i.e., if the power is actually metered.

eoEnergyCollectionStartTime

1.3.6.1.2.1.229.1.5.1.1

TimeTicks · hundredths of a second

The time (in hundredths of a second) since the network management portion of the system was last re-initialized, as specified in the sysUpTime RFC 3418. This object specifies the start time of the energy measurement sample.

eoEnergyConsumed

1.3.6.1.2.1.229.1.5.1.2

Unsigned32 · Watt-hours

This object indicates the energy consumed in units of watt-hours for the Energy Object over the defined interval. This value is specified in the common billing units of watt-hours with the magnitude of watt-hours kWh, MWh, etc.) indicated separately in eoEnergyUnitMultiplier.

eoEnergyProvided

1.3.6.1.2.1.229.1.5.1.3

Unsigned32 · Watt-hours

This object indicates the energy produced in units of watt-hours for the Energy Object over the defined interval. This value is specified in the common billing units of watt-hours with the magnitude of watt-hours (kWh, MWh, etc.) indicated separately in eoEnergyUnitMultiplier.

eoEnergyStored

1.3.6.1.2.1.229.1.5.1.4

Unsigned32 · Watt-hours

This object indicates the difference of the energy consumed and energy produced for an Energy Object in units of watt-hours for the Energy Object over the defined interval. This value is specified in the common billing units of watt-hours with the magnitude of watt-hours (kWh, MWh, etc.) indicated separately in eoEnergyUnitMultiplier.

eoEnergyUnitMultiplier

1.3.6.1.2.1.229.1.5.1.5

UnitMultiplier-24 = yocto-21 = zepto-18 = atto-15 = femto-12 = pico-9 = nano-6 = micro-3 = milli0 = units3 = kilo6 = mega9 = giga12 = tera15 = peta18 = exa21 = zetta24 = yottaThe Unit Multiplier is an integer value that represents the IEEE 61850 Annex A units multiplier associated with the integer units used to measure the power or energy. For example, when used with eoPowerUnitMultiplier, -3 represents 10^-3 or milliwatts.Reference: The International System of Units (SI), National Institute of Standards and Technology, Spec. Publ. 330, August 1991. · Integer32

This object is the magnitude of watt-hours for the energy field in eoEnergyConsumed, eoEnergyProvided, eoEnergyStored, eoEnergyMaxConsumed, and eoEnergyMaxProduced.

eoEnergyAccuracy

1.3.6.1.2.1.229.1.5.1.6

Integer32 (0..10000) · hundredths of percent

This object indicates a percentage accuracy, in hundredths of a percent, of Energy usage reporting. eoEnergyAccuracy is applicable to all Energy measurements in the eoEnergyTable. For example, 1010 means the reported usage is accurate to +/- 10.1 percent. This value is zero if the accuracy is unknown.

eoEnergyMaxConsumed

1.3.6.1.2.1.229.1.5.1.7

Unsigned32 · Watt-hours

This object is the maximum energy observed in eoEnergyConsumed since the monitoring started or was reinitialized. This value is specified in the common billing units of watt-hours with the magnitude of watt-hours (kWh, MWh, etc.) indicated separately in eoEnergyUnitMultiplier.

eoEnergyMaxProduced

1.3.6.1.2.1.229.1.5.1.8

Unsigned32 · Watt-hours

This object is the maximum energy ever observed in eoEnergyEnergyProduced since the monitoring started. This value is specified in the units of watt-hours with the magnitude of watt-hours (kWh, MWh, etc.) indicated separately in eoEnergyEnergyUnitMultiplier.

eoEnergyDiscontinuityTime

1.3.6.1.2.1.229.1.5.1.9

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime RFC 3418 on the most recent occasion at which any one or more of this entity's energy counters in this table suffered a discontinuity: eoEnergyConsumed, eoEnergyProvided or eoEnergyStored. If no such discontinuities have occurred since the last re-initialization of the local management subsystem, then this object contains a zero value.

Trap details

eoPowerStateChange

1.3.6.1.2.1.229.0.2

The SNMP entity generates the eoPowerStateChange when the values of eoPowerAdminState or eoPowerOperState, in the context of the Power State Set, have changed for the Energy Object represented by the entPhysicalIndex.

eoPowerAdminState

1.3.6.1.2.1.229.1.2.1.8

PowerStateSet0 = other255 = unknown256 = ieee1621257 = ieee1621Off258 = ieee1621Sleep259 = ieee1621On512 = dmtf513 = dmtfOn514 = dmtfSleepLight515 = dmtfSleepDeep516 = dmtfOffHard517 = dmtfOffSoft518 = dmtfHibernate519 = dmtfPowerOffSoft520 = dmtfPowerOffHard521 = dmtfMasterBusReset522 = dmtfDiagnosticInterrapt523 = dmtfOffSoftGraceful524 = dmtfOffHardGraceful525 = dmtfMasterBusResetGraceful526 = dmtfPowerCycleOffSoftGraceful527 = dmtfPowerCycleHardGraceful1024 = eman1025 = emanMechOff1026 = emanSoftOff1027 = emanHibernate1028 = emanSleep1029 = emanStandby1030 = emanReady1031 = emanLowMinus1032 = emanLow1033 = emanMediumMinus1034 = emanMedium1035 = emanHighMinus1036 = emanHighIANAPowerState is a textual convention that describes Power State Sets and Power State Set Values an Energy Object supports. IANA has created a registry of Power State supported by an Energy Object and IANA shall administer the list of Power State Sets and Power States. The Textual Convention assumes that Power States in a Power State Set are limited to 255 distinct values. For a Power State Set S, the named number with the value S * 256 is allocated to indicate the Power State Set. For a Power State X in the Power State Set S, the named number with the value S * 256 + X + 1 is allocated to represent the Power State. Requests for new values should be made to IANA via email (iana@iana.org).Reference: http://www.iana.org/assignments/power-state-sets · Integer32

This object specifies the desired Power State and the Power State Set for the Energy Object. Note that other(0) is not a Power State Set and unknown(255) is not a Power State as such, but simply an indication that the Power State of the Energy Object is unknown. Possible values of eoPowerAdminState within the Power State Set are registered at IANA. A current list of assignments can be found at <http://www.iana.org/assignments/power-state-sets>

eoPowerOperState

1.3.6.1.2.1.229.1.2.1.9

PowerStateSet0 = other255 = unknown256 = ieee1621257 = ieee1621Off258 = ieee1621Sleep259 = ieee1621On512 = dmtf513 = dmtfOn514 = dmtfSleepLight515 = dmtfSleepDeep516 = dmtfOffHard517 = dmtfOffSoft518 = dmtfHibernate519 = dmtfPowerOffSoft520 = dmtfPowerOffHard521 = dmtfMasterBusReset522 = dmtfDiagnosticInterrapt523 = dmtfOffSoftGraceful524 = dmtfOffHardGraceful525 = dmtfMasterBusResetGraceful526 = dmtfPowerCycleOffSoftGraceful527 = dmtfPowerCycleHardGraceful1024 = eman1025 = emanMechOff1026 = emanSoftOff1027 = emanHibernate1028 = emanSleep1029 = emanStandby1030 = emanReady1031 = emanLowMinus1032 = emanLow1033 = emanMediumMinus1034 = emanMedium1035 = emanHighMinus1036 = emanHighIANAPowerState is a textual convention that describes Power State Sets and Power State Set Values an Energy Object supports. IANA has created a registry of Power State supported by an Energy Object and IANA shall administer the list of Power State Sets and Power States. The Textual Convention assumes that Power States in a Power State Set are limited to 255 distinct values. For a Power State Set S, the named number with the value S * 256 is allocated to indicate the Power State Set. For a Power State X in the Power State Set S, the named number with the value S * 256 + X + 1 is allocated to represent the Power State. Requests for new values should be made to IANA via email (iana@iana.org).Reference: http://www.iana.org/assignments/power-state-sets · Integer32

This object specifies the current operational Power State and the Power State Set for the Energy Object. other(0) is not a Power State Set and unknown(255) is not a Power State as such, but simply an indication that the Power State of the Energy Object is unknown. Possible values of eoPowerOperState within the Power State Set are registered at IANA. A current list of assignments can be found at <http://www.iana.org/assignments/power-state-sets>

eoPowerStateEnterReason

1.3.6.1.2.1.229.1.2.1.10

OwnerStringThis data type is used to model an administratively assigned name of the owner of a resource. Implementations must accept values composed of well-formed NVT ASCII sequences. In addition, implementations should accept values composed of well-formed UTF-8 sequences. It is suggested that this name contain one or more of the following: IP address, management station name, network manager's name, location, or phone number. In some cases the agent itself will be the owner of an entry. In these cases, this string shall be set to a string starting with 'monitor'. SNMP access control is articulated entirely in terms of the contents of MIB views; access to a particular SNMP object instance depends only upon its presence or absence in a particular MIB view and never upon its value or the value of related object instances. Thus, objects of this type afford resolution of resource contention only among cooperating managers; they realize no access control function with respect to uncooperative parties. SIZE (0..127) · OCTET STRING

This string object describes the reason for the eoPowerAdminState transition. Alternatively, this string may contain with the entity that configured this Energy Object to this Power State.

↑ To TOC