Ubuntu Manpage: busctl - Den Bus prüfen

BEZEICHNUNG

       busctl - Den Bus prüfen

ÜBERSICHT

       busctl [OPTIONEN…] [BEFEHL] [NAME…]

BESCHREIBUNG

       busctl kann zum Prüfen und Überwachen des D-Bus-Busses verwandt werden.

OPTIONEN

Die folgenden Optionen werden verstanden:

--address=ADRESSE
Verbindet mit dem durch ADRESSE festgelegten Bus, anstatt geeignete Vorgaben für
entweder den System- oder den Benutzerbus zu verwenden (siehe die Optionen --system
und --user).

--show-machine
Zeigt bei der Anzeige der Liste der Peers (Gegenstellen) eine Spalte mit den Namen der
Container an, zu denen sie gehören. Siehe systemd-machined.service(8).

--unique
Zeigt bei der Anzeige der Liste der Peers (Gegenstellen) nur »eindeutige« Namen (der
Form »:Zahl.Zahl«) an.

--acquired
Das Gegenteil von --unique — nur »gut bekannte« Namen werden angezeigt.

--activatable
Zeigt bei der Anzeige der Liste der Peers (Gegenstellen) nur jene an, die tatsächlich
noch nicht aktiviert wurden, aber beim Zugriff darauf automatisch gestartet werden
könnten.

--match=TREFFER
Bei der Anzeige der ausgetauschten Nachrichten wird nur die auf TREFFER passende
Teilmenge angezeigt. Siehe sd_bus_add_match(3).

--size=
Bei der Verwendung mit dem Befehl capture legt dies die maximale Busnachrichtengröße
fest, die aufgenommen (»snaplen«) werden soll. Standardmäßig 4096 Byte.

--list
Bei der Verwendung mit dem Befehl tree wird eine flache Liste von Objektpfaden statt
eines Baumes angezeigt.

-q, --quiet
Bei der Verwendung mit dem Befehl call wird die Anzeige der Antwortnachrichtennutzlast
unterdrückt. Beachten Sie, dass zurückgelieferte Fehler weiterhin ausgegeben und das
Werkzeug den Erfolg oder Misserfolg durch den Exit-Code des Prozesses angeben wird,
selbst wenn diese Option festgelegt ist.

--verbose
Bei der Verwendung mit dem Befehl call oder get-property wird die Ausgabe in einem
ausführlicheren Format angezeigt.

--xml-interface
Gibt die vom D-Bus-Aufruf org.freedesktop.DBus.Introspectable.Introspect empfangene
XML-Beschreibung statt der normalen Ausgabe aus, falls mit dem Aufur introspect
verwandt.

--json=MODUS
Wird dies mit dem Befehl call oder get-property verwandt, zeigt es die Ausgabe im
JSON-Format an. Erwartet entweder »short« (für die kürzest mögliche Ausgabe ohne
redundanten Leerraum oder Zeilenumbrüche) oder »pretty« (für eine schöne Version des
gleichen, mit Einrückungen und Zeilenumbrüchen). Beachten Sie, dass die Umwandlung von
der D-Bus-Anordnung nach JSON auf eine verlustfreie Art erfolgt, was bedeutet, dass
Typinformationen in den JSON-Objektbaum eingebettet sind.

-j
Äquivalent zu --json=pretty, wenn interaktiv von einem Terminal aufgerufen.
Andernfalls äquivalent zu --json=short, insbesondere wenn die Ausgabe mittels Pipe an
ein anderes Programm weitergeleitet wird.

--expect-reply=LOGISCH
Bei der Verwendung mit dem Befehl call legt dies fest, ob busctl auf den Abschluss des
Methodenaufrufs warten, die Ausgabe der zurückgelieferten Methodenantwortdaten
ausgeben und Erfolg oder Fehler mittels des Prozess-Exit-Codes zurückliefern soll.
Falls dies auf »no« gesetzt ist, wird der Methodenaufruf durchgeführt, aber es wird
keine Antwort erwartet, das Werkzeug beendet sich sofort und daher kann keine Antwort
angezeigt und kein Erfolg oder Misserfolg über den Exit-Code zurückgeliefert werden.
Um nur die Ausgabe der Antwortnachrichtennutzlast zu unterdrücken, verwenden Sie
--quiet oben. Standardmäßig »yes«.

