Standard view Table view

BATTERY-MIB

        This MIB module defines a set of objects for monitoring
batteries of networked devices and of their components.
        
Copyright (c) 2015 IETF Trust and the persons identified as
authors of the code.  All rights reserved.
        
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
        
This version of this MIB module is part of RFC 7577; see
the RFC itself for full legal notices.
Source file
BATTERY-MIB
Last revised
Identity
batteryMIB
Base OID
1.3.6.1.2.1.233
Imported Objects
ENTITY-MIB entPhysicalIndex
SNMP-FRAMEWORK-MIB SnmpAdminString
SNMPv2-CONF MODULE-COMPLIANCE NOTIFICATION-GROUP OBJECT-GROUP
SNMPv2-SMI Integer32 mib-2 MODULE-IDENTITY NOTIFICATION-TYPE OBJECT-TYPE Unsigned32
SNMPv2-TC DateAndTime
Net-SNMP examples using the rfc MIB directory Show commands

These commands use the standard Observium installation path and load the selected MIB variant before the RFC and Net-SNMP directories.

Translate the module identity
/usr/bin/snmptranslate -Pud -Ir -On -m 'BATTERY-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'BATTERY-MIB::batteryMIB'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'BATTERY-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'BATTERY-MIB::batteryMIB'
How SNMP, Net-SNMP, MIB paths, and variants work
Objects (33)
batteryMIB
.1.3.6.1.2.1.233
batteryNotifications
.1.3.6.1.2.1.233.0
batteryObjects
.1.3.6.1.2.1.233.1
batteryTable
.1.3.6.1.2.1.233.1.1
batteryEntry
ENTITY-MIBentPhysicalIndex
 .1.3.6.1.2.1.233.1.1.1
batteryIdentifier
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.233.1.1.1.1
batteryActualCapacity
milliampere hoursSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.10
batteryChargingCycleCount
SNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.11
batteryLastChargingCycleTime
SNMPv2-TCDateAndTime
 .1.3.6.1.2.1.233.1.1.1.12
batteryChargingOperState
Enumeration
 .1.3.6.1.2.1.233.1.1.1.13
batteryChargingAdminState r/w
Enumeration
 .1.3.6.1.2.1.233.1.1.1.14
batteryActualCharge
milliampere hoursSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.15
batteryActualVoltage
millivoltSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.16
batteryActualCurrent
milliampereSNMPv2-SMIInteger32
 .1.3.6.1.2.1.233.1.1.1.17
batteryTemperature
deci-degrees CelsiusSNMPv2-SMIInteger32
 .1.3.6.1.2.1.233.1.1.1.18
batteryAlarmLowCharge r/w
milliampere hoursSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.19
batteryFirmwareVersion
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.233.1.1.1.2
batteryAlarmLowVoltage r/w
millivoltSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.20
batteryAlarmLowCapacity r/w
milliampere hoursSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.21
batteryAlarmHighCycleCount r/w
SNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.22
batteryAlarmHighTemperature r/w
deci-degrees CelsiusSNMPv2-SMIInteger32
 .1.3.6.1.2.1.233.1.1.1.23
batteryAlarmLowTemperature r/w
deci-degrees CelsiusSNMPv2-SMIInteger32
 .1.3.6.1.2.1.233.1.1.1.24
batteryCellIdentifier
SNMP-FRAMEWORK-MIBSnmpAdminString
 .1.3.6.1.2.1.233.1.1.1.25
batteryType
Enumeration
 .1.3.6.1.2.1.233.1.1.1.3
batteryTechnology
SNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.4
batteryDesignVoltage
millivoltSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.5
batteryNumberOfCells
SNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.6
batteryDesignCapacity
milliampere hoursSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.7
batteryMaxChargingCurrent
milliampereSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.8
batteryTrickleChargingCurrent
milliampereSNMPv2-SMIUnsigned32
 .1.3.6.1.2.1.233.1.1.1.9
batteryConformance
.1.3.6.1.2.1.233.2
batteryCompliances
.1.3.6.1.2.1.233.2.1
batteryGroups
.1.3.6.1.2.1.233.2.2
Dependencies (7) 5 direct · 2 transitive Show tree and compile order Hide dependency details

Each imported module is resolved in the importing module's source directory first, then through the normal default-variant rules.

