Formatbeschreibung der Hauptkonfigurationsdatei

Allgemeine Informationen

Die Hauptkonfigurationsdatei ist im reinen Textformat im Stil der "ini"-Dateien.
Abschnitte sind durch [] markiert und Variablen haben einen zugewiesenen Wert. Die Variablen müssen auch im richtigen Abschnitt stehen, so dass Sie sicherstellen müssen, dass ggf. auch der Abschnitt aktiviert ist.
Semikola (;) werden benutzt, um Kommentare zu markieren. Abschnitte und Variablen mit einem vorangestellten Semikolon werden als Kommentare angesehen und von NagVis nicht erkannt.

Bei einer neuen NagVis-Installation gibt es keine Datei mit einer Default-Konfiguration. Standardwerte sind im PHP-Code enthalten. Konfigurationseinstellungen in der Datei etc/nagvis.ini.php übersteuern diese Standardwerte.
Es gibt eine Datei etc/nagvis.ini.php-sample mit Beispiel-Konfigurationswerten. Alle Werte sind auskommentiert.

Überblick

Beschreibung der Abschnitte im Detail

global

Alle Werte, die für das gesamte NagVis gelten, werden im global-Abschnitt gespeichert.
WertDefaultBeschreibung
audit_log1Aktivieren/deaktiviern der Protokollierung von sicherheitsrelevanten Benutzeraktionen in NagVis. Benutzeran- und abmeldungen werden z.B. in var/nagvis-audit.log protokolliert.
authmoduleCoreAuthModSQLiteDefiniert das zu benutzende Authentifizierungsmodul. Per Default benutzt NagVis das eingebaute SQLite-Authentifizierungsmodul. Bei der Auslieferung ist kein anderes Authentifizierungsmodul verfügbar. Es ist möglich, andere Authentifizierungsmodule hinzuzufügen, um andere Authentifizierungsmechanismen zu unterstützen. Weitere Einzelheiten finden Sie in der Authentifizierungsmodul-Dokumentation
authorisationmoduleCoreAuthorisationModSQLiteDefiniert das zu benutzende Autorisierungsmodul. Per Default benutzt NagVis das eingebaute SQLite-Autorisierungsmodul. Bei der Auslieferung ist kein anderes Autorisierungsmodul verfügbar. Es ist möglich, andere Autorisierungsmodule hinzuzufügen, um andere Autorisierungsmechanismen zu unterstützen. Weitere Einzelheiten finden Sie in der Autorisierungsmodul-Dokumentation
controls_size (neu in 1.6) 10 Die Größe (in Pixeln) von Objekt-Kontrollelementen in entsperrten (Edit)-Modus im Frontend. Objekt-Kontrollelemente sind z.B. die "modify"-, "delete"- und "move"-Icons.
dateformatY-m-d H:i:sDas in NagVis benutzte Format für Datum- und Zeit. Verfügbare Optionen wie bei der date()-Funktion von php
displayheader1Anzeigen des Header-Menus in Maps Veraltet ab Version 1.4, siehe Option "headermenu" in den default- und index-Abschnitten
languageen_USWählen Sie die Sprache, die in NagVis benutzt werden soll. de_DE (Deutsch), en_US (Englisch), fr_FR (Französisch) und pt_BR (brasilianisches Portugiesisch; ab 1.4.4) sind als Standard verfügbar). Seit 1.4 müssen Sie die Sprache in einem anderen Format angeben. ("de_DE" statt "german")
language_availablede_DE,en_US,es_ES,fr_FR,pt_BRSie möchten Ihren Benutzern vielleicht eine Auswahl an verschiedenen Sprachen anbieten. Sie können das Verhalten kontrollieren, ohne die Sprachdateien aus Ihrer NagVis-Installation zu löschen. Wenn dieser Wert nicht gefüllt ist, werden alle vorkonfigurierten Sprachen angeboten. Wenn Sie eine weitere Sprache hinzufügen möchten, dann müssen Sie den Wert hier eintragen
language_detectionuser,session,browser,configDies kontrolliert, wie NagVis die Sprache des Benutzers ermitteln soll. NagVis kennt mehrere Mechanismen zur Erkennung der Sprache:
- user: explizit vom Benutzer eingestellte Sprache
- session: wenn der Benutzer eine Sprache wählt, dann wird diese in der Session gespeichert
- browser: NagVis versucht, die Sprache mit Hilfe des Browser-Agenten zu ermitteln
- config: die Default-Sprache der Installation
Die Reihenfolge der Optionen bestimmt die Reihenfolge, in der NagVis die verschiedenen Mechanismen benutzt
logonmoduleLogonMixedDefiniert das zu benutzende Logon-Modul. Per Default benutzt NagVis das Mixed-Auth-Modul, das dem Benutzernamen vertraut, der per REMOTE_USER oder dem HTML-Logon-Dialog zur Abfrage von Authentifizierungsinformationen übergeben wurde, falls REMOTE_USER nicht gesetzt ist.

