Skip to content

Unpoller

services.unpoller.enable

Whether to enable unpoller. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.db

Database name. Database should exist.

Type: string

Default

"unifi"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.disable

Whether to disable the influxdb output plugin.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.interval

Setting this lower than the Unifi controller's refresh interval may lead to zeroes in your database.

Type: string

Default

"30s"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.pass

Path of a file containing the password for influxdb. This file needs to be readable by the unifi-poller user.

Type: path

Default

unpoller-influxdb-default.password

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.url

URL of the influxdb host.

Type: string

Default

"http://127.0.0.1:8086"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.user

Username for the influxdb.

Type: string

Default

"unifipoller"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.influxdb.verify_ssl

Verify the influxdb's certificate.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.interval

How often the events are polled and pushed to Loki.

Type: string

Default

"2m"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.pass

Path of a file containing the password for Loki. This file needs to be readable by the unifi-poller user.

Type: path

Default

"unpoller-influxdb-default.password"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.tenant_id

Tenant ID to use in Loki.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.timeout

Should be increased in case of timeout errors.

Type: string

Default

"10s"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.url

URL of the Loki host.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.user

Username for Loki.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.loki.verify_ssl

Verify Loki's certificate.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.poller.debug

Turns on line numbers, microsecond logging, and a per-device log. This may be noisy if you have a lot of devices. It adds one line per device.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.poller.plugins

Load additional plugins.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.poller.quiet

Turns off per-interval logs. Only startup and error logs will be emitted.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.prometheus.disable

Whether to disable the prometheus output plugin.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.prometheus.http_listen

Bind the prometheus exporter to this IP or hostname.

Type: string

Default

"[::]:9130"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.prometheus.report_errors

Whether to report errors.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers

List of Unifi controllers to poll. Use defaults if empty.

Type: list of (submodule)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.hash_pii

Hash, with md5, client names and MAC addresses. This attempts to protect personally identifiable information.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.pass

Path of a file containing the password for the unifi service user. This file needs to be readable by the unifi-poller user.

Type: path

Default

unpoller-unifi-default.password

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.save_alarms

Collect and save data from UniFi alarms to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.save_anomalies

Collect and save data from UniFi anomalies to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.save_dpi

Collect and save data from deep packet inspection. Adds around 150 data points and impacts performance.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.save_events

Collect and save data from UniFi events to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.save_ids

Collect and save data from the intrusion detection system to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.save_sites

Collect and save site data.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.sites

List of site names for which statistics should be exported. Or the string "default" for the default site or the string "all" for all sites.

Type: one of "default", "all" or list of string

Default

"all"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.url

URL of the Unifi controller.

Type: string

Default

"https://unifi:8443"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.user

Unifi service user name.

Type: string

Default

"unifi"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.controllers.*.verify_ssl

Verify the Unifi controller's certificate.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.hash_pii

Hash, with md5, client names and MAC addresses. This attempts to protect personally identifiable information.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.pass

Path of a file containing the password for the unifi service user. This file needs to be readable by the unifi-poller user.

Type: path

Default

unpoller-unifi-default.password

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.save_alarms

Collect and save data from UniFi alarms to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.save_anomalies

Collect and save data from UniFi anomalies to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.save_dpi

Collect and save data from deep packet inspection. Adds around 150 data points and impacts performance.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.save_events

Collect and save data from UniFi events to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.save_ids

Collect and save data from the intrusion detection system to influxdb and Loki.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.save_sites

Collect and save site data.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.sites

List of site names for which statistics should be exported. Or the string "default" for the default site or the string "all" for all sites.

Type: one of "default", "all" or list of string

Default

"all"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.url

URL of the Unifi controller.

Type: string

Default

"https://unifi:8443"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.user

Unifi service user name.

Type: string

Default

"unifi"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.defaults.verify_ssl

Verify the Unifi controller's certificate.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix

services.unpoller.unifi.dynamic

Let prometheus select which controller to poll when scraping. Use with default credentials. See unifi-poller wiki for more.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/unpoller.nix