New in version 1.4.
unarchive module unpacks an archive.remote_src=yes to unpack an archive which already exists on the target.remote_src=yes.| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
attributes
(added in 2.3) |
Attributes the file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr.
aliases: attr |
|
|
copy
bool |
|
If true, the file is copied from local 'master' to the target machine, otherwise, the plugin will look for src archive at the target machine.
This option has been deprecated in favor of
remote_src.This option is mutually exclusive with
remote_src. |
|
creates
(added in 1.6) |
If the specified absolute path (file or directory) already exists, this step will not be run.
|
|
|
decrypt
bool (added in 2.4) |
Yes
|
This option controls the autodecryption of source files using vault.
|
|
dest
required |
Remote absolute path where the archive should be unpacked.
|
|
|
exclude
(added in 2.1) |
List the directory and file entries that you would like to exclude from the unarchive action.
|
|
|
extra_opts
(added in 2.1) |
Default: |
Specify additional options by passing in an array.
|
| group |
Name of the group that should own the file/directory, as would be fed to chown.
|
|
|
keep_newer
bool (added in 2.1) |
|
Do not replace existing files that are newer than files from the archive.
|
|
list_files
bool (added in 2.0) |
|
If set to True, return the list of files that are contained in the tarball.
|
| mode |
Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either specify the leading zero so that Ansible's YAML parser knows it is an octal number (like
0644 or 01777) or quote it (like '644' or '0644' so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r). |
|
| owner |
Name of the user that should own the file/directory, as would be fed to chown.
|
|
|
remote_src
bool (added in 2.2) |
|
Set to
yes to indicate the archived file is already on the remote system and not local to the Ansible controller.This option is mutually exclusive with
copy. |
| selevel |
Default: s0
|
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the
range. _default feature works as for seuser. |
| serole |
Role part of SELinux file context,
_default feature works as for seuser. |
|
| setype |
Type part of SELinux file context,
_default feature works as for seuser. |
|
| seuser |
User part of SELinux file context. Will default to system policy, if applicable. If set to
_default, it will use the user portion of the policy if available. |
|
|
src
required |
If
remote_src=no (default), local path to archive file to copy to the target server; can be absolute or relative. If remote_src=yes, path on the target server to existing archive file to unpack.If
remote_src=yes and src contains ://, the remote machine will download the file from the URL first. (version_added 2.0). This is only for simple cases, for full download support use the get_url module. |
|
|
unsafe_writes
bool (added in 2.2) |
|
Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.
This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.
|
|
validate_certs
bool (added in 2.2) |
|
This only applies if using a https URL as the source of the file.
This should only set to
no used on personally controlled sites using self-signed certificate.Prior to 2.2 the code worked as if this was set to
yes. |
Note
gtar/unzip command on target host.unzip as well as .tar, .tar.gz, .tar.bz2 and .tar.xz files using gtar.--diff arg to calculate if changed or not. If this arg is not supported, it will always unpack the archive.- name: Extract foo.tgz into /var/lib/foo
unarchive:
src: foo.tgz
dest: /var/lib/foo
- name: Unarchive a file that is already on the remote machine
unarchive:
src: /tmp/foo.zip
dest: /usr/local/bin
remote_src: yes
- name: Unarchive a file that needs to be downloaded (added in 2.0)
unarchive:
src: https://example.com/example.zip
dest: /usr/local/bin
remote_src: yes
- name: Unarchive a file with extra options
unarchive:
src: /tmp/foo.zip
dest: /usr/local/bin
extra_opts:
- --transform
- s/^xxx/yyy/
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.