--auto-start=LOGISCH
Bei der Verwendung mit dem Befehl call oder emit legt dies fest, ob der Methodenaufruf
implizit den aufgerufenen Dienst aktivieren soll, falls er noch nicht laufen sollte,
aber für automatisches Starten konfiguriert ist. Standardmäßig »yes«.

--allow-interactive-authorization=LOGISCH
Bei der Verwendung mit dem Befehl call legt dies fest, ob der Dienst interaktive
Autorisierung während der Ausführung einer Aktion erzwingen darf, falls die
Sicherheitsrichtlinie dafür konfiguriert ist. Standardmäßig »yes«.

--timeout=SEKS
Bei der Verwendung mit dem Befehl call legt dies die maximale Zeit, die auf den
Abschluss eines Methodenaufrufs gewartet werden soll, fest. Falls keine Zeiteinheit
festgelegt ist, wird Sekunden angenommen. Die normalen anderen Einheiten werden auch
verstanden (ms, us, s, min, h, d, w, month, y). Beachten Sie, dass diese
Zeitüberschreitung nicht angewandt wird, falls --expect-reply=no verwandt wird, da das
Werkzeug dann nicht auf eine Antwortnachricht wartet. Falls nicht angegeben oder auf 0
gesetzt, wird die Vorgabe von »25s« angenommen.

--augment-creds=LOGISCH
Steuert, ob das Berichten der Berechtigungsnachweise durch list oder status mit Daten
aus /proc ergänzt werden soll. Wenn dies eingeschaltet ist, sind die dargestellten
Daten möglicherweise inkonsistent, da die aus /proc gelesenen Daten neuer als der Rest
der Berechtigungsnachweisinformationen sein könnten. Standardmäßig »yes«.

--watch-bind=LOGISCH
Steuert, ob auf das Auftauchen des festgelegten AF_UNIX-Bus-Sockets im Dateisystem
gewartet werden soll, bevor damit verbunden wird. Standardmäßig aus. Falls aktiviert,
wird das Werkzeug das Dateisystem beobachten, bis das Socket erstellt ist und sich
dann mit ihm verbinden.

--destination=DIENST
Akzeptiert einen Dienstenamen. Bei der Verwendung mit dem Befehl emit wird ein Signal
an den festgelegten Dienst ausgesandt.

--user
Kommuniziert mit dem Diensteverwalter des aufrufenden Benutzers statt mit dem
Diensteverwalter des Systems.

--system
Kommuniziert mit dem Diensteverwalter des Systems. Dies ist die implizite Vorgabe.

-H, --host=
Führt die Aktion aus der Ferne aus. Geben Sie den Rechnernamen oder einen
Benutzernamen und Rechnernamen (getrennt durch »@«) an, zu dem verbunden werden soll.
Dem Rechnernamen darf optional ein Port, auf dem SSH auf Anfragen wartet, getrennt
durch »:« und dann ein Container auf dem festgelegten Host angehängt werden, womit
direkt zu einem bestimmten Container auf dem angegebenen Rechner verbunden wird. Dies
verwendet SSH, um mit der Maschinen-Verwalterinstanz auf dem Rechner in der Ferne zu
kommunizieren. Container-Namen dürfen mit machinectl -H RECHNER aufgezählt werden.
Stellen Sie IPv6-Adressen in Klammern.

-M, --machine=
Führt die Aktion in einem lokalen Container aus. Geben Sie den Namen des Containers
an, zu dem verbunden werden soll.

--no-pager
Die Ausgabe nicht an ein Textanzeigeprogramm weiterleiten.

--no-legend
Gibt die Legende nicht aus, d.h. die Spaltenköpfe und die Fußzeile mit Hinweisen.

-h, --help
Zeigt einen kurzen Hilfetext an und beendet das Programm.

--version
Zeigt eine kurze Versionszeichenkette an und beendet das Programm.

BEFEHLE

Die folgenden Befehle werden verstanden:

list
Zeigt alle Peers (Gegenstellen) durch ihren Dienstenamen auf dem Bus. Standardmäßig
werden sowohl eindeutige als auch gut bekannte Namen angezeigt, dies kann aber mit den
Schaltern --unique und --acquired geändert werden. Dies ist die Vorgabeaktion, falls
kein Befehl festgelegt ist.

status [DIENST]
Zeigt Prozessinformationen und Berechtigungsnachweise eines Bus-Dienstes (falls einer
durch seinen eindeutigen oder gut bekannten Namen festgelegt ist), eines Prozesses
(falls einer durch seine numerische PID festgelegt ist) oder des Eigentümers des
Busses (falls kein Parameter festgelegt ist).

