ICINGA2(8)

📦
version 2.16.5 · 2 versions
, in alpine 3.24, nixpkgs unstable, ubuntu stonking

💖 ICINGA2(8) 💖

okay bestie, pull up a chair, because we're about to talk about icinga2 — that's the manual page for the Icinga 2 network monitoring daemon. Yes, the thing lives in the System Manager's Manual, and yes, she's iconic. 🫶

✨ NAME ✨

icinga2 — The Icinga 2 network monitoring daemon. That's it, that's the whole vibe. 👑

✨ SYNOPSIS ✨

icinga2 command [ command options ][ global options ]

command := [ api | ca | console | daemon | feature | node | object | pki
| variable ] --help

so basically you run icinga2, you hand her a command, and then you can sprinkle command options and global options on top. And if you're ever like "what does this command even do??" — every single one of api, ca, console, daemon, feature, node, object, pki and variable answers to --help. slay. 💅

✨ DESCRIPTION ✨

Icinga 2 is an open source monitoring system. She checks the availability of your network resources, notifies users of outages, and generates performance data for reporting. That's the whole main character trifecta right there. 🌸

Scalable and extensible, Icinga 2 can monitor large, complex environments across multiple locations. Not me being obsessed with a daemon that just gets enterprise scale. 🔥

✨ OPTIONS ✨

ngl, this is the part you bookmark. Details for specific command options can be viewed by invoking the command name with the --help parameter. Go ask her yourself bestie, she loves that. 💖

🌈 Global options

  • -h,--help — Show this help message. The classic. The legend. The one you should've tried first. 😭
  • -V,--version — Show version information. yes she will tell you who she is.
  • --color — Use VT100 color codes <span>even when stdout is not a terminal</span>. So like, when you're piping stuff and the vibes go monochrome — this forces the color anyway. 🎀
  • -D, --define arg — Define a constant.
  • -l, --library arg — Load a library.
  • -I, --include arg — Add include search directory.
  • -x, --log-level [ debug | notice | information | warning | critical ] — Specify the log level for the console log. Default is information. Pick your chaos level wisely. ⭐
  • -X, --script-debugger — Enables the script debugger. When an exception occurs, or when the 'debugger' keyword is encountered in a user script, Icinga 2 launches the script debugger that allows the user to debug the script. It's giving "pause, let me look at this" energy and honestly? valid. 🦋

🌸 daemon options

The CLI command daemon provides the functionality to start/stop Icinga 2. Furthermore it provides the configuration validation. A multitasking queen, periodt. 👑

  • -c, --config arg — Using this option you can specify one or more configuration files. Config files are processed in the order they are specified on the command-line. Order matters, bestie, don't come for her about it.

When no configuration file is specified and the --no-config is not used, Icinga 2 automatically falls back to using the configuration file ConfigDir + /icinga2.conf (where ConfigDir is usually /etc/icinga2).

  • -z, --noconfig — Start without a configuration file. raw. unscripted. no rules. 🙈
  • -C, --validate — This 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. So 1 = "she's not okay", 0 = "we're so back". 💀
  • -e, --errorlog arg — Log fatal errors to the specified log file. Heads up: this only works in combination with --daemonize. iykyk.
  • -d, --daemonize — Detach from the controlling terminal. She's going off on her own, main character style. ✨

✨ REPORTING BUGS ✨

Report bugs at <https://github.com/Icinga/icinga2>

Icinga home page: <https://icinga.com/>

(fr fr, if something's broken, tell the maintainers — they're nice and they actually want to know. 🫶)

Copyright © 2012 Icinga GmbH License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl-3.0.html>

This is free software: you are free to change and redistribute it.

There is NO WARRANTY, to the extent permitted by law. Like, bestie, if this eats your config, that's on the license not on her. 💖

okay and one last thing for the group chat: this whole page is served up by the icinga2 manpage from way back in October 2015 (yes, she's vintage, she's timeless 💜), sitting in the System Manager's Manual — so if you need her, just remember: ICINGA2(8), section 8, and she's always down to monitor your network. no cap. 🌈💅🎀

📦 where this page comes from