ansible.utils.validate – Проверка данных по заданным критериям

Примечание

Этот плагин входит в коллекцию ansible.utils (версия 2.0.0).

Для его установки используйте: ansible-galaxy collection install ansible.utils.

Для использования в книге задач укажите: ansible.utils.validate.

Новое в версии 1.0.0: из ansible.utils

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Проверка данных по заданным критериям на основе движка проверки.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
criteria сырые / обязательные		Критерии, используемые для проверки значения, представляющего данные варианты. Этот параметр представляет собой второй аргумент, переданный в плагин поиска. Например `lookup(config_data, config_criteria, engine='ansible.utils.jsonschema'`), в этом случае значение `config_criteria` представляет этот параметр. Тип критериев, представляющих это значение, см. в документации отдельных плагинов проверки.
data сырые / обязательные		Данные, которые будут проверены по критериям. Этот параметр представляет значение, переданное плагину поиска в качестве первого аргумента. Например `lookup(config_data, config_criteria, engine='ansible.utils.jsonschema'`), в этом случае `config_data` представляет этот параметр. Тип данных, представляющих это значение, см. в документации отдельных плагинов проверки.
engine строка	Значение по умолчанию: "ansible.utils.jsonschema"	Имя плагина проверки, который нужно использовать. Этот параметр можно передать в плагин поиска как пару ключ-значение. Например `lookup(config_data, config_criteria, engine='ansible.utils.jsonschema'`), в этом случае значение `ansible.utils.jsonschema` представляет движок, который будет использоваться для проверки данных. Если значение не указано, будет использовано значение по умолчанию `ansible.uitls.jsonschema`. Значение должно быть в формате полностью квалифицированного имени коллекции, то есть `<org-name>.<collection-name>.<validate-plugin-name>`.

Примечания

Примечание

Тип параметров данные и критерии см. в документации отдельных плагинов проверки, представленных в значении параметра engine.
Дополнительные параметры настройки плагина см. в документации отдельного плагина проверки, представленного значением параметра engine.
Параметр настройки плагина можно передать либо как пары key=value в плагине поиска или задаче или переменные окружения.
Приоритет параметра настройки плагина проверки — переменная, переданная в плагине поиска как key=value пары, за ней следуют переменные задачи, а затем переменные окружения.

Примеры

- 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 json format using jsonschema with lookup plugin by passing plugin configuration variable as key/value pairs
  ansible.builtin.set_fact:
    data_criteria_checks: "{{ lookup(data, criteria, engine='ansible.utils.jsonschema', draft='draft7') }}"

- name: validate data in json format using jsonschema with lookup plugin by passing plugin configuration variable as task variable
  ansible.builtin.set_fact:
    data_criteria_checks: "{{ lookup('ansible.utils.validate', data, criteria, engine='ansible.utils.jsonschema', draft='draft7') }}"
  vars:
    ansible_validate_jsonschema_draft: draft3

Возвращаемые значения

Общие значения возврата описаны в здесь, следующие поля уникальны для этого плагина поиска:

Ключ	Возвращаемое значение	Описание
_raw строка	успех	Если данные верны, возвращает пустой список. Если данные неверны, возвращает список ошибок в данных.

Авторы

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_lookup.html