Skip to content

Commit 83c9d60

Browse files
authored
Add skeleton/first draft for developerguide: check package
1 parent 5859ff0 commit 83c9d60

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Developer Guide: New-IcingaCheckPackage
2+
3+
Below you will find a list of functions and detailed descriptions including use cases for Cmdlets and features the PowerShell Framework provides.
4+
5+
| Type | Return Value | Description |
6+
| --- | --- | --- |
7+
| Cmdlet | PowerShell Object | Check Object containing other check objects |
8+
9+
The `IcingaCheckPackage` is the first step to take to write more advanced checks. A `IcingaCheckPackage` offers the possibility to build a check containing varius `IcingaChecks`. Just like the `IcingaCheck`, the `IcingaCheckPackage` also provides a bunch of internal commands within the PowerShell Object to analyse a value and get the Icinga result `Ok`, `Warning`, `Critical` including performance metrics. In this case the result is based on the result of the logical connection between added `IcingaChecks` within the `IcingaCheckPackage`
10+
11+
It will be used like in this example:
12+
13+
14+
```powershell
15+
$IcingaPackage = New-IcingaCheckPackage -Name 'My Package' -OperatorAnd;
16+
```
17+
18+
## Arguments
19+
20+
| Argument | Input | Mandatory | Description |
21+
| --- | --- | --- | --- |
22+
| Name | String | * | The unique name of each package within a plugin. Will be displayed in the check output. |
23+
| OperatorAnd | Switch | | Logical relation of the check within the package becomes an AND |
24+
| OperatorOr | Switch | | Logical relation of the check within the package becomes an Or |
25+
| OperatorNone | Switch | | - |
26+
| OperatorMin | Int | | - |
27+
| OperatorMax | Int | | - |
28+
| Checks | Array | | Array of checks to be added to the check package |
29+
| Verbose | int | | Defines the level of output detail from 0 lowest to 3 highest detail |
30+
| Hidden | Switch | | If set, the check package doesn't generate output |

0 commit comments

Comments
 (0)