Docs: conceal that NSClient++ is bundled on Windows
|
@ -769,9 +769,6 @@ The preferred flavor is `x86_64` for modern Windows systems.
|
||||||
|
|
||||||
The Windows package provides native [monitoring plugin binaries](06-distributed-monitoring.md#distributed-monitoring-windows-plugins)
|
The Windows package provides native [monitoring plugin binaries](06-distributed-monitoring.md#distributed-monitoring-windows-plugins)
|
||||||
to get you started more easily.
|
to get you started more easily.
|
||||||
The installer package also includes the [NSClient++](https://www.nsclient.org/) package
|
|
||||||
to allow using its built-in plugins. You can find more details in
|
|
||||||
[this chapter](06-distributed-monitoring.md#distributed-monitoring-windows-nscp).
|
|
||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
|
@ -830,7 +827,6 @@ Optionally enable the following settings:
|
||||||
Accept commands from master/satellite instance(s) | **Optional.** Whether this node accepts command execution messages from the master node (required for [command endpoint mode](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this is disabled by default.
|
Accept commands from master/satellite instance(s) | **Optional.** Whether this node accepts command execution messages from the master node (required for [command endpoint mode](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this is disabled by default.
|
||||||
Accept config updates from master/satellite instance(s) | **Optional.** Whether this node accepts configuration sync from the master node (required for [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this is disabled by default.
|
Accept config updates from master/satellite instance(s) | **Optional.** Whether this node accepts configuration sync from the master node (required for [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this is disabled by default.
|
||||||
Run Icinga 2 service as this user | **Optional.** Specify a different Windows user. This defaults to `NT AUTHORITY\Network Service` and is required for more privileged service checks.
|
Run Icinga 2 service as this user | **Optional.** Specify a different Windows user. This defaults to `NT AUTHORITY\Network Service` and is required for more privileged service checks.
|
||||||
Install/Update bundled NSClient++ | **Optional.** The Windows installer bundles the NSClient++ installer for additional [plugin checks](06-distributed-monitoring.md#distributed-monitoring-windows-nscp).
|
|
||||||
Disable including local 'conf.d' directory | **Optional.** Allows to disable the `include_recursive "conf.d"` directive except for the `api-users.conf` file in the `icinga2.conf` file. Defaults to `true`.
|
Disable including local 'conf.d' directory | **Optional.** Allows to disable the `include_recursive "conf.d"` directive except for the `api-users.conf` file in the `icinga2.conf` file. Defaults to `true`.
|
||||||
|
|
||||||
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_03.png)
|
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_03.png)
|
||||||
|
@ -840,44 +836,6 @@ Verify the certificate from the master/satellite instance where this node should
|
||||||
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_04.png)
|
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_04.png)
|
||||||
|
|
||||||
|
|
||||||
#### Bundled NSClient++ Setup <a id="distributed-monitoring-setup-agent-windows-nsclient"></a>
|
|
||||||
|
|
||||||
If you have chosen to install/update the NSClient++ package, the Icinga 2 setup wizard asks
|
|
||||||
you to do so.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_01.png)
|
|
||||||
|
|
||||||
Choose the `Generic` setup.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_02.png)
|
|
||||||
|
|
||||||
Choose the `Custom` setup type.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_03.png)
|
|
||||||
|
|
||||||
NSClient++ does not install a sample configuration by default. Change this as shown in the screenshot.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_04.png)
|
|
||||||
|
|
||||||
Generate a secure password and enable the web server module. **Note**: The webserver module is
|
|
||||||
available starting with NSClient++ 0.5.0. Icinga 2 v2.6+ is required which includes this version.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_05.png)
|
|
||||||
|
|
||||||
Finish the installation.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_06.png)
|
|
||||||
|
|
||||||
Open a web browser and navigate to `https://localhost:8443`. Enter the password you've configured
|
|
||||||
during the setup. In case you lost it, look into the `C:\Program Files\NSClient++\nsclient.ini`
|
|
||||||
configuration file.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_07.png)
|
|
||||||
|
|
||||||
The NSClient++ REST API can be used to query metrics. [check_nscp_api](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api)
|
|
||||||
uses this transport method.
|
|
||||||
|
|
||||||
|
|
||||||
#### Finish Windows Agent Setup <a id="distributed-monitoring-setup-agent-windows-finish"></a>
|
#### Finish Windows Agent Setup <a id="distributed-monitoring-setup-agent-windows-finish"></a>
|
||||||
|
|
||||||
Finish the Windows setup wizard.
|
Finish the Windows setup wizard.
|
||||||
|
@ -943,7 +901,6 @@ C:\> Restart-Service icinga2
|
||||||
C:\> Get-Service icinga2
|
C:\> Get-Service icinga2
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
Now that you've successfully installed a Windows agent, please proceed to
|
Now that you've successfully installed a Windows agent, please proceed to
|
||||||
the [detailed configuration modes](06-distributed-monitoring.md#distributed-monitoring-configuration-modes).
|
the [detailed configuration modes](06-distributed-monitoring.md#distributed-monitoring-configuration-modes).
|
||||||
|
|
||||||
|
@ -2790,9 +2747,8 @@ CPU utilization, please use the HTTP API instead of the CLI sample call.
|
||||||
|
|
||||||
#### NSCLient++ with check_nscp_api <a id="distributed-monitoring-windows-nscp-check-api"></a>
|
#### NSCLient++ with check_nscp_api <a id="distributed-monitoring-windows-nscp-check-api"></a>
|
||||||
|
|
||||||
The [Windows setup](06-distributed-monitoring.md#distributed-monitoring-setup-agent-windows) already allows
|
In addition to the Windows plugins you can use the
|
||||||
you to install the NSClient++ package. In addition to the Windows plugins you can
|
[nscp_api command](10-icinga-template-library.md#nscp-check-api) provided by the Icinga Template Library (ITL).
|
||||||
use the [nscp_api command](10-icinga-template-library.md#nscp-check-api) provided by the Icinga Template Library (ITL).
|
|
||||||
|
|
||||||
The initial setup for the NSClient++ API and the required arguments
|
The initial setup for the NSClient++ API and the required arguments
|
||||||
is the described in the ITL chapter for the [nscp_api](10-icinga-template-library.md#nscp-check-api) CheckCommand.
|
is the described in the ITL chapter for the [nscp_api](10-icinga-template-library.md#nscp-check-api) CheckCommand.
|
||||||
|
@ -2902,9 +2858,8 @@ apply Service "nscp-api-" for (svc in host.vars.services) {
|
||||||
|
|
||||||
#### NSCLient++ with nscp-local <a id="distributed-monitoring-windows-nscp-check-local"></a>
|
#### NSCLient++ with nscp-local <a id="distributed-monitoring-windows-nscp-check-local"></a>
|
||||||
|
|
||||||
The [Windows setup](06-distributed-monitoring.md#distributed-monitoring-setup-agent-windows) allows
|
In addition to the Windows plugins you can use the
|
||||||
you to install the bundled NSClient++ package. In addition to the Windows plugins you can
|
[nscp-local commands](10-icinga-template-library.md#nscp-plugin-check-commands)
|
||||||
use the [nscp-local commands](10-icinga-template-library.md#nscp-plugin-check-commands)
|
|
||||||
provided by the Icinga Template Library (ITL).
|
provided by the Icinga Template Library (ITL).
|
||||||
|
|
||||||
Add the following `include` statement on all your nodes (master, satellite, agent):
|
Add the following `include` statement on all your nodes (master, satellite, agent):
|
||||||
|
|
|
@ -47,8 +47,7 @@ Key benefits:
|
||||||
Follow the setup and configuration instructions [here](06-distributed-monitoring.md#distributed-monitoring-setup-agent-satellite).
|
Follow the setup and configuration instructions [here](06-distributed-monitoring.md#distributed-monitoring-setup-agent-satellite).
|
||||||
|
|
||||||
On Windows hosts, the Icinga agent can query a local NSClient++ service
|
On Windows hosts, the Icinga agent can query a local NSClient++ service
|
||||||
for additional checks in case there are no plugins available. The NSCP
|
for additional checks in case there are no plugins available.
|
||||||
installer is bundled with Icinga and can be installed with the setup wizard.
|
|
||||||
|
|
||||||
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_01.png)
|
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_01.png)
|
||||||
|
|
||||||
|
|
|
@ -666,12 +666,6 @@ C:\Program Files\ICINGA2\sbin\icinga2.exe console --eval "dirname(msi_get_compon
|
||||||
If this command does not return anything, NSClient++ is not properly installed.
|
If this command does not return anything, NSClient++ is not properly installed.
|
||||||
Verify that inside the `Programs and Features` (`appwiz.cpl`) control panel.
|
Verify that inside the `Programs and Features` (`appwiz.cpl`) control panel.
|
||||||
|
|
||||||
You can run the bundled NSClient++ installer from the Icinga 2 Windows package.
|
|
||||||
The msi package is located in `C:\Program Files\ICINGA2\sbin`.
|
|
||||||
|
|
||||||
The bundled NSClient++ version has properly been tested with Icinga 2. Keep that
|
|
||||||
in mind when using a different package.
|
|
||||||
|
|
||||||
|
|
||||||
### Check Thresholds Not Applied <a id="check-thresholds-not-applied"></a>
|
### Check Thresholds Not Applied <a id="check-thresholds-not-applied"></a>
|
||||||
|
|
||||||
|
|
Before Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 32 KiB |