Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note
titleHinweise

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:

CommandSysteminterne Beschreibung (en)
Handler und Parameter der Consoleauth-cleanupCleanup all auth pathsHandler und Parameter der Console
check_mk-exportExports i-doit objects and Host Tags to Check_MK WATO configuration files
Handler und Parameter der Consolecheck_mk-livestatusImports monitoring status changes from Livestatusto the i-doit Logbook
helpDisplays help for a command
Handler und Parameter der Consoleimport-csvImports CSV formatted files (Using a predefined CSV Import filter, defined in the GUI)
Handler und Parameter der Consoleimport-csvprofilesList all available csv profiles
Handler und Parameter der Consoleimport-hinventoryImports files formatted in the hInventory XML syntax
Handler und Parameter der Consoleimport-jdiscImports data from a JDisc server (SQL server access is defined in the GUI)
Handler und Parameter der Consoleimport-jdiscdiscoveryTriggers a JDisc discovery (API Access to the JDisc server is defined in the GUI)
Handler und Parameter der Consoleimport-ocsImports data from an OCS inventory NG server (SQL server access is defined in the GUI)
import-syslogImports data from a Syslog server textfile to the i-doit Logbook
import-xmlImports files formatted in the i-doit XML syntax
Handler und Parameter der Consoleldap-syncSynchronizes LDAP user accounts with i-doit user objects
ldap-syncdnSynchronizes LDAP user DN attributes with i-doit user objects (Only needs to be run when migrating between different LDAP sources)
listLists commandsHandler und Parameter der Console
logbook-archiveArchives Logbook entries (Settings are defined in the GUI)
Handler und Parameter der ConsolemaintenanceSends out e-mails for objects with a planned maintenance. As defined in the maintenance add-on
Handler und Parameter der Consolenagios-exportExports i-doit objects and monitoring settings to Nagios configuration files
Handler und Parameter der Consolenagios-ndoutilsImports monitoring status changes from NDOUtils into the i-doit logbook
Handler und Parameter der Consolenotifications-sendSends out e-mails for notifications defined in the notification add-on
Handler und Parameter der Console report-exportExecutes an i-doit report and saves it to a file as CSV, TXT, PDF or XML
Handler und Parameter der Console searchTriggers a search and gives the results as formatted text table
Handler und Parameter der Consolesearch-indexDeletes current search index and create it
Handler und Parameter der Consolesync-dynamic-groupsSyncronize dynamic group members
Handler und Parameter der Consolesystem-autoincrementChanges the initial autoincrement value for all i-doit database tables (Affects everything, Object-IDs, category
entries, etc. Use with caution!)
Handler und Parameter der Consolesystem-checkforupdatesChecks for i-doit core updates
Handler und Parameter der Consolesystem-maintenancecontractSends e-mail notifications for maintenance contracts (Function is deprecated, please use the notification add-on)
Handler und Parameter der Consolesystem-objectcleanupPurges optionally objects that are in the state unfinished, archived or deleted
Handler und Parameter der Consolesystem-objectrelationsRegenerates all object relation names
Handler und Parameter der Consoletenant-addAdd a new tenant
Handler und Parameter der Consoletenant-disableDisable a tenant
Handler und Parameter der Consoletenant-enableEnable a new tenant
Handler und Parameter der Consoletenant-listList all tenants
Handler und Parameter der Consoleworkflows-processProcess all workflows, send e-mails and create newtasks from checklists
Note
titleKonfigurationsdatei 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.

Anchor
auth-cleanup
auth-cleanup

auth-cleanup

Leert den Cache des Rechtesystems, damit die derzeit konfigurierten Rechte aktuell sind bzw. aktualisiert werden.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php auth-cleanup --user admin --password admin --tenantId 1

Anchor
check_mk-export
check_mk-export

check_mk-export

Führt einen Check_MK Export durch

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php check_mk-export --user admin --password admin --tenantId 1


Anchor
check_mk-livestatus
check_mk-livestatus

check_mk-livestatus

Importiert die Änderungen am Monitoring-Status aus Livestatus nach i-doit

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php check_mk-livestatus --user admin --password admin --tenantId 1

Anchor
import-csv
import-csv

import-csv

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

...

Code Block
languagebash
themeRDark
titleBeispiel 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

Anchor
import-csvprofiles
import-csvprofiles

import-csvprofiles

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php import-csvprofiles --user admin --password admin --tenantId 1


Anchor
import-hinventory
import-hinventory

import-hinventory

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

...

Code Block
languagebash
themeRDark
titleBeispiel 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 


Anchor
import-jdisc
import-jdisc

