RSET(1) General Commands Manual RSET(1)

rsetconfigure systems using labeled scripts

rset [-ln] [-F sshconfig_file] [-f route_file] host_pattern [label_pattern]

rset evaluates script fragments written in Progressive Label Notation (pln(5)), executing each one in tern using ssh connection multiplexing. rset requires one parameter specifying the regular expression matching hosts to configure.

A second regex may be specified to limit execution to labels matching a specific pattern. By default only labels beginning with [0-9a-z] are evaluated.

The arguments are as follows:

List the options associated with each label.
Do not execute commands. Hostnames are highlighted to show what characters the host_pattern matched.
Specify a config file for ssh(1) to use.
Specify a route_file. This file is composed of labels which correspond to hostnames or IP addresses which are matched against host_pattern. The default is routes.pln.
Allow TTY input by copying the content of each label to the remote host instead of opening a pipe to the interpreter.
Print the HTTP log messages after each label is executed

Execution on the remote host sets the following environment variables: INSTALL_URL, LABEL, ROUTE_LABEL.

Available hosts and the pathnames to labeled scripts to run are read from routes.pln, located in the current directory.

A ssh master is established at the beginning of a session and all subsequent interactions with a host are run over a socket at /tmp/rset_control_{hostname}.

The local directory _rutils must exist, and is shipped to the remote host at the beginning of each execution as a temporary directory named /tmp/rset_staging_{http_port}. This is used to set the current working directory in the environment of the remote host, hence the capabilities of rset may easily be extend by accessing utilities at this location.

Most options are not set in the command line, but are modified using key-value pairs.

The interpreter to run a script fragment with. Defaults to /bin/sh, but any language may be used that is capable of reading scripts over STDIN.

Command for elevating privileges, such as doas(1) and sudo(8).

miniquark(1), rinstall(1), rsub(1), ssh_config(5), re_format(7)

July 22, 2020 OpenBSD 6.7