Icinga PowerShell Plugins CHANGELOG¶

The latest release announcements are available on https://icinga.com/blog/.

Please read the upgrading documentation before upgrading to a new release.

Released closed milestones can be found on GitHub.

1.12.0 (2024-03-26)¶

Bugfixes¶

#375 Fixes a memory leak on the Icinga EventLog provider for fetching Windows EventLog information
#384 Adds new data provider for Invoke-IcingaCheckProcess and extends functionality by adding a new ‘ExcludeProcess’ argument
#386 Adds new provider for Invoke-IcingaCheckEventLog, to improve performance and fix memory leaks

Enhancements¶

#288 Adds support to Invoke-IcingaCheckPartitionSpace to define mandatory partitions which should always be present
#366 Adds support to Invoke-IcingaCheckCPU to report top CPU consuming process information as well as a switch to change the overall load from average to sum
#378 Adds support for Invoke-IcingaCheckService to change the output for not found services from UNKNOWN to OK, WARNING or CRITICAL instead

1.11.1 (2023-11-07)¶

Bugfixes¶

#358 Fixes broken Icinga plain configuration
#360 Fixes Invoke-IcingaCheckMemory which uses the wrong unit for the pagefile plugin, wrong values, exceptions and %-Values not working

1.11.0 (2023-08-01)¶

Bugfixes¶

#342 Fixes an issue for disk health plugin, which can fail in some cases due to an invalid conversion from the MSFT output from int to string
#346 Fixes the pagefile provider at Get-IcingaMemoryPerformanceCounter which returned the pagefile size in MB instead of Bytes

Enhancements¶

#332 Adds support to provide different credentials for the Invoke-IcingaCheckUNCPath plugin, to run the check for a different user account
#348 Adds feature to Invoke-IcingaCheckPerfCounter to summarize an entire performance counter category, in case all instances of the check fail to prevent large outputs being written into the database
#355 Updates Invoke-IcingaCheckCPU to use new data providers directly from the Icinga PowerShell Framework.

Breaking changes¶

Invoke-IcingaCheckCPU¶

The new CPU metrics will now be separated between the actual sockets of the system, allowing an overview on multi socket systems, which CPU is assigned more loads
Metrics will now be separated by 0_1 for the index, which in this example is socket 0 and core 1.

1.10.1 (2022-12-20)¶

Bugfixes¶

#323 Fixes Invoke-IcingaCheckService to write invalid performance data in case one service is actively checked and returning UNKNOWN because it does not exist

Enhancements¶

#322 Adds flag -IgnoreService for plugin Invoke-IcingaCheckTimeSync to ignore the time service being evaluated during check runtime

1.10.0 (2022-08-30)¶

Issue and PRs

Bugfixes¶

#199 Fixes Invoke-IcingaCheckDiskHealth to add disk metadata like serial number and friendly name for any disk type processed
#308 Fixes function Get-IcingaServiceCheckName which was not public anymore since v1.9.0, causing MSSQL plugins to not work properly
#319 Removes performance data for Invoke-IcingaCheckCheckSum, as there are no real performance metrics to write which are allowed by icinga

Enhancements¶

#276 Extends Invoke-IcingaCheckUpdates for allowing to check if there is a pending reboot on the system remaining to finalize Windows updates
#284 Adds support to exclude certain exit codes from throwing critical for Invoke-IcingaCheckScheduledTask [Paul-Weisser]
#300 Adds a new flag -ConnectionErrAsCrit to Invoke-IcingaCheckHTTPStatus, allowing to change the UNKNOWN result in case a connection to the website is not possible to CRITICAL
#301 Adds support to use Include and Exclude filters for Invoke-IcingaCheckPerfCounter
#312 Adds support to exclude certificates by thumbprints for Invoke-IcingaCheckCertificate by adding thumbprints to the -ExcludePattern argument
#316 Adds support to include and exclude network devices for Invoke-IcingaCheckNetworkInterface by their device and interface name, besides the internal id

Grafana Dashboards¶

New Dashboards¶

