Skip to content

Commit 00a96e9

Browse files
Generate alert type docs from database
1 parent a4a1de4 commit 00a96e9

File tree

1 file changed

+210
-3
lines changed

1 file changed

+210
-3
lines changed

doc/reference/alerttypes.rst

Lines changed: 210 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,17 @@ Tells us whether the load has passed a certain threshold.
109109
------------------
110110
Tells us whether a link is up or down.
111111

112+
.. list-table:: Alerts associated with linkState events
113+
:widths: 25 75
114+
:header-rows: 1
115+
116+
* - Alert type name
117+
- Description
118+
* - ``linkUp``
119+
- Link active
120+
* - ``linkDown``
121+
- Link inactive
122+
112123

113124

114125

@@ -154,13 +165,26 @@ Basic information
154165
---------------------
155166
Notification event, typically between NAV systems
156167

168+
.. list-table:: Alerts associated with notification events
169+
:widths: 25 75
170+
:header-rows: 1
171+
172+
* - Alert type name
173+
- Description
174+
157175

158176

159177

160178
*deviceActive* events
161179
---------------------
162180
Lifetime event for a device
163181

182+
.. list-table:: Alerts associated with deviceActive events
183+
:widths: 25 75
184+
:header-rows: 1
185+
186+
* - Alert type name
187+
- Description
164188

165189

166190

@@ -176,13 +200,13 @@ Registers the state of a device
176200
* - Alert type name
177201
- Description
178202
* - ``deviceInIPOperation``
179-
- The device is now in operation with an active IP address.
203+
- The device is now in operation with an active IP address
180204
* - ``deviceInStack``
181-
- The device is now in operation as a chassis module.
205+
- The device is now in operation as a chassis module
182206
* - ``deviceRMA``
183207
- RMA event for device.
184208
* - ``deviceNewModule``
185-
- The device has been found as a module.
209+
- The device has been found as a module.
186210
* - ``deviceNewChassis``
187211
- The device has been found as a chassis.
188212
* - ``deviceNewPsu``
@@ -192,6 +216,7 @@ Registers the state of a device
192216

193217

194218

219+
195220
*deviceNotice* events
196221
---------------------
197222
Registers a notice on a device
@@ -360,3 +385,185 @@ The state of this BGP peering session changed
360385

361386

362387