Bei der Auslieferung sind die folgenden Module verfügbar:

LogonMixed: Das gemischte Logon-Modul benutzt das LogonEnv-Modul als Standard und das LogonDialog-Modul als Ausweichlösung, falls LogonEnv keinen Benutzernamen zurückliefert. Das sollte den Anforderungen in den meisten Umgebungen genügen.

LogonDialog: Dies ist ein HTML-Anmeldedialog, um die Authentifizierungsinformationen abzufragen.

LogonEnv: Es ist möglich, einen vollständig zu "trauendem" Authentifizierungsmechanismus wie in den Vorgängerversionen von NagVis zu realisieren. Auf diese Weise wird der Benutzer nicht wirklich authentifiziert. NagVis vertraut dem gelieferten Benutzernamen implizit. NagVis benutzt die konfigurierte Umgebungsvariable, um den Benutzer zu identifizieren. Sie können Ihrem Webserver verschiedene Authentifizierungsmechanismen hinzufügen, angefangen mit der Basic-Authentifizierung, die von Nagios genutzt wird (.htaccess) bis hin zu Single-Sign-On-Umgebungen.
Setzen Sie einfach logonmodule auf "LogonEnv", setzen Sie die als Benutzername zu verwendende Umgebungsvariable auf die Option logonenvvar und teilen Sie dem Authentifizierungsmodul mit, dass Benutzer in der Datenbank neu anzulegen sind, wenn der gelieferte Benutzer noch nicht vorhanden ist. Die Option logonenvcreaterole weist das Authentifizierungsmodul an, den neuen Benutzer einer Rolle zuzuweisen. Setzen Sie die Option auf einen leeren String, um dieses Verhalten auszuschalten.

LogonMultisite: Dieses Modul benutzt die Authentifizierung von auth_*-Cookies, die von Check_MK-Multisite geliefert werden, wenn die Cookie-basierte Authentifizierung verwendet wird.

Es ist möglich, eigene Logon-Module hinzuzufügen, um andere Dialoge zu bedienen. Weitere Informantionen finden Sie in der logon module-Dokumentation.

