Skip to content

Commit d9efd1d

Browse files
author
Markus Opolka
authored
Merge pull request #91 from drewkerrigan/chore/readme
Update README
2 parents 6b51e1b + e72030a commit d9efd1d

File tree

1 file changed

+32
-48
lines changed

1 file changed

+32
-48
lines changed

‎README.md‎

Lines changed: 32 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ that service.
4040
4141
Version: 2.2.0 (2024-05-14)
4242
43-
optional arguments:
43+
options:
4444
-h, --help show this help message and exit
4545
-d, --debug debug mode
46+
-v, --verbose Verbose mode. Multiple -v options increase the verbosity
4647
-s, --ssl use TLS to connect to remote host
4748
-H HOST, --host HOST remote host to query
4849
-k, --insecure do not check server SSL certificate
@@ -56,61 +57,44 @@ optional arguments:
5657
-p PATH, --path PATH Path
5758
-t TIMEOUT, --timeout TIMEOUT
5859
Connection timeout (seconds)
60+
--unreachable-state UNREACHABLE_STATE
61+
Exit with specified code if URL unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)
5962
-B AUTH, --basic-auth AUTH
6063
Basic auth string "username:password"
6164
-D DATA, --data DATA The http payload to send as a POST
6265
-A HEADERS, --headers HEADERS
6366
The http headers in JSON format.
6467
-f SEPARATOR, --field_separator SEPARATOR
65-
JSON Field separator, defaults to "."; Select element
66-
in an array with "(" ")"
67-
-F SEPARATOR, --value_separator SEPARATOR
68-
JSON Value separator, defaults to ":";
69-
-w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]], --warning [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]
70-
Warning threshold for these values
71-
(key1[>alias],WarnRange key2[>alias],WarnRange).
72-
WarnRange is in the format [@]start:end, more
73-
information at nagios-plugins.org/doc/guidelines.html.
74-
-c [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]], --critical [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]]
75-
Critical threshold for these values
76-
(key1[>alias],CriticalRange
77-
key2[>alias],CriticalRange. CriticalRange is in the
78-
format [@]start:end, more information at nagios-
79-
plugins.org/doc/guidelines.html.
80-
-e [KEY_LIST [KEY_LIST ...]], --key_exists [KEY_LIST [KEY_LIST ...]]
81-
Checks existence of these keys to determine status.
82-
Return warning if key is not present.
83-
-E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]], --key_exists_critical [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]
68+
JSON Field separator, defaults to "."; Select element in an array with "(" ")"
69+
-F VALUE_SEPARATOR, --value_separator VALUE_SEPARATOR
70+
JSON Value separator, defaults to ":"
71+
-w [KEY_THRESHOLD_WARNING ...], --warning [KEY_THRESHOLD_WARNING ...]
72+
Warning threshold for these values (key1[>alias],WarnRange key2[>alias],WarnRange). WarnRange is in the format
73+
[@]start:end, more information at nagios-plugins.org/doc/guidelines.html.
74+
-c [KEY_THRESHOLD_CRITICAL ...], --critical [KEY_THRESHOLD_CRITICAL ...]
75+
Critical threshold for these values (key1[>alias],CriticalRange key2[>alias],CriticalRange. CriticalRange is in
76+
the format [@]start:end, more information at nagios-plugins.org/doc/guidelines.html.
77+
-e [KEY_LIST ...], --key_exists [KEY_LIST ...]
78+
Checks existence of these keys to determine status. Return warning if key is not present.
79+
-E [KEY_LIST_CRITICAL ...], --key_exists_critical [KEY_LIST_CRITICAL ...]
8480
Same as -e but return critical if key is not present.
85-
-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]], --key_equals [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]
86-
Checks equality of these keys and values
87-
(key[>alias],value key2,value2) to determine status.
88-
Multiple key values can be delimited with colon
89-
(key,value1:value2). Return warning if equality check
90-
fails
91-
-Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]], --key_equals_critical [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]
92-
Same as -q but return critical if equality check
93-
fails.
94-
-u [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]], --key_equals_unknown [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]]
81+
-q [KEY_VALUE_LIST ...], --key_equals [KEY_VALUE_LIST ...]
82+
Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values
83+
can be delimited with colon (key,value1:value2). Return warning if equality check fails
84+
-Q [KEY_VALUE_LIST_CRITICAL ...], --key_equals_critical [KEY_VALUE_LIST_CRITICAL ...]
85+
Same as -q but return critical if equality check fails.
86+
-u [KEY_VALUE_LIST_UNKNOWN ...], --key_equals_unknown [KEY_VALUE_LIST_UNKNOWN ...]
9587
Same as -q but return unknown if equality check fails.
96-
-y [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]], --key_not_equals [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]]
97-
Checks equality of these keys and values
98-
(key[>alias],value key2,value2) to determine status.
99-
Multiple key values can be delimited with colon
100-
(key,value1:value2). Return warning if equality check
101-
succeeds
102-
-Y [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]], --key_not_equals_critical [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]]
103-
Same as -q but return critical if equality check
104-
succeeds.
105-
-m [METRIC_LIST [METRIC_LIST ...]], --key_metric [METRIC_LIST [METRIC_LIST ...]]
106-
Gathers the values of these keys (key[>alias],
107-
UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for
108-
Nagios performance data. More information about Range
109-
format and units of measure for nagios can be found at
110-
nagios-plugins.org/doc/guidelines.html Additional
111-
formats for this parameter are: (key[>alias]),
112-
(key[>alias],UnitOfMeasure),
113-
(key[>alias],UnitOfMeasure,WarnRange, CriticalRange).
88+
-y [KEY_VALUE_LIST_NOT ...], --key_not_equals [KEY_VALUE_LIST_NOT ...]
89+
Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values
90+
can be delimited with colon (key,value1:value2). Return warning if equality check succeeds
91+
-Y [KEY_VALUE_LIST_NOT_CRITICAL ...], --key_not_equals_critical [KEY_VALUE_LIST_NOT_CRITICAL ...]
92+
Same as -q but return critical if equality check succeeds.
93+
-m [METRIC_LIST ...], --key_metric [METRIC_LIST ...]
94+
Gathers the values of these keys (key[>alias], UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for Nagios
95+
performance data. More information about Range format and units of measure for nagios can be found at nagios-
96+
plugins.org/doc/guidelines.html Additional formats for this parameter are: (key[>alias]),
97+
(key[>alias],UnitOfMeasure), (key[>alias],UnitOfMeasure,WarnRange, CriticalRange).
11498
```
11599

116100
## Examples

0 commit comments

Comments
 (0)