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.13.0 (tbd)¶

Issues and PRs

1.12.3 (2024-04-24)¶

Issues and PRs

Bugfixes¶

#718 Fixes Icinga repository JSON validator to report the correct state of the validation status, in case the JSON is not valid
#722 Fixes leading \ for the service binary path and directory, which results in wrong behavior while using the same shell on which the initial installation was made
#724 Fixes icingaforwindows.pfx creation in case another certutil is installed on the system and being available in the PATH environment
#725 Fixes Icinga for Windows certificate handling by keeping the .pfx file on the system as created, without using the certificate store. Also fixes handling for providing thumbprints for certificates, which are now loaded directly from the certificate store by also providing a new filter mechanic to fetch the proper certificates from the store

1.12.2 (2024-04-10)¶

Issues and PRs

Bugfixes¶

#719 Fixes certificate handling for renewing certificates with the scheduled task background, which could fail on some Windows Server 2022 environments

1.12.1 (2024-04-09)¶

Issues and PRs

Bugfixes¶

#672 Fixes Icinga for Windows REST-Api to fully read client data, even when they client is sending the packets on a very slow basis, preventing the API trying to process an incomplete request
#707 Fixes size of the Icinga for Windows eventlog by setting it to 20MiB, allowing to store more events before they are overwritten
#708 Fixes the order for updating components with Update-Icinga, to ensure the framework is always updated first before all other components
#709 Fixes error handling for Icinga for Windows repositories by providing more details about occurring errors as well as properly checking the JSON-File for the repository and providing more details about JSON errors
#710 Fixes various console errors while running Icinga for Windows outside of an administrative shell
#713 Fixes Icinga for Windows REST-Api which fails during certificate auth handling while running as NT Authority\NetworkService
#714 Fixes missing service environment information during initial setup of Icinga for Windows v1.12 on some systems
#715 Fixes internal scheduled task handling and certificate renewal task by setting the user to LocalSystem instead of any administrative user or group, ensuring compatibility with all Windows versions as well as managing by using WinRM and SSH
#716 Fixes Icinga for Windows certificate creation while using WinRM or SSH for remote connections

1.12.0 (2024-03-26)¶

Issues and PRs

Bugfixes¶

#673 Fixes a memory leak while fetching Windows EventLog information by using CLI tools and inside the Hyper-V provide
#678 Fixes various memory leaks in Icinga for Windows API core and check handler
#680 Fixes exception in some cases, when provider or metrics return values as null instead of 0 while units are being used for check objects
#683 Fixes JEA installer to exclude domain from user name length check, which can easily exceed the Windows 20 digits username limit
#685 Fixes an issue while trying to stop the JEA process in certain cases, which results in an error during installation but has no other effect on the environment
#686 Fixes certutil error handling and message output in case the icingaforwindows.pfx could not be created
#687 Fixes Icinga for Windows port handling on installation, which will now use the proper defined port for communicating with the Icinga CA
#699 Fixes Icinga for Windows password management for the managed user icinga, which could fail in some cases because of ambiguous characters or complexity errors and will now retry up to 10 times before giving up
#702 Fixes an issue with Icinga Director Self-Service API, which ignored the defined service user

Enhancements¶

#313 Adds IWKB entry IWKB000017 handling issues with failed checks once SCOM is uninstalled as example
#587 Adds support to create own snapshot repositories with New-IcingaRepository
#631 Deduplicates -C try { Use-Icinga ... boilerplate by adding it to the PowerShell Base template and removing it from every single command
#669 Adds new metric to the CPU provider, allowing for distinguishing between the average total load as well as the sum of it
#679 Adds a new data provider for fetching process information of Windows systems, while sorting all objects based on a process name and their process id
#682 Adds new data provider for fetching Eventlog information to increase performance and reduce memory impact
#688 Adds new handling to add scheduled tasks in Windows for interacting with Icinga for Windows core functionality as well as an auto renewal task for the Icinga for Windows certificate generation
#690 Adds automatic renewal of the icingaforwindows.pfx certificate for the REST-Api daemon in case the certificate is not yet present, valid or changed during the runtime of the daemon while also making the icingaforwindows.pfx mandatory for all installations, regardless of JEA being used or not
#692 Renames Restart-IcingaWindowsService to Restart-IcingaForWindows and adds alias for backwards compatibility to start unifying the Icinga for Windows cmdlets
#693 Adds new command Restart-Icinga to restart both, the Icinga Agent and Icinga for Windows
#694 Adds support for check objects not being added to summary header
#695 Adds security hardening to JEA profiles by always prohibit certain cmdlets
#700 Adds feature to support using pipes and multi lines for plugin documentation
#701 Adds new command Test-IcingaForWindowsto check the current environment health by also improving internal handlings on how service information are fetched, preventing a lock on those

