-# <a id="cli-commands"></a> Icinga 2 CLI Commands
+# Icinga 2 CLI Commands <a id="cli-commands"></a>
Icinga 2 comes with a number of CLI commands which support bash autocompletion.
Run `icinga2` without any arguments to get a list of all available global
options.
- # icinga2
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- Usage:
- icinga2 <command> [<arguments>]
-
- Supported commands:
- * api setup (setup for api)
- * console (Icinga console)
- * daemon (starts Icinga 2)
- * feature disable (disables specified feature)
- * feature enable (enables specified feature)
- * feature list (lists all enabled features)
- * 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)
- * node setup (set up node)
- * 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)
- * 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) (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)
- * troubleshoot (collect information for troubleshooting)
- * 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
- -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
-
- Report bugs at <https://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
-
-## <a id="cli-commands-autocompletion"></a> Icinga 2 CLI Bash Autocompletion
+```
+# icinga2
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+Usage:
+ icinga2 <command> [<arguments>]
+
+Supported commands:
+ * api setup (setup for api)
+ * ca list (lists all certificate signing requests)
+ * ca sign (signs an outstanding certificate request)
+ * console (Icinga console)
+ * daemon (starts Icinga 2)
+ * feature disable (disables specified feature)
+ * feature enable (enables specified feature)
+ * feature list (lists all available features)
+ * node setup (set up node)
+ * 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)
+ * troubleshoot (collect information for troubleshooting)
+ * 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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+
+## Icinga 2 CLI Bash Autocompletion <a id="cli-commands-autocompletion"></a>
Bash Auto-Completion (pressing `<TAB>`) is provided only for the corresponding context.
RHEL/CentOS/Fedora:
- # yum install bash-completion
+```
+# yum install bash-completion
+```
SUSE:
- # zypper install bash-completion
+```
+# zypper install bash-completion
+```
Debian/Ubuntu:
- # apt-get install bash-completion
+```
+# apt-get install bash-completion
+```
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
+```
+# source /etc/bash-completion.d/icinga2
+```
-## <a id="cli-commands-global-options"></a> Icinga 2 CLI Global Options
+## Icinga 2 CLI Global Options <a id="cli-commands-global-options"></a>
### Application Type
[Global constants](17-language-reference.md#constants) can be set using the `--define` command-line option.
-### <a id="config-include-path"></a> Config Include Path
+### Config Include Path <a id="config-include-path"></a>
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>
+```
+include <test.conf>
+```
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)
Using the `--include` command-line option additional search directories can be
added.
-
-## <a id="cli-command-console"></a> CLI command: Console
+## CLI command: Api <a id="cli-command-api"></a>
+
+Provides the setup CLI command to enable the REST API. More details
+in the [Icinga 2 API](12-icinga2-api.md#icinga2-api-setup) chapter.
+
+```
+# icinga2 api --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+Usage:
+ icinga2 <command> [<arguments>]
+
+Supported commands:
+ * api setup (setup for api)
+
+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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## CLI command: Ca <a id="cli-command-ca"></a>
+
+List and manage incoming certificate signing requests. More details
+can be found in the [signing methods](06-distributed-monitoring.md#distributed-monitoring-setup-sign-certificates-master)
+chapter. This CLI command is available since v2.8.
+
+```
+# icinga2 ca --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+Usage:
+ icinga2 <command> [<arguments>]
+
+Supported commands:
+ * ca list (lists all certificate signing requests)
+ * ca sign (signs an outstanding certificate request)
+
+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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## CLI command: Console <a id="cli-command-console"></a>
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.
- $ icinga2 console
- Icinga 2 (version: v2.6.0)
- <1> => function test(name) {
- <1> .. log("Hello " + name)
- <1> .. }
- null
- <2> => test("World")
- information/config: Hello World
- null
- <3> =>
+```
+$ icinga2 console
+Icinga 2 (version: v2.8.0)
+<1> => function test(name) {
+<1> .. log("Hello " + name)
+<1> .. }
+null
+<2> => test("World")
+information/config: Hello World
+null
+<3> =>
+```
Further usage examples can be found in the [library reference](18-library-reference.md#library-reference) chapter.
+```
+# icinga2 console --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+Usage:
+ icinga2 console [<arguments>]
+
+Interprets Icinga script expressions.
+
+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
+ -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
+
+Command options:
+ -c [ --connect ] arg connect to an Icinga 2 instance
+ -e [ --eval ] arg evaluate expression and terminate
+ -r [ --file ] arg evaluate a file and terminate
+ --syntax-only only validate syntax (requires --eval or --file)
+ --sandbox enable sandbox mode
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+
On operating systems without the `libedit` library installed there is no
support for line-editing or a command history. However you can
use the `rlwrap` program if you require those features:
- $ rlwrap icinga2 console
+```
+$ rlwrap icinga2 console
+```
The debug console can be used to connect to a running Icinga 2 instance using
the [REST API](12-icinga2-api.md#icinga2-api). [API permissions](12-icinga2-api.md#icinga2-api-permissions)
Here's an example:
- $ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/'
- Icinga 2 (version: v2.6.0)
- <1> =>
+```
+$ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/'
+Icinga 2 (version: v2.8.0)
+<1> =>
+```
Once connected you can inspect variables and execute other expressions by entering them at the prompt:
- <1> => var h = get_host("example.localdomain")
- null
- <2> => h.last_check_result
- {
- active = true
- check_source = "example.localdomain"
- command = [ "/usr/local/sbin/check_ping", "-H", "127.0.0.1", "-c", "5000,100%", "-w", "3000,80%" ]
- execution_end = 1446653527.174983
- execution_start = 1446653523.152673
- exit_status = 0.000000
- 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
- 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> =>
-
+```
+<1> => var h = get_host("icinga2-client1.localdomain")
+null
+<2> => h.last_check_result
+{
+ active = true
+ check_source = "icinga2-client1.localdomain"
+ command = [ "/usr/local/sbin/check_ping", "-H", "127.0.0.1", "-c", "5000,100%", "-w", "3000,80%" ]
+ execution_end = 1446653527.174983
+ execution_start = 1446653523.152673
+ exit_status = 0.000000
+ 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
+ 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> =>
+```
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.
to check a script for syntax errors. In this mode the script is parsed to identify
syntax errors but not evaluated.
-Here's an example that retrieves the command that was used by Icinga to check the `example.localdomain` host:
+Here's an example that retrieves the command that was used by Icinga to check the `icinga2-client1.localdomain` host:
- $ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/' --eval 'get_host("example.localdomain").last_check_result.command' | python -m json.tool
- [
- "/usr/local/sbin/check_ping",
- "-H",
- "127.0.0.1",
- "-c",
- "5000,100%",
- "-w",
- "3000,80%"
- ]
+```
+$ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/' --eval 'get_host("icinga2-client1.localdomain").last_check_result.command' | python -m json.tool
+[
+ "/usr/local/sbin/check_ping",
+ "-H",
+ "127.0.0.1",
+ "-c",
+ "5000,100%",
+ "-w",
+ "3000,80%"
+]
+```
-## <a id="cli-command-daemon"></a> CLI command: Daemon
+## CLI command: Daemon <a id="cli-command-daemon"></a>
The CLI command `daemon` provides the functionality to start/stop Icinga 2.
Furthermore it allows to run the [configuration validation](11-cli-commands.md#config-validation).
- # icinga2 daemon --help
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- 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
- -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
-
- 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://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
+```
+# icinga2 daemon --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+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
+ -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
+
+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://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
### Config Files
contain errors. If any errors are found, the exit status is 1, otherwise 0
is returned. More details in the [configuration validation](11-cli-commands.md#config-validation) chapter.
-## <a id="cli-command-feature"></a> CLI command: Feature
+## CLI command: Feature <a id="cli-command-feature"></a>
The `feature enable` and `feature disable` commands can be used to enable and disable features:
- # icinga2 feature disable <tab>
- --app --define --include --log-level --version checker graphite mainlog
- --color --help --library --script-debugger api command ido-mysql notification
-
- # icinga2 feature enable <tab>
- --app --define --include --log-level --version debuglog ido-pgsql livestatus perfdata syslog
- --color --help --library --script-debugger compatlog gelf influxdb opentsdb statusdata
+```
+# icinga2 feature disable <tab>
+--app --define --include --log-level --version checker graphite mainlog
+--color --help --library --script-debugger api command ido-mysql notification
+```
+
+```
+# icinga2 feature enable <tab>
+--app --define --include --log-level --version debuglog ido-pgsql livestatus perfdata syslog
+--color --help --library --script-debugger compatlog gelf influxdb opentsdb statusdata
+```
The `feature list` command shows which features are currently enabled:
- # icinga2 feature list
- Disabled features: compatlog debuglog gelf ido-pgsql influxdb livestatus opentsdb perfdata statusdata syslog
- Enabled features: api checker command graphite ido-mysql mainlog notification
+```
+# icinga2 feature list
+Disabled features: compatlog debuglog gelf ido-pgsql influxdb livestatus opentsdb perfdata statusdata syslog
+Enabled features: api checker command graphite ido-mysql mainlog notification
+```
+## CLI command: Node <a id="cli-command-node"></a>
-## <a id="cli-command-node"></a> CLI command: Node
+Provides the functionality to setup master and client
+nodes in a [distributed monitoring](06-distributed-monitoring.md#distributed-monitoring) scenario.
-> **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).
-
-Provides the functionality to install and manage master and client
-nodes in a [distributed monitoring](6-distributed-monitoring.md#distributed-monitoring) scenario.
-
- # icinga2 node --help
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- Usage:
- icinga2 <command> [<arguments>]
-
- Supported commands:
- * 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)
- * node setup (set up node)
- * 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)
- * 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
- -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
-
- Report bugs at <https://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
-
-
-## <a id="cli-command-object"></a> CLI command: Object
+```
+# icinga2 node --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+Usage:
+ icinga2 <command> [<arguments>]
+
+Supported commands:
+ * node setup (set up node)
+ * 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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## CLI command: Object <a id="cli-command-object"></a>
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 and as such
[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.
-More information can be found in the [troubleshooting](15-troubleshooting.md#list-configuration-objects) section.
-
- # icinga2 object --help
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- 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
- -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
-
- Report bugs at <https://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
-## <a id="cli-command-pki"></a> CLI command: Pki
+More information can be found in the [troubleshooting](15-troubleshooting.md#troubleshooting-list-configuration-objects) section.
+
+```
+# icinga2 object --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.7.1-196-g23e8a6253; debug)
+
+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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## CLI command: Pki <a id="cli-command-pki"></a>
Provides the CLI commands to
* generate a new ticket for the client setup
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).
-
- # icinga2 pki --help
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- 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
- -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
-
- Report bugs at <https://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
-## <a id="cli-command-repository"></a> CLI command: Repository
-
-> **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
-are used in the [node update-config](11-cli-commands.md#cli-command-node) cli command.
-
-## <a id="cli-command-troubleshoot"></a> CLI command: Troubleshoot
+You will need them in the [distributed monitoring chapter](06-distributed-monitoring.md#distributed-monitoring).
+
+```
+# icinga2 pki --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## CLI command: Troubleshoot <a id="cli-command-troubleshoot"></a>
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).
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.
- # icinga2 troubleshoot --help
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- Usage:
- icinga2 troubleshoot [<arguments>]
-
- Collect logs and other relevant information for troubleshooting purposes.
-
- 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
- -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
-
- Command options:
- -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`)
-
- Report bugs at <https://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
-## <a id="cli-command-variable"></a> CLI command: Variable
+```
+# icinga2 troubleshoot --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0)
+
+Usage:
+ icinga2 troubleshoot [<arguments>]
+
+Collect logs and other relevant information for troubleshooting purposes.
+
+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
+ -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
+
+Command options:
+ -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`)
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## CLI command: Variable <a id="cli-command-variable"></a>
Lists all configured variables (constants) in a similar fashion like [object list](11-cli-commands.md#cli-command-object).
- # icinga2 variable --help
- icinga2 - The Icinga 2 network monitoring daemon (version: v2.6.0)
-
- 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
- -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
-
- Report bugs at <https://github.com/Icinga/icinga2>
- Icinga home page: <https://www.icinga.com/>
-
-## <a id="enable-features"></a> Enabling/Disabling Features
+```
+# icinga2 variable --help
+icinga2 - The Icinga 2 network monitoring daemon (version: v2.8.0; debug)
+
+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
+ -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
+
+Report bugs at <https://github.com/Icinga/icinga2>
+Icinga home page: <https://www.icinga.com/>
+```
+
+## Enabling/Disabling Features <a id="enable-features"></a>
Icinga 2 provides configuration files for some commonly used features. These
are installed in the `/etc/icinga2/features-available` directory and can be
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
+```
+# 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.
-
+```
+# 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.
-
+```
+# 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
-## <a id="config-validation"></a> Configuration Validation
+## Configuration Validation <a id="config-validation"></a>
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
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)
- }
+```
+apply Service "my-ping4" {
+ import "generic-service"
+ check_command = "ping4"
+ //assign where host.address
+}
+```
-Validate the configuration with the init script option `checkconfig`:
+Validate the configuration:
- # /etc/init.d/icinga2 checkconfig
+```
+# icinga2 daemon -C
-> **Note**
->
-> Using [systemd](2-getting-started.md#systemd-service) you need to manually validate the configuration using
-> the CLI command below.
+[2014-05-22 17:07:25 +0200] critical/ConfigItem: Location:
+/etc/icinga2/conf.d/tests/my.conf(5): }
+/etc/icinga2/conf.d/tests/my.conf(6):
+/etc/icinga2/conf.d/tests/my.conf(7): apply Service "my-ping4" {
+ ^^^^^^^^^^^^^
+/etc/icinga2/conf.d/tests/my.conf(8): import "test-generic-service"
+/etc/icinga2/conf.d/tests/my.conf(9): check_command = "ping4"
-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`
+Config error: 'apply' is missing 'assign'
+[2014-05-22 17:07:25 +0200] critical/ConfigItem: 1 errors, 0 warnings.
+Icinga 2 detected configuration errors.
+```
If you encounter errors during configuration validation, please make sure
to read the [troubleshooting](15-troubleshooting.md#troubleshooting) chapter.
You can also use the [CLI command](11-cli-commands.md#cli-command-object) `icinga2 object list`
after validation passes to analyze object attributes, inheritance or created
objects by apply rules.
-Find more on troubleshooting with `object list` in [this chapter](15-troubleshooting.md#list-configuration-objects).
-
-Example filtered by `Service` objects with the name `ping*`:
-
- # icinga2 object list --type Service --name *ping*
- Object 'icinga.com!ping4' of type 'Service':
- * __name = 'icinga.com!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 = 'icinga.com'
- % = 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
+Find more on troubleshooting with `object list` in [this chapter](15-troubleshooting.md#troubleshooting-list-configuration-objects).
+
+
+## Reload on Configuration Changes <a id="config-change-reload"></a>
Every time you have changed your configuration you should first tell Icinga 2
to [validate](11-cli-commands.md#config-validation). If there are no validation errors, you can
safely reload the Icinga 2 daemon.
- # systemctl reload icinga2
+```
+# systemctl reload icinga2
+```
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
projects / icinga2 / blobdiff