CISCO-ENERGYWISE-MIB

BITS

This object indicates the nanny vector of the current Cisco EnergyWise entity. powerWakeUp(0): Feature to wake up a Cisco EnergyWise entity. powerLevel1(1): Feature to set to power level 1(shut). powerLevel2(2): Feature to set to power level 2(hibernate). powerLevel3(3): Feature to set to power level 3(sleep). powerLevel4(4): Feature to set to power level 4(standby) powerLevel5(5): Feature to set to power level 5(ready). powerLevel6(6): Feature to set to power level 6(low). powerLevel7(7): Feature to set to power level 7(frugal). powerLevel8(8): Feature to set to power level 8(medium). powerLevel9(9): Feature to set to power level 9(reduced). powerLevel10(10): Feature to set to power level 10(high). powerLevel11(11): Feature to set to power level 11(full). powerShutNWakeUp: Feature to shutdown and wake up a Cisco EnergyWise entity. powerUsage: Feature to manage Cisco EnergyWise usage of a Cisco EnergyWise entity. powerImportance: Feature to manage Cisco EnergyWise importance of a Cisco EnergyWise entity.

Unsigned32 (1..4294967295)

This object indicates an arbitrary unsigned integer-value that uniquely identifies the Cisco EnergyWise neighbor, for which the current Cisco EnergyWise entity serves as a nanny.

EnergywiseKeywordListA list of keywords. If multiple keywords are present, then this string will contain all the keywords separated by ',' character. For example, If a Cisco EnergyWise entity is tagged with keywords 'building' and 'lobby', then the keyword list will be 'building,lobby'. SIZE (0..255) · OCTET STRING

This object specifies the EnergywiseKeywordList with which this entity is tagged. This object specifies the null string if no keyword has been configured. If write access is implemented for an instance of cewEntKeyword, and a value is written into the instance, the agent must retain the supplied value in the cewEntKeyword instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all re-initializations/reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies an administratively assigned human readable name to the Cisco EnergyWise entity. For example, we can have a switch deployed to lobby with cewEntName as 'LL'. This object specifies a null string if no name is configured. If write access is implemented for an instance of cewEntName, and a value is written into the instance, the agent must retain the supplied value in the cewEntname instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all re-initializations/reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies an administratively assigned name to indicate the purpose a Cisco EnergyWise entity serves in the network. For example, we can have switches deployed to a lobby with cewEntName as 'LL', cewEntRoleDescription as 'LobbySwitch'. This object specifies a null string if no role description is configured. If write access is implemented for an instance of cewEntRoleDescription, and a value is written into the instance, the agent must retain the supplied value in the cewEntRoleDescription instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all re- initializations/reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies the full name of a Cisco EnergyWise entity. This name is the combination of the cewDomainName, cewEntRoleDescription, cewEntName. For example, we can have a switch deployed to lobby with cewEntFullName as 'com.cisco.bldg19.LobbySwitch.LL' where, cewDomainName - gcom.cisco.bldg19 cewEntRole - LobbySwitch cewEntName - LL

EnergywisePowerUnitsAn integer value that represents the units used to measure the power. The units are expressed in watts. (-24..24) · Integer32

This object indicates the units of power for the Cisco EnergyWise entity. The value of this column applies to the following objects: cewEntEnergyUsage cewEntEnergyUsageProvisioned.

Unsigned32 (0..2147483647)

This object indicates the current usage for the Cisco EnergyWise entity. This should be less than or equal to the power that can be consumed at that specified level.

INTEGER1 = max2 = presumed3 = unknown4 = actual5 = trusted · Integer32

This object specifies the type of the usage data reported by cewEntityEnergyUsage. max: This indicates that the actual power drawn cannot be determined. A presumed value that is the maximum the Cisco EnergyWise entity could draw is provided. presumed: This indicates that the actual power drawn cannot be determined but can be presumed from the model. A dell box X draws 200W, Dell Model y draws 210W. actual: This indicates that the usage data reported is not presumed or max but the real power drawn. A PoE phone drawing X amount of power can be determined by reading from the port. A PoE phone can report the actual usage as X W. unknown: This indicates that the usage reported is unknown. In some cases, entities report aggregate power like what a lighting controller or aggregate controller does. In such cases it is not known whether the usage reported is actual or presumed. trusted: This indicates that the usage data reported was reported from another source.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object specifies the current power level for the Cisco EnergyWise entity.

