[icinga-checkins] icinga.org: icinga-doc/r1.5: docs issue #1578: status cgi / statustypes / properties

git at icinga.org git at icinga.org
Sat Aug 20 14:33:11 CEST 2011


Module: icinga-doc
Branch: r1.5
Commit: e0533ed02d325a4f7bc027c84922d6b3ecc5ca3f
URL:    https://git.icinga.org/?p=icinga-doc.git;a=commit;h=e0533ed02d325a4f7bc027c84922d6b3ecc5ca3f

Author: Wolfgang <wnd at gmx.net>
Date:   Sat Aug 20 14:31:43 2011 +0200

docs issue #1578: status cgi / statustypes / properties

---

 de/cgiparams.xml |   59 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 en/cgiparams.xml |   62 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 117 insertions(+), 4 deletions(-)

diff --git a/de/cgiparams.xml b/de/cgiparams.xml
index d9370bd..214b80d 100644
--- a/de/cgiparams.xml
+++ b/de/cgiparams.xml
@@ -21,6 +21,26 @@
 
   <para>Nach dieser Tabelle folgt eine Erklärung der Parameter (in Bearbeitung).</para>
 
+  <para><emphasis role="bold">Properties / Statustypes</emphasis></para>
+
+  <para>Sie können <filename>status.cgi</filename> benutzen, um Objekte mit einem oder mehreren "Statustypen" (hoststatustype /
+  servicestatustype) und mit bestimmten Eigenschaften (hostprops / serviceprops) anzuzeigen. Jeder Statustyp / jede Eigenschaft wird durch
+  eine Zahl identifiziert (die <link linkend="cgiparams-filter">hier</link> und <link linkend="cgiparams-statustypes">hier</link> am Ende
+  des Abschnitts zu finden sind). Bitte addieren Sie die entsprechenden Zahlen und setzen die resultierende Summe jeweils bei der Option
+  ein.</para>
+
+  <para>Das Beispiel zeigt alle Services im nicht-OK-Zustand, die weder in einer Ausfallzeit (downtime) sind noch bestätigt (acknowledged)
+  wurden:</para>
+
+  <screen> http://localhost/icinga/cgi-bin/status.cgi?host=all&servicestatustypes=29&serviceprops=10</screen>
+
+  <para>"29" enthält auch "PENDING" Services (die seit dem Start noch nicht geprüft wurden).</para>
+
+  <note>
+    <para>Bitte beachten Sie, dass "properties" nur die Objekte anzeigt, die ALLE Bedingungen gleichzeitig erfüllen, während bei
+    "statustypes" nur EINE Bedingung erfüllt sein muss (kann).</para>
+  </note>
+
   <para><emphasis role="bold">Matrix Parameter / CGIs</emphasis></para>
 
   <informaltable>
@@ -4620,6 +4640,21 @@
 #define SERVICE_HARD_STATE              262144
 #define SERVICE_SOFT_STATE              524288</programlisting>
 
+  <para><anchor xml:id="cgiparams-statustypes" /><emphasis role="bold">Excerpt from include/statusdata.h</emphasis></para>
+
+  <para><screen>/*************************** SERVICE STATES ***************************/
+#define SERVICE_PENDING  1
+#define SERVICE_OK       2
+#define SERVICE_WARNING  4
+#define SERVICE_UNKNOWN  8
+#define SERVICE_CRITICAL 16
+
+/**************************** HOST STATES ****************************/
+#define HOST_PENDING     1
+#define HOST_UP          2
+#define HOST_DOWN        4
+#define HOST_UNREACHABLE 8</screen></para>
+
   <para>[1] Logisches ODER bedeutet, dass die jeweiligen Zahlen addiert werden. Es werden dann die Objekte angezeigt, die ALLE Bedingungen
   erfüllen.</para>
 
@@ -4638,7 +4673,29 @@
   <indexterm zone="cgiparams-filter">
     <primary>CGIs</primary>
 
-    <secondary>Filtereigenschaften (Filter Properties)</secondary>
+    <secondary>Filtereigenschaften (filter properties)</secondary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-filter">
+    <primary>hostprops</primary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-filter">
+    <primary>serviceprops</primary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-statustypes">
+    <primary>CGIs</primary>
+
+    <secondary>Statustypen (status types)</secondary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-statustype">
+    <primary>hoststatustypes</primary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-statustype">
+    <primary>servicestatustypes</primary>
   </indexterm>
 
   <indexterm zone="cgiparams-ahas">
