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

注意

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

概要

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

  • 它可以用于使用 when 满足特定条件时退出。

  • 此模块也支持 Windows 目标。

注意

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

参数

参数

注释

msg

字符串

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

如果省略，fail 将简单地使用通用消息退出。

默认值： "Failed as requested from task"

属性

属性

支持

描述

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)