目录
get_url 模块是 Ansible 中的一个内置模块，用于从指定的 URL 下载文件到目标主机。它可以处理通过 HTTP、HTTPS、FTP 等协议下载文件，并支持多种功能如基本的身份认证、代理设置、校验和验证等。Ansible 的 get_url 模块本身并不直接支持断点续传功能，但是可使用shell或command模块结合 wget 或 curl。以下是关于 get_url 模块的详细介绍和使用示例。
主要用途
- 下载文件：从指定的 URL 下载文件到目标主机。
- 支持身份验证：可以处理需要基本 HTTP 认证的网站。
- 校验和验证：下载后可以对文件进行校验和验证，以确保文件的完整性。
- 使用代理：支持通过代理服务器下载文件。
参数总结
url:- 描述：要下载文件的 URL。
- 类型：字符串
- 必需：是
dest:- 描述：下载文件的目标路径（必须为绝对路径）。
- 类型：字符串
- 必需：是
backup:- 描述：如果为
yes，在目标文件存在且内容发生更改时，将创建备份。 - 类型：布尔值
- 默认值：
no
- 描述：如果为
checksum:- 描述：指定下载文件的 SHA256 校验和，以确保文件的完整性。如果校验和不匹配，将发生错误。
- 类型：字符串
force:- 描述：如果为
yes，则总是下载文件，即使文件已存在。 - 类型：布尔值
- 默认值：
no
- 描述：如果为
timeout:- 描述：设置下载的超时时间（秒）。
- 类型：整数
- 默认值：10
headers:- 描述：传递给 HTTP 服务器的自定义头信息。
- 类型：字典
http_agent:- 描述：用于 HTTP 请求的用户代理字符串。
- 类型：字符串
username:- 描述：用于基本身份验证的用户名。
- 类型：字符串
password:- 描述：用于基本身份验证的密码。
- 类型：字符串
url_password:- 描述：用于 URL 访问的密码（用于处理 URL 中包含的密码）。
- 类型：字符串
url_username:- 描述：用于 URL 访问的用户名（用于处理 URL 中包含的用户名）。
- 类型：字符串
use_proxy:- 描述：是否使用代理。
- 类型：布尔值
- 默认值：
yes
validate_certs:- 描述：使用 HTTPS 时是否验证 SSL 证书。
- 类型：布尔值
- 默认值：
yes
client_cert:- 描述：用于身份验证的客户端证书文件路径。
- 类型：字符串
client_key:- 描述：用于身份验证的客户端密钥文件路径。
- 类型：字符串
sha256sum:- 描述：下载文件的 SHA256 校验和，以确保文件的完整性（
checksum参数的别名）。 - 类型：字符串
- 描述：下载文件的 SHA256 校验和，以确保文件的完整性（
基本语法示例
Ansible 命令行直接使用 get_url 模块的基本语法如下：
ansible <host-pattern> -m get_url -a "url=<URL> dest=<目的路径> [其他参数]"
使用示例
示例1：下载文件
从指定 URL 下载文件到远程主机的指定路径：
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt"
示例2：使用校验和验证文件
通过校验和验证下载后的文件：
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt checksum=md5:5d41402abc4b2a76b9719d911017c592"
示例3：使用 HTTP 基本认证
下载一个需要认证的文件：
ansible all -m get_url -a "url=http://example.com/private.txt dest=/tmp/private.txt url_username=myuser url_password=mypassword"
示例4：通过代理服务器下载文件
通过代理服务器下载文件：
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt use_proxy=yes http_proxy=http://proxy.example.com:8080"
示例5：设置文件权限、所有者和组
下载文件并设置权限、所有者和组：
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt mode=0644 owner=myuser group=mygroup"
示例6：强制重新下载文件
即使文件已经存在，也强制重新下载：
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt force=yes"
示例7：设置下载超时时间
设置下载操作的超时时间为 30 秒：
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt timeout=30"
综合示例
示例8：下载文件并设置各种参数
ansible all -m get_url -a "url=http://example.com/sample.txt dest=/tmp/sample.txt mode=0644 owner=myuser group=mygroup force=yes timeout=30 checksum=md5:5d41402abc4b2a76b9719d911017c592"
Playbook示例
基础用法
示例1：下载文件
从指定 URL 下载文件到远程主机的指定路径：
---
- name: Download a file from URL
hosts: all
tasks:
- name: Download a file
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
高级用法
示例2：使用校验和验证文件
通过校验和验证下载后的文件，以确保其完整性：
---
- name: Download a file with checksum verification
hosts: all
tasks:
- name: Download with checksum
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
checksum: "md5:5d41402abc4b2a76b9719d911017c592"
示例3：使用 HTTP 基本认证
下载需要认证的文件，可以提供用户名和密码：
---
- name: Download a file with HTTP authentication
hosts: all
tasks:
- name: Download with basic auth
get_url:
url: http://example.com/private.txt
dest: /tmp/private.txt
url_username: myuser
url_password: mypassword
示例4：通过代理服务器下载文件
通过代理服务器下载文件：
---
- name: Download a file using a proxy
hosts: all
tasks:
- name: Download with proxy
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
use_proxy: yes
http_proxy: http://proxy.example.com:8080
示例5：设置文件权限、所有者和组
下载文件并设置权限、所有者和组：
---
- name: Download a file and set permissions
hosts: all
tasks:
- name: Download and set file attributes
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
mode: '0644'
owner: myuser
group: mygroup
特殊用法
示例6：强制重新下载文件
即使文件已经存在，强制重新下载：
---
- name: Force re-download a file
hosts: all
tasks:
- name: Force download
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
force: yes
示例7：设置下载超时时间
设置下载操作的超时时间，以避免长时间挂起：
---
- name: Download a file with a timeout
hosts: all
tasks:
- name: Download with timeout
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
timeout: 30
集合示例
结合多个参数达到复杂需求：
---
- name: Comprehensive example of get_url usage
hosts: all
tasks:
- name: Download a public file
get_url:
url: http://example.com/public.txt
dest: /tmp/public.txt
- name: Download a file with checksum verification
get_url:
url: http://example.com/sample.txt
dest: /tmp/sample.txt
checksum: "md5:5d41402abc4b2a76b9719d911017c592"
- name: Download a file with HTTP authentication
get_url:
url: http://example.com/private.txt
dest: /tmp/private.txt
url_username: myuser
url_password: mypassword
- name: Download a file using a proxy
get_url:
url: http://example.com/sample-proxy.txt
dest: /tmp/sample-proxy.txt
use_proxy: yes
http_proxy: http://proxy.example.com:8080
- name: Download a file and set permissions
get_url:
url: http://example.com/sample-permissions.txt
dest: /tmp/sample-permissions.txt
mode: '0644'
owner: myuser
group: mygroup
- name: Force re-download a file
get_url:
url: http://example.com/sample-force.txt
dest: /tmp/sample-force.txt
force: yes
- name: Download a file with a timeout
get_url:
url: http://example.com/sample-timeout.txt
dest: /tmp/sample-timeout.txt
timeout: 30