Befehle und Optionen#

Bitte erstellen Sie vor jeder Änderung an einer Schnittstelle/Import einen vollständiges Backup. Falls das Ergebnis nicht zufriedenstellend ist kann dieses dann wiederhergestellt werden

Hinweise

Sämtliche Beispiele auf dieser Seite beziehen sich auf die Verwendung des i-doit Benutzers mit der Kombination Benutzername/Passwort: admin/admin.
Alle Parameter sind case-sensitive, dies bedeutet, dass Groß- und Kleinschreibung gemäß den Beispielen und Vorgaben exakt einzuhalten sind.

Folgende Befehle stehen für die i-doit Console zur Verfügung#

Befehl	Interne Beschreibung
addon-activate	Aktivieren von Add-ons
addon-deactivate	Deaktivieren von Add-ons
addon-install	Installieren von Add-ons
addon-list	Zeigt eine Liste mit allen installierten Add-ons an
addon-uninstall	Deaktivierung von Add-ons
admin-center-password-reset	Passwort für das Admin-Center zurücksetzen
auth-cleanup	Rechtesystem bereinigen
clear-credentials	Entfernt die Anmeldeinformationen von Benutzern
completion	Das Shell-Vervollständigungsskript ausgeben
contracts-outdated	Aktualisiert den Status ausgelaufener Verträge
extend-contracts	Verlängert die Laufzeit eines Vertrags, wenn dessen letztmögliches Kündigungsdatum in der Vergangenheit liegt
help	Zeigt die Hilfe zu einem Befehl an
import-csv	Daten aus einer CSV-Datei importieren (Nutzt einen definiertes Import Profil aus der GUI)
import-csvprofiles	Auflisten aller CSV-Importprofile
import-hinventory	Daten aus h-inventory importieren
import-jdisc	Daten aus JDisc Discovery importieren (SQL Server Zugriff wird über die GUI konfiguriert)
import-jdiscdiscovery	Einen Scan in JDisc Discovery starten (API Zugriff wird über die GUI konfiguriert)
import-syslog	Daten aus einem Syslog in das Logbuch von i-doit importieren
import-xml	Daten aus XML importieren
install	Installiert i-doit
jdisc-create-server	Erzeugt einen JDisc Server, basierend auf einer gegebenen Eingabe
ldap-sync	Personen und Personengruppen aus einem LDAP-Verzeichnis oder Active Directory (AD) importieren
ldap-syncdn	Synchronisiere aus einem LDAP/AD den Distinguished Name (DN) der Benutzer (siehe Kategorie LDAP)
license-add	Fügt eine Lizenz für i-doit hinzu (in Bearbeitung)
license-assign	Ordnet eine Hosting Lizenz einem Mandaten zu (in Bearbeitung)
license-import	Importiert Lizenzen vom i-doit Server (in Bearbeitung)
license-key	Setzt einen Lizenzschlüssel für i-doit (in Bearbeitung)
license-list	Listet alle Lizenzen mit allen Informationen auf (ID; Produkt; Typ; Startdatum; Enddatum; lizenzierte Objekte; lizenzierte Mandanten; Umgebung)
license-remove	Entfernt Lizenzen von i-doit
list	Listet alle console Kommandos auf
logbook:archive	Logbuch-Einträge archivieren
migrate-uploaded-files	Migriert hochgeladene Dateien von i-doit
notifications-list	Listet alle Benachrichtigungen auf
notifications-send	Benachrichtigungen per E-Mail versenden (Benachrichtigungen werden in der GUI konfiguriert)
report-export	Einen Report als Datei exportieren
report-refresher	Aktualisiert einen oder alle Berichte.
search	In i-doit suchen
search-index	Suchindex erstellen/erneuern
strip-description-html	Mit diesem Befehl können Sie html-Tags im Beschreibungsfeld aller Kategorien und Objekte entfernen
sync-dynamic-groups	Synchronisiert dynamische Gruppenmitglieder neu
system-autoincrement	auto_increment von MariaDB-/MySQL-Tabellen auf einen positiven Integer-Wert setzen (Betrifft die Datenstruktur! Mit Vorsicht zu nutzen!)
system-categorycleanup	Bereinigt optional Kategorieeinträge, die sich im Status unfertig, archiviert oder gelöscht befinden
system-checkforupdates	Nach Aktualisierungen für i-doit suchen
system-convert-non-innodb-tables	Konvertiert alle Tabellen, welche nicht in INNODB sind zu INNODB (Betrifft die Datenbankkodierung. Mit Vorsicht zu nutzen!)
system-convert-non-utf8-tables	Konvertiert alle non-UTF8-Tabellen in UTF8-Tabellen (Betrifft die Datenbankkodierung. Mit Vorsicht zu nutzen!)
system-location-fix	Führt die Standortkorrektur aus der GUI auf der Konsole aus
system-objectcleanup	Objekte bereinigen (Objekte mit dem Status "unfertig", "archiviert" oder "gelöscht" werden endgültig entfernt)
system-objectrelations	Objekt-Beziehungen neu aufbauen
system-refresh-table-configuration	Erneuert alle verfügbaren Listenkonfigurationen (Objekttypen und Kategorien)
system-set-settings	Ermöglicht das setzen von Admin-Center Einstellungen über die CLI
tenant-create	Einen neuen Mandanten hinzufügen
tenant-disable	Einen bestehenden Mandanten deaktivieren
tenant-enable	Einen bestehenden Mandanten aktivieren
tenant-list	Alle verfügbaren Mandanten auflisten
tenant-remove	Einen bestehenden Mandanten entfernen
uninstall	Deinstalliert i-doit
update	Update von i-doit installieren
idoit:feature-manager	Mit diesem Befehl ist es möglich Features in i-doit zu aktivieren
idoit:set-env-var	Mit diesem Befehl ist es möglich, Umgebungsvariablen für i-doit zu setzen.
idoit:set-update-capability	De- und Aktivierung der i-doit Aktualisierungsfunktion
system:tenant-export	Exportiere deine Mandantendaten inklusive hochgeladener Dateien in einem ZIP-Paket
system:tenant-import	Importiere deine Mandantendaten inklusive hochgeladener Dateien aus einem ZIP-Paket

