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

Примечание

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

Добавлен в версии 0.8: of ansible.builtin

Описание
Параметры
Примечания
См. также
Примеры

Описание

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

Примечание

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

Параметры

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

Примечания

Примечание

Этот модуль также поддерживается для 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/fail_module.html