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

Примечание

Этот модуль входит в ansible-core и включен во все установки Ansible. В большинстве случаев можно использовать краткое имя модуля fail, не указывая ключевое слово collections. Тем не менее рекомендуем использовать полное имя коллекции (FQCN) ansible.builtin.fail, чтобы упростить переход к документации модуля и избежать конфликтов с другими коллекциями, в которых может быть модуль с таким же именем.

Краткое описание
Параметры
Атрибуты
См. также
Примеры

Краткое описание

Этот модуль прерывает выполнение и выводит пользовательское сообщение.
Модуль может быть полезен для досрочного завершения выполнения при наступлении определенного условия с помощью when.
Этот модуль также поддерживается для целевых узлов Windows.

Примечание

Этому модулю соответствует плагин действий.

Параметры

Параметр	Комментарии
msg string	Пользовательское сообщение, выводимое при прерывании выполнения. Если параметр не указан, fail просто прервет выполнение с общим сообщением. По умолчанию: `"Failed as requested from task"`

Атрибуты

Атрибут	Поддержка	Описание
action	Поддержка: полная	Указывает, что этому модулю соответствует плагин действий, поэтому некоторые параметры можно обработать на управляющем узле
async	Поддержка: нет	Поддерживает использование с ключевым словом `async`
become	Поддержка: нет	Можно использовать вместе с ключевыми словами become
bypass_host_loop	Поддержка: нет	Принудительно выполняет «глобальную» задачу, которая запускается не для каждого узла; при этом обходятся шаблонизация для каждого узла, serial, throttle и другие параметры циклов Условия будут работать так, как если бы использовалось `run_once`; переменные будут взяты с первого доступного узла Это действие обычно не работает вне стратегий синхронного выполнения
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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ansible/builtin/fail_module.html