salt-ssh¶

Authentication Options¶

--priv=SSH_PRIV¶

Specify the SSH private key file to be used for authentication.

--priv-passwd=SSH_PRIV_PASSWD¶

Specify the SSH private key file's passphrase if need be.

-i, --ignore-host-keys¶

By default ssh host keys are honored and connections will ask for approval. Use this option to disable StrictHostKeyChecking.

--no-host-keys¶

Fully ignores ssh host keys which by default are honored and connections would ask for approval. Useful if the host key of a remote server has changed and would still error with --ignore-host-keys.

--user=SSH_USER¶

Set the default user to attempt to use when authenticating.

--passwd¶

Set the default password to attempt to use when authenticating.

--askpass¶

Interactively ask for the SSH password with no echo - avoids password in process args and stored in history.

--key-deploy¶

Set this flag to attempt to deploy the authorized ssh key with all minions. This combined with --passwd can make initial deployment of keys very fast and easy.

--identities-only¶

Use the only authentication identity files configured in the ssh_config files. See IdentitiesOnly flag in man ssh_config.

--sudo¶

Run command via sudo.

Scan Roster Options¶

--scan-ports=SSH_SCAN_PORTS¶

Comma-separated list of ports to scan in the scan roster.

--scan-timeout=SSH_SCAN_TIMEOUT¶

Scanning socket timeout for the scan roster.

Logging Options¶

Logging options which override any settings defined on the configuration files.

-l LOG_LEVEL, --log-level=LOG_LEVEL¶

Console logging log level. One of all, garbage, trace, debug, info, warning, error, quiet. Default: warning.

--log-file=LOG_FILE¶

Log file path. Default: /var/log/salt/ssh.

--log-file-level=LOG_LEVEL_LOGFILE¶

Logfile logging log level. One of all, garbage, trace, debug, info, warning, error, quiet. Default: warning.

Target Selection¶

The default matching that Salt utilizes is shell-style globbing around the minion id. See https://docs.python.org/3/library/fnmatch.html#module-fnmatch.

-E, --pcre¶

The target expression will be interpreted as a PCRE regular expression rather than a shell glob.

Output Options¶

--out¶

Pass in an alternative outputter to display the return of data. This outputter can be any of the available outputters:

highstate, json, key, overstatestage, pprint, raw, txt, yaml, and many others.

Some outputters are formatted only for data returned from specific functions. If an outputter is used that does not support the data passed into it, then Salt will fall back on the pprint outputter and display the return data using the Python pprint standard library module.

--out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT¶

Print the output indented by the provided value in spaces. Negative values disable indentation. Only applicable in outputters that support indentation.

--out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE¶

Write the output to the specified file.

--out-file-append, --output-file-append¶

Append the output to the specified file.

--no-color¶

Disable all colored output

--force-color¶

Force colored output

Note

When using colored output the color codes are as follows:

green denotes success, red denotes failure, blue denotes changes and success and yellow denotes a expected future change in configuration.

--state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT¶

Override the configured state_output value for minion output. One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default: 'none'.

--state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE¶

Override the configured state_verbose value for minion output. Set to True or False. Default: none.