ANSIBLE.GET_URL(3)              ANSIBLE MODULES             ANSIBLE.GET_URL(3)



NAME
       get_url - Downloads files from HTTP, HTTPS, or FTP to node

DESCRIPTION
       Downloads files from HTTP, HTTPS, or FTP to the remote server. The
       remote server must have direct access to the remote resource.

       By default, if an environment variable <protocol>_proxy is set on the
       target host, requests will be sent through that proxy. This behaviour
       can be overridden by setting a variable for this task (see `setting the
       environment
       <http://www.ansibleworks.com/docs/playbooks_environment.html#setting-
       the-environment-and-working-with-proxies>`_), or by using the use_proxy
       option.

OPTIONS
       dest   absolute path of where to download the file to.If dest is a
              directory, either the server provided filename or, if none
              provided, the base name of the URL on the remote server will be
              used. If a directory, force has no effect.(required)

       force  If yes and dest is not a directory, will download the file every
              time and replace the file if the contents change. If no, the
              file will only be downloaded if the destination does not exist.
              Generally should be yes only for small local files. Prior to
              0.6, this module behaved as if yes was the default. Has no
              effect if dest is a directory - the file will always be
              downloaded, but replaced only if the contents changed.  Choices:
              yes,no. (default: no)(Added in Ansible version 0.7.)


       others all arguments accepted by the file module also work here

       sha256sum
              If a SHA-256 checksum is passed to this parameter, the digest of
              the destination file will be calculated after it is downloaded
              to ensure its integrity and verify that the transfer completed
              successfully.(Added in Ansible version 1.3.)


       url    HTTP, HTTPS, or FTP URL in the form
              (http|https|ftp)://[user[:pass]]@host.domain[:port]/path(required)

       use_proxy
              if no, it will not use a proxy, even if one is defined in an
              environment variable on the target hosts.  Choices: yes,no.
              (default: yes).

NOTES
       This module doesn't yet support configuration for proxies.

EXAMPLES
       - name: download foo.conf
         get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440

       - name: download file with sha256 check
         get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf sha256sum=b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c



AUTHOR
       Jan-Piet Mens

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



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