1SALT-SSH(1)                          Salt                          SALT-SSH(1)
2
3
4

NAME

6       salt-ssh - salt-ssh Documentation
7

SYNOPSIS

9          salt-ssh '*' [ options ] sys.doc
10
11          salt-ssh -E '.*' [ options ] sys.doc cmd
12

DESCRIPTION

14       Salt  SSH  allows  for  salt routines to be executed using only SSH for
15       transport
16

OPTIONS

18       --version
19              Print the version of Salt that is running.
20
21       --versions-report
22              Show program's dependencies and version number, and then exit
23
24       -h, --help
25              Show the help message and exit
26
27       -c CONFIG_DIR, --config-dir=CONFIG_dir
28              The location of the Salt configuration directory. This directory
29              contains  the  configuration  files for Salt master and minions.
30              The default location on most systems is /etc/salt.
31
32       --hard-crash
33              Raise any original exception  rather  than  exiting  gracefully.
34              Default: False.
35
36       -r, --raw, --raw-shell
37              Execute a raw shell command.
38
39       --roster
40              Define  which  roster  system to use, this defines if a database
41              backend, scanner, or custom roster system is  used.  Default  is
42              the flat file roster.
43
44       --roster-file
45              Define an alternative location for the default roster file loca‐
46              tion. The default roster file is called roster and is  found  in
47              the same directory as the master config file.
48
49              New in version 2014.1.0.
50
51
52       --refresh, --refresh-cache
53              Force  a  refresh  of the master side data cache of the target's
54              data. This is needed if a target's grains have been changed  and
55              the auto refresh timeframe has not been reached.
56
57       --max-procs
58              Set  the  number of concurrent minions to communicate with. This
59              value defines how many processes are opened up at a time to man‐
60              age  connections, the more running process the faster communica‐
61              tion should be, default is 25.
62
63       --extra-filerefs=EXTRA_FILEREFS
64              Pass in extra files to include in the state tarball.
65
66       --min-extra-modules=MIN_EXTRA_MODS
67              One  or  comma-separated  list  of  extra  Python  modulesto  be
68              included into Minimal Salt.
69
70       --thin-extra-modules=THIN_EXTRA_MODS
71              One  or  comma-separated  list  of  extra  Python  modulesto  be
72              included into Thin Salt.
73
74       -v, --verbose
75              Turn on command verbosity, display jid.
76
77       -s, --static
78              Return the data from minions as a group after they all return.
79
80       -w, --wipe
81              Remove the deployment of the salt files when done executing.
82
83       -W, --rand-thin-dir
84              Select a random temp dir to deploy on the remote system. The dir
85              will be cleaned after the execution.
86
87       -t, --regen-thin, --thin
88              Trigger  a  thin tarball regeneration. This is needed if  custom
89              grains/modules/states have been added or updated.
90
91       --python2-bin=PYTHON2_BIN
92              Path to a python2 binary which has salt installed.
93
94       --python3-bin=PYTHON3_BIN
95              Path to a python3 binary which has salt installed.
96
97       --jid=JID
98              Pass a JID to be used instead of generating one.
99
100   Authentication Options
101       --priv=SSH_PRIV
102              Specify the SSH private key file to be used for authentication.
103
104       --priv-passwd=SSH_PRIV_PASSWD
105              Specify the SSH private key file's passphrase if need be.
106
107       -i, --ignore-host-keys
108              By default ssh host keys are honored and connections   will  ask
109              for approval. Use this option to disable StrictHostKeyChecking.
110
111       --no-host-keys
112              Fully  ignores  ssh  host  keys which by default are honored and
113              connections would ask for approval. Useful if the host key of  a
114              remote   server   has   changed   and  would  still  error  with
115              --ignore-host-keys.
116
117       --user=SSH_USER
118              Set the default user to attempt to use when authenticating.
119
120       --passwd
121              Set the default password to attempt to use when authenticating.
122
123       --askpass
124              Interactively ask for the SSH password with  no  echo  -  avoids
125              password in process args and stored in history.
126
127       --key-deploy
128              Set  this  flag to attempt to deploy the authorized ssh key with
129              all minions.  This  combined  with  --passwd  can  make  initial
130              deployment of keys very fast and easy.
131
132       --identities-only
133              Use  the  only  authentication  identity files configured in the
134              ssh_config files. See IdentitiesOnly flag in man ssh_config.
135
136       --sudo Run command via sudo.
137
138   Scan Roster Options
139       --scan-ports=SSH_SCAN_PORTS
140              Comma-separated list of ports to scan in the scan roster.
141
142       --scan-timeout=SSH_SCAN_TIMEOUT
143              Scanning socket timeout for the scan roster.
144
145   Logging Options
146       Logging options which override any settings defined on  the  configura‐
147       tion files.
148
149       -l LOG_LEVEL, --log-level=LOG_LEVEL
150              Console  logging  log  level. One of all, garbage, trace, debug,
151              info, warning, error, quiet. Default: warning.
152
153       --log-file=LOG_FILE
154              Log file path. Default: /var/log/salt/ssh.
155
156       --log-file-level=LOG_LEVEL_LOGFILE
157              Logfile logging log level. One of all,  garbage,  trace,  debug,
158              info, warning, error, quiet. Default: warning.
159
160   Target Selection
161       The  default matching that Salt utilizes is shell-style globbing around
162       the                  minion                   id.                   See
163       https://docs.python.org/2/library/fnmatch.html#module-fnmatch.
164
165       -E, --pcre
166              The  target  expression  will  be  interpreted as a PCRE regular
167              expression rather than a shell glob.
168
169   Output Options
170       --out  Pass in an alternative outputter to display the return of  data.
171              This outputter can be any of the available outputters:
172                 grains,  highstate,  json,  key, overstatestage, pprint, raw,
173                 txt, yaml
174
175              Some outputters are formatted only for data returned  from  spe‐
176              cific  functions;  for  instance,  the grains outputter will not
177              work for non-grains data.
178
179              If an outputter is used that does not support  the  data  passed
180              into  it,  then  Salt will fall back on the pprint outputter and
181              display the return data using the Python pprint standard library
182              module.
183
184              NOTE:
185                 If using --out=json, you will probably want --static as well.
186                 Without the static option,  you  will  get  a  separate  JSON
187                 string per minion which makes JSON output invalid as a whole.
188                 This is due to using an iterative outputter. So if  you  want
189                 to feed it to a JSON parser, use --static as well.
190
191       --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
192              Print the output indented by the provided value in spaces. Nega‐
193              tive values disable indentation. Only applicable  in  outputters
194              that support indentation.
195
196       --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
197              Write the output to the specified file.
198
199       --out-file-append, --output-file-append
200              Append the output to the specified file.
201
202       --no-color
203              Disable all colored output
204
205       --force-color
206              Force colored output
207
208              NOTE:
209                 When using colored output the color codes are as follows:
210
211                 green  denotes  success,  red  denotes  failure, blue denotes
212                 changes and success and  yellow  denotes  a  expected  future
213                 change in configuration.
214
215       --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
216              Override  the  configured  state_output value for minion output.
217              One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default:
218              'none'.
219
220       --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
221              Override  the  configured state_verbose value for minion output.
222              Set to True or False. Default: none.
223

SEE ALSO

225       salt(7) salt-master(1) salt-minion(1)
226

AUTHOR

228       Thomas S. Hatch <thatch45@gmail.com> and many others,  please  see  the
229       Authors file
230
231
232
233
2342019.2.0                         Jan 08, 2019                      SALT-SSH(1)
Impressum