Dependency tree
Dependency-first compile order
  1. SNMPv2-SMIrfc
  2. SNMPv2-TCrfc
  3. IANA-ENTITY-MIBrfc
  4. SNMPv2-CONFrfc
  5. SNMP-FRAMEWORK-MIBrfc
  6. UUID-TC-MIBrfc
  7. ENTITY-MIBrfc
  8. BATTERY-MIBrfcselected
Conformance Groups (6)
batteryDescriptionGroup
batteryIdentifier batteryFirmwareVersion batteryType batteryTechnology batteryDesignVoltage batteryNumberOfCells batteryDesignCapacity batteryMaxChargingCurrent batteryTrickleChargingCurrent
A compliant implementation MUST implement the objects
contained in this group.
 .1.3.6.1.2.1.233.2.2.1
batteryStatusGroup
batteryActualCapacity batteryChargingCycleCount batteryLastChargingCycleTime batteryChargingOperState batteryActualCharge batteryActualVoltage batteryActualCurrent batteryTemperature
A compliant implementation MUST implement the objects
contained in this group.
 .1.3.6.1.2.1.233.2.2.2
batteryAdminGroup
batteryChargingAdminState
A compliant implementation does not have to implement the
object contained in this group.
 .1.3.6.1.2.1.233.2.2.3
batteryAlarmThresholdsGroup
batteryAlarmLowCharge batteryAlarmLowVoltage batteryAlarmLowCapacity batteryAlarmHighCycleCount batteryAlarmHighTemperature batteryAlarmLowTemperature
A compliant implementation does not have to implement the
objects contained in this group.
 .1.3.6.1.2.1.233.2.2.4
batteryNotificationsGroup
batteryChargingStateNotification batteryLowNotification batteryCriticalNotification batteryAgingNotification batteryTemperatureNotification batteryConnectedNotification batteryDisconnectedNotification
A compliant implementation does not have to implement the
notifications contained in this group.
 .1.3.6.1.2.1.233.2.2.5
batteryPerCellNotificationsGroup
batteryCellIdentifier
A compliant implementation does not have to implement the
object contained in this group.
 .1.3.6.1.2.1.233.2.2.6
Compliance Statements (1)

OID .1.3.6.1.2.1.233.2.1.1
The compliance statement for implementations of the
BATTERY-MIB module.

A compliant implementation MUST implement the objects
defined in the mandatory groups batteryDescriptionGroup
and batteryStatusGroup.

Note that this compliance statement requires
compliance with the entity4CRCompliance
MODULE-COMPLIANCE statement of the
ENTITY-MIB (RFC 6933).
Required groups
mandatory batteryDescriptionGroup
mandatory batteryStatusGroup
optional batteryAlarmThresholdsGroup A compliant implementation does not have to implement
the batteryAlarmThresholdsGroup.
optional batteryNotificationsGroup A compliant implementation does not have to implement
the batteryNotificationsGroup.
optional batteryPerCellNotificationsGroup A compliant implementation does not have to implement
the batteryPerCellNotificationsGroup.
optional batteryAdminGroup A compliant implementation does not have to implement
the batteryAdminGroup.
Object refinements
ObjectAccessSyntaxDescription
batteryAlarmLowCharge readonly
A compliant implementation is not required
to support set operations on this object.
batteryAlarmLowVoltage readonly
A compliant implementation is not required
to support set operations on this object.
batteryAlarmLowCapacity readonly
A compliant implementation is not required
to support set operations on this object.
batteryAlarmHighCycleCount readonly
A compliant implementation is not required
to support set operations on this object.
batteryAlarmHighTemperature readonly
A compliant implementation is not required
to support set operations on this object.
batteryAlarmLowTemperature readonly
A compliant implementation is not required
to support set operations on this object.
Notifications / Traps (7)
NameOIDDescription
batteryChargingStateNotification
batteryChargingOperState
.1.3.6.1.2.1.233.0.1
This notification can be generated when a charging state
of the battery (indicated by the value of object
batteryChargingOperState) is triggered by an event other
than a write action to object batteryChargingAdminState.
Such an event may, for example, be triggered by a local
battery controller.
batteryLowNotification
batteryActualCharge batteryActualVoltage batteryCellIdentifier
.1.3.6.1.2.1.233.0.2
This notification can be generated when the current charge
(batteryActualCharge) or the current voltage
(batteryActualVoltage) of the battery falls below a
threshold defined by object batteryAlarmLowCharge or object
batteryAlarmLowVoltage, respectively.

