diff options
| author | Ben Doherty <ben@thinkoomph.com> | 2016-05-27 00:07:15 -0400 |
|---|---|---|
| committer | Ben Doherty <ben@thinkoomph.com> | 2016-05-27 00:07:15 -0400 |
| commit | 6e0aac888b736b4edd13d130cb0e24af01da842e (patch) | |
| tree | a1de0e1fa46777e4d63dbeb7fd48d2f98e2c2cea | |
| parent | 20bfb1339d06b6b576e1d7b15c21834d51f015b2 (diff) | |
| download | ansible-modules-extras-6e0aac888b736b4edd13d130cb0e24af01da842e.tar.gz | |
Documentation updates
| -rw-r--r-- | files/archive.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/files/archive.py b/files/archive.py index 811a9aaa..8a9a082f 100644 --- a/files/archive.py +++ b/files/archive.py @@ -28,21 +28,20 @@ version_added: 2.2 short_description: Creates a compressed archive of one or more files or trees. extends_documentation_fragment: files description: - - The M(archive) module packs an archive. It is the opposite of the unarchive module. By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying remove=True. + - The M(archive) module packs an archive. It is the opposite of the unarchive module. By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying C(remove)=I(True). options: path: description: - Remote absolute path, glob, or list of paths or globs for the file or files to archive or compress. - required: false - default: null + required: true compression: description: - The type of compression to use. Can be 'gz', 'bz2', or 'zip'. choices: [ 'gz', 'bz2', 'zip' ] creates: description: - - The file name of the destination archive. This is required when 'path' refers to multiple files by either specifying a glob, a directory or multiple paths in a list. - required: false, unless multiple source paths or globs are specified + - The file name of the destination archive. This is required when C(path) refers to multiple files by either specifying a glob, a directory or multiple paths in a list. + required: false default: null remove: description: |