388+
*juniperYellowAlarmState* events
389+
--------------------------------
390+
Tells us if a Juniper device has any open yellow alarms.
391+
392+
.. list-table:: Alerts associated with juniperYellowAlarmState events
393+
:widths: 25 75
394+
:header-rows: 1
395+
396+
* - Alert type name
397+
- Description
398+
* - ``juniperYellowAlarmOn``
399+
- The Juniper device has some yellow alarms.
400+
* - ``juniperYellowAlarmOff``
401+
- The Juniper device has no yellow alarms.
402+
403+
404+
405+
406+
*juniperRedAlarmState* events
407+
-----------------------------
408+
Tells us if a Juniper device has any open red alarms.
409+
410+
.. list-table:: Alerts associated with juniperRedAlarmState events
411+
:widths: 25 75
412+
:header-rows: 1
413+
414+
* - Alert type name
415+
- Description
416+
* - ``juniperRedAlarmOn``
417+
- The Juniper device has some red alarms.
418+
* - ``juniperRedAlarmOff``
419+
- The Juniper device has no red alarms.
420+
421+
422+
423+
424+
*weathergoose_temperature* events
425+
---------------------------------
426+
427+
428+
.. list-table:: Alerts associated with weathergoose_temperature events
429+
:widths: 25 75
430+
:header-rows: 1
431+
432+
* - Alert type name
433+
- Description
434+
* - ``cmClimateTempCTRAP``
435+
- Climate Temperature Sensor Trap
436+
* - ``cmClimateTempCCLEAR``
437+
- Climate Temperature Sensor Clear Trap
438+
* - ``cmClimateTempCNOTIFY``
439+
- Climate Temperature Sensor Trap
440+
* - ``cmTempSensorTempCNOTIFY``
441+
- Remote Temp Sensor - Temperature Trap
442+
* - ``cmTempSensorTempCCLEAR``
443+
- Remote Temp Sensor - Temperature Clear Trap
444+
* - ``gstClimateTempCNOTIFY``
445+
- Climate Temperature Sensor Trap
446+
* - ``gstTempSensorTempCNOTIFY``
447+
- Remote Temp Sensor - Temperature Trap
448+
* - ``gstClimateTempCCLEAR``
449+
- Climate Temperature Sensor Clear Trap
450+
* - ``gstTempSensorTempCCLEAR``
451+
- Remote Temp Sensor - Temperature Clear Trap
452+
453+
454+
455+
456+
*weathergoose_humidity* events
457+
------------------------------
458+
459+
460+
.. list-table:: Alerts associated with weathergoose_humidity events
461+
:widths: 25 75
462+
:header-rows: 1
463+
464+
* - Alert type name
465+
- Description
466+
* - ``cmClimateHumidityTRAP``
467+
- Climate Humidity Sensor Trap
468+
* - ``cmClimateHumidityCLEAR``
469+
- Climate Humidity Sensor Clear Trap
470+
* - ``cmClimateHumidityNOTIFY``
471+
- Climate Humidity Sensor Trap
472+
* - ``gstClimateHumidityNOTIFY``
473+
- Climate Humidity Sensor Trap
474+
* - ``gstClimateHumidityCLEAR``
475+
- Climate Humidity Sensor Clear Trap
476+
477+
478+
479+
480+
*weathergoose_airflow* events
481+
-----------------------------
482+
483+
484+
.. list-table:: Alerts associated with weathergoose_airflow events
485+
:widths: 25 75
486+
:header-rows: 1
487+
488+
* - Alert type name
489+
- Description
490+
* - ``cmClimateAirflowTRAP``
491+
- Climate Air Flow Sensor Trap
492+
* - ``cmClimateAirflowCLEAR``
493+
- Climate Air Flow Sensor Clear Trap
494+
* - ``cmClimateAirflowNOTIFY``
495+
- Climate Air Flow Sensor Trap
496+
* - ``gstClimateAirflowNOTIFY``
497+
- Climate Air Flow Sensor Trap
498+
* - ``gstClimateAirflowCLEAR``
499+
- Climate Air Flow Sensor Clear Trap
500+
501+
502+
503+
504+
*weathergoose_light* events
505+
---------------------------
506+
507+
508+
.. list-table:: Alerts associated with weathergoose_light events
509+
:widths: 25 75
510+
:header-rows: 1
511+
512+
* - Alert type name
513+
- Description
514+
* - ``cmClimateLightTRAP``
515+
- Climate Light Sensor Trap
516+
* - ``cmClimateLightCLEAR``
517+
- Climate Light Sensor Clear Trap
518+
* - ``cmClimateLightNOTIFY``
519+
- Climate Light Sensor Trap
520+
* - ``gstClimateLightNOTIFY``
521+
- Climate Light Sensor Trap
522+
* - ``gstClimateLightCLEAR``
523+
- Climate Light Sensor Clear Trap
524+
525+
526+
527+
528+
*weathergoose_sound* events
529+
---------------------------
530+
531+
532+
.. list-table:: Alerts associated with weathergoose_sound events
533+
:widths: 25 75
534+
:header-rows: 1
535+
536+
* - Alert type name
537+
- Description
538+
* - ``cmClimateSoundTRAP``
539+
- Climate Sound Sensor Trap
540+
* - ``cmClimateSoundCLEAR``
541+
- Climate Sound Sensor Clear Trap
542+
* - ``cmClimateSoundNOTIFY``
543+
- Climate Sound Sensor Trap
544+
* - ``gstClimateSoundNOTIFY``
545+
- Climate Sound Sensor Trap
546+
* - ``gstClimateSoundCLEAR``
547+
- Climate Sound Sensor Clear Trap
548+
549+
550+
551+
552+
*upsPowerState* events
553+
----------------------
554+
UPS running on battery or utility power
555+
556+
.. list-table:: Alerts associated with upsPowerState events
557+
:widths: 25 75
558+
:header-rows: 1
559+
560+
* - Alert type name
561+
- Description
562+
* - ``upsOnBatteryPower``
563+
- Ups running on battery power
564+
* - ``upsOnUtilityPower``
565+
- Ups running on utility power
566+
567+
568+
569+

0 commit comments

Comments
 (0)