Skip to content

Update logbook command to use new syntax #1221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MichaelOv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update logbook command to use new syntax #1221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/de/administration/verwaltung/logbuch/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Hier wird festgelegt für welchen Zeitraum Einträge im Logbuch vorgehalten werd

[![Archivieren](../../../assets/images/de/administration/verwaltung/logbuch/2-l.png)](../../../assets/images/de/administration/verwaltung/logbuch/2-l.png)

Damit das das Logbuch archiviert wird, muss der [logbook-archive](../../../automatisierung-und-integration/cli/index.md) Befehl ausgeführt werden.
Damit das das Logbuch archiviert wird, muss der [logbook:archive](../../../automatisierung-und-integration/cli/index.md) Befehl ausgeführt werden.

## Listenansicht Logbuch

Expand Down
4 changes: 2 additions & 2 deletions docs/de/automatisierung-und-integration/automatisierung-und-cronjobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ set IDOIT_PASSWORD="admin"
set TENANT_ID="1"

:: Auszuführende Befehle
:: Logbook-Archive: Archiviert die Logbucheinträge mit einem definierten Alter, gemäß den Einstellungen auf der i-doit Oberfläche.
C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php logbook-archive --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
:: Logbook:Archive: Archiviert die Logbucheinträge mit einem definierten Alter, gemäß den Einstellungen auf der i-doit Oberfläche.
C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php logbook:archive --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%