Windows Base
Windows-Plugins-Web

New Plugin Integrations¶

Invoke-IcingaCheckPartitionSpace
Invoke-IcingaCheckNetworkInterface
Invoke-IcingaCheckUpdates
Invoke-IcingaCheckUptime
Invoke-IcingaCheckCPU
Invoke-IcingaCheckService
Invoke-IcingaCheckMemory
hostalive

New Plugin¶

Adds new plugin Invoke-IcingaCheckHttpJsonResponse to check results returned by a JSON web request #290. [DOliana]

1.9.0 (2022-05-03)¶

Issue and PRs

Bugfixes¶

#283 Fixes random Add-Type exceptions during runtime compilation by replacing it with Add-IcingaAddTypeLib
#286 Fixes Invoke-IcingaCheckHTTPStatus which is not returning the request time, in case the target website is not providing content
#299 Fixes integration with Inventory module

Enhancements¶

#298 Adds support for Icinga for Windows v1.9.0 module isolation

1.8.0 (2022-02-08)¶

Issue and PRs

Bugfixes¶

#250 Fixes alias Invoke-IcingaCheckUsedPartitionSpace which is not working on Windows 2012R2 or older and being replaced with a native function
#246 Fixes wrong UNKNOWN on Invoke-IcingaCheckService while using service display name with the -Service argument instead of the service name
#261 Fixes Invoke-IcingaCheckCertificate which always included the CertStore because no option to not check the certificate store was available
#262 Fixes method NULL exception on empty EventLog entries for Invoke-IcingaCheckEventLog
#271 Fixes JEA error which detected ScriptBlocks in the plugin collection
#272 Fixes file encoding for Invoke-IcingaCheckTimeSync which was not UTF8 before, causing the JEA profile writer to ignore the file
#274 Fixes Invoke-IcingaCheckScheduledTask for wildcard task names, which added the unknown package in case wildcards were used for task names

Enhancements¶

#143, #220, #256 Improves Invoke-IcingaCheckUpdates, splitting updates into different categories, allowing the check for the update count based on these categories Microsoft Defender, Security Updates, Rollup Updates and all Other Updates. The -UpdateFilter will only apply to the total update count, allowing additional customisation. By running the plugin with -Verbosity 1, it will now also print the list of the update names if the the thresholds are printing Warning, Critical or Unknown
#204 Extends functionality of Invoke-IcingaCheckDirectory by allowing to monitor file counts, adding folder count to monitoring, different files sizes (total size, average, smallest file and largest file) and allows to print the entire file list fetched by the plugin
#205 Adds new plugin Invoke-IcingaCheckProcess for detailed monitoring of running services for CPU, Memory, PageFile and ThreadCount usage and total running processes

1.7.0 (2021-11-09)¶

Issue and PRs

Bugfixes¶

#187 Fixes Invoke-IcingaCheckUsedPartitionSpace and Invoke-IcingaCheckDiskHealth in case mirrored disks are used within the system, causing an exception on duplicate partition id’s
#200 Fixes UNKNOWN for Invoke-IcingaCheckUsedPartitionSpace, in case the main partition has no space left which should return CRITICAL instead
#233 Fixes used partition space plugin performance by fetching only partition space data instead of entire disk information collection and renamed it to represent the new method of being able to toggle between free and used space for partitions
#235 Fixes operational status monitoring output for Invoke-IcingaCheckDiskHealth

Enhancements¶

#199 Adds additional metadata to Invoke-IcingaCheckDiskHealth for disk serial number, assigned partitions, boot device, device id, system device and device name
#211 Adds feature to Invoke-IcingaCheckService, allowing to filter for specific service startup types in case the plugin is used to check for specific services with -Service
#237 Adds support for Invoke-IcingaCheckHTTPStatus to add the content of the website output by using the flag -AddOutputContent
#241 Adds possibility to switch between free and used monitoring for Invoke-IcingaCheckUNCPath and consolidates monitoring like other plugins, with dynamic % monitoring.
#243 Removes function Publish-IcingaPluginDocumentation, as this function will move directly into the Icinga PowerShell Framework

