From 83bbd6c3148d3cb1e34afaf2b4532dc2980f9cbc Mon Sep 17 00:00:00 2001 From: Steve Jenkins Date: Mon, 9 Jan 2017 22:37:42 -0700 Subject: [PATCH] Create README.md --- nagios/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 nagios/README.md diff --git a/nagios/README.md b/nagios/README.md new file mode 100644 index 0000000..17e6c8c --- /dev/null +++ b/nagios/README.md @@ -0,0 +1,47 @@ +check_unifi +=========== + +Nagios plugin to check the UniFi Controller for AP status. + +Install +------- +The UniFi API pip module is required: + + sudo pip install -U unifi + +Copy check_unifi into your plugins directory. + +Usage +----- +``` +usage: check_unifi [-h] [-H HOSTNAME] [-u USERNAME] [-p PASSWORD] [-b PORT] + [-v VERSION] [-s SITEID] [-w WARNING] [-c CRITICAL] [-a AP] + +optional arguments: + -h, --help show this help message and exit + -H HOSTNAME, --hostname HOSTNAME + the controller address (default "unifi") + -u USERNAME, --username USERNAME + the controller username (default("admin") + -p PASSWORD, --password PASSWORD + the controller password + -b PORT, --port PORT the controller port (default "8443") + -v VERSION, --version VERSION + the controller base version (default "v2") + -s SITEID, --siteid SITEID + the site ID, UniFi >=3.x only (default "default") + -w WARNING, --warning WARNING + amount of APs to be down for WARNING (default: none) + -c CRITICAL, --critical CRITICAL + amount of APs to be down for CRITICAL (default: none) + -a AP, --ap AP name of AP to get status of (default: overall check) +``` + +License +------- +This project is licensed under the terms of the MIT license. + +Credits +------- +Current version by Michael Sweetser (https://github.com/msweetser/check_unifi) +Based on Michel Greijmans' original UniFi WiFi Nagios Monitoring Plugin, available at: https://community.ubnt.com/t5/UniFi-Wireless/UniFi-WiFi-Nagios-Monitoring-Plugin/td-p/1092503