ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Make remove default to false. It's less frightening.

Browse source
This commit is contained in:
Ben Doherty 2016-05-26 23:58:17 -04:00 committed by Matt Clay
parent 3c8d788c11
commit c9291e06f6
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
lib/ansible/modules/extras/files/archive.py
View file

@ -28,7 +28,7 @@ version_added: 2.2
short_description: Creates a compressed archive of one or more files or trees. short_description: Creates a compressed archive of one or more files or trees.
extends_documentation_fragment: files extends_documentation_fragment: files
description: 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 - set copy=yes to pack an archive which does not already exist on the target. The source files are deleted after archiving. - 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.
options: options:
path: path:
description: description:
@ -41,22 +41,28 @@ options:
choices: [ 'gz', 'bz2', 'zip' ] choices: [ 'gz', 'bz2', 'zip' ]
creates: creates:
description: description:
- The file name of the destination archive. When it already exists, this step will B(not) be run. This is required when 'path' refers to multiple files by either specifying a glob, a directory or multiple paths in a list. - 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 required: false, unless multiple source paths or globs are specified
default: null default: null
remove:
description:
- Remove any added source files and trees after adding to archive.
type: bool
required: false
default: false
author: "Ben Doherty (@bendoh)" author: "Ben Doherty (@bendoh)"
notes: notes:
- requires tarfile, zipfile, gzip, and bzip2 packages on target host - requires tarfile, zipfile, gzip, and bzip2 packages on target host
- can product I(gzip), I(bzip2) and I(zip) compressed files or archives - can produce I(gzip), I(bzip2) and I(zip) compressed files or archives
- removes source files by default
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Compress directory /path/to/foo/ into /path/to/foo.tgz # Compress directory /path/to/foo/ into /path/to/foo.tgz
- archive: path=/path/to/foo creates=/path/to/foo.tgz - archive: path=/path/to/foo creates=/path/to/foo.tgz
# Compress regular file /path/to/foo into /path/to/foo.gz # Compress regular file /path/to/foo into /path/to/foo.gz and remove it
- archive: path=/path/to/foo - archive: path=/path/to/foo remove=True
# Create a zip archive of /path/to/foo # Create a zip archive of /path/to/foo
- archive: path=/path/to/foo compression=zip - archive: path=/path/to/foo compression=zip
@ -113,7 +119,7 @@ def main():
path = dict(type='list', required=True), path = dict(type='list', required=True),
compression = dict(choices=['gz', 'bz2', 'zip'], default='gz', required=False), compression = dict(choices=['gz', 'bz2', 'zip'], default='gz', required=False),
creates = dict(required=False), creates = dict(required=False),
remove = dict(required=False, default=True, type='bool'), remove = dict(required=False, default=False, type='bool'),
), ),
add_file_common_args=True, add_file_common_args=True,
supports_check_mode=True, supports_check_mode=True,