1.11.1 (2023-11-07)¶

Issues and PRs

Bugfixes¶

#659 Fixes configuration writer which publishes invalid Icinga plain configuration files
#660 Fixes Update-Icinga not updating to the latest available version for a component and specifying -Version is updating to the latest one instead of the given one instead
#661 Fixes Icinga Agent installation and uninstallation, which could cause unintended automatic reboots
#662 Fixes JEA-Profiles always being updated during Update-Icinga calls, even when no component or non JEA related components were updated
#664 Fixes JEA profile compiler not including REST-Api configuration during first installation

1.11.0 (2023-08-01)¶

Issues and PRs

Bugfixes¶

#579 Fixes error message during config generation with Get-IcingaCheckCommandConfig to make it more clear, in case the custom variables generated are too long for the Icinga Director import
#603 Fixes service filter to handle exclude with wildcards instead of requiring the full service name (not applying to the display name)
#609 Fixes config generator to never use set_if = true on Icinga 2/Icinga Director configuration
#611 Fixes Sync-IcingaRepository which did not save the SSH user and host inside the repository configuration, preventing Update-IcingaRepository to work properly and added missing scp progress
#615 Fixes the framework migration tasks which fails in case multiple versions of the framework are installed, printing warnings in case there is
#617 Fixes failing calls for plugins which use a switch argument like -NoPerfData, which is followed directly by the -ThresholdInterval argument
#621 Fixes -ThresholdInterval key detection on newer systems
#634 Fixes an issue with Clear-Host which could cause an exception during certain automation tasks, causing it to fail
#645 Fixes error and exception handling while using API-Checks, which now will in most cases always return a proper check-result object and also abort while running into plugin execution errors, in case a server is not reachable by the time sync plugin for example
#646 Fixes REST-Api to allow arguments for check execution with and without leading -
#648 Fixes some memory management while using the REST-Api to clear connection objects once they are no longer required

Enhancements¶

#544 Adds support to configure the Icinga Director JSON string for registering hosts via self-service API
#572 Adds support to write the name of the repository synced/created into the local ifw.repo.json file
#573 Adds support to run command icinga with new argument -NoNewInstance, to use -RebuildCache as example to update the current PowerShell instance with all applied changes
#613 Adds a -Version parameter to the Update-Icinga command, to be able to update a component to a specified version [@log1-c]
#619 Adds feature to securely read enum provider values with new function Get-IcingaProviderEnumData
#623 Adds support to provide the Icinga service user written as user@domain
#633 Adds support for Icinga 2.14.0 native Icinga for Windows API communication
#635 Adds support for Write-IcingaAgentApiConfig function to configure the Icinga Agent TLS cipher list setting by new argument -CipherList
#637 Adds new base handling for future data providers with first metrics for CPU information
#638 Adds option for formatted, colored console prints with Write-ColoredOutput
#640 Adds support to set the flag -NoSSLValidation for Cmdlets icinga and Install-Icinga, to ignore errors on self-signed certificates within the environment
#643 Adds support for -RebuildCache flag on icinga cmd to rebuild component cache as well
#644 Adds progress bar output to repository interaction (sync, update, new) instead of plain text output
#649 Adds new basic data provider base for Hyper-V information
#655 Adds IWKB and test/manage Cmdlets for SCOM intercept counters
#656 Adds new feature to write document content easier by storing it in memory first and then allowing to write it to disk at once with proper UTF8 encoding

1.10.1 (2022-12-20)¶

Issue and PRs

Bugfixes¶