logonenvvarREMOTE_USERDefiniert die Umgebungsvariable, die für das Holen des authentifizierten Benutzers aus der Webserver-Umgebung benutzt werden soll. Diese Option wird nur für die Logon-Module LogonEnv und LogonMixed verwendet.
logonenvcreateuser1Veranlasst das LogonEnv/LogonMixedModul, ein Benutzerkonto für jeden unbekannten Benutzer anzulegen, der die NagVis-Seite öffnet. Diese Option wird nur für die Logon-Module LogonEnv und LogonMixed verwendet.
logonenvcreateroleGuestsVeranlasst das LogonEnv/LogonMixedModul, die Benutzerkonten mit der angegebenen Rolle anzulegen. Diese Option wird nur für die Logon-Module LogonEnv und LogonMixed verwendet.
logon_multisite_htpasswd Der Pfad zur htpasswd-Datei, die von Multisite benutzt wird (wird nur vom LogonMultisite-Modul verwendet).
logon_multisite_secret Der Pfad zur auth-secret-Datei, die von Multisite benutzt wird (wird nur vom LogonMultisite-Modul verwendet).
logon_multisite_createuser 1 Gleich wie die "logonenvcreateuser"-Option (wird nur vom LogonMultisite-Modul verwendet).
logon_multisite_createrole Guest Gleich wie die "logonenvcreaterole"-Option (wird nur vom LogonMultisite-Modul verwendet).
refreshtime60Aktualisierungsintervall in Maps bzw. laden der nächsten Map bei Map-Rotation
sesscookiedomainautomatisch ermitteltVielleicht möchten Sie festlegen, für welche Domain NagVis das Session-Cookie speichern soll. Per Default versucht NagVis, den Wert mit Hilfe der Web-Server-Umgebungsvariablen selbst zu ermitteln. Dies sollte in den meisten Umgebungen funktionieren, könnte sich aber z.B. durch URL-Rewriting ändern.
sesscookiepathautomatisch ermitteltVielleicht möchten Sie den Pfad festlegen, für den NagVis das Session-Cookie speichern soll. Per Default versucht NagVis, den Wert mit Hilfe der paths/htmlbase-Variablen selbst zu ermitteln. Dies sollte in den meisten Umgebungen funktionieren, könnte sich aber z.B. durch URL-Rewriting ändern.
sesscookieduration86400 Lebensdauer des Cookies in Sekunden. Der Standardwert ist auf 24 Stunden eingestellt. Das NagVis-Session-Cookie wird bei jedem Seitenaufruf erneuert. Wenn eine Session länger als die eingestellte Zeit untätig ist, wird sie ungültig.
startmoduleoverviewDas anzuzeigende Startmodul, wenn vom Benutzer keins angegeben wird.
startactionviewDie Default-Aktion, wenn vom Benutzer keine angegeben wird.
startshow Der startshow-Parameter wird zur Zeit nur von einigen Views benutzt. Er wird von den Map- und AutoMap-Modulen verwendet.

paths

In diesem Abschnitt werden alle benötigten Pfad-Variablen definiert.
WertDefaultBeschreibung
base/usr/local/nagvis/share/absoluter physikalischer NagVis-Pfad
htmlbase/nagvisabsoluter html-NagVis-Pfad
htmlcgi/nagvis/cgi-binabsoluter html-NagVis-cgi-Pfad

defaults

