mirror of
https://github.com/Icinga/icinga-powershell-framework.git
synced 2025-12-20 23:00:35 -05:00
Merge branch 'master' of https://github.com/LordHepipud/icinga-module-windows
This commit is contained in:
commit
cc519c5d4e
5 changed files with 8 additions and 8 deletions
|
|
@ -4,12 +4,12 @@ Icinga Module for Windows
|
||||||
The Icinga PowerShell Framework provides a wide range of configuration and check possibilities to ensure an easy integration and full monitoring of Windows environments.
|
The Icinga PowerShell Framework provides a wide range of configuration and check possibilities to ensure an easy integration and full monitoring of Windows environments.
|
||||||
Each single chapter of this documentation will describe parts of the module and the possibilities.
|
Each single chapter of this documentation will describe parts of the module and the possibilities.
|
||||||
|
|
||||||
Before you continue, please take a look on the [installation guide](doc/02-Installation.md)
|
Before you continue, please take a look at the [installation guide](doc/02-Installation.md)
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
Please take a look on the following content to get to know the possibilities of the module including examples on how to use it.
|
Please take a look at the following content to get to know the possibilities of the module including examples on how to use it.
|
||||||
|
|
||||||
* [Introduction](doc/01-Introduction.md)
|
* [Introduction](doc/01-Introduction.md)
|
||||||
* [Installation Guide](doc/02-Installation.md)
|
* [Installation Guide](doc/02-Installation.md)
|
||||||
|
|
@ -18,7 +18,7 @@ Please take a look on the following content to get to know the possibilities of
|
||||||
Developer Guide
|
Developer Guide
|
||||||
------------
|
------------
|
||||||
|
|
||||||
If you wish to extend the Framework by yourself or write custom plugins for your environment, please have a look on the [Developer Guide](doc/04-DeveloperGuide.md) for detailed explanations of functions and code examples.
|
If you wish to extend the Framework by yourself or write custom plugins for your environment, please have a look at the [Developer Guide](doc/04-DeveloperGuide.md) for detailed explanations of functions and code examples.
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
|
||||||
|
|
@ -10,4 +10,4 @@ The following requirements have to be fullfilled:
|
||||||
* Windows 7 / Windows 2008 R2 or later
|
* Windows 7 / Windows 2008 R2 or later
|
||||||
* PowerShell Version 4.x or higher
|
* PowerShell Version 4.x or higher
|
||||||
|
|
||||||
If you are ready to get started, take a look on the [installation guide](02-Installation.md).
|
If you are ready to get started, take a look at the [installation guide](02-Installation.md).
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ Of course if you wish to actively send data to Icinga Web 2 for example, you can
|
||||||
Start-Icinga-Checker
|
Start-Icinga-Checker
|
||||||
```
|
```
|
||||||
|
|
||||||
For additional setup possibilities, please take a look on the following pages:
|
For additional setup possibilities, please take a look at the following pages:
|
||||||
|
|
||||||
* [Use the module as Icinga Plugin Framework](12-Icinga2AgentExample.md)
|
* [Use the module as Icinga Plugin Framework](12-Icinga2AgentExample.md)
|
||||||
* [Install the module as Windows Service](10-InstallService.md)
|
* [Install the module as Windows Service](10-InstallService.md)
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ Below you will find a list of functions and detailed descriptions including use
|
||||||
|
|
||||||
The `IcingaCheck` is the basic start point for determining on how a certain value is performing. Checks will provide a bunch of internal commands within the PowerShell Object to analyse a value and get the Icinga result `Ok`, `Warning`, `Critical` including performance metrics.
|
The `IcingaCheck` is the basic start point for determining on how a certain value is performing. Checks will provide a bunch of internal commands within the PowerShell Object to analyse a value and get the Icinga result `Ok`, `Warning`, `Critical` including performance metrics.
|
||||||
|
|
||||||
Checks are always used wihtin Check Plugins to have a standardised method for properly handling the input.
|
Checks are always used within Check Plugins to have a standardised method for properly handling the input.
|
||||||
|
|
||||||
It will be used like in this example:
|
It will be used like in this example:
|
||||||
|
|
||||||
|
|
@ -16,7 +16,7 @@ It will be used like in this example:
|
||||||
$IcingaCheck = New-IcingaCheck -Name 'My Check' -Value 25 -Unit '%';
|
$IcingaCheck = New-IcingaCheck -Name 'My Check' -Value 25 -Unit '%';
|
||||||
```
|
```
|
||||||
|
|
||||||
You will have to provide a `Name` for each check which **must** be unique within each Check Plugin. This will make it easier to differentiate between checks for results. The `Value` is mandatory as this will be the base for each single check to fetch the actual status.
|
You will have to provide a `Name` for each check which **must** be unique within each Check Plugin. This will make it easier to differentiate between checks for results. The `Value` is mandatory as this will be the basis for each single check to fetch the actual status.
|
||||||
|
|
||||||
For performance metrics you can provide a `Unit` to ensure your graphing is displaying values as the should be
|
For performance metrics you can provide a `Unit` to ensure your graphing is displaying values as the should be
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -41,4 +41,4 @@ The prefered way is to simply unblock the script files, allowing them to be exec
|
||||||
Get-ChildItem -Path 'C:\Program Files\WindowsPowershell\Modules\icinga-powershell-framework' -Recurse | Unblock-File
|
Get-ChildItem -Path 'C:\Program Files\WindowsPowershell\Modules\icinga-powershell-framework' -Recurse | Unblock-File
|
||||||
```
|
```
|
||||||
|
|
||||||
Once done, please try again if you are now able to run the module on your host. If you are still not able to run the module and/or its scripts, please have a look on the Microsoft documentation for the [Set-Execution-Policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6) Cmdlet to modify the Execution Policy for running PowerShell modules on your host, matching your internal guidelines.
|
Once done, please try again if you are now able to run the module on your host. If you are still not able to run the module and/or its scripts, please have a look at the Microsoft documentation for the [Set-Execution-Policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6) Cmdlet to modify the Execution Policy for running PowerShell modules on your host, matching your internal guidelines.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue