summaryrefslogtreecommitdiffstats
path: root/debian/man/icingadb.8.xml
blob: 8366dc98ffecdc4b4dbfa1c0e4e0b5486ef26b42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id='icingadb'>

  <refmeta>
    <refentrytitle>icingadb</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>icingadb</refname>
    <refpurpose>Database connector for Icinga 2</refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>icingadb</command>
      <arg choice='opt'><option>-h</option></arg>
      <arg choice='opt'><option>--version</option></arg>
      <arg choice='opt'><option>-c</option> <replaceable>PATH</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      <command>icingadb</command> is a database connector for Icinga 2.
    </para>
    <para>
      It is part of a set of components for publishing, synchronizing and
      visualizing monitoring data in the Icinga ecosystem, consisting of:
      <itemizedlist>
        <listitem>
          <para>
            The Icinga DB daemon, which synchronizes monitoring data
            between a Redis server and a database.
          </para>
        </listitem>
        <listitem>
          <para>
            Icinga 2 with its Icinga DB feature enabled, responsible for
            publishing the data to the Redis server, i.e. configuration
            and its runtime updates, check results, state changes,
            downtimes, acknowledgements, notifications, and other events
            such as flapping.
          </para>
        </listitem>
        <listitem>
          <para>
            And Icinga Web with the Icinga DB Web module enabled, which
            connects to both Redis and the database to display and work
            with the most up-to-date data.
          </para>
        </listitem>
      </itemizedlist>
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>

    <para>
      Application Options:
    </para>
    <variablelist>

      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>
            Print version and exit
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c</option>=<replaceable>PATH</replaceable></term>
        <term><option>--config</option>=<replaceable>PATH</replaceable></term>
        <listitem>
          <para>
            Path to config file
            (default: <filename>/etc/icingadb/config.yml</filename>)
          </para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>
      Help Options:
    </para>
    <variablelist>

      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>
            Show usage information and exit
          </para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

</refentry>