ansible.builtin.fail – Отказ с пользовательским сообщением

Примечание

Этот модуль входит в состав ansible-base и включен во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля fail даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя FQCN для удобной ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.

Новое в версии 0.8: из ansible.builtin

Обзор
Параметры
Примечания
См. также
Примеры

Обзор

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

Примечание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
msg строка	Значение по умолчанию: "Выполнение прервано заданием"	Пользовательское сообщение, используемое для прерывания выполнения. Если опущено, модуль завершит работу с общим сообщением.

Примечания

Примечание

Этот модуль также поддерживается для целевых систем Windows.

См. также

ansible.builtin.assert: Официальная документация модуля ansible.builtin.assert.
ansible.builtin.debug: Официальная документация модуля ansible.builtin.debug.
ansible.builtin.meta: Официальная документация модуля ansible.builtin.meta.

Примеры

- name: Example using fail and when together
  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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/fail_module.html