31-Changelog.md

Icinga PowerShell Framework 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.6.0 (pending)

Issue and PRs

Bugfixes

• #311 Fixes an issue with negative inputs on some scenarios which will cause an exception for checks instead of continuing executing them properly

Enhancements

• #301 Improves error handling to no longer print passwords in case String is used for SecureString arguments
• #305 Adds a new Cmdlet to test if functions with Add-Type are already present inside the current scope of the shell
• #306 Adds new Cmdlet Exit-IcingaThrowCritical to throw critical exit with a custom message, either by force or by using string filtering and adds storing of plugin exit codes internally

1.5.2 (2021-07-09)

Security Fixes

• #298 Fixes possible security vulnerability on Icinga for Windows service registration, by not quoting the service path on registration

You can read more on this on the Knowledge Base Entry with further details, on how to apply the fix and test if you are affected.

1.5.1 (2021-07-07)

Issue and PRs

Bugfixes

• #276 Fixes check value conversion to decimal, which sometimes did not resolve values properly and caused conversion issues
• #282 Fixes issue on System.Text.StringBuilder which fails to initialize properly on some older Windows systems
• #284 Fixes exception while creating default threshold objects
• #285 Fixes plain Icinga 2 conf generation for commands, which was caused by a new exception output for additional output
• #293 Fixes crash on REST-Api for NULL values while parsing the REST message
• #295 Fixes background service check daemon not working with arguments for plugins
• #297 Fixes null exception error which can occur in certain edge cases, caused by testing New-IcingaCheck directly without function wrapper

1.5.0 (2021-06-02)

Issue and PRs

Enhancements

• #228 Adds feature to suppress any kind of console output except for plugin output and performance data
• #229 CustomFields defined as SecureString are now set to hidden within the Icinga Director configuration basket - please read the upgrading docs carefully
• #234 Adds support to allow custom exception lists for Icinga Exceptions, making it easier for different modules to ship their own exception messages
• #235 Adds new Cmdlet Show-IcingaEventLogAnalysis to get a better overview on how many log entries are present within the EventLog based on hour, minute and day average/maximum for allowing a more dynamic configuration for Invoke-IcingaCheckEventLog
• #236 Adds feature which stops the Icinga Agent before upgrading the Icinga PowerShell Framework and starting it again afterwards (in case it was running), to resolve some possible file lock issues
• #241 Ensures we use TLS 1.1 and 1.2 for REST-Api calls, as used certificates in general are created with these
• #243 Adds stacktrace output for exceptions in case plugin execution fails
• #248 Improves Test-IcingaPerformanceCounterCategory by creating an object for the Performance Counter category provided and checking if it is a valid object instead of relying on the registry which might not contain all categories in the correct language.
• #249 Improves internal exception handler to get rid if misplaced : and adds all fields properly
• #250 Improve error handling on plugin execution by informing the user if the plugin is simply not installed or the entire module was not loaded because of errors or missing dependencies
• #264 Adds initial handling for handling link speeds or anything else by using new units and conversions, which were formerly used inside the Network plugin and corresponding provider

Bugfixes

• #231 Fixes error while using Icinga Director Self-Service API, in case the host or host API key was deleted inside the Icinga Director and the installation wizard was called with the correct template key, while the old host key was still present inside the Icinga for Windows configuration
• #232 Fixes wrong encoding while using REST-Api checks experimental feature, and now forces UTF8
• #237 Fixes Icinga PowerShell Framework root folder lookup, in case the module was installed with PowerShell gallery, which creates version folders for each installed version
• #240 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.
• #245 Fixes loading of .pfx certificates by properly checking the file type
• #265 Fixes Test-Numeric to now accept negative numeric values and als fixes errors, causing . to be allowed multiple times. ConvertFrom-TimeSpan now properly prints on negative values if the time provided is positive or negative and also prints microseconds as us in case the value is loer than 1ms
• #269 Fixes unhandled exception on Set-IcingaCacheData, as the -ErrorAction Stop argument was not set and therefor the function never halted on errors
• #272 Fixes invalid unit conversion, in case first char of a string is matching time metrics

1.4.2 (2021-07-09)

Security Fixes

• #298 Fixes possible security vulnerability on Icinga for Windows service registration, by not quoting the service path on registration

You can read more on this on the Knowledge Base Entry with further details, on how to apply the fix and test if you are affected.

1.4.1 (2021-03-10)

Issue and PRs

Bugfixes

• #222 Fixes an issue with [Secure.String] arguments for PowerShell plugins, caused by ConvertTo-IcingaSecureString Cmdlet not being pre-loaded
• #224 Fixes "memory leak" on background daemon for registered service checks, by clearing the error stack and manually calling the PowerShell garbage collector to force freeing of memory

1.4.0 (2021-03-02)

Issue and PRs

Breaking Changes

There are changes made to the pre-compiled configuration files and Get-IcingaCheckCommandConfig. Please have a look on the upgrading before applying the new configuration files.

Enhancements

