icinga-powershell-framework/doc/02-Installation.md

Installing the Icinga PowerShell Framework
===

Installing the Icinga PowerShell Framework is managed by different ways, depending on the user environment including available possibilities.

Get the latest Version from [GitHub](https://github.com/Icinga/icinga-powershell-framework/releases/latest) or [PowerShell Gallery](https://www.powershellgallery.com/packages/icinga-powershell-framework).

Instructions
---

* Install the Icinga PowerShell Framework with the [Kickstart Script](installation/01-Kickstart-Script.md)
* Install the Icinga PowerShell Framework [manually](installation/02-Manual-Installation.md)
* Install the Icinga PowerShell Framework with [PowerShell Gallery](installation/03-PowerShell-Gallery-Installation.md)

Testing the installation
---

Once the Icinga PowerShell Framework is installed you can try if the installation was successfully by using the command

```powershell
Use-Icinga
```

This command will initialize the entire Icinga PowerShell Framework and load all available Cmdlets.

*Note:* Starting with Icinga PowerShell Framework `1.2.0` you can simply use `icinga` to open a Icinga PowerShell Framework shell.

Whenever you intend to use specific Cmdlets of the framework for Icinga Plugins, Testing or configuration you will require to run this command for each new PowerShell instance to initialize the framework.

Icinga Agent installation wizard
---

Once the entire Framework is installed and the module is runnable, you can start the Icinga Agent installation wizard. Please follow the [Icinga Agent Wizard](installation/04-Icinga-Agent-Wizard.md) guide for examples and usage.

Service Installation
---

You can install a service which will allow you to run the PowerShell Framework as background daemon. This will add the possibility to register functions to run frequently for collecting data or execute different tasks on the system.

To install the service you can either follow the `IcingaAgentInstallWizard` or do it [manually](service/01-Install-Service.md)
Improves docs 2020-06-02 06:46:08 -04:00			`Installing the Icinga PowerShell Framework`
Add first draft of new documentation 2019-10-21 09:18:51 -04:00			`===`
Initial commit 2018-11-06 11:14:49 -05:00
Improves documentation 2020-08-22 08:22:37 -04:00			`Installing the Icinga PowerShell Framework is managed by different ways, depending on the user environment including available possibilities.`

			`Get the latest Version from [GitHub](https://github.com/Icinga/icinga-powershell-framework/releases/latest) or [PowerShell Gallery](https://www.powershellgallery.com/packages/icinga-powershell-framework).`
Initial commit 2018-11-06 11:14:49 -05:00
Add first draft of new documentation 2019-10-21 09:18:51 -04:00			`Instructions`
			`---`
Initial commit 2018-11-06 11:14:49 -05:00
Improves docs 2020-06-02 06:46:08 -04:00			`* Install the Icinga PowerShell Framework with the [Kickstart Script](installation/01-Kickstart-Script.md)`
			`* Install the Icinga PowerShell Framework [manually](installation/02-Manual-Installation.md)`
Improves documentation for Framework installation 2020-08-11 11:26:43 -04:00			`* Install the Icinga PowerShell Framework with [PowerShell Gallery](installation/03-PowerShell-Gallery-Installation.md)`
Initial commit 2018-11-06 11:14:49 -05:00
Add first draft of new documentation 2019-10-21 09:18:51 -04:00			`Testing the installation`
			`---`
Initial commit 2018-11-06 11:14:49 -05:00
Improves docs 2020-06-02 06:46:08 -04:00			`Once the Icinga PowerShell Framework is installed you can try if the installation was successfully by using the command`
Initial commit 2018-11-06 11:14:49 -05:00
			```powershell
Add first draft of new documentation 2019-10-21 09:18:51 -04:00			`Use-Icinga`
Initial commit 2018-11-06 11:14:49 -05:00			```

Improves documentation 2020-08-22 08:22:37 -04:00			`This command will initialize the entire Icinga PowerShell Framework and load all available Cmdlets.`
Initial commit 2018-11-06 11:14:49 -05:00
Improves documentation for Framework installation 2020-08-11 11:26:43 -04:00			Note: Starting with Icinga PowerShell Framework `1.2.0` you can simply use `icinga` to open a Icinga PowerShell Framework shell.

Improves documentation 2020-08-22 08:22:37 -04:00			`Whenever you intend to use specific Cmdlets of the framework for Icinga Plugins, Testing or configuration you will require to run this command for each new PowerShell instance to initialize the framework.`
Adds documentation for background daemons and windows service 2020-02-07 12:17:40 -05:00
Improves documentation for Framework installation 2020-08-11 11:26:43 -04:00			`Icinga Agent installation wizard`
			`---`

Fixes broken link in installation docs 2020-08-11 11:29:03 -04:00			`Once the entire Framework is installed and the module is runnable, you can start the Icinga Agent installation wizard. Please follow the [Icinga Agent Wizard](installation/04-Icinga-Agent-Wizard.md) guide for examples and usage.`
Improves documentation for Framework installation 2020-08-11 11:26:43 -04:00
Adds documentation for background daemons and windows service 2020-02-07 12:17:40 -05:00			`Service Installation`
			`---`

			`You can install a service which will allow you to run the PowerShell Framework as background daemon. This will add the possibility to register functions to run frequently for collecting data or execute different tasks on the system.`

			To install the service you can either follow the `IcingaAgentInstallWizard` or do it [manually](service/01-Install-Service.md)