#578 Fixes installation and uninstallation commands changing PowerShell location even when not necessary
#582 Fixes background service registration caused by migration task for v1.10.0 being executed even when no services were defined before
#588 Fixes threshold values causing an error because of too aggressive regex expression
#599 Fixes plugin argument parser to proceed with real argument names and possible provided aliases

1.10.0 (2022-08-30)¶

Issue and PRs

Deprecated¶

We have decided to now officially deprecate the previous installation method Start-IcingaAgentInstallWizard. It hasn’t been updated or promoted in a long time and all new features have been moved to the Icinga Management Console. Please update your installation method to the new solution. The old method will be removed in a future release.

Bugfixes¶

#473 Fixes an issue with current string rendering config implementation, as string values containing whitespaces or $ are rendered wrong by default, if not set in single quotes ''
#476 Fixes exception You cannot call a method on va null-valued expression during installation in case no background daemon is configured
#482 Fixes encoding problems with special chars or German umlauts during plugin execution and unescaped whitespace in plugin argument strings like Icinga for Windows, which was previously wrongly rended as Icinga for example
#489 Fixes error message This argument does not support the % unit in case a BaseValue is set, but the actual value is 0
#503 Fixes wrong conversion of values for Convert-IcingaPluginThresholds, which did not properly handle string values containing certain units inside the string itself
#505 Fixes certificate generation and host registration, in case a custom hostname was set during usage of Install-Icinga automation
#529 Fixes package manifest reader for Icinga for Windows components on Windows 2012 R2 and older
#523 Fixes errors on encapsulated PowerShell calls for missing Cmdlets Write-IcingaConsoleError and Optimize-IcingaForWindowsMemory
#524 Fixes uninstallation process by improving the location handling of PowerShell instances with Icinga IMC or Shell
#528 Fixes negative thresholds being interpreted wrongly as argument instead of an value for an argument
#545 Fixes RemoteSource being cleared within repository .json files during Update-IcingaRepository tasks
#552 Fixes file encoding for Icinga for Windows v1.10.0 to ensure the cache is always properly created with the correct encoding
#553 Fixes an exception caused by service recovery setting, if the required service was not installed before
#556 Fixes the certificate folder not present during first installation, preventing permissions properly set from the start which might cause issues once required
#562 Fixes corrupt Performance Data, in case plugins were executed inside a JEA context without the REST-Api
#563 Fixes checks like MSSQL using arguments of type SecureString not being usable with the Icinga for Windows REST-Api
#565 Fixes internal cache file writer and reader to store changes inside a .tmp file first and validating the file state and content, before applying it to the actual file to prevent data corruption
#566 Fixes useless testing and printing of error messages, in case the Icinga Agent is not installed during installation and Icinga for Windows printing plenty of errors, because the ACL checks cannot be completed because of the missing Agent
#568 Fixes misleading SID error during uninstallation of Icinga for Windows or the Agent component

Enhancements¶

#40 Adds support to set service recovery for the Icinga Agent and Icinga for Windows service, to restart them in case of a crash or error
#485 Adds new style for performance data labels, to use the multi output format, allowing for better filtering and visualisation with InfluxDB and Grafana
#502 Adds support for hostname override for old installer function Start-IcingaAgentInstallWizard [moreamazingnick]
#525 Adds new developer mode for icinga command and improved cache handling, to ensure within -DeveloperMode and inside a VS Code environment, the framework cache file is never overwritten, while still all functions are loaded and imported.
#531 Adds Test-IcingaStateFile and Repair-IcingaStateFile, which is integrated into Test-IcingaAgent, to ensure the Icinga Agent state file is healthy and not corrupt, causing the Icinga Agent to fail on start
#534 Improves Icinga and Director configuration generator, by wrapping PowerShell arrays inside @() instead of simply writing them comma separated
#536 Adds new function Test-IcingaArrayFilter for easier include and exclude filtering during plugin runtime and to allow filtering of array content for intended values only
#560 Improves handling for Icinga Management Console which will now terminate itself during full uninstallation and restarts after updating the Icinga PowerShell Framework, to apply changes directly
#569 Adds -Include and -Exclude filter for EventLog CLI parser, to only contain certain messages or exclude them from the output

1.9.2 (2022-06-03)¶

Issue and PRs

