| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- .. _salt-run:
- ============
- ``salt-run``
- ============
- Execute a Salt runner
- Synopsis
- ========
- .. code-block:: bash
- salt-run RUNNER
- Description
- ===========
- salt-run is the frontend command for executing ``Salt Runners``.
- Salt runners are simple modules used to execute convenience functions on the
- master
- Options
- =======
- .. program:: salt-run
- .. include:: _includes/common-options.rst
- .. include:: _includes/timeout-option.rst
- .. |timeout| replace:: 1
- .. option:: --hard-crash
- Raise any original exception rather than exiting gracefully. Default is
- False.
- .. option:: -d, --doc, --documentation
- Display documentation for runners, pass a module or a runner to see
- documentation on only that module/runner.
- .. include:: _includes/logging-options.rst
- .. |logfile| replace:: /var/log/salt/master
- .. |loglevel| replace:: ``warning``
- See also
- ========
- :manpage:`salt(1)`
- :manpage:`salt-master(1)`
- :manpage:`salt-minion(1)`
|
