Skip to content

Commit 88eb859

Browse files
authored
Merge pull request #11 from Icinga/documentation
Fix documentation
2 parents 582f05f + e315f9f commit 88eb859

File tree

4 files changed

+24
-8
lines changed

4 files changed

+24
-8
lines changed

plugins/Invoke-IcingaCheckMemory.psm1

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@
1313
PS>Invoke-IcingaCheckMemory -Verbosity 3 -Warning 60 -Critical 80
1414
[WARNING]: % Memory Check 78.74 is greater than 60
1515
.EXAMPLE
16-
PS>
16+
PS> Invoke-IcingaCheckMemory -WarningPercent 0:30 -CriticalPercent 0:50
17+
[WARNING] Check package "Memory Usage" - [WARNING] Memory Percent Used
18+
\_ [WARNING] Memory Percent Used: Value "48.07%" is greater than threshold "30%"
19+
| 'memory_percent_used'=48.07%;0:30;0:50;0;100 'used_bytes'=3.85GB;;;0;8
20+
1
1721
.PARAMETER Warning
1822
Used to specify a Warning threshold. In this case an string value.
1923

plugins/Invoke-IcingaCheckUptime.psm1

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
PS> Invoke-IcingaCheckUptime -Warning 18d -Critical 20d
1313
[WARNING]: Check package "Windows Uptime: Days: 19 Hours: 13 Minutes: 48 Seconds: 29" is [WARNING]
1414
| 'Windows Uptime'=1691309,539176s;1555200;1728000
15+
.EXAMPLE
16+
PS> Invoke-IcingaCheckUptime -Warning 25d:
17+
[WARNING] Check package "System Uptime: 22d 16h 42m 35s" - [WARNING] System Uptime
18+
\_ [WARNING] System Uptime: Value "1960955.28s" is lower than threshold "2160000s"
19+
| 'system_uptime'=1960955.28s;2160000:;
20+
1
1521
.PARAMETER Warning
1622
Used to specify a Warning threshold. In this case a string.
1723
Allowed units include: ms, s, m, h, d, w, M, y

plugins/Invoke-IcingaCheckUsedPartitionSpace.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
Used to specify an array of partitions to be excluded.
2929
e.g. 'C:\','D:\'
3030
.PARAMETER Include
31-
Used to specify an array of partitions to be included.
31+
Used to specify an array of partitions to be included. If not set, the check expects that all not excluded partitions should be checked.
3232
e.g. 'C:\','D:\'
3333
.INPUTS
3434
System.String

plugins/Invoke-IcingaCheckUsers.psm1

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
<#
22
.SYNOPSIS
3-
Checks how many files are in a directory.
3+
Checks how many users are logged on to the host
44
.DESCRIPTION
5-
Invoke-IcingaCheckDirectory returns either 'OK', 'WARNING' or 'CRITICAL', based on the thresholds set.
6-
e.g 'C:\Users\Icinga\Backup' contains 200 files, WARNING is set to 150, CRITICAL is set to 300. In this case the check will return CRITICAL
5+
Invoke-IcingaCheckUsers returns either 'OK', 'WARNING' or 'CRITICAL', based on the thresholds set.
6+
e.g There are 13 users logged on, WARNING is set to 8, CRITICAL is set to 15. In this case the check will return WARNING.
77
More Information on https://github.com/Icinga/icinga-powershell-plugins
88
.FUNCTIONALITY
9-
This module is intended to be used to check how many files and directories are within are specified path.
9+
This module is intended to check how many users are loged onto a host.
1010
Based on the thresholds set the status will change between 'OK', 'WARNING' or 'CRITICAL'. The function will return one of these given codes.
1111
1212
.EXAMPLE
13-
PS>
13+
PS> Invoke-IcingaCheckUsers -Warning 8 -Critical 15
14+
[WARNING] Check package "Users" - [WARNING] Logged On Users
15+
\_ [WARNING] Logged On Users: Value "13" is greater than threshold "8"
16+
| 'logged_on_users'=13;8;15 'logged_on_users_test'=5;; 'logged_on_users_umfd0'=1;; 'logged_on_users_dwm1'=2;; 'logged_on_users_system'=1;; 'logged_on_users_dwm2'=2;; 'logged_on_users_umfd1'=1;; 'logged_on_users_umfd2'=1;;
1417
.EXAMPLE
15-
PS>
18+
PS> Invoke-IcingaCheckUsers -Username 'astoll' -Warning 8 -Critical 15
19+
[OK] Check package "Users"
20+
| 'logged_on_users_test'=5;8;15
21+
0
1622
.PARAMETER Warning
1723
Used to specify a Warning threshold. In this case an integer value.
1824
.PARAMETER Critical

0 commit comments

Comments
 (0)