• #180 Ensure check data are separated from each thread and not accessible from one thread to another to prevent conflicting results
• #193 Adds optional support for adding milliseconds to Get-IcingaUnixTime with the -Milliseconds argument for more detailed time comparison
• #198 Adds support to flush the content of the Icinga Agent API directory with a single Cmdlet Clear-IcingaAgentApiDirectory
• #203 Removes experimental state of the Icinga PowerShell Framework code caching and adds docs on how to use the feature
• #205 Ensure Icinga for Windows configuration file is opened as read-only for every single task besides actually modifying configuration content
• #207 Adds new Argument -LabelName to New-IcingaCheck, allowing the developer to provide custom label names for checks and override the default based on the check name.
• #210 Updates the Icinga DSL for building PowerShell arrays to ensure all string values are properly escaped with '. In case the user already wrapped commands with ' by himself, this will not have an effect as we only add single quotes for escaping if they are not present already
• #211 Adds feature to uninstall single components for Icinga for Windows or to uninstall everything and start entirely from new
• #213 Added support to fetch network interface for Register-IcingaDirectorSelfServiceHost directly from provided director url
• #213 Added support for Icinga Framework Code Cache file being deleted once the feature is disabled
• #213 Added support to suppress any console output for the current PowerShell session by using Disable-IcingaFrameworkConsoleOutput and to enable it again by using Enable-IcingaFrameworkConsoleOutput
• #213 Added support for -Release argument for Get-IcingaFrameworkServiceBinary suppressing questions and using GitHub as source directly if set
• #213 Added support to color console output by using Write-IcingaConsolePlain with the new argument -ForeColor
• #213 Added new feature to write Icinga for Windows console headers more easily, better structured and formatted with Write-IcingaConsoleHeader by adding line content as array elements

Bugfixes

• #206 Fixes background service check daemon for collecting metrics over time which will no longer share data between configured checks which might cause higher CPU load and a possible memory leak
• #208 Fixes Convert-IcingaPluginThresholds which sometimes did not return proper numeric usable values for our internal functions, causing issues on plugin calls. In addition the function now also supports the handling for % units.
• #213 Fixed possible crash on Get-IcingaAgentFeatures if PowerShell is not running as administrator and therefor the command icinga2 feature list can not be processed
• #213 Fixed ConvertTo-IcingaSecureString to return $null for empty strings instead of throwing an exception
• #214 Fixes wrong [Unknown] PluginNotInstalled exception because of new plugin configuration and wrong checking against APi result in case feature is enabled
• #215 Fixes wrong used variable for arguments on API call checks

Experimental

• #204 Adds experimental feature to forward checks executed by the Icinga Agent to an internal REST-Api, to reduce the performance impact on systems with lower resources available
• #213 Adds new experimental feature Management Console for better and easier management for Icinga for Windows and improved automation and deployed.

1.3.2 (2021-07-09)

Security Fixes

• #298 Fixes possible security vulnerability on Icinga for Windows service registration, by not quoting the service path on registration

You can read more on this on the Knowledge Base Entry with further details, on how to apply the fix and test if you are affected.

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

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

1.1.2 (2020-07-01)

Issue and PRs

Bugfixes

• #74 Disabling Agent features for last list item is not possible
• #75 'notification' feature is not disabled during installation

1.1.1 (2020-06-18)

Issue and PRs

Bugfixes

• #70 Fixes zones configuration for multiple parent endpoints
• #72 Fixes installation target directory not used properly while directory exist already

1.1.0 (2020-06-02)

Issue and PRs

Notes

• #62 Deprecates --key argument for certificate generation for Icinga 2.12.0 and later

Deprecations

• The value latest for the installation wizard argument AgentVersion is deprecated and has been replaced by release

Breaking changes

• The -AcceptConnections argument for the install wizard had the opposite effect in the previous versions. Please review your configuration on a test setup before proceeding with a mass-rollout to ensure the Agent behaves as expected
• The wizard now ships with a new argument -ConvertEndpointIPConfig which will convert hostnames or FQDN entries for connection information to IP addresses. If you are having a CLI string available and neither want to be asked this question or change current behaviour, set the argument to 0: -ConvertEndpointIPConfig 0

Enhancements

• #48 Adds support to check if a check package contains any checks or check packages
• #64 Icinga Agent RC versions are no longer used by using latest as version
• #67 Adds support to flush entire Icinga 2 ProgamData directory on uninstallation
• #68 Improves the setup wizard by providing better understandable prompts including examples and various smaller bugfixes
• Console prints are now containing a severity message to better keep an eye on possible warnings/errors
• #69 Improves stability of installation/uninstallation of the Agent by using different PowerShell instances for service and installation/uninstallation handling

Bugfixes

• #61 Fixes duplicate command line entries after wizard completion and escaping of values
• #63 Adds missing port argument for certificate generation requests
• #65 Fixes icinga2.conf file while upgrading from the old PowerShell module to the new framework
• #66 Fixes boolean performance metrics from check plugins by converting them to integer

1.0.2 (2020-04-16)

Issue and PRs

Bugfixes

• Fixes crash on fetching the latest Icinga 2 Agent MSI installer package by ignoring RC versions

1.0.1 (2020-03-18)

Issue and PRs

Bugfixes

• Fixes crash during update of components while no update is available on stable branch
• Fixes handling of LocalSystem service user to prevent the framework from crashing
• Fixes an issue while trying to modify the service user with password on older Windows versions
• Fixes persistent Director Self-Service Key prompt while using unattended installation on a new system
• Fixes service user fetching by using NETBIOS name for non-domain hosts instead of full hostname

1.0.0 (2020-02-19)

Issue and PRs

Breaking changes

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

• New Cmdlets for managing the Agent have been added
• Improved the install wizard to handle errors more intelligent

Bugfixes

• General bugfixes to increase reliability, stability and performance
• Some fixes for configuration rendering for Icinga Director Baskets

1.0.0 RC3 (2019-12-17)

Issue and PRs

Bugfixes

• Fixed wrong URL for stable plugin repository (refered to Framework instead of Plugins)

1.0.0 RC2 (2019-12-13)

Issue and PRs

Enhancements

• Added Cmdlets for managing Self-Service keys
• Added fetching for interface for host address in Icinga Director
• Improved wizard to re-ask on errors

Bugfixes

• Fixed memory leak for background daemon
• Fixed crash on Plugin Repo / Framework update
• Fixed missing NodeName configuration in Icinga Agent config

1.0.0 RC1 (2019-11-04)

Notes

• Removed legacy framework code
• New release for final framework version