import-jdisc

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

...

Code Block
languagebash
themeRDark
titleBeispiel 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


Anchor
import-jdiscdiscovery
import-jdiscdiscovery

import-jdiscdiscovery

Löst einen JDisc Discovery Job aus.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php import-jdiscdiscovery --user admin --password admin --tenantId 1 --server 2


Anchor
import-ocs
import-ocs

import-ocs

Führt einen Import von Inhalten einer OCS-Datenbank nach i-doit aus.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php import-ocs --user admin --password admin --tenantId 1 --databaseSchema ocs --objectType C__OBJTYPE__CLIENT


Anchor
import-syslog
import-syslog

import-syslog

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php import-syslog --user admin --password admin --tenantId 1

Anchor
import-xml
import-xml

import-xml

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

...

Code Block
languagebash
themeRDark
titleBeispiel 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 

Anchor
ldap-sync
ldap-sync

ldap-sync

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php ldap-sync --user admin --password admin --tenantId 1 --verbose --ldapServerId 1


Anchor
ldap-syncdn
ldap-syncdn

ldap-syncdn

Synchronisiert LDAP DNs mit den i-doit Usern.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php ldap-syncdn --user admin --password admin --tenantId 1 --ldapServerId 1


Anchor
logbook-archive
logbook-archive

logbook-archive

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php logbook-archive --user admin --password admin --tenantId 1


Anchor
maintenance
maintenance

maintenance

Verschickt E-Mails mit geplanten Wartungen gemäß den im Add-on "Wartungen" festgelegten Zeiträumen.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php maintenance --user admin --password admin --tenantId 1


Anchor
nagios-export
nagios-export

nagios-export

Exportiert die Nagios-Einstellungen und i-doit Objekte in Nagios-Konfigurationsdateien.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php nagios-export --user admin --password admin --tenantId 1 --nagiosHostId 1


Anchor
nagios-ndoutils
nagios-ndoutils

nagios-ndoutils

Importiert Monitoring Statusänderungen aus den NDOUtils in das i-doit Logbuch.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php nagios-ndoutils --user admin --password admin --tenantId 1


Anchor
notifications-send
notifications-send

notifications-send

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php notifications-send --user admin --password admin --tenantId 1


Anchor
report-export
report-export

report-export

Exportiert einen Report in das gewünschte Dateiformat.

...

Code Block
languagebash
themeRDark
titleBeispiel 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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php search --user admin --password admin --tenantId 1 --searchString "Server001"


Anchor
search-index
search-index

search-index

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php search-index --user admin --password admin --tenantId 1


Anchor
sync-dynamic-groups
sync-dynamic-groups

sync-dynamic-groups

Synchronisiert dynamische Gruppenmitglieder neu.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php sync-dynamic-groups --user admin --password admin --tenantId --groups 173,188,219


Anchor
system-autoincrement
system-autoincrement

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.

...

Anchor
system-checkforupdates
system-checkforupdates

system-checkforupdates

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

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php system-checkforupdates


Anchor
system-maintenancecontract
system-maintenancecontract

system-maintenancecontract

Verschickt eine E-Mail Benachrichtigung für Wartungskontakte.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php system-maintenancecontract --user admin --password admin --tenantId 1

Anchor
system-objectcleanup
system-objectcleanup

system-objectcleanup

Bereinigt alle Objekte mit einem selbst definierbarem Status.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php system-objectcleanup --user admin --password admin --tenantId 1 --objectStatus 1


Anchor
system-objectrelations
system-objectrelations

system-objectrelations

Erneuert die Bezeichnungen aller Objektbeziehungen.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php system-objectrelations --user admin --password admin --tenantId 1 --categoryConstant C__CATG__IP


Anchor
tenant-add
tenant-add

tenant-add

Erstellt einen neuen Mandanten

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php tenant-add --title Musterfirma --user idoit --password idoitpassword -- enable --tenantId 3


Anchor
tenant-disable
tenant-disable

tenant-disable

Deaktiviert einen existierenden Mandaten.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php tenant-disable --tenantId 3


Anchor
tenant-enable
tenant-enable

tenant-enable

Aktiviert einen bestehenden Mandanten.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php tenant-enable --tenantId 3


Anchor
tenant-list
tenant-list

tenant-list

Listet alle bestehenden Mandanten auf.

...

Code Block
languagebash
themeRDark
titleBeispiel zur Verwendung
sudo -u www-data php console.php tenant-list


Anchor
workflows-process
workflows-process

workflows-process

Sendet E-Mails zu Workflows und erstellt Aufgaben aus Checklisten.

...