Unsigned32 (0..2147483647)

This object indicates the maximum power a Cisco EnergyWise entity can draw at current level.

Unsigned32 (1..100)

This object specifies Cisco EnergyWise importance for the Cisco EnergyWise entity.

Unsigned32 (1..4294967295)

This object indicates the sum of its own importance and intrinsic importance of all the entities dependent on it.

Unsigned32 (1..100)

This object indicates the relative importance of a Cisco EnergyWise entity with respect to the maximum importance value in the domain. It is derived using the formula: (cewEntImportanceExt / cewEntMaxImportance) * 100.

EnergywiseIdA unique identifier for the Cisco EnergyWise entity in the Cisco EnergyWise domain. Implementation must make sure that the ID for each entity should be unique among all entities within the Cisco EnergyWise domain. For example, for Cisco entities, ID is based on UDI. where UDI consists of: PID - Product Identifier VID - Version Identifier SN - Serial Number. SIZE (0..32) · OCTET STRING

This object indicates a Cisco EnergyWise entity, which identifies itself as important for the current entity's functionality in the network. For example, assume a network consisting of switches, IP phones and a call manager (device which supports call related operations in a phone). Though an IP phone derives its power from the switch, it will not work if the call-manager is not operational. It clearly demonstrates the importance of the call-manager in the network. Hence it is the parent of the IP phones in terms of importance. Given a parent and child relationship this can be read as, child (IP phone) needs parent (call manager). Importance calculations enable the management stations to identify the Cisco EnergyWise entities that support other Cisco EnergyWise entities and weigh them as more important to the network as a whole.

EnergywiseIdA unique identifier for the Cisco EnergyWise entity in the Cisco EnergyWise domain. Implementation must make sure that the ID for each entity should be unique among all entities within the Cisco EnergyWise domain. For example, for Cisco entities, ID is based on UDI. where UDI consists of: PID - Product Identifier VID - Version Identifier SN - Serial Number. SIZE (0..32) · OCTET STRING

This object indicates the Cisco EnergyWise parent of this entity. If a Cisco EnergyWise entity is a Cisco EnergyWise parent, then the value of this column is the null string.

INTEGER1 = up2 = down · Integer32

A control object to indicate the administratively desired state for the Cisco EnergyWise entity. up: enables Cisco EnergyWise protocol on the entity. down: disables Cisco EnergyWise protocol on the entity.

INTEGER1 = up2 = down3 = error · Integer32

This object indicates the operational status for the Cisco EnergyWise entity. If the cewEntAdminStatus is down(2), then cewEntOperStatus should be down(2). If cewEntAdminStatus is changed to up(1), then cewEntOperStatus should change to up(1), unless some error has occurred, then it should be in error(3) state.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object specifies the level set by the network administrator. The value of this object could change if the recurrence event is fired. When a network administrator sets the level of this object the value of cewEntEnergyLevel will change to that value if the configured level is successfully accepted by the system.

INTEGER1 = consumer2 = producer3 = meter · Integer32

This object specifies the energy usage type of this Cisco Energywise Entity. consumer: This indicates that the Cisco Energywise Entity consumes energy. producer: This indicates that the Cisco Energywise Entity generates energy. meter: This indicates that the Cisco Energywise Entity is a meter which reads the energy consumed or produced.

INTEGER-1 = out1 = in · Integer32

This object specifies the direction of the energy usage by this Cisco EnergyWise Entity, with respect to the power grid. out: This indicates that the power is being consumed or drawn out of the power grid by the Cisco EnergyWise Entity. in: This indicates that the power is being produced and supplied into the power grid by the Cisco EnergyWise Entity.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object specifies the value of the flag used to determine if the Cisco Energywise Query Set is set to true/false. If the flag is set to true, the cli, energywise allow query set is activated for this Cisco Energywise Entity. When its set to false, the user will be prevented from setting the parameters from the query. For more information on Cisco Energywise Queries, refer to the description above.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object specifies the value of the flag used to determine if activity check is allowed or not on this Cisco Energywise Entity. If the flag is set to true, Energywise allows activity check to be done on this Cisco Energywise Entity.Activity check is done to determine if an IP Phone entity connected to the switch is in use or not before the port can be turned OFF or ON.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object indicates the level for which this entry describes the power usage.