Bugfixes¶

#529 Fixes package manifest reader for Icinga for Windows components on Windows 2012 R2 and older

1.9.1 (2022-05-13)¶

Issue and PRs

Bugfixes¶

#519 Fixes missing loading of Icinga for Windows modules, which is required to ensure an Icinga for Windows environment is providing all commands and variables to a session, allowing other modules to access these information
#520 Adds missing Import-IcingaPowerShellComponent function while creating new components by using the developer tools

1.9.0 (2022-05-03)¶

Issue and PRs

Bugfixes¶

#472 Fixes random errors while dynamically compiling Add-Type code by now writing a DLL inside cache/dll for later usage
#478 Fixes connection option “Connecting from parent system” which is not asking for ca.crt path
#479 Fixes possible exceptions while trying to remove downloaded repository temp files which might still contain a file lock from virusscanners or other tasks
#480 Fixes service locking during Icinga Agent upgrade and ensures errors on service management are caught and printed with internal error handling
#483 Fixes REST-Api SSL certificate lookup from the Icinga Agent, in case a custom hostname was used or in certain domain environments were domain is not matching DNS domain
#490 Fixes the command Uninstall-IcingaComponent for the service component which is not doing anything
#491 Fixes GC collection with Optimize-IcingaForWindowsMemory for every incoming REST connection call
#497 Fixes loop sleep for idle REST-Api threads by replacing them with BlockingCollection ConcurrentQueue

Enhancements¶

#469 Improves plugin doc generator to allow multi-lines in code examples and updates plugin overview as table, adding a short description on what the plugin is for
#495 Adds feature to check the sign status for the local Icinga Agent certificate and notifying the user, in case the certificate is not yet signed by the Icinga CA
#496 Improves REST-Api default timeout for internal plugin execution calls from 30s to 120s
#498 Adds feature for thread queuing optimisation and frozen thread detection for REST calls
#514 Adds support for Icinga for Windows module isolation

1.8.0 (2022-02-08)¶

Issue and PRs

Bugfixes¶

#273 Fixes exceptions and freezes while using Icinga for Windows within an PowerShell ISE session and informing the user properly about the limitations
#291 Fixes Split-IcingaVersion by returning data with naming mayor for the version instead of major. We will return both results to give developers time to adjust their code before removing the mayor object
#379 Fixes memory leak for Icinga for Windows by using a custom function being more aggressive on memory cleanup
#380 Fixes exception while using Use-Icinga inside the same shell Icinga for Windows is installed for the first time on the system
#394 Fixes lookup time for Icinga managed user for large Active Directory environments by limiting lookup to local system only
#402 Fixes missing address attribute for REST-Api daemon, making it unable to change the listening address
#403 Fixes memory leak on newly EventLog reader for CLI event stream
#407 Removes unnecessary module import inside Invoke-IcingaNamespaceCmdlets
#409 Fixes URL builder for Sync-IcingaRepository which will now properly test the JSON file and try a secondary fallback by pointing to the ifw.repo.json in case a URL is returning the directory listing instead
#411 Fixes Icinga Director error message output because of missing [string]::Format()
#412 Fixes possible defective state of the Icinga Agent by using a custom service user for JEA profiles which is larger than 20 digits
#414 Fixes Service Check Daemon with a total rewrite to improve performance, decrease required resources and fix memory leaks
#418 Fixes crash on wrong variable usage introduced by #411
#421 Fixes experimental state of API Check feature by removing that term and removing the requirement to install icinga-powershell-restapi and icinga-powershell-apichecks
#436 Fixes a lookup error for existing plugin documentation files, which caused files not being generated properly in case a similar name was already present on the system
#439 Moves PerformanceCounter to private space from previous public, which caused some problems
#441 Fixes an exception while loading the Framework, caused by a race condition for missing environment variables which are accessed by some plugins before the Framework is loaded properly
#443 Fixes Get-IcingaServices which returned Unknown for service StartType, in case the -Service argument contained values with wildcard *
#446 Fixes Icinga for Windows progress preference, which sometimes caused UI glitches
#449 Fixes unhandled exception while importing modules during Install-IcingaComponent process, because of possible missing dependencies
#451 Fixes PowerShell being unable to enter JEA context if only the Framework is installed and removes the | from plugin output, in case a JEA error is thrown that check commands are not present
#452 Fixes unhandled true output on the console while running the installer
#454 Fixes JEA catalog compiler and background daemon execution in JEA context
#456 Fixes JEA service error count not resetting itself after a certain amount of time without errors
#458 Fixes Install-IcingaSecurity which should only run in an administrative shell
#459 Fixes Update-Icinga which was not working to downgrade snapshot packages pack to release (NOTE: It can still happen that migrations of the Framework might break your environment. Not recommended in production environments for the Framework component)
#460 Fixes Icinga Agent installation over IMC and Director Self-Service, in case the Self-Service is configured to not install the Icinga Agent or the user manually set Do not install Icinga Agent inside the IMC, which results in most configurations not being applied to the Agent, in case it is already installed
#461 Fixes Add-IcingaRepository which now only overrides the RemotePath by using -Force instead of removing and adding the repository again, causing problems with installation orders over IMC for example
#464 Fixes Icinga for Windows uninstaller which did not remove the service binary for the PowerShell service

