rookeryd
The operations of rookeryd, on every host.
The operations of a host's rookeryd, over its unix sockets.
| Operation | Kind | Summary |
|---|---|---|
actions.list | call | The actions the caller may run, in the order of the file. |
actions.run | call | Run an action. It and what extends it are the steps of one session. |
actions.choices | call | The values to offer for an argument. |
version | call | The version of rookeryd and of its API. |
reload | call | Read the configuration files again. Sessions go on. |
sessions.start | call | Start a session. |
sessions.list | call | All sessions, running and ended. |
sessions.get | call | One session's state. The agent sees those it started through an action. |
sessions.attach | stream | A session, live: its output as it is produced, and input to it. |
sessions.delete | call | End it if it runs (HUP, after five seconds KILL) and forget it with its transcript. |
sessions.output | call | The transcript, by bytes or by lines. |
sessions.screen | call | A terminal as it looks now, as text. |
sessions.input | call | Write to standard input or type into the terminal. Never recorded. |
sessions.resize | call | Give a terminal a new size. |
sessions.signal | call | Send INT, TERM, HUP or KILL to the session's process group. |
applied.profile | call | The profile the host keeps of itself, as the last apply or the first boot wrote it. |
system.stats | call | Load, CPU, memory, filesystems, network, GPU and unit states, read now. |
system.power | call | Reboot the host or power it off. Refused while sessions run. |
desktop.screenshot | call | The shared desktop as PNG. |
files.read | call | A folder's entries (a Listing), or a file's content; Range is honoured. As the agent, under the configured roots. |
files.write | call | Write one file, creating its folders. |
files.delete | call | Remove a file or an empty folder; never a root itself. |
units.list | call | The units and their state. |
units.get | call | One unit's properties, as systemctl show gives them. |
units.act | call | Start, stop, restart, reload, enable or disable a unit. |
logs.read | call | Journal entries. |
logs.follow | stream | Journal entries, then what is logged. |
processes.list | call | The processes, from /proc. |
processes.signal | call | Send a signal to a process. |
channel.publish | call | Publish a message on a topic. |
channel.read | call | Kept messages after since. |
channel.listen | stream | Messages on the channel: the kept ones after since, then what arrives. |
services.list | call | The services that can be called, and whether each is up. |
services.call | call | Call a method of the service PLUGIN/NAME: JSON in, JSON out. |
services.serve | stream | For the program that answers a service's calls. While it is open the service is up. |
ports.connect | stream | A TCP connection to a port on the host's loopback, 127.0.0.1. The port is dialled first, so one that nothing listens on is an error and not a stream. |
endpoints.connect | stream | For rookery serve alone: a TCP connection to an address on a network of the host's own interfaces, such as a container on a bridge. The address is resolved once, every address it has is checked, and the one checked is dialled first, so one that nothing answers on is an error and not a stream. |