monitor [DIENST…]
Schreibt die ausgetauschten Nachrichten raus. Falls DIENST festgelegt ist, werden die
Nachrichten von und an diesen Peer (Gegenstelle), der durch seinen gut bekannten oder
eindeutigen Namen identifiziert ist, angezeigt. Andernfalls werden alle Nachrichten
auf dem Bus angezeigt. Verwenden Sie Strg+C, um die Ausgabe abzubrechen.

capture [DIENST…]
Ähnlich zu monitor, schreibt die Ausgabe aber im Pcap-Format (für Details siehe die
Beschreibung Libpcap-Dateiformat[1]). Stellen Sie sicher, dass die die Standardausgabe
in eine Datei umgelenkt ist. Werkzeuge wie wireshark(1) können zum Analysieren und
Anschauen der entstehenden Dateien verwandt werden.

tree [DIENST…]
Zeigt einen Objektbaum von einem oder mehreren Diensten. Falls DIENST festgelegt ist,
wird nur der Objektbaum des festgelegten Dienstes gezeigt. Andernfalls werden alle
Objektbäume aller Dienste auf dem Bus, der mindestens einen gut bekannten Namen
erlangte, angezeigt.

introspect DIENST OBJEKT [SCHNITTSTELLE]
Zeigt Schnittstellen, Methoden, Eigenschaften und Signale der festgelegten Objekte
(identifiziert durch ihren Pfad) auf dem festgelegten Dienst. Falls das
Schnittstellenargument übergeben wurde, wird die Ausgabe auf die Elemente auf der
festgelegten Schnittstelle beschränkt.

call DIENST OBJEKT SCHNITTSTELLE METHODE [SIGNATUR [ARGUMENT…]]
Ruft eine Methode auf und zeigt die Antwort. Akzeptiert einen Dienstenamen, einen
Objektpfad, Schnittstellennamen und Methodennamen. Falls Parameter an den
Methodenaufruf übergeben werden sollen, wird eine Signaturzeichenkette, gefolgt von
den Argumenten, die individuell als Zeichenketten formatiert sind, benötigt. Für
Details über die verwandte Formatierung siehe unten. Um die Ausgabe der
zurückgelieferten Daten zu unterdrücken, verwenden Sie die Option --quiet.

emit OBJEKT SCHNITTSTELLE SIGNAL [SIGNATURE [ARGUMENT…]]
Sendet ein Signal. Akzeptiert einen Objektpfad, Schnittstellennamen und Methodennamen.
Falls Parameter übergeben werden sollen, wird eine Signaturzeichenkette, gefolgt von
den Argumenten, die individuell als Zeichenketten formatiert sind, benötigt. Für
Details über die verwandte Formatierung siehe unten. Um das Ziel des Signals
festzulegen, verwenden Sie die Option --destination=.

get-property DIENST OBJEKT SCHNITTSTELLE EIGENSCHAFT…
Ruft den aktuellen Wert einer oder mehrerer Objekteigenschaften ab. Akzeptiert einen
Dienstenamen, einen Objektpfad, einen Schnittstellennamen und einen
Eigenschaftennamen. Mehrere Eigenschaften können auf einmal, getrennt durch
Zeilenumbrüche, festgelegt werden. In diesem Falle werden ihre Werte einer nach dem
anderen angezeigt. Die Ausgabe ist standardmäßig im knappen Format. Verwenden Sie
--verbose für ein ausführlicheres Ausgabeformat.

set-property DIENST OBJEKT SCHNITTSTELLE EIGENSCHAFT SIGNATUR ARGUMENT…
Setzt den aktuellen Wert einer Objekteigenschaft. Akzeptiert einen Dienstenamen,
Objektpfad, Schnittstellennamen, Eigenschaftsnamen, Eigenschaftssignatur, gefolgt von
einer Liste von Parametern, die als Zeichenketten formatiert sind.

help
Zeigt die Hilfe zur Befehlssyntax.

PARAMETERFORMATIERUNG

