diff --git a/doc/000-Introduction.md b/doc/000-Introduction.md index 0504969..884ec6c 100644 --- a/doc/000-Introduction.md +++ b/doc/000-Introduction.md @@ -74,12 +74,12 @@ Below you will find a list of currently available modules published by the Icing ### Extensions -| Icinga PowerShell REST-Api | Icinga PowerShell Inventory | Icinga PowerShell Api-Checks | -| --- | --- | --- | -| [![Rest-API](images/02_icons/restapi.png)](https://icinga.com/docs/windows/latest/restapi/doc/01-Introduction/) | [![Inventory](images/02_icons/inventory.png)](https://icinga.com/docs/windows/latest/inventory/doc/01-Introduction/) | [![Frame](images/02_icons/plugins.png)](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) | +| Icinga PowerShell Inventory | +| --- | +| [![Inventory](images/02_icons/inventory.png)](https://icinga.com/docs/windows/latest/inventory/doc/01-Introduction/) | | ### Additional Plugins -| Icinga PowerShell Hyper-V | Icinga PowerShell MSSQL | Icinga PowerShell Cluster | -| --- | --- | --- | -| [![Hyper-V](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/hyperv/doc/01-Introduction/) | [![MSSQL](images/02_icons/mssql.png)](https://icinga.com/docs/windows/latest/mssql/doc/01-Introduction/) | [![Cluster](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/cluster/doc/01-Introduction/) | +| Icinga PowerShell Hyper-V | Icinga PowerShell MSSQL | Icinga PowerShell Cluster | Icinga PowerShell IIS | +| --- | --- | --- | --- | +| [![Hyper-V](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/hyperv/doc/01-Introduction/) | [![MSSQL](images/02_icons/mssql.png)](https://icinga.com/docs/windows/latest/mssql/doc/01-Introduction/) | [![Cluster](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/cluster/doc/01-Introduction/) | [![IIS](images/02_icons/iis.png)](https://icinga.com/docs/icinga-for-windows/latest/iis/doc/01-Introduction/) | diff --git a/doc/100-General/01-Upgrading.md b/doc/100-General/01-Upgrading.md index e1f7697..d090099 100644 --- a/doc/100-General/01-Upgrading.md +++ b/doc/100-General/01-Upgrading.md @@ -91,7 +91,7 @@ Please [contact us](https://icinga.com/company/contact/) in case you require ass ### REST-Api and Api-Checks -With Icinga for Windows v1.7.0, the previously separate available components REST-Api [icinga-powershell-restapi](https://icinga.com/docs/icinga-for-windows/latest/restapi/doc/01-Introduction/) and API-Checks [icinga-powershell-apichecks](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) are now directly baked into the Icinga PowerShell Framework. You will no longer require to install these components in addition. +With Icinga for Windows v1.7.0, the previously separate available components REST-Api (icinga-powershell-restapi) and API-Checks (icinga-powershell-apichecks) are now directly baked into the Icinga PowerShell Framework. You will no longer require to install these components in addition. **Upgrading**: If you previously installed these components, you should remove them from the system before actively using Icinga for Windows v1.7.0, as additional changes were made in this case. diff --git a/doc/100-General/10-Changelog.md b/doc/100-General/10-Changelog.md index 553080f..dbe69bb 100644 --- a/doc/100-General/10-Changelog.md +++ b/doc/100-General/10-Changelog.md @@ -376,7 +376,7 @@ This beta release has reworked the entire handling on how thresholds and the che ### Enhancements -* [#383](https://github.com/Icinga/icinga-powershell-framework/pull/383) Moves the components REST-Api [icinga-powershell-restapi](https://icinga.com/docs/icinga-for-windows/latest/restapi/doc/01-Introduction/) and API-Checks [icinga-powershell-apichecks](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) directly into the Framework +* [#383](https://github.com/Icinga/icinga-powershell-framework/pull/383) Moves the components REST-Api (icinga-powershell-restapi) and API-Checks (icinga-powershell-apichecks) directly into the Framework * [#389](https://github.com/Icinga/icinga-powershell-framework/pull/389) Adds developer tools for easier start and management of development custom extensions for Icinga for Windows * [#392](https://github.com/Icinga/icinga-powershell-framework/pull/392) Adds support to read logs from Windows EventLog while using `Read-IcingaAgentLogFile` * [#393](https://github.com/Icinga/icinga-powershell-framework/pull/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 diff --git a/doc/110-Installation/30-API-Check-Forwarder.md b/doc/110-Installation/30-API-Check-Forwarder.md index 079afa6..23db7fc 100644 --- a/doc/110-Installation/30-API-Check-Forwarder.md +++ b/doc/110-Installation/30-API-Check-Forwarder.md @@ -97,10 +97,9 @@ For quick installation, here the list of commands to get everything running: ```powershell Register-IcingaBackgroundDaemon -Command 'Start-IcingaWindowsRESTApi'; Add-IcingaRESTApiCommand -Command 'Invoke-IcingaCheck*' -Endpoint 'apichecks'; +Enable-IcingaFrameworkApiChecks; Restart-IcingaForWindows; - -Enable-IcingaFrameworkApiChecks; ``` ## EventLog Errors diff --git a/doc/900-Developer-Guide/12-Custom-API-Endpoints.md b/doc/900-Developer-Guide/12-Custom-API-Endpoints.md index 66a81bd..5f62fde 100644 --- a/doc/900-Developer-Guide/12-Custom-API-Endpoints.md +++ b/doc/900-Developer-Guide/12-Custom-API-Endpoints.md @@ -1,6 +1,6 @@ # Developer Guide: Custom API-Endpoints -Starting with Icinga [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) plenty of features and functionality have been added for shipping data by using a REST-API. This Developer Guide will describe on how to write custom API endpoints by using the [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) and the [Icinga PowerShell REST-Api](https://icinga.com/docs/windows/latest/restapi/doc/01-Introduction/). In this example we will write a custom endpoint to simply provide a file list for a specific folder. +Starting with Icinga [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) plenty of features and functionality have been added for shipping data by using a REST-API. This Developer Guide will describe on how to write custom API endpoints by using the [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) and [REST-Api listener](../110-Installation/30-API-Check-Forwarder.md). In this example we will write a custom endpoint to simply provide a file list for a specific folder. ## File Structure diff --git a/doc/images/02_icons/iis.png b/doc/images/02_icons/iis.png new file mode 100644 index 0000000..4db2fe6 Binary files /dev/null and b/doc/images/02_icons/iis.png differ diff --git a/lib/core/tools/Get-IcingaCheckCommandConfig.psm1 b/lib/core/tools/Get-IcingaCheckCommandConfig.psm1 index c558b4f..8d0f672 100644 --- a/lib/core/tools/Get-IcingaCheckCommandConfig.psm1 +++ b/lib/core/tools/Get-IcingaCheckCommandConfig.psm1 @@ -172,7 +172,7 @@ function Get-IcingaCheckCommandConfig() $ThresholdIntervalArg | Add-Member -MemberType NoteProperty -Name 'Name' -Value 'ThresholdInterval'; $ThresholdIntervalArg | Add-Member -MemberType NoteProperty -Name 'required' -Value $FALSE; $ThresholdIntervalArg.type | Add-Member -MemberType NoteProperty -Name 'name' -Value 'String'; - $ThresholdIntervalArg.Description | Add-Member -MemberType NoteProperty -Name 'Text' -Value 'Change the value your defined threshold checks against from the current value to a collected time threshold of the Icinga for Windows daemon, as described here: https://icinga.com/docs/icinga-for-windows/latest/doc/service/10-Register-Service-Checks/ An example for this argument would be 1m or 15m which will use the average of 1m or 15m for monitoring.'; + $ThresholdIntervalArg.Description | Add-Member -MemberType NoteProperty -Name 'Text' -Value 'Change the value your defined threshold checks against from the current value to a collected time threshold of the Icinga for Windows daemon, as described here: https://icinga.com/docs/icinga-for-windows/latest/doc/110-Installation/06-Collect-Metrics-over-Time/ An example for this argument would be 1m or 15m which will use the average of 1m or 15m for monitoring.'; # Loop through ${CheckName}, to get information on every command specified/all commands. foreach ($check in $CheckName) {