unarchive¶
Collection Note
This module is part of the ansible.builtin collection. To install the collection, use:
Added in version1.4.
Synopsis¶
- The M(ansible.builtin.unarchive) module unpacks an archive. It will not unpack a compressed file that does not contain an archive.
- By default, it will copy the source file from the local system to the target before unpacking.
- Set O(remote_src=yes) to unpack an archive which already exists on the target.
- If checksum validation is desired, use M(ansible.builtin.get_url) or M(ansible.builtin.uri) instead to fetch the file and set O(remote_src=yes).
- For Windows targets, use the M(community.windows.win_unzip) module instead.
Parameters¶
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| attributes str |
The attributes the resulting filesystem object should have. To get supported flags look at the man page for C(chattr) on the target system. This string should contain the attributes in the same order as the one displayed by C(lsattr). The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. Version Added: 2.3 |
|
| copy bool |
Default: True |
If true, the file is copied from local controller to the managed (remote) node, otherwise, the plugin will look for src archive on the managed machine. This option has been deprecated in favor of O(remote_src). This option is mutually exclusive with O(remote_src). |
| creates path |
If the specified absolute path (file or directory) already exists, this step will B(not) be run. The specified absolute path (file or directory) must be below the base path given with O(dest). Version Added: 1.6 |
|
| decrypt bool |
Default: True |
This option controls the auto-decryption of source files using vault. Version Added: 2.4 |
| dest path required |
Remote absolute path where the archive should be unpacked. The given path must exist. Base directory is not created by this module. |
|
| exclude list / elements=str |
List the directory and file entries that you would like to exclude from the unarchive action. Mutually exclusive with O(include). Version Added: 2.1 |
|
| extra_opts list / elements=str |
Specify additional options by passing in an array. Each space-separated command-line option should be a new element of the array. See examples. Command-line options with multiple elements must use multiple lines in the array, one for each element. Version Added: 2.1 |
|
| group str |
Name of the group that should own the filesystem object, as would be fed to C(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. |
|
| include list / elements=str |
List of directory and file entries that you would like to extract from the archive. If O(include) is not empty, only files listed here will be extracted. Mutually exclusive with O(exclude). Version Added: 2.11 |
|
| io_buffer_size int |
Default: 65536 |
Size of the volatile memory buffer that is used for extracting files from the archive in bytes. Version Added: 2.12 |
| keep_newer bool |
Do not replace existing files that are newer than files from the archive. Version Added: 2.1 |
|
| list_files bool |
If set to True, return the list of files that are contained in the tarball. Version Added: 2.0 |
|
| mode raw |
The permissions the resulting filesystem object should have. For those used to C(/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. |
|
| owner str |
Name of the user that should own the filesystem object, as would be fed to C(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. |
|
| remote_src bool |
Set to V(true) to indicate the archived file is already on the remote system and not local to the Ansible controller. This option is mutually exclusive with O(copy). Version Added: 2.2 |
|
| selevel str |
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. |
|
| serole str |
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. |
|
| setype str |
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. |
|
| seuser str |
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. |
|
| src path required |
If O(remote_src=no) (default), local path to archive file to copy to the target server; can be absolute or relative. If O(remote_src=yes), path on the target server to existing archive file to unpack. If O(remote_src=yes) and O(src) contains V(://), 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 M(ansible.builtin.get_url) module. |
|
| unsafe_writes bool |
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. Version Added: 2.2 |
|
| validate_certs bool |
Default: True |
This only applies if using a https URL as the source of the file. This should only set to V(false) used on personally controlled sites using self-signed certificate. Prior to 2.2 the code worked as if this was set to V(true). Version Added: 2.2 |
Notes¶
Note
- Requires C(zipinfo) and C(gtar)/C(unzip) command on target host.
- Requires C(zstd) command on target host to expand I(.tar.zst) files.
- Can handle I(.zip) files using C(unzip) as well as I(.tar), I(.tar.gz), I(.tar.bz2), I(.tar.xz), and I(.tar.zst) files using C(gtar).
- Does not handle I(.gz) files, I(.bz2) files, I(.xz), or I(.zst) files that do not contain a I(.tar) archive.
- Existing files/directories in the destination which are not in the archive are not touched. This is the same behavior as a normal archive extraction.
- Existing files/directories in the destination which are not in the archive are ignored for purposes of deciding if the archive should be unpacked or not.
Examples¶
- name: Extract foo.tgz into /var/lib/foo
ansible.builtin.unarchive:
src: foo.tgz
dest: /var/lib/foo
- name: Unarchive a file that is already on the remote machine
ansible.builtin.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)
ansible.builtin.unarchive:
src: https://example.com/example.zip
dest: /usr/local/bin
remote_src: yes
- name: Unarchive a file with extra options
ansible.builtin.unarchive:
src: /tmp/foo.zip
dest: /usr/local/bin
extra_opts:
- --transform
- s/^xxx/yyy/
Return Values¶
| Key | Data Type | Description | Returned |
|---|---|---|---|
| dest | str | Path to the destination directory. | always |
| files | list | List of all the files in the archive. | When O(list_files) is V(True) |
| gid | int | Numerical ID of the group that owns the destination directory. | always |
| group | str | Name of the group that owns the destination directory. | always |
| handler | str | Archive software handler used to extract and decompress the archive. | always |
| mode | str | String that represents the octal permissions of the destination directory. | always |
| owner | str | Name of the user that owns the destination directory. | always |
| size | int | The size of destination directory in bytes. Does not include the size of files or subdirectories contained within. | always |
| src | str | The source archive's path. If O(src) was a remote web URL, or from the local ansible controller, this shows the temporary location where the download was stored. | always |
| state | str | State of the destination. Effectively always "directory". | always |
| uid | int | Numerical ID of the user that owns the destination directory. | always |
Authors¶
- Michael Dehaan