summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrian Coca <bcoca@users.noreply.github.com>2021-03-11 21:28:47 +0100
committerGitHub <noreply@github.com>2021-03-11 21:28:47 +0100
commitb486feaaf41353e6df0bbfafa31a66f3a42de4f9 (patch)
tree54b1f3f33a9c80bf7eb944df1ad7df7b74dc928c
parentdescribe what ansible-core is (#73829) (diff)
downloadansible-b486feaaf41353e6df0bbfafa31a66f3a42de4f9.tar.xz
ansible-b486feaaf41353e6df0bbfafa31a66f3a42de4f9.zip
document slurp returns (#73865)
* no path on return
-rw-r--r--lib/ansible/modules/slurp.py18
1 files changed, 17 insertions, 1 deletions
diff --git a/lib/ansible/modules/slurp.py b/lib/ansible/modules/slurp.py
index 919c79ccce..a216b65145 100644
--- a/lib/ansible/modules/slurp.py
+++ b/lib/ansible/modules/slurp.py
@@ -58,7 +58,23 @@ EXAMPLES = r'''
# 2179
'''
-RETURN = r'''#'''
+RETURN = r'''
+content:
+ description: Encoded file content
+ returned: success
+ type: str
+ sample: "MjE3OQo="
+encoding:
+ description: Type of encoding used for file
+ returned: success
+ type: str
+ sample: "base64"
+source:
+ description: Actual path of file slurped
+ returned: success
+ type: str
+ sample: "/var/run/sshd.pid"
+'''
import base64
import os