Konfigurationsdatei und Parameter --config

Es ist möglich dem Aufruf zusätzliche Inhalte über eine Konfigurationsdatei zu übergeben. Diese Datei muss im i-doit Verzeichnis src/handler/config/ abgelegt werden. Ein Beispiel in Form der Datei "isys_handler_ldap.ini" ist im Verzeichnis src/handler/config/examples/ zu finden.
Wenn diese Datei beim Vorgang berücksichtigt werden soll, muss sie über den Parameter --config bzw. -c eingebunden werden.

addon-activate#

Aktiviert installierte Add-ons für den gewünschten Mandanten

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-a	--addon=[ADDON]	Add-on-Kennung (mehrere Werte zulässig)
-t	--tenant=[TENANT-ID]	Mandanten-ID (mehrere Werte zulässig)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php addon-activate --user admin --password admin --tenant 1 --addon api

addon-deactivate#

Deaktiviert installierte Add-ons für den gewünschten Mandanten

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-a	--addon=[ADDON]	Add-on-Kennung (mehrere Werte zulässig)
-t	--tenant=[TENANT-ID]	Mandanten-ID (mehrere Werte zulässig)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php addon-deactivate --user admin --password admin --tenant 1 --addon api

addon-install#

Installiert Add-ons für den gewünschten Mandanten

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-z	--zip=[ZIP]	Pfad zur Add-on ZIP-Datei
-a	--addon=[ADDON]	Add-on-Kennung (mehrere Werte zulässig)
-t	--tenant=[TENANT-ID]	Mandanten-ID (mehrere Werte zulässig)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php addon-install --user admin --password admin --tenant 1 --addon api --zip /path/to/the/zip/file.zip

addon-list#

Zeigt eine Liste mit allen installierten Add-ons zum ausgewählten Mandanten an

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-a	--addon=[ADDON]	Add-on-Kennung (mehrere Werte zulässig)
-t	--tenant=[TENANT-ID]	Mandanten-ID (mehrere Werte zulässig)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php addon-list --tenant 1 --user admin --password admin

addon-uninstall#

Deinstalliert ein Add-on

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user[=USER]	i-doit Admin Benutzername [default: "admin"]
-p	--password[=PASSWORD]	i-doit Admin Passwort
-a	--addon=[ADDON]	Add-on Identifikator
-h	--help	Zeigt die Hilfe für den angegebenen Befehl an. Wenn kein Befehl angegeben wird, wird die Hilfe für den list-Befehl angezeigt
-q	--quiet	Kein Output
-V	--version	Zeige die Anwendungsversion an
--ansi	--no-ansi	Erzwinge (oder verhindere --no-ansi) ANSI output
-n	--no-interaction	Keine interaktive Frage anzeigen
-v / -vv / -vvv	--verbose	Erhöhe die Ausführlichkeit der Meldungen: 1 für normale Ausgabe, 2 für ausführlichere Ausgabe und 3 für Debugging