Default-Werte für Maps, die Sie benutzen. Wenn für die Map bzw. ein Element kein Wert angegeben wurde, dann wird ein Standardwert benutzt.
WertDefaultBeschreibung
backendlive_1Default-Backend (ID des Backends - kopieren Sie den Text, der für <backend-id> steht, nach [backend_<backend-id>])
backgroundcolortransparentDefault-Hintergrundfarbe für Maps
contextmenu0Aktivieren/Deaktivieren des Kontextmenüs auf Ihren Map-Objekten.
contexttemplatedefaultDefault context template.
eventbackground 0 aktivieren (1) bzw. deaktivieren (0) des Wechselns der Hintergrundfarbe bei Statusänderungen (die konfigurierte Farbe wird gezeigt, wenn der Gesamtstatus PENDING, OK oder UP ist)
eventhighlight 1 aktivieren (1) bzw. deaktivieren (0) der Hervorhebung von Statusänderungen durch Hinzufügen einer blinkenden Umrandung
eventhighlightduration 10000 Dauer der Hervorhebung in Millisekunden
eventhighlightinterval 500 Intervall der Hervorhebung in Millisekunden
eventlog 0 aktivieren (1) bzw. deaktivieren (0) des Ereignisprotokolls im neuen JavaScript-Frontend. Das Ereignisprotokoll enthält wichtige Aktionen und Informationen
eventlogevents24Anzahl von Ereignissen im Ereignisprotokoll-Rückblick
eventloglevel info Loglevel des Ereignisprotokolls (verfügbar: debug, info, warning, critical)
eventheight 100 Höhe des JavaScript-Eventlogs in Pixeln
eventhidden 1 Verstecken/Zeigen des Eventlogs während des Map-Ladens
eventscroll 1 aktivieren (1) bzw. deaktivieren (0) des Bewegens zu dem Icon, das den Status verändert hat, falls das Icon nicht im sichtbaren Bereich liegt
eventsound 1 aktivieren (1) bzw. deaktivieren (0) von Sound-Signalen bei Statusänderungen
headerfade 0 aktivieren/deaktivieren des Abblendeffekts in den Untermenüs des Header-Menüs (wenn das verwendete Header-Menü diese Option unterstützt).
headermenu1aktivieren (1) bzw. deaktivieren (0) des Headermenüs
headertemplatedefaultDefault header template
hoverchildslimit10max. Anzahl von Child-Objekten
hoverchildsorderascReihenfolge von Child-Objekten ("asc"=aufsteigend, "desc"=absteigend)
hoverchildsshow1Anzeigen von Child-Objekten in Hover-Menüs
hoverchildssortaSortierreihenfolge von Child-Objekten ("s"=Status, "a"=Alphabet)
hoverdelay0Verzögerung des Hover-Menü-Auftretens (in Sekunden)
hovermenu1aktivieren/deaktivieren von Hover-Menüs
hovertemplatedefaultDefault hover template
hovertimeout5Default-Timeout bei Ajax-Anfragen in Hover-Menüs (in Sekunden) veraltet ab 1.4
icons std_medium Default-Iconset
onlyhardstates0nur Hard-Zustände benutzen (keine Soft-Zustände)
recognizeservices1Service-Zustände in Host/Hostgroup-Objekten erkennen
showinlists1Anzeigen von Maps in Listen (Dropdowns, Index-Seite, ...)
showinmultisite 1 Anzeigen der Maps im Multisite-Snapin
stylesheetDateiname des benutzerdefinierten Stylesheets, das in den Maps verwendet werden soll. Die Datei muss im share/nagvis/styles-Verzeichnis abgelegt werden.
urltarget_selfZiel des Icon-Links, diese Option passt <a target=""> an (_self ist das gleiche Fenster)
hosturl[htmlcgi]/status.cgi?host=[host_name]Die Default-URL, die bei einem Links-Klicks des Benutzers auf ein Host-Objekt benutzt wird. Verfügbare Makros: [htmlcgi], [htmlbase], [host_name], [backend_id]
hostgroupurl [htmlcgi]/status.cgi?hostgroup=[hostgroup_name] Die Default-URL, die bei einem Links-Klicks des Benutzers auf ein Hostgruppen-Objekt benutzt wird. Verfügbare Makros: [htmlcgi], [htmlbase], [hostgroup_name], [backend_id]
serviceurl [htmlcgi]/extinfo.cgi?type=2&host=[host_name]&service=[service_description] Die Default-URL, die bei einem Links-Klicks des Benutzers auf ein Service-Objekt benutzt wird. Verfügbare Makros: [htmlcgi], [htmlbase], [host_name], [service_description], [backend_id]
servicegroupurl [htmlcgi]/status.cgi?servicegroup=[servicegroup_name] Die Default-URL, die bei einem Links-Klicks des Benutzers auf ein Servicegruppen-Objekt benutzt wird. Verfügbare Makros: [htmlcgi], [htmlbase], [servicegroup_name], [backend_id]
mapurl [htmlbase]/index.php?mod=Map&act=view&show=[map_name] Die Default-URL, die bei einem Links-Klicks des Benutzers auf ein Map-Objekt benutzt wird. Verfügbare Makros: [htmlcgi], [htmlbase], [map_name]
view_template default In den verschiedenen Views zu benutzendes Template.

index

Dieses sind die Optionen für die Übersichtsseite von NagVis.
WertDefaultBeschreibung
backgroundcolor#ffffffDefault-Hintergrundfarbe für die Übersichtsseite
cellsperrow4Maps pro Zeile in Map-Listen.
headermenu1aktivieren (1) bzw. deaktivieren (0) des Headermenüs
headertemplatedefaultDefault header template
showautomaps1aktivieren/deaktivieren der Anzeige von Automaps
showmaps1aktivieren/deaktivieren der Anzeige von Maps
showmapthumbs1aktivieren/deaktivieren der Anzeige von Map-Thumbnails
showrotations1aktivieren/deaktivieren der Anzeige von definierten Rotationen

automap

