diff --git a/doc/reference/alerttypes.rst b/doc/reference/alerttypes.rst index bb3cbe0c8f..2f77fd945f 100644 --- a/doc/reference/alerttypes.rst +++ b/doc/reference/alerttypes.rst @@ -109,6 +109,17 @@ Tells us whether the load has passed a certain threshold. ------------------ Tells us whether a link is up or down. +.. list-table:: Alerts associated with linkState events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``linkUp`` + - Link active + * - ``linkDown`` + - Link inactive + @@ -154,6 +165,13 @@ Basic information --------------------- Notification event, typically between NAV systems +.. list-table:: Alerts associated with notification events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + @@ -161,6 +179,12 @@ Notification event, typically between NAV systems --------------------- Lifetime event for a device +.. list-table:: Alerts associated with deviceActive events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description @@ -176,13 +200,13 @@ Registers the state of a device * - Alert type name - Description * - ``deviceInIPOperation`` - - The device is now in operation with an active IP address. + - The device is now in operation with an active IP address * - ``deviceInStack`` - - The device is now in operation as a chassis module. + - The device is now in operation as a chassis module * - ``deviceRMA`` - RMA event for device. * - ``deviceNewModule`` - - The device has been found as a module. + - The device has been found as a module. * - ``deviceNewChassis`` - The device has been found as a chassis. * - ``deviceNewPsu`` @@ -192,6 +216,7 @@ Registers the state of a device + *deviceNotice* events --------------------- Registers a notice on a device @@ -360,3 +385,185 @@ The state of this BGP peering session changed +*juniperYellowAlarmState* events +-------------------------------- +Tells us if a Juniper device has any open yellow alarms. + +.. list-table:: Alerts associated with juniperYellowAlarmState events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``juniperYellowAlarmOn`` + - The Juniper device has some yellow alarms. + * - ``juniperYellowAlarmOff`` + - The Juniper device has no yellow alarms. + + + + +*juniperRedAlarmState* events +----------------------------- +Tells us if a Juniper device has any open red alarms. + +.. list-table:: Alerts associated with juniperRedAlarmState events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``juniperRedAlarmOn`` + - The Juniper device has some red alarms. + * - ``juniperRedAlarmOff`` + - The Juniper device has no red alarms. + + + + +*weathergoose_temperature* events +--------------------------------- + + +.. list-table:: Alerts associated with weathergoose_temperature events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``cmClimateTempCTRAP`` + - Climate Temperature Sensor Trap + * - ``cmClimateTempCCLEAR`` + - Climate Temperature Sensor Clear Trap + * - ``cmClimateTempCNOTIFY`` + - Climate Temperature Sensor Trap + * - ``cmTempSensorTempCNOTIFY`` + - Remote Temp Sensor - Temperature Trap + * - ``cmTempSensorTempCCLEAR`` + - Remote Temp Sensor - Temperature Clear Trap + * - ``gstClimateTempCNOTIFY`` + - Climate Temperature Sensor Trap + * - ``gstTempSensorTempCNOTIFY`` + - Remote Temp Sensor - Temperature Trap + * - ``gstClimateTempCCLEAR`` + - Climate Temperature Sensor Clear Trap + * - ``gstTempSensorTempCCLEAR`` + - Remote Temp Sensor - Temperature Clear Trap + + + + +*weathergoose_humidity* events +------------------------------ + + +.. list-table:: Alerts associated with weathergoose_humidity events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``cmClimateHumidityTRAP`` + - Climate Humidity Sensor Trap + * - ``cmClimateHumidityCLEAR`` + - Climate Humidity Sensor Clear Trap + * - ``cmClimateHumidityNOTIFY`` + - Climate Humidity Sensor Trap + * - ``gstClimateHumidityNOTIFY`` + - Climate Humidity Sensor Trap + * - ``gstClimateHumidityCLEAR`` + - Climate Humidity Sensor Clear Trap + + + + +*weathergoose_airflow* events +----------------------------- + + +.. list-table:: Alerts associated with weathergoose_airflow events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``cmClimateAirflowTRAP`` + - Climate Air Flow Sensor Trap + * - ``cmClimateAirflowCLEAR`` + - Climate Air Flow Sensor Clear Trap + * - ``cmClimateAirflowNOTIFY`` + - Climate Air Flow Sensor Trap + * - ``gstClimateAirflowNOTIFY`` + - Climate Air Flow Sensor Trap + * - ``gstClimateAirflowCLEAR`` + - Climate Air Flow Sensor Clear Trap + + + + +*weathergoose_light* events +--------------------------- + + +.. list-table:: Alerts associated with weathergoose_light events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``cmClimateLightTRAP`` + - Climate Light Sensor Trap + * - ``cmClimateLightCLEAR`` + - Climate Light Sensor Clear Trap + * - ``cmClimateLightNOTIFY`` + - Climate Light Sensor Trap + * - ``gstClimateLightNOTIFY`` + - Climate Light Sensor Trap + * - ``gstClimateLightCLEAR`` + - Climate Light Sensor Clear Trap + + + + +*weathergoose_sound* events +--------------------------- + + +.. list-table:: Alerts associated with weathergoose_sound events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``cmClimateSoundTRAP`` + - Climate Sound Sensor Trap + * - ``cmClimateSoundCLEAR`` + - Climate Sound Sensor Clear Trap + * - ``cmClimateSoundNOTIFY`` + - Climate Sound Sensor Trap + * - ``gstClimateSoundNOTIFY`` + - Climate Sound Sensor Trap + * - ``gstClimateSoundCLEAR`` + - Climate Sound Sensor Clear Trap + + + + +*upsPowerState* events +---------------------- +UPS running on battery or utility power + +.. list-table:: Alerts associated with upsPowerState events + :widths: 25 75 + :header-rows: 1 + + * - Alert type name + - Description + * - ``upsOnBatteryPower`` + - Ups running on battery power + * - ``upsOnUtilityPower`` + - Ups running on utility power + + + +