Ansible Core 文档

ansible.builtin.assert 模块 – 断言给定表达式为真

注意

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

概要 

此模块断言给定表达式为真，并带有可选的自定义消息。
Windows 目标也支持此模块。

注意

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

参数 

参数	注释
fail_msg 别名：msg 字符串在 Ansible 2.7 中添加	用于断言失败的自定义消息。此参数在 Ansible 2.7 之前称为 `msg`，现在重命名为 `fail_msg`，别名为 `msg`。
quiet 布尔值在 Ansible 2.8 中添加	将此设置为 `true` 以避免详细输出。选项 `false` ← (默认) `true`
success_msg 字符串在 Ansible 2.7 中添加	用于断言成功的自定义消息。
that 列表 / 元素=字符串 / 必需	可以传递给 `when` 语句的相同形式的字符串表达式列表。

属性 

属性	支持	描述
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.debug: 执行期间打印语句。
ansible.builtin.fail: 使用自定义消息失败。
ansible.builtin.meta: 执行 Ansible“操作”。

示例 

- name: A single condition can be supplied as string instead of list
  ansible.builtin.assert:
    that: "ansible_os_family != 'RedHat'"

- name: Use yaml multiline strings to ease escaping
  ansible.builtin.assert:
    that:
      - "'foo' in some_command_result.stdout"
      - number_of_the_counting == 3
      - >
        "reject" not in some_command_result.stderr

- name: After version 2.7 both O(msg) and O(fail_msg) can customize failing assertion message
  ansible.builtin.assert:
    that:
      - my_param <= 100
      - my_param >= 0
    fail_msg: "'my_param' must be between 0 and 100"
    success_msg: "'my_param' is between 0 and 100"

- name: Please use O(msg) when ansible version is smaller than 2.7
  ansible.builtin.assert:
    that:
      - my_param <= 100
      - my_param >= 0
    msg: "'my_param' must be between 0 and 100"

- name: Use quiet to avoid verbose output
  ansible.builtin.assert:
    that:
      - my_param <= 100
      - my_param >= 0
    quiet: true

作者

Ansible Core 团队
Michael DeHaan

集合链接