1 # <a id="icinga2-client"></a> Icinga 2 Client
3 ## <a id="icinga2-client-introduction"></a> Introduction
5 Icinga 2 uses its own unique and secure communitication protol amongst instances.
6 Be it an High-Availability cluster setup, distributed load-balanced setup or just a single
7 agent [monitoring a remote client](11-icinga2-client.md#icinga2-client).
9 All communication is secured by TLS with certificates, and fully supports IPv4 and IPv6.
11 If you are planning to use the native Icinga 2 cluster feature for distributed
12 monitoring and high-availability, please continue reading in
13 [this chapter](distributed-monitoring-high-availability).
17 > Don't panic - there are CLI commands available, including setup wizards for easy installation
18 > with SSL certificates.
19 > If you prefer to use your own CA (for example Puppet) you can do that as well.
22 ## <a id="icinga2-client-scenarios"></a> Client Scenarios
24 * Clients with [local configuration](11-icinga2-client.md#icinga2-client-configuration-local), sending their inventory to the master
25 * Clients as [command execution bridge](11-icinga2-client.md#icinga2-client-configuration-command-bridge) without local configuration
26 * Clients receive their configuration from the master ([Cluster config sync](11-icinga2-client.md#icinga2-client-configuration-master-config-sync))
28 Keep the [naming convention](13-distributed-monitoring-ha.md#cluster-naming-convention) for nodes in mind.
32 > If you're looking for troubleshooting clients problems, check the general
33 > [cluster troubleshooting](17-troubleshooting.md#troubleshooting-cluster) section.
35 ### <a id="icinga2-client-configuration-combined-scenarios"></a> Combined Client Scenarios
37 If your setup consists of remote clients with local configuration but also command execution bridges
38 and probably syncing global templates through the cluster config sync, you should take a deep
39 breath and take pen and paper to draw your design before starting over.
41 Keep the following hints in mind:
43 * You can blacklist remote nodes entirely. They are then ignored on `node update-config`
45 * Your remote instance can have local configuration **and** act as remote command execution bridge.
46 * You can use the `global` cluster zones to sync check commands, templates, etc to your remote clients.
47 Be it just for command execution or for helping the local configuration.
48 * If your remote clients shouldn't have local configuration, remove `conf.d` inclusion from `icinga2`
49 and simply use the cluster configuration sync.
50 * `accept_config` and `accept_commands` are disabled by default in the `api` feature
52 If you are planning to use the Icinga 2 client inside a distributed setup, refer to
53 [this chapter](13-distributed-monitoring-ha.md#cluster-scenarios-master-satellite-clients) with detailed instructions.
56 ## <a id="icinga2-client-installation"></a> Installation
58 ### <a id="icinga2-client-installation-firewall"></a> Configure the Firewall
60 Icinga 2 master, satellite and client instances communicate using the default tcp
63 Communication between zones requires one of these connection directions:
65 * The parent zone nodes are able to connect to the child zone nodes (`parent => child`).
66 * The child zone nodes are able to connect to the parent zone nodes (`parent <= child`).
67 * Both connnection directions work.
69 If you are going to use CSR-Autosigning, you must (temporarly) allow the client
70 connecting to the master instance and open the firewall port. Once the client install is done,
71 you can close the port and use a different communication direction (master-to-client).
73 In case of a [multiple hierarchy setup](13-distributed-monitoring-ha.md#cluster-scenarios-master-satellite-clients)
74 (master, satellite, client) you will need to manually deploy your [client certificates](11-icinga2-client.md#certificates-manual-creation)
75 and zone configuration.
77 ### <a id="icinga2-client-installation-master-setup"></a> Setup the Master for Remote Clients
79 If you are planning to use the [remote Icinga 2 clients](11-icinga2-client.md#icinga2-client)
80 you'll first need to update your master setup.
82 Your master setup requires the following
84 * SSL CA and signed certificate for the master
85 * Enabled API feature, and a local Endpoint and Zone object configuration
86 * Firewall ACLs for the communication port (default 5665)
88 You can use the [CLI command](8-cli-commands.md#cli-command-node) `node wizard` for setting up a new node
89 on the master. The command must be run as root, all Icinga 2 specific files
90 will be updated to the icinga user the daemon is running as (certificate files
93 Make sure to answer the first question with `n` (no).
95 nbmif /etc/icinga2 # icinga2 node wizard
96 Welcome to the Icinga 2 Setup Wizard!
98 We'll guide you through all required configuration details.
100 Please specify if this is a satellite setup ('n' installs a master setup) [Y/n]: n
101 Starting the Master setup routine...
102 Please specifiy the common name (CN) [icinga2-node1.localdomain]:
103 Checking the 'api' feature...
104 'api' feature not enabled, running 'api setup' now.
105 information/cli: Generating new CA.
107 information/base: Writing private key to '/var/lib/icinga2/ca/ca.key'.
108 information/base: Writing X509 certificate to '/var/lib/icinga2/ca/ca.crt'.
109 information/cli: Initializing serial file in '/var/lib/icinga2/ca/serial.txt'.
110 information/cli: Generating new CSR in '/etc/icinga2/pki/icinga2-node1.localdomain.csr'.
112 information/base: Writing private key to '/etc/icinga2/pki/icinga2-node1.localdomain.key'.
113 information/base: Writing certificate signing request to '/etc/icinga2/pki/icinga2-node1.localdomain.csr'.
114 information/cli: Signing CSR with CA and writing certificate to '/etc/icinga2/pki/icinga2-node1.localdomain.crt'.
116 information/cli: Copying CA certificate to '/etc/icinga2/pki/ca.crt'.
118 information/cli: Adding new ApiUser 'root' in '/etc/icinga2/conf.d/api-users.conf'.
120 information/cli: Enabling the ApiListener feature.
122 Enabling feature api. Make sure to restart Icinga 2 for these changes to take effect.
123 information/cli: Dumping config items to file '/etc/icinga2/zones.conf'.
124 Please specify the API bind host/port (optional):
127 information/cli: Updating constants.conf.
128 information/cli: Updating constants file '/etc/icinga2/constants.conf'.
129 information/cli: Updating constants file '/etc/icinga2/constants.conf'.
132 Now restart your Icinga 2 daemon to finish the installation!
135 The setup wizard will do the following:
137 * Check if the `api` feature is already enabled, and if not:
138 * Generate a local CA in `/var/lib/icinga2/ca` or use the existing one
139 * Generate a new CSR, sign it with the local CA and copying it into `/etc/icinga2/pki`
140 * Enabling the API feature, and setting optional `bind_host` and `bind_port`
141 * Generate a local zone and endpoint configuration for this master based on FQDN
142 * Setting the `NodeName` and `TicketSalt` constants in [constants.conf](4-configuring-icinga-2.md#constants-conf)
144 The setup wizard does not automatically restart Icinga 2.
146 Verify the modified configuration:
148 # egrep 'NodeName|TicketSalt' /etc/icinga2/constants.conf
150 # cat /etc/icinga2/zones.conf
152 * Generated by Icinga 2 node setup commands
153 * on 2015-02-09 15:21:49 +0100
156 object Endpoint "icinga2-node1.localdomain" {
159 object Zone "master" {
160 //this is the local node master named = "master"
161 endpoints = [ "icinga2-node1.localdomain" ]
164 Validate the configuration and restart Icinga 2.
169 > This setup wizard will install a standalone master, HA cluster scenarios are currently
170 > not supported and require manual modifications afterwards.
172 ## <a id="icinga2-client-setup"></a> Client Setup for Remote Monitoring
174 Icinga 2 can be installed on Linux/Unix and Windows. While
175 [Linux/Unix](11-icinga2-client.md#icinga2-client-installation-client-setup-linux) will be using the [CLI command](8-cli-commands.md#cli-command-node)
176 `node wizard` for a guided setup, you will need to use the
177 graphical installer for Windows based client setup.
179 Your client setup requires the following
181 * A ready configured and installed [master node](11-icinga2-client.md#icinga2-client-installation-master-setup)
182 * SSL signed certificate for communication with the master (Use [CSR auto-signing](11-icinga2-client.md#csr-autosigning-requirements)).
183 * Enabled API feature, and a local Endpoint and Zone object configuration
184 * Firewall ACLs for the communication port (default 5665)
188 ### <a id="csr-autosigning-requirements"></a> Requirements for CSR Auto-Signing
190 If your remote clients are capable of connecting to the central master, Icinga 2
191 supports CSR auto-signing.
193 First you'll need to define a secure ticket salt in the [constants.conf](4-configuring-icinga-2.md#constants-conf).
194 The [setup wizard for the master setup](11-icinga2-client.md#icinga2-client-installation-master-setup) will create
199 > **Never** expose the ticket salt to your clients. This is the master's private key
200 > and must remain on the master providing the CSR Auto-Signing functionality for security reasons.
202 The client setup wizard will ask you to generate a valid ticket number using its CN.
203 If you already know your remote client's Common Names (CNs) - usually the FQDN - you
204 can generate all ticket numbers on-demand.
206 This is also reasonable if you are not capable of installing the remote client, but
207 a colleague of yours, or a customer.
209 Example for a client:
211 # icinga2 pki ticket --cn icinga2-node2.localdomain
214 ### <a id="certificates-manual-creation"></a> Manual SSL Certificate Generation
216 This is described separately in the [cluster setup chapter](13-distributed-monitoring-ha.md#manual-certificate-generation).
220 > If you're using [CSR Auto-Signing](11-icinga2-client.md#csr-autosigning-requirements), skip this step.
223 ### <a id="icinga2-client-installation-client-setup-linux"></a> Setup the Client on Linux
225 There is no extra client binary or package required. Install Icinga 2 from your distribution's package
226 repository as described in the general [installation instructions](2-getting-started.md#setting-up-icinga2).
228 Please make sure that either [CSR Auto-Signing](11-icinga2-client.md#csr-autosigning-requirements) requirements
229 are fulfilled, or that you're using [manual SSL certificate generation](13-distributed-monitoring-ha.md#manual-certificate-generation).
233 > You don't need any features (DB IDO, Livestatus) or user interfaces on the remote client.
234 > Install them only if you're planning to use them.
236 Once the package installation succeeded, use the `node wizard` CLI command to install
237 a new Icinga 2 node as client setup.
239 You'll need the following configuration details:
241 * The client common name (CN). Defaults to FQDN.
242 * The client's local zone name. Defaults to FQDN.
243 * The master endpoint name. Look into your master setup `zones.conf` file for the proper name.
244 * The master endpoint connection information. Your master's IP address and port (port defaults to 5665)
245 * The [request ticket number](11-icinga2-client.md#csr-autosigning-requirements) generated on your master
247 * Bind host/port for the Api feature (optional)
249 The command must be run as root, all Icinga 2 specific files will be updated to the icinga
250 user the daemon is running as (certificate files for example). The wizard creates backups
251 of configuration and certificate files if already existing.
253 Capitalized options in square brackets (e.g. `[Y/n]`) signal the default value and
254 allow you to continue pressing `Enter` instead of entering a value.
256 # icinga2 node wizard
257 Welcome to the Icinga 2 Setup Wizard!
258 We'll guide you through all required configuration details.
260 Please specify if this is a satellite setup ('n' installs a master setup) [Y/n]:
261 Starting the Node setup routine...
262 Please specifiy the common name (CN) [icinga2-node2.localdomain]:
263 Please specifiy the local zone name [icinga2-node2.localdomain]:
264 Please specify the master endpoint(s) this node should connect to:
265 Master Common Name (CN from your master setup): icinga2-node1.localdomain
266 Please fill out the master connection information:
267 Master endpoint host (optional, your master's IP address or FQDN): 192.168.56.101
268 Master endpoint port (optional) []:
269 Add more master endpoints? [y/N]
270 Please specify the master connection for CSR auto-signing (defaults to master endpoint host):
271 Host [192.168.56.101]:
273 information/base: Writing private key to '/etc/icinga2/pki/icinga2-node2.localdomain.key'.
274 information/base: Writing X509 certificate to '/etc/icinga2/pki/icinga2-node2.localdomain.crt'.
275 information/cli: Generating self-signed certifiate:
276 information/cli: Fetching public certificate from master (192.168.56.101, 5665):
278 information/cli: Writing trusted certificate to file '/etc/icinga2/pki/trusted-master.crt'.
279 information/cli: Stored trusted master certificate in '/etc/icinga2/pki/trusted-master.crt'.
281 Please specify the request ticket generated on your Icinga 2 master.
282 (Hint: # icinga2 pki ticket --cn 'icinga2-node2.localdomain'): ead2d570e18c78abf285d6b85524970a0f69c22d
283 information/cli: Processing self-signed certificate request. Ticket 'ead2d570e18c78abf285d6b85524970a0f69c22d'.
285 information/cli: Writing signed certificate to file '/etc/icinga2/pki/icinga2-node2.localdomain.crt'.
286 information/cli: Writing CA certificate to file '/etc/icinga2/pki/ca.crt'.
287 Please specify the API bind host/port (optional):
290 information/cli: Disabling the Notification feature.
291 Disabling feature notification. Make sure to restart Icinga 2 for these changes to take effect.
292 information/cli: Enabling the Apilistener feature.
293 Enabling feature api. Make sure to restart Icinga 2 for these changes to take effect.
294 information/cli: Created backup file '/etc/icinga2/features-available/api.conf.orig'.
295 information/cli: Generating local zones.conf.
296 information/cli: Dumping config items to file '/etc/icinga2/zones.conf'.
297 information/cli: Created backup file '/etc/icinga2/zones.conf.orig'.
298 information/cli: Updating constants.conf.
299 information/cli: Created backup file '/etc/icinga2/constants.conf.orig'.
300 information/cli: Updating constants file '/etc/icinga2/constants.conf'.
301 information/cli: Updating constants file '/etc/icinga2/constants.conf'.
304 Now restart your Icinga 2 daemon to finish the installation!
307 The setup wizard will do the following:
309 * Generate a new self-signed certificate and copy it into `/etc/icinga2/pki`
310 * Store the master's certificate as trusted certificate for requesting a new signed certificate
311 (manual step when using `node setup`).
312 * Request a new signed certificate from the master and store updated certificate and master CA in `/etc/icinga2/pki`
313 * Generate a local zone and endpoint configuration for this client and the provided master information
315 * Disabling the `notification` feature for this client
316 * Enabling the `api` feature, and setting optional `bind_host` and `bind_port`
317 * Setting the `NodeName` constant in [constants.conf](4-configuring-icinga-2.md#constants-conf)
319 The setup wizard does not automatically restart Icinga 2.
321 Verify the modified configuration:
323 # grep 'NodeName' /etc/icinga2/constants.conf
325 # cat /etc/icinga2/zones.conf
327 * Generated by Icinga 2 node setup commands
328 * on 2015-02-09 16:56:10 +0100
331 object Endpoint "icinga2-node1.localdomain" {
332 host = "192.168.56.101"
335 object Zone "master" {
336 endpoints = [ "icinga2-node1.localdomain" ]
339 object Endpoint "icinga2-node2.localdomain" {
342 object Zone "icinga2-node2.localdomain" {
343 //this is the local node = "icinga2-node2.localdomain"
344 endpoints = [ "icinga2-node2.localdomain" ]
348 Validate the configuration and restart Icinga 2.
350 If you are getting an error when requesting the ticket number, please check the following:
352 * Can your client connect to the master instance?
353 * Is the CN the same (from pki ticket on the master and setup node on the client)?
354 * Is the ticket expired?
358 #### <a id="icinga2-client-installation-client-setup-linux-manual"></a> Manual Setup without Wizard
360 Instead of using the `node wizard` cli command, there is an alternative `node setup`
361 cli command available which has some pre-requisites. Make sure that the
362 `/etc/icinga2/pki` exists and is owned by the `icinga` user (or the user Icinga 2 is
365 `icinga2-node1.localdomain` is the already installed master instance while
366 `icinga2-node2.localdomain` is the instance where the installation cli commands
369 Required information:
371 * The client common name (CN). Use the FQDN, e.g. `icinga2-node2.localdomain`.
372 * The master host and zone name. Pass that to `pki save-cert` as `--host` parameter for example.
373 * The client ticket number generated on the master (`icinga2 pki ticket --cn icinga2-node2.localdomain`)
375 Generate a new local self-signed certificate.
377 # icinga2 pki new-cert --cn icinga2-node2.localdomain \
378 --key /etc/icinga2/pki/icinga2-node2.localdomain.key \
379 --cert /etc/icinga2/pki/icinga2-node2.localdomain.crt
381 Request the master certificate from the master host (`icinga2-node1.localdomain`)
382 and store it as `trusted-master.crt`. Review it and continue.
384 # icinga2 pki save-cert --key /etc/icinga2/pki/icinga2-node2.localdomain.key \
385 --cert /etc/icinga2/pki/icinga2-node2.localdomain.crt \
386 --trustedcert /etc/icinga2/pki/trusted-master.crt \
387 --host icinga2-node1.localdomain
389 Send the self-signed certificate to the master host using the ticket number and
390 receive a CA signed certificate and the master's `ca.crt` certificate.
391 Specify the path to the previously stored trusted master certificate.
393 # icinga2 pki request --host icinga2-node1.localdomain \
395 --ticket ead2d570e18c78abf285d6b85524970a0f69c22d \
396 --key /etc/icinga2/pki/icinga2-node2.localdomain.key \
397 --cert /etc/icinga2/pki/icinga2-node2.localdomain.crt \
398 --trustedcert /etc/icinga2/pki/trusted-master.crt \
399 --ca /etc/icinga2/pki/ca.crt
401 Continue with the additional node setup steps. Specify a local endpoint and zone name (`icinga2-node2.localdomain`)
402 and set the master host (`icinga2-node1.localdomain`) as parent zone configuration. Specify the path to
403 the previously stored trusted master certificate.
405 # icinga2 node setup --ticket ead2d570e18c78abf285d6b85524970a0f69c22d \
406 --endpoint icinga2-node1.localdomain \
407 --zone icinga2-node2.localdomain \
408 --master_host icinga2-node1.localdomain \
409 --trustedcert /etc/icinga2/pki/trusted-master.crt
411 Restart Icinga 2 once complete.
413 # service icinga2 restart
416 ### <a id="icinga2-client-installation-client-setup-windows"></a> Setup the Client on Windows
418 Download the MSI-Installer package from [http://packages.icinga.org/windows/](http://packages.icinga.org/windows/).
421 * Windows Vista/Server 2008 or higher
422 * [Microsoft .NET Framework 2.0](http://www.microsoft.com/de-de/download/details.aspx?id=1639) if not already installed.
424 The setup wizard will install Icinga 2 and then continue with SSL certificate generation,
425 CSR-Autosigning and configuration setup.
427 You'll need the following configuration details:
429 * The client common name (CN). Defaults to FQDN.
430 * The client's local zone name. Defaults to FQDN.
431 * The master endpoint name. Look into your master setup `zones.conf` file for the proper name.
432 * The master endpoint connection information. Your master's IP address and port (defaults to 5665)
433 * The [request ticket number](11-icinga2-client.md#csr-autosigning-requirements) generated on your master
435 * Bind host/port for the Api feature (optional)
437 Once install is done, Icinga 2 is automatically started as a Windows service.
439 The Icinga 2 configuration is located inside the installation path and can be edited with
440 your favorite editor.
442 Configuration validation is done similar to the linux pendant on the Windows shell:
444 C:> icinga2.exe daemon -C
449 ## <a id="icinga2-client-configuration-modes"></a> Client Configuration Modes
451 * Clients with [local configuration](11-icinga2-client.md#icinga2-client-configuration-local), sending their inventory to the master
452 * Clients as [command execution bridge](11-icinga2-client.md#icinga2-client-configuration-command-bridge) without local configuration
453 * Clients receive their configuration from the master ([Cluster config sync](11-icinga2-client.md#icinga2-client-configuration-master-config-sync))
455 ### <a id="icinga2-client-configuration-local"></a> Clients with Local Configuration
457 This is considered as independant satellite using a local scheduler, configuration
458 and the possibility to add Icinga 2 features on demand.
460 There is no difference in the configuration syntax on clients to any other Icinga 2 installation.
461 You can also use additional features like notifications directly on the remote client, if you are
462 required to. Basically everything a single Icinga 2 instance provides by default.
464 The following convention applies to remote clients:
466 * The hostname in the default host object should be the same as the Common Name (CN) used for SSL setup
467 * Add new services and check commands locally
469 Local configured checks are transferred to the central master. There are additional `node`
470 cli commands available which allow you to list/add/remove/blacklist remote clients and
471 generate the configuration on the master.
474 #### <a id="icinga2-remote-monitoring-master-discovery"></a> Discover Client Services on the Master
476 Icinga 2 clients will sync their locally defined objects to the defined master node. That way you can
477 list, add, filter and remove nodes based on their `node`, `zone`, `host` or `service` name.
479 List all discovered nodes (satellites, agents) and their hosts/services:
482 Node 'icinga2-node2.localdomain' (last seen: Mon Feb 9 16:58:21 2015)
483 * Host 'icinga2-node2.localdomain'
496 Listing the node and its host(s) and service(s) does not modify the master configuration yet. You
497 need to generate the configuration in the next step.
500 ### <a id="icinga2-client-master-discovery-generate-config"></a> Generate Configuration for Client Services on the Master
502 There is a dedicated Icinga 2 CLI command for updating the client services on the master,
503 generating all required configuration.
505 # icinga2 node update-config
507 The generated configuration of all nodes is stored in the `repository.d/` directory.
509 By default, the following additional configuration is generated:
510 * add `Endpoint` and `Zone` objects for the newly added node
511 * add `cluster-zone` health check for the master host for reachability and dependencies
512 * use the default templates `satellite-host` and `satellite-service` defined in `/etc/icinga2/conf.d/satellite.conf`
513 * apply a dependency for all other hosts on the remote satellite prevening failure checks/notifications
515 If hosts or services disappeared from the client discovery, it will remove the existing configuration objects
516 from the config repository. If there are existing hosts/services defined or modified, the CLI command will not
517 overwrite these (modified) configuration files.
519 After updating the configuration repository, make sure to reload Icinga 2.
521 # service icinga2 reload
524 # systemctl reload icinga2
527 The `update-config` CLI command will fail, if there are uncommitted changes for the
528 configuration repository.
529 Please review these changes manually, or clear the commit and try again. This is a
530 safety hook to prevent unwanted manual changes to be committed by a updating the
531 client discovered objects only.
533 # icinga2 repository commit --simulate
534 # icinga2 repository clear-changes
535 # icinga2 repository commit
538 ### <a id="icinga2-client-configuration-command-bridge"></a> Clients as Command Execution Bridge
540 Similar to other addons (NRPE, NSClient++, etc) the remote Icinga 2 client will only
541 execute commands the master instance is sending. There are no local host or service
542 objects configured, only the check command definitions must be configured.
546 > Remote clients must explicitely accept commands in a similar
547 > fashion as cluster nodes [accept configuration](13-distributed-monitoring-ha.md#cluster-zone-config-sync).
548 > This is due to security reasons.
550 Edit the `api` feature configuration in `/etc/icinga2/features-enabled/api.conf` on your client
551 and set `accept_commands` to `true`.
553 object ApiListener "api" {
554 cert_path = SysconfDir + "/icinga2/pki/" + NodeName + ".crt"
555 key_path = SysconfDir + "/icinga2/pki/" + NodeName + ".key"
556 ca_path = SysconfDir + "/icinga2/pki/ca.crt"
557 accept_commands = true
560 Icinga 2 on the remote client does not schedule checks locally, or keep checking
561 hosts/services on connection loss. This mode also does not allow to use features
562 for backend data writing (DB IDO, Perfdata, etc.) as the client does not have
563 local objects configured.
565 Icinga 2 already provides a variety of `CheckCommand` definitions using the Plugin
566 Check Commands, but you should also modify the local configuration inside `commands.conf`
569 If you're wondering why you need to keep the same command configuration on the master and
570 remote client: Icinga 2 calculates all required runtime macros used as command arguments on
571 the master and sends that information to the client.
572 In case you want to limit command arguments or handles values in a different manner, you
573 can modify the check command configuration on the remote client only. See [this issue](https://dev.icinga.org/issues/8221#note-3)
576 ### <a id="icinga2-client-configuration-command-bridge-master-config"></a> Master Configuration for Clients as Command Execution Bridge
578 This step involves little knowledge about the way the Icinga 2 nodes communication and trust
579 each other. Each client is configured as `Endpoint` object providing connection information.
580 As a matter of trust the client `Endpoint` is a member of its own `Zone` object which gets
581 the master zone configured as parent. That way the master knows how to connect to the client
582 and where to execute the check commands.
584 Add an `Endpoint` and `Zone` configuration object for the remote client
585 in `/etc/icinga2/zones.conf` and define a trusted master zone as `parent`.
587 object Endpoint "icinga2-node2.localdomain" {
588 host = "192.168.56.102"
591 object Zone "icinga2-node2.localdomain" {
593 endpoints = [ "icinga2-node2.localdomain" ]
597 * [configure endpoints](13-distributed-monitoring-ha.md#configure-cluster-endpoints)
598 * [configure zones](13-distributed-monitoring-ha.md#configure-cluster-zones)
601 Once you have configured the required `Endpoint` and `Zone` object definition, you can start
602 configuring your host and service objects. The configuration is simple: If the `command_endpoint`
603 attribute is set, Icinga 2 calculcates all required runtime macros and sends that over to the
604 defined endpoint. The check result is then received asynchronously through the cluster protocol.
606 object Host "host-remote" {
607 import "generic-host"
609 address = "127.0.0.1"
615 apply Service "users-remote" {
616 import "generic-service"
618 check_command = "users"
619 command_endpoint = "icinga2-node2.localdomain"
621 vars.users_wgreater = 10
622 vars.users_cgreater = 20
624 /* assign where a remote client pattern is matched */
625 assign where match("*-remote", host.name)
629 If there is a failure on execution (for example, the local check command configuration or the plugin
630 is missing), the check will return `UNKNOWN` and populate the check output with the error message.
631 This will happen in a similar fashion if you forgot to enable the `accept_commands` attribute
632 inside the `api` feature.
634 If you don't want to define the endpoint name inside the service apply rule everytime, you can
635 also easily inherit this from a host's custom attribute like shown in the example below.
637 object Host "host-remote" {
638 import "generic-host"
640 address = "127.0.0.1"
645 vars.remote_client = "icinga2-node2.localdomain"
647 /* host specific check arguments */
648 vars.users_wgreater = 10
649 vars.users_cgreater = 20
652 apply Service "users-remote" {
653 import "generic-service"
655 check_command = "users"
656 command_endpoint = host.vars.remote_client
658 /* override (remote) command arguments with host settings */
659 vars.users_wgreater = host.vars.users_wgreater
660 vars.users_cgreater = host.vars.users_cgreater
662 /* assign where a remote client is set */
663 assign where host.vars.remote_client
666 That way your generated host object is the information provider and the service apply
667 rules must only be configured once.
671 > [Event commands](3-monitoring-basics.md#event-commands) are executed on the
672 > remote command endpoint as well. You do not need
673 > an additional transport layer such as SSH or similar.
676 ### <a id="icinga2-client-configuration-master-config-sync"></a> Clients with Master Config Sync
678 This is an advanced configuration mode which requires knowledge about the Icinga 2
679 cluster configuration and its object relation (Zones, Endpoints, etc) and the way you
680 will be able to sync the configuration from the master to the remote satellite or client.
682 Please continue reading in the [distributed monitoring chapter](13-distributed-monitoring-ha.md#distributed-monitoring-high-availability),
683 especially the [configuration synchronisation](13-distributed-monitoring-ha.md#cluster-zone-config-sync)
684 and [best practices](13-distributed-monitoring-ha.md#zone-config-sync-best-practice).
689 ### <a id="icinga2-client-cli-node"></a> Advanced Node Cli Actions
691 #### <a id="icinga2-remote-monitoring-master-discovery-blacklist-whitelist"></a> Blacklist/Whitelist for Clients on the Master
693 It's sometimes necessary to `blacklist` an entire remote client, or specific hosts or services
694 provided by this client. While it's reasonable for the local admin to configure for example an
695 additional ping check, you're not interested in that on the master sending out notifications
696 and presenting the dashboard to your support team.
698 Blacklisting an entire set might not be sufficient for excluding several objects, be it a
699 specific remote client with one ping servie you're interested in. Therefore you can `whitelist`
700 clients, hosts, services in a similar manner
702 Example for blacklisting all `ping*` services, but allowing only `probe` host with `ping4`:
704 # icinga2 node blacklist add --zone "*" --host "*" --service "ping*"
705 # icinga2 node whitelist add --zone "*" --host "probe" --service "ping*"
707 You can `list` and `remove` existing blacklists:
709 # icinga2 node blacklist list
710 Listing all blacklist entries:
711 blacklist filter for Node: '*' Host: '*' Service: 'ping*'.
713 # icinga2 node whitelist list
714 Listing all whitelist entries:
715 whitelist filter for Node: '*' Host: 'probe' Service: 'ping*'.
720 > The blacklist feature only prevents future updates from creating and removing objects, but it does not remove already existing objects.
721 > The `--zone` and `--host` arguments are required. A zone is always where the remote client is in.
722 > If you are unsure about it, set a wildcard (`*`) for them and filter only by host/services.
726 #### <a id="icinga2-client-master-discovery-manual"></a> Manually Discover Clients on the Master
728 Add a to-be-discovered client to the master:
730 # icinga2 node add my-remote-client
732 Set the connection details, and the Icinga 2 master will attempt to connect to this node and sync its
735 # icinga2 node set my-remote-client --host 192.168.33.101 --port 5665
737 You can control that by calling the `node list` command:
740 Node 'my-remote-client' (host: 192.168.33.101, port: 5665, log duration: 1 day, last seen: Sun Nov 2 17:46:29 2014)
742 #### <a id="icinga2-remote-monitoring-master-discovery-remove"></a> Remove Discovered Clients
744 If you don't require a connected agent, you can manually remove it and its discovered hosts and services
745 using the following CLI command:
747 # icinga2 node remove my-discovered-agent
751 > Better use [blacklists and/or whitelists](11-icinga2-client.md#icinga2-remote-monitoring-master-discovery-blacklist-whitelist)
752 > to control which clients and hosts/services are integrated into your master configuration repository.