Unsigned32 (0..2147483647)

This object indicates the maximum power usage for the Cisco EnergyWise entity at the particular level.

Integer32

This object indicates the delta; that is the difference between the current cewEntityEnergyUsage and the cewLevelMaxUsage value of a Cisco EnergyWise entity at a level.

EnergywisePowerUnitsAn integer value that represents the units used to measure the power. The units are expressed in watts. (-24..24) · Integer32

This object indicates the Cisco EnergyWise power units for cewLevelMaxUsage and cewLevelDeltaUsage values.

Unsigned32 (1..4294967295)

This object indicates an arbitrary unsigned integer-value that uniquely identifies the proxy.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address. unknown(0) An unknown address type. This value MUST be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below. ipv4(1) An IPv4 address as defined by the InetAddressIPv4 textual convention. ipv6(2) An IPv6 address as defined by the InetAddressIPv6 textual convention. ipv4z(3) A non-global IPv4 address including a zone index as defined by the InetAddressIPv4z textual convention. ipv6z(4) A non-global IPv6 address including a zone index as defined by the InetAddressIPv6z textual convention. dns(16) A DNS domain name as defined by the InetAddressDNS textual convention. Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType. To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation. Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32

This object specifies the address type used for cewProxyAddress. Cisco EnergyWise proxy entries are only valid for the address type of ipv4(1) and ipv6(2).

InetAddressDenotes a generic Internet address. An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row. The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error. When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING

This object specifies the IP address of the proxy.

InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>. The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d

This object specifies the port used by the proxy.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies a string which a network administrator can use to classify Cisco EnergyWise proxies to particular proxy type. For example, all the building controllers (Cisco EnergyWise proxies which understand BACNET proprietary protocol) will be tagged with 'BACNET' string.

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 object specifies the memory realization of a Cisco EnergyWise proxy.

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

This object indicates the status of this proxy. Once the entry status has been set to active(1), the entry cannot be modified. The only operation possible after this is to delete the entry.

Unsigned32 (1..4294967295)

This object indicates an arbitrary unsigned integer-value that uniquely identifies the Cisco EnergyWise neighbor.

EnergywiseIdA unique identifier for the Cisco EnergyWise entity in the Cisco EnergyWise domain. Implementation must make sure that the ID for each entity should be unique among all entities within the Cisco EnergyWise domain. For example, for Cisco entities, ID is based on UDI. where UDI consists of: PID - Product Identifier VID - Version Identifier SN - Serial Number. SIZE (0..32) · OCTET STRING

This object specifies the Cisco EnergyWise identifier of the neighbor.

INTEGER1 = static2 = dynamic3 = child · Integer32

This object specifies the type of a Cisco EnergyWise neighbor static : specifies a neighbor which is added statically. dynamic : specifies a neighbor added dynamically, by a discovery protocol. child : specifies a neighbor which needs a parent to nanny.

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

This object indicates the value of sysUpTime the last time a heartbeat was received from the neighbor Cisco EnergyWise entity.

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 object specifies the memory realization of a Cisco EnergyWise neighbor.

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

This object indicates the status of this neighbor. Once the entry status has been set to active(1), the entry cannot be modified. The only operation possible after this is to delete the entry.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies the device type of the Cisco EnergyWise neighbor. This object should be same as the cewDeviceType of the neighbor.

EnergywiseKeywordListA list of keywords. If multiple keywords are present, then this string will contain all the keywords separated by ',' character. For example, If a Cisco EnergyWise entity is tagged with keywords 'building' and 'lobby', then the keyword list will be 'building,lobby'. SIZE (0..255) · OCTET STRING

This object specifies the EnergywiseKeywordList with which this Cisco Energywise endpoint neighbor entity is tagged. If cewNeighborConfiguredKeyword is successfully changed, the new value will be copied over to cewNeighborKeyword to make both the objects have the same value. This object specifies the null string if no keyword has been configured.

EnergywiseKeywordListA list of keywords. If multiple keywords are present, then this string will contain all the keywords separated by ',' character. For example, If a Cisco EnergyWise entity is tagged with keywords 'building' and 'lobby', then the keyword list will be 'building,lobby'. SIZE (0..255) · OCTET STRING

