Skip to Content

rookeryd

The operations of rookeryd, on every host.

The operations of a host's rookeryd, over its unix sockets.

OperationKindSummary
actions.listcallThe actions the caller may run, in the order of the file.
actions.runcallRun an action. It and what extends it are the steps of one session.
actions.choicescallThe values to offer for an argument.
versioncallThe version of rookeryd and of its API.
reloadcallRead the configuration files again. Sessions go on.
sessions.startcallStart a session.
sessions.listcallAll sessions, running and ended.
sessions.getcallOne session's state. The agent sees those it started through an action.
sessions.attachstreamA session, live: its output as it is produced, and input to it.
sessions.deletecallEnd it if it runs (HUP, after five seconds KILL) and forget it with its transcript.
sessions.outputcallThe transcript, by bytes or by lines.
sessions.screencallA terminal as it looks now, as text.
sessions.inputcallWrite to standard input or type into the terminal. Never recorded.
sessions.resizecallGive a terminal a new size.
sessions.signalcallSend INT, TERM, HUP or KILL to the session's process group.
applied.profilecallThe profile the host keeps of itself, as the last apply or the first boot wrote it.
system.statscallLoad, CPU, memory, filesystems, network, GPU and unit states, read now.
system.powercallReboot the host or power it off. Refused while sessions run.
desktop.screenshotcallThe shared desktop as PNG.
files.readcallA folder's entries (a Listing), or a file's content; Range is honoured. As the agent, under the configured roots.
files.writecallWrite one file, creating its folders.
files.deletecallRemove a file or an empty folder; never a root itself.
units.listcallThe units and their state.
units.getcallOne unit's properties, as systemctl show gives them.
units.actcallStart, stop, restart, reload, enable or disable a unit.
logs.readcallJournal entries.
logs.followstreamJournal entries, then what is logged.
processes.listcallThe processes, from /proc.
processes.signalcallSend a signal to a process.
channel.publishcallPublish a message on a topic.
channel.readcallKept messages after since.
channel.listenstreamMessages on the channel: the kept ones after since, then what arrives.
services.listcallThe services that can be called, and whether each is up.
services.callcallCall a method of the service PLUGIN/NAME: JSON in, JSON out.
services.servestreamFor the program that answers a service's calls. While it is open the service is up.
ports.connectstreamA 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.connectstreamFor 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.