Skip to content

Commit

Permalink
docs: added meta and removed Controller
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelOv
MichaelOv committed Jan 7, 2025
1 parent ae9d7d3 commit 45ab764
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 95 deletions.
158 changes: 83 additions & 75 deletions docs/de/automatisierung-und-integration/cli/console/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# Console
---
title: Console commands
description: Console commands
icon:
status:
lang: de
---

# Console commands

!!! warning "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"

i-doit verfügt über ein Command line Interface (CLI), über das sich verschiedene Aufgaben durchführen lassen. Das CLI wird beispielsweise für [Cronjobs](../../../wartung-und-betrieb/cronjobs-einrichten.md) benötigt und kann zum Automatisieren von Arbeitsschritten eingesetzt werden.
i-doit verfügt über ein **Command line Interface (CLI)**, über das sich verschiedene Aufgaben durchführen lassen. Das CLI wird beispielsweise für [Cronjobs](../../../wartung-und-betrieb/cronjobs-einrichten.md) benötigt und kann zum Automatisieren von Arbeitsschritten eingesetzt werden.

## Erste Schritte

Das CLI befindet sich im Installationsverzeichnis von i-doit, beispielsweise unter **/var/www/html/**. Es muss innerhalb dieses Verzeichnisses mit denselben Rechten des Apache Webservers aufgerufen werden. Unter Debian GNU/Linux ist dies der User **www-data**. Mittels **sudo** werden diese Rechte erlangt:
Das CLI befindet sich im Installationsverzeichnis von i-doit, beispielsweise unter `/var/www/html/`. Es muss innerhalb dieses Verzeichnisses mit denselben Rechten des Apache Webservers aufgerufen werden. Unter Debian GNU/Linux ist dies der User **www-data**. Mittels **sudo** werden diese Rechte erlangt:

```sh
cd /var/www/html/
Expand All @@ -24,80 +32,80 @@ Führt man die CLI ohne weitere Argument aus, wird die allgemeine Hilfe präsent

??? abstract "Verfügbare Kommandos ohne Add-ons"
```text
i-doit console utility 32
i-doit console utility 33

Usage:
command [options] [arguments]

Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
addon-activate Activate add-on
addon-deactivate Deactivate add-on
addon-install Install add-on
addon-list Shows list of installed addons
addon-uninstall Deactivate add-on
admin-center-password-reset With this command you can reset the Admin-Center password
auth-cleanup Cleanup all auth paths
clear-credentials It removes both attributes username and password from the users "login" category
completion Dump the shell completion script
contracts-outdated Updates status of outdated contracts
extend-contracts Automatically extend the runtime of not-cancelled contracts
help Display 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-syslog Imports data from a Syslog server textfile to the i-doit Logbook
import-xml Imports files formatted in the i-doit XML syntax
install Install the i-doit application
jdisc-create-server Creates a JDisc server, based on given input
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)
license-add Add license into i-doit
license-assign Assign hosting license to i-doit tenant
license-import Import licenses from the i-doit server
license-key Set license key for i-doit
license-list List of the licenses: ID, Product, Type (type of license), From (start of license), Expire (expiration date of license), Licensed (max amount of licensed objects), Tenants (max amount of tenants), Environment
license-remove Remove license from i-doit
list List commands
logbook-archive Archives Logbook entries (Settings are defined in the GUI)
migrate-uploaded-files Migrates uploaded files in i-doit <v1.13 to v.1.14>
notifications-list Lists all notification types and notifications for later usage
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
strip-description-html With this command you can strip html tags in description field of all categories and objects
sync-dynamic-groups Synchronize 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-categorycleanup Purges optionally category entries that are in the state unfinished, archived or deleted
system-checkforupdates Checks for i-doit core updates
system-convert-non-innodb-tables Converts all tables which are not in INNODB to INNODB (Affects database encoding. Use with caution!)
system-convert-non-utf8-tables Changes all non-UTF8-tables to UTF8 (Affects database encoding. Use with caution!)
system-location-fix Performs the location fix from the systemtools GUI
system-objectcleanup Purges optionally objects that are in the state unfinished, archived or deleted
system-objectrelations Regenerates all object relation names
system-refresh-table-configuration Refreshes all available list configurations (object types and categories)
system-set-settings Set system settings
tenant-create Create tenant in i-doit
tenant-disable Disables the tenant with specific id
tenant-enable Enables the tenant with specific id
tenant-list Shows list of available tenants
tenant-remove Remove the i-doit Tenant
uninstall Uninstall the i-doit application
update Update the i-doit application
idoit
idoit:feature-manager [idoit:fm] With this command it will be possible to activate a set of features in i-doit.
idoit:set-env-var With this command it will be possible to set environmental variables for i-doit.
idoit:set-update-capability Dis- and enable the i-doit update capability
command [options] [arguments]

Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
addon-activate Activate add-on
addon-deactivate Deactivate add-on
addon-install Install add-on
addon-list Shows list of installed addons
addon-uninstall Deactivate add-on
admin-center-password-reset With this command you can reset the Admin-Center password
auth-cleanup Cleanup all auth paths
clear-credentials It removes both attributes username and password from the users "login" category
completion Dump the shell completion script
contracts-outdated Updates status of outdated contracts
extend-contracts Automatically extend the runtime of not-cancelled contracts
help Display 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-syslog Imports data from a Syslog server textfile to the i-doit Logbook
import-xml Imports files formatted in the i-doit XML syntax
install Install the i-doit application
jdisc-create-server Creates a JDisc server, based on given input
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)
license-add Add license into i-doit
license-assign Assign hosting license to i-doit tenant
license-import Import licenses from the i-doit server
license-key Set license key for i-doit
license-list List of the licenses: ID, Product, Type (type of license), From (start of license), Expire (expiration date of license), Licensed (max amount of licensed objects), Tenants (max amount of tenants), Environment
license-remove Remove license from i-doit
list List commands
logbook-archive Archives Logbook entries (Settings are defined in the GUI)
migrate-uploaded-files Migrates uploaded files in i-doit <v1.13 to v.1.14>
notifications-list Lists all notification types and notifications for later usage
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
strip-description-html With this command you can strip html tags in description field of all categories and objects
sync-dynamic-groups Synchronize 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-categorycleanup Purges optionally category entries that are in the state unfinished, archived or deleted
system-checkforupdates Checks for i-doit core updates
system-convert-non-innodb-tables Converts all tables which are not in INNODB to INNODB (Affects database encoding. Use with caution!)
system-convert-non-utf8-tables Changes all non-UTF8-tables to UTF8 (Affects database encoding. Use with caution!)
system-location-fix Performs the location fix from the systemtools GUI
system-objectcleanup Purges optionally objects that are in the state unfinished, archived or deleted
system-objectrelations Regenerates all object relation names
system-refresh-table-configuration Refreshes all available list configurations (object types and categories)
system-set-settings Set system settings
tenant-create Create tenant in i-doit
tenant-disable Disables the tenant with specific id
tenant-enable Enables the tenant with specific id
tenant-list Shows list of available tenants
tenant-remove Remove the i-doit Tenant
uninstall Uninstall the i-doit application
update Update the i-doit application

idoit:feature-manager [idoit:fm] With this command it will be possible to activate a set of features in i-doit.
idoit:set-env-var With this command it will be possible to set environmental variables for i-doit.
idoit:set-update-capability Dis- and enable the i-doit update capability
```

## Authentifizierung
Expand Down
28 changes: 18 additions & 10 deletions ...tomatisierung-und-integration/cli/console/optionen-und-parameter-der-console.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
title: Optionen und Parameter der Console
description: Optionen und Parameter der Console
icon:
status:
lang: de
---

# Optionen und Parameter der Console

!!! warning "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"
Expand Down Expand Up @@ -67,7 +75,7 @@
| [tenant-remove](#tenant-remove) | Einen bestehenden Mandanten entfernen |
| [uninstall](#uninstall) | Deinstalliert i-doit |
| [update](#update) | Update von i-doit installieren |
| [idoit:feature-manager](#idoitfeature-manager) | Mit diesem Befehl ist es möglich Features in i-doit zu aktivieren |
| [idoit:feature-manager](#idoitfeature-manager) | Mit diesem Befehl ist es möglich Features in i-doit zu aktivieren |

!!! attention "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.<br>
Expand Down Expand Up @@ -1524,15 +1532,15 @@ Mit diesem Befehl ist es möglich Features in i-doit zu aktivieren

| 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 |
| | --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) |
Expand Down
Loading

0 comments on commit 45ab764

Please sign in to comment.