1.6.0 (2021-09-07)¶

Issue and PRs

Bugfixes¶

#221 Fixes Invoke-IcingaCheckFirewall to not use variable with name -Profile as argument, as it is reserved for PowerShell internals
#224 Fixes Invoke-IcingaCheckUsedPartitionSpace label names, which might have caused conflicts with Graphite/InfluxDB, because of changed metric unit
#226 Fixes class names of Add-Type for Get-IcingaDiskAttributes and Get-IcingaUNCPathSize and adds checks if the class was already added inside the session

Enhancements¶

#208 Adds additional features to Invoke-IcingaCheckScheduledTask, allowing to monitor exit codes, missed runs and last/next run time of a task
#217 Adds feature for Invoke-IcingaCheckPerfCounter with new switch -IgnoreEmptyChecks to change the output from UNKNOWN to OK, in case no performance counters were found
#222 Replaces Get-FileHash with own implementation as Get-IcingaFileHash, to work with new JEA integration
#223 Removes the function Get-IcingaServices, as this function has been moved to the Icinga PowerShell Framework
#225 Adds support for plugins to work in JEA context

1.5.1 (2021-07-07)¶

Issue and PRs

Bugfixes¶

#196 Fixes unhandled PermissionDenied exceptions for Invoke-IcingaCheckDirectory, in case required permissions for files and folders were not set
#202 Fixes \ and / which are now removed again for -Include and -Exclude arrays on Invoke-IcingaCheckUsedPartitionSpace.

1.5.0 (2021-06-02)¶

Issue and PRs

New Plugins¶

Invoke-IcingaCheckHTTPStatus¶

#163 Checks the response time, the return code and content of HTTP requests.

Invoke-IcingaCheckMPIO¶

#172 Checks the number of paths for each MPIO driver on your system.

Reworked Plugins¶

Please have a look on the upgrading docs for these plugins

Invoke-IcingaCheckNetworkInterface
Invoke-IcingaCheckMemory
Invoke-IcingaCheckUsedPartitionSpace

Enhancements¶

#14 Rework of Invoke-IcingaCheckMemory to use new features from 1.5.0 for % handling and added page file check content including arguments. Please have a look on the upgrading docs
#71 Rework Invoke-IcingaCheckUsedPartitionSpace to properly use Framework v1.5.0 functionality and resolve upper/lower case drive filtering
#156 Adds feature to modify the output status of Invoke-IcingaCheckCertificate from UNKNOWN to OK in case no certificate was found by setting the new argument -IgnoreEmpty
#159 Replaces the deprecated function Get-EventLog with Get-WinEvent. In addition, the plugin received a new argument -MaxEntries to allow additional filtering for the number of events fetched to improve performance in addition. The EventLog now also supports an array with list items, allowing easier filtering for severities which are allowed inside the EventLog.
#167 Upgrades plugin configuration files to Framework version 1.5.0. Please have a look on the upgrading docs
#181 Improves the handling for the Network Interface plugin and moves the Get-IcingaNetworkInterfaceUnits from the plugin repository into the Framework

Bugfixes¶

#144 Fixes filtering for Invoke-IcingaCheckEventLog which resulted in wrong results, depending on the plugin configuration
#147 Fixes wrong comparison for file size on Get-IcingaDirectorySizeSmallerThan, used by Invoke-IcingaCheckDirectory
#148 Fixes exception on Invoke-CheckNetworkInterface while two team interfaces with the identical name are present on the system
#154 Fixes Invoke-IcingaCheckDirectory by setting -FileNames argument to * as default for allowing to fetch all files for a given directory by default
#160 While filtering for certain services with Get-IcingaServices, there were some attributes missing from the collection. These are now added resulting in always correct output data.
#161 Fixes a copy & paste error on Invoke-IcingaCheckUsedPartitionSpace, as a wrong check variable was used for forcing Unknown results
#171 Fixes wrong OK states for Invoke-IcingaCheckPerfCounter, in case counters for categories with instances were not present
#176 Fixes offset calculation for Invoke-IcingaCheckTimeSync, to allow negative offset as well
#178 Fixes exception handling for Invoke-IcingaCheckNLA to properly handle errors while checking for connection profiles
#185 Fixes Network interface percent for teams not working
#186 Fixes possible exception on Icinga for Windows installation, if plugins were removed, no new shell session was created and therefor plugins are not able to load

