Documentation

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

Synopsis

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), or by using the use_proxy option. HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Options

parameter required default choices comments
backup
(added in 2.1)
 no no
  • yes
  • no
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
checksum
(added in 2.0)
 no
    If a 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. Format: <algorithm>:<checksum>, e.g.: checksum="sha256:D98291AC[...]B6DC7B97" If you worry about portability, only the sha1 algorithm is available on all platforms and python versions. The third party hashlib library can be installed for access to additional algorithms. Additionaly, if a checksum is passed to this parameter, and the file exist under the dest location, the destination_checksum would be calculated, and if checksum equals destination_checksum, the file download would be skipped (unless force is true).
    dest
    		 yes
      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. If dest is a directory, the file will always be downloaded (regardless of the force option), but replaced only if the contents changed.
      force
      		 no no
      • yes
      • no
      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.

      aliases: thirsty
      force_basic_auth
      (added in 2.0)
      		 no no
      • yes
      • no
      httplib2, the library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request.
      headers
      (added in 2.0)
      		 no
        Add custom HTTP headers to a request in the format "key:value,key:value"
        others
        		 no
          all arguments accepted by the file module also work here
          sha256sum
          (added in 1.3)
          		 no
            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. This option is deprecated. Use 'checksum'.
            timeout
            (added in 1.8)
            		 no 10
              Timeout in seconds for URL request
              tmp_dest
              (added in 2.1)
              		 no
                absolute path of where temporary file is downloaded to.
                Defaults to TMPDIR, TEMP or TMP env variables or a platform specific value
                https://docs.python.org/2/library/tempfile.html#tempfile.tempdir
                url
                		 yes
                  HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
                  url_password
                  (added in 1.6)
                  		 no
                    The password for use in HTTP basic authentication. If the url_username parameter is not specified, the url_password parameter will not be used.
                    url_username
                    (added in 1.6)
                    		 no
                      The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords.
                      use_proxy
                      		 no yes
                      • yes
                      • no
                      if no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
                      validate_certs
                      		 no yes
                      • yes
                      • no
                      If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

                      Examples

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

- name: download file and force basic auth
  get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf force_basic_auth=yes

- name: download file with custom HTTP headers
  get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf headers='key:value,key:value'

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

                      This is a Core Module

                      For more information on what this means please read Core Modules

                      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.