Try SpotterCreates a compressed archive of one or more files or trees
| "added in version" 2.3 of ansible.builtin"
Authors: Ben Doherty (@bendoh)
preview | supported by community
pipInstall with pip install ansible==2.9.27
Packs an archive.
It is the opposite of M(unarchive).
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 I(remove=True).
- name: Compress directory /path/to/foo/ into /path/to/foo.tgz
archive:
path: /path/to/foo
dest: /path/to/foo.tgz
- name: Compress regular file /path/to/foo into /path/to/foo.gz and remove it
archive:
path: /path/to/foo
remove: yes
- name: Create a zip archive of /path/to/foo
archive:
path: /path/to/foo
format: zip
- name: Create a bz2 archive of multiple files, rooted at /path
archive:
path:
- /path/to/foo
- /path/wong/foo
dest: /path/file.tar.bz2
format: bz2
- name: Create a bz2 archive of a globbed path, while excluding specific dirnames
archive:
path:
- /path/to/foo/*
dest: /path/file.tar.bz2
exclude_path:
- /path/to/foo/bar
- /path/to/foo/baz
format: bz2
- name: Create a bz2 archive of a globbed path, while excluding a glob of dirnames
archive:
path:
- /path/to/foo/*
dest: /path/file.tar.bz2
exclude_path:
- /path/to/foo/ba*
format: bz2
- name: Use gzip to compress a single archive (i.e don't archive it first with tar)
archive:
path: /path/to/foo/single.file
dest: /path/file.gz
format: gz
- name: Create a tar.gz archive of a single file.
archive:
path: /path/to/foo/single.file
dest: /path/file.tar.gz
format: gz
force_archive: true
dest:
description:
- 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.
type: path
mode:
description:
- The permissions the resulting filesystem object should have.
- For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
You must give Ansible enough information to parse them correctly. For consistent
results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
a string and can do its own conversion from string into number. Adding a leading
zero (for example, V(0755)) works sometimes, but can fail in loops and some other
circumstances.
- Giving Ansible a number without following either of these rules will end up with
a decimal number which will have unexpected results.
- As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx)
or V(u=rw,g=r,o=r)).
- If O(mode) is not specified and the destination filesystem object B(does not) exist,
the default C(umask) on the system will be used when setting the mode for the newly
created filesystem object.
- If O(mode) is not specified and the destination filesystem object B(does) exist,
the mode of the existing filesystem object will be used.
- Specifying O(mode) is the best way to ensure filesystem objects are created with
the correct permissions. See CVE-2020-1736 for further details.
type: raw
path:
description:
- Remote absolute path, glob, or list of paths or globs for the file or files to compress
or archive.
required: true
type: list
group:
description:
- Name of the group that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current group of the current user unless you
are root, in which case it can preserve the previous ownership.
type: str
owner:
description:
- Name of the user that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current user unless you are root, in which case
it can preserve the previous ownership.
- Specifying a numeric username will be assumed to be a user ID and not a username.
Avoid numeric usernames to avoid this confusion.
type: str
format:
choices:
- bz2
- gz
- tar
- xz
- zip
default: gz
description:
- The type of compression to use.
- Support for xz was added in Ansible 2.5.
type: str
remove:
default: false
description:
- Remove any added source files and trees after adding to archive.
type: bool
serole:
description:
- The role part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(role) portion of the policy if available.
type: str
setype:
description:
- The type part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(type) portion of the policy if available.
type: str
seuser:
description:
- The user part of the SELinux filesystem object context.
- By default it uses the V(system) policy, where applicable.
- When set to V(_default), it will use the C(user) portion of the policy if available.
type: str
selevel:
description:
- The level part of the SELinux filesystem object context.
- This is the MLS/MCS attribute, sometimes known as the C(range).
- When set to V(_default), it will use the C(level) portion of the policy if available.
type: str
attributes:
aliases:
- attr
description:
- The attributes the resulting filesystem object should have.
- To get supported flags look at the man page for I(chattr) on the target system.
- This string should contain the attributes in the same order as the one displayed
by I(lsattr).
- The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
be included in the string.
type: str
version_added: '2.3'
version_added_collection: ansible.builtin
exclude_path:
description:
- Remote absolute path, glob, or list of paths or globs for the file or files to exclude
from the archive.
type: list
version_added: '2.4'
version_added_collection: ansible.builtin
force_archive:
default: false
description:
- Allow you to force the module to treat this as an archive even if only a single
file is specified.
- By default behaviour is maintained. i.e A when a single file is specified it is
compressed only (not archived).
type: bool
version_added: '2.8'
version_added_collection: ansible.builtin
unsafe_writes:
default: false
description:
- Influence when to use atomic operation to prevent data corruption or inconsistent
reads from the target filesystem object.
- By default this module uses atomic operations to prevent data corruption or inconsistent
reads from the target filesystem objects, but sometimes systems are configured or
just broken in ways that prevent this. One example is docker mounted filesystem
objects, which cannot be updated atomically from inside the container and can only
be written in an unsafe manner.
- This option allows Ansible to fall back to unsafe methods of updating filesystem
objects when atomic operations fail (however, it doesn't force Ansible to perform
unsafe writes).
- IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
archived:
description: Any files that were compressed or added to the archive.
returned: success
type: list
arcroot:
description: The archive root.
returned: always
type: str
expanded_exclude_paths:
description: The list of matching exclude paths from the exclude_path argument.
returned: always
type: list
expanded_paths:
description: The list of matching paths from paths argument.
returned: always
type: list
missing:
description: Any files that were missing from the source.
returned: success
type: list
state:
description: The current state of the archived file. If 'absent', then no source
files were found and the archive does not exist. If 'compress', then the file
source file is in the compressed state. If 'archive', then the source file or
paths are currently archived. If 'incomplete', then an archive was created, but
not all source paths were found.
returned: always
type: str