ansible / ansible.builtin / v2.9.27 / module / win_get_url Downloads file from HTTP, HTTPS, or FTP to node | "added in version" 1.7 of ansible.builtin" Authors: Paul Durivage (@angstwad), Takeshi Kuramochi (@tksarah) stableinterface | supported by coreansible.builtin.win_get_url (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Downloads files from HTTP, HTTPS, or FTP to the remote server.
The remote server I(must) have direct access to the remote resource.
For non-Windows targets, use the M(get_url) module instead.
- name: Download earthrise.jpg to specified path win_get_url: url: http://www.example.com/earthrise.jpg dest: C:\Users\RandomUser\earthrise.jpg
- name: Download earthrise.jpg to specified path only if modified win_get_url: url: http://www.example.com/earthrise.jpg dest: C:\Users\RandomUser\earthrise.jpg force: no
- name: Download earthrise.jpg to specified path through a proxy server. win_get_url: url: http://www.example.com/earthrise.jpg dest: C:\Users\RandomUser\earthrise.jpg proxy_url: http://10.0.0.1:8080 proxy_username: username proxy_password: password
- name: Download file from FTP with authentication win_get_url: url: ftp://server/file.txt dest: '%TEMP%\ftp-file.txt' url_username: ftp-user url_password: ftp-password
- name: Download src with sha256 checksum url win_get_url: url: http://www.example.com/earthrise.jpg dest: C:\temp\earthrise.jpg checksum_url: http://www.example.com/sha256sum.txt checksum_algorithm: sha256 force: True
- name: Download src with sha256 checksum url win_get_url: url: http://www.example.com/earthrise.jpg dest: C:\temp\earthrise.jpg checksum: a97e6837f60cec6da4491bab387296bbcd72bdba checksum_algorithm: sha1 force: True
url: description: - The full URL of a file to download. required: true type: str dest: description: - The location to save the file at the URL. - Be sure to include a filename and extension as appropriate. required: true type: path force: default: true description: - If C(yes), will download the file every time and replace the file if the contents change. If C(no), will only download the file if it does not exist or the remote file has been modified more recently than the local file. - This works by sending an http HEAD request to retrieve last modified time of the requested resource, so for this to work, the remote web server must support HEAD requests. type: bool version_added: '2.0' version_added_collection: ansible.builtin method: description: - This option is not for use with C(win_get_url) and should be ignored. type: str version_added: '2.9' version_added_collection: ansible.builtin headers: description: - Extra headers to set on the request. - This should be a dictionary where the key is the header name and the value is the value for that header. type: dict version_added: '2.4' version_added_collection: ansible.builtin timeout: default: 30 description: - Specifies how long the request can be pending before it times out (in seconds). - Set to V(0) to specify an infinite timeout. type: int checksum: description: - If a I(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 cannot be set with I(checksum_url). type: str version_added: '2.8' version_added_collection: ansible.builtin proxy_url: description: - An explicit proxy to use for the request. - By default, the request will use the IE defined proxy unless O(use_proxy) is set to V(no). type: str version_added: '2.0' version_added_collection: ansible.builtin use_proxy: default: true description: - If V(no), it will not use the proxy defined in IE for the current user. type: bool version_added: '2.4' version_added_collection: ansible.builtin http_agent: default: ansible-httpget description: - Header to identify as, generally appears in web server logs. - This is set to the C(User-Agent) header on a HTTP request. type: str client_cert: description: - The path to the client certificate (.pfx) that is used for X509 authentication. This path can either be the path to the C(pfx) on the filesystem or the PowerShell certificate path C(Cert:\CurrentUser\My\<thumbprint>). - The WinRM connection must be authenticated with C(CredSSP) or C(become) is used on the task if the certificate file is not password protected. - Other authentication types can set O(client_cert_password) when the cert is password protected. type: str version_added: '2.9' version_added_collection: ansible.builtin checksum_url: description: - Specifies a URL that contains the checksum values for the resource at I(url). - Like C(checksum), this is used to verify the integrity of the remote transfer. - This option cannot be set with I(checksum). type: str version_added: '2.8' version_added_collection: ansible.builtin url_password: description: - The password for O(url_username). type: str url_username: description: - The username to use for authentication. type: str proxy_password: description: - The password for O(proxy_username). type: str version_added: '2.0' version_added_collection: ansible.builtin proxy_username: description: - The username to use for proxy authentication. type: str version_added: '2.0' version_added_collection: ansible.builtin validate_certs: default: true description: - If V(no), SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates. type: bool follow_redirects: choices: - all - none - safe default: safe description: - Whether or the module should follow redirects. - V(all) will follow all redirect. - V(none) will not follow any redirect. - V(safe) will follow only "safe" redirects, where "safe" means that the client is only doing a C(GET) or C(HEAD) on the URI to which it is being redirected. - When following a redirected URL, the C(Authorization) header and any credentials set will be dropped and not redirected. type: str version_added: '2.9' version_added_collection: ansible.builtin force_basic_auth: default: false description: - By default the authentication header is only sent when a webservice responses 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 the original request. type: bool checksum_algorithm: choices: - md5 - sha1 - sha256 - sha384 - sha512 default: sha1 description: - Specifies the hashing algorithm used when calculating the checksum of the remote and destination file. type: str version_added: '2.8' version_added_collection: ansible.builtin maximum_redirection: default: 50 description: - Specify how many times the module will redirect a connection to an alternative URI before the connection fails. - If set to V(0) or O(follow_redirects) is set to V(none), or V(safe) when not doing a C(GET) or C(HEAD) it prevents all redirection. type: int version_added: '2.9' version_added_collection: ansible.builtin client_cert_password: description: - The password for O(client_cert) if the cert is password protected. type: str version_added: '2.9' version_added_collection: ansible.builtin use_default_credential: default: false description: - Uses the current user's credentials when authenticating with a server protected with C(NTLM), C(Kerberos), or C(Negotiate) authentication. - Sites that use C(Basic) auth will still require explicit credentials through the O(url_username) and O(url_password) options. - The module will only have access to the user's credentials if using C(become) with a password, you are connecting with SSH using a password, or connecting with WinRM using C(CredSSP) or C(Kerberos with delegation). - If not using C(become) or a different auth method to the ones stated above, there will be no default credentials available and no authentication will occur. type: bool proxy_use_default_credential: default: false description: - Uses the current user's credentials when authenticating with a proxy host protected with C(NTLM), C(Kerberos), or C(Negotiate) authentication. - Proxies that use C(Basic) auth will still require explicit credentials through the O(proxy_username) and O(proxy_password) options. - The module will only have access to the user's credentials if using C(become) with a password, you are connecting with SSH using a password, or connecting with WinRM using C(CredSSP) or C(Kerberos with delegation). - If not using C(become) or a different auth method to the ones stated above, there will be no default credentials available and no proxy authentication will occur. type: bool
checksum_dest: description: <algorithm> checksum of the file after the download returned: success and dest has been downloaded sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 type: str checksum_src: description: <algorithm> checksum of the remote resource returned: force=yes or dest did not exist sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 type: str dest: description: destination file/path returned: always sample: C:\Users\RandomUser\earthrise.jpg type: str elapsed: description: The elapsed seconds between the start of poll and the end of the module. returned: always sample: 2.1406487 type: float msg: description: Error message, or HTTP status message from web-server returned: always sample: OK type: str size: description: size of the dest file returned: success sample: 1220 type: int status_code: description: HTTP status code returned: always sample: 200 type: int url: description: requested url returned: always sample: http://www.example.com/earthrise.jpg type: str