Index · Directives · Python · libudev · gudev systemd 217

Name

busctl — Introspect the bus

Synopsis

busctl [OPTIONS...] [COMMAND] [NAME...]

Description

busctl may be used to introspect and monitor the D-Bus bus.

Options

The following options are understood:

--address=ADDRESS

Connect to the bus specified by ADDRESS instead of using suitable defaults for either the system or user bus (see --system and --user options).

--show-machine

When showing the list of endpoints, show a column containing the names of containers they belong to. See systemd-machined.service(8).

--unique

When showing the list of endpoints, show only "unique" names (of the form ":number.number").

--acquired

The opposite of --unique — only "well-known" names will be shown.

--activatable

When showing the list of endpoints, show only endpoints which have actually not been activated yet, but may be started automatically if accessed.

--match=MATCH

When showing messages being exchanged, show only the subset matching MATCH.

--no-legend

Do not print the legend, i.e. the column headers and the footer.

--size=

When used with the capture command specifies the maximum bus message size to capture ("snaplen"). Defaults to 4096 bytes.

--list

When used with the tree command shows a flat list of object paths instead of a tree.

--quiet

When used with the call command suppresses display of the response message.

--user

Talk to the service manager of the calling user, rather than the service manager of the system.

--system

Talk to the service manager of the system. This is the implied default.

-H, --host=

Execute the operation remotely. Specify a hostname, or a username and hostname separated by "@", to connect to. The hostname may optionally be suffixed by a container name, separated by ":", which connects directly to a specific container on the specified host. This will use SSH to talk to the remote machine manager instance. Container names may be enumerated with machinectl -H HOST.

-M, --machine=

Execute operation on a local container. Specify a container name to connect to.

-h, --help

Print a short help text and exit.

--version

Print a short version string and exit.

--no-pager

Do not pipe output into a pager.

Commands

The following commands are understood:

list

Show service names on the bus. This is the default if no command is specified.

tree [SERVICE...]

Shows an object tree of one or more services. If SERVICE is specified, show object tree of the specified services only. Otherwise, show all object trees of all services on the bus that acquired at least one well-known name.

monitor [SERVICE...]

Dump messages being exchanged. If SERVICE is specified, show messages to or from this endpoint. Otherwise, show all messages on the bus.

capture [SERVICE...]

Similar to monitor but writes the output in pcap format (for details see the Libpcap File Format description. Make sure to redirect the output to STDOUT to a file. Tools like wireshark(1) may be used to dissect and view the generated files.

status SERVICE

Show process information and credentials of a bus service.

call SERVICE OBJECT INTERFACE METHOD [SIGNATURE [PARAMETERS...]]

Invoke a method and show the response. Takes a service name, object path, interface name and method name. If parameters shall be passed to the method call a signature string is required, followed by the individual parameters, individually formatted as textual arguments.

get-property SERVICE OBJECT [INTERFACE [PROPERTIES...]]

Retrieve the current value one or more object properties. Takes a service name and object path. Optionally takes an interface name and property name. If the property name is omited, shows all properties on the selected interface. If the interface is also omitted shows the properties of all interfaces. Multiple properties may be specified at once in which case their values will be shown one after the other.

help

Show command syntax help.

See Also

dbus-daemon(1), D-Bus, kdbus, sd-bus(3), systemd(1), systemd-bus-proxyd(8), machinectl(1), wireshark(1)