ansible.builtin.assert – Утверждает, что заданные выражения истинны
Примечание
Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля assert, даже не указывая collections: ключевое слово. Несмотря на это, мы рекомендуем использовать FQCN для лёгкой ссылки на документацию по модулю и для избежания конфликтов с другими коллекциями, которые могут иметь то же имя модуля.
Новое в версии 1.5: of ansible.builtin
Описание
- Этот модуль утверждает, что заданные выражения истинны с необязательным пользовательским сообщением.
- Этот модуль также поддерживается для целевых платформ Windows.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| fail_msg строка добавлено в 2.7 of ansible.builtin | Настраиваемое сообщение, используемое для неудачного утверждения. Этот аргумент назывался 'msg' до Ansible 2.7, теперь он переименован в 'fail_msg' с псевдонимом 'msg'. псевдонимы: msg | |
| quiet логическое добавлено в 2.8 of ansible.builtin |
| Установите это в yes чтобы избежать подробного вывода. |
| success_msg строка добавлено в 2.7 of ansible.builtin | Настраиваемое сообщение, используемое для успешного утверждения. | |
| that список / элементы=строка / обязательно | Список строковых выражений одного и того же формата, которые могут быть переданы в утверждение 'when'. |
Примечания
Примечание
- Этот модуль также поддерживается для целевых платформ Windows.
См. также
См. также
- ansible.builtin.debug
-
Официальная документация по модулю ansible.builtin.debug.
- ansible.builtin.fail
-
Официальная документация по модулю ansible.builtin.fail.
- ansible.builtin.meta
-
Официальная документация по модулю ansible.builtin.meta.
Примеры
- assert: { that: "ansible_os_family != 'RedHat'" }
- assert:
that:
- "'foo' in some_command_result.stdout"
- number_of_the_counting == 3
- name: After version 2.7 both 'msg' and 'fail_msg' can customize failing assertion message
assert:
that:
- my_param <= 100
- my_param >= 0
fail_msg: "'my_param' must be between 0 and 100"
success_msg: "'my_param' is between 0 and 100"
- name: Please use 'msg' when ansible version is smaller than 2.7
assert:
that:
- my_param <= 100
- my_param >= 0
msg: "'my_param' must be between 0 and 100"
- name: Use quiet to avoid verbose output
assert:
that:
- my_param <= 100
- my_param >= 0
quiet: true
Авторы
- Команда Ansible Core
- Michael DeHaan
© 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/assert_module.html