Karaf-Konsolen-Befehle Cheat Sheet

Diese Seite dient als Cheat Sheet mit häufig benötigten Karaf-Konsolen-Kommandos, d.h. die Beschreibungen sind absichtlich kompakt gehalten. Besonderes interessante Befehle sind fett. Ausführliche Dokumentation unter Apache Karaf Container 4.x - Documentation bzw. Karaf-Konsolen-Befehle für das BPC.

Allgemein

Befehl Beschreibung

Befehl	Beschreibung
`logout`	Beendet die aktuelle Karaf-Konsolen-Session
`shutdown -r`	Beendet und startet Karaf neu (nicht OpenSearch)
`<TAB-Taste> <Befehl/Subshell/…><TAB-Taste> <Subshell>:<TAB-Taste>`	Die Tabulator-Taste listet mögliche Befehle, Subshells usw., oder für eine Subshell deren Befehle (bspw. bpc:<TAB-Taste>), oder für einen Befehl die Optionen. Der Name muss nicht vollständig eingetippt werden und bei Eindeutigkeit wird automatisch vervollständigt – so wird bspw. aus der Eingabe `fe<TAB>:ins<TAB>` der Befehl `feature:install`
`<befehl/subshell> --help`	Hilfe zum Befehl. Je nach Konfiguration funktionieren auch die Aliase `help <befehl/subshell>` und `man <befehl/subshell>`
`<Subshell-Name>:<Befehl><Enter>`	Führt den Befehl der angegebenen Subshell aus.
`<Subshell-Name><Enter><Befehl><Enter>`	Wechselt in die angegebene Subshell (von der Eltern-Shell oder einer beliebigen Subshell) und führt den Befehl aus.
`exit`	Verlässt die Subshell und kehrt zur Eltern-Shell zurück.

logout

Beendet die aktuelle Karaf-Konsolen-Session

shutdown -r

Beendet und startet Karaf neu (nicht OpenSearch)

<TAB-Taste> <Befehl/Subshell/…><TAB-Taste> <Subshell>:<TAB-Taste>

Die Tabulator-Taste listet mögliche Befehle, Subshells usw., oder für eine Subshell deren Befehle (bspw. bpc:<TAB-Taste>), oder für einen Befehl die Optionen. Der Name muss nicht vollständig eingetippt werden und bei Eindeutigkeit wird automatisch vervollständigt – so wird bspw. aus der Eingabe fe<TAB>:ins<TAB> der Befehl feature:install

<befehl/subshell> --help

Hilfe zum Befehl.
Je nach Konfiguration funktionieren auch die Aliase help <befehl/subshell> und man <befehl/subshell>

<Subshell-Name>:<Befehl><Enter>

Führt den Befehl der angegebenen Subshell aus.

<Subshell-Name><Enter><Befehl><Enter>

Wechselt in die angegebene Subshell (von der Eltern-Shell oder einer beliebigen Subshell) und führt den Befehl aus.

exit

Verlässt die Subshell und kehrt zur Eltern-Shell zurück.

Karaf-Bundles auflisten, installieren, stoppen etc.

Befehl Beschreibung

Befehl	Beschreibung
`list`	Zeige installierte Bundles und ihren Status
`list \| grep -i -v "active"`	Zeige installierte Bundles, deren Zeile nicht "aktiv" enthält (-v), ignoriere Groß-/Kleinschreibung (-i)
`stop <ID>`	Stoppe das Bundle mit angegebener ID (kann via list ermittelt werden)
`restart< ID>[, <ID>]`	Starte das Bundle mit angegebener ID (kann via list ermittelt werden) neu
`feature:install <featurename>`	Installiert ein Feature, bspw. den PostgreSQL-JDBC-Treiber mit `feature:install pax-jdbc-postgresql` Teilweise Alternative zu Deployment i.S. Kopieren von Dateien nach <karaf-install-dir>/deploy
`bundle:install -s <URL>`	Installiert und startet ein OSGi-Bundle, typischerweise mit URL-Pattern mvn:my/bundle/1.0
`bundle:uninstall <URL>`	Deinstalliert ein OSGi-Bundle

list

Zeige installierte Bundles und ihren Status

list | grep -i -v "active"

Zeige installierte Bundles, deren Zeile nicht "aktiv" enthält (-v), ignoriere Groß-/Kleinschreibung (-i)

stop <ID>

Stoppe das Bundle mit angegebener ID (kann via list ermittelt werden)

restart< ID>[, <ID>]

Starte das Bundle mit angegebener ID (kann via list ermittelt werden) neu

feature:install <featurename>

Installiert ein Feature, bspw. den PostgreSQL-JDBC-Treiber mit feature:install pax-jdbc-postgresql
Teilweise Alternative zu Deployment i.S. Kopieren von Dateien nach <karaf-install-dir>/deploy

