Skip to content

Commit 183f8dc

Browse files
committed
Improves API forwarder docs
1 parent be29d7d commit 183f8dc

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/110-Installation/30-API-Check-Forwarder.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This will reduce the performance impact on the CPU as well as lower the loading
88

99
To use this feature, you wil require the following
1010

11-
* Icinga Agent is certificates installed
12-
* Icinga for Windows v1.6.0 installed
13-
* [Icinga for Windows Service installed](https://icinga.com/docs/icinga-for-windows/latest/doc/service/01-Install-Service/)
11+
* Icinga Agent certificate installed
12+
* Icinga for Windows v1.6.0 or later installed
13+
* [Icinga for Windows Service installed](05-Background-Daemons.md)
1414
* Icinga for Windows v1.4.0+ CheckCommand configuration applied (**Important:** Update your entire Windows environment to v1.4.0+ before updating the Icinga configuration!)
1515

1616
## Installation with IMC
@@ -22,7 +22,7 @@ In order to install the REST-Api feature, you can simply enable it by using the
2222
* Navigate to `Icinga for Windows Features`
2323
* Toggle the setting `Api-Check Forwarder` by using the menu index entry (besides the feature is mentioned if it is `Enabled` or `Disabled`)
2424

25-
Please note that you will require to have the [Icinga for Windows Service](https://icinga.com/docs/icinga-for-windows/latest/doc/service/01-Install-Service/) already installed. The menu entry will only ensure, that the entire configuration is made and that check commands are enabled as commands.
25+
Please note that you will require to have the [Icinga for Windows Service](05-Background-Daemons.md) already installed. The menu entry will only ensure, that the entire configuration is made and that check commands are enabled as commands.
2626

2727
## Manual Installation and Configuration
2828

@@ -40,7 +40,7 @@ Register-IcingaBackgroundDaemon -Command 'Start-IcingaWindowsRESTApi';
4040

4141
By default, it will start listening on Port `5668` on `localhost` and use the Icinga Agents certificates for TLS encrypted communication. As long as the Windows firewall is not allowing access to this port, external communication is not possible.
4242

43-
To modify any REST-Api arguments, please follow the [REST-Api installation guide](https://icinga.com/docs/icinga-for-windows/latest/restapi/doc/02-Installation/#daemon-registration).
43+
To modify any REST-Api arguments, please follow the [background daemon page](05-Background-Daemons.md).
4444

4545
### Whitelist Check Commands
4646

@@ -78,7 +78,7 @@ Last but not least restart the Icinga for Windows service:
7878
Restart-IcingaWindowsService;
7979
```
8080

81-
As long as the feature is enabled, the Icinga for Windows service is running, the REST-Api daemon is registered and both modules, [icinga-powershell-restapi](https://icinga.com/docs/icinga-for-windows/latest/restapi/doc/01-Introduction/) and [icinga-powershell-apichecks](https://icinga.com/docs/icinga-for-windows/doc/icinga_for_windows_v1.6.0/apichecks/doc/01-Introduction/) are installed, checks will be forwarded to the REST-Api and executed, if whitelisted.
81+
As long as the feature is enabled, the Icinga for Windows service is running and the REST-Api daemon is registered, checks will be forwarded to the REST-Api and executed, if whitelisted.
8282

8383
### Disable Api Check Feature
8484

@@ -105,7 +105,7 @@ Enable-IcingaFrameworkApiChecks;
105105

106106
## EventLog Errors
107107

108-
In case a check could not be executed by using this experimental feature, either because of timeouts or other issues, they are added with `EventId 1553` inside the EventLog for `Icinga for Windows`. A description on why the check could not be executed is added within the event output.
108+
In case a check could not be executed by using this feature, either because of timeouts or other issues, they are added with `EventId 1553` inside the EventLog for `Icinga for Windows`. A description on why the check could not be executed is added within the event output.
109109

110110
## Icinga Communication to API
111111

0 commit comments

Comments
 (0)