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

76 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2011-05-23 06:58:49 +00:00
=============
``salt-call``
=============
Synopsis
========
::
salt-call [options]
Description
===========
The salt-call command is used to run module functions locally on a minion
instead of executing them from the master.
2011-05-23 06:58:49 +00:00
Options
=======
.. program:: salt-call
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options
.. option:: -g, --grains
2012-05-23 04:43:12 +00:00
Return the information generated by the Salt grains
2011-05-23 06:58:49 +00:00
.. option:: -m MODULE_DIRS, --module-dirs=MODULE_DIRS
Specify an additional directories to pull modules from, multiple
directories can be delimited by commas
.. option:: -d, --doc
2012-05-23 04:43:12 +00:00
Return the documentation for the specified module or for all modules if
2011-05-23 06:58:49 +00:00
none are specified
2012-03-19 18:47:05 +00:00
.. option:: -l LOG_LEVEL, --log-level=LOG_LEVEL
Console log level. One of ``info``, ``none``, ``garbage``,
``trace``, ``warning``, ``error``, ``debug``. For the logfile
settings see the config file. Default: ``info``.
.. option:: --raw-out
2012-05-23 04:43:12 +00:00
Print the output from the salt command in raw Python
2012-03-19 18:47:05 +00:00
form, this is suitable for re-reading the output into
2012-05-23 04:43:12 +00:00
an executing Python script with eval.
2012-03-19 18:47:05 +00:00
.. option:: --text-out
Print the output from the salt command in the same
form the shell would.
.. option:: --yaml-out
2012-05-23 04:43:12 +00:00
Print the output from the salt command in YAML.
2012-03-19 18:47:05 +00:00
.. option:: --json-out
2012-05-23 04:43:12 +00:00
Print the output from the salt command in JSON.
2012-03-19 18:47:05 +00:00
.. option:: --no-color
Disable all colored output
2012-05-10 22:10:39 +00:00
See also
========
:manpage:`salt(1)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`