Beispiel zur Verwendung

sudo -u www-data php console.php addon-uninstall --user admin --password admin -a document

admin-center-password-reset#

Passwort für das Admin-Center zurücksetzen

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php admin-center-password-reset --user admin --password admin

auth-cleanup#

Bereinigt potenziell verwaiste Einträge im Rechtssystem, dies geschieht pro Modul. In der CMDB werden beispielsweise Rechte aus Kategorien, Objekten und Objekttypen entfernt, die nicht mehr existieren.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php auth-cleanup --user admin --password admin --tenantId 1

clear-credentials#

Entfernt die Einträge der Attribute username und password von Benutzerlogins

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--object=[OBJECT]	Objekt-ID des zu deaktivierenden Benutzers
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php clear-credentials --user admin --password admin --object ObjectID

completion#

Der Befehl completion gibt das Shell-Vervollständigungsskript aus, das für die Verwendung der automatischen Shell-Vervollständigung erforderlich ist (derzeit wird nur die Bash-Vervollständigung unterstützt).

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--debug	Das Debug-Protokoll der Fertigstellung verfolgen
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

1	`php console.php completion`

contracts-outdated#

Aktualisiert den Status veralteter Verträge

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USER]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANTID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php contracts-outdated --user admin --password admin

extend-contracts#

Verlängert die Laufzeit eines Vertrags, dessen letztmögliches Kündigungsdatum in der Vergangenheit liegt

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--simulate	Simuliert die Vertragserweiterung
-u	--user=[USER]	Username
-p	--password=[PASSWORD]	Passwort
-i	--tenantID=[TENANTID]	Tenant ID [default: 1]
-h	--help	Zeigt Hilfe für den Befehl an
-c	--config=CONFIG	Konfigurationsdatei
-q	--quit	Es wird keine Nachricht angezeigt
-v	--version	Zeigt die Version der Anwendung an
	--ansi --no-ansi	Erzwingt ANSI Ausgabe / Deaktiviert ANSI Ausgabe
-v / -vv / -vvv	--verbose	Erhöht die Ausführlichkeit der Nachricht [default: 1]

Beispiel zur Verwendung

sudo -u www-data php console.php extend-contracts --user admin --password admin

help#

Zeigt in Verbindung mit einem anderen Befehl dessen Nutzung, Argumente und Optionen an

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--format=[FORMAT]	Format der Ausgabe festlegen (txt, xml, json or md) [Default: txt]
	--raw	Ausgabe der Befehls-Hilfe
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php help --format=txt

import-csv#

Führt den Import einer CSV-Datei mit den gewünschten Importparametern durch

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--importFile=[IMPORTFILE]	Gibt die Datei und deren Pfad an, die für den Import verwendet werden soll
	--importProfileId=[IMPORTPROFILEID]	Legt fest, mit welchem Profil der Import ausgeführt werden soll
	--csvSeparator=[CSVSEPARATOR]	Definiert die Trennzeichen für den Import
	--multiValueMode=[MULTIVALUEMODE]	Legt den Modus für Multi-Value-Kategorien fest (Mögliche Werte: "row", "column" oder "comma")
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-csv --user admin --password admin --tenantId 1 --importFile /var/www/imports/idoit-Demo-CSV-Import.csv --importProfileId 1 --csvSeparator ";" --multiValueMode column

import-csvprofiles#

Gibt eine Auflistung der Import-Profile für den CSV-Import zurück

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-csvprofiles --user admin --password admin --tenantId 1

import-hinventory#

Führt einen h-inventory Import einer kompatiblen XML-Datei durch

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--importFile=[IMPORTFILE]	Gibt die Datei und deren Pfad an, die für den Import verwendet werden soll
	--usage	Weitere detaillierte Informationen zur Verwendung des Commands
	--objectType=[OBJECTTYPE]	Importiert den angegebenen Objekttypen
	--objectId=[OBJECTID]	Importiert ausschließlich das angegebene Objekt
-f	--force	Erzwingt das Aktualisieren bestehender Objekte aber überschreibt die importierten Kategorien
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-hinventory --user admin --password admin --tenantId 1 --importFile /var/www/imports/idoit-Demo-h-inventory-import.xml

