Skip to content

Installation

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

C:\Program Files\WindowsPowerShell\Modules\

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

Install-Module 'icinga-powershell-plugins';

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 v1.1.0:

Install latest stable release:

Use-Icinga;
Install-IcingaFrameworkComponent -Name plugins -Release;

Install latest snapshot

Use-Icinga;
Install-IcingaFrameworkComponent -Name plugins -Snapshot;

Custom repository source

Use-Icinga;
Install-IcingaFrameworkComponent -Name plugins -Url 'url to your .zip file';

Manual Installation

For manual installation either download the latest release .zip or the latest master .zip and extract the content into the correct PowerShell modules folder.

This could for example be:

C:\Program Files\WindowsPowerShell\Modules

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:

C:\Program Files\WindowsPowerShell\Modules\icinga-powershell-plugins-master

As our .psm1 file is named icinga-powershell-plugins.psm1 we will have to rename the folder to look like this:

C:\Program Files\WindowsPowerShell\Modules\icinga-powershell-plugins

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-plugins' -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

Import-Module 'icinga-powershell-plugins';

Using the Plugins

To make use of plugins for testing locally, you will have to initialise the entire Framework by using the command

Use-Icinga

Once executed, the plugins are automatically loaded and available within our current PowerShell session.