icinga-powershell-framework/lib/plugins/Invoke-IcingaCheckDirectory.psm1

86 lines
3.6 KiB
PowerShell
Raw Normal View History

Import-IcingaLib provider\directory;
<#
.SYNOPSIS
Checks how many files are in a directory.
.DESCRIPTION
Invoke-IcingaCheckDirectory returns either 'OK', 'WARNING' or 'CRITICAL', based on the thresholds set.
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
More Information on https://github.com/LordHepipud/icinga-module-windows
.FUNCTIONALITY
This module is intended to be used to check how many files and directories are within are specified path.
Based on the thresholds set the status will change between 'OK', 'WARNING' or 'CRITICAL'. The function will return one of these given codes.
.EXAMPLE
PS>Invoke-IcingaCheckDirectory -Path "C:\Users\Icinga\Downloads" -Warning 20 -Critical 30 -Verbosity 3
[OK]: Check package "C:\Users\Icinga\Downloads" is [OK] (Match All)
\_ [OK]: C:\Users\Icinga\Downloads is 19
.EXAMPLE
PS>Invoke-IcingaCheckDirectory -Path "C:\Users\Icinga\Downloads" -Warning 20 -Critical 30 -Verbosity 3
[WARNING]: Check package "C:\Users\Icinga\Downloads" is [WARNING] (Match All)
\_ [WARNING]: C:\Users\Icinga\Downloads is 24
.EXAMPLE
PS>Invoke-IcingaCheckDirectory -Path "C:\Users\Icinga\Downloads" -Warning 20 -Critical 30 -Verbosity 3 -YoungerThen 20d -OlderThen 10d
[OK]: Check package "C:\Users\Icinga\Downloads" is [OK] (Match All)
\_ [OK]: C:\Users\Icinga\Downloads is 1
.EXAMPLE
PS>Invoke-IcingaCheckDirectory -Path "C:\Users\Icinga\Downloads" -FileNames "*.txt","*.sql" -Warning 20 -Critical 30 -Verbosity 3
[OK]: Check package "C:\Users\Icinga\Downloads" is [OK] (Match All)
\_ [OK]: C:\Users\Icinga\Downloads is 4
.PARAMETER Warning
Used to specify a Warning threshold. In this case an integer value.
.PARAMETER Critical
Used to specify a Critical threshold. In this case an integer value.
.PARAMETER Path
Used to specify a path.
e.g. 'C:\Users\Icinga\Downloads'
.PARAMETER FileNames
Used to specify an array of filenames or expressions to match against.
e.g '*.txt', '*.sql' # Fiends all files ending with .txt and .sql
.PARAMETER Recurse
A switch, which can be set to filter through directories recursively.
.PARAMETER YoungerThen
String that expects input format like "20d", which translates to 20 days. Allowed units: ms, s, m, h, d, w, M, y.
Thereby all files younger then 20 days are considered within the check
.PARAMETER OlderThen
String that expects input format like "20d", which translates to 20 days. Allowed units: ms, s, m, h, d, w, M, y.
Thereby all files older then 20 days are considered within the check
.INPUTS
System.String
.OUTPUTS
System.String
.LINK
https://github.com/LordHepipud/icinga-module-windows
.NOTES
#>
function Invoke-IcingaCheckDirectory()
{
2019-10-29 05:47:24 -04:00
param(
[string]$Path,
[array]$FileNames,
[switch]$Recurse,
2019-10-29 05:51:17 -04:00
$Critical = $null,
$Warning = $null,
2019-10-29 05:47:24 -04:00
[string]$YoungerThen,
[string]$OlderThen,
[ValidateSet(0, 1, 2, 3)]
[int]$Verbosity = 0
);
2019-10-29 05:47:24 -04:00
$DirectoryData = Get-IcingaDirectoryAll -Path $Path -FileNames $FileNames `
-Recurse $Recurse -YoungerThen $YoungerThen -OlderThen $OlderThen;
$DirectoryCheck = New-IcingaCheck -Name $Path -Value $DirectoryData.Count -NoPerfData;
2019-10-29 05:47:24 -04:00
$DirectoryCheck.WarnOutOfRange(
($Warning)
).CritOutOfRange(
($Critical)
) | Out-Null;
2019-10-29 05:47:24 -04:00
$DirectoryPackage = New-IcingaCheckPackage -Name $Path -OperatorAnd -Checks $DirectoryCheck -Verbose $Verbosity;
2019-10-29 05:47:24 -04:00
return (New-IcingaCheckresult -Check $DirectoryPackage -NoPerfData $TRUE -Compile);
}