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 #5792 from basepi/envdoc5772

Browse Source 
Document the `env` arg for cmdmod functions, Fix #5772
This commit is contained in:
Thomas S Hatch 2013-06-27 14:42:32 -07:00
commit 4a6408fb4c
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
salt/modules/cmdmod.py
View File

@ -405,6 +405,9 @@ def run(cmd,
'''
Execute the passed command and return the output as a string
Note that ``env`` represents the environment variables for the command, and
should be formatted as a dict, or a YAML string which resolves to a dict.
CLI Example::
salt '*' cmd.run "ls -l | awk '/foo/{print \\$2}'"
@ -457,6 +460,9 @@ def run_stdout(cmd,
'''
Execute a command, and only return the standard out
Note that ``env`` represents the environment variables for the command, and
should be formatted as a dict, or a YAML string which resolves to a dict.
CLI Example::
salt '*' cmd.run_stdout "ls -l | awk '/foo/{print \\$2}'"
@ -504,6 +510,9 @@ def run_stderr(cmd,
'''
Execute a command and only return the standard error
Note that ``env`` represents the environment variables for the command, and
should be formatted as a dict, or a YAML string which resolves to a dict.
CLI Example::
salt '*' cmd.run_stderr "ls -l | awk '/foo/{print \\$2}'"
@ -551,6 +560,9 @@ def run_all(cmd,
'''
Execute the passed command and return a dict of return data
Note that ``env`` represents the environment variables for the command, and
should be formatted as a dict, or a YAML string which resolves to a dict.
CLI Example::
salt '*' cmd.run_all "ls -l | awk '/foo/{print \\$2}'"
@ -611,6 +623,9 @@ def retcode(cmd,
'''
Execute a shell command and return the command's return code.
Note that ``env`` represents the environment variables for the command, and
should be formatted as a dict, or a YAML string which resolves to a dict.
CLI Example::
salt '*' cmd.retcode "file /bin/bash"