Skip to content

Commit d660067

Browse files
committed
Updates plugin documentation
1 parent 162c3df commit d660067

12 files changed

+27
-300
lines changed

doc/plugins/07-Invoke-IcingaCheckMemory.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ More Information on https://github.com/Icinga/icinga-powershell-plugins
1414

1515
| Argument | Type | Required | Default | Description |
1616
| --- | --- | --- | --- | --- |
17-
| CriticalBytes | String | false | | Used to specify a Critical threshold. In this case an string value. The string has to be like, "20B", "20KB", "20MB", "20GB", "20TB", "20TB" |
18-
| WarningBytes | String | false | | Used to specify a Warning threshold. In this case an string value. The string has to be like, "20B", "20KB", "20MB", "20GB", "20TB", "20TB" |
17+
| Critical | String | false | | Used to specify a Critical threshold. In this case an string value. The string has to be like, "20B", "20KB", "20MB", "20GB", "20TB", "20PB" |
18+
| Warning | String | false | | Used to specify a Warning threshold. In this case an string value. The string has to be like, "20B", "20KB", "20MB", "20GB", "20TB", "20PB" |
1919
| CriticalPercent | Object | false | | Used to specify a Critical threshold. In this case an integer value. Like 30 for 30%. If memory usage is below 30%, the check will return CRITICAL. |
2020
| WarningPercent | Object | false | | |
21-
| Verbosity | Int32 | false | 0 | [switch]$PageFile, |
21+
| Verbosity | Int32 | false | 0 | |
2222
| NoPerfData | SwitchParameter | false | False | |
2323

2424
## Examples
@@ -38,11 +38,11 @@ Invoke-IcingaCheckMemory -Verbosity 3 -Warning 60 -Critical 80
3838
### Example Command 2
3939

4040
```powershell
41-
41+
Invoke-IcingaCheckMemory -WarningPercent 30 -CriticalPercent 50
4242
```
4343

4444
### Example Output 2
4545

4646
```powershell
47-
47+
[WARNING] Check package "Memory Usage" - [WARNING] Memory Percent Used\_ [WARNING] Memory Percent Used: Value "48.07%" is greater than threshold "30%"| 'memory_percent_used'=48.07%;0:30;0:50;0;100 'used_bytes'=3.85GB;;;0;81
4848
```

doc/plugins/08-Invoke-IcingaCheckPerfcounter.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

doc/plugins/09-Invoke-IcingaCheckProcessCount.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

doc/plugins/10-Invoke-IcingaCheckService.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

doc/plugins/11-Invoke-IcingaCheckUpdates.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

doc/plugins/12-Invoke-IcingaCheckUptime.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

doc/plugins/13-Invoke-IcingaCheckUptime.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,15 @@ Invoke-IcingaCheckUptime -Warning 18d -Critical 20d
3131
```powershell
3232
[WARNING]: Check package "Windows Uptime: Days: 19 Hours: 13 Minutes: 48 Seconds: 29" is [WARNING]| 'Windows Uptime'=1691309,539176s;1555200;1728000
3333
```
34+
35+
### Example Command 2
36+
37+
```powershell
38+
Invoke-IcingaCheckUptime -Warning 25d:
39+
```
40+
41+
### Example Output 2
42+
43+
```powershell
44+
[WARNING] Check package "System Uptime: 22d 16h 42m 35s" - [WARNING] System Uptime\_ [WARNING] System Uptime: Value "1960955.28s" is lower than threshold "2160000s"| 'system_uptime'=1960955.28s;2160000:;1
45+
```

doc/plugins/13-Invoke-IcingaCheckUsedPartitionSpace.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

doc/plugins/14-Invoke-IcingaCheckUsedPartitionSpace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ More Information on https://github.com/Icinga/icinga-powershell-plugins
1515
| --- | --- | --- | --- | --- |
1616
| Warning | Object | false | | Used to specify a Warning threshold. In this case an integer value. |
1717
| Critical | Object | false | | Used to specify a Critical threshold. In this case an integer value. |
18-
| Include | Array | false | @() | Used to specify an array of partitions to be included. e.g. 'C:\','D:\' |
18+
| Include | Array | false | @() | Used to specify an array of partitions to be included. If not set, the check expects that all not excluded partitions should be checked. e.g. 'C:\','D:\' |
1919
| Exclude | Array | false | @() | Used to specify an array of partitions to be excluded. e.g. 'C:\','D:\' |
2020
| NoPerfData | SwitchParameter | false | False | |
2121
| Verbosity | Int32 | false | 0 | |

doc/plugins/14-Invoke-IcingaCheckUsers.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)