Skip to content

yaml_templates_to_facts

Note

Always use the FQCN (Fully Qualified Collection Name) arista.avd.yaml_templates_to_facts when using this plugin.

Set facts from YAML via Jinja2 templates

Synopsis

Set facts from YAML produced by Jinja2 templates

Parameters

Argument Type Required Default Value Restrictions Description
root_key str False None Root key under which the facts will be defined. If not set the facts well be set directly on root level.
schema dict False None Schema conforming to "AVD Meta Schema". Either schema or schema_id must be set.
schema_id str False None Valid values:
- eos_cli_config_gen
- eos_designs		 ID of Schema conforming to "AVD Meta Schema". Either schema or schema_id must be set.
templates list True None List of dicts for Jinja templates to be run.
    template str False None Template file. Either template or python_module must be set.
    python_module str False None Python module to import. Either template or python_module must be set.
    python_class_name str False AvdStructuredConfig Name of Python Class to import.
    options dict False None Template options.
        list_merge str False append Merge strategy for lists
        strip_empty_keys bool False True Filter out keys from the generated output if value is null/none/undefined. Only applies to templates.
debug bool False None Output list 'avd_yaml_templates_to_facts_debug' with timestamps of each performed action.
dest str False None Destination path. If set, the output facts will also be written to this path.
Autodetects data format based on file suffix. '.yml', '.yaml' -> YAML, default -> JSON
mode str False None File mode (ex. 0664) for dest file. See 'ansible.builtin.copy' module for details.
template_output bool False None If true, the output data will be run through another jinja2 rendering before returning.
This is to resolve any input values with inline jinja using variables/facts set by the input templates.
conversion_mode str False debug Valid values:
- error
- warning
- info
- debug
- quiet
- disabled		 Run data conversion in either "error", "warning", "info", "debug", "quiet" or "disabled" mode.
Conversion will perform type conversion of input variables as defined in the schema.
Conversion is intended to help the user to identify minor issues with the input data, while still allowing the data to be validated.
During conversion, messages will be generated with information about the host(s) and key(s) which required conversion.
conversion_mode:disabled means that conversion will not run.
conversion_mode:error will produce error messages and fail the task.
conversion_mode:warning will produce warning messages.
conversion_mode:info will produce regular log messages.
conversion_mode:debug will produce hidden messages viewable with -v.
conversion_mode:quiet will not produce any messages.
validation_mode str False warning Valid values:
- error
- warning
- info
- debug
- disabled		 Run validation in either "error", "warning", "info", "debug" or "disabled" mode.
Validation will validate the input variables according to the schema.
During validation, messages will be generated with information about the host(s) and key(s) which failed validation.
validation_mode:disabled means that validation will not run.
validation_mode:error will produce error messages and fail the task.
validation_mode:warning will produce warning messages.
validation_mode:info will produce regular log messages.
validation_mode:debug will produce hidden messages viewable with -v.
output_schema dict False None AVD Schema for output data. Used for automatic merge of data.
output_schema_id str False None Valid values:
- eos_cli_config_gen
- eos_designs		 ID of AVD Schema for output data. Used for automatic merge of data.
set_switch_fact bool False True Set "switch" fact from on "avd_switch_facts.<inventory_hostname>.switch"

Examples

---
- name: Generate device configuration in structured format
  arista.avd.yaml_templates_to_facts:
    root_key: structured_config
    templates:
      - python_module: "ansible_collections.arista.avd.roles.eos_designs.python_modules.base"
        python_class_name: "AvdStructuredConfig"
      - template: "mlag/main.j2"
      - template: "designs/underlay/main.j2"
      - template: "designs/overlay/main.j2"
      - template: "l3_edge/main.j2"
      - template: "designs/network_services/main.j2"
      - template: "connected_endpoints/main.j2"
      - template: "custom-structured-configuration-from-var.j2"
        options:
          list_merge: "{{ custom_structured_configuration_list_merge }}"
          strip_empty_keys: false
    schema_id: eos_designs
    output_schema_id: eos_cli_config_gen
  check_mode: no
  changed_when: False

Authors

  • EMEA AS Team (@aristanetworks)