Setzt die Automap-Optionen.
WertDefaultBeschreibung
defaultparams&childLayers=2Dies sind die Parameter für die Automap-Ansichten und Links in den Listen (Map-Indexseite, Dropdown-Menüs in den Headern)
defaultrootlocalhostDefault-Wert für das Root-Objekt. Details finden Sie in der Automap-Dokumentation
graphvizpath/usr/local/binwenn die graphviz-Binaries (dot,neato,twopi,...) nicht über PATH gefunden werden können, muss der Pfad hier gesetzt werden
showinlists1aktivieren/deaktivieren der Automap in Map-Listen (Map-Indexseite, Dropdown-Menüs in den Headern)

wui

Dieses sind die Optionen für die WUI.
WertDefaultBeschreibung
autoupdatefreq25In diesem Intervall wird die Map von der WUI gesichert (veraltet ab 1.6).
grid_color#f7f7f7Die Farbe der Rasterlinien.
grid_show0Aktivieren (1) bzw. deaktivieren (0) eines Rasters, um die Ausrichtung von Objekten im WUI zu vereinfachen. Objekte werden an der linken, oberen Ecke ausgerichtet.
grid_steps32Größe des Rasters in Pixeln.
headermenu1Aktivieren (1) bzw. deaktivieren (0) des Header-Menüs im WUI (veraltet ab 1.6).
headertemplatedefaultzu benutzendes Standard-Header-Template im WUI (veraltet ab 1.5).
maplocktime5Zeit in Minuten, die eine Map von einem editierenden Benutzer blockiert wird.

worker

Optionen für den neuen Worker im JavaScript-Frontend von NagVis.
WertDefaultBeschreibung
interval 5 Das Intervall in Sekunden, in dem der Worker auf zu aktualisierende Objekte prüft.
requestmaxlength 1900 Die maximale Länge von HTTP-Requests während Ajax-HTTP-Requests. Einige Intrusion Detection/Prevention-Systeme haben ein Problem mit zu langen Queries.
requestmaxparams 0 Die maximale Anzahl von Parametern in Ajax-HTTP-Requests. Einige Intrusion Detection/Prevention-Systeme haben Probleme mit zu vielen Parametern im URL. 0 = keine Begrenzung.
updateobjectstates 15 Die Aufbewahrungszeit in Sekunden für die Zustände im Frontend. Die Statusinformationen werden nach Ablauf dieser Zeit im folgenden Worker-Intervall aufgefrischt.

backend_*

Die Backend-Abschnitte zur Definition der Backends werden alle [backend_<backend-id>] benannt. In dem Beispiel ist live_1 die backend_id.

Abhängig vom Wert in backendtype müssen die gültigen Werte für die Backends gesetzt werden. In diesem Beispiel ist es das MKLivestatus-Backend.
[backend_live_1]
    backendtype="mklivestatus"
    htmlcgi="/nagios/cgi-bin"
    ; the following options depend on the selected backendtype, in this case it is MKLivestatus
    socket="unix:/usr/local/nagios/var/rw/live
WertDefaultBeschreibung
backendtypemklivestatusArt des Backends - MUSS gesetzt werden
statushost 

Der "statushost" kann genutzt werden, um lästige Timeouts zu vermeiden, wenn ein Backend nicht erreichbar ist. Dies ist nur sinnvoll in Multi-Backend-Umgebungen.

Es funktioniert wie folgt: Die Annahme ist, dass es ein "lokales" Backend gibt, das den Host des "entfernten" Backends überwacht. Wenn der entfernte Backend-Host als "UP" gemeldet wird, dann wird das Backend ganz normal abgefragt.

Wenn der entfernte Backend-Host als "DOWN" oder "UNREACHABLE" gemeldet wird, dann wird NagVis solange keine Verbindung dorthin versuchen, bis der Backend-Host wieder verfügbar ist.

Der "statushost" muss im folgenden Format angegeben werdent: "<backend_id>:<hostname>" -> e.g. "live_2:nagios"

Der Host muss in einem anderen Backend sein als der aktuelle, damit es funktioniert.