Enhancements¶

#388 Improves performance for testing if Add-Type functions have been added, by adding an internal test for newly introduced environment variables within a PowerShell session
#417 Adds support to allow the force creation of Icinga Agent certificates, even when they are already present on the system over Icinga Management Console installation
#427 Moves Icinga for Windows EventLog from Application to a custom log Icinga for Windows, allowing better separation
#438 Adds support for enabling the REST-Api background daemon and the Api-Check feature during the IMC installation wizard on advanced settings, which will be enabled by default
#440 Adds upgrade notification if Icinga for Windows Service binary older than v1.2.0 is used, which will not work with Icinga for Windows v1.8.0 or later
#445 Adds command Repair-IcingaService to repair Icinga Agent service in case it was broken during upgrades, mostly caused by The specified service has been marked for deletion
#448 Adds support to sort arrays without ScriptBlocks
#450 Improves show command Show-IcingaRegisteredServiceChecks, adds new command Show-IcingaRegisteredBackgroundDaemons and extends Show-Icinga by both commands and adds debug and api forwarder features to environment list
#453 Reworks Icinga Management Console menu structure and naming and changes the default behavior of executing icinga to now open the IMC by default and icinga -Shell to open a shell as done previously
#455 Adds support for remote execution plugin check_by_icingaforwindows

1.7.1 (2021-11-11)¶

Issue and PRs

Bugfixes¶

#398 Fixes String.Builder object output, while creating new components by using New-IcingaForWindowsComponent
#399 Fixes repository file hash generator, which now only includes .zip and .msi files, which otherwise turned into invalid hashes because of the repository index file always changing based on the assigned hash
#401 Fixes the repository manager by now using Icinga WebRequests instead of Windows WebRequests, allowing the usage of the internal proxy feature

1.7.0 (2021-11-09)¶

Issue and PRs

Bugfixes¶

#375 Fixes exception on last message printed during Uninstall-IcingaForWindows, because the prior used function is no longer present at this point
#376 Fixes IMC error handling on invalid JSON for installation command/file
#377 Fixes overhead for testing of modules being loaded, which returned invalid path values and wrong exceptions, which was unnecessary in first place
#381 Fixes Repository Hash generator for new repositories, which always returned the same hash regardless of the files inside
#386 Fixes check command config generator for Icinga Director baskets/Icinga 2 conf files, in case we are using a check command with an alias as reference to a new name of a check command
#387 Fixes config generator to use alias names for command arguments/parameters in case available instead of the real name
#390 Fixes threshold interval time conversion by using -ThresholdInterval with values that cause the used TimeSpan object to move from minutes to hours, like 60m and 1h
#395 Fixes -ThresholdInterval data type inside auto generated docs for plugins, which was of type Object, but should be of type String

Enhancements¶

#383 Moves the components REST-Api icinga-powershell-restapi and API-Checks icinga-powershell-apichecks directly into the Framework
#389 Adds developer tools for easier start and management of development custom extensions for Icinga for Windows
#392 Adds support to read logs from Windows EventLog while using Read-IcingaAgentLogFile
#393 Adds generic reader function Read-IcingaWindowsEventLog, allowing to read any EventLog as stream on the console and adds in addition Read-IcingaForWindowsLog for reading Icinga for Windows specific logs
#396 Adds function Publish-IcingaPluginDocumentation from plugins directly into the Framework

