[icinga-checkins] icinga.org: icinga-doc/master: docs issue #1726: show_partial_hostgroups in cgi.cfg

git at icinga.org git at icinga.org
Wed Aug 24 15:28:27 CEST 2011


Module: icinga-doc
Branch: master
Commit: 0912b1c9bdbe2c66476fc164b25b91921116d18b
URL:    https://git.icinga.org/?p=icinga-doc.git;a=commit;h=0912b1c9bdbe2c66476fc164b25b91921116d18b

Author: Wolfgang <wnd at gmx.net>
Date:   Tue Aug  9 10:27:21 2011 +0200

docs issue #1726: show_partial_hostgroups in cgi.cfg

---

 de/configcgi.xml |   45 +++++++++++++++++++++++++++++++++++++++++++++
 en/configcgi.xml |   54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 99 insertions(+), 0 deletions(-)

diff --git a/de/configcgi.xml b/de/configcgi.xml
index 073f15c..f978d07 100644
--- a/de/configcgi.xml
+++ b/de/configcgi.xml
@@ -1792,6 +1792,51 @@
     <para>Diese Option ist verfügbar ab &name-icinga; 1.5.</para>
   </note>
 
+  <para><anchor xml:id="configcgi-show_partial_hostgroups" /> <emphasis role="bold">Unvollständige Hostgruppen anzeigen</emphasis></para>
+
+  <informaltable frame="none">
+    <tgroup cols="2">
+      <colspec colname="c1" colwidth="5*" />
+
+      <colspec colname="c2" colwidth="50*" />
+
+      <tbody>
+        <row>
+          <entry align="left" valign="top"><para>Format:</para></entry>
+
+          <entry><para> <emphasis role="bold">show_partial_hostgroups=<0|1></emphasis> </para></entry>
+        </row>
+
+        <row>
+          <entry align="left" valign="top"><para>Beispiel:</para></entry>
+
+          <entry><para> <emphasis condition="red" role="color"> <emphasis role="bold">show_partial_hostgroups=1</emphasis> </emphasis>
+          </para></entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>Per Default (gleichbedeutend mit einer nicht vorhandenen oder deaktivierten Direktive) sieht ein Benutzer eine Hostgruppe und deren
+  Hosts nur, wenn er ein autorisierter Kontakt für <emphasis>alle</emphasis> Hosts der jeweiligen Gruppe ist. Das Verhalten kann mit der
+  Direktive <code>show_partial_hostgroups=1</code> geändert werden.</para>
+
+  <para>Wenn sie aktiviert ist, wird der Hostgruppen-Überblick auch unvollständige Hostgruppen aufführen, bei denen lediglich die Hosts
+  angezeigt werden, für die der Benutzer ein autorisierter Kontakt ist.</para>
+
+  <para>Außerdem wird der Hinweis "(Partial Hostgroups Enabled)" oberhalb des Hostgruppen-Überblicks angezeigt, damit keine Verwirrung
+  darüber entsteht, ob diese Direktive aktiviert ist oder nicht. Aus Geheimhaltungsgründen werden unvollständige Hostgruppen nicht als
+  solche gekennzeichnet.</para>
+
+  <para>KOMPATIBILITÄTSHINWEIS: Wie bei jeder Änderung an der Ausgabe der CGIs kann die Aktivierung dieser Direktive die Funktion von
+  Drittanbieter-Tools beeinträchtigen, die sich auf eine bestimmte (Bildschirm-)Struktur verlassen. Wenn Sie auf ein solches Problem stoßen,
+  dann deaktivieren Sie diese Option wieder und ermuntern Sie den/die Entwickler des Programms, statt dessen JSON zur Ermittlung der Daten
+  zu nutzen.</para>
+
+  <note>
+    <para>Diese Option ist verfügbar ab &name-icinga; 1.5.</para>
+  </note>
+
   <para><anchor xml:id="configcgi-highlight_table_rows" /> <emphasis role="bold">Zeilen in status.cgi hervorheben</emphasis></para>
 
   <informaltable frame="none">
diff --git a/en/configcgi.xml b/en/configcgi.xml
index 463a87d..5057758 100644
--- a/en/configcgi.xml
+++ b/en/configcgi.xml
@@ -254,6 +254,10 @@
     </listitem>
 
     <listitem>
+      <para><link linkend="configcgi-show_partial_hostgroups">Show partial hostgroups</link></para>
+    </listitem>
+
+    <listitem>
       <para><link linkend="configcgi-highlight_table_rows">Highlight rows in status.cgi</link></para>
     </listitem>
   </itemizedlist>
@@ -2087,6 +2091,50 @@
     <para>This option is available starting with &name-icinga; 1.5</para>
   </note>
 
+  <para><anchor xml:id="configcgi-show_partial_hostgroups" /> <emphasis role="bold">Show partial hostgroups</emphasis></para>
+
+  <informaltable frame="none">
+    <tgroup cols="2">
+      <colspec colname="c1" colwidth="5*" />
+
+      <colspec colname="c2" colwidth="50*" />
+
+      <tbody>
+        <row>
+          <entry align="left" valign="top"><para>Format:</para></entry>
+
+          <entry><para> <emphasis role="bold">show_partial_hostgroups=<0|1></emphasis> </para></entry>
+        </row>
+
+        <row>
+          <entry align="left" valign="top"><para>Example:</para></entry>
+
+          <entry><para> <emphasis condition="red" role="color"> <emphasis role="bold">show_partial_hostgroups=1</emphasis> </emphasis>
+          </para></entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>By default (meaning the directive is not present or disabled), a user only sees a hostgroup and the hosts within it if they are an
+  authorised contact for <emphasis>all</emphasis> of the hosts of the group. The behaviour can be changed using the directive 
+  <code>show_partial_hostgroups=1</code>.</para>
+
+  <para>When enabled, the hostgroups overview will show a partial listing of hosts that the user is an authorised contact for within each
+  hostgroup.</para>
+
+  <para>It will also add the string "(Partial Hostgroups Enabled)" to the top of the Hostgroup Overview to help prevent any confusion over
+  whether the option is in use or not. However for privacy reasons, hostgroups that are only showing a partial listing are not
+  specifically indicated.</para>
+
+  <para>COMPATIBILITY NOTICE: As with any tweak made to the output of the CGIs, enabling this option may adversely impact third party
+  programs that rely on 'screen scraping' to get their information.  If you encounter such a problem, turn this option back to its
+  default of off and encourage the developer(s) of the program to use JSON for their data needs instead.</para>
+
+  <note>
+    <para>This option is available starting with &name-icinga; 1.5</para>
+  </note>
+
   <para><anchor xml:id="configcgi-highlight_table_rows" /> <emphasis role="bold">Highlight rows in status.cgi</emphasis></para>
 
   <informaltable frame="none">
@@ -2422,6 +2470,12 @@
     <secondary>Suppress objects in maintenance/downtime state</secondary>
   </indexterm>
 
+  <indexterm zone="configcgi-show_partial_hostgroups">
+    <primary>show_partial_hostgroups=</primary>
+
+    <secondary>Show partial hostgroups</secondary>
+  </indexterm>
+
   <indexterm zone="configcgi-highlight_table_rows">
     <primary>highlight_table_rows=</primary>
 





More information about the icinga-checkins mailing list