Die Befehle call und set-property akzeptieren eine Signaturzeichenkette, gefolgt von einer
Liste von als Zeichenketten formatierten Parametern (für Details über
D-Bus-Signaturzeichenketten siehe das Typesystemkapitel der D-Bus-Spezifikation[2]). Für
einfache Typen sollte jeder der Signatur folgenden Parameter einfach der als Zeichenkette
formatierte Parameter sein. Positive logische Werte können als »true«, yes«, »on« oder
»1«, negative logische Werte können als »false«, »no«, »off« oder »0« festgelegt sein. Für
Felder soll ein numerisches Argument für die Anzahl der Einträge gefolgt von den Einträgen
festgelegt werden. Für Varianten soll die Signatur der Einträge, gefolgt von den Inhalten,
festgelegt werden. Für Wörterbücher und Strukturen sollen die Einträge direkt festgelegt
werden.

Beispielsweise ist

s jawoll

die Formatierung einer einzelnen Zeichenkette »jawoll«.

as 3 Hallo Welt foobar

ist die Formatierung eines Zeichenkettenfeldes mit den drei Einträgen »Hallo«, »Welt« und
»foobar«.

a{sv} 3 Eins s One Zwei u 2 Ja b true

ist die Formatierung eines Wörterbuchfeldes, das Zeichenketten auf Varianten abbildet und
aus drei Einträgen besteht. Der Zeichenkette »Eins« wird »One« zugeordnet. Der
Zeichenkette »Zwei« wird die vorzeichenfreie 32-Bit-Ganzzahl 2 zugeordnet. Der
Zeichenkette »Ja« wird ein positiver logischer Wert zugeordnet.

Beachten Sie, dass die Befehle call, get-property, introspect auch Ausgaben für die
zurückgelieferten Daten in diesem Format erstellen. Da dieses Format manchmal zu knapp und
daher nicht immer leicht verständlich ist, können die Befehle call und get-property eine
ausführlichere, mehrzeilige Ausgabe, wenn die Option --verbose übergeben wird, erzeugen.

BEISPIELE

       Beispiel 1. Eine Eigenschaft lesen und schreiben

       Die folgenden zwei Befehle schreiben zuerst eine Eigenschaft und lesen sie dann zurück.
       Die Eigenschaft wird im Objekt »/org/freedesktop/systemd1« des Dienstes
       »org.freedesktop.systemd1« gefunden. Der Name der Eigenschaft ist »LogLevel« auf der
       Schnittstelle »org.freedesktop.systemd1.Manager«. Die Eigenschaft enthält eine einzelne
       Zeichenkette:

           # busctl set-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel s debug
           # busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel
           s "debug"

       Beispiel 2. Knappe und ausführliche Ausgabe

       Die folgenden zwei Befehle lesen eine Eigenschaft, die ein Feld von Zeichenketten enthält,
       und zeigen sie zuerst in einem knappen, gefolgt von einem ausführlichen Format:

           $ busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
           as 2 "LANG=en_US.UTF-8" "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
           $ busctl get-property --verbose org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
           ARRAY "s" {
                   STRING "LANG=en_US.UTF-8";
                   STRING "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin";
           };

       Beispiel 3. Eine Methode aufrufen

       Die folgenden Befehle rufen die Methode »StartUnit« auf der Schnittstelle
       »org.freedesktop.systemd1.Manager« des Objektes »/org/freedesktop/systemd1« des Dienstes
       »org.freedesktop.systemd1« auf und übergeben ihr zwei Zeichenketten »cups.service« und
       »replace«. Als Ergebnis des Methodenaufrufs wird ein einzelnes Pfadparameterobjekt
       empfangen und angezeigt:

           # busctl call org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager StartUnit ss "cups.service" "replace"
           o "/org/freedesktop/systemd1/job/42684"

SIEHE AUCH

       dbus-daemon(1), D-Bus[3], sd-bus(3), systemd(1), machinectl(1), wireshark(1)

ANMERKUNGEN

        1. Libpcap-Dateiformat
           https://wiki.wireshark.org/Development/LibpcapFileFormat

        2. Typsystemkapitel der D-Bus-Spezifikation
           http://dbus.freedesktop.org/doc/dbus-specification.html#type-system

        3. D-Bus
           https://www.freedesktop.org/wiki/Software/dbus

ÜBERSETZUNG

       Die deutsche Übersetzung dieser Handbuchseite wurde von Helge Kreutzmann
       <debian@helgefjell.de> erstellt.

       Diese Übersetzung ist Freie Dokumentation; lesen Sie die GNU General Public License
       Version 3 oder neuer bezüglich der Copyright-Bedingungen. Es wird KEINE HAFTUNG
       übernommen.

       Wenn Sie Fehler in der Übersetzung dieser Handbuchseite finden, schicken Sie bitte eine E-
       Mail an <debian-l10n-german@lists.debian.org>.