ansible.builtin.url 查找 – 从 URL 返回内容

注意

此查找插件是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您可以使用短插件名称 url。但是，我们建议您使用完全限定集合名称 (FQCN) ansible.builtin.url，以便轻松链接到插件文档并避免与其他可能具有相同查找插件名称的集合冲突。

概要 

返回请求的 URL 的内容，以便在 playbook 中用作数据。

术语 

参数	注释
术语字符串	要查询的 URL

关键字参数 

这描述了查找的关键字参数。这些是在以下示例中 key1=value1、key2=value2 等值：lookup('ansible.builtin.url', key1=value1, key2=value2, ...) 和 query('ansible.builtin.url', key1=value1, key2=value2, ...)

参数	注释
ca_path 字符串在 ansible-base 2.10 中添加	要使用的 CA 证书包的文件系统路径字符串配置 INI 条目 [url_lookup] ca_path = VALUE 环境变量：`ANSIBLE_LOOKUP_URL_CA_PATH` 变量：ansible_lookup_url_ca_path
ciphers 列表 / 元素=字符串在 ansible-core 2.14 中添加	用于请求的 SSL/TLS 密码当提供列表时，所有密码按顺序用 `:` 连接有关更多详细信息，请参阅OpenSSL 密码列表格式。可用密码取决于 Python 和 OpenSSL/LibreSSL 版本配置 INI 条目 [url_lookup] ciphers = VALUE 环境变量：`ANSIBLE_LOOKUP_URL_CIPHERS` 变量：ansible_lookup_url_ciphers
follow_redirects 字符串在 ansible-base 2.10 中添加	urllib2、all/yes、safe、none 的字符串，用于确定如何跟踪重定向选项 `"all"`：将跟踪所有重定向。 `"no"`：（已弃用，将在未来版本中删除）`none` 的别名。 `"none"`：不会跟踪任何重定向。 `"safe"`：仅会跟踪执行 GET 或 HEAD 请求的重定向。 `"urllib2"` (默认)：遵从 urllib2 行为（在编写本文时，这会跟踪 HTTP 重定向）。 `"yes"`：（已弃用，将在未来版本中删除）`all` 的别名。配置 INI 条目 [url_lookup] follow_redirects = urllib2 环境变量：`ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS` 变量：ansible_lookup_url_follow_redirects
force 布尔值在 ansible-base 2.10 中添加	是否使用值“no-cache”设置“cache-control”标头选项 `false` ← (默认) `true` 配置 INI 条目 [url_lookup] force = false 环境变量：`ANSIBLE_LOOKUP_URL_FORCE` 变量：ansible_lookup_url_force
force_basic_auth 布尔值在 ansible-base 2.10 中添加	强制基本身份验证选项 `false` ← (默认) `true` 配置 INI 条目 [url_lookup] force_basic_auth = false 环境变量：`ANSIBLE_LOOKUP_URL_FORCE_BASIC_AUTH` 变量：ansible_lookup_url_force_basic_auth
headers 字典在 Ansible 2.9 中添加	HTTP 请求标头默认值： `{}`
http_agent 字符串在 ansible-base 2.10 中添加	要在请求中使用的 User-Agent。默认值在 2.11 中更改为 `ansible-httpget`。默认值： `"ansible-httpget"` 配置 INI 条目 [url_lookup] agent = ansible-httpget 环境变量： `ANSIBLE_LOOKUP_URL_AGENT` 变量： ansible_lookup_url_agent
password 字符串在 Ansible 2.8 中添加	用于 HTTP 身份验证的密码。
split_lines 布尔值	控制内容是作为行列表返回还是作为单个文本块返回的标志选项 `false` `true` ← （默认）
timeout float 在 ansible-base 2.10 中添加	服务器在放弃之前等待发送数据的时间默认值： `10.0` 配置 INI 条目 [url_lookup] timeout = 10.0 环境变量： `ANSIBLE_LOOKUP_URL_TIMEOUT` 变量： ansible_lookup_url_timeout
unix_socket 字符串在 ansible-base 2.10 中添加	用于建立与提供的 URL 连接的 Unix 套接字文件系统路径字符串配置 INI 条目 [url_lookup] unix_socket = VALUE 环境变量： `ANSIBLE_LOOKUP_URL_UNIX_SOCKET` 变量： ansible_lookup_url_unix_socket
unredirected_headers 列表 / 元素=字符串在 ansible-base 2.10 中添加	在重定向请求时不附加的标头列表配置 INI 条目 [url_lookup] unredirected_headers = VALUE 环境变量： `ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS` 变量： ansible_lookup_url_unredir_headers
use_gssapi 布尔值在 ansible-base 2.10 中添加	使用请求的 GSSAPI 处理程序从 Ansible 2.11 开始，可以使用 `username` 和 `password` 来指定 GSSAPI 凭据。选项 `false` ← (默认) `true` 配置 INI 条目 [url_lookup] use_gssapi = false 环境变量： `ANSIBLE_LOOKUP_URL_USE_GSSAPI` 变量： ansible_lookup_url_use_gssapi
use_netrc 布尔值在 ansible-core 2.14 中添加	确定是否使用来自 ``~/.netrc`` 文件的凭据默认情况下，.netrc 与基本身份验证标头一起使用设置为 False 时，将忽略 .netrc 凭据选项 `false` `true` ← （默认）配置 INI 条目 [url_lookup] use_netrc = true 环境变量： `ANSIBLE_LOOKUP_URL_USE_NETRC` 变量： ansible_lookup_url_use_netrc
use_proxy 布尔值	一个标志，用于控制查找在存在 HTTP 代理环境变量时是否会观察它们。选项 `false` `true` ← （默认）
username 字符串在 Ansible 2.8 中添加	用于 HTTP 身份验证的用户名。
validate_certs 布尔值	控制 SSL 证书验证的标志选项 `false` `true` ← （默认）

注释 

注意

当关键字和位置参数一起使用时，位置参数必须在关键字参数之前列出：lookup('ansible.builtin.url', term1, term2, key1=value1, key2=value2) 和 query('ansible.builtin.url', term1, term2, key1=value1, key2=value2)

示例 

- name: url lookup splits lines by default
  ansible.builtin.debug: msg="{{item}}"
  loop: "{{ lookup('ansible.builtin.url', 'https://github.com/gremlin.keys', wantlist=True) }}"

- name: display ip ranges
  ansible.builtin.debug: msg="{{ lookup('ansible.builtin.url', 'https://ip-ranges.amazonaws.com/ip-ranges.json', split_lines=False) }}"

- name: url lookup using authentication
  ansible.builtin.debug: msg="{{ lookup('ansible.builtin.url', 'https://some.private.site.com/file.txt', username='bob', password='hunter2') }}"

- name: url lookup using basic authentication
  ansible.builtin.debug:
    msg: "{{ lookup('ansible.builtin.url', 'https://some.private.site.com/file.txt', username='bob', password='hunter2', force_basic_auth='True') }}"

- name: url lookup using headers
  ansible.builtin.debug:
    msg: "{{ lookup('ansible.builtin.url', 'https://some.private.site.com/api/service', headers={'header1':'value1', 'header2':'value2'} ) }}"

返回值 

键	描述
返回值列表 / 元素=字符串	URL 的行列表或内容列表返回：成功

作者

Brian Coca (@bcoca)

提示

每个条目类型的配置条目都有一个从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。