Icinga PowerShell Plugins v1.5.0

1.5.0 (2021-06-02)

Issue and PRs

Upgrading Steps

Reworked plugins and removed arguments

Please note that in general plugins should no longer ship % values performance data and only the actually values including thresholds and min/max input. With the new Icinga for Windows Framework, you can use your graphing solution to properly calculate % values there on your own for display context. Monitoring is for most plugins possible, by simply adding a % sign behind your threshold.

In case the plugin does not support this input for this specify argument, you will receive a UNKNOWN output.

Invoke-IcingaCheckNetworkInterface

The following arguments have been removed from the plugin and are no longer usable:

• IncomingAvgBandUsageWarn
• IncomingAvgBandUsageCrit
• OutboundAvgBandUsageWarn
• OutboundAvgBandUsageCrit

These arguments were a % value based on the link speed and the current traffic of the interface. With the new argument handling for % values with Icinga for Windows v1.5.0, you can achieve the same result with the following, already present arguments:

• DeviceTotalBytesSecWarn
• DeviceTotalBytesSecCrit
• DeviceSentBytesSecWarn
• DeviceSentBytesSecCrit
• DeviceReceivedBytesSecWarn
• DeviceReceivedBytesSecCrit

Invoke-IcingaCheckMemory

We entirely reworked the plugin and added the same % value shipping with Icinga for Windows v1.5.0, which means we removed the following arguments:

• PercentWarning
• PercentCritical

In addition we added page file monitoring capabilities to the plugin with additional arguments

Invoke-IcingaCheckUsedPartitionSpace

As for both previous plugins, we reworked used partition space with changes for % values with Icinga for Windows 1.5.0 and fixed minor issues from the ground up.

Invoke-IcingaCheckPerfCounter

We fixed a spelling issue on the command itself, which was Invoke-IcingaCheckPerfcounter before and now properly displays Invoke-IcingaCheckPerfCounter. For that reason your current plugin configuration will change.
To resolve this beforehand, rename the custom variable within your Icinga Director to match the new uppercase C for Counter, before importing new configuration baskets.

Features and Updates

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

Icinga PowerShell Plugins v1.4.0

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

• #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

Icinga PowerShell Plugins v1.3.1

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

Icinga PowerShell Plugins v1.3.0

1.3.0 (2020-12-01)

Issue and PRs

Upgrading to v1.3.0 (2020-12-01)

Plugin Argument Changes (Breaking Changes)

The following plugins received modifications to their existing arguments. Please keep in mind that updating to this version of the Icinga PowerShell Plugins, you must update your configuration to ensure everything is running properly and update all plugins on all systems. As for the Icinga Director, you have to import the new basket for these plugins to apply the configuration. How ever, current values assigned to these arguments will no longer apply and have to be reconfigured!

Invoke-IcingaCheckScheduledTask

The State argument for Invoke-IcingaCheckScheduledTask has been changed from String to Array, which will now support providing multiple states a task can be into. In addition we modified the Icinga PowerShell Framework to properly support ValidateSet for array arguments, fixed in #152. Please ensure to upgrade to v1.3.0 before generating the new configuration and importing it, as the fix ensures that array arguments still can only contain fixed values.

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

Icinga PowerShell Plugins v1.2.0

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

Icinga PowerShell Plugins v1.1.0

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

Icinga PowerShell Plugins v1.0.0

The first stable release of our Icinga for Windows PowerShell Plugins

Fixed Issues and Improvements

• You can find issues and feature requests related to this release on our roadmap

Summary:

• Added new performance data output for certain plugins
• Added smart service check handling which will by default lookup all services which should be started automatically and throw critical if some are not running and exited not with exit code 0
• Increased the performance of certain plugins
• Fixed smaller display issues, framework compatibility and wrong output data

Update Notes

• If you installed the previous RC versions of 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

Icinga PowerShell Plugins v1.0.0-rc1

Changelog

• Initial release