Skip to content

Commit bc092da

Browse files
committed
Add documentation for plugin treshhold handling
Fixes #15
1 parent 2af9ad6 commit bc092da

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/10-Icinga-Plugins.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Icinga Plugins
22

3-
Below you will find a documentation for every single available plugin provided by this repository
3+
Below you will find a documentation for every single available plugin provided by this repository. Most of the plugins allow the usage of default Icinga threshold range handling, which is defined as follows:
4+
5+
| Argument | Throws error on | Ok range |
6+
| --- | --- | --- |
7+
| 20 | < 0 or > 20 | 0 .. 20 |
8+
| 20: | < 20 | between 20 .. ∞ |
9+
| ~:20 | > 20 | between -∞ .. 20 |
10+
| 30:40 | < 30 or > 40 | between {30 .. 40} |
11+
| `@30:40 | ≥ 30 and ≤ 40 | outside -∞ .. 29 and 41 .. ∞ |
12+
13+
Please ensure that you will escape the `@` if you are configuring it on the Icinga side. To do so, you will simply have to write an *\`* before the `@` symbol: \``@`
14+
15+
To test thresholds with different input values, you can use the Framework Cmdlet `Get-IcingaHelpThresholds`.
416

517
* [Invoke-IcingaCheckBiosSerial](plugins/01-Invoke-IcingaCheckBiosSerial.md)
618
* [Invoke-IcingaCheckCheckSum](plugins/02-Invoke-IcingaCheckCheckSum.md)

0 commit comments

Comments
 (0)