eos_cli_config_gen¶
Overview¶
eos_cli_config_gen, is a role that generates eos cli syntax and device documentation.
The eos_cli_config_gen role:
- Designed to generate the intended configuration offline, without relying on switch current state information.
- Facilitates the evaluation of the configuration prior to deployment with tools like Batfish
- Facilitates the evaluation of the configuration post deployment with eos_validate_state role.
Role Inputs and Outputs¶
Figure 1 below provides a visualization of the roles inputs, and outputs and tasks in order executed by the role.
Inputs:
- Structured EOS configuration according to supported data models.
Outputs:
- EOS configuration in CLI format.
- Device Documentation in Markdown format.
Tasks:
- Import device structured configuration from YAML file unless
structured_config
flag is set byeos_designs
. - Generate EOS configuration in CLI format.
- Generate Device Documentation in Markdown format.
Requirements¶
Requirements are located in the collection installation guide
Input Variables¶
The input variables are documented in the Input Variables section.
Role Configuration¶
The role configuration variables are documented in the Role Configuration section.
Role configuration settings can be set either as regular inventory variables or directly as task_vars on the import_role
task.
License¶
Project is published under Apache 2.0 License
Last update:
June 13, 2023