granicus.if.org Git - icinga2/blob - doc/icinga2.8

   1 .TH ICINGA2 "8" "October 2015" "icinga2 - The Icinga 2 network monitoring daemon"
   2 .SH NAME
   3 icinga2 \- The Icinga 2 network monitoring daemon
   4
   5 .SH SYNOPSIS
   6 .B icinga2
   7 .I command
   8 [
   9 .I command options
  10 ][
  11 .I global options
  12 ]
  13
  14 .I command
  15 := [
  16 .B api | ca | console | daemon | feature | node | object | pki | variable
  17 ]
  18 .B --help
  19
  20 .SH DESCRIPTION
  21
  22 Icinga 2 is an open source monitoring system which checks the availability of your network resources, notifies users of outages, and generates performance data for reporting.
  23
  24 Scalable and extensible, Icinga 2 can monitor large, complex environments across multiple locations.
  25
  26 .SH OPTIONS
  27 Details for specific command options can be viewed by invoking the command name with
  28 .B --help
  29 parameter.
  30
  31 .SS Global options
  32 .TP
  33 .B -h,--help
  34 Show this help message.
  35 .TP
  36 .B -V,--version
  37 Show version information.
  38 .TP
  39 .B --color
  40 Use VT100 color codes even when stdout is not a terminal.
  41 .TP
  42 .BI "-D, --define" " arg"
  43 Define a constant.
  44 .TP
  45 .BI "-l, --library" " arg"
  46 Load a library.
  47 .TP
  48 .BI "-I, --include" " arg"
  49 Add include search directory.
  50 .TP
  51 .BI "-x, --log-level" " [ debug | notice | information | warning | critical ]"
  52 Specify the log level for the console log, default is
  53 .B information.
  54 .TP
  55 .BI "-X, --script-debugger"
  56 Enables the script debugger. When an exception occurs or the 'debugger' keyword
  57 is encountered in a user script Icinga 2 launches the script debugger that
  58 allows the user to debug the script.
  59
  60 .SS daemon options
  61 The CLI command daemon provides the functionality to start/stop Icinga 2.
  62 Furthermore it provides the configuration validation.
  63
  64 .TP
  65 .BI "-c, --config" " arg"
  66 Using this option you can specify one or more configuration files.
  67 Config files are processed in the order they are specified on the command-line.
  68
  69 When no configuration file is specified and the
  70 .B --no-config
  71 is not used, Icinga 2 automatically falls back to using the configuration file
  72 .B ConfigDir + "/icinga2.conf"
  73 (where ConfigDir is usually
  74 .BI "/etc/icinga2" ")."
  75
  76 .TP
  77 .B "-z, --noconfig"
  78 Start without a configuration file.
  79 .TP
  80 .B "-C, --validate"
  81 This option can be used to check if your configuration files contain errors.
  82 If any errors are found the exit status is 1, otherwise 0 is returned.
  83 .TP
  84 .BI "-e, --errorlog" " arg"
  85 Log fatal errors to the specified log file (only works in combination with
  86 .BR "--daemonize" ")."
  87 .TP
  88 .B "-d, --daemonize"
  89 Detach from the controlling terminal.
  90 .SH "REPORTING BUGS"
  91 Report bugs at <https://github.com/Icinga/icinga2>
  92 .br
  93 Icinga home page: <https://icinga.com/>
  94 .SH COPYRIGHT
  95 Copyright \(co 2012 Icinga GmbH
  96 License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl2.html>
  97 .br
  98 This is free software: you are free to change and redistribute it.
  99 There is NO WARRANTY, to the extent permitted by law.