Technische Dokumentation openITCOCKPIT V31. Installation
1.1. Vorraussetzungen1.2. Generelle Installation
1.2.1. openITCOCKPIT + Naemon (empfohlen)1.2.2. openITCOCKPIT + Nagios
1.3. Lizenz / Modul Installation1.3.1. Lizenz erstellen und eintragen1.3.2. Modul Installation1.3.3. Modul Liste
1.4. Satelliten1.4.1. Installation aus Paketen (recommended)
1.4.1.1. Todo auf dem Master1.4.1.2. Todo auf dem Satelliten1.4.1.3. Abschluss
1.4.2. Naemon Installation und Konfiguration auf dem Satellit von Hand1.4.2.1. phpNSTAClient Installation auf dem Satellit1.4.2.2. SSH Key erzeugen und austauschen zwischen Master und Satellit1.4.2.3. phpNSTA Installation auf dem Master1.4.2.4. Supervisor Installation auf dem Master1.4.2.5. Installation und Konfiguration vom Distribute Modul1.4.2.6. Berechtigung für den Export auf dem Satellit
1.5. Testing und Checklisten2. Update der openITCOCKPIT Version
2.1. Vorgehensweise2.2. Pitfalls2.3. Testing und Checklisten
3. Migration3.1. Vorbereitung3.2. Durchführung3.3. Testing und Checklisten3.4. Modulmigration
4. Benutzung4.1. Frontend
4.1.1. Hauptnavigation4.1.1.1. Dashboard
4.1.1.1.1. Welcome Widget:4.1.1.1.2. Parentoutages Widget:4.1.1.1.3. Hosts Piechart Widget:4.1.1.1.4. Hosts Piechart 180 Widget:4.1.1.1.5. Services Piechart Widget:4.1.1.1.6. Services Piechart 180 Widget:4.1.1.1.7. Host downtimes Widget:4.1.1.1.8. Service downtimes Widget:4.1.1.1.9. Hosts status list Widget:4.1.1.1.10. Service status list Widget:4.1.1.1.11. Trafficlight Widget:4.1.1.1.12. Tachometer Widget:4.1.1.1.13. Notice Widget:4.1.1.1.14. Map Widget:4.1.1.1.15. Graphgenerator Widget:
4.1.1.2. Maps4.1.1.2.1. Status Map4.1.1.2.2. Auto Map
4.1.1.3. Basic Monitoring4.1.1.3.1. Hosts4.1.1.3.2. Services4.1.1.3.3. Browser4.1.1.3.4. Host templates4.1.1.3.5. Service templates4.1.1.3.6. Service Template Groups4.1.1.3.7. Host Groups4.1.1.3.8. Service Groups4.1.1.3.9. Contacts4.1.1.3.10. Contactgroups4.1.1.3.11. Calendar4.1.1.3.12. Timeperiod4.1.1.3.13. Commands
4.1.1.3.14. Tenants4.1.1.3.15. Nodes4.1.1.3.16. Locations4.1.1.3.17. Graph Generator4.1.1.3.18. Graph Collections4.1.1.3.19. Downtimes4.1.1.3.20. Log Entries4.1.1.3.21. Notifications4.1.1.3.22. Performance Info
4.1.1.4. Expert Monitoring4.1.1.4.1. User Defined Macros4.1.1.4.2. Host Escalations4.1.1.4.3. Service Escalations4.1.1.4.4. Host Dependencies4.1.1.4.5. Service Dependencies4.1.1.4.6. External Commands
4.1.1.5. Reporting4.1.1.5.1. Instant Report4.1.1.5.2. Downtime Report4.1.1.5.3. Current State Report
4.1.1.6. Documentation4.1.1.7. Administration
4.1.1.7.1. Change Log4.1.1.7.2. Proxy Settings4.1.1.7.3. Package Manager4.1.1.7.4. Manage Users4.1.1.7.5. Manage User Roles4.1.1.7.6. Debugging4.1.1.7.7. System Failures4.1.1.7.8. System Settings4.1.1.7.9. Cron Jobs4.1.1.7.10. Registration4.1.1.7.11. Backup & Restore
4.1.1.8. Support4.1.1.8.1. Report an issue
4.1.2. Benutzerprofil4.1.2.1. Change profile4.1.2.2. Your picture4.1.2.3. Change password
4.1.3. Suche4.1.3.1. Menü Schnell Suche4.1.3.2. Host Schnell Suche4.1.3.3. Erweiterte Suche
4.1.4. Refresh Monitoring Configuration4.1.5. Module
4.1.5.1. Event Correlations4.1.5.1.1. Event Correlations4.1.5.1.2. EVC Hosttemplates4.1.5.1.3. EVC Servicetemplates4.1.5.1.4. Settings
4.1.5.2. Autoreports4.1.5.2.1. Autoreports4.1.5.2.2. Settings
4.1.5.3. Distributed Monitoring4.1.5.3.1. Satellites
4.1.5.4. Discovery (Check_MK)4.1.5.4.1. MK Checks4.1.5.4.2. MK Servicetemplates4.1.5.4.3. MK Agents
4.1.5.5. i-doit4.1.5.5.1. i-doit systems4.1.5.5.2. Software-Link list4.1.5.5.3. Synchronization4.1.5.5.4. Host comparison
4.1.6. Best practices und Anwendungsbeispiele4.2. Backend
4.2.1. Debugging Methoden4.2.2. Checks manuell ausführen4.2.3. Log Locations
4.3. API
4.3.1. Login4.3.2. Logout4.3.3. Host anlegen4.3.4. Host editieren4.3.5. Host löschen4.3.6. Hosttemplate anlegen4.3.7. Hosttemplate editieren4.3.8. Hosttemplate löschen4.3.9. Hostgruppe anlegen4.3.10. Hostgruppe editieren4.3.11. Hostgruppe löschen4.3.12. Service anlegen4.3.13. Service editieren4.3.14. Service löschen4.3.15. Servicetemplate anlegen4.3.16. Servicetemplate editieren4.3.17. Servicetemplate löschen4.3.18. Servicetemplategroup anlegen4.3.19. Servicetemplategroup editieren4.3.20. Servicetemplategroup löschen4.3.21. Servicegroup anlegen4.3.22. Servicegroup editieren4.3.23. Servicegroup löschen4.3.24. Kommando anlegen4.3.25. Kommando editieren4.3.26. Kommando löschen4.3.27. Node anlegen4.3.28. Node löschen4.3.29. Export4.3.30. User anlegen4.3.31. User editieren4.3.32. User löschen4.3.33. Check Mk
4.3.33.1. Health Scan4.3.33.2. Process Scan4.3.33.3. Check MK Service anlegen
4.3.34. Maps4.3.34.1. Maps anlegen4.3.34.2. Maps editieren4.3.34.3. Maps löschen4.3.34.4. Map Background einfügen4.3.34.5. Variablen für alle Objekte auf einer Map4.3.34.6. Map Items einfügen4.3.34.7. Map Gadgets einfügen4.3.34.8. Map Icons einfügen4.3.34.9. Map Miscellaneous einfügen
4.3.35. Eventkorrelation4.3.35.1. EVK anlegen4.3.35.2. EVK editieren4.3.35.3. EVK Tree anlegen
4.3.36. Distribute Modul4.3.36.1. Satellit anlegen4.3.36.2. Satellit editieren4.3.36.3. Satellit löschen
4.3.37. Best Practice5. Fehlerbehebung
5.1. Dienste5.1.1. Aufgaben
5.1.1.1. Nagios / Naemon5.1.1.2. Statusengine5.1.1.3. OITC Cmd5.1.1.4. phpNSTA5.1.1.5. Gearman-Job-Server5.1.1.6. gearman_worker5.1.1.7. Nginx5.1.1.8. sudo_server5.1.1.9. NPCD
5.1.2. Abhängigkeiten5.1.3. Logs
5.2. Bekannte Fehler und deren Behebung
5.2.1. Debugskript6. Testing
6.1. Kontinuierliche Integration6.2. Paketbau6.3. Unittests6.4. Frontend Testing6.5. Checklisten
7. Ansible8. Cluster
1. Installation
1.1. Vorraussetzungen
Unterstützte Betriebssysteme:
Ubuntu 14.04 LTS "trusty"Ubuntu 16.04 LTS "xenial"Debian Linux 8 "jessie"Debian Linux 9 "stretch"
mind. 2 CPU Kerne (x86-64)
mind. 2 GB Ram
mind 15 GB Festplattenspeicher
1.2. Generelle Installation
Die Installation von openITCOCKPIT erfolgt über die apt repositories des jeweiligen Betriebssystem.
1.2.1. openITCOCKPIT + Naemon (empfohlen)
Key hinzufügen
apt-get install apt-transport-httpsapt-key adv --recv --keyserver hkp://keyserver.ubuntu.com1148DA8E
In manchen Fällen kann es passieren das der Key nicht importiert werden kann. Dann muss man ihn manuell.importieren
Ubuntu 14.04 - Trusty
echo 'deb https://packages.openitcockpit.com/repositories/trustytrusty main' > /etc/apt/sources.list.d/openitcockpit.list
Ubuntu 16.04 - Xenial
echo 'deb https://packages.openitcockpit.com/repositories/xenialxenial main' > /etc/apt/sources.list.d/openitcockpit.list
Debian 8 - Jessie
echo 'deb https://packages.openitcockpit.com/repositories/jessiejessie main' > /etc/apt/sources.list.d/openitcockpit.list
Debian 9 - Stretch
echo 'deb https://packages.openitcockpit.com/repositories/stretchstretch main' > /etc/apt/sources.list.d/openitcockpit.list
Update und Installation
apt-get updateapt-get installopenitcockpit{,-naemon,-statusengine-naemon,-npcd,-message}
Während der Installation fragt phpMyAdmin nach dem Webserver, dort nichts auswählen und weiter (Tab, Enter)
Setup ausführen
/usr/share/openitcockpit/app/SETUP.sh
1.2.2. openITCOCKPIT + Nagios
Key hinzufügen
apt-get install apt-transport-httpsapt-key adv --recv --keyserver hkp://keyserver.ubuntu.com1148DA8E
In manchen Fällen kann es passieren das der Key nicht importiert werden kann. Dann muss man ihn manuellimportieren.
Ubuntu 14.04 - Trusty
echo 'deb https://packages.openitcockpit.com/repositories/trustytrusty main' > /etc/apt/sources.list.d/openitcockpit.list
Ubuntu 16.04 - Xenial
echo 'deb https://packages.openitcockpit.com/repositories/xenialxenial main' > /etc/apt/sources.list.d/openitcockpit.list
Debian 8 - Jessie
echo 'deb https://packages.openitcockpit.com/repositories/jessiejessie main' > /etc/apt/sources.list.d/openitcockpit.list
Debian 9 - Stretch
echo 'deb https://packages.openitcockpit.com/repositories/stretchstretch main' > /etc/apt/sources.list.d/openitcockpit.list
Update und Installation
apt-get updateapt-get install openitcockpit{,-nagios,-ndoutils,-npcd,-message}
Während der Installation fragt phpMyAdmin nach dem Webserver, dort nichts auswählen und weiter (Tab, Enter)
Setup ausführen
/usr/share/openitcockpit/app/SETUP.sh
1.3. Lizenz / Modul Installation
1.3.1. Lizenz erstellen und eintragen
Damit Module installiert werden können muss zunächst eine Lizenz im openITCOCKPIT eingetragen werden.
Eine Dokumentation zum Erstellen und Verwalten von Lizenzen findet man .hier
Im Frontend von openITCOCKPIT findet man unter "Administration / Registration" das Eingabefeld für dieentsprechende Lizenz.
Das openITCOCKPIT benötigt nun eine Verbindung zum Internet damit die eingegebene Lizenz verifiziert werdenkann.
Wenn hier alle Daten korrekt sind, wurde die Lizenz erfolgreich registriert.
1.3.2. Modul Installation
Im Frontend von openITCOCKPIT findet man unter "Administration / Package Manager" eine Liste aller installierbarenModule (abhängig von der eingetragenen Lizenz).
Um ein Modul zu installieren muss man einfach auf den Install Button des jeweiligen Moduls klicken. Dies öffnet eineLightbox, installiert das entsprechende Modul und zeigt Information über die einzelnen Schritte die ausgeführtwerden.
ACHTUNG
In älteren Versionen von openITCOCKPIT muss nach der Modulinstallation der Befehl< 3.0.10-7"openitcockpit-update" auf der Konsole ausgeführt werden.
Oftmals beinhaltet die Modulinstallation auch neue Rechte für Benutzer von openITCOCKPIT. Diese müssen unter"Administration / Manage User Roles" bei der gewünschten Rolle aktiviert werden um das Modul benutzen zukönnen.
1.3.3. Modul Liste
check_nrpeAutoreportCheckMKDistribute (Satellite)MapsIdoitEventcorrelationMassenversandSAPDesignmodulWMIPostgresNWCLinux Basic MonitoringAlfrescoNrpe
1.4. Satelliten
1.4.1. Installation aus Paketen (recommended)
1.4.1.1. Todo auf dem Master
apt-get install openitcockpit-module-distribute phpnsta-masteropenitcockpit-update
Im Anschluss muss man für den Benutzer Nagios einen SSH Key erzeugen.
Der pnpNSTA wird so konfiguriert, das die Verbindungen über Supervisor und SSH getunnelt werden. Dafür werden dieSSH-Keys von Nagios verwendet.
Auch die Konfiguration des AfterExportCommands unter ist schon auf die/etc/openitcockpit/app/Config/after_export.phpSSH Keys des Nagios Benutzers eingestellt.
SSH Keys für Benutzer Nagios auf dem Master System erstellen
su nagiosssh-keygencat /var/lib/nagios/.ssh/id_rsa.pub
1.4.1.2. Todo auf dem Satelliten
Zuerst müssen der Key und das Repository von openitcockpit eingebungen werden. Welches Repository hängt vom OS ab.Siehe .hier
In manchen Fällen kann es zu Problemen beim Importieren des Keys kommen. Dieser kann bei Bedarf auch manuell erzeugt.werden
apt-key adv --recv --keyserver hkp://keyserver.ubuntu.com1148DA8Eecho 'deb https://packages.openitcockpit.com/repositories/xenialxenial main' > /etc/apt/sources.list.d/openitcockpit.listapt-get update
Im Anschluss können alle benötigten Pakete, ganz bequem über APT installiert werden
apt-get install openitcockpit-nagios-satopenitcockpit-statusengine-broker-sat-nagios phpnsta-clientopenitcockpit-monitoring-plugins
Nun muss noch der Public Key (id_rsa.pub), des Benutzers Nagios vom Master system, für den Benutzer Nagios auf demSatelliten importiert werden.
Kopiert dafür einfach die Ausgabe des cat Befehls (siehe oben)
Vorbereitung für Import des public Keys
#Wir sind hier auf dem Satellitensu nagiosmkdir -p /var/lib/nagios/.sshchmod 700 /var/lib/nagios/.sshtouch /var/lib/nagios/.ssh/authorized_keyschmod 600 /var/lib/nagios/.ssh/authorized_keys
Nun kann der Public Key in die Datei /var/lib/nagios/.ssh/authorized_keys eingefügt werden. (Über vim, nano, cat ,etc...)
1.4.1.3. Abschluss
Am Master System, sollte man zur Sicherheit nochmal vom Benutzer Nagios aus, eine SSH-Verbindung auf die Satellitenaufbauen und den Host-Key importieren (ssh mit yes bestätigen)
Danach können die Satelliten in der openITCOCKPIT Oberfläche angelegt werden, ein Export durchgeführt werden und erphpNSTA auf dem Mastersystem gestartet werden.
1.4.2. Naemon Installation und Konfiguration auf dem Satellit von Hand
Installation benötigter Programme
apt-get install build-essential tmux htop screen vnstatphp5-cli php5-dev gearman-job-server php5-gearman help2mangperf vim
Nun kann man mit der eigentlichen Naemon Installation beginnen.
Download & Installation von Naemon
wget https://github.com/naemon/naemon-core/archive/v1.0.3.tar.gztar xzf v1.0.3.tar.gzuseradd --system --shell /bin/bash -d /home/naemon -m naemoncd naemon-core-1.0.3./autogen.sh --prefix=/opt/openitc/nagiosmake allmake installmkdir -p /opt/openitc/nagios/var/spool/checkresultsmkdir -p /opt/openitc/nagios/var/rw/chown -R naemon:www-data /opt/openitc/nagios/varcp -a /opt/openitc/nagios/etc/init.d/naemon /etc/init.d/ln -s /etc/init.d/naemon /etc/init.d/nagiosln -s /opt/openitc/nagios/bin/naemon/opt/openitc/nagios/bin/nagiosln -s /opt/openitc/nagios/bin/naemonstats/opt/openitc/nagios/bin/nagiostatsln -s /opt/openitc/nagios/etc/logrotate.d/naemon/etc/logrotate.d/naemonupdate-rc.d naemon defaults
Anschließend müssen die Werte " " und " " in der Datei " " angepasst werden:config pidfile /etc/init.d/naemon
config="${sysconfdir}/naemon.cfg"
pidfile="${localstatedir}/nagios.lock"
1.4.2.1. phpNSTAClient Installation auf dem Satellit
Download & Installation von phpNSTAClient
wget https://github.com/it-novum/phpNSTA/archive/1.7.5.tar.gztar xzf phpNSTA-1.7.5.tar.gzcd phpNSTA-1.7.5/slave/cp -r phpNSTAClient/ /opt/openitc/nagios/bin/cd naemon_config_sample_v3/cp restart.sh /opt/openitc/nagios/bin/cp naemon_sat.cfg /opt/openitc/nagios/etc/naemon.cfgrm -rf /opt/openitc/nagios/etc/naemon/*ln -s /opt/openitc/nagios/etc/naemon.cfg/opt/openitc/nagios/etc/naemon/naemon.cfgcd /opt/openitc/nagios/etc/mkdir satcd sat/
Nun müssen Anpassungen an der Naemon Config " " vorgenommen werden./opt/openitc/nagios/etc/naemon.cfg
Das Brokermodul der Statusengine muss deaktiviert werden:
#broker_module=/opt/statusengine/statusengine.o
Der Wert " " muss angepasst werden:command_file
command_file=/opt/openitc/nagios/var/rw/oitc.cmd
Folgende Werte sollten bereits auf 1 gesetzt sein aber besser kontrollieren:
obsess_over_services=1
obsess_over_hosts=1
Konfigurationsdatei für den Satelliten anlegen:
Erstellen der Konfigurationsdatei
vim /opt/openitc/nagios/etc/sat/sat.cfg
Inhalt der Konfigurationsdatei
define command{ command_name submit_check_result command_line /opt/openitc/nagios/bin/phpNSTAClient/ocsp.php $TIMET$$HOSTNAME$ $SERVICEDESC$ $SERVICESTATEID$ "$SERVICEOUTPUT$""$SERVICEPERFDATA$"}define command{ command_name submit_host_check_result command_line /opt/openitc/nagios/bin/phpNSTAClient/ochp.php $TIMET$$HOSTNAME$ $HOSTSTATEID$ "$HOSTOUTPUT$"}
Weitere Konfiguration & Installation
mkdir -p /opt/openitc/nagios/etc/configchown naemon:naemon /opt/openitc/nagios/etc/configapt install gearman-toolscp /opt/openitc/nagios/bin/phpNSTAClient/phpNSTAClient/etc/init.d/chmod +x /opt/openitc/nagios/bin/phpNSTAClient/phpNSTAClient.phpcp -a /opt/openitc/nagios/bin/phpNSTAClient/ochp.naemon.php/opt/openitc/nagios/bin/phpNSTAClient/ochp.phpchmod +x /opt/openitc/nagios/bin/phpNSTAClient/ochp.phpcp -a /opt/openitc/nagios/bin/phpNSTAClient/ocsp.naemon.php/opt/openitc/nagios/bin/phpNSTAClient/ocsp.phpchmod +x /opt/openitc/nagios/bin/phpNSTAClient/ocsp.php
Anschließend muss der Wert "use_initscript" in der Datei "/opt/openitc/nagios/bin/phpNSTAClient/config.php" angepasst werden:
use_initscript=true
1.4.2.2. SSH Key erzeugen und austauschen zwischen Master und Satellit
Der Key muss als " " User angelegt werden.root
Erzeugen des SSH Keys auf dem Master
ssh-keygen
Alle Abfragen können einfach bestätigt werden (KEIN Passwort vergeben)
Anzeigen des SSH Keys auf dem Master
cat /root/.ssh/id_rsa.pub
Nun in einer seperaten Shell auf dem Satelliten
Erzeugen der Authorized Keys auf dem Satelliten
su naemonssh root@localhost[Strg]+[D][Strg]+[D]vim /home/naemon/.ssh/authorized_keys # Hier den Inhalt vomMaster 'cat /root/.ssh/id_rsa.pub' einfügenchmod 600 /home/naemon/.ssh/authorized_keyschown naemon:naemon /home/naemon/.ssh/authorized_keys
Test der SSH Verbindung
Die SSH-Verbindung vom Master zum Satelliten muss möglich sein ohne Rückfragen
Auf dem Master
ssh naemon@<IPdesSatelliten>
1.4.2.3. phpNSTA Installation auf dem Master
Installation auf dem Master
wget https://github.com/it-novum/phpNSTA/archive/1.7.5.tar.gztar xzf phpNSTA-1.7.5.tar.gzmv phpNSTA-1.7.5 phpNSTAcp -a phpNSTA /opt/openitc/nagios/bin/cp -a /opt/openitc/nagios/bin/phpNSTA/phpNSTA /etc/init.d/
Anschliessend wird die Konfiguration von phpNSTA angepasst. Folgende Werte müssen in "/opt/openit" gesetzt werden:c/nagios/bin/phpNSTA/config.php
use_spooldir => 3 (abhängig von der Monitoring Engine. Kommentar lesen in der config.php. "3"nur bei Naemon)username => 'naemon'private_path => '/root/.ssh/id_rsa'public_path => '/root/.ssh/id_rsa_pub'grep_for_nagios => 'ps -eaf | grep "/opt/openitc/nagios/bin/ -dnaemon/etc/openitcockpit/nagios.cfg" | grep -v "grep"'
1.4.2.4. Supervisor Installation auf dem Master
Auf dem Master
apt-get install supervisor
Anschliessend wird die Konfiguration von Supervisor angepasst. Folgende Einträge am Ende der Datei "/" eintragen:etc/supervisor/supervisord.conf
[inet_http_server]port = 127.0.0.1:9090username = phpNSTApassword = phpNSTAsSecretPassword
Supervisor neustarten
service supervisor restart
1.4.2.5. Installation und Konfiguration vom Distribute Modul
Im Frontend von openITCOCKPIT unter " " das Distribute ModuleAdministration / Package Managerauswählen und installieren. Anschliessend die Berechtigungen für das Modul unter "Administration / Manage
" setzen. Damit erscheint das Modul nun in der linken Navigation und kann angewählt werden.User Roles
Durch klicken auf den " " Button legt man einen neuen Satelliten mit den entsprechenden Werten an.New
Die vorhandenen Satelliten müssen ihre Konfiguration vom Master erhalten, daher muss man folgendenSymlink erstellen.
Rollout Ordner erstellen und Symlink
mkdir /opt/openitc/nagios/rolloutln -s /opt/openitc/nagios/etc/resource.cfg/opt/openitc/nagios/rollout/resource.cfg
In der Datei " " müssen folgende Werte angepasst/etc/openitcockpit/app/Config/after_export.phpwerden:
'username' => 'naemon''restart_command' => 'sudo service naemon restart'
1.4.2.6. Berechtigung für den Export auf dem Satellit
Der Benutzer naemon benötigt noch Rechte für den Neustart des Service.
Standardeditor setzen und visudo ausführen
export EDITOR=vimvisudo
Am Ende der Datei folgendes einfügen
Standardeditor setzen und visudo ausführen
# See sudoers(5) for more information on "#include"directives:naemon ALL=(ALL) NOPASSWD:ALL
Anschließend wird die Funktion getestet. (Es darf Passwortabfrage kommen)keine
Testen
su naemonsudo whoamiexit
Ordner Besitzer und Gruppe setzen
chown -R naemon:naemon /opt/openitc/nagios/etc/
Inbetriebnahme des Satelliten
service phpNSTAClient start
1.5. Testing und Checklisten
2. Update der openITCOCKPIT Version
2.1. Vorgehensweise
Sobald eine neuere Version von openITCOCKPIT released wird, erscheint im Frontend auf allen Seiten im Kopfbereich eineblaue Flamme um das Update zu signalisieren.
Im Bereich des Packagemanagers findet sich noch ein deutlicher Banner der ebenfalls auf die neue Version hinweist.
Das eigentlich Update wird im Backend ausgeführt. Hierzu verbindet man sich via SSH auf den Server.
SSH Verbindung
Anschließend müssen folgende Befehle auf der Konsole ausgeführt werden.
Update der Paketquellen
apt-get update
Ausführen des Updates inklusive abhängiger Pakete
apt-get dist-upgrade
Ausführen des Update Befehls um Datenbanktabellen bzw ACOs und AROs
upzudaten
openitcockpit-update
Fertig.
Nun sollte geprüft werden das alles reibungslos funktioniert und vorallem ob alle notwendigen Dienste laufen. DieDebugging Seite ist hier hilfreich.
2.2. Pitfalls
Wie bei allen Updates kann natürlich auch hier etwas schief gehen. Daher empfiehlt es sich vorher ein Backup derDatenbank (exkl. der Nagiostabellen) zu machen.
Im besten Fall erstellt man einen Snapshot vor dem Update, so kann man am einfachsten den Ursprungszustandwiederherstellen.
2.3. Testing und Checklisten
3. Migration
3.1. Vorbereitung
3.2. Durchführung
3.3. Testing und Checklisten
3.4. Modulmigration
4. Benutzung
4.1. Frontend
4.1.1. Hauptnavigation
4.1.1.1. Dashboard
Das Dashboard ist die Startseite von openITCOCKPIT und besteht im default aus nur einem "Default" Tab.
Man kann zwischen den verschiedenen Tabs wechseln indem man auf den jeweiligen Tab klickt. Um das obengezeigte Kontextmenü anzuzeigen muss man auf den
kleinen Pfeil neben dem Tabnamen klicken. Folgende Funktionen stehen hier zur Verfügung.
Rename: Umbenennung des TabsStart sharing: Hier kann man seinen konfigurierten Tab inklusive alle Widgets anderen Benutzern zurVerfügung stellenDelete: Löscht den Tab
Über diese Schaltfläche können neue Tabs angelegt werden, dies öffnet folgendes Fenster
Zum Erstellen eines leeren, neuen Tabs muss im oberen Bereich ein Name für den Tab angegeben werdenund anschließend auf den "Save" Button geklickt werden.
Zum Erstellen eines Tabs aus einer Vorlage wählt man einen freigegebenen Tab aus der Liste und klicktanschließend auf "Create". Erstellt man einen Tab aus einer
Vorlage und an dieser Vorlage ändert sich etwas, erscheint beim nächsten Aufruf des Tabs folgender Dialog.
Man kann nun auswählen ob man seinen Tab updaten möchte oder nicht.
Über diese Schaltfläche kann ein Zeitintervall eingestellt werden um automatisch zum nächsten Tab zuwechseln oder bei nur einem Tab diesen nach der definierten Zeit neu zu laden.
Um Widgets dem Tab hinzuzufügen klickt man auf den grünen Widget Button und wählt das entsprechendeWidget aus der Liste aus.
Man kann den Standardtitel jedes Widget ändern indem auf das Zahnrad klickt.
Die Hintergrundfarbe der Kopfzeile kann durch einen Klick auf das Farbfeld angepasst werden.
Durch Klicken dieses Buttons wird das Widget vom Dashboard entfernt.
Mit dieser Schaltfläche kann man das Widget beliebig vergrößern oder verkleinern.
4.1.1.1.1. Welcome Widget:
Zeigt eine Übersicht wieviele Hosts und Services aktuell gemonitored werden und die aktuelle Zeit, Zeitzoneund Datum
4.1.1.1.2. Parentoutages Widget:
Zeigt eine Liste aller nicht erreichbaren verknüpften Eltern Objekte
4.1.1.1.3. Hosts Piechart Widget:
Zeigt ein Tortendiagramm aller Hosts und deren Status
4.1.1.1.4. Hosts Piechart 180 Widget:
Zeigt ein halbes Tortendiagramm aller Hosts und deren Status. Außerdem kann
man durch Klicken des kleinen Pfeils unterhalb der der Torte einer Detailliste einblenden.
4.1.1.1.5. Services Piechart Widget:
Zeigt ein Tortendiagramm aller Services und deren Status
4.1.1.1.6. Services Piechart 180 Widget:
Zeigt ein halbes Tortendiagramm aller Services und deren Status. Außerdem
kann man durch Klicken des kleinen Pfeils unterhalb der der Torte einer Detailliste einblenden.
4.1.1.1.7. Host downtimes Widget:
Zeigt eine Liste aller Hosts die aktuell in einer Downtime sind
4.1.1.1.8. Service downtimes Widget:
Zeigt eine Liste aller Services die aktuell in einer Downtime sind
4.1.1.1.9. Hosts status list Widget:
Zeigt eine individuell gefilterte Liste aller Hosts
4.1.1.1.10. Service status list Widget:
Zeigt eine individuell gefilterte Liste aller Services
4.1.1.1.11. Trafficlight Widget:
Zeigt den Status eines Services in Form einer Ampel
4.1.1.1.12. Tachometer Widget:
Zeigt die aktuellen Performancedaten eines Services in Form eines Tachometers an
4.1.1.1.13. Notice Widget:
Ermöglicht sich eine kleine Notiz auf dem Dashboard zu speichern
4.1.1.1.14. Map Widget:
Zeigt eine Map auf dem Dashboard an.
4.1.1.1.15. Graphgenerator Widget:
Zeigt einen im Graphengenerator konfigurierten Graphen auf dem Dashboard an.
Durch Klicken auf folgende Schaltfläche kann man ein Default Dashboard im aktuellen Tab erstellen.
Dieses beinhaltet folgende Widgets:
WelcomeParentoutagesHosts PiechartServices PiechartHost DowntimesService Downtimes
4.1.1.2. Maps
4.1.1.2.1. Status Map
Unter dem Menüpunkt "Maps / Status Map" erreicht man eine Statuskarte aller Hosts. Durch Klickeneines Hosts zoomt man in die
Karte und erhält detaillierte Informationen über den Host.
Ein Doppelklick auf die Karte setzt den Zoom wieder zurück auf die Ausgangsposition.
Oben links in der Karte wurde eine Hostsuche integriert mit der man nach Hostnamen suchen kann.
4.1.1.2.2. Auto Map
Unter dem Menüpunkt "Maps / Auto Map" erreicht man zunächst einer Übersichtstabelle aller Automaps.Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um eine neue Automap anzulegen
Bietet die Möglichkeit die Automapliste zu filtern
Neue Automap:
Das Eingabeformular zum Anlegen einer neuen Automap beinhaltet im Kopfbereich eine
Schaltfläche.
Führt zurück zur Automapübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem die Automap liegen soll
Recursive containerlookup
Soll der Container rekursiv durchsucht werden. Achtung: Kann insehr großen
Umgebungen zu Performanceproblemen führen
Name Der Name der Automap
Description Eine Beschreibung der Automap
Host RegEx Regulärer Ausdruck zur Suche nach Hosts
Service RegEx Regulärer Ausdruck zur Suche nach Services
Show Ok Sollen Hosts und Services mit dem Status Up bzw. OK angezeigtwerden
Show Warning Sollen Services mit dem Status Warning angezeigt werden
Show Critical Sollen Hosts und Services mit dem Status Down bzw. Critical angezeigtwerden
Show Unknown Sollen Hosts und Services mit dem Status Unreachable bzw. Unknownangezeigt werden
Show Downtime Sollen Hosts und Services in Downtime angezeigt werden
Show Acknowledged Sollen Hosts und Services die acknowledged wurden angezeigt werden
Show Label Soll der Name des Host / Services angezeigt werden
Group by host Sollen Services nach Hosts gruppiert werden
Icon size Wie groß sollen die Icons der Hosts und Services sein
4.1.1.3. Basic Monitoring
4.1.1.3.1. Hosts
Unter dem Menüpunkt "Basic Monitoring / Hosts" erreicht man zunächst einer Übersichtstabelle allerHosts. Diese beinhaltet im Kopfbereich
vier Tabs (Monitored, Not monitored, Disabled, Deleted) zur Auswahl und drei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um einen neuen Host anzulegen
Bietet die Möglichkeit die Hostliste nach Name, IP-Adresse, Output, Status, Acknowledged oder inDowntime zu filtern
Neuer Host:
Das Eingabeformular zum Anlegen eines neuen Hosts beinhaltet im Kopfbereich zwei Tabs (Basicconfiguration, Expert settings) und zwei
Schaltflächen.
Schaltet die Auto DNS Lookup Funktion an oder aus. Diese versucht automatisch den Hostnamen ineine IP-Adresse und umgekehrt aufzulösen.
Führt zurück zur Hostübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Container Der Container in dem der Host liegen soll
Shared Containers Container in denen der Host ebenfalls sichtbar sein soll
Hosttemplate Das Hosttemplate welches verwendet werden soll.
Host Name Der Name des Hosts
Description Eine Beschreibung des Hosts
Address Die IP-Adresse des Hosts
Hostgroups Ist der Host in einer Hostgruppe
Parent hosts Ist der Host Elternobjekten zugeordnet
Notes Bemerkungen zu dem Host
Host URL Die URL des Hosts
Priority Die Priorität des Hosts (hat aktuell noch keinen Einfluss)
Tags Die Tags des Hosts
Satellite Wird der Host vom Mastersystem oder einem Satellitengemonitored
Notification period Der Zeitraum wann der Host Benachrichtigungen auslösen kann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable active checks Wird der Host aktiv gechecked oder werden die Ergebnissepassiv übertragen
Contact Die Kontakte des Hosts
Contactgroups Die Kontaktgruppen des Hosts
Expert settings
Checkcommand Das Kommando zum Checken des Hosts und dessen Argumente
Check period Zeitraum in dem der Host gecheckt wird.
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Viele Einstellungen erbt der Host bei der Auswahl des Hosttemplates. Diese werden durch einKettensymbol angezeigt.
Einstellung wurde vom Hosttemplate geerbt und nicht verändert
Einstellung wurde vom Hosttemplate geerbt aber weicht vom Wert im Template ab
Hiermit können dem Host Macros hinzugefügt werden.
4.1.1.3.2. Services
Unter dem Menüpunkt "Basic Monitoring / Services" erreicht man zunächst einer Übersichtstabelle allerServices. Diese beinhaltet im Kopfbereich
drei Tabs (Monitored, Not monitored, Disabled) zur Auswahl und zwei Schaltflächen.
Link zur Eingabemaske um einen neuen Service anzulegen
Bietet die Möglichkeit die Serviceliste nach Hostname, Servicename, Output, Status, Acknowledged, inDowntime oder Passive zu filtern
Neuer Service:
Das Eingabeformular zum Anlegen eines neuen Services beinhaltet im Kopfbereich zwei Tabs (Basicconfiguration, Expert settings) und eine
Schaltfläche.
Führt zurück zur Serviceübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Host Der Host auf dem der Service angelegt werden soll
Servicetemplate Das Servicetemplate welches verwendet werden soll.
Name Der Name des Service
Description Eine Beschreibung des Service
Servicegroup Ist der Service in einer Servicegruppe
Notes Bemerkungen zu dem Service
Service URL Die URL des Service
Priority Die Priorität des Service (hat aktuell noch keinen Einfluss)
Tags Die Tags des Service
Notification period Der Zeitraum wann der Host Benachrichtigungen auslösen kann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable graph Sollen Performancedaten zu diesem Service gespeichert werden
Enable active checks Wird der Service aktiv gechecked oder werden die Ergebnissepassiv übertragen
Contact Die Kontakte des Service
Contactgroups Die Kontaktgruppen des Service
Expert settings
Checkcommand Das Kommando zum Checken des Service und dessenArgumente
Check period Zeitraum in dem der Service gecheckt wird.
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Status volatile Soll die Option aktiviert sein.is_volatile
Freshness checksenabled
Sollen freshness checks aktiviert sein
Freshness threshold Wielange soll die Freshness sein in Sekunden
Eventhandler Der Eventhandler des Service
Viele Einstellungen erbt der Service bei der Auswahl des Servicetemplates. Diese werden durch einKettensymbol angezeigt.
Einstellung wurde vom Servicetemplate geerbt und nicht verändert
Einstellung wurde vom Servicetemplate geerbt aber weicht vom Wert im Template ab
Hiermit können dem Service Macros hinzugefügt werden.
4.1.1.3.3. Browser
Unter dem Menüpunkt "Basic Monitoring / Browser" erreicht man Übersicht über die angelegt ContainerStruktur und deren Inhalte.
Im Standard werden nur Hosts und Services im aktuell ausgewählten Container angezeigt. Einerekursive Anzeige kann im
Benutzerprofil des Frontend Benutzer aktiviert werden.
Zeigt den Pfad des aktuell gewählten Containers an.
Das Nodes Fenster zeigt alle Container innerhalb des gewählten Containers an.
Die Container im Nodesfenster sind verlinkt und man kann mit deren Hilfe durch die Containerstrukturnavigieren.
4.1.1.3.4. Host templates
Unter dem Menüpunkt "Basic Monitoring / Host Templates" erreicht man zunächst einerÜbersichtstabelle aller Hosttemplates. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um ein neues Hosttemplate anzulegen
Bietet die Möglichkeit die Hosttemplate Liste nach dem Name zu filtern
Neues Hosttemplate:
Das Eingabeformular zum Anlegen eines neuen Hosttemplates beinhaltet im Kopfbereich zwei Tabs(Basic configuration, Expert settings) und eine
Schaltfläche.
Führt zurück zur Hosttemplateübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Container Der Container in dem das Hosttemplate liegen soll
Templatename Der Name des Hosttemplates
Description Eine Beschreibung des Hosttemplates
Hostgroups Sollen Hosts, welche aus diesem Template erstellt werden in einerHostgruppe sein
Notes Bemerkungen zu dem Hosttemplate
Host URL Die URL des Hosttemplates
Priority Die Priorität des Hosttemplates (hat aktuell noch keinen Einfluss)
Tags Die Tags des Hosttemplates
Notification period Der Zeitraum wann das Hosttemplate Benachrichtigungen auslösenkann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable active checks Wird der Host aus diesem Template aktiv gechecked oder werden dieErgebnisse passiv übertragen
Contact Die Kontakte des Hosttemplates
Contactgroups Die Kontaktgruppen des Hosttemplates
Expert settings
Checkcommand Das Kommando zum Checken des Hosts aus diesem Template unddessen Argumente
Check period Zeitraum in dem der Host gecheckt wird.aus diesem Template
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Hiermit können dem Hosttemplate Macros hinzugefügt werden.
4.1.1.3.5. Service templates
Unter dem Menüpunkt "Basic Monitoring / Service Templates" erreicht man zunächst einerÜbersichtstabelle aller Servicetemplates. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um ein neues Servicetemplate anzulegen
Bietet die Möglichkeit die Servicetemplate Liste nach dem Templatename, Servicename oder TemplateBeschreibung zu filtern
Neues Servicetemplate:
Das Eingabeformular zum Anlegen eines neuen Servicetemplates beinhaltet im Kopfbereich zwei Tabs(Basic configuration, Expert settings) und eine
Schaltfläche.
Führt zurück zur Servicetemplateübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Container Der Container in dem das Template ist
Template name Der Name des Servicetemplates
Service name Der Name des Service welcher aus dem Template erzeugt wird
Description Eine Beschreibung des Servicetemplates
Servicegroup Sollen Services, welche aus diesem Template erstellt werden ineiner Servicegruppe sein
Notes Bemerkungen zu dem Servicetemplate
Priority Die Priorität des Servicetemplates (hat aktuell noch keinen Einfluss)
Tags Die Tags des Servicetemplates
Notification period Der Zeitraum wann der Host Benachrichtigungen auslösen kann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable graph Sollen Performancedaten zu diesem Service gespeichert werden
Enable active checks Wird der Service aktiv gechecked oder werden die Ergebnissepassiv übertragen
Contact Die Kontakte des Service welche aus diesem Template erstelltwerden
Contactgroups Die Kontaktgruppen des Service welche aus diesem Templateerstellt werden
Expert settings
Checkcommand Das Kommando zum Checken des Service und dessen Argumente
Check period Zeitraum in dem der Service gecheckt wird.
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Status volatile Soll die Option aktiviert sein.is_volatile
Freshness checksenabled
Sollen freshness checks aktiviert sein
Freshness threshold Wielange soll die Freshness sein in Sekunden
Eventhandler Der Eventhandler des Service welche aus diesem Template erstelltwerden
Hiermit können dem Servicetemplate Macros hinzugefügt werden.
4.1.1.3.6. Service Template Groups
Unter dem Menüpunkt "Basic Monitoring / Service Template Grps." erreicht man zunächst einerÜbersichtstabelle aller Servicetemplategruppen. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um eine neue Servicetemplategruppe anzulegen
Bietet die Möglichkeit die Servicetemplate Liste nach dem Name zu filtern
Neue Servicetemplategruppe:
Das Eingabeformular zum Anlegen einer neuen Servicetemplategruppe beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Servicetemplategruppenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem die Servicetemplategruppe ist
Service Template GroupName
Der Name der Servicetemplategruppe
Service Templates Welche Servicetemplates sollen in der Gruppezusammengefasst werden
Description Eine Beschreibung der Servicetemplategruppe
Jede Servicetemplategruppe besitzt in der Übersichtsliste ein Untermenü, welches sich durch Klickendes Pfeils öffnen lässt.
Edit: Öffnet die Servicetemplategruppe zum EditierenAllocate host group: Rollt die Servicetemplates der Gruppe auf alle Hosts einer Hostgruppe ausAllocate matching host group: Rollt die Servicetemplates der Gruppe auf eine namensgleichHostgruppe ausAllocate host: Rollt die Servicetemplates der Gruppe auf einen einzelnen Host ausDelete: Löscht die Servicetemplategruppe
Beim Ausrollen werden die jeweiligen Hosts angezeigt inklusiver einer Checkbox vor jedemServicetemplate der Gruppe.
Ist die Checkbox angehackt, ist der entsprechende Service noch nicht auf dem Host vorhanden, ist dieCheckbox leer, ist derService bereits auf dem Host vorhanden.
4.1.1.3.7. Host Groups
Unter dem Menüpunkt "Basic Monitoring / Host Groups" erreicht man zunächst einer Übersichtstabellealler Hostgruppen. Diese beinhaltet im Kopfbereich
vier Schaltflächen.
Link zur einer detailierten und erweiterten Hostgruppenübersicht
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Hostgruppe anzulegen
Bietet die Möglichkeit die Hostgruppen Liste nach dem Name und/oder der Beschreibung zu filtern
Neue Hostgruppe:
Das Eingabeformular zum Anlegen einer neuen Hostgruppe beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Hostgruppenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem die Hostgruppe ist
Host Group Name Der Name der Hostgruppe
Description Eine Beschreibung der Hostgruppe
Host Group URL Die URL zur Hostgruppe
Hosts Hosts dieser Hostgruppe
Host templates Hosttemplates dieser Hostgruppe
4.1.1.3.8. Service Groups
Unter dem Menüpunkt "Basic Monitoring / Service Groups" erreicht man zunächst einerÜbersichtstabelle aller Servicegruppen. Diese beinhaltet im Kopfbereich
drei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Hostgruppe anzulegen
Bietet die Möglichkeit die Servicegruppen Liste nach dem Name und/oder der Beschreibung zu filtern
Neue Servicegruppe:
Das Eingabeformular zum Anlegen einer neuen Servicegruppe beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Servicegruppenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem die Servicegruppe ist
Servicegroup Name Der Name der Servicegruppe
Description Eine Beschreibung der Servicegruppe
Servicegroup URL Die URL zur Servicegruppe
Services Services dieser Servicegruppe
Service templates Servicetemplates dieser Servicegruppe
4.1.1.3.9. Contacts
Unter dem Menüpunkt "Basic Monitoring / Contacts" erreicht man zunächst einer Übersichtstabelle allerKontakte. Diese beinhaltet im Kopfbereich
drei bzw. vier Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um einen neuen Kontakt anzulegen
Ermöglicht einen Kontakt aus dem konfigurierten LDAP zu importieren. Wird nur angezeigt wenn dieLDAP Authentifizierung in den Systemeinstellungen aktiviert ist
Bietet die Möglichkeit die Kontakt Liste nach dem Name, Email oder Pager zu filtern
Neuer Kontakt:
Das Eingabeformular zum Anlegen eines neuen Kontakts beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Kontaktübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem der Kontakt ist
Name Der Name des Kontakts
Description Eine Beschreibung des Kontakts
Email Die Email des Kontakts
Phone Telefonnummer des Kontakts
Notification Host
Host Timeperiod Der Zeitraum für Hostbenachrichtigungen
Host Commands Das Host Benachrichtigungskommando
Notifications enabled Sollen Host Benachrichtigungen an diesen Kontakt verschicktwerden
Host notification options Bei welchen Hoststatus soll benachrichtigt werden
Notification Service
Service Timeperiod Der Zeitraum für Servicebenachrichtigungen
Service Commands Das Service Benachrichtigungskommando
Notifications enabled Sollen Service Benachrichtigungen an diesen Kontakt verschicktwerden
Service notificationoptions
Bei welchen Servicestatus soll benachrichtigt werden
Beim Import vom LDAP werden die Felder Name und Email automatisch gesetzt.
4.1.1.3.10. Contactgroups
Unter dem Menüpunkt "Basic Monitoring / Contact Groups" erreicht man zunächst einerÜbersichtstabelle aller Kontaktgruppen. Diese beinhaltet im Kopfbereich
drei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Kontaktgruppe anzulegen
Bietet die Möglichkeit die Kontaktgruppen Liste nach dem Name und/oder der Beschreibung zu filtern
Neue Kontaktgruppe:
Das Eingabeformular zum Anlegen einer neuen Kontaktgruppe beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Kontaktgruppenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem die Kontaktgruppe ist
Contact group name Der Name der Kontaktgruppe
Description Eine Beschreibung der Kontaktgruppe
Contacts Kontakte dieser Kontaktgruppe
4.1.1.3.11. Calendar
Unter dem Menüpunkt "Basic Monitoring / Calendar" erreicht man zunächst einer Übersichtstabelle allerKalender. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um einen neuen Kalender anzulegen
Neuer Kalender:
Das Eingabeformular zum Anlegen eines neuen Kalenders beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Kalenderübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Name Der Name des Kalender
Description Eine Beschreibung des Kalenders
Tenant Welchem Mandanten soll der Kalender zugeordnet sein
4.1.1.3.12. Timeperiod
Unter dem Menüpunkt "Basic Monitoring / Time Periods" erreicht man zunächst einer Übersichtstabellealler Zeiträume. Diese beinhaltet im Kopfbereich
drei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um einen neuen Zeitraum anzulegen
Bietet die Möglichkeit die Zeitraum Liste nach dem Name und/oder der Beschreibung zu filtern
Neuer Zeitraum:
Das Eingabeformular zum Anlegen eines neuen Zeitraums beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Zeitraumübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container in dem der Zeitraum ist
Name Der Name des Zeitraums
Description Eine Beschreibung der Kontaktgruppe
Time ranges Die einzelnen Zeitspannen der Wochentage
Fügt eine Zeitspanne hinzu. Der Wochentag kann gewählt werden und die jeweilige Start- und Endzeit
Entfernt die entsprechende Zeitspanne
4.1.1.3.13. Commands
Unter dem Menüpunkt "Basic Monitoring / Commands" erreicht man zunächst einer Übersichtstabellealler Kommandos. Diese beinhaltet im Kopfbereich
vier Tabs (Commands, Hostchecks, Notifications und Event handler) und zwei Schaltflächen.
Link zur Eingabemaske um ein neues Kommando anzulegen
Bietet die Möglichkeit die Kommando Liste nach dem Name zu filtern
Neues Kommando:
Das Eingabeformular zum Anlegen eines neuen Zeitraums beinhaltet im Kopfbereich zwei Schaltflächen.
Zeigt eine Übersicht aller Benutzer definierten Makros an. Diese können unter "Expert Monitoring / Userdefined Macros" erstellt und bearbeitet werden
Führt zurück zur Kommandoübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Commandtype
Art des Kommandos (Servicecheck, Hostcheck, Notification oderEventhandler)
Name Der Name des Kommandos
Command line Das eigentliche Kommando welches ausgeführt werden soll
Description Die Beschreibung des Kommandos
Mit dieser Schaltfläche können Argumente für das Kommando angelegt werden
Zu Testzwecken enthält dieser Bildschirm ein integriertes Terminal
4.1.1.3.14. Tenants
Unter dem Menüpunkt "Basic Monitoring / Tenants" erreicht man zunächst einer Übersichtstabelle allerMandanten. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um einen neuen Mandanten anzulegen
Bietet die Möglichkeit die Mandanten Liste nach dem Name und/oder der Beschreibung zu filtern
Neuer Mandant:
Das Eingabeformular zum Anlegen eines neuen Mandanten beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Mandantenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Name Der Name des Mandanten
Description Die Beschreibung des Mandanten
is active Ist der Mandant aktiv
Expiration date Wielange soll der Mandant gültig sein (Format dd/mm/yyyy)
Firstname Der Vorname des Mandanten
Lastname Der Nachname des Mandanten
Street Straße
Zipcode Postleitzahl
City Stadt
Max Users Maximale Anzahl der Benutzer (0 für unbegrenzt)
Max Hosts Maximale Anzahl der Hosts (0 für unbegrenzt)
Max Services Maximale Anzahl der Services (0 für unbegrenzt)
4.1.1.3.15. Nodes
Unter dem Menüpunkt "Basic Monitoring / Nodes" erreicht man eine Übersicht aller Nodes in Form einerBaumstruktur des jeweils gewählten Mandanten.
Neue Node:
Um eine neue Node bzw Container anzulegen, muss man den Container auswählen in welchem dieseerstellt werden soll und muss einen Namen angeben
4.1.1.3.16. Locations
Unter dem Menüpunkt "Basic Monitoring / Locations" erreicht man zunächst einer Übersichtstabelle allerLokationen. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um eine neue Lokation anzulegen
Bietet die Möglichkeit die Mandanten Liste nach dem Name und/oder der Beschreibung zu filtern
Neue Lokation:
Das Eingabeformular zum Anlegen einer neuen Lokation beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Lokationsübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container der Lokation
Name Der Name der Lokation
Description Die Beschreibung der Lokation
Timezone Zeitzone der Lokation
Latitude Breitengrad der Lokation
Longitude Längengrad der Lokation
4.1.1.3.17. Graph Generator
Unter dem Menüpunkt "Basic Monitoring / Graph Generator" erreicht man zunächst eine Eingabemaskezum Erstellen von Graphen. Diese beinhaltet im Kopfbereich
zwei Tabs.
Wechselt man auf den "List" Tab erhält man eine Übersichtsliste aller erstellten Graphen
Neuer Graph:
Feldname Pflichtfeld Beschreibung
Name Der Name des Graphen
Time Der Zeitraum der Evaluierung
Host Welcher Host
Service Welcher Service
Nach Auswahl eines Services kann gewählt werden, welche Regeln dieses Services im Graphenangezeigt werden sollen.
Beispielsweise bei einem "Ping" sind das rta und / oder pl.
Es können mehrere Graphen von Services übereinander gelegt werden, auch von unterschiedlichenHosts. HIerzu einfach
den entsprechenden Host und Service wählen und die Regeln dazu auswählen.
4.1.1.3.18. Graph Collections
Unter dem Menüpunkt "Basic Monitoring / Graph Collections" erreicht man zunächst einerÜbersichtstabelle aller Graphensammlungen. Diese beinhaltet im Kopfbereich
eine Schaltflächen.
Link zur Eingabemaske um eine neue Graphensammlung anzulegen
Neue Graphensammlung:
Feldname Pflichtfeld Beschreibung
Name Der Name der Graphensammlung
Description Die Beschreibung der Graphensammlung
Templates Welche Graphen aus dem Graphengenerator sollen verwendet werden
4.1.1.3.19. Downtimes
Unter dem Menüpunkt "Basic Monitoring / Downtimes" erreicht man zunächst einer Übersichtstabellealler Host Downtimes. Diese beinhaltet im Kopfbereich
sieben Schaltflächen und 2 Eingabefelder.
Hier wird ausgewählt welche Art von Downtime angezeigt werden soll. Host, Service oder ReoccuringDowntime stehen zur Auswahl.
Anzahl der gezeigten Ergebnisse.
Hier kann ausgewählt ob abgelaufene Downtimes ausgeblendet werden sollen.
Übernimmt die gewählten Einstellungen und wendet sie auf die Liste an.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um einen neue Downtime anzulegen. Man wählt welche Art von Downtime(Host, Hostgroup, Service) man erstellen möchte.
Bietet die Möglichkeit die Downtime Liste nach dem Host, User und Kommentar zu filtern.
Neue Downtime:
Das Eingabeformular zum Anlegen einer neuen Downtime beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Downtime Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Host Downtime
Host Welcher Host soll eine Downtime erhalten
Maintenance period for Für wen soll die Downtime gelten.
Individual hostHost including servicesHost and dependent Hosts (triggered)Host and dependent Hosts (non-triggered)
Comment Kommentar der Downtime
Recurring downtime Wiederkehrende Downtime
From Startzeitpunkt der Downtime
To Endzeitpunkt der Downtime
Hostgroup Downtime
Hostgroup Welche Hostgroup soll eine Downtime erhalten
Maintenance period for Für wen soll die Downtime gelten.
Hosts onlyHosts including services
Comment Kommentar der Downtime
Recurring downtime Wiederkehrende Downtime
From Startzeitpunkt der Downtime
To Endzeitpunkt der Downtime
Service Downtime
Service Welcher Service soll eine Downtime erhalten
Comment Kommentar der Downtime
Recurring downtime Wiederkehrende Downtime
From Startzeitpunkt der Downtime
To Endzeitpunkt der Downtime
4.1.1.3.20. Log Entries
Unter dem Menüpunkt "Basic Monitoring / Log Entries" erreicht man eine Übersichtstabelle allerLogeinträge. Diese beinhaltet im Kopfbereich
5 Schaltflächen.
Anzahl der gezeigten Ergebnisse.
Hier kann ausgewählt werden welcher Typ von Logeintrag angezeigt werden soll.
Übernimmt die gewählten Einstellungen und wendet sie auf die Liste an.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Bietet die Möglichkeit die Logeintrag Liste nach dem Logeintrag zu filtern.
4.1.1.3.21. Notifications
Unter dem Menüpunkt "Basic Monitoring / Notifications" erreicht man eine Übersichtstabelle allerBenachrichtigungen. Diese beinhaltet im Kopfbereich
5 Schaltflächen und zwei Eingabefelder.
Auswahlmöglichkeit zwischen Host oder Service Benachrichtigungen
Anzahl der gezeigten Ergebnisse.
Übernimmt die gewählten Einstellungen und wendet sie auf die Liste an.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Bietet die Möglichkeit die Benachrichtigungsliste nach Output, Host name, Contact name oderNotification method zu filtern
4.1.1.3.22. Performance Info
Unter dem Menüpunkt "Basic Monitoring / Performance Info" erreicht man eine Übersichtsseite mitverschiedenen Tabellen zu aktiven und
passiven Host- und Servicechecks. Diese zeigen beispielsweise wieviele Checks in den letzten 60Minuten ausgeführt wurden etc.
Außerdem gibt es eine Tabelle mit allgemeinen Informationen zum Monitoring System
Diese Seite beinhaltet einen automatischen Refresh der Daten und wird alle 15 Sekunden neu geladen.
4.1.1.4. Expert Monitoring
4.1.1.4.1. User Defined Macros
Unter dem Menüpunkt "Expert Monitoring / User Defined Macros" erreicht man eine Übersichtstabellealler Benutzer definierten Makros. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Fügt einen Eintrag am Ende der Liste der Makros hinzu
Jedes Makro benötigt einen Eintrag unter Value, die Beschreibung ist optional
Macht den Wert eines Makros sichtbar oder unkenntlich
Löscht das jeweilige Makro
Leere Makros werden automatisch entfernt.
4.1.1.4.2. Host Escalations
Unter dem Menüpunkt "Expert Monitoring / Host Escalations" erreicht man eine Übersichtstabelle allerHost Eskalationen. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Host Eskalation anzulegen
Neue Host Eskalation:
Das Eingabeformular zum Anlegen einer neuen Host Eskalation beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Hosteskalationsübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container In welchem Container soll die Host Eskalation angelegt werden
Hosts Welche Hosts sollen betroffen sein
Hosts excluded Welche Hosts sollen nicht betroffen sein
Hostgroups Welche Hostgruppen sollen betroffen sein
Hostgroups excluded Welche Hostgruppen sollen nicht betroffen sein
First escalation notice Ab wann soll die Eskalation greifen (Anzahl der Benachrichtigungen)
Last escalation notice Wielange soll die Eskalation greifen (Anzahl der Benachrichtigungen)
Notification interval Wie oft soll benachrichtigt werden (in Minuten)
Timeperiod Der Zeitraum indem benachrichtigt werden soll
Contacts Die Kontakte welche benachrichtigt werden sollen
Contactgroups Die Kontaktgruppen welche benachrichtigt werden sollen
Hostescalation options Bei welchem Status soll benachrichtigt werden.
4.1.1.4.3. Service Escalations
Unter dem Menüpunkt "Expert Monitoring / Service Escalations" erreicht man eine Übersichtstabelle allerService Eskalationen. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Service Eskalation anzulegen
Neue Service Eskalation:
Das Eingabeformular zum Anlegen einer neuen Service Eskalation beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Serviceeskalationsübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container In welchem Container soll die Service Eskalation angelegt werden
Services Welche Services sollen betroffen sein
Services excluded Welche Services sollen nicht betroffen sein
Service Groups Welche Servicegruppen sollen betroffen sein
Service Groupsexcluded
Welche sollen nicht betroffen seinServicegruppen
First escalation notice Ab wann soll die Eskalation greifen (Anzahl derBenachrichtigungen)
Last escalation notice Wielange soll die Eskalation greifen (Anzahl derBenachrichtigungen)
Notification interval Wie oft soll benachrichtigt werden (in Minuten)
Timeperiod Der Zeitraum indem benachrichtigt werden soll
Contacts Die Kontakte welche benachrichtigt werden sollen
Contactgroups Die Kontaktgruppen welche benachrichtigt werden sollen
Serviceescalationoptions
Bei welchem Status soll benachrichtigt werden.
4.1.1.4.4. Host Dependencies
Unter dem Menüpunkt "Expert Monitoring / Host Dependencies" erreicht man eine Übersichtstabelle allerHost Abhängigkeiten. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Host Abhängigkeit anzulegen
Neue Host Abhängigkeit:
Das Eingabeformular zum Anlegen einer neuen Host beinhaltet im Kopfbereich eineAbhängigkeitSchaltfläche.
Führt zurück zur Hostabhängigkeitsübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container In welchem Container soll die Host angelegt werdenAbhängigkeit
Hosts Welche Hosts sollen betroffen sein
Dependent hosts Welche Hosts sollen abhängig sein
Hostgroups Welche Hostgruppen sollen betroffen sein
Dependent Hostgroups Welche Hostgruppen sollen abhängig sein
Timeperiod Der Zeitraum indem die Abhängigkeit gelten soll
Inherit parents Sollen Elternobjekte mitbetroffen sein
Execution failure criteria Bei welchen Status soll die Abhängigkeit greifen
Notification failure criteria Bei welchem Status soll benachrichtigt werden.
4.1.1.4.5. Service Dependencies
Unter dem Menüpunkt "Expert Monitoring / Service Dependencies" erreicht man eine Übersichtstabellealler Service Abhängigkeiten. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Service Abhängigkeit anzulegen
Neue Service Abhängigkeit:
Das Eingabeformular zum Anlegen einer neuen Service Abhängigkeit beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Serviceabhängigkeitsübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container In welchem Container soll die Service Abhängigkeit angelegtwerden
Service Welche s sollen betroffen seinService
Dependent Services Welche s sollen abhängig seinService
Servicegroups Welche gruppen sollen betroffen seinService
DependentServicegroups
Welche gruppen sollen abhängig seinService
Timeperiod Der Zeitraum indem die Abhängigkeit gelten soll
Inherit parents Sollen Elternobjekte mitbetroffen sein
Execution failure criteria Bei welchen Status soll die Abhängigkeit greifen
Notification failure criteria Bei welchem Status soll benachrichtigt werden.
4.1.1.4.6. External Commands
Unter dem Menüpunkt "Expert Monitoring / External Commands" erreicht man eine Auswahllisteverschiedener externer Kommandos.
Wählt man ein Kommando aus erhält man detaillierte Information über die API Struktur des Kommandosund einen Beispiel HTTP Request
des Kommandos.
4.1.1.5. Reporting
4.1.1.5.1. Instant Report
Unter dem Menüpunkt "Reporting / Instant Report" erreicht man eine Übersichtstabelle allerInstantreports sofern schon Reports angelegt wurden.
Falls noch keine angelegt wurden landet man direkt im Eingabeformular zum Erstellen einesInstantreports. Die Übersichtsliste beinhaltet im Kopfbereich
zwei Schaltflächen.
Versendet alle Instant Reports an die hinterlegten Kontakte
Link zur Eingabemaske um einen neuen Instant Report anzulegen
Neuer Instant Report:
Das Eingabeformular zum Anlegen eines neuen Instant Reports beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Instant Report Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container In welchem Container soll der Instant Report angelegt werden
Name Der Name des Instant Reports
Evaluation Welche Objekte sollen evaluiert werden (Host, Hosts und Services,Services)
Type Welche Art von Objekten sollen wählbar sein (Hosts, Hostgruppen,Services, Servicegruppen)
Objekte Dieses Feld wird je nach Auswahl vom Typ benannt. Hier werden z.B.: DieHosts ausgewählt
Timeperiod Welcher Zeitraum soll berücksichtigt werden
Reflection state Welche Status sollen berücksichtigt werden (Soft und Hard State, nur HardState)
Considerdowntimes
Sollen Downtimes berücksichtigt werden
Summarydisplay
Soll eine Zusammenfassung im Report angezeigt werden
Send email Soll dieser Report als Email versendet werden.
Send interval Sendeinterval der Emails. (Daily, Weekly, Monthly, Yearly)
Users to send Auswahl der Benutzer welche den Report erhalten sollen
4.1.1.5.2. Downtime Report
Unter dem Menüpunkt "Reporting / Downtime Report" erreicht man das Eingabeformular zum Erstelleneines Downtimereports.
Neuer Downtime Report:
Feldname Pflichtfeld Beschreibung
Evaluation Welche Objekte sollen evaluiert werden (Host, Hosts und Services)
Report format Ausgabeformat des Downtime Reports (PDF, HTML)
Timeperiod Welcher Zeitraum soll berücksichtigt werden
From Beginn der Auswertung
To Ende der Auswertung
Reflectionstate
Welche Status sollen berücksichtigt werden (Soft und Hard State, nur HardState)
4.1.1.5.3. Current State Report
Unter dem Menüpunkt "Reporting / Current State Report" erreicht man das Eingabeformular zumErstellen eines Current State Reports.
Neuer Current State Report:
Feldname Pflichtfeld Beschreibung
Services Welche Services sollen ausgewertet werden
State filter Welcher Status soll berücksichtigt werden (Ok, Warning, Critical, Unknown)
Report format Ausgabeformat des Downtime Reports (PDF, HTML)
4.1.1.6. Documentation
Beinhaltet Informationen zur Benutzung und Funktionsweise von openITCOCKPIT.
4.1.1.7. Administration
4.1.1.7.1. Change Log
Unter dem Menüpunkt "Administration / Change Log" erreicht man eine Übersichtsliste aller Logeinträge.
Oberhalb dieser Liste gibt es die Möglichkeit die Liste nach gewissen Kriterien zu filtern.
Bietet die Möglichkeit das Change Log nach dem Name, dem Typ(Command, Contact, Contactgroup,Host, Hostgroup, Hosttemplate,
Service, Servicegroup, Servicetemplate, Timeperiod) und der Aktion(add, copy,delete,edit) zu filtern.
4.1.1.7.2. Proxy Settings
Unter dem Menüpunkt "Administration / Proxy Settings" erreicht man ein Formular um füropenITCOCKPIT einen Proxy zu verwenden.
Sperrt bzw. entsperrt das Eingabeformular.
Um den Proxy zu verwenden muss die korrekte IP-Adresse und der korrekte Port eingetragen werdenund der Schalter "Enable Proxy" muss
auf "on" gestellt werden.
4.1.1.7.3. Package Manager
Unter dem Menüpunkt "Administration / Package Manager" erreicht man eine Übersicht allerinstallierbaren Module.
Welche Module zur Installation angeboten werden, hängt von dem hinterlegten Lizenzschlüssel desopenITCOCKPIT ab.
Eine Liste aller Module findet man .hier
Installiert das jeweilige Modul
Blendet das Changelog von openITCOCKPIT an.
4.1.1.7.4. Manage Users
Unter dem Menüpunkt "Administration / Manage Users" erreicht man eine Tabelle aller angelegtenBenutzer in openITCOCKPIT.
Die Übersichtsliste beinhaltet im Kopfbereich zwei bzw. dreiSchaltflächen.
Link zur Eingabemaske um einen neuen Benutzer anzulegen
Ermöglicht einen Benutzer aus dem konfigurierten LDAP zu importieren. Wird nur angezeigt wenn dieLDAP Authentifizierung in den Systemeinstellungen aktiviert ist
Bietet die Möglichkeit die Benutzer Liste nach dem Name, Email oder Company zu filtern
Neuer Benutzer:
Das Eingabeformular zum Anlegen eines neuen Benutzers beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Benutzer Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Auf welche Container soll der Benutzer Rechte erhalten (read, readand write)
User role Welche Rolle soll dem Benutzer zugewiesen werden
Status Welchen Status soll der Benutzer haben (active, suspended, deleted)
Email Address Die Email Adresse des Benutzers. Wird für den lokalen Loginverwendet
First Name Der Vorname des Benutzers
Last name Der Nachname des Benutzers
Company Die Firma des Benutzers
Company Position Die Position des Benutzers
Phone Number Die Telefonnummer des Benutzers
LinkedIn ID Die LinkedIn ID des Benutzers
New Password Das Passwort des Benutzers
Confirm newPassword
Das Passwort des Benutzers zur Verifizierung
4.1.1.7.5. Manage User Roles
Unter dem Menüpunkt "Administration / Manage User Roles" erreicht man eine Tabelle aller angelegtenBenutzerrollen in openITCOCKPIT.
Die Übersichtsliste beinhaltet im Kopfbereich zwei Schaltflächen.
Bietet die Möglichkeit einzelne Spalten der Tabelle ein oder auszublenden
Link zur Eingabemaske um eine neue Benutzerrolle anzulegen
Neue Benutzerrolle:
Das Eingabeformular zum Anlegen einer neuen Benutzerrolle beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Benutzerrollen Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Name Name der Benutzerrolle
Description Beschreibung der Benutzerrolle
Über die Benutzerrolle werden die Rechte konfiguriert. Um ein gewisses Recht zu vergeben musslediglich die Checkbox neben
der jeweiligen Aktion/Methode angehakt werden.
Klappt den gesamte Rechtebaum zusammen
Öffnet den gesamten Rechtebaum
Setzt oder entfernt alle Aktionen/Methoden
Setzt oder entfernt alle "View" Rechte
Setzt oder entfernt alle "Create" Rechte
Setzt oder entfernt alle "Edit" Rechte
Setzt oder entfernt alle "Delete" Rechte
4.1.1.7.6. Debugging
Unter dem Menüpunkt "Administration / Debugging" erreicht man eine Informationsseite inopenITCOCKPIT.
Diese zeigt diverse Informationen die hilfreich beim Debugging sein können. Zum Beispiel wird angezeigtob
kritische Services für den Betrieb von openITCOCKPIT laufen.
Außerdem gibt es einen Graphen mit der Load des openITCOCKPIT Servers und dessen Memory usageund Festplattenauslastung.
Weiterhin gibt es eine Statustabelle der Queueing engine, die hinterlegte Email Konfiguration und diekompletten PHP Einstellungen.
4.1.1.7.7. System Failures
Unter dem Menüpunkt "Administration / System Failures" erreicht man zunächst einer Übersichtstabellealler Systemausfälle. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um einen neuen Systemausfall anzulegen
Bietet die Möglichkeit die Systemausfalls Liste nach dem Kommentar zu filtern.
Neuer Systemausfall:
Das Eingabeformular zum Anlegen eines neuen Systemausfalls beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Systemausfall Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Comment Kommentar zum Systemausfall
From Beginn des Systemausfalls
To Ende des Systemausfalls
4.1.1.7.8. System Settings
Unter dem Menüpunkt "Administration / System Settings" erreicht man eine Tabelle allerSystemeinstellungen.
SUDO_SERVER
Feldname Beschreibung
SOCKET Pfad in dem der Sudoserver die Socketdatei versucht zuerzeugen
SOCKET_NAME Name des Sudoserver Sockets
SOCKETPERMISSIONS Berechtigungen des Sudoserver Sockets
FOLDERPERMISSIONS Berechtigungen des Socketordners
API_KEY API Schlüssel des Sudoservers
WORKERSOCKET_NAME Name des Worker Sockets
WORKERSOCKETPERMISSIONS Berechtigungen des Worker Sockets
RESPONSESOCKET_NAME Name des Response Sockets
RESPONSESOCKETPERMISSIONS Berechtigungen des Response Sockets
WEBSERVER
USER Benutzername des Webserver
GROUP Benutzergruppe des Wbserver
MONITORING
USER Benutzername des Monitoring Systems
GROUP Benutzergruppe des Monitoring Systems
FROM_ADDRESS Absender der Benachrichtigungen
FROM_NAME Absender Name der Benachrichtigungen
MESSAGE_HEADER Der Header der Benachrichtigung in der Plaintext Email
ACK_RECEIVER_SERVER Empfangsserver der Acknowledge Emails
ACK_RECEIVER_ADDRESS Emailadresse für Acknowledge Emails
ACK_RECEIVER_PASSWORD Passwort des Acknowledge Emailkontos
CMD Die Pipe für Kommandos des Monitoring Systems
HOST.INITSTATE Der initiale Hoststatus
SERVICE.INITSTATE Der initiale Servicestatus
RESTART Befehl zum Neustart des Monitoring Systems
RELOAD Befehl zum Neuladen der Konfiguration des MonitoringSystems
STOP Befehl zum Stoppen des Monitoring Systems
START Befehl zum Starten des Monitoring Systems
STATUS Befehl zur Statusabfrage des Monitoring Systems
CORECONFIG Pfad zur Konfiguration des Monitoring Systems
STATUS_DAT Pfad zur status.dat des Monitoring Systems
FRESHNESS_THRESHOLD_ADDITION Wert in Sekunden, welcher dem Service check interval beipassiven
Services hinzugefügt wird bevor das Monitoring System einenfreshness_check
ausführt
AFTER_EXPORT Ein Kommando, welches nachdem Export als root Benutzerausgeführt wird
SINGLE_INSTANCE_SYNC Ermöglicht bei Verwendung von Satelliten einzelne Satellitenauszuwählen um
zu vermeiden das die Konfiguration auf alle Satelliten ausgerolltwird.
QUERY_HANDLER Pfad zum Queryhandler des Monitoring Systems
HOST_CHECK_ACTIVE_DEFAULT Soll der Wert "active_checks_enabled" für neue Hosttemplatesim Standard
gesetzt sein
SERVICE_CHECK_ACTIVE_DEFAULT Soll der Wert "active_checks_enabled" für neueServicetemplates im Standard
gesetzt sein
SYSTEM
ADDRESS Die IP-Adresse des openITCOCKPIT Servers
FRONTEND
SYSTEMNAME Der Name des Systems
SHOW_EXPORT_RUNNING Soll im Kopfbereich des Systems angezeigt werden ob geradeein Export läuft
MASTER_INSTANCE Der Name des openITCOCKPITS Hauptsystem
AUTH_METHOD Welche Login Methode soll das Frontend verwenden
LDAP.TYPE Art des angebundenen LDAP
LDAP.ADDRESS IP-Adresse des LDAP Servers
LDAP.PORT Der Port des LDAP Server
LDAP.QUERY Die Abfrage an den LDAP Server
LDAP.BASEDN Ab wo soll im LDAP Verzeichnisbaum gesucht werden
LDAP.USERNAME Benutzer um die LDAP Suche zu starten
LDAP.PASSWORD Passwort des LDAP Benutzers
LDAP.SUFFIX Der Suffix des LDAP
LDAP.USE_TLS Soll die TLS Verschlüsselung aktiviert werden
SSO.CLIENT_ID Die Single Sign On Id vom SSO Server generiert
SSO.CLIENT_SECRET Das Passwort zur Client Id
SSO.AUTH_ENDPOINT Der Authentifizierungsendpunkt
SSO.TOKEN_ENDPOINT Der Tokenendpunkt
SSO.USER_ENDPOINT Der Endpunkt des SSO Servers für Benutzer
SSO.NO_EMAIL_MESSAGE Inhalt der Fehlermeldung falls eine falsche Email angegebenwurde
SSO.LOG_OFF_LINK Link zum Logout des SSO Servers
CERT.DEFAULT_USER_EMAIL Standard Email Adresse falls im Loginzertifikat keine Emailhinterlegt ist
HIDDEN_USER_IN_CHANGELOG Sollen die Benutzernamen im Changelog ausgeblendet werden
CHECK_MK
BIN Pfad zum Check MK binary
MATCH Regex welche services nicht komprimiert werden sollen durchCheck MK
ETC Pfad zu den Check MK Konfigurationsdateien
VAR Pfad zu den Check MK Var Dateien
ACTIVE_CHECK Name des Servicetemplates für den aktiven Check MK Service
ARCHIVE
AGE.SERVICECHECKS Wieviele Wochen sollen die Ergebnisse von Servicechecksgespeichert werden
AGE.HOSTCHECKS Wieviele Wochen sollen die Ergebnisse von Hostchecksgespeichert werden
AGE.STATEHISTORIES Wieviele Wochen sollen Statuswechsel gespeichert werden
AGE.LOGENTRIES Wieviele Wochen sollen die Logeinträge gespeichert werden
AGE.NOTIFICATiONS Wieviele Wochen sollen Benachrichtigungen gespeichertwerden
Wieviele Wochen sollen Kontaktbenachrichtigungengespeichert werden
AGE.CONTACTNOTIFICATIONSMETHODS Wieviele Wochen sollen Kontaktbenachrichtigungsmethodengespeichert werden
INIT
SUDO_SERVER_STATUS Kommando zur Statusabfrage des Sudoservers
GEARMAN_WORKER_STATUS Kommando zur Statusabfrage des Gearman Workers
OITC_CMD_STATUS Kommando zur Statusabfrage der oitc cmd
NPCD_STATUS Kommando zur Statusabfrage des NPCD
NDO_STATUS Kommando zur Statusabfrage der NDO
STATUSENGINE_STATUS Kommando zur Statusabfrage der Statusengine
GEARMAN_JOB_SERVER_STATUS Kommando zur Statusabfrage des Gearman-Job-Servers
PHPNSTA_STATUS Kommando zur Statusabfrage des phpnsta
TICKET_SYSTEM
URL Link zum Ticketsystem
4.1.1.7.9. Cron Jobs
Unter dem Menüpunkt "Administration / Cron Jobs" erreicht man zunächst einer Übersichtstabelle allerangelegten Cron Jobs. Diese beinhaltet im Kopfbereich
eine Schaltflächen.
Link zur Eingabemaske um einen neuen Cron Job anzulegen
Neuer Cron Job:
Das Eingabeformular zum Anlegen eines neuen Cron Jobs beinhaltet im Kopfbereich eine Schaltfläche.
Führt zurück zur Cron Job Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Plugin Welches Plugin soll verwendet werden
Task Welcher Task soll ausgeführt werden
Interval In welchem Interval in Minuten soll der Cron Job ausgeführt werden
4.1.1.7.10. Registration
Unter dem Menüpunkt "Administration / Registration" erreicht man ein Formular in dem man denLizenzschlüssel für openITCOCKPIT eintragen kann.
4.1.1.7.11. Backup & Restore
Unter dem Menüpunkt "Administration / Backup / Restore" erreicht man ein Formular mit dessen Hilfeman Backups der Datenbank erstellen kann oder
vorhandene SQL Dumps wieder einspielen kann. Nicht mehr benötigte Backups können hier auchgelöscht werden.
4.1.1.8. Support
4.1.1.8.1. Report an issue
Unter dem Menüpunkt "Support / Report an issue" hat man verschiedene Möglichkeiten Unterstützungrund um openITCOCKPIT zu erhalten.
Commercial Support: Erzeugt direkt ein Ticket in unserem Ticket System
IRC: Hier kann man in unserem IRC Channel seine Fragen stellen und in direkten Kontakt mit dem vonopenITCOCKPIT treten
Jira: Erzeugt ein neues Bug Ticket
GitHub: Verlinkt auf die Issue Liste von openITCOCKPIT auf GitHub.
4.1.2. Benutzerprofil
4.1.2.1. Change profile
Das Benutzerprofil erreicht man durch einen Klick auf den Benutzernamen der über der Hauptnavigationangezeigt wird.
Im Benutzerprofil kann der angemeldete Benutzer seine persönlichen Daten und Einstellungen anpassen.
Feldname Pflichtfeld Beschreibung
First name Vorname des Benutzers
Last name Nachname des Benutzers
Email Email des Benutzers
Phone Telefonnummer des Benutzers
Show statusstats in menu
Soll eine Schnellansicht des aktuellen Status aller Hosts und Services imKopfbereich auf allen Seiten angezeigt werden
RecursiveBrowser
Soll der Browser unter "Basic Monitoring / Browser" die Container rekursivauswerten (kann in großen Umgebungen Performance Probleme verursachen)
ListelementLength
Wieviele Ergebnisse sollen pro Seite in allen Listen angezeigt werden
Date format In welchem Format sollen Datum und Uhrzeit angezeigt werden
Timezone Welche Zeitzone soll verwendet werden
4.1.2.2. Your picture
Hier kann der Benutzer ein Profilbild hochladen.
4.1.2.3. Change password
Hier kann der Benutzer sein Passwort ändern.
4.1.3. Suche
4.1.3.1. Menü Schnell Suche
Tippen Sie hier den Begriff ein nachdem Sie im Menü suchen und es wird automatisch eine Ergebnissliste
unterhalb der Eingabe Box angezeigt. Zum Aufruf der Seite können Sie direkt auf das Ergebniss klicken.
4.1.3.2. Host Schnell Suche
Tippen Sie hier den Host ein nachdem Sie suchen und drücken Enter. Dadurch wird eine Hostsuche ausgelöst.
4.1.3.3. Erweiterte Suche
Klickt man auf die Lupe erreicht man eine erweiterte Suche. Diese beinhaltet in der Kopfzeile fünf Tabs.
default: Beinhaltet eine Wildcardsuche nach Hosts oder Services inklusive Statusby tags: Beinhaltet eine Wildcardsuche nach Host oder Service Tagsby address: Beinhaltet eine Wildcardsuche nach der IP Adresse eines Hostsby macro: Beinhaltet eine Wildcardsuche nach Host oder Service Macrosby UUID: Beinhaltet eine Suche nach Objekten anhand der UUID
4.1.4. Refresh Monitoring Configuration
Über diese Schaltfläche im Kopfbereich von openITCOCKPIT gelangt man auf die "Refresh Monitoring Configuration"Seite. Diese dient
dazu die Konfigurationsdateien für Nagios/Naemon neu zu erstellen. Dies ist nötig wenn beispielsweise neue Hostsoder Services angelegt
wurden oder man die Konfiguration auf Satelliten Systeme übertragen möchte.
Bei jedem Refresh hat man die Möglichkeit ein Backup der alten Konfiguration zu erstellen. Diese Backups könnenunter "Administration / Backup / Restore"
wieder eingespielt werden.
Wurde die Option "SINGLE_INSTANCE_SYNC" in den System Settings aktiviert, kann man die Satelliten einzelnanwählen um die
Konfiguration auf selbige zu übertragen.
Sobald der Refresh erfolgreich abgeschlossen wurde erscheint eine Hinweismeldung.
4.1.5. Module
4.1.5.1. Event Correlations
4.1.5.1.1. Event Correlations
Unter dem Menüpunkt "Event Correlations / Event Correlations" erreicht man zunächst einerÜbersichtstabelle aller Eventkorrelationen. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um eine neue Eventkorrelation anzulegen
Bietet die Möglichkeit die Eventkorrelations Liste nach dem Name und/oder der Beschreibung zu filtern.
Neue Eventkorrelation:
Das Eingabeformular zum Anlegen einer neuen Eventkorrelation beinhaltet im Kopfbereich eineSchaltfläche.
Führt zurück zur Eventkorrelation Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container In welchem Container soll die EVK angelegt werden
Hosttemplate Welches Hosttemplate soll für die EVK verwendet werden
EVK Name Der Name der EVK
EVK Description Beschreibung der EVK
Erstellen / Modifizieren der Eventkorrelation:
Öffnet das Formular zum Erstellen eines neuen virtuellen Services
Feldname Pflichtfeld Beschreibung
vService Name Der Name des virtuellen Services
Servicetemplate Welches Servicetemplate soll verwendet werden
Services Welche Services sollen korreliert (Auf der ersten Ebene könnenphysische Services gewählt werden. Ab der zweiten Ebene nur nochvirtuelle)
Operator Mit welchem Operator sollen die Services korreliert werden.
ANDOREQUALMIN
OperatorModifier
Wenn der Operator MIN gewählt wurde, wird hier definiert wievieleServices den Status "OK" haben müssen
Speichert die gesamte Eventkorrelation
4.1.5.1.2. EVC Hosttemplates
Unter dem Menüpunkt "Event Correlations / EVC Hosttemplates" erreicht man zunächst einerÜbersichtstabelle aller EVK Hosttemplates. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um ein neues EVK Hosttemplate anzulegen
Bietet die Möglichkeit die EVK Hosttemplate Liste nach dem Name zu filtern.
Neues EVK Hosttemplate:
Das Eingabeformular zum Anlegen eines neuen EVK Hosttemplates beinhaltet im Kopfbereich zwei Tabs
(Basic configuration, Expert settings) und eine
Schaltfläche.
Führt zurück zur EVK Hosttemplateübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Container Der Container in dem das Hosttemplate liegen soll
Templatename Der Name des Hosttemplates
Description Eine Beschreibung des Hosttemplates
Hostgroups Sollen Hosts, welche aus diesem Template erstellt werden in einerHostgruppe sein
Notes Bemerkungen zu dem Hosttemplate
Host URL Die URL des Hosttemplates
Priority Die Priorität des Hosttemplates (hat aktuell noch keinen Einfluss)
Tags Die Tags des Hosttemplates
Notification period Der Zeitraum wann das Hosttemplate Benachrichtigungen auslösenkann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable active checks Wird der Host aus diesem Template aktiv gechecked oder werden dieErgebnisse passiv übertragen
Contact Die Kontakte des Hosttemplates
Contactgroups Die Kontaktgruppen des Hosttemplates
Expert settings
Checkcommand Das Kommando zum Checken des Hosts aus diesem Template unddessen Argumente
Check period Zeitraum in dem der Host aus diesem Template gecheckt wird.
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Hiermit können dem EVK Hosttemplate Macros hinzugefügt werden.
4.1.5.1.3. EVC Servicetemplates
Unter dem Menüpunkt "Event Correlations / EVC Servicetemplates" erreicht man zunächst einerÜbersichtstabelle aller EVK Servicetemplates. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um ein neues EVK Servicetemplate anzulegen.
Bietet die Möglichkeit die EVK Servicetemplate Liste nach dem Name zu filtern.
Neues EVK Servicetemplate:
Das Eingabeformular zum Anlegen eines neuen EVK Servicetemplates beinhaltet im Kopfbereich zweiTabs (Basic configuration, Expert settings) und eine
Schaltfläche.
Führt zurück zur EVK Servicetemplateübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Container Der Container in dem das Template ist
Template name Der Name des Servicetemplates
Service name Der Name des Service welcher aus dem Template erzeugt wird
Description Eine Beschreibung des Servicetemplates
Servicegroup Sollen Services, welche aus diesem Template erstellt werden ineiner Servicegruppe sein
Notes Bemerkungen zu dem Servicetemplate
Priority Die Priorität des Servicetemplates (hat aktuell noch keinen Einfluss)
Tags Die Tags des Servicetemplates
Notification period Der Zeitraum wann der Host Benachrichtigungen auslösen kann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable graph Sollen Performancedaten zu diesem Service gespeichert werden
Enable active checks Wird der Service aktiv gechecked oder werden die Ergebnissepassiv übertragen
Contact Die Kontakte des Service welche aus diesem Template erstelltwerden
Contactgroups Die Kontaktgruppen des Service welche aus diesem Templateerstellt werden
Expert settings
Checkcommand Das Kommando zum Checken des Service und dessen Argumente
Check period Zeitraum in dem der Service gecheckt wird.
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Status volatile Soll die Option aktiviert sein.is_volatile
Freshness checksenabled
Sollen freshness checks aktiviert sein
Freshness threshold Wielange soll die Freshness sein in Sekunden
Eventhandler Der Eventhandler des Service welche aus diesem Template erstelltwerden
Hiermit können dem EVK Servicetemplate Macros hinzugefügt werden.
4.1.5.1.4. Settings
Unter dem Menüpunkt "Event Correlations / Settings" erreicht man die Einstellungen für das EVK Modul.
Feldname Pflichtfeld Beschreibung
EVC_CONSIDER_STATETYPE Soll der Soft- und Hardstate berücksichtigt werden odernur Hardstate
Off = Soft- und Hardstate
On = Nur Hardstate
EVC_CONSIDER_STATE_COUNT Soll die Anzahl der Status berücksichtigt werden?
Beispiel: Ein vService wird aus vier Services korreliert.Ein Service hat den Status Warning, zwei sind Criticalund einer Unknown.
Off = vService => Unknown
On = vService => Critical
Monitoring System Welches Monitoring System wird verwendet
4.1.5.2. Autoreports
4.1.5.2.1. Autoreports
Unter dem Menüpunkt "Reporting / Autoreport" erreicht man zunächst eine Übersichtstabelle allerAutoreports. Diese beinhaltet im Kopfbereich
zwei Schaltflächen.
Link zur Eingabemaske um einen neuen Autoreport anzulegen
Bietet die Möglichkeit die Autoreport Liste nach dem Name, Beschreibung, Report Intervall, Report SendIntervall, Mindest Verfügbarkeit
oder Maximaler Anzahl an Ausfällen zu filtern.
Neuer Autoreport:
Das Eingabeformular zum Anlegen eines neuen Autoreports Ist in drei Schritte aufgeteilt.
Wechselt zum nächsten Schritt
Feldname Pflichtfeld Beschreibung
Tenant Welcher Mandant soll dem Report zugeordnet sein
Report name Der Name des Report
Report description Die Beschreibung des Report
Set start Soll ein Startdatum gesetzt werden
Start date Das Startdatum wenn Option Set start aktiviert ist
Timeperiod Der Zeitraum des Report
Evaluation period Der Evaluierungszeitraum (Jahr, Quartal, Monat, Woche, Tag)
Send interval Das Versendungsintervall (Nie, Jahr, Quartal, Monat, Woche, Tag)
Min allowedavailability
Die Mindestverfügbarkeit. Kann in Prozent oder Minuten angegebenwerden
Max. number ofoutages
Maximale Anzahl der Ausfälle
Graph Graph in Prozent oder Stunden
Reflection state Soll der Soft- und Hardstate berücksichtigt werden oder nur Hardstate
Consider downtimes Sollen Downtimes berücksichtigt werden
Consider holidays Sollen Feiertage berücksichtigt werden
Calendar Welcher Kalendar soll für die Feiertage zur Grunde liegen
Users An welche Benutzer soll der Report verschickt werden
In diesem Schritt werden nun die Hosts und Services zur Auswertung ausgewählt.
Feldname Pflichtfeld Beschreibung
in % Soll der Host/Service prozentual ausgewertet werden
in h Soll der Host/Service zeitlich ausgewertet werden
Alias Nur Hosts: Soll der Alias des Hosts angezeigt werden
Graph Nur Service: Soll der Graph des Service angezeigt werden
Max. outage duration Maximale Dauer des Ausfalls in Minuten
All failures Sollen alle Fehler angezeigt werden
Auf der letzten Seite werden nun nochmal alle Einstellungen zur Kontrolle zusammengefasst.
4.1.5.2.2. Settings
Unter dem Menüpunkt "Reporting / Settings" erreicht man die Konfiguration aller Autoreports.
Feldname Beschreibung
AUTOREPORTS_TENANT_AS_SUBJECT Soll der Mandant als Titel verwendet werdenanstelle des Reportnamens für automatischgenerierte Email Reports
AUTOREPORTS_GENERATE_ONLY_FOR_EXISTING Sollen Reports nur für Hosts und Services erstelltwerden welche vor dem Startdatum schonexistierten
AUTOREPORTS_SEND_REPORT_AS_PDF Soll der Report als PDF verschickt werden
AUTOREPORTS_SEND_REPORT_AS_CSV Soll der Report als CSV verschickt werden
AUTOREPORTS_GENERATE_QUARTERLY_REPORTS Sollen Quartalsreports versendet werden
AUTOREPORTS_SHOW_OUTAGES_IN_DOWNTIME Sollen Ausfälle in Downtimes angezeigt werden
AUTOREPORTS_SHOW_DOWNTIMES Sollen alle Downtimes angezeigt werden
AUTOREPORTS_USE_YEAR_IN_FILENAME Soll das Jahr an den Dateinamen angehängtwerden
AUTOREPORTS_SHOW_SLA_GRAPH Soll der SLA Graph im Report angezeigt werden
AUTOREPORTS_SHOW_SUMMARY_STATISTICS Soll eine Zusammenfassung auf der ersten Seitedes Reports angezeigt werden
AUTOREPORTS_EXTENDED_HOST_DESC Soll der Hostname mit der aktuellen Verfügbarkeitangezeigt werden
AUTOREPORTS_EXTENDED_SERV_DESC Soll die Service Beschreibung mit der aktuellenVerfügbarkeit angezeigt werden
AUTOREPORTS_ERROR_NOTIFICATION Emailadressen, die benachrichtigt werden wennbei der Quartal Report Erstellung Fehler auftreten.Mehrere Emailadressen können mit einemSemikolon getrennt angegeben werden
AUTOREPORTS_STORE_PATH Pfad zu den Report Dateien
4.1.5.3. Distributed Monitoring
4.1.5.3.1. Satellites
Unter dem Menüpunkt "Distributed Monitoring / Satellites" erreicht man zunächst einer Übersichtstabellealler Satelliten. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um einen neuen Satelliten anzulegen.
Neuer Satellit:
Das Eingabeformular zum Anlegen eines neuen Satelliten beinhaltet im Kopfbereich eine
Schaltfläche.
Führt zurück zur Satellitenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Instance name Name des Satelliten
IP address IP-Adresse des Satelliten
Timezone Die Zeitzone des Satelliten
Container Der Container des Satelliten
4.1.5.4. Discovery (Check_MK)
4.1.5.4.1. MK Checks
Unter dem Menüpunkt "Discovery / MK Checks" erreicht man zunächst einer Übersichtstabelle aller MKChecks. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um einen neuen MK Check anzulegen.
Neuer MK Check:
Das Eingabeformular zum Anlegen eines neuen MK Checks beinhaltet im Kopfbereich eine
Schaltfläche.
Führt zurück zur MK Check Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Check name Name des Checks
Servicetemplate Welches Servicetemplate soll der Check verwenden
4.1.5.4.2. MK Servicetemplates
Unter dem Menüpunkt "Discovery / MK Servicetemplates" erreicht man zunächst einer Übersichtstabellealler MK Servicetemplates. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um ein neues MK Servicetemplate anzulegen.
Neues Check_MK Servicetemplate:
Das Eingabeformular zum Anlegen eines neuen Check_MK Servicetemplates beinhaltet im Kopfbereichzwei Tabs (Basic configuration, Expert settings) und eine
Schaltfläche.
Führt zurück zur Check_MK Servicetemplateübersicht (ohne Speichern)
Basic configuration
Feldname Pflichtfeld Beschreibung
Container Der Container in dem das Template ist
Template name Der Name des Servicetemplates
Service name Der Name des Service welcher aus dem Template erzeugt wird
Description Eine Beschreibung des Servicetemplates
Servicegroup Sollen Services, welche aus diesem Template erstellt werden ineiner Servicegruppe sein
Notes Bemerkungen zu dem Servicetemplate
Priority Die Priorität des Servicetemplates (hat aktuell noch keinen Einfluss)
Tags Die Tags des Servicetemplates
Notification period Der Zeitraum wann der Host Benachrichtigungen auslösen kann
Notification interval Der Zeitraum zwischen den Benachrichtigungen
Notifcation options Bei welchen Status soll eine Benachrichtigung ausgelöst werden
Enable graph Sollen Performancedaten zu diesem Service gespeichert werden
Enable active checks Wird der Service aktiv gechecked oder werden die Ergebnissepassiv übertragen
Contact Die Kontakte des Service welche aus diesem Template erstelltwerden
Contactgroups Die Kontaktgruppen des Service welche aus diesem Templateerstellt werden
Expert settings
Checkcommand Das Kommando zum Checken des Service und dessen Argumente
Check period Zeitraum in dem der Service gecheckt wird.
Max. number of checkattempts
Maximale Anzahl der Checkversuche
Checkinterval Der Zeitraum zwischen den Checks
Retryinterval Der Zeitraum zwischen den Checks im Fehlerfall
Flap detection Ist die Flap Detection aktiviert
Status volatile Soll die Option aktiviert sein.is_volatile
Freshness checksenabled
Sollen freshness checks aktiviert sein
Freshness threshold Wielange soll die Freshness sein in Sekunden
Eventhandler Der Eventhandler des Service welche aus diesem Template erstelltwerden
Hiermit können dem Check_MK Servicetemplate Macros hinzugefügt werden.
4.1.5.4.3. MK Agents
Unter dem Menüpunkt "Discovery / MK Agents" erreicht man zunächst einer Übersichtstabelle allerzusätzlichen Check_MK Agenten. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um einen neuen Check_MK Agenten anzulegen.
Neuen Check_MK Agenten:
Das Eingabeformular zum Anlegen eines neuen Check_MK Agenten beinhaltet im Kopfbereich eine
Schaltfläche.
Führt zurück zur Check_MK Agentenübersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
Container Der Container des Agenten
Name Der Name des Agenten
Description Die Beschreibung des Agenten
Command line Die Kommandozeile des Agenten bzw Pfad zum Agenten
4.1.5.5. i-doit
4.1.5.5.1. i-doit systems
Unter dem Menüpunkt "i-doit / i-doit systems" erreicht man zunächst einer Übersichtstabelle aller i-doitSysteme. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um ein neues i-doit System anzulegen.
Neues i-doit System:
Das Eingabeformular zum Anlegen eines neuen i-doit System Ist in vier Schritte aufgeteilt.
Wechselt zum nächsten Schritt
Step 1: API configuration
Feldname Pflichtfeld Beschreibung
Name Der Name des i-doit Systems
URL Die URL zur API Schnittstelle des i-doit Systems
API Key Der API Key des i-doit Systems
Automatically synchronise Sollen Objekte automatisch synchronisiert werden
Step 2: Test connection
Step 3: Select object types
In diesem Schritt können nun die Objekt Typen selektiert werden, welche importiert werden sollen. Fürjeden Typ der ausgewählt wird muss der Container und das Hosttemplate ausgewählt werden welchesverwendet werden soll.
Step 4: Select config items
In diesem Schritt können nun die Objekte selektiert werden, welche importiert werden sollen. Für jedesObjekt das ausgewählt wird kann der Container und das Hosttemplate individuell ausgewählt werden.
4.1.5.5.2. Software-Link list
Unter dem Menüpunkt "i-doit / Software-Link list" erreicht man zunächst einer Übersichtstabelle allerSoftware-Link Listen. Diese beinhaltet im Kopfbereich
eine Schaltfläche.
Link zur Eingabemaske um eine neue Software-Link Liste anzulegen.
Neue Software-Link Liste:
Führt zurück zur Software-Link Listen Übersicht (ohne Speichern)
Feldname Pflichtfeld Beschreibung
i-doit System Welches i-doit System soll verwendet werden
RegEx Regulärer Ausdruck zum filtern der Objekte
Servicetemplategroup Welche Servicetemplategruppe soll auf die Objekte ausgerolltewerden
4.1.5.5.3. Synchronization
Unter dem Menüpunkt "i-doit / Synchronization" kann man die importierten Objekte aus i-doitsynchronisieren.
Startet den Synchronisationsvorgang
4.1.5.5.4. Host comparison
Unter dem Menüpunkt "i-doit / Host comparison" erreicht man eine Übersichtstabelle aller Hosts, welchein openITCOCKPIT aber nicht in i-doit existieren.
4.1.6. Best practices und Anwendungsbeispiele
4.2. Backend
4.2.1. Debugging Methoden
4.2.2. Checks manuell ausführen
4.2.3. Log Locations
4.3. API
4.3.1. Login
URL: https://123.123.123.123/login/login.json
Methode: POST
Response: JSON
Formularfeld Value
data[LoginUser][auth_method] session | ldap
Session
data[LoginUser][email] valide email von einem lokalen User
data[LoginUser][password] Passwort des Users
LDAP
data[LoginUser][samaccountname] LDAP Username
data[LoginUser][password] Passwort des Users
Response bei erfolgreichem Login
{ "message": "Login successful"}
4.3.2. Logout
URL: https://123.123.123.123/login/logout.json
: POSTMethode
: HTMLResponse
4.3.3. Host anlegen
URL: https://123.123.123.123/hosts/add.json
Methode: POST
Response: JSON
Host Requiredforadding
Requiredforediting
Beschreibung vererbt Typ Beispiel
id ID des Hosts integer 123
name Name des Hosts string "default host"
address IP Adresse des Hosts string "123.123.123.123"
satellite_id ID des Satelliten falls dieser Host voneinem Satelliten gemonitored werdensoll
integer 123
own_contacts null = Kontakte aus Template |
1 = vom Template abweichendeKontakte
null |integer
null oder 1
own_contactgroups = Kontaktgruppen aus Template |null
1 = vom Template abweichendeKontaktgruppen
null |integer
null oder 1
own_customvariables = keine Customvariablen |null
1 = Customvariablen verwenden
null |integer
null oder 1
container_id ID des Containers in dem der Hostangelegt wird (1 = /root)
integer 123
shared_container IDs der Container in die der Hostgeshared werden soll
array [ 1, 2, 3, ....]
hosttemplate_id ID des Hosttemplates von der Hostseine Einstellungen erbt
integer 123
description Beschreibung des Hosts string "host Beschreibung"
Hostgroup IDs der Hostgruppen in denen der Hostsein soll
array [ 1, 2, 3, ....]
Parenthost ID des Parenthosts null |integer
null oder 123
notes Notizen zu dem Host string "Lorem ipsum dolor sit amet"
host_url URL des Hosts string "http://hosturl.com"
priority Priorität des Hosts (noch nichtimplementiert)
null |integer
null oder 1
tags Host spezifisches Label string "Lorem ipsum dolor sit amet"
notify_period_id ID der notification_period integer 123
notification_interval Intervall der Notifikationen in Sekunden integer 123
notify_on_recovery Notifikation bei Recovery null |integer
null oder 1
notify_on_down Notifikation bei Down null |integer
null oder 1
notify_on_unreachable Notifikation bei Unreachable null |integer
null oder 1
notify_on_flapping Notifikation bei Flapping null |integer
null oder 1
notify_on_downtime Notifikation bei Downtime null |integer
null oder 1
active_checks_enabled Wird der Host aktiv gecheckt null |integer
null oder 1
Contact IDs der Kontakte array [ 1, 2, 3, ....]
Contactgroup IDs der Kontaktgruppen array [ 1, 2, 3, ....]
command_id ID des Kommandos null |integer
null oder 123
check_period_id ID der check_period null |integer
null oder 123
max_check_attempts Wie oft soll maximal gechecked werden null |integer
null oder Anzahl
check_interval Intervall des checks in Sekunden null |integer
null oder 123
retry_interval Intervall beim retry in Sekunden null |integer
null oder 123
flap_detection_enabled Soll die flap_detection aktiv sein null |integer
null oder 1
flap_detection_on_up flap_detection im Status "up" null |integer
null oder 1
flap_detection_on_down flap_detection im Status "down" null |integer
null oder 1
flap_detection_on_unreachable flap_detection im Status "unreachable" null |integer
null oder 1
JSON zum Erzeugen eines Hosts via REST API
{ "Host" : { "name":"api host", "address":"127.0.0.1", "satellite_id":0, "own_contacts":null, "own_contactgroups":null, "own_customvariables":null, "container_id":1, "shared_container":[], "hosttemplate_id":1, "description":"", "Hostgroup":[], "Parenthost":null, "notes":"", "host_url":"", "priority":null, "tags":"", "notify_period_id":1, "notification_interval":null, "notify_on_recovery":null, "notify_on_down":null, "notify_on_unreachable":null, "notify_on_flapping":null, "notify_on_downtime":null, "active_checks_enabled":null, "Contact":[], "Contactgroup":[], "command_id":$COMMAND_ID, "check_period_id":null, "max_check_attempts":null, "check_interval":null, "retry_interval":null, "flap_detection_enabled":null, "flap_detection_on_up":null, "flap_detection_on_down":null, "flap_detection_on_unreachable":null }, "Hostcommandargumentvalue":[], "Customvariable":{ "1":{ "name":"NAME1", "value":"$VALUE", "objecttype_id":256 } }}
Minimales JSON
{ "Host" : { "name":"api host", "address":"127.0.0.1", "container_id":1, "hosttemplate_id":1, "notification_interval":null, "check_interval":null, "Hostgroup":[], "retry_interval":null }}
Response bei erfolgreichem Aufruf
{ "id": "123"}
Beispielhafter Fehlercode wenn man die Container ID nicht übergibt
{ "error": { "container_id": [ "Invalid container." ] }}
4.3.4. Host editieren
URL: https://123.123.123.123/hosts/edit/$HOST_ID.json
: POSTMethod
: HTMLResponse
JSON zum Editieren eines Hosts via REST API
{ "Host" : { "name":"api host modified", "address":"127.0.0.1", "id" : $HOST_ID, "satellite_id":0, "own_contacts":null, "own_contactgroups":null, "own_customvariables":null, "container_id":1, "shared_container":[], "hosttemplate_id":1, "description":"", "Hostgroup":[], "Parenthost":null, "notes":"", "host_url":"", "priority":null, "tags":"", "notify_period_id":1, "notification_interval":null, "notify_on_recovery":null, "notify_on_down":null, "notify_on_unreachable":null, "notify_on_flapping":null, "notify_on_downtime":null, "active_checks_enabled":null, "Contact":["1"], "Contactgroup":[], "command_id":null, "check_period_id":null, "max_check_attempts":null, "check_interval":null, "retry_interval":null, "flap_detection_enabled":null, "flap_detection_on_up":null, "flap_detection_on_down":null, "flap_detection_on_unreachable":null }, "Hostcommandargumentvalue":[], "Customvariable":[]}
Minimales JSON
{ "Host" : { "name":"api host modified", "address":"127.0.0.1", "id" : $HOST_ID, "container_id":1, "hosttemplate_id":1, "Hostgroup":[], "Parenthost" : null }}
4.3.5. Host löschen
URL: https://123.123.123.123/hosts/delete/$HOST_ID.json
: POSTMethode
: HTMLResponse
Bei fehlerhafter Host Id Übergabe
{ "name": "Invalid host", "message": "Invalid host", "url": "/hosts/delete/$HOST_ID.json"}
4.3.6. Hosttemplate anlegen
URL: https://123.123.123.123/hosttemplates/add.json
Methode: POST
Response: HTML
JSON zum Erzeugen eines Hosttemplates via REST API
{ "Hosttemplate":{ "container_id":1, "name":"api hosttemplate", "description":"api hosttemplate description", "Hostgroup":[], "notes":"api hosttemplate notes", "host_url":"http://api-hosttemplate.url", "priority":1, "tags":"api hosttemplate tags", "notify_period_id":1, "notification_interval":7200, "notify_on_recovery":1, "notify_on_down":1, "notify_on_unreachable":1, "notify_on_flapping":0, "notify_on_downtime":0, "active_checks_enabled":0, "Contact":[1], "Contactgroup":[], "command_id":4, "check_period_id":1, "max_check_attempts":3, "check_interval":600, "retry_interval":60, "flap_detection_enabled":0, "flap_detection_on_up":0, "flap_detection_on_down":0, "flap_detection_on_unreachable":0 }, "Hosttemplatecommandargumentvalue":{ "3":{ "value":"123", "commandargument_id":3 }, "4":{ "value":"456", "commandargument_id":4 } }, "Customvariable":{ "1":{ "name":"NAME1", "value":"value1", "objecttype_id":512 } }}
Minimales JSON
{ "Hosttemplate":{ "container_id":1, "name":"api hosttemplate", "priority":1, "notify_period_id":1, "notification_interval":7200, "notify_on_recovery":1, "notify_on_down":1, "notify_on_unreachable":1, "notify_on_flapping":0, "notify_on_downtime":0, "active_checks_enabled":0, "Contact":[1], "Contactgroup":[], "command_id":4, "check_period_id":1, "max_check_attempts":3, "check_interval":600, "retry_interval":60 }}
Response bei erfolgreichem Aufruf
{ "id": "$HOSTTEMPLATE_ID"}
4.3.7. Hosttemplate editieren
URL: https://123.123.123.123/hosttemplates/edit/$HOSTTEMPLATE_ID.json
Methode: POST
Response: HTML
JSON zum Editieren eines Hosttemplates via REST API
{ "Hosttemplate":{ "container_id":1, "id" : $HOSTTEMPLATE_ID, "name":"api hosttemplate modified", "description":"api hosttemplate descriptionmodified", "Hostgroup":[1], "notes":"api hosttemplate notes modified", "host_url":"http://api-hosttemplate.url/modified", "priority":1, "tags":"api hosttemplate tags modified", "notify_period_id":1, "notification_interval":7200, "notify_on_recovery":1, "notify_on_down":1, "notify_on_unreachable":1, "notify_on_flapping":1, "notify_on_downtime":1, "active_checks_enabled":1, "Contact":[2,3], "Contactgroup":[], "command_id":4, "check_period_id":1, "max_check_attempts":3, "check_interval":600, "retry_interval":60, "flap_detection_enabled":0, "flap_detection_on_up":0, "flap_detection_on_down":0, "flap_detection_on_unreachable":0 }, "Hosttemplatecommandargumentvalue":{ "3":{ "value":"123modified", "commandargument_id":3 }, "4":{ "value":"456modified", "commandargument_id":4 } }, "Customvariable":{ "1":{ "name":"NAME1modified", "value":"value1 modified", "objecttype_id":512 } }}
4.3.8. Hosttemplate löschen
URL: https://123.123.123.123/hosts/delete/$HOSTTEMPLATE_ID.json
: POSTMethode
: HTMLResponse
Bei fehlerhafter HOSTTEMPLATE_ID Übergabe
{ "name": "Invalid hosttemplate", "message": "Invalid hosttemplate", "url": "/hosts/delete/$HOSTTEMPLATE_ID.json"}
4.3.9. Hostgruppe anlegen
URL: https://123.123.123.123/hostgroups/add.json
: POSTMethode
: JSONResponse
JSON zum Erzeugen einer Hostgruppe via REST API
{ "Container":{ "parent_id":"$PARENTCONTAINER_ID", "name":"API Hostgroup name" }, "Hostgroup":{ "description":"API Hostgroup description", "hostgroup_url":"http://API-Hostgroup.url", "Host":[$HOST_ID,$HOST_ID,....], "Hosttemplate":[$HOSTTEMPLATE_ID,$HOSTTEMPLATE_ID,...] }}
Minimales JSON
{ "Container":{ "parent_id":"1", "name":"API Hostgroup name" }}
Response bei erfolgreichem Aufruf
{ "id": "$HOSTGROUP_ID"}
4.3.10. Hostgruppe editieren
URL: https://123.123.123.123/hostgroups/edit/$HOSTGROUP_ID.json
: POSTMethode
: HTMLResponse
JSON zum Erzeugen einer Hostgruppe via REST API
{ "Container":{ "id":$CONTAINER_ID, "parent_id":$PARENT_CONTAINER_ID, "name":"API Hostgroup name modified" }, "Hostgroup":{ "id":$HOSTGROUP_ID, "container_id":$CONTAINER_ID, "description":"API Hostgroup description modified", "hostgroup_url":"http://API-Hostgroup.url/modified", "Host":[$HOST_ID,$HOST_ID,....], "Hosttemplate":[$HOSTTEMPLATE_ID,$HOSTTEMPLATE_ID,...] }}
4.3.11. Hostgruppe löschen
URL: https://123.123.123.123/hostgroups/delete/$HOSTGROUP_ID.json
: POSTMethode
: HTMLResponse
4.3.12. Service anlegen
URL: https://123.123.123.123/services/add.json
Methode: POST
Response: JSON
Service Requiredforadding
Requiredforediting
Beschreibung vererbt Typ Beispiel
name Name des Service string "Ping created with API"
notes Notes des Service string "Notes für diesen Service"
service_url URL des Service string "URL für diesen Service"
own_contacts null = Kontakte aus Template |
1 = vom Template abweichendeKontakte
null |integer
null oder 1
own_contactgroups null = Kontaktgruppen aus Template |
1 = vom Template abweichende Kontaktgruppen
null |integer
null oder 1
own_customvariables null = keine Customvariablen |
1 = Customvariablen verwenden
null |integer
null oder 1
id ID des Service integer 123
host_id ID des Hosts integer 123
servicetemplate_id ID des Servicetemplates integer 123
description Beschreibung des Service string "Beschreibung für diesen Service"
Servicegroup IDs der Servicegruppen in denen derService enthalten ist
array [ 1,2,3 ]
priority Priorität des Service (noch nichtimplementiert)
null |integer
null oder 1
notify_period_id ID der notification_period integer 123
notification_interval Intervall der Notifikationen inSekunden
integer 123
notify_on_recovery Notifikation bei Recovery null |integer
null oder 1
notify_on_warning Notifikation bei Warning null |integer
null oder 1
notify_on_unknown Notifikation bei Unknown null |integer
null oder 1
notify_on_critical Notifikation bei Critical null |integer
null oder 1
notify_on_flapping Notifikation bei Flapping null |integer
null oder 1
notify_on_downtime Notifikation bei Downtime null |integer
null oder 1
process_performance_data Sollen Performancedaten für diesenService gespeichert werden
null |integer
null oder 1
active_checks_enabled Wird dieser Service aktiv gecheckt null |integer
null oder 1
command_id ID des Kommandos integer 123
check_period_id ID der Checkperiode integer 123
max_check_attempts Anzahl der check Versuche integer 123
check_interval Intervall des Checks in Sekunden integer 123
retry_interval Intervall beim retry in Sekunden integer 123
tags Tags des Service string "Tags für diesen Service"
flap_detection_enabled Soll die flap_detection aktiv sein null |integer
null oder 1
flap_detection_on_ok flap_detection im Status "ok" null |integer
null oder 1
flap_detection_on_warning flap_detection im Status "warning" null |integer
null oder 1
flap_detection_on_unknown flap_detection im Status "unknown" null |integer
null oder 1
flap_detection_on_critical flap_detection im Status "critical" null |integer
null oder 1
is_volatile Soll der Service "volatile" sein null |integer
null oder 1
freshness_checks_enabled Soll der freshness_check aktiv sein null |integer
null oder 1
freshness_threshold Freshness Schwellwert in Sekunden integer 123
eventhandler_command_id ID des Eventhandlers null |integer
null oder 1
Contact IDs der Kontakte array [ 1,2,3 ]
Contactgroup IDs der Kontaktgruppen array [ 1,2,3 ]
Minimales JSON
{ "Service" : { "name" : "api service", "servicetemplate_id":1, "notification_interval" : 7200, "check_interval" : 300, "retry_interval" : 60, "host_id": $HOST_ID }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICE_ID"}
4.3.13. Service editieren
URL: https:/123.123.123.123/services/edit/$SERVICE_ID.json
Methode: POST
Response: HTML
JSON zum Editieren eines Services via REST API
{ "Service" :{ "name":"api service", "notes":"", "service_url":"", "own_contacts":null, "own_contactgroups":null, "own_customvariables":null, "id":"$SERVICE_ID", "host_id":"$HOST_ID", "servicetemplate_id":1, "description":null, "Servicegroup":[], "priority":null, "notify_period_id":null,
"notification_interval":null, "notify_on_recovery":null, "notify_on_warning":null, "notify_on_unknown":null, "notify_on_critical":null, "notify_on_flapping":null, "notify_on_downtime":null, "process_performance_data":null, "active_checks_enabled":null, "command_id":null, "check_period_id":null, "max_check_attempts":null, "check_interval":null, "retry_interval":null, "tags":null, "flap_detection_enabled":null, "flap_detection_on_ok":null, "flap_detection_on_warning":null, "flap_detection_on_unknown":null, "flap_detection_on_critical":null, "is_volatile":null, "freshness_checks_enabled":null, "freshness_threshold":null, "eventhandler_command_id":null, "Contact":[], "Contactgroup":[] }, "Servicegroup":{ "Servicegroup":[] }, "Customvariable":{ "1":{ "name":"NAME1", "value":"$VALUE", "objecttype_id":2048
} }}
Minimales JSON
{ "Service" :{ "name":"api service", "id":"$SERVICE_ID", "host_id":"$HOST_ID", "Servicegroup" : [], "servicetemplate_id":"1" }, "Servicegroup":{ "Servicegroup":[] }}
4.3.14. Service löschen
URL: https://123.123.123.123/services/delete/$SERVICE_ID.json
Methode: POST
Response: HTML
Bei fehlerhafter $Service_ID Übergabe
{ "name": "Invalid service", "message": "Invalid service", "url": "/services/delete/$SERVICE_ID.json"}
4.3.15. Servicetemplate anlegen
URL: https://123.123.123.123/servicetemplates/add.json
Methode: POST
Response: JSON
JSON zum Erzeugen eines Servicetemplates via REST API
{ "Servicetemplate":{ "container_id":1, "template_name":"api servicetemplate", "name":"api service through api servicetemplate", "description":"api servicetemplate description", "Servicegroup":[], "notes":"api servicetemplate notes", "priority":1, "notify_period_id":1, "notification_interval":7200, "notify_on_recovery":1, "notify_on_warning":1, "notify_on_unknown":1, "notify_on_critical":1, "notify_on_flapping":0, "notify_on_downtime":0, "process_performance_data":1, "active_checks_enabled":1, "Contact":[1], "Contactgroup":[], "command_id":3, "check_period_id":1, "max_check_attempts":3, "check_interval":300, "retry_interval":60, "tags":"api servicetemplate tags", "flap_detection_enabled":1, "flap_detection_on_ok":0, "flap_detection_on_warning":1, "flap_detection_on_unknown":0, "flap_detection_on_critical":1, "is_volatile":0, "freshness_checks_enabled":0, "freshness_threshold":60, "eventhandler_command_id":0 }, "Servicetemplatecommandargumentvalue":{ "1":{ "value":"", "commandargument_id":1 }, "2":{ "value":"", "commandargument_id":2 } } "Customvariable":{ "1":{ "name" : "Custom1", "value" : "$VALUE",
"objecttype_id":4096
} }}
Minimales JSON
{ "Servicetemplate":{ "container_id":1, "template_name":"api servicetemplate minimal", "name":"api service through api servicetemplate", "notify_period_id":1, "notification_interval":7200, "notify_on_recovery":1, "notify_on_warning":1, "notify_on_unknown":1, "notify_on_critical":1, "notify_on_flapping":0, "notify_on_downtime":0, "command_id":3, "check_period_id":1, "max_check_attempts":3, "check_interval":300, "retry_interval":60 }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICETEMPLATE_ID"}
4.3.16. Servicetemplate editieren
URL: https://123.123.123.123/servicetemplates/edit/$SERVICETEMPLATE_ID.json
Methode: POST
Response: JSON
JSON zum Erzeugen eines Servicetemplates via REST API
{ "Servicetemplate":{ "container_id":1, "id":"1",
"template_name":"api servicetemplate", "name":"api service through api servicetemplate", "description":"api servicetemplate description", "Servicegroup":[], "notes":"api servicetemplate notes", "priority":1, "notify_period_id":1, "notification_interval":7200, "notify_on_recovery":1, "notify_on_warning":1, "notify_on_unknown":1, "notify_on_critical":1, "notify_on_flapping":0, "notify_on_downtime":0, "process_performance_data":1, "active_checks_enabled":1, "Contact":[1], "Contactgroup":[], "command_id":3, "check_period_id":1, "max_check_attempts":3, "check_interval":300, "retry_interval":60, "tags":"api servicetemplate tags", "flap_detection_enabled":1, "flap_detection_on_ok":0, "flap_detection_on_warning":1, "flap_detection_on_unknown":0, "flap_detection_on_critical":1, "is_volatile":0, "freshness_checks_enabled":0, "freshness_threshold":60, "eventhandler_command_id":0 }, "Servicetemplatecommandargumentvalue":{ "1":{ "value":"", "commandargument_id":1 }, "2":{ "value":"", "commandargument_id":2 } } "Customvariable":{ "1":{ "name" : "Custom1", "value" : "$VALUE", "objecttype_id":4096
} }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICETEMPLATE_ID"}
4.3.17. Servicetemplate löschen
URL: https://123.123.123.123/servicetemplates/delete/$SERVICETEMPLATE_ID.json
Methode: POST
Response: JSON
Bei fehlerhafter $SERVICETEMPLATE_ID Übergabe
{ "name": "Invalid servicetemplate", "message": "Invalid servicetemplate", "url":"/servicetemplates/delete/$SERVICETEMPLATE_ID.json"}
4.3.18. Servicetemplategroup anlegen
URL: https://123.123.123.123/servicetemplategroups/add.json
Methode: POST
Response: JSON
JSON zum Erzeugen einer Servicetemplategroup via REST API
{ "Container":{ "parent_id":"$CONTAINER_ID", "name":"API Servicetemplategroup" }, "Servicetemplategroup":{ "Servicetemplate":[$SERVICETEMPLATE_ID,$SERVICETEMPLATE_ID,...], "description":"API Servicetemplategroup Description" }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICETEMPLATEGROUP_ID"}
4.3.19. Servicetemplategroup editieren
URL: https://123.123.123.123/servicetemplategroups/edit/$SERVICETEMPLATEGROUP_ID.json
Methode: POST
Response: HTML
JSON zum Erzeugen einer Servicetemplategroup via REST API
{ "Container":{ "id":$CONTAINER_ID, "parent_id":"$PARENT_ID", "name":"API Servicetemplategroup modified" }, "Servicetemplategroup":{ "id":$SERVICETEMPLATEGROUP_ID, "container_id":$CONTAINER_ID, "Servicetemplate":[$SERVICETEMPLATE_ID,$SERVICETEMPLATE_ID,...], "description":"API Servicetemplategroup Description modified" }}
4.3.20. Servicetemplategroup löschen
URL: https://123.123.123.123/servicetemplategroups/delete/$SERVICETEMPLATEGROUP_ID.json
Methode: POST
Response: HTML
4.3.21. Servicegroup anlegen
URL: https://123.123.123.123/servicegroups/add.json
Methode: POST
Response: JSON
JSON zum Erzeugen einer Servicegroup via REST API
{ "Container":{ "parent_id":"$PARENT_CONTAINER_ID", "name":"API Servicegroup" }, "Servicegroup":{ "description":"API Servicegroup Description", "servicegroup_url":"http://API-Servicegroup.url", "Service":[$SERVICE_ID,$SERVICE_ID,...], "Servicetemplate":[$SERVICETEMPLATE_ID,$SERVICETEMPLATE_ID,...] }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICEGROUP_ID"}
4.3.22. Servicegroup editieren
URL: https://123.123.123.123/servicegroups/edit/$SERVICEGROUP_ID.json
Methode: POST
Response: JSON
JSON zum Erzeugen einer Servicegroup via REST API
{ "Container":{ "id":$CONTAINER_ID, "parent_id":$PARENT_CONTAINER_ID, "name":"API Servicegroup modified" }, "Servicegroup":{ "id":$SERVICEGROUP_ID, "container_id":$CONTAINER_ID, "Service":[$SERVICE_ID,$SERVICE_ID,...], "Servicetemplate":[$SERVICETEMPLATE_ID,$SERVICETEMPLATE_ID,...], "servicegroup_url":"http://API-Servicegroup.url/modified", "description":"API Servicegroup Description modified" }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICEGROUP_ID"}
4.3.23. Servicegroup löschen
URL: https://123.123.123.123/servicegroups/delete/$SERVICEGROUP_ID.json
Methode: POST
Response: HTML
4.3.24. Kommando anlegen
URL: https://123.123.123.123/commands/add.json
Methode: POST
Response: JSON
Command_type
1 Servicecheck Command
2 Hostcheck Command
3 Notification Command
4 Eventhandler Command
JSON zum Erzeugen eines Kommandos via REST API
{ "Command" : { "name" : "API Example Command with arguments", "command_line" : "$USER1$/check_ping -H$HOSTADDRESS$ -w $ARG1$ -c $ARG2$ -p 5", "command_type" : 1 }, "Commandargument" : { "0":{ "name" : "$ARG1$", "human_name" : "Warning" }, "1":{ "name" : "$ARG2$", "human_name" : "Critical" } }}
Response bei erfolgreichem Aufruf
{ "id": "$COMMAND_ID", "command_arguments": [ { "Commandargument": { "name": "$ARG1$", "human_name": "Warning", "command_id": "$COMMAND_ID", "modified": "2017-03-30 09:29:26", "created": "2017-03-30 09:29:26", "id": "$COMMANDARGUMENT_ID" } }, { "Commandargument": { "name": "$ARG2$", "human_name": "Critical", "command_id": "$COMMAND_ID", "modified": "2017-03-30 09:29:26", "created": "2017-03-30 09:29:26", "id": "$COMMANDARGUMENT_ID" } } ]}
4.3.25. Kommando editieren
URL: https://123.123.123.123/commands/edit/$COMMAND_ID.json
Methode: POST
Response: JSON
JSON zum Erzeugen eines Kommandos via REST API
{ "Command":{ "id":"$COMMAND_ID", "command_type":"1", "name":"API Example Command with arguments", "command_line":"$USER1$\/check_ping -H$HOSTADDRESS$ -w $ARG1$ -c $ARG2$ -p 5", "description":"api description" }, "Commandargument":[ { "id":"$COMMANDARGUMENT_ID", "command_id":"$COMMAND_ID", "name":"$ARG1$", "human_name":"Warning" }, { "id":"$COMMANDARGUMENT_ID", "command_id":"$COMMAND_ID", "name":"$ARG2$", "human_name":"Critical" } ]}
4.3.26. Kommando löschen
URL: $COMMAND_ID.jsonhttps://123.123.123.123/commands/delete/
Methode: POST
Response: JSON
Bei fehlerhafter $COMMAND_ID Übergabe
{ "name": "Invalid command", "message": "Invalid command", "url": "/commands/delete/$COMMAND_ID.json"}
4.3.27. Node anlegen
URL: https://123.123.123.123/containers/add.json
Methode: POST
Response: JSON
JSON zum Erzeugen einer Node via REST API
{ "Container":{ "parent_id":"$PARENT_CONTAINER_ID", "name":"API Node", "containertype_id":5 }}
Response bei erfolgreichem Aufruf
{ "id": "$NODE_ID"}
4.3.28. Node löschen
URL: https://123.123.123.123/containers/delete/$NODE_ID.json
Methode: POST
Response: HTML
4.3.29. Export
URL: https://123.123.123.123/exports/launchExport/1.json
Methode: GET / POST
Response: JSON
Bei diesem Aufruf muss folgender Header gesetzt werden damit der Aufruf erfolgreich ist.
Header Value
X-Requested-With XMLHttpRequest
Response bei erfolgreichem Aufruf
{ "export": { "exportRunning": false, "exportStarted": true }}
4.3.30. User anlegen
URL: https://123.123.123.123/users/add.json
Methode: POST
Response: JSON
User anlegen
{ "User":{ "Container":[$CONTAINER_IDs], "usergroup_id":1, "status":1, "email":"[email protected]", "firstname":"API Firstname", "lastname":"API Lastname", "company":"Company", "position":"Position", "phone":"phone", "linkedin_id":"linkedid", "new_password":"password123", "confirm_new_password":"password123", "showstatsinmenu":0 }, "ContainerUserMembership":{ "1":2, "6":1 }}
Response bei erfolgreichem Aufruf
{ "id": "$USER_ID"}
4.3.31. User editieren
URL: https://123.123.123.123/users/edit/$USER_ID.json
Methode: POST
Response: HTML
User editieren
{ "User":{ "id":$USER_ID, "Container":[$CONTAINER_IDs], "usergroup_id":1, "status":1, "email":"[email protected]", "firstname":"API Firstname", "lastname":"API Lastname", "company":"Company", "position":"Position", "phone":"phone", "linkedin_id":"linkedid", "new_password":"password123", "confirm_new_password":"password123", "showstatsinmenu":0 }, "ContainerUserMembership":{ "1":2, "6":1 }}
4.3.32. User löschen
URL: https://123.123.123.123/users/delete/$USER_ID.json
Methode: POST
Response: HTML
4.3.33. Check Mk
4.3.33.1. Health Scan
URL: https://123.123.123.123/mk_module/scans/ajaxHealthList/$HOST_ID.json
Methode: POST
Response: JSON
Response bei erfolgreichem Aufruf
{ "discoveryResult":{ "result":{ "fb8326e1edbd06b1bf6ea0332e089055":{ "checktype":"kernel.util", "item":"None", "params":"{}", "description":"CPU utilization", "servicetemplate_id":"39" }, "bbc503ab35300697c20c6287c3b1647d":{ "checktype":"diskstat", "item":"SUMMARY", "params":"{}", "description":"Disk IO SUMMARY", "servicetemplate_id":"37" }, "6a4d575da2db7edd6606f60b5cf752e7":{ "checktype":"lnx_if", "item":"2", "params":"{'state': ['1'], 'errors':(0.01, 0.1), 'speed': 0}", "description":"Interface 2", "servicetemplate_id":"47" } }, "missing_template":[] }}
4.3.33.2. Process Scan
URL: https://123.123.123.123/mk_module/scans/ajaxProcessList/$HOST_ID.json
Methode: POST
Response: JSON
Response bei erfolgreichem Aufruf
{ "MkProcesses":{ "ps":{ "a45da96d0bf6575970f2d27af22be28a":{ "checktype":"ps", "item":"System", "description":"proc_System", "servicetemplate_id":"29" }, "b7622e2072ff39e8eb1a810275a35936":{ "checktype":"ps", "item":"smss.exe", "description":"proc_smss.exe", "servicetemplate_id":"29" } }, "services":{ "d8f15ee2b5b427725462f6f1205d7f61":{ "checktype":"services", "item":"AeLookupSvc", "description":"service_AeLookupSvc", "servicetemplate_id":"30" }, "d399903282f1cd2ec81520d1e906c28c":{ "checktype":"services", "item":"Alerter", "description":"service_Alerter", "servicetemplate_id":"30" }, "1204a5c2ac4e8891367b2b2c03f72bb8":{ "checktype":"services", "item":"ALG", "description":"service_ALG", "servicetemplate_id":"30" } } }}
4.3.33.3. Check MK Service anlegen
Um einen Check_MK Service anzulegen müssen zwei URL Aufrufe stattfinden. Zunächst muss dieService Api angesprochen werden:
URL: https://123.123.123.123/services/add.json
Methode: POST
Response: JSON
Service anlegen
{ "Service" : { "name" : "$DESCRIPTION", "servicetemplate_id":$SERVICETEMPLATE_ID, "host_id":$HOST_ID, "own_contacts" : null, "own_contactgroups" : null, "service_type" : 8 }}
Response bei erfolgreichem Aufruf
{ "id": "$SERVICE_ID"}
Nun wird das MK Modul aufgerufen
URL: https://123.123.123.123/mk_module/mkservicedata/add.json
Methode: POST
Response: JSON
Variable Value
service_id ID des eben erzeugten Service
host_id Die ID des Hosts
is_process 1 wenn checktype = service oder ps. Ansonsten 0
check_name Checktype des Checks welcher angelegt werden soll.
check_item Item des Checks welcher angelegt werden soll.
CheckMK Service anlegen
{ "service_id" : $SERVICE_ID, "host_id":$HOST_ID, "is_process" : 1, "check_name" : "$CHECKTYPE", "check_item" : "$ITEM"}
Response bei erfolgreichem Aufruf
{ "id": "$CHECK_MK_SERVICE_ID"}
4.3.34. Maps
4.3.34.1. Maps anlegen
URL: https://123.123.123.123/map_module/maps/add.json
Methode: POST
Response: JSON
Variable Required Beschreibung Typ Beispiel
container_id IDs der Container in welchendie Map angelegt werden soll
array [ 1, 2, 3, ....]
name Name der Map string "Api Map Name"
title Titel der Map string "Api Map Titel"
refresh_interval Intervall in der sich die Map imAnsichtsmodus neuladen sollin Millisekunden
integer 90000
Neue Map anlegen
{ "Map":{ "container_id":[$CONTAINER_IDs], "name":"Api Map Name", "title":"Api Map Title", "refresh_interval":90000 }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.34.2. Maps editieren
URL: https://123.123.123.123/map_module/maps/edit/$MAP_ID.json
Methode: POST
Response: JSON
Neue Map anlegen
{ "Map":{ "id" : $MAP_ID, "container_id":[$CONTAINER_IDs], "name":"Api Map Name Modified", "title":"Api Map Title Modified", "refresh_interval":90000 }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.34.3. Maps löschen
URL: https://123.123.123.123/map_module/maps/delete/$MAP_ID.json
Methode: POST
Response: HTML
4.3.34.4. Map Background einfügen
URL: https://123.123.123.123/map_module/mapeditors/edit/$MAP_ID.json
Methode: POST
Response: HTML
Neue Map anlegen
{ "Map":{ "id":$MAP_ID, "container_id" : [$CONTAINER_IDs], "background":$UUID.jpg, "name":"Api Map Name Modified", "title":"Api Map Title Modified" }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.34.5. Variablen für alle Objekte auf einer Map
Variable Beschreibung Typ Beispiel
$MAP_ID ID der Map integer 123
container_id IDs der Container in welchen die Map angelegtwerden soll
array [1,2,3,....]
Name des Iconsets welches verwendet werden soll string arrows_128px | globe_64px | ...
$TYPE Typ des eingebunden Objekts string host | hostgroup | service |servicegroup | map
$OBJECT_ID ID des eingebundenen Objekts integer $HOST_ID | $HOSTGROUP_ID |etc
x Koordinate auf der x-Achse integer 123
y Koordinate auf der y-Achse integer 123
Gadget spezifisch
gadget Name des Gadgets string Tacho | TrafficLight | Cylinder | Text| RRDGraph
transparent_background Soll der Hintergrund des Gadget transparent sein integer 0 | 1 (default 0)
Mapline spezifisch
startX Startpunkt auf der X-Achse integer 123
endX Endpunkt auf der X-Achse integer 123
startY Startpunkt auf der Y-Achse integer 123
endY Endpunkt auf der X-Achse integer 123
Maptext spezifisch
text Freitext string Lorem ipsum dolor
Folgender BB-Code kann innerhalb des Textfeldes verwendet werden
[color='#356E35'][/color] (Hexadezimal Farbwert)[text='small'][/text] (Möglichkeiten: xx-small | x-small | small | large | x-large | xx-large)[b][/b][i][/i][u][/u][left][/left][center][/center][right][/right][justify][/justify][url='2' tab]Map link[/url] (url= Mapid, tab = link im neuen Tab öffnen)[url=' ' tab]link descriptition[/url] (url = url, )https://www.google.de tab = link im neuen Tab öffnen
4.3.34.6. Map Items einfügen
URL: https://123.123.123.123/map_module/mapeditors/edit/$MAP_ID.json
Methode: POST
Response: HTML
Neue Map anlegen
{ "Map":{ "id":$MAP_ID, "container_id" : [$CONTAINER_IDs], "name":"Api Map Name Modified", "title":"Api Map Title Modified" }, "Mapitem":{ "0":{ "x":"10", "y":"456", "iconset":"$ICONSET", "type":"$TYPE", "object_id":"$OBJECT_ID", "map_id":$MAP_ID }, "1":{ "x":"230", "y":"170", "iconset":"$ICONSET", "type":"$TYPE", "object_id":"$OBJECT_ID", "map_id":$MAP_ID } }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.34.7. Map Gadgets einfügen
URL: https://123.123.123.123/map_module/mapeditors/edit/$MAP_ID.json
Methode: POST
Response: HTML
Neue Map anlegen
{ "Map":{ "id":$MAP_ID, "container_id" : [$CONTAINER_IDs], "name":"Api Map Name Modified", "title":"Api Map Title Modified" }, "Mapgadget":{ "0":{ "x":"58", "y":"133", "elementUuid":"1bb3dd33-5a1b-4bb7-99ce-b64bd7b95ea7", "gadget":"Tacho", "type":"service", "object_id":"43", "transparent_background":"0", "map_id":$MAP_ID } }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.34.8. Map Icons einfügen
URL: https://123.123.123.123/map_module/mapeditors/edit/$MAP_ID.json
Methode: POST
Response: HTML
Neue Map anlegen
{ "Map":{ "id":$MAP_ID, "container_id" : [$CONTAINER_IDs], "name":"Api Map Name Modified", "title":"Api Map Title Modified" }, "Mapicon":{ "0":{ "x":"137", "y":"51", "icon":"Fallout_PIP-Boy.jpg" } }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.34.9. Map Miscellaneous einfügen
URL: https://123.123.123.123/map_module/mapeditors/edit/$MAP_ID.json
Methode: POST
Response: HTML
Neue Map anlegen
{ "Map":{ "id":$MAP_ID, "container_id" : [$CONTAINER_IDs], "name":"Api Map Name Modified", "title":"Api Map Title Modified" }, "Mapline":{ "0":{ "startX":"105", "endX":"373", "startY":"701", "endY":"174", "iconset":"std_line", "type":"host", "object_id":"16", "map_id":$MAP_ID } }, "Maptext":{ "0":{ "text":"ssdfg[b]sd[\/b]fhsthsdfghwr[center]thwq[\/center]w[text='x-large']hwsrghwrth[\/text]", "x":"444", "y":"292", "map_id":$MAP_ID } }}
Response bei erfolgreichem Aufruf
{ "id": "$MAP_ID"}
4.3.35. Eventkorrelation
4.3.35.1. EVK anlegen
URL: https://123.123.123.123//eventcorrelation_module/eventcorrelations/add.json
Methode: POST
Response: HTML
Neue EVK anlegen
{ "Host":{ "container_id":$CONTAINER_ID, "hosttemplate_id":$HOSTTEMPLATE_ID, "name":"API Eventkorrelation", "description":"API Eventkorrelation Description" }}
4.3.35.2. EVK editieren
URL: https://123.123.123.123//eventcorrelation_module/eventcorrelations/add.json
Methode: POST
Response: HTML
Neue EVK anlegen
{ "Host":{ "id":$EVK_ID "container_id":$CONTAINER_ID, "hosttemplate_id":$EVC_HOSTTEMPLATE_ID, "name":"API Eventkorrelation", "description":"API Eventkorrelation Description" }}
4.3.35.3. EVK Tree anlegen
URL:https://123.123.123.123//eventcorrelation_module/eventcorrelations/editCorrelation/$EVC_ID.json
Methode: POST
Response: JSON
Neue EVK anlegen
{ "layer_1":{ "ui-id-1":{ "children":{ "1":1, "2":2, "3":3, "4":4 }, "operator":"and", "vServiceName":"layer1_1", "vServiceTemplateId":49 }, "ui-id-2":{ "children":{ "1":5, "2":6, "3":7, "4":8 }, "operator":"and", "vServiceName":"Layer1_2", "vServiceTemplateId":"49" } }, "layer_2":{ "ui-id-3":{ "operator":"and", "vServiceName":"layer2_1", "vServiceTemplateId":"49", "children":["ui-id-1","ui-id-2"] } }}
4.3.36. Distribute Modul
4.3.36.1. Satellit anlegen
URL: https://123.123.123.123/distribute_module/satellites/add.json
Methode: POST
Response: JSON
Neuen Satellit anlegen
{ "Satellite":{ "name":"API Satellite", "address":"127.0.0.1", "timezone":"Europe/Berlin", "container_id":1 }}
Response bei erfolgreichem Aufruf
{ "id": "$SATELLITE_ID"}
4.3.36.2. Satellit editieren
URL: https://123.123.123.123/distribute_module/satellites/edit/$SATELLITE_ID.json
Methode: POST
Response: JSON
Neuen Satellit anlegen
{ "Satellite":{ "id":$SATELLITE_ID, "name":"API Satellite modified", "address":"127.0.0.1", "timezone":"Europe/Berlin", "container_id":1 }}
Response bei erfolgreichem Aufruf
{ "id": "$SATELLITE_ID"}
4.3.36.3. Satellit löschen
URL: https://123.123.123.123/distribute_module/satellites/delete/$SATELLITE_ID.json
Methode: POST
Response: HTML
4.3.37. Best Practice
5. Fehlerbehebung
5.1. Dienste
5.1.1. Aufgaben
5.1.1.1. Nagios / Naemon
Monitoring Engine. Die Binary liegt unter: /opt/openitc/nagios.
Konfigdatei: /etc/openitcockpit/nagios.cfg
5.1.1.2. Statusengine
Brokermodule für Nagios/Naemon: /opt/statusengine/statusengine.o
Config: /opt/statusengine/cakephp/app/Config/Statusengine.php
5.1.1.3. OITC Cmd
Alias für die naemon.cmd, welche beispielsweise UUIDs in echte Hostnamen etc. übersetzen kann-
5.1.1.4. phpNSTA
Überträgt Daten von Master zum Satelliten und vice versa und übergibt diese im Fall von naemon alsMonitoring engine an den Naemon queryhandler.
5.1.1.5. Gearman-Job-Server
Stellt queues für verschiedene Aufgaben zur Verfügung und verwaltet diese.
5.1.1.6. gearman_worker
Stellt die "worker" bereit, welche die queues vom Gearman-Job-Server abarbeiten.
5.1.1.7. Nginx
Webserver
5.1.1.8. sudo_server
Führt Kommandos mit sudo Rechten aus
5.1.1.9. NPCD
Verarbeitet Performancedaten in /opt/openitc/nagios/var/spool/perfdata und wandelt diese in *.rrd und*.xml Dateien und legt diese in /opt/openitc/nagios/share/perfdata ab
5.1.2. Abhängigkeiten
5.1.3. Logs
Nagios / Naemon Log: /opt/openitc/nagios/var/nagios.log
openITCOCKPIT: /usr/share/openitcockpit/app/tmp/logs/error.log
NPCD: /opt/openitc/nagios/var/npcd.log
Gearman Job Server: /var/log/gearman-job-server/gearman.log
OITC CMD: /var/log/oitc_cmd.log
PHP 7: /var/log/php7.0-fpm.log
PHP 5: /var/log/php5-fpm.log
: Nginx /var/log/nginx/access.log
/var/log/nginx/error.log ( Fehler, generelle Fehler von Nginx, Applikationsunabhänging)sudo_server
Cake: /var/log/nginx/cake/error.log
MySQL: /var/log/mysql/error.log
phpNSTA: /var/log/phpNSTA.log
Supervisor: /var/log/supervisor/supervisord.log
5.2. Bekannte Fehler und deren Behebung
5.2.1. Debugskript
Ein Skript, welches auf bekannte Probleme prüft und bei Entdeckung eines Fehlers zum entsprechendenConfluence Artikel verlinkt
Tabelle der openitcockpit Datenbank größer 10 GBKaputte RRD DateienSSH Verbindungen am supervisorctl alle auf RUNNING und gleich Anzahl der konfigurierten Satellitengearman --status output prüfen, ob die Worker laufen und nicht zu viele Einträge in den Queues sindBei den EVKs prüfen ob der EVK Name auch zu dem Namen des Hosts passen (da hatten wir Probleme beider Migration bei diversen Kunden)innodb_buffer_pool_size >= Größe aller InnoDB Tabellen/opt/openitc/nagios/var/rw/nagios.cmd prüfen, ob es eine Pipe Datei ist oder eine reguläre Datei (falls Nagiosnicht korrekt startet)Aktuelles Datenbankschema mit dem aus der Konfiguration vergleichen -> Immer mal wieder versäumen esKunden nach dem Wiederherstellen eines Backups openitcockpit-update auszuführen
error_log prüfen, ob dort Fehler drin sind (theoretisch sollten die ja bei einem reibungslos laufenden Systemleer sein)Datum des ältesten Backups unter /opt/openitc/nagios/backup
Das Skript sollte leicht erweiterbar sein. Man sollte es mit Parametern aufrufen können um langsame Checksauszublenden zum beispiel
6. Testing
6.1. Kontinuierliche Integration
6.2. Paketbau
6.3. Unittests
6.4. Frontend Testing
6.5. Checklisten
7. Ansible
8. Cluster