Please create a complete backup before making any changes to an interface/import. If the result is not satisfying, it can then be restored
i-doit has a Command line Interface (CLI) with which you can carry out various tasks. For example, the CLI is required for Cronjobs and can be applied for the automation of work steps.
The CLI can be found in the i-doit installation directory, for example at /var/www/html/. Within this directory the CLI has to be activated with the same permissions as the Apache webserver. Under Debian GNU/Linux this is the user called www-data. You can achieve the permissions with sudo:
12
cd/var/www/html/
sudo-uwww-dataphpconsole.php
Under Windows you also have to change to the installation directory. As the permissions of the webserver are not an issue, the start of php.exe, which has to stand in the path of the user, is sufficient.
12
cd C:\xampp\htdocs
php.exe console.php
When you execute the CLI without further arguments, the general help is displayed:
i-doit console utility 34
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
system
system:tenant-export Export your tenant data including uploaded files in a ZIP package.
In order to access i-doit via the CLI an authentication is required for most of the commands. For this purpose, you hand over a user name, the appropriate password and the desired tenant ID. With a default installation, in most cases the latter is "1".
We recommend creating a dedicated user in i-doit for the application of the CLI. If this user is to be configured as local user, create it as object of the type Persons with the desired credentials in the Persons → Login category. This user should receive admin rights. The rights assignment can be carried out through allocation to the predefined Person group Admin.