1.4.0 (2021-03-02)¶

Issue and PRs

Breaking changes¶

If you are going to install this plugin release, please have a look on the upgrading docs before!

Enhancements¶

#114 Adds possibility to exclude certificates matching a certain pattern
#134 Adds autoloading for plugin information to standardize the development and projects and fixes plenty of spelling/code styling errors
#135 Adds new check plugin Invoke-IcingaCheckTCP
#137 Adds new configuration for Icinga for Windows v1.4.0 to make future configuration changes unnecessary. Please read the upgrading docs before upgrading!
#139 Adds check note for the last boot time for Invoke-IcingaCheckUptime which is being displayed by using -Verbosity 2 on the check configuration
#140 Adds new plugin Invoke-IcingaCheckUNCPath to test for network share paths or other volumes to fetch the size and free space from them
#141 Update Icinga Director and Icinga 2 conf files with new DSL parser for array elements to properly escape string values with single quotes. Please read the upgrading docs

Bugfixes¶

#136 Improves Invoke-IcingaCheckEventLog time filter by allowing simple input like -After 5h and fixes issue on filtering by formatting the time data into required format yyyy/MM/dd HH:mm:ss

1.3.1 (2021-02-04)¶

Issue and PRs

Bugfixes¶

#123 Fixes wrong documented user group for accessing Performance Counter objects which should be Performance Monitor Users
#124 Fixes crash on Invoke-IcingaCheckService if an automatic service is not running
#126 Fixes code base for Invoke-IcingaCheckService by preferring to fetch the startup type of services by using WMI instead of Get-Services, as the result of Get-Services might be empty in some cases
#128 Fixes invalid Icinga 2 configuration files due to special characters, invalid attributes and wrong boolean values

1.3.0 (2020-12-01)¶

Issue and PRs

New Plugins¶

This release adds the following new plugin:

Invoke-IcingaCheckNetworkInterface: Checks availability, state and Usage of Network interfaces and Interface Teams
Invoke-IcingaCheckStoragePool: Checks availability, utilization and state of a StoragePool

Breaking changes¶

If you are going to install this plugin release, please have a look on the upgrading docs to not run into issues!

Enhancements¶

#61 Adds exception handling in case permissions to access Windows Updates are missing on the system
#73 Improves plugin creation Cmdlet to write a new permission section and to create the plugins doc folder in case it does not exist
#74 Adds avg. disk queue length metric for monitoring and performance data to Invoke-IcingaCheckDiskHealth
#78 Improves the documentation and output for Invoke-IcingaCheckService by adding metrics for all found services configured to run Automatic and adds service output on Verbosity 1 to show a list of all found services including their current state
#85 Adds support on Invoke-IcingaCheckUsedPartitionSpace to ignore a Unknown in case all checks are filtered out. This will then return Ok instead if argument -IgnoreEmptyChecks is set. In addition you can now use -SkipUnknown which will transform an Unknown of partitions without data to Ok. Reworks #84
#90 Adds support to ignore read only/offline disks on Invoke-IcingaCheckDiskHealth
#101 Improves Invoke-IcingaCheckScheduledTask by changing the State argument from String to Array, allowing the comparison against multiple states. Important: Please have a look on the upgrading docs!
#104 Adds plugin configuration files for Icinga Director and Icinga 2 within the config directory
#109 Adds exception handling in case -Path argument is not set or not directing a file (including invalid path)

Bugfixes¶

