Standard view Table view

CLAB-UPS-MIB

        This MIB module provides the management objects for the
configuration and monitoring of the battery backup & UPS
functionality for CableLabs compliant devices.
        
Copyright 2004-2018 Cable Television Laboratories, Inc.
All rights reserved.
Source file
CLAB-UPS-MIB
Last revised
Identity
clabUpsMib
Base OID
1.3.6.1.4.1.4491.4.1
Imported Objects
CLAB-DEF-MIB clabCommonMibs
SNMPv2-CONF MODULE-COMPLIANCE
SNMPv2-SMI Integer32 MODULE-IDENTITY OBJECT-TYPE
UPS-MIB upsAlarmDescr upsAlarmsPresent upsAlarmTime upsAutoRestart upsBasicAlarmGroup upsBasicConfigGroup upsBasicControlGroup upsBasicInputGroup upsBasicOutputGroup upsBatteryStatus upsConfigAudibleStatus upsConfigInputFreq upsConfigInputVoltage upsConfigLowBattTime upsConfigOutputFreq upsConfigOutputPower upsConfigOutputVA upsConfigOutputVoltage upsEstimatedChargeRemaining upsEstimatedMinutesRemaining upsFullBatteryGroup upsIdentAgentSoftwareVersion upsIdentAttachedDevices upsIdentManufacturer upsIdentModel upsIdentName upsInputFrequency upsInputLineBads upsInputNumLines upsInputVoltage upsOutputFrequency upsOutputNumLines upsOutputSource upsOutputVoltage upsRebootWithDuration upsSecondsOnBattery upsShutdownType upsStartupAfterDelay upsSubsetIdentGroup
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 'CLAB-UPS-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'CLAB-UPS-MIB::clabUpsMib'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'CLAB-UPS-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'CLAB-UPS-MIB::clabUpsMib'
How SNMP, Net-SNMP, MIB paths, and variants work
Objects (14)
clabUpsMib
.1.3.6.1.4.1.4491.4.1
clabUpsNotifications
.1.3.6.1.4.1.4491.4.1.0
clabUpsObjects
.1.3.6.1.4.1.4491.4.1.1
clabSupplemtalGroup
.1.3.6.1.4.1.4491.4.1.1.1
mtaDevPwrSupplyBatteryTest r/w
Enumeration
 .1.3.6.1.4.1.4491.4.1.1.1.1
mtaDevPwrSupplyConfigRunTime r/w
minutesSNMPv2-SMIInteger32
 .1.3.6.1.4.1.4491.4.1.1.1.2
mtaDevPwrSupplyRatedMinutes
minutesSNMPv2-SMIInteger32
 .1.3.6.1.4.1.4491.4.1.1.1.3
mtaDevPwrSupplyAvailableMinutes
minutesSNMPv2-SMIInteger32
 .1.3.6.1.4.1.4491.4.1.1.1.4
mtaDevPwrSupplyConfigReplaceBatteryTime r/w
minutesSNMPv2-SMIInteger32
 .1.3.6.1.4.1.4491.4.1.1.1.5
mtaDevPwrSupplyFullChargeTime r/w
SNMPv2-SMIInteger32
 .1.3.6.1.4.1.4491.4.1.1.1.6
mtaDevPwrSupplyBatteryTestTime
SNMPv2-SMIInteger32
 .1.3.6.1.4.1.4491.4.1.1.1.7
clabUpsConformance
.1.3.6.1.4.1.4491.4.1.2
clabUpsCompliances
.1.3.6.1.4.1.4491.4.1.2.1
clabUpsGroups
.1.3.6.1.4.1.4491.4.1.2.2
Dependencies (11) 4 direct · 7 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. IANAifType-MIBrfc
  4. SNMPv2-CONFrfc
  5. SNMPv2-MIBrfc
  6. IF-MIBrfc
  7. INET-ADDRESS-MIBrfc
  8. SNMP-FRAMEWORK-MIBrfc
  9. DOCS-IETF-BPI2-MIBrfc
  10. CLAB-DEF-MIBrfc
  11. UPS-MIBrfc
  12. CLAB-UPS-MIBrfcselected
Compliance Statements (1)

