Icinga PowerShell Framework

1.3.1 (2021-02-04)

Issue and PRs

Bugfixes

• #186 Fixes path handling for custom local/web path sources for service binary installation
• #188 Removes hardcoded zones director-global and global-zones which were always set regardless of user specification. This fix will ensure the user has the option to add or not add these zones
• #189 Fixes wrong documented user group for accessing Performance Counter objects which should be Performance Monitor Users
• #192 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
• #195 Fix Agent installer crash on package lookup with different files in directory
• #196 Fix Icinga 2 .conf file generator to no longer generate invalid plain configuration files
• #197 Fixes progress bar appearance on check outputs for certain plugins, by disabling the entire PowerShell progress bar during the usage of Icinga for Windows

1.3.0 (2020-12-01)

Issue and PRs

Breaking Changes

Components

• Please have a look on the changes made on the Icinga PowerShell Plugins for a smooth upgrade process

Icinga PowerShell Kickstart

• In order to be able to use the Icinga PowerShell Kickstart Script with v1.3.0 of the Icinga PowerShell Framework, you will have to upgrade the kickstart script to v1.2.0

Enhancements

• #19 Add support for proxy servers for web calls and re-arranges content from lib/web to lib/webserver and uses lib/web for new proxy/web calls
• #121 Adds feature allowing sharing of local variables with Icinga Shell, by using -ArgumentList. They can then be accessed by using $IcingaShellArgs with the correct array index id, following the order of items added to -ArgumentList
• #136 Adds support to ignore empty check packages and return Ok instead of Unknown if -IgnoreEmptyPackage is set on New-IcingaCheckPackage
• #137 Adds Cmdlet to compare a DateTime object with the current DateTime and return the offset as Integer in seconds
• #139 Add Cmdlet Start-IcingaShellAsUser to open an Icinga Shell as different user for testing
• #141 Adds Cmdlet Convert-IcingaPluginThresholds as generic approach to convert Icinga Thresholds with units to the lowest unit of this type.
• #134 Adds Cmdlet Test-IcingaWindowsInformation to check if a WMI class exist and if we can fetch data from it. In addition we add support for binary value comparison with the new Cmdlet Test-IcingaBinaryOperator
• #142 Experimental: Adds feature to cache the Framework code into a single file to speed up the entire loading process, mitigating the impact on performance on systems with few CPU cores. You enable disables this feature by using Enable-IcingaFrameworkCodeCache and Disable-IcingaFrameworkCodeCache. Updating the cache is done with Write-IcingaFrameworkCodeCache
• #149 Adds support to add Wmi permissions for a specific user and namespace with Add-IcingaWmiPermissions. In addition you can remove users from Wmi namespaces by using Remove-IcingaWmiPermissions
• #153 Adds support to add a knowledge base id to Exit-IcingaThrowException for easier referencing. This should mostly be used for custom messages, as we should track the main knowledge base id's inside the messages directly. Native messages should be split in a hashtable with a Message and IWKB key
• #155 Adds support to write all objects collected by Get-IcingaWindowsInformation into the Windows EventLog in case the debug output for the Icinga PowerShell Framework is enabled.
• #162 Adds feature to test the length of plugin custom variables during config generation and throws error in case the total length is bigger than 64 digits, as imports into the Icinga Director by using baskets is not possible otherwise
• #163 Adds native support for writing Icinga 2 configuration for plugins and allows to easy publish new configurations for modules with the new Cmdlet Publish-IcingaPluginConfiguration
• #164 Adds exit after calling icinga on Windows Terminal integration to ensure the shell will close in case the Icinga shell is closed
• #168 Adds support for new Icinga Director SelfService config arguments which will now ensure the wizard will run without asking questions by using the Icinga Director configuration (requires Icinga Director 1.8 or later)

Bugfixes