:: Search-Index: Erneuert den Suchindex, indem dieser gelöscht und neu geschrieben wird.
C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php search-index --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
Expand Down
7 changes: 4 additions & 3 deletions docs/de/automatisierung-und-integration/cli/befehle-und-optionen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ lang: de
| [license-list](#license-list) | Listet alle Lizenzen mit allen Informationen auf (ID; Produkt; Typ; Startdatum; Enddatum; lizenzierte Objekte; lizenzierte Mandanten; Umgebung) |
| [license-remove](#license-remove) | Entfernt Lizenzen von i-doit |
| [list](#list) | Listet alle console Kommandos auf |
| [logbook-archive](#logbook-archive) | Logbuch-Einträge archivieren |
| [logbook:archive](#logbookarchive) | Logbuch-Einträge archivieren |
| [migrate-uploaded-files](#migrate-uploaded-files) | Migriert hochgeladene Dateien von i-doit <v1.13 zu v.1.14> |
| [notifications-list](#notifications-list) | Listet alle [Benachrichtigungen](../../auswertungen/benachrichtigungen.md) auf |
| [notifications-send](#notifications-send) | Benachrichtigungen per E-Mail versenden (Benachrichtigungen werden in der GUI konfiguriert) |
Expand Down Expand Up @@ -853,14 +853,15 @@ Löscht eine Lizenz aus i-doit
sudo -u www-data php console.php license-remove --user admin --password admin --license LicenseID
```

### logbook-archive
### 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) |
Expand All @@ -875,7 +876,7 @@ Archiviert die Logbucheinträge mit einem definierten Alter, gemäß den Einstel
**Beispiel zur Verwendung**

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

### migrate-uploaded-files
Expand Down
3 changes: 2 additions & 1 deletion docs/de/automatisierung-und-integration/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,6 @@ Available commands:
license-list Liste der Lizenzen: ID, Produkt, Typ (Lizenztyp), Von (Lizenzbeginn), Ablaufen (Ablaufdatum der Lizenz), Lizenziert (max. Anzahl lizenzierter Objekte), Mandanten (max. Anzahl Mandanten)
license-remove Lizenz aus i-doit entfernen
list Befehle auflisten
logbook-archive Archiviert Logbuch-Einträge (Einstellungen werden in der GUI definiert)
migrate-uploaded-files Migriert hochgeladene Dateien in i-doit <v1.13 zu v.1.14>
notifications-list Listet alle Benachrichtigungstypen und Benachrichtigungen zur späteren Verwendung auf
notifications-send Versendet E-Mails für Benachrichtigungen, die im Benachrichtigungs Add-on definiert sind
Expand Down Expand Up @@ -298,6 +297,8 @@ idoit
idoit:feature-manager [idoit:fm] Mit diesem Befehl wird es möglich sein, eine Reihe von Features in i-doit zu aktivieren.
idoit:set-env-var Mit diesem Befehl wird es möglich sein, Umgebungsvariablen für i-doit zu setzen.
idoit:set-update-capability Die i-doit-Update-Fähigkeit de- und aktivieren
logbook
logbook:archive Archiviert Logbuch-Einträge (Einstellungen werden in der GUI definiert)
system
system:tenant-export Exportieren Sie Ihre Mandantendaten einschließlich hochgeladener Dateien in ein ZIP-Paket.
system:tenant-import Importieren Sie Ihre Mandantendaten einschließlich hochgeladener Dateien aus einem ZIP-Paket, das mit dem Befehl system:tenant-export generiert wurde.
Expand Down
2 changes: 1 addition & 1 deletion docs/de/grundlagen/logbuch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Das Logbuch nimmt neue Einträge aus Dritt-Systemen entgegen, beispielsweise dur
Beispiel:

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

Archivierte Einträge lassen sich zur weiteren Auswertung wiederherstellen. Dieser Punkt befindet sich unter **Extras → CMDB → Logbuch → Wiederherstellen**.
Expand Down
4 changes: 2 additions & 2 deletions docs/de/i-doit-add-ons/flows/actions/call-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Die folgenden [console commands](../../../automatisierung-und-integration/cli/in
| [jdisc:discovery](#jdiscdiscovery) | Löst einen JDisc-Discovery-Job aus. |
| [ldap-sync](#ldap-sync) | Synchronisiert Benutzer und Gruppen von LDAP nach i-doit und legt sie als Objekte an. |
| [ldap-syncdn](#ldap-syncdn) | Synchronisiert LDAP-DNs mit den i-doit-Benutzern. |
| [logbook-archive](#logbook-archive) | Archiviert die Logbuch-Einträge mit einem definierten Alter gemäß den Einstellungen auf der i-doit-Oberfläche. |
| [logbook:archive](#logbookarchive) | Archiviert die Logbuch-Einträge mit einem definierten Alter gemäß den Einstellungen auf der i-doit-Oberfläche. |
| [notifications-send](#notifications-send) | Versendet die auf der i-doit-Oberfläche konfigurierten Benachrichtigungen. |
| [search-index](#search-index) | Stellt den Suchindex wieder her, indem er gelöscht und neu geschrieben wird. |
| [sync-dynamic-groups](#sync-dynamic-groups) | Synchronisiert die Mitglieder dynamischer Gruppen neu. |
Expand Down Expand Up @@ -102,7 +102,7 @@ Verlängert automatisch die Laufzeit von ungekündigten Verträgen. Ein Anwendun
| ---------------- | ------------------------------------ |
| **ldapServerId** | Angabe des LDAP-Servers über die ID. |

## logbook-archive
## logbook:archive

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

Expand Down
4 changes: 2 additions & 2 deletions docs/de/wartung-und-betrieb/cronjobs-einrichten.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ Dieses Script bekommt folgenden Inhalt:
test "$(whoami)" != "$APACHE_USER" && prefix="sudo -u $APACHE_USER "

log "Archive i-doit logbook"
eval "${prefix}${CONSOLE_BIN} logbook-archive $suffix" || \
abort "Command 'logbook-archive' failed"
eval "${prefix}${CONSOLE_BIN} logbook:archive $suffix" || \
abort "Command 'logbook:archive' failed"
log ""

log "Cleanup i-doit rights"
Expand Down
7 changes: 4 additions & 3 deletions docs/en/automation-and-integration/cli/commands-and-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ lang: en
| [license-list](#license-list) | Lists all licenses with all information (ID; product; type; start date; end date; licensed objects; licensed clients; environment) |
| [license-remove](#license-remove) | Removes licenses from i-doit |
| [list](#list) | Lists all commands |
| [logbook-archive](#logbook-archive) | Archiving logbook entries |
| [logbook:archive](#logbookarchive) | Archiving logbook entries |
| [migrate-uploaded-files](#migrate-uploaded-files) | Migrates uploaded files in i-doit <v1.13 to v.1.14> |
| [notifications-list](#notifications-list) | Lists all notification types and notifications for later usage |
| [notifications-send](#notifications-send) | Send notifications by e-mail (notifications are configured in the GUI) |
Expand Down Expand Up @@ -856,14 +856,15 @@ Deletes a license from i-doit
sudo -u www-data php console.php license-remove --user admin --password admin --license LicenseID
```

### logbook-archive
### logbook:archive

Archives the logbook entries with a defined age, according to the settings on the i-doit interface.

**Options:**

| Parameter (short version) | Parameter (long version) | Description |
| ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------- |
| | --batch=BATCHSIZE | Number of entries to be archived per batch [Default: 1000] |
| -u | --user=USERNAME | Username of a user who is authorized to execute |
| -p | --password=PASSWORD | Password for authentication of the previously specified user |
| -i | --tenantId=TENANT-ID | Tenant ID of the tenant to be used (default: 1) |
Expand All @@ -878,7 +879,7 @@ Archives the logbook entries with a defined age, according to the settings on th
**Example of use**

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

### migrate-uploaded-files
Expand Down
3 changes: 2 additions & 1 deletion docs/en/automation-and-integration/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,6 @@ Available commands:
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
Expand Down Expand Up @@ -298,6 +297,8 @@ 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
logbook
logbook:archive Archives Logbook entries (Settings are defined in the GUI)
system
system:tenant-export Export your tenant data including uploaded files in a ZIP package.
system:tenant-import Import your tenant data including uploaded files from a ZIP package generated from the system:tenant-export command.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/automation-and-integration/task-scheduling-and-cronjobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ set IDOIT_PASSWORD="admin"
set TENANT_ID="1"

:: Commands
:: Logbook-Archive: Archives the logbook entries with a predefined age, according to the settings on the i-doit interface.
C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php logbook-archive --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
:: Logbook:Archive: Archives the logbook entries with a predefined age, according to the settings on the i-doit interface.
C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php logbook:archive --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%

:: Search-Index: Renews the search index by deleting and rewriting it.
C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php search-index --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
Expand Down
4 changes: 2 additions & 2 deletions docs/en/basics/logbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ Whether older entries are to be archived or not can be configured via **Extras

[![Archiving and Restoring Older Entries](../assets/images/en/basics/logbook/8-lb.png)](../assets/images/en/basics/logbook/8-lb.png)

Archiving is performed via the [i-doit Console](../i-doit-add-ons/api/index.md). This step can therefore also be automated. A corresponding example of a call and a [list of parameters](../automation-and-integration/cli/index.md) can be found in the corresponding article for the [logbook-archive](../automation-and-integration/cli/index.md) option.
Archiving is performed via the [i-doit Console](../i-doit-add-ons/api/index.md). This step can therefore also be automated. A corresponding example of a call and a [list of parameters](../automation-and-integration/cli/index.md) can be found in the corresponding article for the [logbook:archive](../automation-and-integration/cli/index.md) option.

Example:

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

Archived entries can be restored for further evaluation. This item can be found under **Extras → CMDB → Logbook → Restore**.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/i-doit-add-ons/flows/actions/call-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The following [console commands](../../../automation-and-integration/cli/index.m
| [jdisc:import](#jdiscimport) | Performs a JDisc import to i-doit |
| [ldap-sync](#ldap-sync) | Synchronizes user and groups from LDAP to i-doit and creates them as objects |
| [ldap-syncdn](#ldap-syncdn) | Synchronizes LDAP DNs with the i-doit users |
| [logbook-archive](#logbook-archive) | Archives the logbook entries with a defined age, according to the settings on the i-doit interface |
| [logbook:archive](#logbookarchive) | Archives the logbook entries with a defined age, according to the settings on the i-doit interface |
| [notifications-send](#notifications-send) | Sends the notifications configured on the i-doit interface |
| [search-index](#search-index) | Restores the search index by deleting and rewriting it |
| [sync-dynamic-groups](#sync-dynamic-groups) | Resynchronizes dynamic group members |
Expand Down Expand Up @@ -102,7 +102,7 @@ Automatically extend the runtime of not-cancelled contracts. A Use case can be f
| ---------------- | ------------------------------------- |
| **ldapServerId** | Specifying the LDAP server via the ID |

## logbook-archive
## logbook:archive

Archives the logbook entries with a defined age, according to the settings on the i-doit interface.

Expand Down
Loading
Loading