Skip to content

Commit

Permalink
Update README with new help text.
Browse files Browse the repository at this point in the history
  • Loading branch information
johanthoren committed Mar 6, 2024
1 parent 4b2e4cb commit f94e9de
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,34 @@
# check_macos_updates

A Nagios compatible plugin to check if macOS system updates are available.

``` sh
$ check_macos_updates -h
A Nagios compatible plugin that checks for available MacOS updates.

Thresholds are defined using Nagios range syntax. Examples:
+------------------+-------------------------------------------------+
| Range definition | Generate an alert if x... |
+------------------+-------------------------------------------------+
| 10 | < 0 or > 10, (outside the range of {0 .. 10}) |
+------------------+-------------------------------------------------+
| 10: | < 10, (outside {10 .. ∞}) |
+------------------+-------------------------------------------------+
| ~:10 | > 10, (outside the range of {-∞ .. 10}) |
+------------------+-------------------------------------------------+
| 10:20 | < 10 or > 20, (outside the range of {10 .. 20}) |
+------------------+-------------------------------------------------+
| @10:20 | ≥ 10 and ≤ 20, (inside the range of {10 .. 20}) |
+------------------+-------------------------------------------------+


Usage: check_macos_updates [OPTIONS]

Options:
-f, --force-manual Force manual check with `softwareupdate -l` (slow)
-w, --warning <WARNING> Warning limit for number of updates available [default: 0]
-c, --critical <CRITICAL> Critical limit for number of updates available
-h, --help Print help
-V, --version Print version

```
Use together with nrpe or similar, preferably with [Opsview](https://www.itrsgroup.com/products/infrastructure-monitoring).
Use together with NRPE or similar, preferably with [Opsview](https://www.itrsgroup.com/products/infrastructure-monitoring).

0 comments on commit f94e9de

Please sign in to comment.