• #059, #060 Fixes interface handling for multiple interfaces and returns only the main interface by fallback to routing table and adds support for Windows 2008 R2
• #114#146 Fixes Icinga Agent API being wrongly disabled after successful certificate configuration and installation
• #127 Fixes wrong error message on failed MSSQL connection due to database not reachable by using -IntegratedSecurity
• #128 Fixes unhandled output from loading System.Reflection.Assembly which can cause weird side effects for plugin outputs
• #130 Fix crash while running services as background task to collect metrics over time by missing Performance Counter cache initialisation
• #133, #147 Fixes an issue while changing the hostname between upper/lower case which might cause unwanted exceptions on one hand but also required manual signing of requests on the CA master as the signing process was not completed
• #138 Fixes possible value overflow on Convert-Bytes while converting from anything larger than MB to Bytes
• #140 Fixes version fetching for not loaded modules during upgrades/plugin calls with Get-IcingaPowerShellModuleVersion
• #143 Fixes the annoying hint from the analyzer to check space before open brace
• #152 Fixes incorrect rendering for empty arrays which used $null incorrectly instead of @() and fixed ValidateSet which now also supports arrays as data type
• #159 Fixes crash during update of the Icinga Framework, caused by the newly introduced experimental feature for code caching
• #165 Fixes fetching for Icinga Agent certificate for REST-Api daemon on upper/lower case hostname mismatch
• #166 Fixes fetching of Icinga Agent MSI packages by correctly comparing versions to ensure we always use the latest version and fixes release usage for local/network drive sources
• #167 Fixes error while writing EventLog entries with too large message size
• #177 Fixes Wmi permissions to allow domain accounts while not being locally known on the system

1.2.0 (2020-08-28)

Issue and PRs

Upgrading Notes

Breaking change with non-equal versions

Check Command configuration generated by Icinga for Windows 1.2.0 require Icinga for Windows 1.2.0 or later deployed on all systems, otherwise you will run into issues with an unknown command Exit-IcingaPluginNotInstalled error.

• To properly catch errors on check execution you will have to import check commands as Director basket again by using Get-IcingaCheckCommandConfig. Further details can be found in the upgrading docs

Notes

• Improved documentation for plenty of Cmdlets and functionality
• We have updated the handling for plugin outputs which will now only print non Ok values by using verbosity 0 on check plugin configuration and include Ok checks for packages with non Ok checks on verbosity 1. Additional details can be found on issue #99
• #80 Adds wrapper function Get-IcingaWindowsInformation for WMI and CIM calls to properly handle config/permission errors
• #93 Adds PSScriptAnalyzer for improved and identical code quality

Enhancements

• Adds configuration for Windows Terminal integration
• Adds new Cmdlet Show-IcingaPerformanceCounterInstances to display all available instances for Performance Counters
• #76 Adds support to test for required .NET Framework Version 4.6.0 or above before trying to install the Icinga Agent
• #87 Adds wrapper command to test new code or functionality of Framework and/or plugins
• #88 Adds Start/Stop timer functionality for performance analysis
• #94 Adds Namespace argument for Get-IcingaWindowsInformation for additional filtering
• #95 Improves error handling for issues by using Use-Icinga initialising or by calling plugins which are not installed
• #98 Adds support for SecureString as password argument on config generation
• #99 Improves plugin output with different verbosity settings
• #100, #107 Adds help for each Performance Counter Cmdlet, separates Cmdlets into single files, adds Filter option for Show-IcingaPerformanceCounterCategories and adds Test-IcingaPerformanceCounterCategory to test if a category exists on a system
• #108 Adds function Show-IcingaPerformanceCounterHelp to fetch the help of a specific Performance Counter
• #111 Improves error message on permission problems while accessing CIM/WMI objects including details on how to resolve them

Bugfixes

• #78 Fix Icinga Agent package fetching for x86 architecture
• #79 Fix ConvertTo-Seconds to output valid numeric data with multiple digits
• #81, #82 Fix error on EventLog initialising in case Icinga for Windows application is not registered on new machines and throws proper error message on plugin execution on how to resolve it
• #83 Fix error on Icinga Config basket renderer for illegal ValidateSet while $null values were allowed values
• #84 Fix conversion of ConvertTo-Seconds and ConvertTo-SecondsFromIcingaThresholds while the input value is $null
• #85 Fix incorrect handling to empty service user password which was configured as empty String instead of $null SecureString object
• #89 Fix file type question during Get-IcingaCheckCommandConfig generation in Windows 2012 R2 and older
• #90 Fix file type question during Icinga Agent installation on Windows 2012 R2 while using a custom installation target
• #91 Fix wrong default values being set for installer arguments by using the Icinga Director Self-Service API
• #92 Fix Set-IcingaAcl which fails on older Windows systems with a security id error and not at all/not properly setting required permissions for directories
• #96 Re-Implements caching for Performance Counters and fixes an issue with counters sometimes returning value 0 instead of the correct value
• #97, #101, #104 Fix value digit count for Performance Counters