2016-12-19 15:14:37 -07:00
|
|
|
.. _salt-run:
|
|
|
|
|
|
2011-07-07 22:23:26 -06:00
|
|
|
============
|
2011-07-02 19:55:06 -06:00
|
|
|
``salt-run``
|
2011-07-07 22:23:26 -06:00
|
|
|
============
|
2011-07-02 19:55:06 -06:00
|
|
|
|
|
|
|
|
Execute a Salt runner
|
|
|
|
|
|
|
|
|
|
Synopsis
|
|
|
|
|
========
|
|
|
|
|
|
2014-07-13 11:02:33 -05:00
|
|
|
.. code-block:: bash
|
2011-07-02 19:55:06 -06:00
|
|
|
|
|
|
|
|
salt-run RUNNER
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
===========
|
|
|
|
|
|
2012-01-20 17:45:38 -07:00
|
|
|
salt-run is the frontend command for executing ``Salt Runners``.
|
2011-07-02 19:55:06 -06:00
|
|
|
Salt runners are simple modules used to execute convenience functions on the
|
|
|
|
|
master
|
|
|
|
|
|
|
|
|
|
Options
|
|
|
|
|
=======
|
|
|
|
|
|
2013-08-10 14:06:53 +01:00
|
|
|
.. program:: salt-run
|
2011-07-02 19:55:06 -06:00
|
|
|
|
2013-08-10 14:19:43 +01:00
|
|
|
.. include:: _includes/common-options.rst
|
2013-08-10 14:06:53 +01:00
|
|
|
|
2013-08-10 14:45:21 +01:00
|
|
|
.. include:: _includes/timeout-option.rst
|
|
|
|
|
.. |timeout| replace:: 1
|
|
|
|
|
|
2015-04-14 17:32:56 -06:00
|
|
|
.. option:: --hard-crash
|
|
|
|
|
|
|
|
|
|
Raise any original exception rather than exiting gracefully. Default is
|
|
|
|
|
False.
|
|
|
|
|
|
2013-08-10 14:45:55 +01:00
|
|
|
.. option:: -d, --doc, --documentation
|
|
|
|
|
|
2014-12-10 19:37:07 -08:00
|
|
|
Display documentation for runners, pass a module or a runner to see
|
2013-08-10 14:45:55 +01:00
|
|
|
documentation on only that module/runner.
|
|
|
|
|
|
2013-08-10 14:06:53 +01:00
|
|
|
.. include:: _includes/logging-options.rst
|
|
|
|
|
.. |logfile| replace:: /var/log/salt/master
|
|
|
|
|
.. |loglevel| replace:: ``warning``
|
|
|
|
|
|
|
|
|
|
|
2012-05-11 03:40:39 +05:30
|
|
|
See also
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
:manpage:`salt(1)`
|
|
|
|
|
:manpage:`salt-master(1)`
|
2023-02-06 19:32:11 +00:00
|
|
|
:manpage:`salt-minion(1)`
|
