summaryrefslogtreecommitdiff
path: root/files
diff options
context:
space:
mode:
authorBen Doherty <ben@thinkoomph.com>2016-05-26 21:38:31 -0400
committerBen Doherty <ben@thinkoomph.com>2016-05-26 21:38:31 -0400
commit9cde150bd12b771ba607b9e62918c57ca724ef88 (patch)
tree7d21b706fe3ec37e2787f3714b0a3d387b2557b7 /files
parente9b85326a653c9c9e325a8fe1b1c7714c05a29ad (diff)
downloadansible-modules-extras-9cde150bd12b771ba607b9e62918c57ca724ef88.tar.gz
Add RETURN documentation
Diffstat (limited to 'files')
-rw-r--r--files/archive.py21
1 files changed, 21 insertions, 0 deletions
diff --git a/files/archive.py b/files/archive.py
index 76dcb9cf..e64a9197 100644
--- a/files/archive.py
+++ b/files/archive.py
@@ -50,6 +50,27 @@ EXAMPLES = '''
compression: bz2
'''
+RETURN = '''
+state:
+ description: The current state of the archived file.
+ type: string
+ returned: always
+missing:
+ description: Any files that were missing from the source.
+ type: list
+ returned: success
+archived:
+ description: Any files that were compressed or added to the archive.
+ type: list
+ returned: success
+arcroot:
+ description: The archive root.
+ type: string
+expanded_paths:
+ description: The list of matching paths from paths argument.
+ type: list
+'''
+
import stat
import os
import errno