docs: Fixed validate lookup plugin and module filter examples in document (#325)
* fix validate examples * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>pull/323/head^2
parent
6842746a9d
commit
259cb8b9e4
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
doc_changes:
|
||||
- validate lookup plugin - Fix syntax in EXAMPLES.
|
||||
- validate module - Fix syntax in EXAMPLES.
|
|
@ -116,12 +116,12 @@ Examples
|
|||
|
||||
- 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')}}"
|
||||
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') }}"
|
||||
data_criteria_checks: "{{ lookup('ansible.utils.validate', 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:
|
||||
|
|
|
@ -103,8 +103,8 @@ Examples
|
|||
|
||||
- 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')}}"
|
||||
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:
|
||||
|
@ -116,8 +116,8 @@ Examples
|
|||
|
||||
- name: validate configuration with config plugin (see config plugin for criteria examples)
|
||||
ansible.utils.validate:
|
||||
data: "{{ lookup('ansible.builtin.file', './backup/eos.config' }}"
|
||||
criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml' }}"
|
||||
data: "{{ lookup('ansible.builtin.file', './backup/eos.config') }}"
|
||||
criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml') }}"
|
||||
engine: ansible.utils.config
|
||||
|
||||
|
||||
|
|
|
@ -60,12 +60,12 @@ DOCUMENTATION = """
|
|||
EXAMPLES = r"""
|
||||
- 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')}}"
|
||||
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') }}"
|
||||
data_criteria_checks: "{{ lookup('ansible.utils.validate', 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:
|
||||
|
|
|
@ -52,8 +52,8 @@ notes:
|
|||
EXAMPLES = r"""
|
||||
- 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')}}"
|
||||
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:
|
||||
|
@ -65,8 +65,8 @@ EXAMPLES = r"""
|
|||
|
||||
- name: validate configuration with config plugin (see config plugin for criteria examples)
|
||||
ansible.utils.validate:
|
||||
data: "{{ lookup('ansible.builtin.file', './backup/eos.config' }}"
|
||||
criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml' }}"
|
||||
data: "{{ lookup('ansible.builtin.file', './backup/eos.config') }}"
|
||||
criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml') }}"
|
||||
engine: ansible.utils.config
|
||||
"""
|
||||
|
||||
|
|
Loading…
Reference in New Issue