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 Handler stehen für die i-doit Console zur Verfügung:
| Command | Systeminterne Beschreibung (en) |
|---|---|
| auth-cleanup | Cleanup all auth paths |
| check_mk-export | Exports i-doit objects and Host Tags to Check_MK WATO configuration files |
| check_mk-livestatus | Imports monitoring status changes from Livestatusto the i-doit Logbook |
| help | Displays help for a command |
| import-csv | Imports CSV formatted files (Using a predefined CSV Import filter, defined in the GUI) |
| import-csvprofiles | List all available csv profiles |
| import-hinventory | Imports files formatted in the hInventory XML syntax |
| import-jdisc | Imports data from a JDisc server (SQL server access is defined in the GUI) |
| import-jdiscdiscovery | Triggers a JDisc discovery (API Access to the JDisc server is defined in the GUI) |
| import-ocs | Imports data from an OCS inventory NG server (SQL server access is defined in the GUI) |
| import-syslog | Imports data from a Syslog server textfile to the i-doit Logbook |
| import-xml | Imports files formatted in the i-doit XML syntax |
| ldap-sync | Synchronizes LDAP user accounts with i-doit user objects |
| ldap-syncdn | Synchronizes LDAP user DN attributes with i-doit user objects (Only needs to be run when migrating between different LDAP sources) |
| list | Lists commands |
| logbook-archive | Archives Logbook entries (Settings are defined in the GUI) |
| maintenance | Sends out e-mails for objects with a planned maintenance. As defined in the maintenance add-on |
| nagios-export | Exports i-doit objects and monitoring settings to Nagios configuration files |
| nagios-ndoutils | Imports monitoring status changes from NDOUtils into the i-doit logbook |
| notifications-send | Sends out e-mails for notifications defined in the notification add-on |
| report-export | Executes an i-doit report and saves it to a file as CSV, TXT, PDF or XML |
| search | Triggers a search and gives the results as formatted text table |
| search-index | Deletes current search index and create it |
| sync-dynamic-groups | Syncronize dynamic group members |
| system-autoincrement | Changes the initial autoincrement value for all i-doit database tables (Affects everything, Object-IDs, category entries, etc. Use with caution!) |
| system-checkforupdates | Checks for i-doit core updates |
| system-convert-non-utf8-tables | Changes all non-UTF8-tables to UTF8 (Affects database encoding. Use with caution!) |
| system-maintenancecontract | Sends e-mail notifications for maintenance contracts (Function is deprecated, please use the notification add-on) |
| system-objectcleanup | Purges optionally objects that are in the state unfinished, archived or deleted |
| system-objectrelations | Regenerates all object relation names |
| tenant-add | Add a new tenant |
| tenant-disable | Disable a tenant |
| tenant-enable | Enable a new tenant |
| tenant-list | List all tenants |
| workflows-process | Process all workflows, send e-mails and create newtasks from checklists |
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.
auth-cleanup
Leert den Cache des Rechtesystems, damit die derzeit konfigurierten Rechte aktuell sind bzw. aktualisiert werden.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
check_mk-export
Führt einen Check_MK Export durch
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| -l | --exportLanguage=EXPORTLANGUAGE | Festlegung der für den Export verwendeten Sprache (Standard = 0) |
| -x | --exportStructure=EXPORTSTRUCTURE | Festlegung der für den Export verwendeten Struktur (Standard = 0) |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 check_mk-export --user admin --password admin --tenantId 1
check_mk-livestatus
Importiert die Änderungen am Monitoring-Status aus Livestatus nach i-doit
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 check_mk-livestatus --user admin --password admin --tenantId 1
import-csv
Führt den Import einer CSV-Datei mit den gewünschten Importparametern durch
Optionen
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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": Es werden ausschließlich neue Objekte erstellt, bestehende Objekte bleiben unberührt. 2: "Aktualisieren": Existierende Objekte werden aktualisiert, neue Objekte werden zusätzlich angelegt. Inhalte aus Multi-Value-Kategorien werden angehangen, bestehende Inhalte bleiben erhalten. 3: "Überschreiben": Existierende Objekte werden aktualisiert, neue Objekte werden zusätzlich angelegt. Inhalte aus Multi-Value-Kategorien werden erst vollständig gelöscht und im anschluss auf der Datenbasis neu angelegt. 4: "Aktualisieren (Neu inventarisiert)": Der Modus entspricht "Aktualisieren", jedoch werden alle bekannten Verknüpfungen zwischen i-doit und JDisc-Objekten gelöst und nach einer Prüfung neu verbunden. |
| -s | --server=SERVER | Angabe der Server-ID um diesen auszuwählen |
| -o | --overwriteHost | Festlegen, ob sich überschneidende Hostadressen überschrieben werden sollen |
| -l | --detailedLogging | Erhöht die Stufe des Loggings |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 --regenerateSearchIndex
import-jdiscdiscovery
Löst einen JDisc Discovery Job aus.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-ocs
Führt einen Import von Inhalten einer OCS-Datenbank nach i-doit aus.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --ipPortOverwrite=IPPORTOVERWRITE | Legt fest, ob Hostadressen und Ports vor dem Import geleert werden. Mögliche Werte: 1 = aktiv, 0 = inaktiv | |
| --databaseSchema=DATABASESCHEMA | Auswahl des für den Import verwendeten Datenbankschemas | |
| --objectType=OBJECTTYPE | Angabe des Standard-Objekttyps, der für den Import genutzt wird | |
| --file=FILE | Angabe der Datei, die die Hostnamen enthält | |
| --hosts=HOSTS | Kommaseparierte Liste der Hostnamen, die importiert werden sollen | |
| --snmpDevices=SNMPDEVICES | Import von SNMP-Geräten | |
| --categories=CATEGORIES | Legt die zu importierenden Kategorien fest. Mögliche Werte: drive, ui, sound, application, memory, model, graphic, net, stor, operating_system, cpu | |
| --logging=LOGGING | Aktivierung des Loggings (1= Normales Logging, 2= Debug-Level, Standard = 0) | |
| --listObjectTypes | Auflistung aller verfügbaren Objekttypen | |
| --listCategories | Auflistung aller verfügbaren Kategorien | |
| --usage | ||
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-ocs --user admin --password admin --tenantId 1 --databaseSchema ocs --objectType C__OBJTYPE__CLIENT
import-syslog
Importiert Inhalte aus einer Syslog Server Textdatei in das i-doit Logbuch.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
ldap-sync
Synchronisiert Benutzer aus dem LDAP nach i-doit und legt diese als Personenobjekte an.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| -l | --ldapServerId=LDAPSERVERID | Gibt die ID des LDAP-Servers an, von dem die User synchronisiert werden sollen |
| --dumpConfig | Gibt die derzeitige Konfiguration aus der Konfigurationsdatei aus | |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
logbook-archive
Archiviert die Logbucheinträge mit einem definierten Alter, gemäß den Einstellungen auf der i-doit Oberfläche.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
maintenance
Verschickt E-Mails mit geplanten Wartungen gemäß den im Add-on "Wartungen" festgelegten Zeiträumen.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 maintenance --user admin --password admin --tenantId 1
nagios-export
Exportiert die Nagios-Einstellungen und i-doit Objekte in Nagios-Konfigurationsdateien.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --nagiosHostId=NAGIOSHOSTID | Angabe des Nagios-Hosts, der für den Export verwendet werden soll | |
| --validate | Validiert die Exportdateien | |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 nagios-export --user admin --password admin --tenantId 1 --nagiosHostId 1
nagios-ndoutils
Importiert Monitoring Statusänderungen aus den NDOUtils in das i-doit Logbuch.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 nagios-ndoutils --user admin --password admin --tenantId 1
notifications-send
Verschickt die auf der i-doit Oberfläche konfigurierten Benachrichtigungen
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-2019 --exportFileType csv
search
Sucht nach Inhalten in der Dokumentation
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
sync-dynamic-groups
Synchronisiert dynamische Gruppenmitglieder neu.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-checkforupdates
Prüft, ob eine neue i-doit Version verfügbar ist.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-utf8-tables
Konvertiert alle nicht UTF-8 Datentypen nach UTF-8.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --convert | Startet den Vorgan, alle nicht UTF-8-tables zu konvertieren | |
| -u | --user=[USERNAME] | Passwort zur Authentifizierung des zuvor angegebenen Benutzers |
| -p | --password=[PASSWORD] | Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1) |
| .i | --tenantId=[TENANT-ID] | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
system-maintenancecontract
Verschickt eine E-Mail Benachrichtigung für Wartungskontakte.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-maintenancecontract --user admin --password admin --tenantId 1
system-objectcleanup
Bereinigt alle Objekte mit einem selbst definierbarem Status.
Optionen:
| Parameter (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 (Kurzfrom) | 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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
tenant-add
Erstellt einen neuen Mandanten
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --title=TITLE | Titel des neuen Mandanten | |
| --cacheDirectory=CACHEDIRECTORY | Cache-Verzeichnis des neuen Mandanten | |
| --tplDirectory=TPLDIRECTORY | Tpl-Verzeichnis des neuen Mandanten | |
| --host=HOST | Host des neuen Mandanten | |
| --port=PORT | Datenbankport des neuen Mandanten | |
| --user=USER | Datenbank-User des neuen Mandanten | |
| --password=PASSWORD | Datenbankpasswort des neuen Mandanten | |
| --description=DESCRIPTION | Beschreibung des neuen Mandanten | |
| --sort=SORT | Sortierungsposition des neuen Mandanten | |
| --enable | Bei der Verwendung des Parameters wird der Mandant aktiv geschaltet | |
| --disable | Bei der Verwendung des Parameters wird der Mandant inaktiv geschaltet | |
| --tenantId=TENANTID | Mandanten-ID des neuen Mandanten | |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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-add --title Musterfirma --user idoit --password idoitpassword -- enable --tenantId 3
tenant-disable
Deaktiviert einen existierenden Mandaten.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --tenantId=TENANTID | Mandanten-ID für Mandantenaktionen | |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 3
tenant-enable
Aktiviert einen bestehenden Mandanten.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --tenantId=TENANTID | Mandanten-ID für Mandantenaktionen | |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 3
tenant-list
Listet alle bestehenden Mandanten auf.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| --title=TITLE | Titel des neuen Mandanten | |
| --cacheDirectory=CACHEDIRECTORY | Cache-Verzeichnis des neuen Mandanten | |
| --tplDirectory=TPLDIRECTORY | Tpl-Verzeichnis des neuen Mandanten | |
| --host=HOST | Host des neuen Mandanten | |
| --port=PORT | Datenbankport des neuen Mandanten | |
| --user=USER | Datenbank-User des neuen Mandanten | |
| --password=PASSWORD | Datenbankpasswort des neuen Mandanten | |
| --description=DESCRIPTION | Beschreibung des neuen Mandanten | |
| --sort=SORT | Sortierungsposition des neuen Mandanten | |
| --enable | Bei der Verwendung des Parameters wird der Mandant aktiv geschaltet | |
| --disable | Bei der Verwendung des Parameters wird der Mandant inaktiv geschaltet | |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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
workflows-process
Sendet E-Mails zu Workflows und erstellt Aufgaben aus Checklisten.
Optionen:
| Parameter (Kurzfrom) | Parameter (Langform) | Beschreibung |
|---|---|---|
| -t | --types=TYPES | Workflow-Typen (mehrere Werte sind möglich) |
| -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 | Erzwingt die Ausgabe im ANSI-Format | |
| --no-ansi | Deaktiviert die Ausgabe im ANSI-Format | |
| -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 workflows-process --user admin --password admin --tenantId 1 --types task --types checklist