1.6.1 (2021-09-15)¶

Issue and PRs

Bugfixes¶

#361 Fixes IMC freeze on Icinga Director Self-Service installation, in case no Agent installation set on Self-Service API config
#362 Fixes repository component installation from file share locations
#363 Fixes unneeded continue for JEA process lookup, in case no JEA pid is present
#365 Fixes Icinga environment corruption on Icinga Agent installation failure
#366 Fixes error handling with Icinga Director over IMC, by printing more detailed and user-friendly error messages
#367 Fixes Icinga Director register state not being saved on overview after registration of Host inside Self-Service API
#368 Fixes repository lookup on local path for ifw.repo.json, in the json file was added to the file path during repository add
#369 Fixes experimental feature warning for API-Check Forwarder feature, which is fully supported since v1.6.0 and replaces it with proper information and link to docs
#371 Fixes wrong indention on Icinga parent host address at IMC configuration summary overview
#373 Fixes repository names with dots (.) by replacing them with -, as otherwise the config parser will fail finding the config object

Enhancements¶

#364 Fixes a long lookup for the user table on environments with a large Active Directory
#370 Fixes misleading IMC summary header, implying installation will start immediately on continue

1.6.0 (2021-09-07)¶

Issue and PRs

Bugfixes¶

#300 Fixes an issue on Boolean to empty String conversion for possible maximum values on check plugins on Windows 2012 R2
#311 Fixes an issue with negative inputs on some scenarios which will cause an exception for checks instead of continuing executing them properly
#317 Fixes certain file names being too long, causing errors on deploying branches
#326 Fixes import for module files, by using the full path to the module now instead of the name only, as files could be placed inside a folder which is not listed inside the $ENV:PSModulePath
#327 Fixes possible exception on first import run for certain systems
#328 Fixes installer while using installation files or the installation command, which did not overwrite default values with custom values
#330 Fixes Remove-ItemSecure which was not using all args and might fail on empty path entries
#332 Fixes Icinga Director Self-Service ticket handling, which was not working within the Icinga Management Console
#335 Fixes Icinga Director Self-Service Zones and CA config for legacy installation wizard
#343 Fixes freeze within Icinga Management Console, in case commands which previously existed were removed/renamed or the user applied an invalid configuration with unknown commands as install file or install command
#345 Fixes Framework environment variables like $IcingaEnums not working with v1.6.0
#351 Fixes file writer which could cause corruption on parallel read/write events on the same file
#359 Fixes Plain Plugin Cmdlet execution on shell

Enhancements¶

#301 Improves error handling to no longer print passwords in case String is used for SecureString arguments
#303 Adds support to parse arrays to Icinga Check thresholds functions like WarnOutOfRange and adds two new functions WarnDateTime and CritDateTime, for easier comparing of time stamps.
#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
#310 Adds repository management to install components very easily from one or multiple defined source locations
#314 Adds support to configure on which address TCP sockets are created on, defaults to loopback interface
#316 The reconfigure menu was previously present inside the Icinga Agent sub-menu and is now moved to the main installation menu for the Management Console
#318 We always enforce the Icinga Framework Code caching now and ship a plain file to build the cache on first loading
#322 Remove legacy import feature from Framework and replace it with a dummy function, as no longer required by Icinga for Windows
#323 Adds -RebuildCache switch to icinga command alias and Invoke-IcingaCommand, for quicker cache re-creation for developers
#333 Adds Cmdlet Test-IcingaForWindowsService to test the Icinga for Windows service configuration
#338 Improves various styles, outputs and view for the Icinga for Windows Management Console and fixes some spelling mistakes
#342 Adds feature to print commands being executed by the Icinga Management Console with l and improves summary visualisation for better readability
#346 Adds support for version names for snapshots
#348 Improves debug output on TCP handling by separating several network messages into multiple messages and by logging the send message to the client
#354 Adds extended Repository management to Icinga Management Console

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 lower 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 (referred 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