ansible.builtin.config 查找 – 显示“已解析”的 Ansible 选项值。

注意

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

概要

  • 检索 Ansible 配置设置的值，解析来自默认值、ansible.cfg、环境、CLI 和变量的所有来源，但不包括关键字。

  • 返回的值假定当前主机或 inventory_hostname 的上下文。

  • 您可以使用 ansible-config list 来查看全局可用设置，添加 -t all 以同时显示插件选项。

术语

参数

注释

术语

字符串 / 必需

要查找的选项。

关键字参数

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

参数

注释

on_missing

字符串

如果配置中缺少术语，则采取的操作

选项

  • "error" （默认）：发出错误消息并引发致命信号

  • "skip"：静默忽略

  • "warn"：发出警告消息并继续

plugin_name

字符串

在 ansible-core 2.12 中添加

要为其检索配置设置的插件的名称。

plugin_type

字符串

在 ansible-core 2.12 中添加

由“plugin_name”选项引用的插件的类型。

选项

  • "become"

  • "cache"

  • "callback"

  • "cliconf"

  • "connection"

  • "httpapi"

  • "inventory"

  • "lookup"

  • "netconf"

  • "shell"

  • "vars"

show_origin

布尔值

在 ansible-core 2.16 中添加

设置此选项以返回该值来自哪个配置子系统（默认值、配置文件、环境、CLI 或变量）。

选项

  • false

  • true

备注

注意

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

  • 请注意，目前此查找无法考虑关键字或委派，因此对于支持关键字或受委派影响的选项，这最多只是一个很好的猜测或近似值。

示例

- name: Show configured default become user
  ansible.builtin.debug: msg="{{ lookup('ansible.builtin.config', 'DEFAULT_BECOME_USER')}}"

- name: print out role paths
  ansible.builtin.debug:
    msg: "These are the configured role paths: {{lookup('ansible.builtin.config', 'DEFAULT_ROLES_PATH')}}"

- name: find retry files, skip if missing that key
  ansible.builtin.find:
    paths: "{{lookup('ansible.builtin.config', 'RETRY_FILES_SAVE_PATH')|default(playbook_dir, True)}}"
    patterns: "*.retry"

- name: see the colors
  ansible.builtin.debug: msg="{{item}}"
  loop: "{{lookup('ansible.builtin.config', 'COLOR_OK', 'COLOR_CHANGED', 'COLOR_SKIP', wantlist=True)}}"

- name: skip if bad value in var
  ansible.builtin.debug: msg="{{ lookup('ansible.builtin.config', config_in_var, on_missing='skip')}}"
  var:
    config_in_var: UNKNOWN

- name: show remote user and port for ssh connection
  ansible.builtin.debug: msg={{q("ansible.builtin.config", "remote_user", "port", plugin_type="connection", plugin_name="ssh", on_missing='skip')}}

- name: show remote_tmp setting for shell (sh) plugin
  ansible.builtin.debug: msg={{q("ansible.builtin.config", "remote_tmp", plugin_type="shell", plugin_name="sh")}}

返回值

键

描述

返回值

任何

如果 show_origin 为 false（默认值），则配置中键的值的列表

或者，如果 show_origin 为 true，则为包含 2 个元素列表（值、来源）的列表

返回: 成功

作者

  • Ansible Core 团队

提示

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