allow_insecure | ignore HTTPS certificate errors |
checksum | archive file checksum (match checksum_type). |
checksum_type | archive file checksum type (none|md5|sha1|sha2|sh256|sha384|sha512). |
checksum_url | archive file checksum source (instead of specifying checksum) |
checksum_verify | whether checksum wil be verified (true|false). |
cleanup | whether archive file will be removed after extraction (true|false). |
cookie | archive file download cookie. |
digest_string | archive file checksum (match checksum_type)
(this parameter is for camptocamp/archive compatibility). |
digest_type | archive file checksum type (none|md5|sha1|sha2|sh256|sha384|sha512)
(this parameter is camptocamp/archive compatibility). |
digest_url | archive file checksum source (instead of specifying checksum)
(this parameter is for camptocamp/archive compatibility) |
ensure | whether archive file should be present/absent (default: present) |
extract | whether archive will be extracted after download (true|false). |
extract_command | custom extraction command ('tar xvf example.tar.gz'), also support sprintf format ('tar xvf %s') which will be processed with the filename: sprintf('tar xvf %s', filename) |
extract_flags | custom extraction options, this replaces the default flags. A string such as 'xvf' for a tar file would replace the default xf flag. A hash is useful when custom flags are needed for different platforms. {'tar' => 'xzf', '7z' => 'x -aot'}. |
extract_path | target folder path to extract archive. |
filename | archive file name (derived from path). |
group | extract command group (using this option will configure the archive file permisison to 0644 so the user can read the file). |
password | password to download source file. |
path | namevar, archive file fully qualified file path. |
provider | |
proxy_server | proxy address to use when accessing source |
proxy_type | proxy type (none|ftp|http|https) |
source | archive file source, supports http|https|ftp|file|s3 uri. |
target | target folder path to extract archive. (this parameter is for camptocamp/archive compatibility) |
url | archive file source, supports http|https|ftp|file uri.
(for camptocamp/archive compatibility) |
user | extract command user (using this option will configure the archive file permission to 0644 so the user can read the file). |
username | username to download source file. |