8 uBus is the interconnect system used by most services running on a _LEDE_ setup.
9 Services can connect to the bus and provide methods that can be called by other services or clients.
11 There is a CLI that can be used to communicate with services on the bus.
15 Usage: ubus [<options>] <command> [arguments...]
17 -s <socket>: Set the unix domain socket to connect to
18 -t <timeout>: Set the timeout (in seconds) for a command to complete
19 -S: Use simplified output (for scripts)
20 -v: More verbose output
23 - list [<path>] List objects
24 - call <path> <method> [<message>] Call an object method
25 - listen [<path>...] Listen for events
26 - send <type> [<message>] Send an event
27 - wait_for <object> [<object>...] Wait for multiple objects to appear on ubus
30 To find out which services are currently running on the bus simply use the list command. This will show a complete list.
33 root@lede:/# ubus list
39 network.interface.loopback
41 network.interface.wan6
47 To find out which methods a specific service provides also use the list command but add a few more parameters to see a complete list
50 root@OpenWrt:/# ubus -v list system
55 "watchdog":{"frequency":"Integer","timeout":"Integer","stop":"Boolean"}
56 "signal":{"pid":"Integer","signum":"Integer"}
59 You can now call a remote method and receive a reply. A reply may be a simple integer return code or a more complete reply. Internally the bus uses a blob format, the CLI conveniently converts this to JSON.
62 root@lede:/# ubus call system board
66 "system": "MIPS Malta",
68 "distribution": "LEDE",
71 "codename": "designated_driver",
72 "target": "malta\/le",
73 "description": "LEDE Designated Driver 3"
78 You can call a method and pass it some parameters by simply appending a JSON structure to the CLI command.
80 root@lede:/# ubus call system signal '{ "pid": 123, "signum": 9 }'