bundle:install -s <URL>

Installiert und startet ein OSGi-Bundle, typischerweise mit URL-Pattern mvn:my/bundle/1.0

bundle:uninstall <URL>

Deinstalliert ein OSGi-Bundle

Informationen zum System

Befehl Beschreibung

Befehl	Beschreibung
`log:display -n 50`	Zeige letzte 50 Log-Einträge
`log:tail [-n 20]`	Zeigt letzte [20] Log-Einträge und dann laufend die neu hinzukommenden Einträge. Mit STRG-C beenden.
`log:tail \| grep "Suchterm"`	Zeigt neu hinzukommende Log-Einträge, die den Suchterm enthalten.
`info`	Zeigt wichtige Systeminformationen, bspw. in welchem Pfad es installiert ist. Nützlich, wenn man SSH-Zugang nutzt und daher nicht weiß, wo die Instanz installiert ist, auf die man sich verbunden hat.
`system:property <key>`	Zeigt Wert von Systemeigenschaften. Beispiele für `key` sind `java.home` (Verzeichnis der genutzten JVM) oder `java.runtime.version` oder `karaf.log`(Verzeichnis mit Log-Dateien)
`system:version`	Version von Karaf
`dev:dump-create`	Erstellt eine ZIP-Datei mit umfassenden Informationen zur Problemanalyse, die bspw. für Support-Anfragen benötigt wird.

log:display -n 50

Zeige letzte 50 Log-Einträge

log:tail [-n 20]

Zeigt letzte [20] Log-Einträge und dann laufend die neu hinzukommenden Einträge.
Mit STRG-C beenden.

log:tail | grep "Suchterm"

Zeigt neu hinzukommende Log-Einträge, die den Suchterm enthalten.

info

Zeigt wichtige Systeminformationen, bspw. in welchem Pfad es installiert ist. Nützlich, wenn man SSH-Zugang nutzt und daher nicht weiß, wo die Instanz installiert ist, auf die man sich verbunden hat.

system:property <key>

Zeigt Wert von Systemeigenschaften. Beispiele für key sind java.home (Verzeichnis der genutzten JVM) oder java.runtime.version oder karaf.log(Verzeichnis mit Log-Dateien)

system:version

Version von Karaf

dev:dump-create

Erstellt eine ZIP-Datei mit umfassenden Informationen zur Problemanalyse, die bspw. für Support-Anfragen benötigt wird.

Karaf-Benutzer verwalten

Diese sind nicht zwingend identisch mit den Endbenutzern, die sich per Browser an BPC anmelden, bspw. bei INUBIT als Identity Provider.

Befehl ]Beschreibung jaas:realm-list

Befehl ]Beschreibung	jaas:realm-list
`Auflistung der Realms, um die richtige Realm herauszufinden – oft ist realm 3 der für org.apache.karaf.jaas.modules.properties.PropertiesLoginModule`	jaas:realm-manage --index 3
`Wechsel in den Realm, mit dem man arbeiten will`	jaas:user-list
`Die Nutzer und Karaf-Rollen im Realm prüfen`	jaas:user-add testUser myPass
`Den Nutzer testUser mit Passwort myPass anlegen`	jaas:role-add testUser admin
`Dem Nutzer testUser die Rolle admin geben`	jaas:update

Auflistung der Realms, um die richtige Realm herauszufinden – oft ist realm 3 der für org.apache.karaf.jaas.modules.properties.PropertiesLoginModule

jaas:realm-manage --index 3

Wechsel in den Realm, mit dem man arbeiten will

jaas:user-list

Die Nutzer und Karaf-Rollen im Realm prüfen

jaas:user-add testUser myPass

Den Nutzer testUser mit Passwort myPass anlegen

jaas:role-add testUser admin

Dem Nutzer testUser die Rolle admin geben

jaas:update

BPC-Kommandos

Siehe auch Karaf-Konsolen-Befehle für das BPC.

Befehl Beschreibung

Befehl	Beschreibung
`bpc:sessions-list`	Benutzer-Sessions auflisten
`bpc:sessions-delete <Session ID>`	Einzelne Session löschen
`bpc:sessions-delete-all`	Alle Sessions löschen
`bpc:maintenance-mode on\|status\|off`	Wartungsmodus aktivieren, abfragen oder beenden

bpc:sessions-list

Benutzer-Sessions auflisten

bpc:sessions-delete <Session ID>

Einzelne Session löschen

bpc:sessions-delete-all

Alle Sessions löschen

bpc:maintenance-mode on|status|off

Wartungsmodus aktivieren, abfragen oder beenden

Keywords: