check_home_assistant_state/README.md

Check Home Assistant State

A check plugin for Nagios/Icinga/etc. that queries Home Assistant for the current state of entities.

Requirements

• Python >= 3.8
• requests
• nagiosplugin

Usage

You will need a token for Home Assistant's REST API. Instructions to aquire one can be found here.

At a minimum, you need to specify the token, home assistant url, a device class to filter by, and warning/critical ranges. Example:

./check_home_assistant_state.py --token $HASS_TOKEN --url $HASS_URL --device-class battery --warning 20:100 --critical 10:100

See --help for more features/arguments.

A CheckCommand config for Icinga2 can be generated with --make-icinga-conf.