diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md new file mode 100644 index 00000000000..b333e81bffb --- /dev/null +++ b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md @@ -0,0 +1,44 @@ + + +# Custom Templates + +With Custom Templates for the `eos_cli_config_gen` role, the user can create additional CLI configurations for features not covered by the built-in templates. + +## Create a Custom Template + +Custom templates should be written in Jinja2. + +For details on how to create Jinja2 templates, see [Templating Jinja2](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_templating.html#templating-jinja2). + +Custom templates can utilize variables defined by all the AVD variable definition mechanisms. For more details, see the explanation in [Custom Structured Configuration](../../../eos_designs/docs/how-to/custom-structured-configuration.md). + +Suppose the required variable is not available by any of these mechanisms. In that case, it can be defined using a custom template in the `eos_designs` role. For more details see [Custom Templates for eos_designs](../../../eos_designs/docs/how-to/custom-templates.md). + +At runtime, `eos_cli_config_gen` searches for custom templates in the following location, therefore, custom templates should be saved here: + +```text +/playbooks/templates/