valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 01:18:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #2146 from f0rk/f0rk/optional_arguments_docs

Browse Source 
Generic keyword argument usage documentation
This commit is contained in:
Thomas S Hatch 2012-10-01 18:16:02 -07:00
commit f10cf33b83
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/ref/cli/index.rst
View File

@ -135,6 +135,22 @@ Calling the Function
The function to call on the specified target is placed after the target
specification.
.. versionadded:: 0.9.8
Functions may also accept arguments, space-delimited:
.. code-block:: bash
salt '*' cmd.exec_code python 'import sys; print sys.version'
Optional, keyword arguments are also supported:
.. code-block:: bash
salt '*' pip.install salt timeout=5 upgrade=True
They are always in the form of ``kwarg=argument``.
Finding available minion functions
``````````````````````````````````

6
doc/topics/tutorials/modules.rst
View File

@ -65,3 +65,9 @@ arguments
Space-delimited arguments to the function::
salt '*' cmd.exec_code python 'import sys; print sys.version'
Optional, keyword arguments are also supported::
salt '*' pip.install salt timeout=5 upgrade=True
They are always in the form of ``kwarg=argument``.