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. De‐
34              fault: 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  in‐
68              cluded into Minimal Salt.
69
70       --thin-extra-modules=THIN_EXTRA_MODS
71              One  or  comma-separated  list of extra Python modulesto  be in‐
72              cluded 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       --pre-flight
101              Run the ssh_pre_flight script defined in the roster.  By default
102              this  script will only run if the thin dir does not exist on the
103              target minion. This option will force the script to run  regard‐
104              less of the thin dir existing or not.
105
106   Authentication Options
107       --priv=SSH_PRIV
108              Specify the SSH private key file to be used for authentication.
109
110       --priv-passwd=SSH_PRIV_PASSWD
111              Specify the SSH private key file's passphrase if need be.
112
113       -i, --ignore-host-keys
114              By  default  ssh host keys are honored and connections  will ask
115              for approval. Use this option to disable StrictHostKeyChecking.
116
117       --no-host-keys
118              Fully ignores ssh host keys which by  default  are  honored  and
119              connections  would ask for approval. Useful if the host key of a
120              remote server has changed  and  would  still  error  with  --ig‐
121              nore-host-keys.
122
123       --user=SSH_USER
124              Set the default user to attempt to use when authenticating.
125
126       --passwd
127              Set the default password to attempt to use when authenticating.
128
129       --askpass
130              Interactively  ask  for  the  SSH password with no echo - avoids
131              password in process args and stored in history.
132
133       --key-deploy
134              Set this flag to attempt to deploy the authorized ssh  key  with
135              all  minions.  This  combined with --passwd can make initial de‐
136              ployment of keys very fast and easy.
137
138       --identities-only
139              Use the only authentication identity  files  configured  in  the
140              ssh_config files. See IdentitiesOnly flag in man ssh_config.
141
142       --sudo Run command via sudo.
143
144   Scan Roster Options
145       --scan-ports=SSH_SCAN_PORTS
146              Comma-separated list of ports to scan in the scan roster.
147
148       --scan-timeout=SSH_SCAN_TIMEOUT
149              Scanning socket timeout for the scan roster.
150
151   Logging Options
152       Logging  options  which override any settings defined on the configura‐
153       tion files.
154
155       -l LOG_LEVEL, --log-level=LOG_LEVEL
156              Console logging log level. One of all,  garbage,  trace,  debug,
157              info, warning, error, quiet. Default: warning.
158
159       --log-file=LOG_FILE
160              Log file path. Default: /var/log/salt/ssh.
161
162       --log-file-level=LOG_LEVEL_LOGFILE
163              Logfile  logging  log  level. One of all, garbage, trace, debug,
164              info, warning, error, quiet. Default: warning.
165
166   Target Selection
167       The default matching that Salt utilizes is shell-style globbing  around
168       the                   minion                   id.                  See
169       https://docs.python.org/3/library/fnmatch.html#module-fnmatch.
170
171       -E, --pcre
172              The target expression will be interpreted as a PCRE regular  ex‐
173              pression rather than a shell glob.
174
175   Output Options
176       --out  Pass  in an alternative outputter to display the return of data.
177              This outputter can be any of the available outputters:
178                 highstate, json, key, overstatestage, pprint, raw, txt, yaml,
179                 and many others.
180
181              Some  outputters  are formatted only for data returned from spe‐
182              cific functions.  If an outputter is used that does not  support
183              the  data passed into it, then Salt will fall back on the pprint
184              outputter and display the return data using  the  Python  pprint
185              standard library module.
186
187       --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
188              Print the output indented by the provided value in spaces. Nega‐
189              tive values disable indentation. Only applicable  in  outputters
190              that support indentation.
191
192       --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
193              Write the output to the specified file.
194
195       --out-file-append, --output-file-append
196              Append the output to the specified file.
197
198       --no-color
199              Disable all colored output
200
201       --force-color
202              Force colored output
203
204              NOTE:
205                 When using colored output the color codes are as follows:
206
207                 green  denotes  success,  red  denotes  failure, blue denotes
208                 changes and success and  yellow  denotes  a  expected  future
209                 change in configuration.
210
211       --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
212              Override  the  configured  state_output value for minion output.
213              One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default:
214              'none'.
215
216       --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
217              Override  the  configured state_verbose value for minion output.
218              Set to True or False. Default: none.
219
220       NOTE:
221          If using --out=json, you will probably want --static as well.  With‐
222          out  the static option, you will get a separate JSON string per min‐
223          ion which makes JSON output invalid as a whole.  This is due to  us‐
224          ing  an  iterative  outputter.  So  if you want to feed it to a JSON
225          parser, use --static as well.
226

SEE ALSO

228       salt(7) salt-master(1) salt-minion(1)
229

AUTHOR

231       Thomas S. Hatch <thatch45@gmail.com> and many others,  please  see  the
232       Authors file
233
234
235
236
2373004.2                           May 12, 2022                      SALT-SSH(1)
Impressum