fail

Модуль ansible.builtin.fail используется для завершения выполнения задачи с выводом сообщения об ошибке.

Особенности работы

Особенности использования модуля ansible.builtin.fail:

• модуль завершает выполнение задачи с ошибкой, возвращая сообщение пользователю;

• может использоваться вместе с условием when;

• поддерживается на всех целевых узлах, включая Windows.

Параметры

Модуль принимает следующие параметры:

msg

Сообщение, которое будет выведено при завершении задачи с ошибкой.

Значение по умолчанию: Failed as requested from task.

Атрибуты

Атрибуты определяют функции Ansible, которые может использовать модуль.

Атрибут	Описание
action	Модуль имеет соответствующее расширение действия (action plugin), которое выполняет работу на управляющем узле.
async	Модуль не поддерживает асинхронное выполнение.
become	Модуль не поддерживает повышение привилегий.
bypass_host_loop	Модуль не поддерживает глобальное выполнение задачи.
check_mode	Модуль работает в режиме проверки (check_mode) в полном объеме. Режим проверки позволяет узнать, будет ли выполнение прервано при заданных условиях.
connection	Модуль не использует информацию о настройках подключения к целевому узлу при выполнении заданий на нем.
delegation	Модуль частично поддерживает delegate_to. Помимо register или в сочетании с delegate_facts это не имеет значительного эффекта.
diff_mode	Модуль не поддерживает режим сравнения (diff_mode).
platform	Модуль поддерживает все платформы.

Пример

Следующий пример описывает завершение выполнения задачи по условию:

---
- name: Checking the system status
  ansible.builtin.fail:
    msg: "The system is not prepared according to the CMDB status."
  when: cmdb_status != "to-be-staged"