]> granicus.if.org Git - icinga2/blobdiff - doc/6-cli-commands.md
Update documentation
[icinga2] / doc / 6-cli-commands.md
similarity index 94%
rename from doc/5-cli-commands.md
rename to doc/6-cli-commands.md
index 9818a2de2d1070141ae5cd2933605a1b514b4583..5acdc43dc6b1f282a849dc35774d0abb57279a40 100644 (file)
@@ -105,12 +105,12 @@ Debian/Ubuntu:
 
 #### Libraries
 
-Instead of loading libraries using the [`library` config directive](10-language-reference.md#library)
+Instead of loading libraries using the [`library` config directive](13-language-reference.md#library)
 you can also use the `--library` command-line option.
 
 #### Constants
 
-[Global constants](10-language-reference.md#constants) can be set using the `--define` command-line option.
+[Global constants](13-language-reference.md#constants) can be set using the `--define` command-line option.
 
 #### <a id="config-include-path"></a> Config Include Path
 
@@ -132,7 +132,7 @@ added.
 ### <a id="cli-command-daemon"></a> CLI command: Daemon
 
 The CLI command `daemon` provides the functionality to start/stop Icinga 2.
-Furthermore it provides the [configuration validation](5-cli-commands.md#config-validation).
+Furthermore it provides the [configuration validation](6-cli-commands.md#config-validation).
 
     # icinga2 daemon --help
     icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
@@ -176,7 +176,7 @@ Icinga 2 automatically falls back to using the configuration file
 
 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.
+is returned. More details in the [configuration validation](6-cli-commands.md#config-validation) chapter.
 
 
 ### <a id="cli-command-feature"></a> CLI command: Feature
@@ -195,8 +195,8 @@ feature will only bring up all enabled features.
 ### <a id="cli-command-node"></a> CLI command: Node
 
 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.
+nodes in a [remote monitoring ](5-monitoring-remote-systems.md#icinga2-remote-client-monitoring) or
+[distributed cluster](5-monitoring-remote-systems.md#distributed-monitoring-high-availability) scenario.
 
 
     # icinga2 node --help
@@ -240,9 +240,9 @@ nodes in a [remote monitoring ](4-monitoring-remote-systems.md#icinga2-remote-cl
 
 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.
-That way you can also identify which objects have been created from your [apply rules](10-language-reference.md#apply).
+That way you can also identify which objects have been created from your [apply rules](13-language-reference.md#apply).
 
-More information can be found in the [troubleshooting](8-troubleshooting.md#list-configuration-objects) section.
+More information can be found in the [troubleshooting](10-troubleshooting.md#list-configuration-objects) section.
 
     # icinga2 object --help
     icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
@@ -281,7 +281,7 @@ Provides the CLI commands to
 * 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.
+This functionality is used by the [node setup/wizard](6-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)
@@ -370,7 +370,7 @@ cleared after review.
 
 ### <a id="cli-command-variable"></a> CLI command: Variable
 
-Lists all configured variables (constants) in a similar fasion like [object list](5-cli-commands.md#cli-command-object).
+Lists all configured variables (constants) in a similar fasion like [object list](6-cli-commands.md#cli-command-object).
 
     # icinga2 variable --help
     icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
@@ -406,7 +406,7 @@ Lists all configured variables (constants) in a similar fasion like [object list
 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.
+[CLI commands](6-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
@@ -484,12 +484,12 @@ Or manually passing the `-C` argument:
 > `# icinga2 daemon -C`
 
 If you encouter errors during configuration validation, please make sure
-to read the [troubleshooting](8-troubleshooting.md#troubleshooting) chapter.
+to read the [troubleshooting](10-troubleshooting.md#troubleshooting) chapter.
 
-You can also use the [CLI command](5-cli-commands.md#cli-command-object) `icinga2 object list`
+You can also use the [CLI command](6-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](8-troubleshooting.md#list-configuration-objects).
+Find more on troubleshooting with `object list` in [this chapter](10-troubleshooting.md#list-configuration-objects).
 
 Example filtered by `Service` objects with the name `ping*`:
 
@@ -522,7 +522,7 @@ Example filtered by `Service` objects with the name `ping*`:
 ## <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
+to [validate](6-cli-commands.md#config-validation). If there are no validation errors you can
 safely reload the Icinga 2 daemon.
 
     # /etc/init.d/icinga2 reload
@@ -533,5 +533,5 @@ safely reload the Icinga 2 daemon.
 > which will validate the configuration in a separate process and not stop
 > the other events like check execution, notifications, etc.
 >
-> Details can be found [here](9-migrating-from-icinga-1x.md#differences-1x-2-real-reload).
+> Details can be found [here](12-migrating-from-icinga-1x.md#differences-1x-2-real-reload).