This object specifies the keyword configured by the network administrator on the adjacent Cisco energywise neighbor/child entity. If the neighbor is of type child and a keyword is configured, the switch will attempt to set the endpoint neighbor/child entity with this value. If the set operation is successful, cewNeighborKeyword will be set with the configured keyword. This object specifies the EnergywiseKeywordList with which current Cisco Energywise neighbor/endpoint entity is tagged. This object specifies the null string if no keyword has been configured. If write access is implemented for an instance of cewNeighborConfiguredKeyword, and a value is written into the instance,the agent must retain the supplied value in the cewNeighborConfiguredKeyword instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all re-initializations/reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies an administratively assigned human readable name to the Cisco Energywise endpoint neighbor/child. If cewNeighborConfiguredName is successfully changed, the new value will be copied over to cewNeighborName to make both the objects have the same value. This object specifies a null string if no name is configured.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies the name configured on the adjacent Cisco Energywise neighbor/child entity. If the neighbor is of type child and a name is configured, the switch will attempt to set the endpoint neighbor/child entity with this value. If successful,cewNeighborName will be set with the configured name. This object specifies a null string if no name is configured. If write access is implemented for an instance of cewNeighborConfiguredName, and a value is written into the instance, the agent must retain the supplied value in the cewNeighborConfiguredName instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all re-initializations/reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies an administratively assigned name to indicate the purpose the Cisco Energywise endpoint neighbor/child serves in the network.If cewNeighborConfiguredRoleDesc is successfully changed, the new value will be copied over to cewNeighborRoleDescription to make both the objects have the same value. This object specifies a null string if no role description is configured.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies the role configured on the adjacent Cisco Energywise neighbor/child entity.If the neighbor is of type child and a role is configured, the switch will attempt to set the endpoint neighbor/child entity with this value. If successful, cewNeighborRoleDesc will be set with the configured role. This object specifies an administratively assigned name to indicate the purpose a Cisco EnergyWise entity serves in the network. This object specifies a null string if no role description is configured. If write access is implemented for an instance of cewNeighborConfiguredRoleDesc, and a value is written into the instance, the agent must retain the supplied value in the cewNeighborConfiguredRoleDesc instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all re-initializations/reboots of the network management system, including those which result in a change of the physical entity's entPhysicalIndex value.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object specifies the current power level for the Cisco EnergyWise neighbor/child entity.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object specifies the level configured on the adjacent Cisco Energywise neighbor/child entity. If the neighbor is of type child and a level is configured, the switch will attempt to set the endpoint neighbor/child entity with this value. If successful, cewNeighborEnergyLevel will be set with the configured level.

Unsigned32 (1..100)

This object specifies Cisco EnergyWise importance for the Cisco EnergyWise neighbor/child entity.

Unsigned32 (1..100)

This object specifies the importance configured on the adjacent Cisco Energywise neighbor/child entity. If the neighbor is of type child and the importance is configured, the switch will attempt to set the endpoint neighbor/child entity with this value. If successful, cewNeighborImportance will be set with the configured importance.

EnergywisePowerUnitsAn integer value that represents the units used to measure the power. The units are expressed in watts. (-24..24) · Integer32

This object indicates the units of power for the Cisco Energywise neighbor/child entity. The value of this column applies to the following objects: cewNeighborEnergyUsage

Unsigned32 (0..2147483647)

This object indicates the current usage for the Cisco EnergyWise neighbor/child entity. This should be less than or equal to the power that can be consumed at that specified level.

INTEGER1 = consumer2 = producer3 = meter · Integer32

This object specifies the energy usage type of the Cisco Energywise neighbor/child entity. consumer: This indicates that the neighbor consumes energy. producer: This indicates that the neighbor generates energy. meter: This indicates that the neighbor is a meter which reads the energy consumed or produced.

INTEGER-1 = out1 = in · Integer32

This object specifies the direction of the energy usage with respect to the power grid for this Cisco Energywise neighbor entity. Example: A solar panel is a consumer, drawing power during some part of the day, taking in power from the grid. It can also generate power out to the grid at other times. out: This indicates that the power is being consumed or drawn out by the Cisco EnergyWise neighbor entity. in: This indicates that the power is being produced and supplied back into the power grid by the Cisco EnergyWise neighbor entity.

