2015-02-12 10:29:21 +01:00
|
|
|
# <a id="cli-commands"></a> Icinga 2 CLI Commands
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-01-25 16:07:43 +01:00
|
|
|
Icinga 2 comes with a number of CLI commands which support bash autocompletion.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
These CLI commands will allow you to use certain functionality
|
2017-04-05 19:49:00 +02:00
|
|
|
provided by and around Icinga 2.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
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
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 <command> [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Supported commands:
|
2016-11-23 15:33:28 +01:00
|
|
|
* api setup (setup for api)
|
2015-02-11 10:20:36 +01:00
|
|
|
* console (Icinga console)
|
2015-01-22 09:40:25 +01:00
|
|
|
* daemon (starts Icinga 2)
|
|
|
|
* feature disable (disables specified feature)
|
|
|
|
* feature enable (enables specified feature)
|
|
|
|
* feature list (lists all enabled features)
|
2016-11-23 15:33:28 +01:00
|
|
|
* node add (add node) (DEPRECATED)
|
|
|
|
* node blacklist add (adds a new blacklist filter) (DEPRECATED)
|
|
|
|
* node blacklist list (lists all blacklist filters) (DEPRECATED)
|
|
|
|
* node blacklist remove (removes a blacklist filter) (DEPRECATED)
|
|
|
|
* node list (lists all nodes) (DEPRECATED)
|
|
|
|
* node remove (removes node) (DEPRECATED)
|
|
|
|
* node set (set node attributes) (DEPRECATED)
|
2015-01-22 09:40:25 +01:00
|
|
|
* node setup (set up node)
|
2016-11-23 15:33:28 +01:00
|
|
|
* node update-config (update node config) (DEPRECATED)
|
|
|
|
* node whitelist add (adds a new whitelist filter) (DEPRECATED)
|
|
|
|
* node whitelist list (lists all whitelist filters) (DEPRECATED)
|
|
|
|
* node whitelist remove (removes a whitelist filter) (DEPRECATED)
|
2015-01-22 09:40:25 +01:00
|
|
|
* 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)
|
2016-11-23 15:33:28 +01:00
|
|
|
* repository clear-changes (clear uncommitted repository changes) (DEPRECATED)
|
|
|
|
* repository commit (commit repository changes) (DEPRECATED)
|
|
|
|
* repository endpoint add (adds a new Endpoint object) (DEPRECATED)
|
|
|
|
* repository endpoint list (lists all Endpoint objects) (DEPRECATED)
|
|
|
|
* repository endpoint remove (removes a Endpoint object) (DEPRECATED)
|
|
|
|
* repository host add (adds a new Host object) (DEPRECATED)
|
|
|
|
* repository host list (lists all Host objects) (DEPRECATED)
|
|
|
|
* repository host remove (removes a Host object) (DEPRECATED)
|
|
|
|
* repository service add (adds a new Service object) (DEPRECATED)
|
|
|
|
* repository service list (lists all Service objects) (DEPRECATED)
|
|
|
|
* repository service remove (removes a Service object) (DEPRECATED)
|
|
|
|
* repository zone add (adds a new Zone object) (DEPRECATED)
|
|
|
|
* repository zone list (lists all Zone objects) (DEPRECATED)
|
|
|
|
* repository zone remove (removes a Zone object) (DEPRECATED)
|
2015-02-25 15:01:03 +01:00
|
|
|
* troubleshoot (collect information for troubleshooting)
|
2015-01-22 09:40:25 +01:00
|
|
|
* variable get (gets a variable)
|
|
|
|
* variable list (lists all variables)
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-commands-autocompletion"></a> Icinga 2 CLI Bash Autocompletion
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
Bash Auto-Completion (pressing `<TAB>`) is provided only for the corresponding context.
|
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
While `--config` suggests and auto-completes files and directories on disk,
|
|
|
|
`feature enable` only suggests disabled features.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
RPM and Debian packages install the bash completion files into
|
|
|
|
`/etc/bash_completion.d/icinga2`.
|
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
You need to install the `bash-completion` package if not already installed.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
RHEL/CentOS/Fedora:
|
|
|
|
|
|
|
|
# yum install bash-completion
|
|
|
|
|
|
|
|
SUSE:
|
|
|
|
|
|
|
|
# zypper install bash-completion
|
|
|
|
|
|
|
|
Debian/Ubuntu:
|
|
|
|
|
|
|
|
# apt-get install bash-completion
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
Ensure that the `bash-completion.d` directory is added to your shell
|
|
|
|
environment. You can manually source the icinga2 bash-completion file
|
|
|
|
into your current session and test it:
|
|
|
|
|
|
|
|
# source /etc/bash-completion.d/icinga2
|
|
|
|
|
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-commands-global-options"></a> Icinga 2 CLI Global Options
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-03-18 12:32:55 +01:00
|
|
|
### Application Type
|
|
|
|
|
|
|
|
By default the `icinga2` binary loads the `icinga` library. A different application type
|
|
|
|
can be specified with the `--app` command-line option.
|
2017-04-05 19:49:00 +02:00
|
|
|
Note: This is not needed by the average Icinga user, only developers.
|
2015-03-18 12:32:55 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
### Libraries
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-08-13 15:59:06 +02:00
|
|
|
Instead of loading libraries using the [`library` config directive](17-language-reference.md#library)
|
2015-01-22 09:40:25 +01:00
|
|
|
you can also use the `--library` command-line option.
|
2017-04-05 19:49:00 +02:00
|
|
|
Note: This is not needed by the average Icinga user, only developers.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
### Constants
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-08-13 15:59:06 +02:00
|
|
|
[Global constants](17-language-reference.md#constants) can be set using the `--define` command-line option.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
### <a id="config-include-path"></a> 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>
|
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
This causes Icinga 2 to search its include path for the configuration file
|
|
|
|
`test.conf`. By default the installation path for the [Icinga Template Library](10-icinga-template-library.md#icinga-template-library)
|
2015-01-22 09:40:25 +01:00
|
|
|
is the only search directory.
|
|
|
|
|
|
|
|
Using the `--include` command-line option additional search directories can be
|
|
|
|
added.
|
|
|
|
|
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-command-console"></a> CLI command: Console
|
2015-02-11 10:20:36 +01:00
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
The CLI command `console` can be used to debug and evaluate Icinga 2 config expressions,
|
|
|
|
e.g. to test [functions](17-language-reference.md#functions) in your local sandbox.
|
2015-02-11 10:20:36 +01:00
|
|
|
|
|
|
|
$ icinga2 console
|
2017-04-05 19:49:00 +02:00
|
|
|
Icinga 2 (version: v2.6.0)
|
2015-02-11 10:20:36 +01:00
|
|
|
<1> => function test(name) {
|
|
|
|
<1> .. log("Hello " + name)
|
|
|
|
<1> .. }
|
|
|
|
null
|
|
|
|
<2> => test("World")
|
|
|
|
information/config: Hello World
|
|
|
|
null
|
2015-11-04 10:39:32 +01:00
|
|
|
<3> =>
|
2015-02-11 10:20:36 +01:00
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
Further usage examples can be found in the [library reference](18-library-reference.md#library-reference) chapter.
|
2015-11-04 10:39:32 +01:00
|
|
|
|
|
|
|
On operating systems without the `libedit` library installed there is no
|
2015-11-07 13:49:14 +01:00
|
|
|
support for line-editing or a command history. However you can
|
2015-02-11 10:20:36 +01:00
|
|
|
use the `rlwrap` program if you require those features:
|
|
|
|
|
|
|
|
$ rlwrap icinga2 console
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
The debug console can be used to connect to a running Icinga 2 instance using
|
2016-08-13 15:59:06 +02:00
|
|
|
the [REST API](12-icinga2-api.md#icinga2-api). [API permissions](12-icinga2-api.md#icinga2-api-permissions)
|
2015-11-04 10:39:32 +01:00
|
|
|
are required for executing config expressions and auto-completion.
|
|
|
|
|
2015-11-07 13:49:14 +01:00
|
|
|
> **Note**
|
2017-04-05 19:49:00 +02:00
|
|
|
>
|
|
|
|
> The debug console does not currently support SSL certificate verification.
|
|
|
|
>
|
|
|
|
> Runtime modifications are not validated and might cause the Icinga 2
|
|
|
|
> daemon to crash or behave in an unexpected way. Use these runtime changes
|
|
|
|
> at your own risk and rather *inspect and debug objects read-only*.
|
2015-11-04 10:39:32 +01:00
|
|
|
|
2015-11-07 13:49:14 +01:00
|
|
|
You can specify the API URL using the `--connect` parameter.
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
Although the password can be specified there process arguments on UNIX platforms are
|
|
|
|
usually visible to other users (e.g. through `ps`). In order to securely specify the
|
2017-04-05 19:49:00 +02:00
|
|
|
user credentials the debug console supports two environment variables:
|
2015-11-07 13:49:14 +01:00
|
|
|
|
|
|
|
Environment variable | Description
|
|
|
|
---------------------|-------------
|
|
|
|
ICINGA2_API_USERNAME | The API username.
|
|
|
|
ICINGA2_API_PASSWORD | The API password.
|
|
|
|
|
|
|
|
Here's an example:
|
|
|
|
|
|
|
|
$ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/'
|
2016-11-23 15:33:28 +01:00
|
|
|
Icinga 2 (version: v2.6.0)
|
2015-11-04 10:39:32 +01:00
|
|
|
<1> =>
|
|
|
|
|
2015-11-07 13:49:14 +01:00
|
|
|
Once connected you can inspect variables and execute other expressions by entering them at the prompt:
|
2015-11-04 10:39:32 +01:00
|
|
|
|
2015-11-09 10:37:47 +01:00
|
|
|
<1> => var h = get_host("example.localdomain")
|
2015-11-07 13:49:14 +01:00
|
|
|
null
|
|
|
|
<2> => h.last_check_result
|
2015-11-04 10:39:32 +01:00
|
|
|
{
|
|
|
|
active = true
|
2015-11-09 10:37:47 +01:00
|
|
|
check_source = "example.localdomain"
|
2015-11-04 10:39:32 +01:00
|
|
|
command = [ "/usr/local/sbin/check_ping", "-H", "127.0.0.1", "-c", "5000,100%", "-w", "3000,80%" ]
|
2015-11-07 13:49:14 +01:00
|
|
|
execution_end = 1446653527.174983
|
|
|
|
execution_start = 1446653523.152673
|
2015-11-04 10:39:32 +01:00
|
|
|
exit_status = 0.000000
|
2015-11-07 13:49:14 +01:00
|
|
|
output = "PING OK - Packet loss = 0%, RTA = 0.11 ms"
|
|
|
|
performance_data = [ "rta=0.114000ms;3000.000000;5000.000000;0.000000", "pl=0%;80;100;0" ]
|
|
|
|
schedule_end = 1446653527.175133
|
|
|
|
schedule_start = 1446653583.150000
|
2015-11-04 10:39:32 +01:00
|
|
|
state = 0.000000
|
|
|
|
type = "CheckResult"
|
|
|
|
vars_after = {
|
|
|
|
attempt = 1.000000
|
|
|
|
reachable = true
|
|
|
|
state = 0.000000
|
|
|
|
state_type = 1.000000
|
|
|
|
}
|
|
|
|
vars_before = {
|
|
|
|
attempt = 1.000000
|
|
|
|
reachable = true
|
|
|
|
state = 0.000000
|
|
|
|
state_type = 1.000000
|
|
|
|
}
|
|
|
|
}
|
|
|
|
<3> =>
|
|
|
|
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
You can use the `--eval` parameter to evaluate a single expression in batch mode.
|
|
|
|
Using the `--file` option you can specify a file which should be evaluated.
|
|
|
|
The output format for batch mode is JSON.
|
2016-08-25 19:14:54 +02:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
The `--syntax-only` option can be used in combination with `--eval` or `--file`
|
|
|
|
to check a script for syntax errors. In this mode the script is parsed to identify
|
|
|
|
syntax errors but not evaluated.
|
2015-11-07 13:49:14 +01:00
|
|
|
|
2015-11-09 10:37:47 +01:00
|
|
|
Here's an example that retrieves the command that was used by Icinga to check the `example.localdomain` host:
|
2015-11-07 13:49:14 +01:00
|
|
|
|
2015-11-09 10:37:47 +01:00
|
|
|
$ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/' --eval 'get_host("example.localdomain").last_check_result.command' | python -m json.tool
|
2015-11-04 10:39:32 +01:00
|
|
|
[
|
|
|
|
"/usr/local/sbin/check_ping",
|
|
|
|
"-H",
|
|
|
|
"127.0.0.1",
|
|
|
|
"-c",
|
|
|
|
"5000,100%",
|
|
|
|
"-w",
|
|
|
|
"3000,80%"
|
|
|
|
]
|
|
|
|
|
2015-02-12 10:29:21 +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.
|
2017-04-05 19:49:00 +02:00
|
|
|
Furthermore it allows to run the [configuration validation](11-cli-commands.md#config-validation).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
# icinga2 daemon --help
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 daemon [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Starts Icinga 2.
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Command options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
### Config Files
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
You can specify one or more configuration files with the `--config` option.
|
2016-11-23 15:33:28 +01:00
|
|
|
Configuration files are processed in the order they're specified on the command-line.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
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`).
|
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
### Config Validation
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
The `--validate` option can be used to check if configuration files
|
2016-05-23 12:47:22 +02:00
|
|
|
contain errors. If any errors are found, the exit status is 1, otherwise 0
|
2016-08-13 15:59:06 +02:00
|
|
|
is returned. More details in the [configuration validation](11-cli-commands.md#config-validation) chapter.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-command-feature"></a> CLI command: Feature
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-01-25 16:07:43 +01:00
|
|
|
The `feature enable` and `feature disable` commands can be used to enable and disable features:
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
# icinga2 feature disable <tab>
|
2016-11-23 15:33:28 +01:00
|
|
|
--app --define --include --log-level --version checker graphite mainlog
|
|
|
|
--color --help --library --script-debugger api command ido-mysql notification
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
# icinga2 feature enable <tab>
|
2016-11-23 15:33:28 +01:00
|
|
|
--app --define --include --log-level --version debuglog ido-pgsql livestatus perfdata syslog
|
|
|
|
--color --help --library --script-debugger compatlog gelf influxdb opentsdb statusdata
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-01-25 16:07:43 +01:00
|
|
|
The `feature list` command shows which features are currently enabled:
|
|
|
|
|
|
|
|
# icinga2 feature list
|
2016-11-23 15:33:28 +01:00
|
|
|
Disabled features: compatlog debuglog gelf ido-pgsql influxdb livestatus opentsdb perfdata statusdata syslog
|
|
|
|
Enabled features: api checker command graphite ido-mysql mainlog notification
|
2015-01-25 16:07:43 +01:00
|
|
|
|
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-command-node"></a> CLI command: Node
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
> **Warning**
|
|
|
|
>
|
|
|
|
> This CLI command and its sub commands except for `setup` and `wizard`
|
|
|
|
> have been deprecated in v2.6 and will be
|
|
|
|
> removed in future releases.
|
|
|
|
>
|
|
|
|
> Make sure to follow the release announcements on the [Icinga website](https://www.icinga.com).
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Provides the functionality to install and manage master and client
|
2016-08-13 15:59:06 +02:00
|
|
|
nodes in a [distributed monitoring](6-distributed-monitoring.md#distributed-monitoring) scenario.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
# icinga2 node --help
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 <command> [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Supported commands:
|
2016-11-23 15:33:28 +01:00
|
|
|
* node add (add node) (DEPRECATED)
|
|
|
|
* node blacklist add (adds a new blacklist filter) (DEPRECATED)
|
|
|
|
* node blacklist list (lists all blacklist filters) (DEPRECATED)
|
|
|
|
* node blacklist remove (removes a blacklist filter) (DEPRECATED)
|
|
|
|
* node list (lists all nodes) (DEPRECATED)
|
|
|
|
* node remove (removes node) (DEPRECATED)
|
|
|
|
* node set (set node attributes) (DEPRECATED)
|
2015-01-22 09:40:25 +01:00
|
|
|
* node setup (set up node)
|
2016-11-23 15:33:28 +01:00
|
|
|
* node update-config (update node config) (DEPRECATED)
|
|
|
|
* node whitelist add (adds a new whitelist filter) (DEPRECATED)
|
|
|
|
* node whitelist list (lists all whitelist filters) (DEPRECATED)
|
|
|
|
* node whitelist remove (removes a whitelist filter) (DEPRECATED)
|
2015-01-22 09:40:25 +01:00
|
|
|
* node wizard (wizard for node setup)
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-02-12 10:29:21 +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
|
2017-04-05 19:49:00 +02:00
|
|
|
attributes. The command also shows where each of the attributes was modified and as such
|
|
|
|
provides debug information for further configuration problem analysis.
|
2016-08-13 15:59:06 +02:00
|
|
|
That way you can also identify which objects have been created from your [apply rules](17-language-reference.md#apply).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2017-04-05 19:49:00 +02:00
|
|
|
Runtime modifications via the [REST API](12-icinga2-api.md#icinga2-api-config-objects)
|
|
|
|
are not immediately updated. Furthermore there is a known issue with
|
|
|
|
[group assign expressions](17-language-reference.md#group-assign) which are not reflected in the host object output.
|
|
|
|
You need to restart Icinga 2 in order to update the `icinga2.debug` cache file.
|
|
|
|
|
2016-08-13 15:59:06 +02:00
|
|
|
More information can be found in the [troubleshooting](15-troubleshooting.md#list-configuration-objects) section.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
# icinga2 object --help
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 <command> [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Supported commands:
|
|
|
|
* object list (lists all objects)
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-command-pki"></a> CLI command: Pki
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
Provides the CLI commands to
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
* generate a new certificate authority (CA)
|
2015-01-22 09:40:25 +01:00
|
|
|
* 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
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
This functionality is used by the [node setup/wizard](11-cli-commands.md#cli-command-node) CLI commands.
|
|
|
|
You will need them in the [distributed monitoring chapter](6-distributed-monitoring.md#distributed-monitoring).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
# icinga2 pki --help
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 <command> [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
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)
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-command-repository"></a> CLI command: Repository
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
> **Warning**
|
|
|
|
>
|
|
|
|
> This CLI command has been deprecated in v2.6 and will be
|
|
|
|
> removed in future releases.
|
|
|
|
>
|
|
|
|
> Make sure to follow the release announcements on the [Icinga website](https://www.icinga.com).
|
|
|
|
|
|
|
|
This command is experimental and not finished as public CLI command. Parts of its functionality
|
2016-08-13 15:59:06 +02:00
|
|
|
are used in the [node update-config](11-cli-commands.md#cli-command-node) cli command.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-03-08 11:34:59 +01:00
|
|
|
## <a id="cli-command-troubleshoot"></a> CLI command: Troubleshoot
|
2015-02-25 15:01:03 +01:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
Collects basic information like version, paths, log files and crash reports for troubleshooting
|
|
|
|
purposes and prints them to a file or the console. See [troubleshooting](15-troubleshooting.md#troubleshooting-information-required).
|
2015-02-25 15:01:03 +01:00
|
|
|
|
2015-09-25 10:11:49 +02:00
|
|
|
Its output defaults to a file named `troubleshooting-[TIMESTAMP].log` so it won't overwrite older troubleshooting files.
|
2015-02-25 15:01:03 +01:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
Keep in mind that this tool can not collect information from other icinga2 nodes, you will have to run it on
|
|
|
|
each of one of you instances.
|
|
|
|
This is only a tool to collect information to help others help you, it will not attempt to fix anything.
|
2015-02-25 15:01:03 +01:00
|
|
|
|
|
|
|
# icinga2 troubleshoot --help
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-02-25 15:01:03 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 troubleshoot [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
|
|
|
Collect logs and other relevant information for troubleshooting purposes.
|
|
|
|
|
2015-02-25 15:01:03 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2015-02-25 15:01:03 +01:00
|
|
|
Command options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-c [ --console ] print to console instead of file
|
|
|
|
-o [ --output ] arg path to output file
|
|
|
|
--include-objects Print the whole objectfile (like `object list`)
|
|
|
|
--include-vars Print all Variables (like `variable list`)
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-02-25 15:01:03 +01:00
|
|
|
|
2015-02-12 10:29:21 +01:00
|
|
|
## <a id="cli-command-variable"></a> CLI command: Variable
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-10-17 12:25:58 +02:00
|
|
|
Lists all configured variables (constants) in a similar fashion like [object list](11-cli-commands.md#cli-command-object).
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
# icinga2 variable --help
|
2016-11-23 15:33:28 +01:00
|
|
|
icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
|
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Usage:
|
|
|
|
icinga2 <command> [<arguments>]
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Supported commands:
|
|
|
|
* variable get (gets a variable)
|
|
|
|
* variable list (lists all variables)
|
2016-11-23 15:33:28 +01:00
|
|
|
|
2015-01-22 09:40:25 +01:00
|
|
|
Global options:
|
2016-11-23 15:33:28 +01:00
|
|
|
-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
|
|
|
|
-a [ --app ] arg application library name (default: icinga)
|
|
|
|
-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.
|
|
|
|
The valid value is either debug, notice,
|
|
|
|
information (default), warning, or critical
|
|
|
|
-X [ --script-debugger ] whether to enable the script debugger
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Report bugs at <https://github.com/Icinga/icinga2>
|
2017-01-10 15:54:22 +01:00
|
|
|
Icinga home page: <https://www.icinga.com/>
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2015-10-28 21:07:12 +01:00
|
|
|
## <a id="enable-features"></a> Enabling/Disabling Features
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
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`
|
2016-08-13 15:59:06 +02:00
|
|
|
[CLI commands](11-cli-commands.md#cli-command-feature), respectively.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
|
|
|
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`
|
|
|
|
|
2015-11-20 15:57:16 +01:00
|
|
|
If you encounter errors during configuration validation, please make sure
|
2016-08-13 15:59:06 +02:00
|
|
|
to read the [troubleshooting](15-troubleshooting.md#troubleshooting) chapter.
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-08-13 15:59:06 +02:00
|
|
|
You can also use the [CLI command](11-cli-commands.md#cli-command-object) `icinga2 object list`
|
2015-01-22 09:40:25 +01:00
|
|
|
after validation passes to analyze object attributes, inheritance or created
|
|
|
|
objects by apply rules.
|
2016-08-13 15:59:06 +02:00
|
|
|
Find more on troubleshooting with `object list` in [this chapter](15-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*
|
2016-12-08 17:38:41 +01:00
|
|
|
Object 'icinga.com!ping4' of type 'Service':
|
|
|
|
* __name = 'icinga.com!ping4'
|
2015-01-22 09:40:25 +01:00
|
|
|
* 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
|
2016-12-08 17:38:41 +01:00
|
|
|
* host_name = 'icinga.com'
|
2015-01-22 09:40:25 +01:00
|
|
|
% = 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
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
Every time you have changed your configuration you should first tell Icinga 2
|
2016-08-13 15:59:06 +02:00
|
|
|
to [validate](11-cli-commands.md#config-validation). If there are no validation errors, you can
|
2015-01-22 09:40:25 +01:00
|
|
|
safely reload the Icinga 2 daemon.
|
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
# systemctl reload icinga2
|
2015-01-22 09:40:25 +01:00
|
|
|
|
2016-11-23 15:33:28 +01:00
|
|
|
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 09:40:25 +01:00
|
|
|
|