salt/doc/ref/cli/salt-ssh.rst

66 lines
1.5 KiB
ReStructuredText

============
``salt-ssh``
============
Synopsis
========
salt-ssh '*' [ options ] sys.doc
salt-ssh -E '.*' [ options ] sys.doc cmd
Description
===========
Salt ssh allows for salt routines to be executed using only ssh for transport
Options
=======
.. program:: salt
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options
.. option:: -t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the Salt minions. The
timeout number specifies how long the command line client will wait to
query the minions and check on running jobs.
.. option:: --version
Print the version of Salt that is running.
.. option:: --versions-report
Show program's dependencies version number and exit
.. option:: -E, --pcre
The target expression will be interpreted as a pcre regular expression
rather than a shell glob.
.. option:: --return
Chose an alternative returner to call on the minion, if an alternative
returner is used then the return will not come back to the command line
but will be sent to the specified return system.
.. option:: -c CONFIG_DIR, --config-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.. include:: _includes/output-options.rst
See also
========
:manpage:`salt(7)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`