unarchive – Unpacks an archive after (optionally) copying it from the local machine

• Synopsis
• Parameters
• Notes
• See Also
• Examples
• Status

Synopsis

• The unarchive module unpacks an archive.
• By default, it will copy the source file from the local system to the target before unpacking.
• Set remote_src=yes to unpack an archive which already exists on the target.
• If checksum validation is desired, use get_url or uri instead to fetch the file and set remote_src=yes.
• For Windows targets, use the win_unzip module instead.

Parameters

Notes

See Also

Examples

- 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/

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Core Team. [core]

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

• Michael DeHaan