ansible.utils.validate – Валидация данных по предоставленным критериям
Примечание
Этот плагин входит в состав коллекции ansible.utils (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ansible.utils.
Чтобы использовать его в плейбуке, укажите: ansible.utils.validate.
Введено в версии 1.0.0: модуля ansible.utils
Описание
- Валидация данных по предоставленным критериям на основе механизма валидации.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
criteria
raw / required
|
Критерии, используемые для валидации данных. Тип критериев смотрите в документации отдельных плагинов валидации.
|
|
|
data
raw / required
|
Данные, которые будут валидированы по критериям. Тип данных смотрите в документации отдельных плагинов валидации.
|
|
|
engine
string
|
Значение по умолчанию: "ansible.utils.jsonschema" |
Имя плагина валидации для использования. Значение engine должно соответствовать формату полного имени коллекции, т.е. <имя_организации>.<имя_коллекции>.<имя_плагина_валидации>.
|
Примечания
Примечание
- Для типа параметров data и criteria смотрите документацию отдельных плагинов валидации, представленных в значении параметра engine.
- Для дополнительных параметров конфигурации плагина смотрите документацию отдельных плагинов валидации, представленных в значении параметра engine.
- Параметры конфигурации плагина могут быть переданы как переменные задачи или среды.
- Предпочтение при конфигурации плагина валидации отдается переменным задачи, а затем переменным среды.
Примеры
- name: set facts for data and criteria
ansible.builtin.set_fact:
data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json')}}"
criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json')}}"
- name: validate data in with jsonschema engine (by passing task vars as configurable plugin options)
ansible.utils.validate:
data: "{{ data }}"
criteria: "{{ criteria }}"
engine: ansible.utils.jsonschema
vars:
ansible_jsonschema_draft: draft7
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
|
errors
list / elements=string
|
при невалидном значении data | Список ошибок в data, основанный на criteria. |
|
msg
string
|
всегда |
Значение msg указывает, является ли data валидным по критериям.
В случае валидных данных возвращается сообщение об успехе all checks passed.
В случае невалидных данных возвращается сообщение об ошибке Validation errors were found, а также более подробная информация об ошибке.
|
Авторы
- Bradley Thornton (@cidrblock)
- Ganesh Nalawade (@ganeshrn)
© 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/utils/validate_module.html
