Chapter 9 Dynamic Intent-Based Documentation

For diagrams, tables, or exact code formatting, .

JOHN W. CAPOBIANCOPRINTED PAGE 166

VLANs were used as an example however it is possible to utilize the data dictionaries in the data model to manipulate the variables and template documentation files in Markdown format. A devices’ VLANs, VRFs, static routes, ACLS, software version, or whatever information is present in the data dictionaries, can be templated in these dynamic documentation files.

Execute Playbook – Documentation

Now execute the playbook. The documentation.yml file is completely non-intrusive and non- disruptive to the network. The ios_facts module will gather some information from the network. Otherwise everything in the documentation playbook is building offline automated documentation based on the intent files.

Check for Idempotency Checking for idempotency of the documentation is a quick and easy way to identify the changes being made to the data models or dynamic templates. If the output from the documentation playbook has