2015-01-22 09:40:25 +01:00
|
|
|
## <a id="cli-commands"></a> Icinga 2 CLI Commands
|
|
|
|
|
|
|
|
|
|
Icinga 2 ships its own integrated CLI commands supporting bash-autocompletion.
|
|
|
|
|
|
|
|
|
|
These CLI commands will allow you to use certain functionality
|
|
|
|
|
provided by and around the Icinga 2 daemon.
|
|
|
|
|
|
|
|
|
|
Each CLI command provides its own help and usage information, so please
|
|
|
|
|
make sure to always run them with the `--help` parameter.
|
|
|
|
|
|
|
|
|
|
Run `icinga2` without any arguments to get a list of all available global
|
|
|
|
|
options.
|
|
|
|
|
|
|
|
|
|
# icinga2
|
|
|
|
|
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 <command> [<arguments>]
|
|
|
|
|
|
|
|
|
|
Supported commands:
|
|
|
|
|
* daemon (starts Icinga 2)
|
|
|
|
|
* feature disable (disables specified feature)
|
|
|
|
|
* feature enable (enables specified feature)
|
|
|
|
|
* feature list (lists all enabled features)
|
|
|
|
|
* node add (add node)
|
|
|
|
|
* node blacklist add (adds a new blacklist filter)
|
|
|
|
|
* node blacklist list (lists all blacklist filters)
|
|
|
|
|
* node blacklist remove (removes a blacklist filter)
|
|
|
|
|
* node list (lists all nodes)
|
|
|
|
|
* node remove (removes node)
|
|
|
|
|
* node set (set node attributes)
|
|
|
|
|
* node setup (set up node)
|
|
|
|
|
* node update-config (update node config)
|
|
|
|
|
* node whitelist add (adds a new whitelist filter)
|
|
|
|
|
* node whitelist list (lists all whitelist filters)
|
|
|
|
|
* node whitelist remove (removes a whitelist filter)
|
|
|
|
|
* node wizard (wizard for node setup)
|
|
|
|
|
* object list (lists all objects)
|
|
|
|
|
* pki new-ca (sets up a new CA)
|
|
|
|
|
* pki new-cert (creates a new CSR)
|
|
|
|
|
* pki request (requests a certificate)
|
|
|
|
|
* pki save-cert (saves another Icinga 2 instance's certificate)
|
|
|
|
|
* pki sign-csr (signs a CSR)
|
|
|
|
|
* pki ticket (generates a ticket)
|
|
|
|
|
* repository clear-changes (clear uncommitted repository changes)
|
|
|
|
|
* repository commit (commit repository changes)
|
|
|
|
|
* repository endpoint add (adds a new Endpoint object)
|
|
|
|
|
* repository endpoint list (lists all Endpoint objects)
|
|
|
|
|
* repository endpoint remove (removes a Endpoint object)
|
|
|
|
|
* repository host add (adds a new Host object)
|
|
|
|
|
* repository host list (lists all Host objects)
|
|
|
|
|
* repository host remove (removes a Host object)
|
|
|
|
|
* repository service add (adds a new Service object)
|
|
|
|
|
* repository service list (lists all Service objects)
|
|
|
|
|
* repository service remove (removes a Service object)
|
|
|
|
|
* repository zone add (adds a new Zone object)
|
|
|
|
|
* repository zone list (lists all Zone objects)
|
|
|
|
|
* repository zone remove (removes a Zone object)
|
|
|
|
|
* variable get (gets a variable)
|
|
|
|
|
* variable list (lists all variables)
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### <a id="cli-commands-autocompletion"></a> Icinga 2 CLI Bash Autocompletion
|
|
|
|
|
|
|
|
|
|
Bash Auto-Completion (pressing `<TAB>`) is provided only for the corresponding context.
|
|
|
|
|
|
|
|
|
|
While `--config` will suggest and auto-complete files and directories on disk,
|
|
|
|
|
`feature enable` will only suggest disabled features. `repository` will know
|
|
|
|
|
about object specific attributes, and so on. Try it yourself.
|
|
|
|
|
|
|
|
|
|
RPM and Debian packages install the bash completion files into
|
|
|
|
|
`/etc/bash_completion.d/icinga2`.
|
|
|
|
|
|
|
|
|
|
You will need to install the `bash-completion` package if not already installed.
|
|
|
|
|
|
|
|
|
|
RHEL/CentOS/Fedora:
|
|
|
|
|
|
|
|
|
|
# yum install bash-completion
|
|
|
|
|
|
|
|
|
|
SUSE:
|
|
|
|
|
|
|
|
|
|
# zypper install bash-completion
|
|
|
|
|
|
|
|
|
|
Debian/Ubuntu:
|
|
|
|
|
|
|
|
|
|
# apt-get install bash-completion
|
|
|
|
|
|
|
|
|
|
### <a id="cli-commands-global-options"></a> Icinga 2 CLI Global Options
|
|
|
|
|
|
|
|
|
|
#### Libraries
|
|
|
|
|
|
2015-01-22 16:23:23 +01:00
|
|
|
Instead of loading libraries using the [`library` config directive](10-language-reference.md#library)
|
2015-01-22 09:40:25 +01:00
|
|
|
you can also use the `--library` command-line option.
|
|
|
|
|
|
|
|
|
|
#### Constants
|
|
|
|
|
|
2015-01-22 16:23:23 +01:00
|
|
|
[Global constants](10-language-reference.md#constants) can be set using the `--define` command-line option.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
#### <a id="config-include-path"> Config Include Path
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
When including files you can specify that the include search path should be
|
|
|
|
|
checked. You can do this by putting your configuration file name in angle
|
|
|
|
|
brackets like this:
|
|
|
|
|
|
|
|
|
|
include <test.conf>
|
|
|
|
|
|
|
|
|
|
This would cause Icinga 2 to search its include path for the configuration file
|
|
|
|
|
`test.conf`. By default the installation path for the Icinga Template Library
|
|
|
|
|
is the only search directory.
|
|
|
|
|
|
|
|
|
|
Using the `--include` command-line option additional search directories can be
|
|
|
|
|
added.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-daemon"></a> CLI command: Daemon
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
The CLI command `daemon` provides the functionality to start/stop Icinga 2.
|
|
|
|
|
Furthermore it provides the [configuration validation](5-cli-commands.md#config-validation).
|
|
|
|
|
|
|
|
|
|
# icinga2 daemon --help
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 daemon [<arguments>]
|
|
|
|
|
|
|
|
|
|
Starts Icinga 2.
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
-c [ --config ] arg parse a configuration file
|
|
|
|
|
-z [ --no-config ] start without a configuration file
|
|
|
|
|
-C [ --validate ] exit after validating the configuration
|
|
|
|
|
-e [ --errorlog ] arg log fatal errors to the specified log file (only works
|
|
|
|
|
in combination with --daemonize)
|
|
|
|
|
-d [ --daemonize ] detach from the controlling terminal
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
#### Config Files
|
|
|
|
|
|
|
|
|
|
Using the `--config` option you can specify one or more configuration files.
|
|
|
|
|
Config files are processed in the order they're specified on the command-line.
|
|
|
|
|
|
|
|
|
|
When no configuration file is specified and the `--no-config` is not used
|
|
|
|
|
Icinga 2 automatically falls back to using the configuration file
|
|
|
|
|
`SysconfDir + "/icinga2/icinga2.conf"` (where SysconfDir is usually `/etc`).
|
|
|
|
|
|
|
|
|
|
#### Config Validation
|
|
|
|
|
|
|
|
|
|
The `--validate` option can be used to check if your configuration files
|
|
|
|
|
contain errors. If any errors are found the exit status is 1, otherwise 0
|
|
|
|
|
is returned. More details in the [configuration validation](5-cli-commands.md#config-validation) chapter.
|
|
|
|
|
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-feature"></a> CLI command: Feature
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
The CLI commands for `enable` and `disable` feature support bash auto-completion
|
|
|
|
|
and will only suggest features for the corresponding context. Like disabling a
|
|
|
|
|
feature will only bring up all enabled features.
|
|
|
|
|
|
|
|
|
|
# icinga2 feature disable <tab>
|
|
|
|
|
checker --color --define --help --include --library --log-level mainlog notification --version
|
|
|
|
|
|
|
|
|
|
# icinga2 feature enable <tab>
|
|
|
|
|
api command debuglog graphite icingastatus ido-pgsql --library --log-level statusdata --version
|
|
|
|
|
--color compatlog --define --help ido-mysql --include livestatus perfdata syslog
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-node"></a> CLI command: Node
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
Provides the functionality to install and manage master and client
|
|
|
|
|
nodes in a [remote monitoring ](4-monitoring-remote-systems.md#icinga2-remote-client-monitoring) or
|
|
|
|
|
[distributed cluster](4-monitoring-remote-systems.md#distributed-monitoring-high-availability) scenario.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# icinga2 node --help
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 <command> [<arguments>]
|
|
|
|
|
|
|
|
|
|
Supported commands:
|
|
|
|
|
* node add (add node)
|
|
|
|
|
* node blacklist add (adds a new blacklist filter)
|
|
|
|
|
* node blacklist list (lists all blacklist filters)
|
|
|
|
|
* node blacklist remove (removes a blacklist filter)
|
|
|
|
|
* node list (lists all nodes)
|
|
|
|
|
* node remove (removes node)
|
|
|
|
|
* node set (set node attributes)
|
|
|
|
|
* node setup (set up node)
|
|
|
|
|
* node update-config (update node config)
|
|
|
|
|
* node whitelist add (adds a new whitelist filter)
|
|
|
|
|
* node whitelist list (lists all whitelist filters)
|
|
|
|
|
* node whitelist remove (removes a whitelist filter)
|
|
|
|
|
* node wizard (wizard for node setup)
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-object"></a> CLI command: Object
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
The `object` CLI command can be used to list all configuration objects and their
|
|
|
|
|
attributes. The command also shows where each of the attributes was modified.
|
2015-01-22 16:23:23 +01:00
|
|
|
That way you can also identify which objects have been created from your [apply rules](10-language-reference.md#apply).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-01-22 16:23:23 +01:00
|
|
|
More information can be found in the [troubleshooting](8-troubleshooting.md#list-configuration-objects) section.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
# icinga2 object --help
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 <command> [<arguments>]
|
|
|
|
|
|
|
|
|
|
Supported commands:
|
|
|
|
|
* object list (lists all objects)
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-pki"></a> CLI command: Pki
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
Provides the CLI commands to
|
|
|
|
|
|
|
|
|
|
* generate a new local CA
|
|
|
|
|
* generate a new CSR or self-signed certificate
|
|
|
|
|
* sign a CSR and return a certificate
|
|
|
|
|
* save a master certificate manually
|
|
|
|
|
* request a signed certificate from the master
|
|
|
|
|
* generate a new ticket for the client setup
|
|
|
|
|
|
|
|
|
|
This functionality is used by the [node setup/wizard](5-cli-commands.md#cli-command-pki) CLI commands too.
|
|
|
|
|
|
|
|
|
|
# icinga2 pki --help
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 <command> [<arguments>]
|
|
|
|
|
|
|
|
|
|
Supported commands:
|
|
|
|
|
* pki new-ca (sets up a new CA)
|
|
|
|
|
* pki new-cert (creates a new CSR)
|
|
|
|
|
* pki request (requests a certificate)
|
|
|
|
|
* pki save-cert (saves another Icinga 2 instance's certificate)
|
|
|
|
|
* pki sign-csr (signs a CSR)
|
|
|
|
|
* pki ticket (generates a ticket)
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-repository"></a> CLI command: Repository
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
Provides the functionality to manage the Icinga 2 configuration repository in
|
|
|
|
|
`/etc/icinga2/repository.d`. All changes are logged and must be committed or
|
|
|
|
|
cleared after review.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> **Note**
|
|
|
|
|
>
|
|
|
|
|
> The CLI command `repository` only supports basic configuration manipulation (add, remove)
|
|
|
|
|
> and a limited set of objects required for the [remote client] integration. Future
|
|
|
|
|
> versions will support more options (set, etc.).
|
|
|
|
|
>
|
|
|
|
|
> Please check the Icinga 2 development roadmap for updates.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# icinga2 repository --help
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 <command> [<arguments>]
|
|
|
|
|
|
|
|
|
|
Supported commands:
|
|
|
|
|
* repository clear-changes (clear uncommitted repository changes)
|
|
|
|
|
* repository commit (commit repository changes)
|
|
|
|
|
* repository endpoint add (adds a new Endpoint object)
|
|
|
|
|
* repository endpoint list (lists all Endpoint objects)
|
|
|
|
|
* repository endpoint remove (removes a Endpoint object)
|
|
|
|
|
* repository host add (adds a new Host object)
|
|
|
|
|
* repository host list (lists all Host objects)
|
|
|
|
|
* repository host remove (removes a Host object)
|
|
|
|
|
* repository service add (adds a new Service object)
|
|
|
|
|
* repository service list (lists all Service objects)
|
|
|
|
|
* repository service remove (removes a Service object)
|
|
|
|
|
* repository zone add (adds a new Zone object)
|
|
|
|
|
* repository zone list (lists all Zone objects)
|
|
|
|
|
* repository zone remove (removes a Zone object)
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-01-22 16:09:28 +01:00
|
|
|
### <a id="cli-command-variable"></a> CLI command: Variable
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
Lists all configured variables (constants) in a similar fasion like [object list](5-cli-commands.md#cli-command-object).
|
|
|
|
|
|
|
|
|
|
# icinga2 variable --help
|
|
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
icinga2 <command> [<arguments>]
|
|
|
|
|
|
|
|
|
|
Supported commands:
|
|
|
|
|
* variable get (gets a variable)
|
|
|
|
|
* variable list (lists all variables)
|
|
|
|
|
|
|
|
|
|
Global options:
|
|
|
|
|
-h [ --help ] show this help message
|
|
|
|
|
-V [ --version ] show version information
|
|
|
|
|
--color use VT100 color codes even when stdout is not a
|
|
|
|
|
terminal
|
|
|
|
|
-D [ --define ] arg define a constant
|
|
|
|
|
-l [ --library ] arg load a library
|
|
|
|
|
-I [ --include ] arg add include search directory
|
|
|
|
|
-x [ --log-level ] arg specify the log level for the console log
|
|
|
|
|
|
|
|
|
|
Command options:
|
|
|
|
|
|
|
|
|
|
Report bugs at <https://dev.icinga.org/>
|
|
|
|
|
Icinga home page: <https://www.icinga.org/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## <a id="features"></a> Enabling/Disabling Features
|
|
|
|
|
|
|
|
|
|
Icinga 2 provides configuration files for some commonly used features. These
|
|
|
|
|
are installed in the `/etc/icinga2/features-available` directory and can be
|
|
|
|
|
enabled and disabled using the `icinga2 feature enable` and `icinga2 feature disable`
|
|
|
|
|
[CLI commands](5-cli-commands.md#cli-command-feature), respectively.
|
|
|
|
|
|
|
|
|
|
The `icinga2 feature enable` CLI command creates symlinks in the
|
|
|
|
|
`/etc/icinga2/features-enabled` directory which is included by default
|
|
|
|
|
in the example configuration file.
|
|
|
|
|
|
|
|
|
|
You can view a list of enabled and disabled features:
|
|
|
|
|
|
|
|
|
|
# icinga2 feature list
|
|
|
|
|
Disabled features: api command compatlog debuglog graphite icingastatus ido-mysql ido-pgsql livestatus notification perfdata statusdata syslog
|
|
|
|
|
Enabled features: checker mainlog notification
|
|
|
|
|
|
|
|
|
|
Using the `icinga2 feature enable` command you can enable features:
|
|
|
|
|
|
|
|
|
|
# icinga2 feature enable graphite
|
|
|
|
|
Enabling feature graphite. Make sure to restart Icinga 2 for these changes to take effect.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can disable features using the `icinga2 feature disable` command:
|
|
|
|
|
|
|
|
|
|
# icinga2 feature disable ido-mysql livestatus
|
|
|
|
|
Disabling feature ido-mysql. Make sure to restart Icinga 2 for these changes to take effect.
|
|
|
|
|
Disabling feature livestatus. Make sure to restart Icinga 2 for these changes to take effect.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The `icinga2 feature enable` and `icinga2 feature disable` commands do not
|
|
|
|
|
restart Icinga 2. You will need to restart Icinga 2 using the init script
|
|
|
|
|
after enabling or disabling features.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## <a id="config-validation"></a> Configuration Validation
|
|
|
|
|
|
|
|
|
|
Once you've edited the configuration files make sure to tell Icinga 2 to validate
|
|
|
|
|
the configuration changes. Icinga 2 will log any configuration error including
|
|
|
|
|
a hint on the file, the line number and the affected configuration line itself.
|
|
|
|
|
|
|
|
|
|
The following example creates an apply rule without any `assign` condition.
|
|
|
|
|
|
|
|
|
|
apply Service "5872-ping4" {
|
|
|
|
|
import "generic-service"
|
|
|
|
|
check_command = "ping4"
|
|
|
|
|
//assign where match("5872-*", host.name)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Validate the configuration with the init script option `checkconfig`:
|
|
|
|
|
|
|
|
|
|
# /etc/init.d/icinga2 checkconfig
|
|
|
|
|
|
|
|
|
|
> **Note**
|
|
|
|
|
>
|
|
|
|
|
> Using [systemd](2-getting-started.md#systemd-service) you need to manually validate the configuration using
|
|
|
|
|
> the CLI command below.
|
|
|
|
|
|
|
|
|
|
Or manually passing the `-C` argument:
|
|
|
|
|
|
|
|
|
|
# /usr/sbin/icinga2 daemon -c /etc/icinga2/icinga2.conf -C
|
|
|
|
|
|
|
|
|
|
[2014-05-22 17:07:25 +0200] critical/ConfigItem: Location:
|
|
|
|
|
/etc/icinga2/conf.d/tests/5872.conf(5): }
|
|
|
|
|
/etc/icinga2/conf.d/tests/5872.conf(6):
|
|
|
|
|
/etc/icinga2/conf.d/tests/5872.conf(7): apply Service "5872-ping4" {
|
|
|
|
|
^^^^^^^^^^^^^
|
|
|
|
|
/etc/icinga2/conf.d/tests/5872.conf(8): import "test-generic-service"
|
|
|
|
|
/etc/icinga2/conf.d/tests/5872.conf(9): check_command = "ping4"
|
|
|
|
|
|
|
|
|
|
Config error: 'apply' is missing 'assign'
|
|
|
|
|
[2014-05-22 17:07:25 +0200] critical/ConfigItem: 1 errors, 0 warnings.
|
|
|
|
|
Icinga 2 detected configuration errors.
|
|
|
|
|
|
|
|
|
|
> **Tip**
|
|
|
|
|
>
|
|
|
|
|
> Icinga 2 will automatically detect the default path for `icinga2.conf`
|
|
|
|
|
> in `SysconfDir + /icinga2/icinga2.conf` and you can safely omit this parameter.
|
|
|
|
|
>
|
|
|
|
|
> `# icinga2 daemon -C`
|
|
|
|
|
|
|
|
|
|
If you encouter errors during configuration validation, please make sure
|
2015-01-22 16:23:23 +01:00
|
|
|
to read the [troubleshooting](8-troubleshooting.md#troubleshooting) chapter.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
You can also use the [CLI command](5-cli-commands.md#cli-command-object) `icinga2 object list`
|
|
|
|
|
after validation passes to analyze object attributes, inheritance or created
|
|
|
|
|
objects by apply rules.
|
2015-01-22 16:23:23 +01:00
|
|
|
Find more on troubleshooting with `object list` in [this chapter](8-troubleshooting.md#list-configuration-objects).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
Example filtered by `Service` objects with the name `ping*`:
|
|
|
|
|
|
|
|
|
|
# icinga2 object list --type Service --name *ping*
|
|
|
|
|
Object 'nbmif.int.netways.de!ping4' of type 'Service':
|
|
|
|
|
* __name = 'nbmif.int.netways.de!ping4'
|
|
|
|
|
* check_command = 'ping4'
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/services.conf', lines 17:3-17:25
|
|
|
|
|
* check_interval = 60
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/templates.conf', lines 28:3-28:21
|
|
|
|
|
* host_name = 'nbmif.int.netways.de'
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/services.conf', lines 14:1-14:21
|
|
|
|
|
* max_check_attempts = 3
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/templates.conf', lines 27:3-27:24
|
|
|
|
|
* name = 'ping4'
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/services.conf', lines 14:1-14:21
|
|
|
|
|
* retry_interval = 30
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/templates.conf', lines 29:3-29:22
|
|
|
|
|
* templates = [ 'ping4', 'generic-service' ]
|
|
|
|
|
% += modified in '/etc/icinga2/conf.d/services.conf', lines 14:1-14:21
|
|
|
|
|
% += modified in '/etc/icinga2/conf.d/templates.conf', lines 26:1-30:1
|
|
|
|
|
* type = 'Service'
|
|
|
|
|
* vars
|
|
|
|
|
% += modified in '/etc/icinga2/conf.d/services.conf', lines 18:3-18:19
|
|
|
|
|
* sla = '24x7'
|
|
|
|
|
% = modified in '/etc/icinga2/conf.d/services.conf', lines 18:3-18:19
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## <a id="config-change-reload"></a> Reload on Configuration Changes
|
|
|
|
|
|
|
|
|
|
Everytime you have changed your configuration you should first tell Icinga 2
|
|
|
|
|
to [validate](5-cli-commands.md#config-validation). If there are no validation errors you can
|
|
|
|
|
safely reload the Icinga 2 daemon.
|
|
|
|
|
|
|
|
|
|
# /etc/init.d/icinga2 reload
|
|
|
|
|
|
|
|
|
|
> **Note**
|
|
|
|
|
>
|
|
|
|
|
> The `reload` action will send the `SIGHUP` signal to the Icinga 2 daemon
|
|
|
|
|
> which will validate the configuration in a separate process and not stop
|
|
|
|
|
> the other events like check execution, notifications, etc.
|
|
|
|
|
>
|
2015-01-22 16:23:23 +01:00
|
|
|
> Details can be found [here](9-migrating-from-icinga-1x.md#differences-1x-2-real-reload).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
