icinga-powershell-plugins

1.0.0

plugins/Invoke-IcingaCheckUsedPartitionSpace.psm1

<#
.SYNOPSIS
   Checks how much space on a partition is used.
.DESCRIPTION
   Invoke-IcingaCheckUsedPartition returns either 'OK', 'WARNING' or 'CRITICAL', based on the thresholds set.
   e.g 'C:' is at 8% usage, WARNING is set to 60, CRITICAL is set to 80. In this case the check will return OK.
   More Information on https://github.com/Icinga/icinga-powershell-plugins
.FUNCTIONALITY
   This module is intended to be used to check how much usage there is on an partition.
   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-IcingaCheckUsedPartitionSpace -Warning 60 -Critical 80
   [OK]: Check package "Used Partition Space" is [OK]
   | 'Partition C'=8,06204986572266%;60;;0;100 'Partition D'=12,06204736572266%;60;;0;100 'Partition K'=19,062047896572266%;60;;0;100
.EXAMPLE
   PS>Invoke-IcingaCheckUsedPartitionSpace -Warning 60 -Critical 80 -Exclude "C:\"
   [OK]: Check package "Used Partition Space" is [OK]
   | 'Partition D'=12,06204736572266%;60;;0;100 'Partition K'=19,062047896572266%;60;;0;100
.EXAMPLE
   PS>Invoke-IcingaCheckUsedPartitionSpace -Warning 60 -Critical 80 -Include "C:\"
   [OK]: Check package "Used Partition Space" is [OK]
   | 'Partition C'=8,06204986572266%;60;;0;100
.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 Exclude
   Used to specify an array of partitions to be excluded.
   e.g. 'C:\','D:\'
.PARAMETER Include
   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:\'
.INPUTS
   System.String
.OUTPUTS
   System.String
.LINK
   https://github.com/Icinga/icinga-powershell-plugins
.NOTES
#>

function Invoke-IcingaCheckUsedPartitionSpace()
{
   param(
      $Warning            = $null,
      $Critical           = $null,
      [array]$Include     = @(),
      [array]$Exclude     = @(),
      [switch]$NoPerfData,
      [ValidateSet(0, 1, 2, 3)]
      [int]$Verbosity     = 0
   );

   $DiskFree        = Get-IcingaDiskPartitions;
   $DiskPackage     = New-IcingaCheckPackage -Name 'Used Partition Space' -OperatorAnd -Verbose $Verbosity;
   $DiskBytePackage = New-IcingaCheckPackage -Name 'Used Partition Space in Bytes' -Verbose $Verbosity -Hidden;

   foreach ($Letter in $DiskFree.Keys) {
      if ($Include.Count -ne 0) {
         $Include = $Include.trim(' :/\');
         if (-Not ($Include.Contains($Letter))) {
               continue;
         }
      }

      if ($Exclude.Count -ne 0) {
         $Exclude = $Exclude.trim(' :/\');
         if ($Exclude.Contains($Letter)) {
               continue;
         }
      }

      $Unit               = Get-UnitPrefixIEC $DiskFree.([string]::Format($Letter))."Size";
      $PerfUnit           = Get-UnitPrefixSI  $DiskFree.([string]::Format($Letter))."Size";
      $Bytes              = [math]::Round(($DiskFree.([string]::Format($Letter))."Size") * (100-($DiskFree.([string]::Format($Letter))."Free Space")) / 100);
      $ByteString         = [string]::Format('{0}B', $Bytes);
      $ByteValueConverted = Convert-Bytes -Value $ByteString -Unit $Unit;
      $DiskSizeBytes      = $DiskFree[$Letter]['Size'];
      if ($null -eq $DiskSizeBytes) {
         $DiskSizeBytes = 0;
      }
      $DiskSize           = Convert-Bytes -Value ([string]::Format('{0}B', $DiskSizeBytes)) -Unit $Unit;
      $DiskTotalWarning   = $null;
      $DiskTotalCritical  = $null;

      if ($null -ne $Warning -And $DiskSize.Value -ne 0) {
         $DiskTotalWarning = $DiskSize.Value / 100 * $Warning;
      }
      if ($null -ne $Critical -And $DiskSize.Value -ne 0) {
         $DiskTotalCritical = $DiskSize.Value / 100 * $Critical;
      }

      $IcingaCheckByte = New-IcingaCheck -Name ([string]::Format( 'Used Space Partition {0}', $Letter )) -Value $ByteValueConverted.Value -Unit $PerfUnit -Minimum 0 -Maximum $DiskSize.Value;
      $IcingaCheckByte.WarnOutOfRange($DiskTotalWarning).CritOutOfRange($DiskTotalCritical) | Out-Null;
      $DiskBytePackage.AddCheck($IcingaCheckByte);

      $IcingaCheck = New-IcingaCheck -Name ([string]::Format('Partition {0}', $Letter)) -Value (100-($DiskFree.([string]::Format($Letter))."Free Space")) -Unit '%';
      $IcingaCheck.WarnOutOfRange($Warning).CritOutOfRange($Critical) | Out-Null;
      $DiskPackage.AddCheck($IcingaCheck);

      $DiskPackage.AddCheck($DiskBytePackage);
   }

   return (New-IcingaCheckResult -Check $DiskPackage -NoPerfData $NoPerfData -Compile);
}