diff --git a/en/cgiparams.xml b/en/cgiparams.xml
index f71f76d..368222a 100644
--- a/en/cgiparams.xml
+++ b/en/cgiparams.xml
@@ -26,7 +26,7 @@
   impression change to the folder containing the *.cgi modules (e.g. <filename>/usr/local/icinga/sbin</filename>), set some environment
   variables and execute one of the CGIs:<programlisting> $> export REMOTE_USER=icingaadmin   # or choose the appropriate user
  $> export REQUEST_METHOD='GET'      # if you enter queries
- $> export QUERY_STRING='host=all'  # see the tables below 
+ $> export QUERY_STRING='host=all'   # see the tables below 
 
  $> ./status.cgi</programlisting>Depending on the number of hosts this may return a lot of lines containing HTML code in between which
   most people will find hard to read so you should add "&csvoutput" or "&jsonoutput" to QUERY_STRING along with other
@@ -49,6 +49,24 @@
 
   <para>You will find some examples <link linkend="cgicmd">here</link>.</para>
 
+  <para><emphasis role="bold">Properties / Statustypes</emphasis></para>
+
+  <para>You can use <filename>status.cgi</filename> to show objects with one or more statustype (hoststatustype / servicestatustype) and
+  with certain properties (hostprops / serviceprops). Each statustype / property is identified by a number (shown <link
+  linkend="cgiparams-filter">here</link> and <link linkend="cgiparams-statustypes">here</link> at the end of this section). Please sum up
+  the appropriate numbers and use the resulting value for each option.</para>
+
+  <para>The example shows all non-OK services which are neither in downtime nor acknowledged:</para>
+
+  <screen> http://localhost/icinga/cgi-bin/status.cgi?host=all&servicestatustypes=29&serviceprops=10</screen>
+
+  <para>"29" includes PENDING services (not being checked since start up) as well.</para>
+
+  <note>
+    <para>Please note that using properties will only show the objects satisfying ALL conditions whereas the objects are shown when
+    satifying ONE of the statustypes.</para>
+  </note>
+
   <para><emphasis role="bold">Matrix Parameters / CGIs</emphasis></para>
 
   <informaltable>
@@ -4646,7 +4664,23 @@
 #define SERVICE_HARD_STATE              262144
 #define SERVICE_SOFT_STATE              524288</programlisting>
 
-  <para>[1] Logical OR means that the numbers are added and only the objects will be displayed satisfying ALL conditions.</para>
+  <para><anchor xml:id="cgiparams-statustypes" /><emphasis role="bold">Excerpt from include/statusdata.h</emphasis></para>
+
+  <para><screen>/*************************** SERVICE STATES ***************************/
+#define SERVICE_PENDING  1
+#define SERVICE_OK       2
+#define SERVICE_WARNING  4
+#define SERVICE_UNKNOWN  8
+#define SERVICE_CRITICAL 16
+
+/**************************** HOST STATES ****************************/
+#define HOST_PENDING     1
+#define HOST_UP          2
+#define HOST_DOWN        4
+#define HOST_UNREACHABLE 8</screen></para>
+
+  <para>[1] Logical OR means that the numbers are added and only the objects will be displayed satisfying ALL conditions
+  (properties).</para>
 
   <para>[2] Available starting with &name-icinga; 1.4.</para>
 
@@ -4666,6 +4700,28 @@
     <secondary>Filter properties</secondary>
   </indexterm>
 
+  <indexterm zone="cgiparams-filter">
+    <primary>hostprops</primary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-filter">
+    <primary>serviceprops</primary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-statustypes">
+    <primary>CGIs</primary>
+
+    <secondary>Status types</secondary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-statustype">
+    <primary>hoststatustypes</primary>
+  </indexterm>
+
+  <indexterm zone="cgiparams-statustype">
+    <primary>servicestatustypes</primary>
+  </indexterm>
+
   <indexterm zone="cgiparams-ahas">
     <primary>CGI parameter</primary>
 
@@ -5116,7 +5172,7 @@
     <secondary>serviceprops</secondary>
   </indexterm>
 
-  <indexterm zone="cgiparams-sevicestates">
+  <indexterm zone="cgiparams-servicestates">
     <primary>CGI parameter</primary>
 
     <secondary>servicestates</secondary>





More information about the icinga-checkins mailing list