htmlcgi/nagios/cgi-binPfad zum cgi-bin-Verzeichnis dieses Backends (wichtig bei mehreren Backends)
custom_1Erste benutzerdefinierte Variable, die in den Context- und Hover-Menüs verfügbar ist. Mit dieser Option können verschiedene benutzerdefinierte URLs zu den Context-/Hover-Menüs hinzugefügt werden, die jeweils vom Backend abhängig sind. Das ist u.a. nutzbar, wenn Links auf verschiedene Nagios-Instanzen hinzugefügt werden sollen.
custom_2Zweite benutzerdefinierte Variable (s.o).
custom_3Dritte benutzerdefinierte Variable (s.o).

Die Backend-spezifischen Optionen finden Sie in der Backend-Dokumentation.

rotation_*

Definiert verschiedene Map-Rotationspools. In diesem Beispiel schaltet der Browser alle 15 Sekunden zwischen den Maps "demo" und "demo2" hin und her. Die Rotation wird aktiviert durch die URL: index.php?rotation=<rotation-id>. In diesem Fall ist die Rotation-ID "demo"
[rotation_demo]
    maps="demo,demo2"
    interval=15
WertDefaultBeschreibung
interval15Map-Rotationsintervall in Sekunden
maps kommaseparierte Liste von Maps in diesem Pool, die zu rotieren sind. Sie können auch externe URLs durch [ ] klammern (z.B. maps="demo1,[http://localhost/test.php]". Die URL muss von dem Server erreichbar sein, auf dem NagVis läuft.

Sie können Label im folgenden Format hinzufügen: <label>:<map> und <label>:<[url]>. Die Label werden in der Rotationsliste angezeigt.

Es ist außerdem möglich, Automaps zu Rotationen hinzuzufügen. Setzen Sie einfach ein "@"-Zeichen vor den Name der Automap, um sie der Rotation hinzuzufügen.

states

Optionen, die die Behandlung und das Aussehen der verschiedenen Zustände in der NagVis-Installation beeinflussen.

Diese Einstellungen definieren das Verhalten der Zustandsbehandlung. Hauptsächlich ist es möglich zu konfigurieren, welcher Zustand einen anderen "überdeckt". Ein kritischer Zustand (5) wird eine Warnung (4) überdecken, ein bestätigter kritischer Zustand (2) wird nicht eine Warnung (4) überdecken.

>
WertDefault
unreachable8
unreachable_ack5
unreachable_downtime5
down7
down_ack5
down_downtime5
critical7
critical_ack5
critical_downtime5
warning6
warning_ack4
warning_downtime4
unknown3
unknown_ack2
unknown_downtime2
error3
error_ack2
error_downtime2
ok1
up1
unchecked (neu in 1.6)0
pending0

Diese Einstellungen definieren das Verhalten der Zustände im Frontend.

ValueDefault
unreachable_bgcolor#F1811B
unreachable_color#F1811B
unreachable_ack_bgcolor
unreachable_downtime_bgcolor
unreachable_soundstd_unreachable.mp3
down_bgcolor#FF0000
down_color#FF0000
down_ack_bgcolor
down_downtime_bgcolor
down_soundstd_down.mp3
critical_bgcolor#FF0000
critical_color#FF0000
critical_ack_bgcolor
critical_downtime_bgcolor
critical_soundstd_critical.mp3
warning_bgcolor#FFFF00
warning_color#FFFF00
warning_ack_bgcolor
warning_downtime_bgcolor
warning_soundstd_warning.mp3
unknown_bgcolor#FFCC66
unknown_color#FFCC66
unknown_ack_bgcolor
unknown_downtime_bgcolor
unknown_sound
error_bgcolor#0000FF
error_color#0000FF
error_ack_bgcolor
error_downtime_bgcolor
error_sound
ok_bgcolor#00FF00
ok_color#00FF00
ok
up_bgcolor#00FF00
up_color#00FF00
up_sound
unchecked_bgcolor (neu in 1.6)#C0C0C0
unchecked_color (neu in 1.6)#C0C0C0
unchecked_sound (neu in 1.6)
pending_bgcolor#C0C0C0
pending_color#C0C0C0
pending_sound