Note that, typically, this notification is generated in a
state where the battery is still sufficiently charged to keep
the device(s) that it powers operational for some time.
If the charging state of the battery has become critical,
i.e., the device(s) powered by the battery must go to a
'sleep' or 'off' state, then the batteryCriticalNotification
should be used instead.

If the low charge or voltage has been detected for a single
cell or a set of cells of the battery and not for the entire
battery, then object batteryCellIdentifier should be set to
a value that identifies the cell or set of cells.
Otherwise, the value of object batteryCellIdentifier should
be set to the empty string when this notification is
generated.

The notification should not be sent again for the same
battery or cell before either (a) the current voltage or
the current charge, respectively, has become higher than the
corresponding threshold through charging or (b) an indication
of a maintenance action has been detected, such as a battery
disconnection event or a reinitialization of the battery
monitoring system.

This notification should not be sent when the battery is in
a charging mode, i.e., the value of object
batteryChargingOperState is charging(2).
batteryCriticalNotification
batteryActualCharge batteryActualVoltage batteryCellIdentifier
.1.3.6.1.2.1.233.0.3
This notification can be generated when the current charge
of the battery falls so low that it cannot provide a
sufficient power supply function for regular operation
of the powered device(s). The battery needs to be charged
before it can be used for regular power supply again. The
battery may still provide sufficient power for a 'sleep'
mode of a powered device(s) or for a transition into an 'off'
mode.

If the critical state is caused by a single cell or a set of
cells of the battery, then object batteryCellIdentifier
should be set to a value that identifies the cell or set of
cells. Otherwise, the value of object batteryCellIdentifier
should be set to the empty string when this notification is
generated.

The notification should not be sent again for the same
battery before either the battery charge has increased
through charging to a non-critical value or an indication

of a maintenance action has been detected, such as a battery
disconnection event or a reinitialization of the battery
monitoring system.

This notification should not be sent when the battery is in
a charging mode, i.e., the value of object
batteryChargingOperState is charging(2).
batteryTemperatureNotification
batteryTemperature batteryCellIdentifier
.1.3.6.1.2.1.233.0.4
This notification can be generated when the measured
temperature (batteryTemperature) rises above the threshold
defined by object batteryAlarmHighTemperature or falls
below the threshold defined by object
batteryAlarmLowTemperature.

If the low or high temperature has been detected for a
single cell or a set of cells of the battery and not for the
entire battery, then object batteryCellIdentifier should be
set to a value that identifies the cell or set of cells.
Otherwise, the value of object batteryCellIdentifier should
be set to the empty string when this notification is
generated.

It may occur that the temperature alternates between values
slightly below and slightly above a threshold. For limiting
the notification rate in such a case, this notification
should not be sent again for the same battery or cell,
respectively, within a time interval of 10 minutes.

An exception to the rate limitations occurs immediately
after the reinitialization of the battery monitoring system.
At this point in time, if the battery temperature is above
the threshold defined by object batteryAlarmHighTemperature
or below the threshold defined by object
batteryAlarmLowTemperature, respectively, then this
notification should be sent, independent of the time at
which previous notifications for the same battery or cell,
respectively, had been sent.
batteryAgingNotification
batteryActualCapacity batteryChargingCycleCount batteryCellIdentifier
.1.3.6.1.2.1.233.0.5
This notification can be generated when the actual
capacity (batteryActualCapacity) falls below a threshold
defined by object batteryAlarmLowCapacity
or when the charging cycle count of the battery
(batteryChargingCycleCount) exceeds the threshold defined
by object batteryAlarmHighCycleCount.

If the aging has been detected for a single cell or a set
of cells of the battery and not for the entire battery, then
object batteryCellIdentifier should be set to a value that
identifies the cell or set of cells. Otherwise, the value
of object batteryCellIdentifier should be set to the empty
string when this notification is generated.

This notification should not be sent again for the same
battery or cell, respectively, before an indication of a
maintenance action has been detected, such as a battery
disconnection event or a reinitialization of the battery
monitoring system.
batteryConnectedNotification
batteryIdentifier
.1.3.6.1.2.1.233.0.6
This notification can be generated when it has been
detected that a battery has been connected. The battery
can be identified by the value of object batteryIdentifier
as well as by the value of index entPhysicalIndex that is
contained in the OID of object batteryIdentifier.
batteryDisconnectedNotification
.1.3.6.1.2.1.233.0.7
This notification can be generated when it has been
detected that one or more batteries have been disconnected.