eos_designs_documentation¶
Note
Always use the FQCN (Fully Qualified Collection Name) arista.avd.eos_designs_documentation
when using this plugin.
Generate AVD Fabric Documentation
Synopsis¶
The arista.avd.eos_designs_documentation
module is an Ansible Action Plugin providing the following capabilities:
- Generate fabric documentation using AVD facts and structured configuration files.
- Optionally include connected endpoints documentation.
Parameters¶
Argument | Type | Required | Default | Value Restrictions | Description |
---|---|---|---|---|---|
structured_config_dir | str | True | None | Path to directory containing files with AVD structured configurations. | |
structured_config_suffix | str | optional | yml | File suffix for AVD structured configuration files. | |
fabric_documentation_file | str | True | None | Path to output Markdown file. | |
mode | str | optional | 0o664 | Mode of output files. | |
fabric_documentation | bool | optional | True | Generate fabric documentation. | |
include_connected_endpoints | bool | optional | False | Include connected endpoints in fabric documentation. | |
topology_csv_file | str | True | None | Path to output topology CSV file. | |
topology_csv | bool | optional | False | Generate Topology CSV with all interfaces towards other devices. | |
p2p_links_csv_file | str | True | None | Path to output P2P links CSV file. | |
p2p_links_csv | bool | optional | False | Generate P2P links CSV with all routed point-to-point links between devices. |
Examples¶
---
- name: Generate fabric documentation
arista.avd.eos_designs_documentation:
structured_config_dir: "{{ structured_dir }}"
structured_config_suffix: "{{ avd_structured_config_file_format }}"
fabric_documentation_file: "{{ fabric_dir }}/{{ fabric_name }}-documentation.md"
fabric_documentation: "{{ eos_designs_documentation.enable | arista.avd.default(true) }}"
include_connected_endpoints: "{{ eos_designs_documentation.connected_endpoints | arista.avd.default(false) }}"
topology_csv_file: "{{ fabric_dir }}/{{ fabric_name }}-topology.csv"
topology_csv: "{{ eos_designs_documentation.topology_csv | arista.avd.default(true) }}"
p2p_links_csv_file: "{{ fabric_dir }}/{{ fabric_name }}-topology.csv"
p2p_links_csv: "{{ eos_designs_documentation.p2p_links_csv | arista.avd.default(true) }}"
mode: "0o664"
delegate_to: localhost
check_mode: false
run_once: true
Authors¶
- Arista Ansible Team (@aristanetworks)