Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated CLI docs for salt-ssh #44322

Merged
merged 2 commits into from Oct 30, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
103 changes: 93 additions & 10 deletions doc/ref/cli/salt-ssh.rst
Expand Up @@ -19,13 +19,17 @@ Salt SSH allows for salt routines to be executed using only SSH for transport
Options
=======

.. option:: -r, --raw, --raw-shell
.. program:: salt-ssh

Execute a raw shell command.
.. include:: _includes/common-options.rst

.. option:: --priv
.. option:: --hard-crash

Specify the SSH private key file to be used for authentication.
Raise any original exception rather than exiting gracefully. Default: False.

.. option:: -r, --raw, --raw-shell

Execute a raw shell command.

.. option:: --roster

Expand Down Expand Up @@ -53,38 +57,117 @@ Options
the more running process the faster communication should be, default
is 25.

.. option:: --extra-filerefs=EXTRA_FILEREFS

Pass in extra files to include in the state tarball.

.. option:: --min-extra-modules=MIN_EXTRA_MODS

One or comma-separated list of extra Python modulesto be included
into Minimal Salt.

.. option:: --thin-extra-modules=THIN_EXTRA_MODS

One or comma-separated list of extra Python modulesto be included
into Thin Salt.

.. option:: -v, --verbose

Turn on command verbosity, display jid.

.. option:: -s, --static

Return the data from minions as a group after they all return.

.. option:: -w, --wipe

Remove the deployment of the salt files when done executing.

.. option:: -W, --rand-thin-dir

Select a random temp dir to deploy on the remote system. The dir
will be cleaned after the execution.

.. option:: -t, --regen-thin, --thin

Trigger a thin tarball regeneration. This is needed if custom
grains/modules/states have been added or updated.

.. option:: --python2-bin=PYTHON2_BIN

Path to a python2 binary which has salt installed.

.. option:: --python3-bin=PYTHON3_BIN

Path to a python3 binary which has salt installed.

.. option:: --jid=JID

Pass a JID to be used instead of generating one.

Authentication Options
----------------------

.. option:: --priv=SSH_PRIV

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

.. option:: -i, --ignore-host-keys

Disables StrictHostKeyChecking to relax acceptance of new and unknown
host keys.
By default ssh host keys are honored and connections will ask for
approval. Use this option to disable StrictHostKeyChecking.

.. option:: --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
would ask for approval. Useful if the host key of a remote server has
changed and would still error with --ignore-host-keys.

.. option:: --user=SSH_USER

Set the default user to attempt to use when authenticating.

.. option:: --passwd

Set the default password to attempt to use when authenticating.

.. option:: --askpass

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

.. option:: --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.

.. program:: salt
.. option:: --identities-only

.. include:: _includes/common-options.rst
Use the only authentication identity files configured in the ssh_config
files. See IdentitiesOnly flag in man ssh_config.

.. include:: _includes/target-selection-ssh.rst
.. option:: --sudo

Run command via sudo.

Scan Roster Options
-------------------

.. option:: --scan-ports=SSH_SCAN_PORTS

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

.. option:: --scan-timeout=SSH_SCAN_TIMEOUT

Scanning socket timeout for the scan roster.

.. include:: _includes/logging-options.rst
.. |logfile| replace:: /var/log/salt/ssh
.. |loglevel| replace:: ``warning``

.. include:: _includes/target-selection-ssh.rst

.. include:: _includes/output-options.rst


Expand Down