SNMP: apc_ups.yaml (#20419)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
Jun 5, 2025 at 10:56 UTC
21c28b517c0b85874c2e73712ec5abe0ee559c3a
1 file changed
+177
-139
src/go/plugin/go.d/config/go.d/snmp.profiles/default/apc_ups.yaml
+177
-139
@@ -25,250 +25,288 @@ metrics:
25
symbol:
26
OID: 1.3.6.1.4.1.318.1.1.1.2.2.5.0
27
name: upsAdvBatteryNumOfBattPacks
28
- description: "The number of external battery packs connected to the UPS."
29
- unit: "{battery_pack}"
28
+ description: The number of external battery packs connected to the UPS
29
+ family: UPS/APC/Battery/Packs
30
+ unit: "{pack}"
31
- MIB: POWERNET-MIB
32
symbol:
33
OID: 1.3.6.1.4.1.318.1.1.1.2.2.6.0
34
name: upsAdvBatteryNumOfBadBattPacks
34
- description: "The number of external battery packs connected to the UPS that are defective."
35
- unit: "{battery_pack}"
35
+ description: The number of external battery packs connected to the UPS that are defective
36
+ family: UPS/APC/Battery/Packs
37
+ unit: "{pack}"
38
- MIB: PowerNet-MIB
39
symbol:
40
OID: 1.3.6.1.4.1.318.1.1.1.2.2.4.0
41
name: upsAdvBatteryReplaceIndicator
40
- description: "Indicates whether the UPS batteries need replacing."
41
- unit: "{indicator}"
42
+ description: Indicates whether the UPS batteries need replacing (int 2)
43
+ family: UPS/APC/Battery/Status
44
+ unit: "1"
45
- MIB: PowerNet-MIB
46
symbol:
47
OID: 1.3.6.1.4.1.318.1.1.1.2.2.3.0
48
name: upsAdvBatteryRunTimeRemaining
46
- description: "The UPS battery run time remaining before battery exhaustion."
47
- unit: "s"
49
+ description: The UPS battery run time remaining before battery exhaustion
50
+ family: UPS/APC/Battery/TimeOnBattery
51
+ unit: "s"
52
- MIB: PowerNet-MIB
53
symbol:
54
OID: 1.3.6.1.4.1.318.1.1.1.2.2.2.0
55
name: upsAdvBatteryTemperature
52
- description: "The current internal UPS temperature expressed in Celsius."
53
- unit: "Cel"
56
+ description: The current internal UPS temperature expressed in Celsius
57
+ family: UPS/APC/Battery/Temperature
58
+ unit: "Cel"
59
- MIB: PowerNet-MIB
60
symbol:
61
OID: 1.3.6.1.4.1.318.1.1.1.2.2.1.0
62
name: upsAdvBatteryCapacity
58
- description: "The remaining battery capacity expressed in percent of full capacity."
59
- unit: "%"
63
+ description: The remaining battery capacity expressed in percent of full capacity
64
+ family: UPS/APC/Battery/Capacity
65
+ unit: "%"
66
- MIB: PowerNet-MIB
67
symbol:
68
OID: 1.3.6.1.4.1.318.1.1.1.2.3.2.0
69
name: upsHighPrecExtdBatteryTemperature
64
- description: "The current internal UPS temperature expressed in tenths of degrees Celsius."
65
- unit: "Cel/10"
70
+ description: The current internal UPS temperature expressed in tenths of degrees Celsius
71
+ family: UPS/APC/Battery/Temperature
72
+ unit: "Cel/10"
73
- MIB: PowerNet-MIB
74
symbol:
75
OID: 1.3.6.1.4.1.318.1.1.1.3.2.1.0
76
name: upsAdvInputLineVoltage
70
- description: "The current utility line voltage in VAC."
71
- unit: "V"
77
+ description: The current utility line voltage in VAC
78
+ family: UPS/APC/Input/Voltage
79
+ unit: "V"
80
+ - MIB: PowerNet-MIB
81
+ symbol:
82
+ OID: 1.3.6.1.4.1.318.1.1.1.3.3.1.0
83
+ name: upsHighPrecInputLineVoltage
84
+ description: "The current utility line voltage in tenths of VAC."
85
+ family: UPS/APC/Input/Voltage
86
+ unit: "V/10"
87
- MIB: PowerNet-MIB
88
symbol:
89
OID: 1.3.6.1.4.1.318.1.1.1.3.2.4.0
90
name: upsAdvInputFrequency
76
- description: "The current input frequency to the UPS system in Hz."
77
- unit: "Hz"
91
+ description: The current input frequency to the UPS system in Hz
92
+ family: UPS/APC/Input/Frequency
93
+ unit: "Hz"
94
- MIB: PowerNet-MIB
95
symbol:
96
OID: 1.3.6.1.4.1.318.1.1.1.3.3.4.0
97
name: upsHighPrecInputFrequency
82
- description: "The current input frequency to the UPS system in tenths of Hz."
83
- unit: "Hz/10"
84
- - MIB: PowerNet-MIB
85
- symbol:
86
- OID: 1.3.6.1.4.1.318.1.1.1.3.3.1.0
87
- name: upsHighPrecInputLineVoltage
88
- description: "The current utility line voltage in tenths of VAC."
89
- unit: "V/10"
98
+ description: The current input frequency to the UPS system in tenths of Hz
99
+ family: UPS/APC/Input/Frequency
100
+ unit: "Hz/10"
101
- MIB: PowerNet-MIB
102
symbol:
103
OID: 1.3.6.1.4.1.318.1.1.1.4.3.4.0
104
name: upsHighPrecOutputCurrent
94
- description: "The current in tenths of amperes drawn by the load on the UPS."
95
- unit: "dA"
105
+ description: The current in tenths of amperes drawn by the load on the UPS
106
+ family: UPS/APC/Input/Current
107
+ unit: "dA"
108
- MIB: PowerNet-MIB
109
symbol:
110
OID: 1.3.6.1.4.1.318.1.1.1.3.2.5.0
111
name: upsAdvInputLineFailCause
100
- description: "The reason for the occurrence of the last transfer to UPS battery power."
101
- unit: "TBD"
112
+ description: The reason for the occurrence of the last transfer to UPS battery power
113
+ family: UPS/APC/Input/FailCause
114
+ unit: "{status}"
115
+ mapping:
116
+ 1: noTransfer
117
+ 2: highLineVoltage
118
+ 3: brownout
119
+ 4: blackout
120
+ 5: smallMomentarySag
121
+ 6: deepMomentarySag
122
+ 7: smallMomentarySpike
123
+ 8: largeMomentarySpike
124
+ 9: selfTest
125
+ 10: rateOfVoltageChange
126
- MIB: PowerNet-MIB
127
symbol:
128
OID: 1.3.6.1.4.1.318.1.1.1.4.2.1.0
129
name: upsAdvOutputVoltage
106
- description: "The output voltage of the UPS system in VAC."
107
- unit: "V"
130
+ description: The output voltage of the UPS system in VAC
131
+ family: UPS/APC/Output/Voltage
132
+ unit: "V"
133
- MIB: PowerNet-MIB
134
symbol:
135
OID: 1.3.6.1.4.1.318.1.1.1.4.2.2.0
136
name: upsAdvOutputFrequency
112
- description: "The current output frequency of the UPS system in Hz."
113
- unit: "Hz"
137
+ description: The current output frequency of the UPS system in Hz
138
+ family: UPS/APC/Output/Frequency
139
+ unit: "Hz"
140
- MIB: PowerNet-MIB
141
symbol:
142
OID: 1.3.6.1.4.1.318.1.1.1.4.2.3.0
143
name: upsAdvOutputLoad
118
- description: "The current UPS load expressed in percent of rated capacity."
119
- unit: "%"
144
+ description: The current UPS load expressed in percent of rated capacity
145
+ family: UPS/APC/Output/Load
146
+ unit: "%"
147
- MIB: PowerNet-MIB
148
symbol:
149
OID: 1.3.6.1.4.1.318.1.1.1.4.2.4.0
150
name: upsAdvOutputCurrent
124
- description: "The current in amperes drawn by the load on the UPS."
125
- unit: "A"
151
+ description: The current in amperes drawn by the load on the UPS
152
+ family: UPS/APC/Output/Current
153
+ unit: "A"
154
- MIB: PowerNet-MIB
155
symbol:
156
OID: 1.3.6.1.4.1.318.1.1.1.4.2.8.0
157
name: upsAdvOutputActivePower
130
- description: "The total output active power of the UPS system in W."
131
- unit: "W"
158
+ description: The total output active power of the UPS system in W
159
+ family: UPS/APC/Output/Power
160
+ unit: "W"
161
- MIB: PowerNet-MIB
162
symbol:
163
OID: 1.3.6.1.4.1.318.1.1.1.4.2.9.0
164
name: upsAdvOutputApparentPower
136
- description: "The total output apparent power of all phases of the UPS system in VA."
137
- unit: "VA"
165
+ description: The total output apparent power of all phases of the UPS system in VA
166
+ family: UPS/APC/Output/Power
167
+ unit: "VA"
168
- MIB: PowerNet-MIB
169
symbol:
170
OID: 1.3.6.1.4.1.318.1.1.1.4.2.12.0
171
name: upsAdvOutputEnergyUsage
142
- description: "The output energy usage of the UPS in hundredths of kWh."
172
+ description: The output energy usage of the UPS in hundredths of kWh
173
+ family: UPS/APC/Output/Energy
174
unit: "kWh/100"
175
- MIB: PowerNet-MIB
176
symbol:
177
OID: 1.3.6.1.4.1.318.1.1.1.2.1.2.0
178
name: upsBasicBatteryTimeOnBattery
148
- description: "The elapsed time since the UPS has switched to battery power."
149
- unit: "s"
179
+ description: The elapsed time since the UPS has switched to battery power
180
+ family: UPS/APC/Battery/TimeOnBattery
181
+ unit: "s"
182
- MIB: PowerNet-MIB
183
symbol:
184
OID: 1.3.6.1.4.1.318.1.1.1.7.2.3.0
185
name: upsAdvTestDiagnosticsResults
154
- description: "The results of the last UPS diagnostics test performed."
155
- unit: "TBD"
156
- - MIB: PowerNet-MIB
157
- symbol:
158
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
159
- name: upsBasicStateOutputState
160
- metric_type: flag_stream
161
- options:
162
- placement: 4
163
- metric_suffix: OnLine
164
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
165
- unit: "TBD"
166
- - MIB: PowerNet-MIB
167
- symbol:
168
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
169
- name: upsBasicStateOutputState
170
- metric_type: flag_stream
171
- options:
172
- placement: 5
173
- metric_suffix: ReplaceBattery
174
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
175
- unit: "TBD"
176
- - MIB: PowerNet-MIB
177
- symbol:
178
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
179
- name: upsBasicStateOutputState
180
- metric_type: flag_stream
181
- options:
182
- placement: 8
183
- metric_suffix: AVRTrimActive
184
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
185
- unit: "TBD"
186
- - MIB: PowerNet-MIB
187
- symbol:
188
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
189
- name: upsBasicStateOutputState
190
- metric_type: flag_stream
191
- options:
192
- placement: 11
193
- metric_suffix: BatteriesDischarged
194
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
195
- unit: "TBD"
196
- - MIB: PowerNet-MIB
197
- symbol:
198
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
199
- name: upsBasicStateOutputState
200
- metric_type: flag_stream
201
- options:
202
- placement: 19
203
- metric_suffix: "On"
204
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
205
- unit: "TBD"
206
- - MIB: PowerNet-MIB
207
- symbol:
208
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
209
- name: upsBasicStateOutputState
210
- metric_type: flag_stream
211
- options:
212
- placement: 30
213
- metric_suffix: LowBatteryOnBattery
214
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
215
- unit: "TBD"
216
- - MIB: PowerNet-MIB
217
- symbol:
218
- OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
219
- name: upsBasicStateOutputState
220
- metric_type: flag_stream
221
- options:
222
- placement: 33
223
- metric_suffix: NoBatteriesAttached
224
- description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
225
- unit: "TBD"
186
+ description: The results of the last UPS diagnostics test performed
187
+ family: UPS/APC/Test/Status
188
+ unit: "{status}"
189
+ mapping:
190
+ 1: ok
191
+ 2: failed
192
+ 3: invalidTest
193
+ 4: testInProgress
194
+ # - MIB: PowerNet-MIB
195
+ # symbol:
196
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
197
+ # name: upsBasicStateOutputState
198
+ # metric_type: flag_stream
199
+ # options:
200
+ # placement: 4
201
+ # metric_suffix: OnLine
202
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
203
+ # unit: "TBD"
204
+ # - MIB: PowerNet-MIB
205
+ # symbol:
206
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
207
+ # name: upsBasicStateOutputState
208
+ # metric_type: flag_stream
209
+ # options:
210
+ # placement: 5
211
+ # metric_suffix: ReplaceBattery
212
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
213
+ # unit: "TBD"
214
+ # - MIB: PowerNet-MIB
215
+ # symbol:
216
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
217
+ # name: upsBasicStateOutputState
218
+ # metric_type: flag_stream
219
+ # options:
220
+ # placement: 8
221
+ # metric_suffix: AVRTrimActive
222
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
223
+ # unit: "TBD"
224
+ # - MIB: PowerNet-MIB
225
+ # symbol:
226
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
227
+ # name: upsBasicStateOutputState
228
+ # metric_type: flag_stream
229
+ # options:
230
+ # placement: 11
231
+ # metric_suffix: BatteriesDischarged
232
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
233
+ # unit: "TBD"
234
+ # - MIB: PowerNet-MIB
235
+ # symbol:
236
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
237
+ # name: upsBasicStateOutputState
238
+ # metric_type: flag_stream
239
+ # options:
240
+ # placement: 19
241
+ # metric_suffix: "On"
242
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
243
+ # unit: "TBD"
244
+ # - MIB: PowerNet-MIB
245
+ # symbol:
246
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
247
+ # name: upsBasicStateOutputState
248
+ # metric_type: flag_stream
249
+ # options:
250
+ # placement: 30
251
+ # metric_suffix: LowBatteryOnBattery
252
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
253
+ # unit: "TBD"
254
+ # - MIB: PowerNet-MIB
255
+ # symbol:
256
+ # OID: 1.3.6.1.4.1.318.1.1.1.11.1.1.0
257
+ # name: upsBasicStateOutputState
258
+ # metric_type: flag_stream
259
+ # options:
260
+ # placement: 33
261
+ # metric_suffix: NoBatteriesAttached
262
+ # description: "An ASCII string containing the 64 flags representing the current state(s) of the UPS."
263
+ # unit: "TBD"
264
+ #
265
+ # TODO string metrics, not supported yet
266
- MIB: PowerNet-MIB
267
table:
268
OID: 1.3.6.1.4.1.318.1.1.1.12.1.2
269
name: upsOutletGroupStatusTable
270
symbols:
231
- - name: upsOutletGroupStatus
232
- constant_value_one: true
271
- OID: 1.3.6.1.4.1.318.1.1.1.12.1.2.1.3
272
name: upsOutletGroupStatusGroupState
235
- # TODO: Check out metric_tags with symbols having mappings and/or expressing states/statuses. Need to convert to metrics.
273
+ description: Outlet group state
274
+ family: UPS/APC/Outlet/Status
275
+ status: "{status}"
276
+ mapping:
277
+ 1: ups_outlet_group_status_on
278
+ 2: ups_outlet_group_status_off
279
+ 3: ups_outlet_group_status_unknown
280
metric_tags:
281
- tag: outlet_group_name
282
symbol:
283
OID: 1.3.6.1.4.1.318.1.1.1.12.1.2.1.2
284
name: upsOutletGroupStatusName
241
- - tag: ups_outlet_group_status_group_state
242
- symbol:
243
- OID: 1.3.6.1.4.1.318.1.1.1.12.1.2.1.3
244
- name: upsOutletGroupStatusGroupState
245
- mapping:
246
- 1: ups_outlet_group_status_on
247
- 2: ups_outlet_group_status_off
248
- 3: ups_outlet_group_status_unknown
249
- description: "Allows for getting status of the outlet groups."
250
- unit: "{outlet_group}"
285
- MIB: PowerNet-MIB
286
symbol:
287
OID: 1.3.6.1.4.1.318.1.1.25.1.2.1.6.0
288
name: uioSensorStatusTemperatureDegC
289
description: "The sensor's current temperature reading in tenths of degrees Celsius."
290
+ family: UPS/APC/Temperature
291
unit: "Cel/10"
292
metric_tags:
293
- tag: model
259
- OID: 1.3.6.1.4.1.318.1.1.1.1.1.1.0 # The UPS model name (e.g. 'APC Smart-UPS 600', 'Smart-UPS RT 6000 RM XL').
294
+ OID: 1.3.6.1.4.1.318.1.1.1.1.1.1.0 # The UPS model name (e.g. 'APC Smart-UPS 600', 'Smart-UPS RT 6000 RM XL').
295
symbol: upsBasicIdentModel
296
- tag: serial_num
297
OID: 1.3.6.1.4.1.318.1.1.1.1.2.3.0
263
- symbol: upsAdvIdentSerialNumber # An 8-character string identifying the serial number of
264
- # the UPS internal microprocessor. This number is set at
265
- # the factory. NOTE: This number does NOT correspond to
266
- # the serial number on the rear of the UPS.
298
+ symbol:
299
+ upsAdvIdentSerialNumber # An 8-character string identifying the serial number of
300
+ # the UPS internal microprocessor. This number is set at
301
+ # the factory. NOTE: This number does NOT correspond to
302
+ # the serial number on the rear of the UPS.
303
- tag: firmware_version
304
OID: 1.3.6.1.4.1.318.1.1.1.1.2.1.0
269
- symbol: upsAdvIdentFirmwareRevision # The firmware revision of the UPS system's microprocessor.
270
- # e.g. 452.17.W
271
- - OID: 1.3.6.1.4.1.318.1.1.1.1.1.2.0 # An 8 byte ID string identifying the UPS. This object can be set by the administrator.
272
- # e.g. UP001
305
+ symbol:
306
+ upsAdvIdentFirmwareRevision # The firmware revision of the UPS system's microprocessor.
307
+ # e.g. 452.17.W
308
+ - OID:
309
+ 1.3.6.1.4.1.318.1.1.1.1.1.2.0 # An 8 byte ID string identifying the UPS. This object can be set by the administrator.
310
+ # e.g. UP001
311
symbol: upsBasicIdentName
312
tag: ups_name