import-jdisc#

Führt einen JDisc-Import nach i-doit durch.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-r	--profile=[PROFILE]	Angabe/Auswahl des JDisc-Profils, das für den Import verwendet werden soll
-g	--group=[GROUP]	Angabe/Auswahl der Gruppen ID, die für den Import verwendet werden soll
-x	--mode=[MODE]	Auswahl des Import-Modus. Folgende IDs stehen zur Verfügung: 1: "Erstellen": Der Import-Modus "Erstellen" wird alle gefundenen Objekte erstellen, ohne zu prüfen, ob diese bereits existieren. 2: "Aktualisieren": Der Import-Modus "Aktualisieren" wird nur Objekte erstellen, die in i-doit nicht gefunden werden konnten. Kategorien von bereits existierenden Objekten werden (wenn nötig) um neue Daten ergänzt. 3: "Überschreiben": Der Import-Modus "Überschreiben" verhält sich genauso wie der Modus "Aktualisieren" mit dem Unterschied, das Listen-Kategorien erst geleert und dann neu angelegt werden. 4: "Aktualisieren (Neu inventarisiert)": Mit dem Zusatz "(Neu inventarisiert)" werden feste idoit-zu-jdisc-device Verknüpfungen verworfen und die Objektzugehörigkeiten neu errechnet. 5: "Überschreiben (Neu inventarisiert)": Mit dem Zusatz "(Neu inventarisiert)" werden feste idoit-zu-jdisc-device Verknüpfungen verworfen und die Objektzugehörigkeiten neu errechnet. 6: Der Import-Modus "Erstelle nur neu gescannte Geräte" erstellt nur neu gescannte Objekte, existierende werden übersprungen. 7: Der Import-Modus "Aktualisieren (Nur existierende Objekte) erstellt nur bereits existierende Objekte. Es werden keine neuen Objekte erstellt.
-s	--server=[SERVER]	Angabe der Server-ID um diesen auszuwählen
-o	--overwriteHost	Festlegen, ob sich überschneidende Hostadressen überschrieben werden sollen
-l	--detailedLogging[=DETAILEDLOGGING]	Erhöht die Protokollierung: 1: auf niedriger Log-Ebene werden nur Hinweise und Warnungen protokolliert 2: zusätzlich zur niedrigen Log-Ebene werden Fehler protokolliert 3: zusätzlich zur normalen Log-Ebene werden Debug-Meldungen protokolliert (speicherintensiv)
-b	--regenerateSearchIndex	Führt automatisch die Erneuerung des Suchindex aus
	--listProfiles	Erzeugt eine Liste der verfügbaren Profile
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-jdisc --user admin --password admin --tenantId 1 --profile 3 --mode 4 --server 2 --detailedLogging 3 --regenerateSearchIndex

import-jdiscdiscovery#

Löst einen JDisc Discovery Job aus.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-s	--server=[SERVER]	Auswahl des JDisc-Servers
-j	--discoveryJob=[DISCOVERYJOB]	Auswahl des Discovery Jobs (Standard: "Discover all")
-d	--deviceHostname=[DEVICEHOSTNAME]	Auswahl des Geräts anhand des Hostnames
-a	--deviceHostAddress=[DEVICEHOSTADDRESS]	Auswahl des Geräts anhand der Hostadresse
-l	--showLog	Zeigt das Log während des Discoveries an
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-jdiscdiscovery --user admin --password admin --tenantId 1 --server 2

import-syslog#

Importiert Inhalte aus einer Syslog Server Textdatei in das i-doit Logbuch.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-syslog --user admin --password admin --tenantId 1

import-xml#

Führt einen Import einer XML-Datei nach i-doit durch.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--importFile=[IMPORTFILE]	Angabe der Import-Datei sowie deren Pfad
	--usage	Detaillierte Informationen zur Verwendung des Commands
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php import-xml --user admin --password admin --tenantId 1 --importFile /var/www/imports/idoit-Demo-xml-import.xml

install#

