ANSIBLE.UNARCHIVE(3)            ANSIBLE MODULES           ANSIBLE.UNARCHIVE(3)



NAME
       unarchive - Copies archive to remote locations and unpacks them

DESCRIPTION
       The unarchive module copies an archive file on the local box to remote
       locations and unpacks them.

OPTIONS
       dest   Remote absolute path where the archive should be
              unpacked(required)

       src    Local path to archive file to copy to the remote server; can be
              absolute or relative.(required).

NOTES
       requires tar/unzip command on host

       can handle gzip, bzip2 and xz compressed as well as uncompressed tar
       files

       detects type of archive automatically

       uses tar's --diff arg to calculate if changed or not.  If this arg is
       not supported, it will always unpack the archive

       does not detect if a .zip file is different from destination - always
       unzips

       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
       # Example from Ansible Playbooks
       - unarchive: src=foo.tgz dest=/var/lib/foo



AUTHOR
       Dylan Martin

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#unarchive



1.4.5                             2014-02-12              ANSIBLE.UNARCHIVE(3)
