1CLAB-UPS-MIB DEFINITIONS ::= BEGIN
2
3IMPORTS
4    MODULE-IDENTITY,
5    Integer32,
6    OBJECT-TYPE             FROM SNMPv2-SMI      -- RFC 2578
7
8    MODULE-COMPLIANCE       FROM SNMPv2-CONF     -- RFC 2580
9
10    clabCommonMibs          FROM CLAB-DEF-MIB;
11
12clabUpsMib MODULE-IDENTITY
13    LAST-UPDATED "201801180000Z" -- January 18, 2018
14    ORGANIZATION "Cable Television Laboratories, Inc."
15    CONTACT-INFO
16            "Postal: Cable Television Laboratories, Inc
17             858 Coal Creek Circle
18             Louisville, CO 80027
19             U.S.A.
20             Phone: +1-303-661-9100
21             Fax:   +1-303-661-9199
22             E-mail:mibs@cablelabs.com
23
24             Acknowledgements:
25             Sumanth Channabasappa - CableLabs
26             Jean-Francois Mule, CableLabs.
27             Kevin Marez, Motorola, Inc."
28    DESCRIPTION
29            "This MIB module provides the management objects for the
30             configuration and monitoring of the battery backup & UPS
31             functionality for CableLabs compliant devices.
32
33            Copyright 2004-2018 Cable Television Laboratories, Inc.
34            All rights reserved."
35    REVISION "201801180000Z" -- January 18, 2018
36    DESCRIPTION
37            "Revised Version includes ECN MIB-BB-N-17.0165-1"
38    REVISION "201004280000Z" -- April 28, 2010
39    DESCRIPTION
40            "Revised Version includes ECN MIB-BB-N-10.0047-2
41            and published as part of CL-SP-MIB-BB-I04-100608."
42    REVISION "200905060000Z" -- May 6, 2009
43    DESCRIPTION
44            "Revised Version includes ECN MIB-BB-N-09.0042-2
45            and published as part of CL-SP-MIB-BB-I03-090811."
46    REVISION "200701191700Z" -- January 19, 2007
47    DESCRIPTION
48            "This revision published as CL-SP-MIB-BB-I02-070119."
49
50    REVISION "200501280000Z" -- January 28, 2005
51    DESCRIPTION
52            "This revision published as CL-SP-MIB-BB-I01-050128."
53
54
55    ::= { clabCommonMibs 1 }
56
57-- Administrative assignments
58
59clabUpsNotifications OBJECT IDENTIFIER ::= { clabUpsMib 0 }
60clabUpsObjects       OBJECT IDENTIFIER ::= { clabUpsMib 1 }
61clabUpsConformance   OBJECT IDENTIFIER ::= { clabUpsMib 2 }
62
63
64-- Object Groups
65-- The object groups used in this MIB module are imported from
66-- the IETF RFC 1628, see the module compliance statement
67
68
69-- Conformance Statements
70   clabUpsCompliances OBJECT IDENTIFIER ::=
71                                           { clabUpsConformance 1 }
72   clabUpsGroups OBJECT IDENTIFIER      ::=
73                                           { clabUpsConformance 2 }
74
75clabSupplemtalGroup OBJECT IDENTIFIER ::= { clabUpsObjects 1 }
76
77
78   --   mtaDevPwrSupplyControl OBJECT-GROUP
79   --       OBJECTS { mtaDevPwrSupplyBatteryTest, mtaDevPwrSupplyConfigRunTime,
80   --          mtaDevPwrSupplyRatedMinutes, mtaDevPwrSupplyAvailableMinutes,
81   --          mtaDevPwrSupplyConfigReplaceBatteryTime }
82
83mtaDevPwrSupplyBatteryTest OBJECT-TYPE
84     SYNTAX INTEGER {
85         disableAutoTesting(1),
86         testScheduled(2),
87         testInProgress(3),
88         testPending(4)}
89     MAX-ACCESS read-write
90     STATUS current
91     DESCRIPTION
92       "This attribute enables the automated testing of a device's
93        battery and battery charging system when applicable. Automatic
94        battery testing is enabled by default and is performed immediately
95        from a cold power start if a valid test has not been previously
96        completed or if the scheduled test is due, and then repeats every
97        180 days.
98
99        The number of days left until a battery test is scheduled to run
100        can be found using MtaDevPwrSupplyBatteryTestTime MIB. When the
101        value TestScheduled(0) is set, the battery test scheduler resumes
102        at its current value.
103
104        When the value DisableAutoTesting(1) is set the device stops the
105        countdown timer MtaDevPwrSupplyBatteryTestTime at it's current value.
106
107        When the value TestInProgress(2) is set, the device initiates the
108        battery test cycle and the MtaDevPwrSupplyBatteryTestTime object is
109        reset to its default value of 180 days. This command is ignored if
110        there is a test in progress. The remaining scheduled time may be
111        skipped by issuing a value of testInProgress which will cause the
112        battery test to run immediately when AC power is present. Auto
113        testing is re-enabled (testScheduled) following the test.
114
115        When the test is active, the object will return the value
116        testInProgress(2), unless AC power is lost or a Full Charge has been
117        initiated. In that case, the will return the value testPending(3)."
118   ::= { clabSupplemtalGroup 1 }
119
120mtaDevPwrSupplyConfigRunTime   OBJECT-TYPE
121     SYNTAX Integer32
122     UNITS "minutes"
123     MAX-ACCESS read-write
124     STATUS current
125     DESCRIPTION
126         "This attribute provides the current programmed battery backup
127          minimum run time value. The minimum battery backup run time
128          may also from this value. By programming the run-time to a
129          lower value, the total service life of the battery is extended
130          by decreasing the battery's recharge threshold causing it to
131          recharge less often and to maintain a lower average charge state.
132          Increasing the run-time value in turn decreases the total service
133          life of the battery by causing it to recharge more often and to
134          maintain a higher average charge state. Setting this value greater
135          than MtaDevPwrSupplyAvailableMinutes will not provide a run-time
136          greater than the value in MtaDevPwrSupplyAvailableMinutes."
137    ::= { clabSupplemtalGroup 2 }
138
139mtaDevPwrSupplyRatedMinutes  OBJECT-TYPE
140     SYNTAX INTEGER
141     UNITS "minutes"
142     MAX-ACCESS read-only
143     STATUS current
144     DESCRIPTION
145         "This attribute provides the device's estimate of the rated battery
146          backup run-time which is based upon the unit's typical idle power,
147          the internal battery management power and the tested energy-capacity
148          of the battery when fully charged"
149      ::= { clabSupplemtalGroup 3 }
150
151mtaDevPwrSupplyAvailableMinutes  OBJECT-TYPE
152     SYNTAX INTEGER
153     UNITS "minutes"
154     MAX-ACCESS read-only
155     STATUS current
156     DESCRIPTION
157         "This attribute provides an estimate of the available run-time on
158          the battery based upon the unit's typical idle power and the tested
159          capacity of the battery when fully charged."
160      ::= { clabSupplemtalGroup 4 }
161
162mtaDevPwrSupplyConfigReplaceBatteryTime  OBJECT-TYPE
163     SYNTAX Integer32
164     UNITS "minutes"
165     MAX-ACCESS read-write
166     STATUS current
167     DESCRIPTION
168         "This attribute allows the operator to establish a replace battery
169          threshold value in terms of backup battery run-time minutes.  If
170          a battery's Available Minutes has degraded to a point where it
171          can no longer provide more than the value of this object minutes of
172          run-time, an uspAlarmBatteryBad alarm condition is declared. The
173          default value at power up is the equivalent Battery Backup run time
174          using 50% of the Rated Minutes."
175          ::= { clabSupplemtalGroup 5 }
176
177mtaDevPwrSupplyFullChargeTime OBJECT-TYPE
178     SYNTAX  Integer32
179     MAX-ACCESS read-write
180     STATUS current
181     DESCRIPTION
182         "This attribute configures the number of days that the device will
183          maintain a fully charged battery.  Setting this object value from
184          1 to 16 will cause the battery to be immediately charged to its
185          full state, which is equal to the value reported by
186          MtaDevPwrSupplyAvailableMinutes. The attribute when read serves as
187          a countdown timer for the number of days remaining at the fully
188          charged state. If the value 0 is read, this indicates that battery
189          is not being maintained in the fully charged state."
190     ::= { clabSupplemtalGroup 6 }
191
192
193mtaDevPwrSupplyBatteryTestTime OBJECT-TYPE
194     SYNTAX INTEGER
195     MAX-ACCESS read-only
196     STATUS current
197     DESCRIPTION
198         "This attribute is a countdown timer that reflects when the next
199          scheduled Battery Test will be executed. Reading this object will
200          provide the number of days remaining until the next battery test
201          is scheduled to run.  This attribute returns 255 whenever the
202          MtaDevPwrSupplyBatteryTest attribute has been set for
203          disableAutoTesting(0)."
204       ::= { clabSupplemtalGroup 7 }
205
206clabUpsMibCompliance MODULE-COMPLIANCE
207       STATUS     current
208       DESCRIPTION
209               "The compliance statement for CableLabs compliant
210                devices that implement battery backup and UPS
211                functionality."
212
213       MODULE UPS-MIB -- RFC 1628
214           MANDATORY-GROUPS  {
215                     upsSubsetIdentGroup,
216                     upsFullBatteryGroup,
217                     upsBasicInputGroup,
218                     upsBasicOutputGroup,
219                     upsBasicAlarmGroup,
220                     upsBasicControlGroup,
221                     upsBasicConfigGroup
222                     }
223
224
225 -- upsSubsetIdentGroup OBJECT-GROUP
226 --    OBJECTS { upsIdentManufacturer, upsIdentModel,
227 --              upsIdentAgentSoftwareVersion, upsIdentName,
228 --              upsIdentAttachedDevices }
229
230   OBJECT       upsIdentManufacturer
231   DESCRIPTION
232      "The name of the device manufacturer."
233
234   OBJECT       upsIdentModel                       -- same as RFC 1628
235   DESCRIPTION
236      "The UPS Model designation."
237
238   OBJECT       upsIdentAgentSoftwareVersion        -- same as RFC 1628
239   DESCRIPTION
240      "The UPS agent software version which may have
241       be the same as the upsIdentUPSSoftwareVersion
242       object value."
243
244   OBJECT       upsIdentName
245   DESCRIPTION
246      "Identifies the UPS and its value if provided in the device
247       configuration file.  Else, the default is an empty string."
248
249   OBJECT       upsIdentAttachedDevices
250   DESCRIPTION
251      "A column separated list of the names of the embedded devices
252       attached to the UPS power output as specified in CableLabs'
253       DHCP Options Registry."
254--       REFERENCE
255--          "CableLabs Specifications, CableLabs' DHCP Options Registry."
256
257
258
259--   upsBasicAlarmGroup OBJECT-GROUP
260--       OBJECTS { upsAlarmsPresent, upsAlarmDescr, upsAlarmTime }
261
262--   upsFullBatteryGroup OBJECT-GROUP
263--   OBJECTS { upsBatteryStatus, upsSecondsOnBattery,
264--             upsEstimatedMinutesRemaining,
265--             upsEstimatedChargeRemaining }
266
267   OBJECT       upsBatteryStatus
268   SYNTAX     INTEGER {
269       unknown(1),
270       batteryNormal(2),
271       batteryLow(3),
272       batteryDepleted(4)
273   }
274   DESCRIPTION
275      "Reports the battery status."
276
277   OBJECT       upsSecondsOnBattery
278   DESCRIPTION
279      "The elapsed time since the UPS last switched to battery power,
280       or the time since the device was last restarted, whichever is
281       less. A value of 0 is returned if the attached devices are not
282       on battery power."
283
284   OBJECT       upsEstimatedMinutesRemaining     -- same as RFC 1628
285   DESCRIPTION
286      "An estimate of the time to battery charge depletion
287       under the present load conditions if the utility power
288       is off and remains off, or if it were to be lost and
289       remain off."
290
291   OBJECT       upsEstimatedChargeRemaining      -- same as RFC 1628
292   DESCRIPTION
293      "An estimate of the battery charge remaining expressed
294       as a percent of full charge."
295
296
297--  upsBasicInputGroup OBJECT-GROUP
298--      OBJECTS { upsInputLineBads, upsInputNumLines,
299--                upsInputFrequency, upsInputVoltage }
300--
301   OBJECT       upsInputLineBads
302   DESCRIPTION
303      "A count of the number of times the input entered an
304       out-of-tolerance condition as defined by the manufacturer.
305       This count is incremented by one each time the input
306       transitions from zero out-of-tolerance lines to one or more
307       input lines out-of-tolerance."
308
309   OBJECT       upsInputNumLines
310   DESCRIPTION
311      "Specifies the number of input lines utilized in this device.
312       For example, for an eDOCSIS E-MTA device with 1 battery pack
313       and 1 AC power source, this object value must be 2."
314
315   OBJECT       upsInputFrequency
316   DESCRIPTION
317      "The present input frequency."
318
319   OBJECT       upsInputVoltage
320   DESCRIPTION
321      "The magnitude of the present input voltage."
322
323
324--   upsBasicOutputGroup OBJECT-GROUP
325--       OBJECTS { upsOutputSource, upsOutputFrequency,
326--                 upsOutputNumLines, upsOutputVoltage }
327
328   OBJECT       upsOutputSource
329   SYNTAX INTEGER {
330       none(2),
331       normal(3),
332       battery(5)
333   }
334   DESCRIPTION
335      "The present source of output power.  The enumeration none(2)
336       indicates that there is no source of output power (and
337       therefore no output power), for example, the system has opened
338       the output breaker The upsOutputSource value of other(1) may be
339       used to represent transient states."
340
341   OBJECT       upsOutputFrequency
342   DESCRIPTION
343      "The present output frequency."
344
345   OBJECT       upsOutputNumLines
346   DESCRIPTION
347      "The upsOutputNumLines object specifies the number of output
348       lines utilized in this eDOCSIS device.
349       For example, for an eDOCSIS E-MTA devices with both the eCM and
350       eMTA attached to the UPS, this object value must be 2."
351   OBJECT        upsOutputVoltage
352   DESCRIPTION
353      "The upsOutputVoltage object MAY be supported."
354
355
356
357   OBJECT       upsAlarmsPresent                 -- same as RFC 1628
358   DESCRIPTION
359      "The upsAlarmsPresent object indicates the current number of
360       active alarm conditions."
361
362   OBJECT       upsAlarmDescr
363   DESCRIPTION
364       "Descriptions for the following well known alarm types:
365
366          upsAlarmBatteryBad,
367          upsAlarmOnBattery,
368          upsAlarmLowBattery,
369          upsAlarmDepletedBattery,
370          upsAlarmOutputOffAsRequested,
371          upsAlarmUpsOutputOff,
372          upsAlarmGeneralFault,
373          upsAlarmAwaitingPower,
374          upsAlarmShutdownPending,
375          upsAlarmShutdownImminent."
376
377   OBJECT       upsAlarmTime                     -- same as RFC 1628
378   DESCRIPTION
379      "The upsAlarmTime object indicates the value of sysUpTime when
380       the alarm condition was detected."
381
382
383--   upsBasicControlGroup OBJECT-GROUP
384--       OBJECTS { upsShutdownType, upsShutdownAfterDelay,
385--                 upsStartupAfterDelay, upsRebootWithDuration,
386--                 upsAutoRestart }
387
388   OBJECT       upsShutdownType
389   SYNTAX     INTEGER {
390                         output(1)
391                      }
392   DESCRIPTION
393      "The upsShutdownType object defines the nature of the action to
394       be taken at the time when the countdown of the
395       upsShutdownAfterDelay and upsRebootWithDuration object values
396       reach zero."
397
398   OBJECT       upsStartupAfterDelay
399   SYNTAX     INTEGER (-1..604800) -- max range is 7 days or 604800s
400   DESCRIPTION
401       "Start the output after the indicated number of seconds, including
402        starting the UPS, if necessary.  Setting this object to 0 will cause
403        the startup to occur immediately."
404
405   OBJECT       upsRebootWithDuration            -- same as RFC 1628
406   DESCRIPTION
407      "The upsRebootWithDuration controls a reboot procedure with
408       a countdown. It also indicates whether a reboot procedure is in
409       progress and the number of seconds remaining in the countdown."
410
411   OBJECT       upsAutoRestart                   -- same as RFC 1628
412   DESCRIPTION
413      "The upsAutoRestart is only applicable for UPS system shutdown."
414
415
416--   upsBasicConfigGroup OBJECT-GROUP
417--       OBJECTS { upsConfigInputVoltage, upsConfigInputFreq,
418--                 upsConfigOutputVoltage, upsConfigOutputFreq,
419--                 upsConfigOutputVA, upsConfigOutputPower,
420--                 upsConfigLowBattTime, upsConfigAudibleStatus }
421
422   OBJECT       upsConfigInputVoltage
423   DESCRIPTION
424      "The magnitude of the nominal input voltage."
425
426   OBJECT       upsConfigInputFreq
427   DESCRIPTION
428      "The he nominal input frequency."
429
430   OBJECT       upsConfigOutputVoltage
431   DESCRIPTION
432      "TThe magnitude of the nominal output voltage."
433
434   OBJECT       upsConfigOutputFreq
435   DESCRIPTION
436      "The nominal output frequency."
437
438   OBJECT       upsConfigOutputVA
439   DESCRIPTION
440      "The magnitude of the nominal Volt-Amp rating."
441
442   OBJECT       upsConfigOutputPower
443   DESCRIPTION
444      "The magnitude of the nominal true power rating."
445
446   OBJECT       upsConfigLowBattTime             -- same as RFC 1628
447   DESCRIPTION
448      "The upsConfigLowBattTime specifies the value of
449       upsEstimatedMinutesRemaining at which a lowBattery condition is
450       declared."
451
452
453   OBJECT       upsConfigAudibleStatus
454   DESCRIPTION
455      "The requested state of the audible alarm.."
456
457
458   ::= { clabUpsGroups 1}
459
460   --
461   -- Units of conformance for CableLabs UPS capable devices
462   -- Adapted from RFC 1628, a column was added for CableLabs devices
463   -- An 'x' in the column means the object MUST be supported; all the
464   -- rest is optional and left for vendor decision.
465
466END