.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "CLUSH.CONF" 5 "2023-02-09" "1.9.1" "ClusterShell User Manual" .SH NAME clush.conf \- Configuration file for clush .SH DESCRIPTION .sp \fBclush\fP(1) obtains configuration options from the following sources in the following order: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP 1. 3 command\-line options .IP 2. 3 user configuration file (\fI$XDG_CONFIG_HOME/clustershell/clush.conf\fP) .IP 3. 3 local pip user installation (\fI$HOME/.local/etc/clustershell/clush.conf\fP) .IP 4. 3 global configuration file (\fI$CLUSTERSHELL_CFGDIR/clush.conf\fP, defaults to \fI/etc/clustershell/clush.conf\fP) .UNINDENT .UNINDENT .UNINDENT .sp For each parameter, the first obtained value will be used. .sp The configuration file has a format in the style of RFC 822 composed of one main section: .INDENT 0.0 .TP .B Main Program options definition .UNINDENT .SS [Main] .sp Configuration parameters of the \fBMain\fP section are described below. .INDENT 0.0 .TP .B fanout Size of the sliding window (fanout) of active commands for \fBclush\fP\&. This \fIfanout\fP is used to avoid too many concurrent connections and to conserve resources on the initiating hosts. In tree mode, the same \fIfanout\fP value is used on the head node and on each gateway (the \fIfanout\fP value is propagated). That is, if the \fIfanout\fP is \fB16\fP on the head node, each gateway will initiate up to \fB16\fP connections to their target nodes at the same time. .TP .B confdir Optional list of directory paths where clush should look for \fI\&.conf\fP files which define run modes that can then be activated with \fB\-\-mode\fP\&. All other clush config file settings defined here might be overridden in a run mode. Each mode section should have a name prefixed by \(dqmode:\(dq to clearly identify a section defining a mode. Duplicate modes are not allowed in those files. Configuration files that are not readable by the current user are ignored. The variable \fI$CFGDIR\fP is replaced by the path of the highest priority configuration directory found (where clush.conf resides). The default confdir value enables both system\-wide and any installed user configuration (thanks to \fI$CFGDIR\fP). Duplicate directory paths are ignored. .TP .B connect_timeout Timeout in seconds to allow a connection to establish. This parameter is passed to ssh. If set to \fI0\fP, no timeout occurs. .TP .B command_prefix Command prefix. Generally used for specific run modes, for example to implement \fBsudo\fP(8) support. .TP .B command_timeout 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 \fI0\fP, no timeout occurs. .TP .B color \fBclush\fP can use NO_COLOR, CLICOLOR and CLICOLOR_FORCE environment variables. NO_COLOR takes precedence over CLICOLOR_FORCE which takes precedence over CLICOLOR. When the option is set in configuration file environment variables are taken into account only with \fIauto\fP argument. \fBcolor\fP tells 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 \fBnever\fP, \fBalways\fP or \fBauto\fP (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. .TP .B fd_max 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 \fIfd_max\fP (soft) and system (hard) limits should be high enough to run \fBclush\fP, although their values depend on your \fIfanout\fP value. .TP .B history_size Set the maximum number of history entries saved in the GNU readline history list. Negative values imply unlimited history file size. .TP .B node_count Should \fBclush\fP display additional (node count) information in buffer header? (\fIyes\fP/\fIno\fP) .TP .B maxrc Should \fBclush\fP return the largest of command return codes? (yes/no) .TP .B password_prompt Enable password prompt and password forwarding to stdin? (yes/no) Generally used for specific run modes, for example to implement interactive \fBsudo\fP(8) support. .TP .B verbosity Set the verbosity level: \fI0\fP (quiet), \fI1\fP (default), \fI2\fP (verbose) or more (debug). .TP .B ssh_user Set the ssh user to use for remote connection (default is to not specify). .TP .B ssh_path Set the ssh binary path to use for remote connection (default is \fIssh\fP). .TP .B ssh_options Set additional options to pass to the underlying ssh command. .TP .B scp_path Set the scp binary path to use for remote copy (default is \fIscp\fP). .TP .B scp_options Set additional options to pass to the underlying scp command. If not specified, ssh_options are used instead. .TP .B rsh_path Set the rsh binary path to use for remote connection (default is \fIrsh\fP). You could easily use mrsh or krsh by simply changing this value. .TP .B rcp_path Same a rsh_path for rcp command. (Default is \fIrcp\fP) .TP .B rsh_options Set additional options to pass to the underlying rsh/rcp command. .UNINDENT .SS Run modes .sp Since version 1.9, clush has support for run modes, which are special \fBclush.conf\fP(5) settings with a given name. Two run modes are provided in example configuration files that can be copied and modified. They implement password\-based authentication with \fBsshpass\fP(1) and support of interactive \fBsudo\fP(8) with password. .sp To use a run mode with \fBclush \-\-mode\fP, install a configuration file in one of \fBclush.conf\fP(5)\(aqs \fIconfdir\fP (usually \fBclush.conf.d\fP). Only configuration files ending in \fI\&.conf\fP are scanned. If the user running \fBclush\fP(1) doesn\(aqt have read access to a configuration file, is it ignored. When \fB\-\-mode\fP is specified, you can display all available run modes for the current user by enabling debug mode (\fB\-d\fP). .SH EXAMPLES .sp Simple configuration file. .SS \fIclush.conf\fP .nf [Main] fanout: 128 connect_timeout: 15 command_timeout: 0 history_size: 100 color: auto fd_max: 10240 maxrc: no node_count: yes confdir: /etc/clustershell/clush.conf.d .fi .sp .SH FILES .INDENT 0.0 .TP .B \fI$CLUSTERSHELL_CFGDIR/clush.conf\fP Global clush configuration file. If $CLUSTERSHELL_CFGDIR is not defined, \fI/etc/clustershell/clush.conf\fP is used instead. .TP .B \fI$XDG_CONFIG_HOME/clustershell/clush.conf\fP User configuration file for clush. If $XDG_CONFIG_HOME is not defined, \fI$HOME/.config/clustershell/clush.conf\fP is used instead. .TP .B \fI$HOME/.local/etc/clustershell/clush.conf\fP Local user configuration file for clush (default installation for pip \-\-user) .TP .B \fI~/.clush.conf\fP Deprecated per\-user clush configuration file. .UNINDENT .SH HISTORY .sp As of ClusterShell version 1.3, the \fBExternal\fP section has been removed from \fIclush.conf\fP\&. External commands whose outputs were used by \fBclush\fP (\-a, \-g, \-X) are now handled by the library itself and defined in \fBgroups.conf\fP(5). .SH SEE ALSO .sp \fBclush\fP(1), \fBgroups.conf\fP(5), \fBsshpass\fP(1), \fBsudo\fP(8). .sp \fI\%http://clustershell.readthedocs.org/\fP .SH AUTHOR Stephane Thiell, .SH COPYRIGHT GNU Lesser General Public License version 2.1 or later (LGPLv2.1+) .\" Generated by docutils manpage writer. .