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

host string Required

Your Zabbix server.

path string (Optional, default: /zabbix/)

Path to your Zabbix install.

ssl boolean (Optional, default: false)

Set to true if your Zabbix installation is using SSL.

username string (Optional)

Your Zabbix username.

password string (Optional)

Your Zabbix password.

publish_states_host string (Optional)

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).

exclude list (Optional)

Configure which integrations should be excluded from being published to Zabbix. (Configure Filter)

entities string | list (Optional)

The list of entity ids to be excluded from being published to Zabbix.

entity_globs string | list (Optional)

Exclude all entities matching a listed pattern.

domains string | list (Optional)

The list of domains to be excluded from being published to Zabbix.

include list (Optional)

Configure which integrations should be included in being published to Zabbix. If set, all other entities will not be published to Zabbix. (Configure Filter)

entities string | list (Optional)

The list of entity ids to be included in being published to Zabbix.

entity_globs string | list (Optional)

Include all entities matching a listed pattern.

domains string | list (Optional)

The list of domains to be included in being published to Zabbix.

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:

  1. No includes or excludes - pass all entities
  2. Includes, no excludes - only include specified entities
  3. Excludes, no includes - only exclude specified entities
  4. Both includes and excludes:
    • Include domain and/or glob patterns specified
      • If domain is included, and entity not excluded or match exclude glob pattern, pass
      • If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
      • If domain is not included, glob pattern does not match, and entity not included, fail
    • Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
      • If domain is excluded and entity not included, fail
      • If entity matches exclude glob pattern and entity not included, fail
      • If entity does not match any exclude criteria (domain, glob pattern or listed), pass
    • Neither include or exclude specifies domains or glob patterns
      • If entity is included, pass (as #2 above)
      • If entity include and exclude, the entity exclude is ignored

Sensor

The zabbix sensor platform let you monitor the current count of active triggers for your Zabbix monitoring instance.

You must have the Zabbix component configured to use those sensors.

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

triggers string Required

Specifies that this sensor is for Zabbix ‘triggers’. In the future there will be other Zabbix sensors.

name string (Optional)

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.

hostids string (Optional)

This is a list of Zabbix hostids that we want to filter our count on.

individual boolean (Optional, default: false)

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).