valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 17:09:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #12748 from jaloren/develop

Browse Source 
updated documentation for salt.states.cmd concerning exit code handling.
This commit is contained in:
Thomas S Hatch 2014-05-13 15:31:15 -06:00
commit 17e47d5aba
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
salt/states/cmd.py
View File

@ -37,7 +37,18 @@ touch /tmp/foo if it does not exist.
The ``creates`` option will be supported starting with the feature release
codenamed Helium
Note that when executing a command or script, the state (i.e., changed or not)
Salt determines whether the ``cmd`` state is successfully enforced based on the exit
code returned by the command. If the command returns a zero exit code, then salt
determines that the state was successfully enforced. If the script returns a non-zero
exit code, then salt determines that it failed to successfully enforce the state.
If a command returns a non-zero exit code but you wish to treat this as a success,
then you must place the command in a script and explicitly set the exit code of
the script to zero.
Please note that the success or failure of the state is not affected by whether a state
change occurred nor the stateful argument.
When executing a command or script, the state (i.e., changed or not)
of the command is unknown to Salt's state system. Therefore, by default, the
``cmd`` state assumes that any command execution results in a changed state.