ansible.builtin.fail 模块 – 使用自定义消息失败

注意

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

概要

  • 此模块会使用自定义消息使进度失败。

  • 当使用 when 满足特定条件时，它可以用于中止。

  • Windows 目标也支持此模块。

注意

此模块具有相应的 action 插件。

参数

参数

注释

msg

字符串

用于使执行失败的自定义消息。

如果省略，fail 将仅使用通用消息退出。

默认值: "Failed as requested from task"

属性

属性

支持

描述

action

支持: 完全

指示此模块具有相应的 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

断言给定的表达式为真。

ansible.builtin.debug

在执行期间打印语句。

ansible.builtin.meta

执行 Ansible“操作”。

示例

- name: Example using fail and when together
  ansible.builtin.fail:
    msg: The system may not be provisioned according to the CMDB status.
  when: cmdb_status != "to-be-staged"

作者

  • Dag Wieers (@dagwieers)