valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 09:23:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
553ecaca25
salt/doc/ref/cli/salt-ssh.rst

89 lines
2.1 KiB
ReStructuredText
Raw Normal View History

Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
============
``salt-ssh``
============
Synopsis
========
Docs cleanup Fixes double-colons by making them code-block directives, so they do not erroneously show up as "PYTHON" blocks. Also corrects a few instances of 2nd person pronoun usage.
2014-07-13 16:02:33 +00:00
.. code-block:: bash
Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
salt-ssh '*' [ options ] sys.doc
salt-ssh -E '.*' [ options ] sys.doc cmd
Description
===========
Upcase SSH in Salt SSH.
2013-11-23 23:18:40 +00:00
Salt SSH allows for salt routines to be executed using only SSH for transport
Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
Options
=======
Updated the salt-ssh.rst to add the new options that are available via the command line. Modified the ssh index.rst to include a link to the salt-ssh cli commands page. Updated parsers.py to fix the default value that is present in the documentation from 5 to 25 (as 25 is the actual default). Updated roster.rst to note that the default file location is /etc/salt/roster since it was absent, and might be confusing if you head to the roster documentation before reading the rest of the salt-ssh documentation.
2013-09-29 05:16:13 +00:00
.. option:: -r, --raw, --raw-shell
Execute a raw shell command.
Add two options in the salt-ssh documentation
2014-02-05 14:32:16 +00:00
.. option:: --priv
Specify the SSH private key file to be used for authentication.
Correct salt-ssh docs inaccuracy
2014-01-22 17:18:09 +00:00
.. option:: --roster
Updated the salt-ssh.rst to add the new options that are available via the command line. Modified the ssh index.rst to include a link to the salt-ssh cli commands page. Updated parsers.py to fix the default value that is present in the documentation from 5 to 25 (as 25 is the actual default). Updated roster.rst to note that the default file location is /etc/salt/roster since it was absent, and might be confusing if you head to the roster documentation before reading the rest of the salt-ssh documentation.
2013-09-29 05:16:13 +00:00
Define which roster system to use, this defines if a database backend,
scanner, or custom roster system is used. Default is the flat file roster.
Add --roster-file online docs option (new in 2014.1.0)
2014-01-22 17:24:29 +00:00
.. option:: --roster-file
Define an alternative location for the default roster file location. The
default roster file is called ``roster`` and is found in the same directory
as the master config file.
Removed the term "Hydrogen" from versionadded notation
2014-07-01 21:01:12 +00:00
.. versionadded:: 2014.1.0
Add --roster-file online docs option (new in 2014.1.0)
2014-01-22 17:24:29 +00:00
Updated the salt-ssh.rst to add the new options that are available via the command line. Modified the ssh index.rst to include a link to the salt-ssh cli commands page. Updated parsers.py to fix the default value that is present in the documentation from 5 to 25 (as 25 is the actual default). Updated roster.rst to note that the default file location is /etc/salt/roster since it was absent, and might be confusing if you head to the roster documentation before reading the rest of the salt-ssh documentation.
2013-09-29 05:16:13 +00:00
.. option:: --refresh, --refresh-cache
Force a refresh of the master side data cache of the target's data. This
is needed if a target's grains have been changed and the auto refresh
timeframe has not been reached.
.. option:: --max-procs
Set the number of concurrent minions to communicate with. This value
defines how many processes are opened up at a time to manage connections,
the more running process the faster communication should be, default
is 25.
Whitespace cleanup
2014-12-11 03:37:07 +00:00
Add two options in the salt-ssh documentation
2014-02-05 14:32:16 +00:00
.. option:: -i, --ignore-host-keys
Ignore the ssh host keys which by default are honored and connections
would ask for approval.
Updated the salt-ssh.rst to add the new options that are available via the command line. Modified the ssh index.rst to include a link to the salt-ssh cli commands page. Updated parsers.py to fix the default value that is present in the documentation from 5 to 25 (as 25 is the actual default). Updated roster.rst to note that the default file location is /etc/salt/roster since it was absent, and might be confusing if you head to the roster documentation before reading the rest of the salt-ssh documentation.
2013-09-29 05:16:13 +00:00
.. option:: --passwd
fix doc typo
2014-02-03 10:19:11 +00:00
Set the default password to attempt to use when authenticating.
Updated the salt-ssh.rst to add the new options that are available via the command line. Modified the ssh index.rst to include a link to the salt-ssh cli commands page. Updated parsers.py to fix the default value that is present in the documentation from 5 to 25 (as 25 is the actual default). Updated roster.rst to note that the default file location is /etc/salt/roster since it was absent, and might be confusing if you head to the roster documentation before reading the rest of the salt-ssh documentation.
2013-09-29 05:16:13 +00:00
.. 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.
Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
.. program:: salt
General options are now on a common document.
2013-08-10 13:19:43 +00:00
.. include:: _includes/common-options.rst
Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
Target selection documentation now reside on it's own, common, document.
2013-08-10 09:27:31 +00:00
.. include:: _includes/target-selection.rst
Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
Logging options is now on it's own, common, document. * Added logging options for all the CLI tools that supported it and were lacking them.
2013-08-10 13:06:53 +00:00
.. include:: _includes/logging-options.rst
.. |logfile| replace:: /var/log/salt/ssh
.. |loglevel| replace:: ``warning``
General options are now on a common document.
2013-08-10 13:19:43 +00:00
CLI Output options now reside on it's own, common, document.
2013-08-10 09:06:17 +00:00
.. include:: _includes/output-options.rst
Start on salt-ssh manpage
2013-07-07 03:33:46 +00:00
See also
========
:manpage:`salt(7)`
:manpage:`salt-master(1)`
Whitespace cleanup
2014-12-11 03:37:07 +00:00
:manpage:`salt-minion(1)`
Reference in New Issue Copy Permalink