Console#
i-doit verfügt über ein Befehlszeilenschnittstelle (CLI), über das sich verschiedene Aufgaben durchführen lassen. Das CLI wird beispielsweise für Cronjobs benötigt und kann zum Automatisieren von Arbeitsschritten eingesetzt werden.
Erste Schritte#
Das CLI befindet sich im Installationsverzeichnis von i-doit, beispielsweise unter /var/www/html/. Es muss innerhalb dieses Verzeichnisses mit denselben Rechten des Apache Webservers aufgerufen werden. Unter Debian GNU/Linux ist dies der User www-data. Mittels sudo werden diese Rechte erlangt:
1 2 |
|
Unter Windows wechselt man ebenso in das Installationsverzeichnis. Da die Rechte des Webservers keine Rolle spielen, genügt der Aufruf von php.exe, welches im Pfad des Benutzers stehen muss.
1 2 |
|
Führt man die CLI ohne weitere Argument aus, wird die allgemeine Hilfe präsentiert:
Verfügbare Kommandos
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
|
Authentifizierung#
Um über das CLI auf i-doit zugreifen zu können, ist für die meisten Commands eine Authentifizierung nötig. Dazu übergibt man einen Benutzernamen, das passende Passwort und die gewünschte Tenant ID. Letztere ist bei einer Standardinstallation meistens die 1.
1 2 |
|
Der Benutzer "controller"
Es wird empfohlen, einen dedizierten Benutzer in i-doit für die Nutzung der CLI anzulegen. Soll dieser als lokaler Benutzer konfiguriert werden, erstellt man ihn als Objekt vom Typ Personen mit den gewünschten Credentials in der Kategorie Personen → Login. Dieser Benutzer sollte Admin-Rechte erhalten. Dies kann durch die Zuordnung zur vordefinierten Personengruppe Admin geschehen.
Hilfe#
Commands werden oftmals von weiteren Argumenten begleitet. Daher liefert jedes Command eine Hilfe via --help:
1 2 |
|
Darüber hinaus bieten einige Commands Beispielaufrufe via --usage.
Commands#
Command | pro-Variante | open-Variante | Add-on | Beschreibung |
---|---|---|---|---|
addon-activate | ja | ja | - | Aktivieren von Add-ons |
addon-deactivate | ja | ja | - | Deaktivieren von Add-ons |
addon-install | ja | ja | - | Installieren von Add-ons |
addon-list | ja | ja | - | Zeigt eine Liste mit allen installierten Add-ons an |
admin-center-password-reset | ja | ja | - | Passwort für das Admin-Center zurücksetzen |
auth-cleanup | ja | ja | - | Rechtesystem bereinigen |
check_mk-export | ja | nein | Check_MK | Konfigurationsdaten für Checkmk exportieren |
check_mk-livestatus | ja | nein | Check_MK | Ist-Zustand aus Checkmk ins Logbuch schreiben |
clear-credentials | ja | ja | - | Entfernt die Anmeldeinformationen von Benutzern |
CompileDocuments | ja | nein | Documents | Aktualisiert Dokumente |
completion | ja | ja | - | Das Shell-Vervollständigungsskript ausgeben |
contracts-outdated | ja | ja | - | Aktualisiert den Status ausgelaufener Verträge |
documents | ja | nein | Documents | Dokumente erstellen und exportieren |
extend-contracts | ja | nein | - | Erweitert die Laufzeit eines Vertrags, wenn dessen Kündigungsdatum in der Vergangenheit liegt |
help | ja | ja | - | Zeigt die Hilfe zu einem Befehl an |
import-csv | ja | nein | - | Daten aus einer CSV-Datei importieren |
import-csvprofiles | ja | nein | - | Auflisten aller CSV-Importprofile |
import-hinventory | ja | ja | - | Daten aus h-inventory importieren |
import-jdisc | ja | ja | - | Daten aus JDisc Discovery importieren |
import-jdiscdiscovery | ja | ja | - | Einen Scan in JDisc Discovery starten |
import-syslog | ja | ja | - | Daten aus einem Syslog in das Logbuch von i-doit importieren |
import-xml | ja | ja | - | Daten aus XML importieren |
install | ja | ja | - | Installiert i-doit |
ldap-sync | ja | ja | - | Personen und Personengruppen aus einem LDAP-Verzeichnis oder Active Directory (AD) importieren |
ldap-syncdn | ja | ja | - | Synchronisiere aus einem LDAP/AD den Distinguished Name (DN) der Benutzer (siehe Kategorie LDAP) |
license-add | ja | nein | - | Fügt eine Lizenz für i-doit hinzu (in Bearbeitung) |
license-assign | ja | nein | - | Ordnet eine Hosting Lizenz einem Mandaten zu (in Bearbeitung) |
license-import | ja | nein | - | Importiert Lizenzen vom i-doit Server (in Bearbeitung) |
license-key | ja | nein | - | Setzt einen Lizenzschlüssel für i-doit (in Bearbeitung) |
license-list | ja | nein | - | Listet alle Lizenzen mit allen Informationen auf (ID; Produkt; Typ; Startdatum; Enddatum; lizenzierte Objekte; lizenzierte Mandanten; Umgebung) |
license-remove | ja | nein | - | Entfernt Lizenzen von i-doit |
list | ja | ja | - | Listet alle console Kommandos auf |
logbook-archive | ja | ja | - | Logbuch-Einträge archivieren |
maintenance | ja | nein | Maintenance | Sendet Benachrichtigungen zu geplanten Wartungen aus dem Maintenance Add-on |
migrate-uploaded-files | ja | ja | - | Migriert hochgeladene Dateien in i-doit |
nagios-export | ja | nein | Nagios | Nagios-Konfiguration exportieren |
nagios-ndoutils | ja | nein | Nagios | Ist-Zustand aus Nagios ins Logbuch schreiben |
notifications-list | ja | ja | - | Listet alle Benachrichtigungen auf |
notifications-send | ja | ja | - | Benachrichtigungen per E-Mail versenden |
report-export | ja | nein | - | Einen Report als Datei exportieren |
search | ja | ja | - | In i-doit suchen |
search-index | ja | ja | - | Suchindex erstellen/erneuern |
strip-description-html | ja | ja | - | Mit diesem Befehl können Sie html-Tags im Beschreibungsfeld aller Kategorien und Objekte entfernen |
sync-dynamic-groups | ja | ja | - | Synchronisieren Sie dynamische Gruppenmitglieder |
system-autoincrement | ja | ja | - | auto_increment von MariaDB-/MySQL-Tabellen auf einen positiven Integer-Wert setzen |
system-categorycleanup | ja | ja | - | Bereinigt optional Kategorieeinträge, die sich im Status unfertig, archiviert oder gelöscht befinden |
system-checkforupdates | ja | ja | - | Nach Aktualisierungen für i-doit suchen |
system-convert-non-innodb-tables | ja | ja | - | Konvertiert alle Tabellen, welche nicht in INNODB sind zu INNODB (Betrifft die Datenbankkodierung. Mit Vorsicht zu nutzen!) |
system-convert-non-utf8-tables | ja | ja | - | Konvertiert alle non-UTF8-Tabellen in UTF8-Tabellen (Betrifft die Datenbankkodierung. Mit Vorsicht zu nutzen!) |
system-location-fix | ja | ja | - | Führt die Standortkorrektur aus der GUI auf der Konsole aus |
system-objectcleanup | ja | ja | - | Objekte bereinigen |
system-objectrelations | ja | ja | - | Objekt-Beziehungen neu aufbauen |
system-refresh-table-configuration | ja | ja | - | Erneuert alle verfügbaren Listenkonfigurationen (Objekttypen und Kategorien) |
tenant-create | ja | nein | - | Einen neuen Mandanten hinzufügen |
tenant-disable | ja | nein | - | Einen bestehenden Mandanten deaktivieren |
tenant-enable | ja | nein | - | Einen bestehenden Mandanten aktivieren |
tenant-list | ja | nein | - | Alle verfügbaren Mandanten auflisten |
tenant-remove | ja | nein | - | Einen bestehenden Mandanten entfernen |
uninstall | ja | ja | - | Deinstalliert i-doit |
update | ja | ja | - | Update von i-doit installieren |
workflows-process | ja | nein | Workflow | Workflow-Benachrichtigungen per E-Mail versenden |