1SALT-SSH(1) Salt SALT-SSH(1)
2
6 salt-ssh - salt-ssh Documentation
7
9 salt-ssh '*' [ options ] sys.doc
10 salt-ssh -E '.*' [ options ] sys.doc cmd
12
14 Salt SSH allows for salt routines to be executed using only SSH for
15 transport
16
18 --version
19 Print the version of Salt that is running.
20 --versions-report
22 Show program's dependencies and version number, and then exit
23 -h, --help
25 Show the help message and exit
26 -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 --hard-crash
33 Raise any original exception rather than exiting gracefully.
34 Default: False.
35 -r, --raw, --raw-shell
37 Execute a raw shell command.
38 --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 --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 New in version 2014.1.0.
50 --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 --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 --extra-filerefs=EXTRA_FILEREFS
64 Pass in extra files to include in the state tarball.
65 --min-extra-modules=MIN_EXTRA_MODS
67 One or comma-separated list of extra Python modulesto be
68 included into Minimal Salt.
69 --thin-extra-modules=THIN_EXTRA_MODS
71 One or comma-separated list of extra Python modulesto be
72 included into Thin Salt.
73 -v, --verbose
75 Turn on command verbosity, display jid.
76 -s, --static
78 Return the data from minions as a group after they all return.
79 -w, --wipe
81 Remove the deployment of the salt files when done executing.
82 -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 -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 --python2-bin=PYTHON2_BIN
92 Path to a python2 binary which has salt installed.
93 --python3-bin=PYTHON3_BIN
95 Path to a python3 binary which has salt installed.
96 --jid=JID
98 Pass a JID to be used instead of generating one.
99 Authentication Options
101 --priv=SSH_PRIV
102 Specify the SSH private key file to be used for authentication.
103 --priv-passwd=SSH_PRIV_PASSWD
105 Specify the SSH private key file's passphrase if need be.
106 -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 --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 --user=SSH_USER
118 Set the default user to attempt to use when authenticating.
119 --passwd
121 Set the default password to attempt to use when authenticating.
122 --askpass
124 Interactively ask for the SSH password with no echo - avoids
125 password in process args and stored in history.
126 --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 --identities-only
133 Use the only authentication identity files configured in the
134 ssh_config files. See IdentitiesOnly flag in man ssh_config.
135 --sudo Run command via sudo.
137 Scan Roster Options
139 --scan-ports=SSH_SCAN_PORTS
140 Comma-separated list of ports to scan in the scan roster.
141 --scan-timeout=SSH_SCAN_TIMEOUT
143 Scanning socket timeout for the scan roster.
144 Logging Options
146 Logging options which override any settings defined on the configura‐
147 tion files.
148 -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 --log-file=LOG_FILE
154 Log file path. Default: /var/log/salt/ssh.
155 --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 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 -E, --pcre
166 The target expression will be interpreted as a PCRE regular
167 expression rather than a shell glob.
168 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 highstate, json, key, overstatestage, pprint, raw, txt, yaml,
173 and many others.
174 Some outputters are formatted only for data returned from spe‐
176 cific functions. If an outputter is used that does not support
177 the data passed into it, then Salt will fall back on the pprint
178 outputter and display the return data using the Python pprint
179 standard library module.
180 --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
182 Print the output indented by the provided value in spaces. Nega‐
183 tive values disable indentation. Only applicable in outputters
184 that support indentation.
185 --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
187 Write the output to the specified file.
188 --out-file-append, --output-file-append
190 Append the output to the specified file.
191 --no-color
193 Disable all colored output
194 --force-color
196 Force colored output
197 NOTE:
199 When using colored output the color codes are as follows:
200 green denotes success, red denotes failure, blue denotes
202 changes and success and yellow denotes a expected future
203 change in configuration.
204 --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
206 Override the configured state_output value for minion output.
207 One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default:
208 'none'.
209 --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
211 Override the configured state_verbose value for minion output.
212 Set to True or False. Default: none.
213 NOTE:
215 If using --out=json, you will probably want --static as well. With‐
216 out the static option, you will get a separate JSON string per min‐
217 ion which makes JSON output invalid as a whole. This is due to
218 using an iterative outputter. So if you want to feed it to a JSON
219 parser, use --static as well.
220
222 salt(7) salt-master(1) salt-minion(1)
223
225 Thomas S. Hatch <thatch45@gmail.com> and many others, please see the
226 Authors file
2273000.2 Apr 14, 2020 SALT-SSH(1)