#75 Fixes unhandled arguments FileSizeGreaterThan and FileSizeSmallerThan for Invoke-IcingaCheckDirectory
#77 Fix wrong filtering for EventIds for Invoke-IcingaCheckEventLog and improve the output by adding the EventLog messages on severity 1. In addition we now allow the filtering for message sources and increase performance by fetching EventLog data for new checks from the last 2 hours only
#79 Fixes service check to exclude provided service names in case they contain the wildcard symbol ‘*’ which causes the check to always return unknown
#86 Fixes Get-IcingaCPUCount returns wrong count on empty arguments
#97, #98 Fixes invalid performance data output for Invoke-IcingaCheckScheduledTask
#102, #103 Fixes Invoke-IcingaCheckNetworkInterface plugins arguments being too long for Icinga Director
#110 Fixes Invoke-IcingaCheckEventLog plugin throwing an unknown for valid arguments

1.2.0 (2020-08-28)¶

Issue and PRs

New Plugins¶

This release adds the following new plugins:

Invoke-IcingaCheckTimeSync: Allows to compare local machine time with a time server to check for possible time missmatch
Invoke-IcingaCheckScheduledTask: Allows to check the current state for a list of provided scheduled tasks
Invoke-IcingaCheckDiskHealth: Allows to check for several disk Performance Counters and the disk health in general

Notes¶

#34 Replaces plugin CIM/WMI calls for new Framework wrapper function Get-IcingaWindowsInformation to properly handle config/permission errors

Enhancements¶

#32 Improves plugin doc generate to update existing .md files and create new ones only if required
#28 Adds unknown state for each included service during a service check which was not found on the host
#33 Adds support to generate plugin docs for different plugin module repos
#38 Adds new plugin Invoke-IcingaCheckDiskHealth
#39 Fixes Performance Counters check plugin to throw error in case Performance Counter do not exist or a simply not present
#42 Improves performance of Invoke-IcingaCheckCPU for multi socket systems and optimises the code
#44 Adds check for Performance Counter categories ‘Memory’ and ‘Processor’ if they are present on a system, throwing an ‘Unknown’ if not

Bugfixes¶

#30 Fixes $null input value for certificate check, causing the Director import to fail
#36 Fixes Ok return value for Invoke-IcingaCheckDirectory while -Path argument is not set
#37 Fixes -FileNames argument being ignored for Invoke-IcingaCheckDirectory while not using the -Recurse argument
#40 Fixes Get-TimeZone Cmdlet not known for Invoke-IcingaCheckTimeSync on Windows 2012 R2 and older
#50, #51 Fixes possible crash/artifacts on plugin output for EventLog check while filters do not match any entry

1.1.0 (2020-06-02)¶

Issue and PRs

Notes¶

This release adds two new plugins to the collection:

Invoke-IcingaCheckICMP: Allows to execute ping checks from the Windows Agent to other hosts
Invoke-IcingaCheckCertificate: Allows to check certificates on disk or inside the Windows Cert Store

Enhancements¶

#26 Fixes Invoke-IcingaCheckEventLog to use EventIds instead of InstanceIds for filtering and output

Bugfixes¶

#19 Fixes exclude of EventLog ids for Invoke-IcingaCheckEventLog
#27 Fixes User provider to prevent almost infinite loop on AccountDomainSid resolving

1.0.0 (2020-02-19)¶

Issue and PRs

Notes¶

This release fixed several smaller design and documentation issues as well as improving the general output of the plugins.

Breaking changes¶

If you installed the previous RC versions of the Framework or the Plugins, you will have to generate the Icinga Director Basket configuration again and re-import the newly generated JSON file. Please be aware that because of possible changes your old custom variables containing arguments and thresholds might not apply due to new custom variable naming and handling. Please ensure to have a backup of your Icinga Director before applying any changes

Enhancements¶

#5 Used partition space will now output usage in bytes as well (formatted to MB/GB/TB depending on size)
#9 The memory plugin is now calculating the missing thresholds

Bugfixes¶

#4 Fixes unused partition space plugin not working on Windows 7 or older
#8 Fixes unit auto detection for memory plugin

1.0.0 RC1 (2019-11-04)¶

Notes¶

Initial release candidate for the new Icinga PowerShell Plugins