Like any other PowerShell module, the installation itself is very simple and straight forward. As of before, there are many ways to deploy a PowerShell module on a Windows host.
Regardless of the method: In order to make this module work properly, you will have to install it into the same folder as your Icinga PowerShell Framework module is installed to.
If you installed the Framework into
you will have to install this module there as well.
General Note on Installation/Updates¶
You should always stick to one way of installing/updating any modules for the Icinga for Windows solution. It is not supported and not recommended to mix installation ways by using
PowerShell Gallery initially and switch to the
Framework Component Installer for example later on.
There might be various side effects by doing so.
One of the simplier ways is to use PowerShell Gallery for the installation. For this we simply run the command
Icinga Framework Component Installer¶
If PowerShell Gallery is no option for you because it is not available or you prefer the installation from GitHub releases directly, you can use the component installer of the Icinga PowerShell Framework which was introduced with
Install latest stable release:
Use-Icinga; Install-IcingaFrameworkComponent -Name apichecks -Release;
Install latest snapshot
Use-Icinga; Install-IcingaFrameworkComponent -Name apichecks -Snapshot;
Custom repository source
Use-Icinga; Install-IcingaFrameworkComponent -Name apichecks -Url 'url to your .zip file';
This could for example be:
Please ensure that the folder name of the module is matching the
.psm1 file name inside the folder.
By downloading the latest master and unzipping it into above mentioned folder, you might end up like this:
.psm1 file is named
icinga-powershell-apichecks.psm1 we will have to rename the folder to look like this:
Once this is done, we might require to unblock the file content to be able to load and execute the module
Get-Content -Path 'C:\Program Files\WindowsPowerShell\Modules\icinga-powershell-apichecks' -Recurse | Unblock-File;
Now we can start a new PowerShell instance and the module should be ready to go. Otherwise we have to import it manually by using
Restart the PowerShell Service¶
Once installed, we are ready to go and can simply restart our Icinga PowerShell daemon.
Afterwards our API endpoint is available and ready.
As we are now ready and our service is restarted, we can start using the API