Installieren Sie die i-doit Anwendung

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--root-user=[ROOT-USER]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--root-password=[ROOT-PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
	--host=[HOST]	Benutzername des privilegierten DB-Benutzers [Standard: "root"]
	--port=[PORT]	Port für DB-Verbindung [standardmäßig: 3306]
-d	--database=[DATABASE]	i-doit System Datenbankname [Standard: "idoit_system_temp"]
-U	--user=[USER]	Benutzername der i-doit-System-DB [Standard: "idoit"]
-P	--password=[PASSWORD]	Passwort für i-doit system DB
	--admin-password=[ADMIN-PASSWORD]	Passwort für i-doit Admin-Center
-l	--license-server=[LICENSE-SERVER]	Pfad für den i-doit Lizenzserver [Standard: "https://lizenzen.i-doit.com"]
-k	--key=[KEY]	Lizenzschlüssel für i-doit
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php install

jdisc-create-server#

Erzeugt einen JDisc Server Eintrag.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--default	Als Standardserver festlegen
	--title=[TITLE]	Name für die JDisc Serverkonfiguration [default: "JDisc Server"]
	--jdisc-host=[JDISC-HOST]	JDisc host [default: "localhost"]
	--jdisc-port=[JDISC-PORT]	JDisc port [default: 25321]
	--jdisc-database=[JDISC-DATABASE]	JDisc database [default: "inventory"]
	--jdisc-username=[JDISC-USERNAME]	JDisc database username [default: "postgresro"]
	--jdisc-password=[JDISC-PASSWORD]	JDisc database password
	--allow-older-imports	Import älterer JDisc-Versionen zulassen [default: no]
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php jdisc-create-server -u admin -p admin --default --title JDisc Server --jdisc-host localhost --jdisc-port 25321

ldap-sync#

Synchronisiert Benutzer aus dem LDAP nach i-doit und legt diese als Personenobjekte an.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-l	--ldapServerId=[LDAPSERVERID]	Gibt die ID des LDAP-Servers an, von dem die User synchronisiert werden sollen Wird keine ldapServerId angegeben werden alle Aktiven Server synchronisiert
	--dumpConfig	Gibt die derzeitige Konfiguration aus der Konfigurationsdatei aus
	--connectionRankingActive[=CONNECTIONRANKINGACTIVE]	Option, die alle Verbindungen von allen reaktivierten Benutzern reaktiviert. Standardkonfiguration ist die Experteneinstellung 'ldap.connection-ranking-active' (Tenant-wide) mit dem Wert '1'.
	--dropExistingRelations[=DROPEXISTINGRELATIONS]	Wenn eine bestehende ldap-Gruppe Gruppenmitglied-Benutzer hat, die nicht zu diesen synchronisierten Benutzern gehören, werden diese gelöscht. 1 = bestehende Beziehungen löschen, 0 = bestehende Beziehungen ignorieren [Standard: 0].
	--archiveDeletedGroups	Wenn eine gelöschte ldap-Gruppe in i-doit verbleibt, dann archiviere oder lösche sie. Standard = false Mögliche Werte sind archive oder delete
	--useDefaultTemplates	Verwende das standard Template wenn ein Objekt über dieses Kommando erstellt wird (v1.18)
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php ldap-sync --user admin --password admin --tenantId 1 --verbose --ldapServerId 1

ldap-syncdn#

Synchronisiert LDAP DNs mit den i-doit Usern.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--ldapServerId=[LDAPSERVERID]	Angabe des LDAP-Servers über die ID
-o	--objectType=[OBJECTTYPE]	Angabe des Objekttyps als Konstante (z.B. C__OBJTYPE__SERVER)
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php ldap-syncdn --user admin --password admin --tenantId 1 --ldapServerId 1

list#

Listet alle Befehle auf. Format der Ausgabe kann geändert werden.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--format=[FORMAT]	Format der Ausgabe festlegen (txt, xml, json or md) [Default: txt]
	--raw	Ausgabe der Befehls-Hilfe

Beispiel zur Verwendung

sudo -u www-data php console.php list --format=txt

license-add#

Fügt eine Lizenz für i-doit hinzu

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-l	--license=[LICENSE]	Pfadangabe zur Lizenzdatei (/path/to/license/file.key)
-t	--tenant=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php license-add --user admin --password admin --tenantId 1 --license /path/to/license/file.key

license-assign#

Ordnet eine Hosting Lizenz einem Mandaten zu

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--count=[COUNT]	Anzahl zu lizenzierender Objekte [Default: 0]
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php license-assign --user admin --password admin --tenantId 1 --count 1000

license-import#

Importiert Lizenzen vom i-doit Lizenz-Server

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-l	--license-server=[LICENSE-SERVER]	Pfad zum i-doit Lizenz-Server [Default: "https://lizenzen.i-doit.com"]
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php license-import --user admin --password admin --license-server https://lizenzen.i-doit.com

license-key#

Setzt einen Lizenzschlüssel für i-doit

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-l	--license-server=[LICENSE-SERVER]	Pfad zum i-doit Lizenz-Server [Default: "https://lizenzen.i-doit.com"]
-k	--key=[KEY]	Lizenzschlüssel für i-doit
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php license-key --user admin --password admin --license-server https://lizenzen.i-doit.com --key license

license-list#

Listet alle installierten Lizenzen

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-t	--tenant=[TENANT]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php license-list --tenant 1

license-remove#

Löscht eine Lizenz aus i-doit

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-l	--license=[LICENSE]	Lizenz-ID zu der zu löschenden Lizenz
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php license-remove --user admin --password admin --license LicenseID

logbook:archive#

Archiviert die Logbucheinträge mit einem definierten Alter, gemäß den Einstellungen auf der i-doit Oberfläche.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--batch=[BATCHSIZE]	Anzahl der Einträge, die pro Batch archiviert werden sollen [Standard: 1000]
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php logbook:archive --user admin --password admin --tenantId 1

migrate-uploaded-files#

Migriert hochgeladene Dateien in i-doit

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php migrate-uploaded-files

notifications-list#

Listet alle Benachrichtigungen auf

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php notifications-list --user admin --password admin --tenantId 1

notifications-send#

Verschickt die auf der i-doit Oberfläche konfigurierten Benachrichtigungen

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--notification-ids=[NOTIFICATION-IDS ]	Übergabe bestimmter zu sendender Benachrichtigungs-IDs 1,2,3
	--notification-type-ids=[NOTIFICATION-TYPE-IDS]	Übergeben Sie spezifische IDs für die zu sendenden Benachrichtigungen 1,2,3
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php notifications-send --user admin --password admin --tenantId 1

report-export#

Exportiert einen Report in das gewünschte Dateiformat.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-r	--reportId=[REPORTID]	ID des zu exportierenden Reports
-d	--exportPath=[EXPORTPATH]	Pfad, zu dem der Export erfolgen soll
-f	--exportFilename=[EXPORTFILENAME]	Dateiname der Exportdatei ohne Dateiendung
-t	--exportFileType=[EXPORTFILETYPE]	Dateityp der Exportdatei. Mögliche Werte: csv, txt, pdf, xml (Standard: "csv")
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php report-export --user admin --password admin --tenantId 1 --reportId 27 --exportPath /var/www/exported-reports/ --exportFilename Report-Buchhaltung-November-2025 --exportFileType csv

report-refresher#

Aktualisiert einen oder alle Berichte.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-r	--reportId=[REPORTID]	ID des zu exportierenden Reports
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php report-refresher --user admin --password admin --tenantId 1 --reportId 27

search#

Sucht nach Inhalten in der Dokumentation

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--searchString=[SEARCHSTRING]	Inhalt, nach dem gesucht werden soll
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php search --user admin --password admin --tenantId 1 --searchString "Server001"

search-index#

Erneuert den Suchindex, indem dieser gelöscht und neu geschrieben wird.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--update	Anstatt nur einen neuen Index zu erstellen, werden die aktuellen Index-Dokumente überschrieben
	--category=[CATEGORY]	Whitelist der Kategorien
	--dry-run	Reindex ausführen, ohne zu speichern
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php search-index --user admin --password admin --tenantId 1

strip-description-html#

Mit diesem Befehl können Sie html-Tags im Beschreibungsfeld aller Kategorien und Objekte entfernen

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php strip-description-html --user admin --password admin --tenantId 1

sync-dynamic-groups#

Synchronisiert dynamische Gruppenmitglieder neu.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-g	--groups=GROUPS	Kommaseparierte Liste von IDs der dynamischen Gruppen
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php sync-dynamic-groups --user admin --password admin --tenantId --groups 173,188,219

system-autoincrement#

Legt den Wert des Auto-Increment des Systems fest. Dies beeinflusst Objekt-IDs, Kategorie-Einträge, etc. Beim Zurücksetzen des Auto-Increments kann es passieren, dass einige Inhalte nicht mehr zugänglich sind.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--autoIncrement=[AUTOINCREMENT]	Zahl, auf die das Auto-Increment festgelegt werden soll
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-autoincrement --user admin --password admin --tenantId 1 --autoIncrement 20

system-categorycleanup#

Bereinigt optional Kategorieeinträge, die sich im Status unfertig, archiviert oder gelöscht befinden

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--categoryStatus=[CATEGORYSTATUS]	Use to start cleaning up the specified status: 1 für "unfertige" Kategorieeinträge 3 für "archivierte" Kategorieeinträge 4 für "gelöschte" Kategorieeinträge
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-categorycleanup --user admin --password admin --tenantId 1 --categoryStatus 3

system-checkforupdates#

Prüft, ob eine neue i-doit Version verfügbar ist.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-checkforupdates

system-convert-non-innodb-tables#

Konvertiert alle nicht INNODB Tabellen nach INNODB.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--convert	Startet den Vorgang, alle nicht UTF-8-tables zu konvertieren
	--table=[TABLE]	Tabelle die überprüft und konvertiert werden soll
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-convert-non-innodb-tables --convert --table TABLE_NAME

system-convert-non-utf8-tables#

Konvertiert alle nicht UTF-8 Datentypen nach UTF-8.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--convert	Startet den Vorgang, alle nicht UTF-8-tables zu konvertieren
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-convert-non-utf8-tables --convert

system-location-fix#

Führt die Standortkorrektur aus der GUI in der Konsole aus

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-location-fix --user admin --password admin --tenantId 1 --config /path/to/config/file

system-objectcleanup#

Bereinigt alle Objekte mit einem selbst definierbarem Status.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--objectStatus=[OBJECTSTATUS]	Legt fest, welcher Status bereinigt werden soll: 1: "unfertig"; 3: "archiviert"; 4: "gelöscht"
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-objectcleanup --user admin --password admin --tenantId 1 --objectStatus 1

system-objectrelations#

Erneuert die Bezeichnungen aller Objektbeziehungen.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--categoryConstant=[CATEGORYCONSTANT]	Konstante der Kategorie, für die der Vorgang ausgeführt werden soll (z.B. C__CATG__IP)
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-objectrelations --user admin --password admin --tenantId 1 --categoryConstant C__CATG__IP

system-refresh-table-configuration#

Aktualisiert alle verfügbaren Listenkonfigurationen (Objekttypen und Kategorien)

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-a	--all	Verarbeitet alle Objekttyp-Tabellenkonfigurationen
-o	--object-types=[OBJECT-TYPES]	Nur bestimmte Objekttyp-Tabellenkonfigurationen über ihre Konstante verarbeiten (es ist möglich, eine durch Komma getrennte Liste von Konstanten zu übergeben)
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-c	--config=[CONFIG-FILE]	Angabe des Pfades zur Konfigurationsdatei
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system-refresh-table-configuration --user admin --password admin --tenantId 1

system-set-settings#

Ermöglicht das setzen von Admin-Center Einstellungen über die CLI.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-s	--settings=[SETTINGS]	JSON mit Key = Values z.B.:
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php system-set-settings --user admin --password admin --settings="{\"proxy.active\":1,\"proxy.host\":\"http://myproxy.net\",\"unknown-setting\": 4}" -n

tenant-create#

Erstellt einen neuen Mandanten.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--root-user=[ROOT-USER]	Benutzername des privilegierten DB-Benutzers [default: "root"]
-p	--root-password=[ROOT-PASSWORD]	Passwort des privilegierten DB-Benutzers
-U	--user=[USER]	Benutzername der DB für neuen Mandanten [default: "idoit"]
-P	--password=[PASSWORD]	Password der DB für den neuen Mandanten
-d	--database=[DATABASE]	DB Name für den neuen Mandanten [default: "idoit_data"]
-t	--title=[TITLE]	Name des neuen Mandanten[default: "Your company name"]
	--login-user[=LOGIN-USER]	Benutzername des i-doit-Benutzers
	--login-password[=LOGIN-PASSWORD]	Passwort des i-doit-Benutzers
	--login-recovery-email[=LOGIN-RECOVERY-EMAIL]	E-Mail des i-doit-Benutzers zur Wiederherstellung
	--send-email	E-Mail für das initiale Passwort zusenden
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php tenant-create --title Musterfirma --user idoit --password idoitpassword -- enable --tenantId 3

tenant-disable#

Deaktiviert einen existierenden Mandaten.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php tenant-disable --tenantId 2 --user admin --password admin

tenant-enable#

Aktiviert einen bestehenden Mandanten.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenantId=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php tenant-enable --tenantId 2 --user admin --password admin

tenant-list#

Listet alle bestehenden Mandanten auf.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php tenant-list

tenant-remove#

Entfernt einen bestehenden Mandanten

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenant=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php tenant-remove --user admin --password admin --tenant 1

uninstall#

Deinstalliert die genutzte i-doit Installation

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php uninstall --user admin --password admin

update#

Update von i-doit installieren.

Optionen:

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-z	--zip=[ZIP]	Angabe des Pfades zum Update-Paket
	--v=V	Zu installierende Version
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php update --user admin --password admin --zip /path/to/zip/file.zip --v 1.14

idoit:feature-manager#

Mit diesem Befehl ist es möglich Features in i-doit zu aktivieren.

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
	--unset-cloud	Deaktivieren wenn Anwendung eine Cloud-Instanz ist
	--set-cloud	Aktivieren wenn Anwendung eine Cloud-Instanz ist
-e	--enable=[ENABLE]	Features aktivieren
-d	--disable=[DISABLE]	Features deaktivieren
-r	--replace=[REPLACE]	Vorhandene Features austauschen
-c	--cloudable	Nur Cloud fähige Features werden beachtet
-f	--noncloudable	Nur nicht Cloud fähige Features werden beachtet
	--wizard	Interaktiver Modus um Features zu aktivieren oder deaktivieren
-l	--list	Zeigt alle verfügbaren Features
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenant=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php idoit:feature-manager --enable update-gui --user admin --password admin

idoit:set-env-var#

Mit diesem Befehl ist es möglich, Umgebungsvariablen für i-doit zu setzen.

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-k	--key-pair=[KEY-PAIR]	Durch Kommata getrennte Liste von Schlüsselpaaren, die als Umgebungsvariable aufgenommen werden sollen
-s	--show-variables	Alle definierten Umgebungsvariablen anzeigen
-l	--list-variables	Alle möglichen Umgebungsvariablen anzeigen
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenant=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php idoit:set-env-var -k "IDOIT_APP_URL=localhost" --user admin --password admin

idoit:set-update-capability#

De- und Aktivierung der i-doit Aktualisierungsfunktion.

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenant=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php idoit:set-update-capability enable --user admin --password admin

system:tenant-export#

Exportieren Sie Ihre Mandantendaten inklusive hochgeladener Dateien in einem ZIP-Paket.

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-u	--user=[USERNAME]	Username eines Benutzers, der zur Ausführung berechtigt ist
-p	--password=[PASSWORD]	Passwort zur Authentifizierung des zuvor angegebenen Benutzers
-i	--tenant=[TENANT-ID]	Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1)
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)

