Zabbix
The zabbix
integration is the main integration to connect to a Zabbix monitoring instance via the Zabbix API.
It is possible to publish Home Assistant state changes to Zabbix. In Zabbix a host has to be created which will contain the Home Assistant states as individual items. These items are automatically created using Zabbix Low-Level Discovery (LLD). In order to make setup in Zabbix easy, you can use this template for the host.
There is currently also support for the following device types within Home Assistant:
Configuration
To set the Zabbix integration up, add the following information to your configuration.yaml
file:
# Example configuration.yaml entry
zabbix:
host: IP_ADDRESS
Configuration Variables
The host that will receive the state changes from Home Assistant. It needs to be manually created in Zabbix first and have the template associated with it (see above).
Configure which integrations should be excluded from being published to Zabbix. (Configure Filter)
Configure which integrations should be included in being published to Zabbix. If set, all other entities will not be published to Zabbix. (Configure Filter)
Full configuration
# Example configuration.yaml entry
zabbix:
host: ZABBIX_HOST
path: ZABBIX_PATH
ssl: false
username: USERNAME
password: PASSWORD
publish_states_host: homeassistant
exclude:
domains:
- device_tracker
entities:
- sun.sun
- sensor.time
Configure Filter
By default, no entity will be excluded. To limit which entities are being published to Zabbix, you can use the include
and exclude
parameters.
# Example filter to include specified domains and exclude specified entities
zabbix:
include:
domains:
- alarm_control_panel
- light
entity_globs:
- binary_sensor.*_occupancy
exclude:
entities:
- light.kitchen_light
Filters are applied as follows:
- No filter
- All entities included
- Only includes
- Entity listed in entities include: include
- Otherwise, entity matches domain include: include
- Otherwise, entity matches glob include: include
- Otherwise: exclude
- Only excludes
- Entity listed in exclude: exclude
- Otherwise, entity matches domain exclude: exclude
- Otherwise, entity matches glob exclude: exclude
- Otherwise: include
- Domain and/or glob includes (may also have excludes)
- Entity listed in entities include: include
- Otherwise, entity listed in entities exclude: exclude
- Otherwise, entity matches glob include: include
- Otherwise, entity matches glob exclude: exclude
- Otherwise, entity matches domain include: include
- Otherwise: exclude
- Domain and/or glob excludes (no domain and/or glob includes)
- Entity listed in entities include: include
- Otherwise, entity listed in exclude: exclude
- Otherwise, entity matches glob exclude: exclude
- Otherwise, entity matches domain exclude: exclude
- Otherwise: include
- No Domain and/or glob includes or excludes
- Entity listed in entities include: include
- Otherwise: exclude
The following characters can be used in entity globs:
*
- The asterisk represents zero, one, or multiple characters
?
- The question mark represents a single character
Sensor
The zabbix
sensor platform let you monitor the current count of active triggers for your Zabbix monitoring instance.
To set it up, add the following information to your configuration.yaml
file:
# Example configuration.yaml entry
sensor:
- platform: zabbix
triggers:
name: Important Hosts Trigger Count
hostids: [10051,10081,10084]
individual: true
Configuration Variables
Specifies that this sensor is for Zabbix ‘triggers’. In the future there will be other Zabbix sensors.
Allows you to specify the name for the Sensor, otherwise the host name, as stored in Zabbix, is used. This is useful when you are specifying a list of hostids to monitor as a single count.
A ‘true’/‘false’ to specify whether we should show individual sensors when a list of hostids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn’t provided).