Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
unifi-poller(1)			 unifi-poller		       unifi-poller(1)

NAME
       unifi-poller - Utility to poll UniFi Controller Metrics and store them
       in InfluxDB

SYNOPSIS
       unifi-poller -c /etc/unifi-poller/up.conf

       This daemon polls a UniFi controller at a short interval	and stores the
       collected measurements in an Influx Database. The measurements and
       metrics collected belong	to every available site, device	and client
       found on	the controller.	Including UniFi	Security Gateways, Access
       Points, Switches	and possibly more.

       Dashboards for Grafana are available.  Find them	at <Grafana.com>.

DESCRIPTION
       UniFi Poller is a small Golang application that runs on Windows,	macOS,
       Linux or	Docker.	It polls a UniFi controller every 30 seconds for
       measurements and	stores the data	in an Influx database. See the example
       configuration file for more examples and	default	configurations.

       o See the example configuration file for	more examples and default
	 configurations.

OPTIONS
       unifi-poller [-c	<var>config-file</var>,[config-file]] [-j
       <var>filter</var>] [-h] [-v]

	   -c, --config	<var>config-file</var>,[config-file]
	       Provide a configuration file (instead of	the default). You may provide
	       multiple	file paths separated by	commas.	The first file found is	used.

	   -v, --version
	       Display version and exit.

	   -j, --dumpjson <var>filter</var>
	       This is a debug option; use this	when you are missing data in your graphs,
	       and/or you want to inspect the raw data coming from the controller. The
	       filter accepts three options: devices, clients, other. This will	print a
	       lot of information. Recommend piping it into a file and/or into jq for
	       better visualization. This requires a valid config file that contains
	       working authentication details for a UniFi Controller. This only	dumps
	       data for	sites listed in	the config file. The application exits after
	       printing	the JSON payload; it does not daemonize	or report to InfluxDB
	       with this option. The `other` option is special.	This allows you	request
	       any api path. It	must be	enclosed in quotes with	the word other.	Example:
		  unifi-poller -j "other /stat/admins"

	   -h, --help
	       Display usage and exit.

CONFIGURATION
       o Config	File Default Location:

       o Mac/BSD: /usr/local/etc/unifi-poller/up.conf
       o Windows: C:\ProgramData\unifi-poller\up.conf
       o Others:  /etc/unifi-poller/up.conf
       o Config	File Default Format: TOML
       o Possible formats: XML,	JSON, TOML, YAML

       The config file can be written in four different	syntax formats.	The
       application decides which one to	use based on the file's	name. If it
       contains	.xml it	will be	parsed as XML. The same	goes for .json and
       .yaml. If the filename contains none of these strings, then it is
       parsed as the default format, TOML. This	option is provided so the
       application can be easily adapted to any	environment.

       Config File Parameters

       Configuration file (up.conf) parameters are documented in the wiki.

       o <https://github.com/unifi-poller/unifi-poller/wiki/Configuration>

       Shell Environment Parameters

       This application	can be fully configured	using shell environment
       variables.  Find	documentation for this feature on the Docker Wiki
       page, and the above Configuration wiki.

       o <https://github.com/unifi-poller/unifi-poller/wiki/Docker>

GO DURATION
       This application	uses the Go Time Durations for a polling interval.
       The format is an	integer	followed by a time unit. You may append
       multiple	time units to add them together. A few valid time units	are:

	   ms	(millisecond)
	   s	(second)
	   m	(minute)

       Example Use: 35s, 1m, 1m30s

AUTHOR
       o Garrett Bjerkhoel (original code) ~ 2016
       o David Newhall II (rewritten) ~	4/20/2018
       o David Newhall II (still going)	~ 2/1/2020

LOCATION
       o UniFi Poller: <https://golift.io/unifi-poller/>
       o UniFi Library:	<https://github.com/unifi-poller/unifi>
       o Grafana Dashboards:
	 <https://grafana.com/dashboards?search=unifi-poller>

2.0.1							       unifi-poller(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | CONFIGURATION | GO DURATION | AUTHOR | LOCATION

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=unifi-poller&sektion=1&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help