description for the get_url module describing checksum verification before file download

This commit is contained in:
muszynski@so1.net 2015-10-04 14:24:07 +02:00 committed by Matt Clay
parent d70c33f932
commit 2e3ad2b80a

View file

@ -78,13 +78,17 @@ options:
default: null default: null
checksum: checksum:
description: description:
- 'If a checksum is passed to this parameter, the digest of the - If a checksum is passed to this parameter, the digest of the
destination file will be calculated after it is downloaded to ensure destination file will be calculated after it is downloaded to ensure
its integrity and verify that the transfer completed successfully. its integrity and verify that the transfer completed successfully.
Format: <algorithm>:<checksum>, e.g.: checksum="sha256:shagoeshere" Format: <algorithm>:<checksum>, e.g.: checksum="sha256:shagoeshere"
If you worry about portability, only the sha1 algorithm is available If you worry about portability, only the sha1 algorithm is available
on all platforms and python versions. The third party hashlib on all platforms and python versions. The third party hashlib
library can be installed for access to additional algorithms.' library can be installed for access to additional algorithms.
Additionaly, if a checksum is passed to this parameter, and the file exist under
the C(dest) location, the destination_checksum would be calculated, and if
checksum equals destination_checksum, the file download would be skipped
(unless C(force) is true).
version_added: "2.0" version_added: "2.0"
required: false required: false
default: null default: null