Ansible 社区文档

ansible.builtin.debug 模块 – 执行期间打印语句

注意

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

概要 

此模块在执行期间打印语句，可用于调试变量或表达式，而无需停止 playbook。
与 ‘when:’ 指令一起调试非常有用。
此模块还支持 Windows 目标。

注意

此模块具有相应的操作插件。

参数 

参数	注释
msg 字符串	打印的自定义消息。如果省略，则打印通用消息。默认值： `"Hello world!"`
var 字符串	要调试的变量名称。与 `msg` 选项互斥。请注意，此选项已在 Jinja2 上下文中运行，并具有隐式的 `{{ }}` 包裹，因此除非您正在寻找双重插值，否则不应使用 Jinja2 分隔符。
verbosity 整数	一个数字，用于控制何时运行调试，如果您设置为 3，则只有在 -vvv 或更高版本时才会运行调试。默认值： `0`

属性 

属性	支持	描述
action	支持：完全	表示它具有相应的操作插件，因此某些选项的部分可以在控制器上执行
async	支持：无	支持与 `async` 关键字一起使用
become	支持：无	可与 become 关键字一起使用
bypass_host_loop	支持：无	强制执行不按主机执行的“全局”任务，这会绕过按主机模板化以及串行、节流和其他循环考虑因素条件语句的工作方式与使用 `run_once` 类似，使用的变量将来自第一个可用的主机此操作在锁定步骤策略之外通常不起作用
check_mode	支持：完全	可以在 check_mode 中运行并返回已更改状态预测，而无需修改目标，如果不支持，则将跳过该操作。
connection	支持：无	使用目标配置的连接信息在其上执行代码
delegation	支持：部分除了 `register` 和/或与 `delegate_facts` 结合使用外，它几乎没有效果。	可以与 delegate_to 和相关关键字结合使用
diff_mode	支持：无	在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息
platform	平台：全部	可以对其进行操作的目标操作系统/系列

另请参阅 

另请参阅

ansible.builtin.assert: 断言给定表达式为 true。
ansible.builtin.fail: 使用自定义消息失败。

示例 

- name: Print the gateway for each host when defined
  ansible.builtin.debug:
    msg: System {{ inventory_hostname }} has gateway {{ ansible_default_ipv4.gateway }}
  when: ansible_default_ipv4.gateway is defined

- name: Get uptime information
  ansible.builtin.shell: /usr/bin/uptime
  register: result

- name: Print return information from the previous task
  ansible.builtin.debug:
    var: result
    verbosity: 2

- name: Display all variables/facts known for a host
  ansible.builtin.debug:
    var: hostvars[inventory_hostname]
    verbosity: 4

- name: Prints two lines of messages, but only if there is an environment value set
  ansible.builtin.debug:
    msg:
    - "Provisioning based on YOUR_KEY which is: {{ lookup('ansible.builtin.env', 'YOUR_KEY') }}"
    - "These servers were built using the password of '{{ password_used }}'. Please retain this for later use."

作者

Dag Wieers (@dagwieers)
Michael DeHaan

集合链接