saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Link "stateful" kwargs to definition of what "stateful" means for cmd state.

Browse source 
Fixes #29154
This commit is contained in:
rallytime 2015-12-15 14:21:58 -07:00
parent 7c50533d3f
commit 5c045a86af
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
salt/states/cmd.py
View file

@ -55,6 +55,11 @@ This means that if a ``cmd`` state is watched by another state then the
state that's watching will always be executed due to the `changed` state in
the ``cmd`` state.
.. _stateful-argument:
Using the "Stateful" Argument
-----------------------------
Many state functions in this module now also accept a ``stateful`` argument.
If ``stateful`` is specified to be true then it is assumed that the command
or script will determine its own state and communicate it back by following
@ -470,7 +475,7 @@ def wait(name,
stateful
The command being executed is expected to return data about executing
a state
a state. For more information, see the :ref:`stateful-argument` section.
creates
Only run if the file specified by ``creates`` does not exist.
@ -599,7 +604,7 @@ def wait_script(name,
stateful
The command being executed is expected to return data about executing
a state
a state. For more information, see the :ref:`stateful-argument` section.
use_vt
Use VT utils (saltstack) to stream the command output more
@ -708,7 +713,7 @@ def run(name,
stateful
The command being executed is expected to return data about executing
a state
a state. For more information, see the :ref:`stateful-argument` section.
umask
The umask (in octal) to use when running the command.
@ -951,7 +956,7 @@ def script(name,
stateful
The command being executed is expected to return data about executing
a state
a state. For more information, see the :ref:`stateful-argument` section.
timeout
If the command has not terminated after timeout seconds, send the