OID .1.3.6.1.4.1.4491.4.1.2.2.1
The compliance statement for CableLabs compliant
devices that implement battery backup and UPS
functionality.
Required groups
mandatory UPS-MIB::upsSubsetIdentGroup
mandatory UPS-MIB::upsFullBatteryGroup
mandatory UPS-MIB::upsBasicInputGroup
mandatory UPS-MIB::upsBasicOutputGroup
mandatory UPS-MIB::upsBasicAlarmGroup
mandatory UPS-MIB::upsBasicControlGroup
mandatory UPS-MIB::upsBasicConfigGroup
Object refinements
ObjectAccessSyntaxDescription
UPS-MIBupsIdentManufacturer
The name of the device manufacturer.
UPS-MIBupsIdentModel
The UPS Model designation.
UPS-MIBupsIdentAgentSoftwareVersion
The UPS agent software version which may have
be the same as the upsIdentUPSSoftwareVersion
object value.
UPS-MIBupsIdentName
Identifies the UPS and its value if provided in the device
configuration file. Else, the default is an empty string.
UPS-MIBupsIdentAttachedDevices
A column separated list of the names of the embedded devices
attached to the UPS power output as specified in CableLabs'
DHCP Options Registry.
UPS-MIBupsBatteryStatus
Enumeration
unknown(1), batteryNormal(2), batteryLow(3), batteryDepleted(4)
Reports the battery status.
UPS-MIBupsSecondsOnBattery
The elapsed time since the UPS last switched to battery power,
or the time since the device was last restarted, whichever is
less. A value of 0 is returned if the attached devices are not
on battery power.
UPS-MIBupsEstimatedMinutesRemaining
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.
UPS-MIBupsEstimatedChargeRemaining
An estimate of the battery charge remaining expressed
as a percent of full charge.
UPS-MIBupsInputLineBads
A count of the number of times the input entered an
out-of-tolerance condition as defined by the manufacturer.
This count is incremented by one each time the input
transitions from zero out-of-tolerance lines to one or more
input lines out-of-tolerance.
UPS-MIBupsInputNumLines
Specifies the number of input lines utilized in this device.
For example, for an eDOCSIS E-MTA device with 1 battery pack
and 1 AC power source, this object value must be 2.
UPS-MIBupsInputFrequency
The present input frequency.
UPS-MIBupsInputVoltage
The magnitude of the present input voltage.
UPS-MIBupsOutputSource
Enumeration
none(2), normal(3), battery(5)
The present source of output power. The enumeration none(2)
indicates that there is no source of output power (and
therefore no output power), for example, the system has opened
the output breaker The upsOutputSource value of other(1) may be
used to represent transient states.
UPS-MIBupsOutputFrequency
The present output frequency.
UPS-MIBupsOutputNumLines
The upsOutputNumLines object specifies the number of output
lines utilized in this eDOCSIS device.
For example, for an eDOCSIS E-MTA devices with both the eCM and
eMTA attached to the UPS, this object value must be 2.
UPS-MIBupsOutputVoltage
The upsOutputVoltage object MAY be supported.
UPS-MIBupsAlarmsPresent
The upsAlarmsPresent object indicates the current number of
active alarm conditions.
UPS-MIBupsAlarmDescr
Descriptions for the following well known alarm types:

upsAlarmBatteryBad,
upsAlarmOnBattery,
upsAlarmLowBattery,
upsAlarmDepletedBattery,
upsAlarmOutputOffAsRequested,
upsAlarmUpsOutputOff,
upsAlarmGeneralFault,
upsAlarmAwaitingPower,
upsAlarmShutdownPending,
upsAlarmShutdownImminent.
UPS-MIBupsAlarmTime
The upsAlarmTime object indicates the value of sysUpTime when
the alarm condition was detected.
UPS-MIBupsShutdownType
Enumeration
output(1)
The upsShutdownType object defines the nature of the action to
be taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration object values
reach zero.
UPS-MIBupsStartupAfterDelay
Integer32
 Start the output after the indicated number of seconds, including
starting the UPS, if necessary. Setting this object to 0 will cause
the startup to occur immediately.
UPS-MIBupsRebootWithDuration
The upsRebootWithDuration controls a reboot procedure with
a countdown. It also indicates whether a reboot procedure is in
progress and the number of seconds remaining in the countdown.
UPS-MIBupsAutoRestart
The upsAutoRestart is only applicable for UPS system shutdown.
UPS-MIBupsConfigInputVoltage
The magnitude of the nominal input voltage.
UPS-MIBupsConfigInputFreq
The he nominal input frequency.
UPS-MIBupsConfigOutputVoltage
TThe magnitude of the nominal output voltage.
UPS-MIBupsConfigOutputFreq
The nominal output frequency.
UPS-MIBupsConfigOutputVA
The magnitude of the nominal Volt-Amp rating.
UPS-MIBupsConfigOutputPower
The magnitude of the nominal true power rating.
UPS-MIBupsConfigLowBattTime
The upsConfigLowBattTime specifies the value of
upsEstimatedMinutesRemaining at which a lowBattery condition is
declared.
UPS-MIBupsConfigAudibleStatus
The requested state of the audible alarm..