clush.conf(5)

1CLUSH.CONF(5)              ClusterShell User Manual              CLUSH.CONF(5)
2
3
4

NAME

6       clush.conf - Configuration file for clush
7

DESCRIPTION

9       clush(1)  obtains  configuration  options from the following sources in
10       the following order:
11
12          1. command-line options
13
14          2. user configuration file (~/.clush.conf)
15
16          3. system-wide configuration file (/etc/clustershell/clush.conf)
17
18       For each parameter, the first obtained value will be used.
19
20       The configuration file has a format in the style of RFC 822 composed of
21       one main section:
22
23       Main   Program options definition
24
25   [Main]
26       Configuration parameters of the Main section are described below.
27
28       fanout Size of the sliding window of ssh connectors.
29
30       connect_timeout
31              Timeout  in  seconds  to  allow  a connection to establish. This
32              parameter is passed to ssh. If set to 0, no timeout occurs.
33
34       command_timeout
35              Timeout in seconds to allow a command to complete since the con‐
36              nection  has  been established. This parameter is passed to ssh.
37              In addition, the ClusterShell library ensures that any  commands
38              complete  in less than ( connect_timeout + command_timeout ). If
39              set to 0, no timeout occurs.
40
41       color  Whether to use ANSI colors to  surround  node  or  nodeset  pre‐
42              fix/header with escape sequences to display them in color on the
43              terminal. Valid arguments are never, always or auto  (which  use
44              color  if standard output/error refer to a terminal). Colors are
45              set to [34m (blue foreground text)  for  stdout  and  [31m  (red
46              foreground text) for stderr, and cannot be modified.
47
48       fd_max Maximum  number  of  open  file  descriptors permitted per clush
49              process (soft resource limit for open  files).  This  limit  can
50              never exceed the system (hard) limit. The fd_max (soft) and sys‐
51              tem (hard) limits should be high enough to run  clush,  although
52              their values depend on your fanout value.
53
54       history_size
55              Set the maximum number of history entries saved in the GNU read‐
56              line history list. Negative values imply unlimited history  file
57              size.
58
59       node_count
60              Should clush display additional (node count) information in buf‐
61              fer header? (yes/no)
62
63       verbosity
64              Set the verbosity level: 0 (quiet), 1 (default), 2 (verbose)  or
65              more (debug).
66
67       ssh_user
68              Set the ssh user to use for remote connection (default is to not
69              specify).
70
71       ssh_path
72              Set the ssh binary path to use for remote connection (default is
73              /usr/bin/ssh).
74
75       ssh_options
76              Set additional options to pass to the underlying ssh command.
77

EXAMPLES

79       Simple configuration file.
80
81   clush.conf
82       [Main]
83       fanout: 128
84       connect_timeout: 15
85       command_timeout: 0
86       history_size: 100
87       color: auto
88       fd_max: 10240
89       node_count: yes
90
91
92

FILES

94       ~/.clush.conf
95
96              This is the per-user configuration file.
97
98       /etc/clustershell/clush.conf
99
100              System-wide configuration file.
101

HISTORY

103       As  of  ClusterShell version 1.3, the External section has been removed
104       from clush.conf.  External commands whose outputs were  used  by  clush
105       (-a,  -g,  -X)  are  now  handled  by the library itself and defined in
106       groups.conf(5).
107

AUTHOR

114       Stephane Thiell, CEA DAM  <stephane.thiell@cea.fr>
115

COPYRIGHT

117       CeCILL-C V1
118
119
120
121
1221.5.1                             2011-06-09                     CLUSH.CONF(5)