get_url¶
Collection Note
This module is part of the ansible.builtin collection. To install the collection, use:
Added in version0.6.
Synopsis¶
- Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server I(must) have direct access to the remote resource.
- By default, if an environment variable E(
_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 R(setting the environment,playbooks_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.
- From Ansible 2.4 when run with C(--check), it will do a HEAD request to validate the URL but will not download the entire file or verify it against hashes and will report incorrect changed status.
- For Windows targets, use the M(ansible.windows.win_get_url) 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 |
|
| backup bool |
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. Version Added: 2.1 |
|
| checksum str |
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: If you worry about portability, only the sha1 algorithm is available on all platforms and python versions. The Python C(hashlib) module is responsible for providing the available algorithms. The choices vary based on Python version and OpenSSL version. On systems running in FIPS compliant mode, the C(md5) algorithm may be unavailable. Additionally, if a checksum is passed to this parameter, and the file exist under the O(dest) location, the C(destination_checksum) would be calculated, and if checksum equals C(destination_checksum), the file download would be skipped (unless O(force=true)). If the checksum does not equal C(destination_checksum), the destination file is deleted. If the checksum URL requires username and password, O(url_username) and O(url_password) are used to download the checksum file. Version Added: 2.0 |
|
| ciphers list / elements=str |
SSL/TLS Ciphers to use for the request. When a list is provided, all ciphers are joined in order with C(:). See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT) for more details. The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions. Version Added: 2.14 |
|
| client_cert path |
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, O(client_key) is not required. Version Added: 2.4 |
|
| client_key path |
PEM formatted file that contains your private key to be used for SSL client authentication. If O(client_cert) contains both the certificate and key, this option is not required. Version Added: 2.4 |
|
| decompress bool |
Default: True |
Whether to attempt to decompress gzip content-encoded responses. Version Added: 2.14 |
| dest path required |
Absolute path of where to download the file to. If O(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, O(force) has no effect. If O(dest) is a directory, the file will always be downloaded (regardless of the O(force) and O(checksum) option), but replaced only if the contents changed. |
|
| force bool |
If V(true) and O(dest) is not a directory, will download the file every time and replace the file if the contents change. If V(false), the file will only be downloaded if the destination does not exist. Generally should be V(true) only for small local files. Prior to 0.6, this module behaved as if V(true) was the default. Version Added: 0.7 |
|
| force_basic_auth bool |
Force the sending of the Basic authentication header upon initial request. 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. Version Added: 2.0 |
|
| 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. |
|
| headers dict |
Add custom HTTP headers to a request in hash/dict format. The hash/dict format was added in Ansible 2.6. Previous versions used a C("key:value,key:value") string format. The C("key:value,key:value") string format is deprecated and has been removed in version 2.10. Version Added: 2.0 |
|
| http_agent str |
Default: ansible-httpget |
Header to identify as, generally appears in web server logs. |
| 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. |
|
| 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. |
|
| timeout int |
Default: 10 |
Timeout in seconds for URL request. Version Added: 1.8 |
| tmp_dest path |
Absolute path of where temporary file is downloaded to. When run on Ansible 2.5 or greater, path defaults to ansible's C(remote_tmp) setting. When run on Ansible prior to 2.5, it defaults to E(TMPDIR), E(TEMP) or E(TMP) env variables or a platform specific value. U(https://docs.python.org/3/library/tempfile.html#tempfile.tempdir). Version Added: 2.1 |
|
| unredirected_headers list / elements=str |
A list of header names that will not be sent on subsequent redirected requests. This list is case insensitive. By default all headers will be redirected. In some cases it may be beneficial to list headers such as C(Authorization) here to avoid potential credential exposure. Version Added: 2.12 |
|
| 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 |
|
| url str required |
HTTP, HTTPS, or FTP URL in the form C((http|https|ftp)://[user[:pass]]@host.domain[:port]/path). | |
| url_password str |
The password for use in HTTP basic authentication. If the O(url_username) parameter is not specified, the O(url_password) parameter will not be used. Since version 2.8 you can also use the O(password) alias for this option. Version Added: 1.6 |
|
| url_username str |
The username for use in HTTP basic authentication. This parameter can be used without O(url_password) for sites that allow empty passwords. Since version 2.8 you can also use the O(username) alias for this option. Version Added: 1.6 |
|
| use_gssapi bool |
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library L(gssapi,https://github.com/pythongssapi/python-gssapi) to be installed. Credentials for GSSAPI can be specified with O(url_username)/O(url_password) or with the GSSAPI env var E(KRB5CCNAME) that specified a custom Kerberos credential cache. NTLM authentication is I(not) supported even if the GSSAPI mech for NTLM has been installed. Version Added: 2.11 |
|
| use_netrc bool |
Default: True |
Determining whether to use credentials from C(~/.netrc) file. By default C(.netrc) is used with Basic authentication headers. When V(false), C(.netrc) credentials are ignored. Version Added: 2.14 |
| use_proxy bool |
Default: True |
if V(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| validate_certs bool |
Default: True |
If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes¶
Note
- For Windows targets, use the M(ansible.windows.win_get_url) module instead.
Examples¶
- name: Download foo.conf
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
mode: '0440'
- name: Download file and force basic auth
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
force_basic_auth: yes
- name: Download file with custom HTTP headers
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
headers:
key1: one
key2: two
- name: Download file with check (sha256)
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
checksum: sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
- name: Download file with check (md5)
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
checksum: md5:66dffb5228a211e61d6d7ef4a86f5758
- name: Download file with checksum url (sha256)
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
checksum: sha256:http://example.com/path/sha256sum.txt
- name: Download file from a file path
ansible.builtin.get_url:
url: file:///tmp/a_file.txt
dest: /tmp/afilecopy.txt
- name: < Fetch file that requires authentication.
username/password only available since 2.8, in older versions you need to use url_username/url_password
ansible.builtin.get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
username: bar
password: '{{ mysecret }}'
Return Values¶
| Key | Data Type | Description | Returned |
|---|---|---|---|
| backup_file | str | name of backup file created after download | changed and if backup=yes |
| checksum_dest | str | sha1 checksum of the file after copy | success |
| checksum_src | str | sha1 checksum of the file | success |
| dest | str | destination file/path | success |
| elapsed | int | The number of seconds that elapsed while performing the download | always |
| gid | int | group id of the file | success |
| group | str | group of the file | success |
| md5sum | str | md5 checksum of the file after download | when supported |
| mode | str | permissions of the target | success |
| msg | str | the HTTP message from the request | always |
| owner | str | owner of the file | success |
| secontext | str | the SELinux security context of the file | success |
| size | int | size of the target | success |
| src | str | source file used after download | always |
| state | str | state of the target | success |
| status_code | int | the HTTP status code from the request | always |
| uid | int | owner id of the file, after execution | success |
| url | str | the actual URL used for the request | always |
Authors¶
- Jan-Piet Mens (@jpmens)