MacAddressRepresents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:

This object specifies the MAC Address of the Cisco EnergyWise endpoint that is connected to the Cisco EnergyWise Entity.

EntPhysicalIndexOrZeroThis textual convention is an extension of entPhysicalIndex. If non-zero, the object is an entPhysicalIndex. If zero, no appropriate entPhysicalIndex exists. Any additional semantics are object specific. (0..2147483647) · Integer32

This object specifies the entity physical index of the Cisco Energywise Neighbor. If the neighbor is not a cisco device that supports the cisco entity MIB, this value will be zero.

EntPhysicalIndexOrZeroThis textual convention is an extension of entPhysicalIndex. If non-zero, the object is an entPhysicalIndex. If zero, no appropriate entPhysicalIndex exists. Any additional semantics are object specific. (0..2147483647) · Integer32

This object specifies the entPhysicalIndex of the interface on the switch to which the Cisco EnergyWise endpoint is connected.

Unsigned32 (1..4294967295)

This object specifies an arbitrary unsigned integer-value that uniquely identifies the Cisco EnergyWise event.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object specifies the level at which a Cisco EnergyWise entity is set for an event.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object specifies whether an event is a recurring event. true: If this policy is a recurring event. false: If this policy is not a recurring event.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies a string-value describing the details regarding the time at which the event should get triggered. For example, 00:30 Hrs on Jan, June & Dec, every weekday (Mon-Fri) 30 0 * 1,6,12 1-5 * * * * * command to be executed - - - - - | | | | | | | | | +----- day of week (0 - 6) Sunday=0 | | | +------- month (1 - 12) | | +--------- day of month (1 - 31) | +----------- hour (0 - 23) +------------- min (0 - 59) Other management interfaces (e.g., local console) will configure time in the above manner. cewEventTime can also have wild cards as shown in the above example.

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 object specifies the memory realization of a Cisco EnergyWise event.

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

This object indicates the status of this event. Once the entry status has been set to active(1), the entry cannot be modified. The only operation possible after this is to delete the entry.

Unsigned32 (1..100)

This object specifies the importance at which a Cisco EnergyWise entity is set for an event.

EnergywiseLevel1 = shut2 = hibernate3 = sleep4 = standby5 = ready6 = low7 = frugal8 = medium9 = reduced10 = high11 = fullAn enumerated integer value that represents the value of Cisco EnergyWise entity level, a power setting at which a Cisco EnergyWise entity uses power. shut(1) : An off state. No entity features are available. The entity is unavailable. No power is being consumed. hibernate(2): No entity features are available. The entity may be available but the time for availability is longer than sleep. Minimal, nearly zero, or zero power is consumed. sleep(3) : No entity features are available. The entity may be available but the time for availability is longer than standby. Minimal power is consumed. standby(4) : Indicates some entity features may not be available. The entity may be available but the time for availability is longer than ready. Minimal power is consumed. ready(5) : Indicates some entity features may not be available. The entity itself may be available but their may be a time delay for availability. Low or less power is consumed. low(6) : Indicates some features may not be available and the entity has taken measures/options to provide less than frugal usage. frugal(7) : Indicates some features may not be available and the entity has taken measures/options to provide less than medium usage. medium(8) : Indicates all entity features are available but the entity has taken measures/options to provide less than reduced usage. reduced(9) : Indicates all entity features are available but the entity has taken measures/options to provide less than high usage. high(10) : Indicates all entity features are available and power consumption is less than full. full(11) : Indicates all entity features are available and the entity is consuming the highest power. · Integer32

This object indicates the level for which this neighbor describes the power usage.

Unsigned32 (0..2147483647)

This object indicates the maximum power usage for the Cisco EnergyWise neighbor at the particular level.

Integer32

This object indicates the delta; that is the difference between the current cewNeighborEnergyUsage and the cewNeighborLevelMaxUsage value of the Cisco EnergyWise neighbor at a level.

EnergywisePowerUnitsAn integer value that represents the units used to measure the power. The units are expressed in watts. (-24..24) · Integer32

This object indicates the Cisco EnergyWise power units for cewNeighborLevelMaxUsage cewNeighborLevelDeltaUsage