查找插件
查找插件是 Ansible 对 Jinja2 模板语言的特定扩展。您可以使用查找插件在剧本中访问外部数据源（文件、数据库、键值存储、API 和其他服务）。与所有 模板 一样，查找在 Ansible 控制机器上执行和评估。Ansible 使用标准模板系统提供查找插件返回的数据。您可以使用查找插件从外部数据源加载变量或模板。您可以 创建自定义查找插件.
注意
查找的执行目录相对于角色或剧本，而本地任务的执行目录相对于执行的脚本。
将
wantlist=True传递给查找，以便在 Jinja2 模板“for”循环中使用。默认情况下，出于安全原因，查找返回值被标记为不安全。如果您信任查找访问的外部数据源，请传递
allow_unsafe=True以允许 Jinja2 模板评估查找值。
警告
某些查找将参数传递给 shell。当使用来自远程/不可信数据源的变量时，请使用 |quote 过滤器以确保安全使用。
启用查找插件
Ansible 会启用它能找到的所有查找插件。您可以通过将自定义查找放入与剧本相邻的 lookup_plugins 目录、已安装集合的 plugins/lookup/ 目录、独立角色或 ansible.cfg 中配置的查找目录源之一来激活自定义查找。
使用查找插件
您可以在 Ansible 中使用模板的任何地方使用查找插件：在剧本中、在变量文件中或 template 模块的 Jinja2 模板中。有关使用查找插件的更多信息，请参阅 查找.
vars:
file_contents: "{{ lookup('file', 'path/to/file.txt') }}"
查找是循环的组成部分。无论您看到哪里 with_，下划线后面的部分是查找的名称。因此，查找应该输出列表；例如，with_items 使用 items 查找
tasks:
- name: count to 3
debug: msg={{ item }}
with_items: [1, 2, 3]
您可以将查找与 过滤器、测试 甚至彼此结合起来，进行一些复杂的数据生成和操作。例如
tasks:
- name: Complicated chained lookups and filters
debug: msg="find the answer here:\n{{ lookup('url', 'https://google.com/search/?q=' + item|urlencode)|join(' ') }}"
with_nested:
- "{{ lookup('consul_kv', 'bcs/' + lookup('file', '/the/question') + ', host=localhost, port=2000')|shuffle }}"
- "{{ lookup('sequence', 'end=42 start=2 step=2')|map('log', 4)|list) }}"
- ['a', 'c', 'd', 'c']
版本 2.6 中的新功能。
您可以通过将 errors 设置为 ignore、warn 或 strict 来控制所有查找插件中的错误行为。默认设置为 strict，如果查找返回错误，则会导致任务失败。例如
要忽略查找错误
- name: if this file does not exist, I do not care .. file plugin itself warns anyway ...
debug: msg="{{ lookup('file', '/nosuchfile', errors='ignore') }}"
[WARNING]: Unable to find '/nosuchfile' in expected paths (use -vvvvv to see paths)
ok: [localhost] => {
"msg": ""
}
要获得警告而不是失败
- name: if this file does not exist, let me know, but continue
debug: msg="{{ lookup('file', '/nosuchfile', errors='warn') }}"
[WARNING]: Unable to find '/nosuchfile' in expected paths (use -vvvvv to see paths)
[WARNING]: An unhandled exception occurred while running the lookup plugin 'file'. Error was a <class 'ansible.errors.AnsibleError'>, original message: could not locate file in lookup: /nosuchfile
ok: [localhost] => {
"msg": ""
}
要获得致命错误（默认值）
- name: if this file does not exist, FAIL (this is the default)
debug: msg="{{ lookup('file', '/nosuchfile', errors='strict') }}"
[WARNING]: Unable to find '/nosuchfile' in expected paths (use -vvvvv to see paths)
fatal: [localhost]: FAILED! => {"msg": "An unhandled exception occurred while running the lookup plugin 'file'. Error was a <class 'ansible.errors.AnsibleError'>, original message: could not locate file in lookup: /nosuchfile"}
强制查找返回列表：query 和 wantlist=True
版本 2.5 中的新功能。
在 Ansible 2.5 中，添加了一个名为 query 的新 Jinja2 函数，用于调用查找插件。 lookup 和 query 之间的区别主要在于 query 将始终返回一个列表。 lookup 的默认行为是返回逗号分隔值的字符串。 lookup 可以使用 wantlist=True 显式配置为返回列表。
此功能为与新 loop 关键字交互提供了一个更简单、更一致的接口，同时保持与 lookup 其他用途的向后兼容性。
以下示例等效
lookup('dict', dict_variable, wantlist=True)
query('dict', dict_variable)
如上所示，使用 query 时，wantlist=True 的行为是隐式的。
此外，q 被引入作为 query 的简写形式
q('dict', dict_variable)
插件列表
您可以使用 ansible-doc -t lookup -l 来查看可用的插件列表。使用 ansible-doc -t lookup <plugin name> 来查看特定插件的文档和示例。