clush.conf - Configuration file for clush
(1) obtains configuration options from the following sources in the
- command-line options
- user configuration file
- local pip user installation
- system-wide configuration file
For each parameter, the first obtained value will be used.
The configuration file has a format in the style of RFC 822 composed of one main
- Program options definition
Configuration parameters of the Main
section are described below.
- Size of the sliding window (fanout) of active commands for
clush. This fanout is used to avoid too many concurrent
connections and to conserve resources on the initiating hosts. In tree
mode, the same fanout value is used on the head node and on each
gateway (the fanout value is propagated). That is, if the
fanout is 16 on the head node, each gateway will initate up
to 16 connections to their target nodes at the same time.
- Timeout in seconds to allow a connection to establish. This
parameter is passed to ssh. If set to 0, no timeout occurs.
- Timeout in seconds to allow a command to complete since the
connection has been established. This parameter is passed to ssh. In
addition, the ClusterShell library ensures that any commands complete in
less than ( connect_timeout + command_timeout ). If set to 0, no
- Whether to use ANSI colors to surround node or nodeset
prefix/header with escape sequences to display them in color on the
terminal. Valid arguments are never, always or auto
(which use color if standard output/error refer to a terminal). Colors are
set to [34m (blue foreground text) for stdout and [31m (red foreground
text) for stderr, and cannot be modified.
- Maximum number of open file descriptors permitted per clush
process (soft resource limit for open files). This limit can never exceed
the system (hard) limit. The fd_max (soft) and system (hard) limits
should be high enough to run clush, although their values depend on
your fanout value.
- Set the maximum number of history entries saved in the GNU
readline history list. Negative values imply unlimited history file
- Should clush display additional (node count)
information in buffer header? ( yes/no)
- Set the verbosity level: 0 (quiet), 1
(default), 2 (verbose) or more (debug).
- Set the ssh user to use for remote connection (default is
to not specify).
- Set the ssh binary path to use for remote connection
(default is ssh).
- Set additional options to pass to the underlying ssh
- Set the scp binary path to use for remote copy (default is
- Set additional options to pass to the underlying scp
command. If not specified, ssh_options are used instead.
- Set the rsh binary path to use for remote connection
(default is rsh). You could easily use mrsh or krsh by simply
changing this value.
- Same a rsh_path for rcp command. (Default is
- Set additional options to pass to the underlying rsh/rcp
Simple configuration file.
- System-wide clush configuration file.
- User configuration file for clush. If $XDG_CONFIG_HOME is
not defined, $HOME/.config/clustershell/clush.conf is used
- Local user configuration file for clush (default
installation for pip --user)
- Deprecated per-user clush configuration file.
As of ClusterShell version 1.3, the External
section has been removed
. External commands whose outputs were used by
(-a, -g, -X) are now handled by the library itself and defined in
Stephane Thiell, <firstname.lastname@example.org>
GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)