Beispiel zur Verwendung

sudo -u www-data php console.php system:tenant-export --user admin --password admin

system:tenant-import#

Importieren Sie Ihre Mandantendaten inklusive hochgeladener Dateien aus einem ZIP-Paket.

Optionen

Parameter (Kurzform)	Parameter (Langform)	Beschreibung
-f,	--file=FILE	Export Datei des Mandanten mit system:tenant-export
-d,	--tenant-database-name=TENANT-DATABASE-NAME	Mandanten datenbank Name
-t,	--tenant-title=TENANT-TITLE	Mandanten Name
	--with-system-settings	System Einstellungen übernehmen: Wenn diese Option aktiviert ist, wird die Datei `system.settings.json` importiert und überschreibt die aktuellen Einstellungen des Systems. Alle Einstellungen, die bereits vorhanden sind, aber nicht in `system.settings.json` definiert sind, bleiben unverändert.
	--with-tenant-settings	Mandanteneinstellungen übernehmen: Wenn gesetzt, wird `tenant.settings.json` importiert.
	--db-root-user=DB-ROOT-USER	Datenbank root Benutzername
	--db-root-pass=DB-ROOT-PASS	Datenbank root Passwort
	--db-host=DB-HOST	Datenbank host [Standard: "localhost"]
	--db-port=DB-PORT	Datenbank port [Standard: "3306"]
-h	--help	Hilfenachricht zur Einblendung weiterer Informationen
-q	--quiet	Quiet-Mode um die Rückgabe zu deaktivieren
-V	--version	Ausgabe der Version der i-doit Console
	--ansi --no-ansi	ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren)
-n	--no-interaction	Deaktiviert sämtliche Interaktionsfragen der i-doit Console
-v / -vv / -vvv	--verbose	Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level)