Merge pull request #6 from VGavara/feature-add-check_ups-doc

Add README files to check_ups_*

src/check_ups/check_ups_battery_values/README.md

@@ -0,0 +1,21 @@
+# check_ups_battery_values
+
+Checks the battery values (voltage, current and temperature) on a RFC1628 (UPS-MIB) SNMP compliant device.
+
+# Usage
+
+    check_ups_battery_values -H <hostname>
+        -w [<voltage range>],[<current range>],[<temperature range>]
+        -c [<voltage range>],[<current range>],[<temperature range>]
+        [-C <SNMP Community>] [-e <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]
+        [-V <version>]
+
+Type Type `check_ups_battery_values --help` to get more info.
+
+# Examples
+
+## check_ups_battery_values -H 192.168.0.101 -w 210:240,,,\~:40 -c 200:250,,\~:50
+
+Checks the voltage, current and temperature battery value levels of a UPS-MIB SNMP compliant device with IP address 192.168.0.101.
+
+The plugin returns WARNING if voltage is out of  210 to 240 volts range or the temperature battery value exceeds 40 Celsius degrees, and returns CRITICAL if voltage is out of 200 to 250 volts range or temperature exceeds 50 Celsius degrees.

src/check_ups/check_ups_inputs/README.md

@@ -0,0 +1,22 @@
+# check_ups_inputs
+
+Checks the input levels (frequency, voltage, current and/or power) on a RFC1628 (UPS-MIB) SNMP compliant device.
+
+# Usage
+
+    check_up_inputs -H <hostname>
+        -w [<frequency range>],[<voltage range>],[<current range>],[<power range>]
+        -c [<frequency range>],[<voltage range>],[<current range>],[<power range>]
+        [-i <input list>]
+        [-C <SNMP Community>] [-E <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]
+        [-V <version>]
+
+Type Type `check_ups_inputs --help` to get more info.
+
+# Examples
+
+## check_ups_inputs -H 192.168.0.101 -i 1,2,3 -w ,210:240,,\~:3000 -c ,200:250,,\~:4000
+
+Checks the 1 to 3 input levels of a UPS-MIB SNMP compliant device with IP address 192.168.0.101.
+
+Plugin returns WARNING if voltage is out of  210 to 240 volts range or the output power exceeds 3000W, and returns CRITICAL if voltage is out of 200 to 250 volts range or power exceeds 4000W.

src/check_ups/check_ups_inputs.pl → src/check_ups/check_ups_inputs/check_ups_inputs.pl

@@ -42,7 +42,7 @@
   . "\t\t[-C <SNMP Community>] [-E <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]\n"
   . "\t\t[-V <version>]\n";
 use constant BLURB =>
-  "Checks the input levels (frequency, voltage, current and/or power )\n"
+  "Checks the input levels (frequency, voltage, current and/or power)\n"
   . "on a RFC1628 (UPS-MIB) SNMP compliant device";
 use constant LICENSE =>
   "This check plugin is free software, and comes with ABSOLUTELY NO WARRANTY\n"

src/check_ups/check_ups_mode/README.md

@@ -0,0 +1,21 @@
+# check_ups_mode
+
+Checks the working mode (online/bypass/offline with batt. normal, low or depleted) of a RFC1628 (UPS-MIB) SNMP compliant device, returning autonomy values as performance data.
+
+# Usage
+
+    check_ups_mode -H <hostname>
+        -w [<mode id>, <mode id>,...]
+        -c [<mode id>, <mode id>, ...]
+        [-l <battery low level threshold> [-d <battery depleted level threshold>]
+        [-C <SNMP Community>] [-E <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]
+        [-V <version>]
+
+Type `check_ups_mode --help` to get more info.
+
+# Examples
+
+## check_ups_mode -H 192.168.0.1 -w 2,5 -c 3,4
+It checks the working mode of a UPS-MIB SNMP compliant device with IP address 192.168.0.1, SNMP protocol 2 and real community 'public'.
+
+The plugin returns WARNING if it is working offline and its battery level is NOT low (Offline=2) or it is in bypass mode (bypass=5), or it returns CRITICAL if it is working offline and its battery level is low (Offline battery low = 3) or battery is depleted (Offline battery depleted = 4).

src/check_ups/check_ups_outputs/README.md

@@ -0,0 +1,24 @@
+# check_ups_outputs
+
+Checks the output levels (voltage, current, power and/or load percent) on a RFC1628 (UPS-MIB) SNMP compliant device.
+
+# Usage
+
+    check_up_outputs -H <hostname>
+        -w [<voltage range>],[<current range>],[<power range>],[<load range>]
+        -c [<voltage range>],[<current range>],[<power range>],[<load range>]
+        [-o <output list>]
+        [-p <UPS power rating>]
+        [-C <SNMP Community>] [-E <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]
+        [-V <version>]
+        [-f]
+
+Type Type `check_ups_outputs --help` to get more info.
+
+# Examples
+
+## check_ups_outputs -H 192.168.0.101 -o 1,2,3 -w 210:240,,,\~:70 -c 200:250,,,\~:90
+
+Checks the 1 to 3 output levels of a UPS-MIB SNMP compliant device with IP address 192.168.0.101.
+
+Plugin returns WARNING if voltage is out of  210 to 240 volts range or the output load exceeds 70%, and returns CRITICAL if voltage is out of 200 to 250 volts range or load exceeds 90%.