Releases: CiscoDevNet/network-sketcher-cisco-extension
Release list
Ver 0.5
Network Sketcher Cisco Extension — bridge Cisco platforms to automatic network diagrams
Network Sketcher Cisco Extension is a growing collection of tools that turn
Cisco platform data into
Network Sketcher CLI commands,
so you can rebuild an accurate L1/L2/L3 topology — devices, links, VLANs, SVIs,
sub-interfaces, IP addressing and VRFs — in seconds instead of drawing it by
hand.
Important
The quality of each converted topology depends entirely on what data each
Cisco product is able to provide — whether obtained as a file export or
through a read-only API fetch. Because the available data rarely contains a
complete physical/logical inventory, the generated diagrams necessarily
include a significant amount of inference and synthesized structure.
Treat the output as a starting reference / first draft only — always
review and validate it against authoritative sources before relying on it.
Each converter has so far been validated against a limited number of
samples (sandbox/demo environments); we expect validation against further
real-world data to keep improving output quality.A feature to consolidate
the individual NSM master files each converter/mode currently requires
into a single unified master is still only at the planning stage
— it is not yet decided or scheduled for implementation.
Each tool targets a different data source, can be used independently, and the
conversion runs entirely on local files (no live platform connection is
needed at conversion time). aci_converter, catc_converter,
meraki_converter and nd_converter additionally ship a read-only REST API
fetch that pulls the model straight from the platform into that file; the
others read a file you export from the platform.
All tools are standalone Python CLIs. Most run on the Python standard library
alone — cml_converter needs PyYAML and netbox_converter needs networkx;
see each tool's folder README.md for its exact Python version and
dependencies.
Tools in this extension
The extension is a monorepo: each tool lives in its own sub-directory with its
own README.md and requirements.txt. The folder README.md holds the full
details — installation, usage, supported formats, options, and known issues.
The per-tool sections further down are only a short visual preview that links
to each. Tools are listed alphabetically.
| Product | Tool | What it does | Input | Status |
|---|---|---|---|---|
| Application Centric Infrastructure (ACI) | aci_converter |
Convert an APIC fabric into two diagrams: the physical underlay (spine/leaf/APIC) and the logical overlay (Tenant/VRF/BD/EPG + contracts). | APIC model via read-only REST API (fetch_from_apic) → JSON |
✅ Available |
| Catalyst Center | catc_converter |
Convert an SD-Access campus into two diagrams: the physical underlay (core/distribution/access) and the logical overlay (Virtual Network / anycast gateway). | Catalyst Center model via read-only Intent REST API (fetch_from_catc) → JSON |
✅ Available |
| Catalyst SD-WAN | — | Catalyst SD-WAN (formerly Cisco SD-WAN / Viptela) → Network Sketcher | — | 📋 Planning |
| Cisco Modeling Labs (CML) | cml_converter |
Convert a CML topology YAML (+ embedded running-configs) into Network Sketcher commands | CML lab YAML (local file) | ✅ Available |
| Cyber Vision | cv_converter |
Build an OT topology (Purdue / IEC 62443 / CPwE zones) from Cyber Vision asset + activity exports. | Cisco Cyber Vision networkNodes + activities CSV (local files) | ✅ Available |
| Meraki | meraki_converter |
Convert a Meraki organization into a Network Sketcher command script reconstructing L1/L2/L3. | Meraki org via read-only Dashboard API v1 (fetch_from_meraki) → JSON |
✅ Available |
| Nexus Dashboard | nd_converter |
Convert an NDFC VXLAN EVPN fabric into two diagrams: the physical underlay (leaf/spine/border) and the logical overlay (VRF / Network / anycast gateway). | NDFC model via read-only REST API (fetch_from_nd) → JSON |
✅ Available |
| Secure Network Analytics | sna_converter |
Reconstruct a multi-site L1/L2/L3 topology + endpoints from observed NetFlow. | Cisco SNA (Secure Network Analytics) Flow Search CSV (local file) | ✅ Available |
Each tool's section below shows a preview and links to its folder
README.md
for installation and usage. Every tool produces Network Sketcher CLI
commands, so the
"Running the output in Network Sketcher"
guidance applies to all of them.
Community / third-party converters
Tools that target a data source that is not a Cisco platform live under
3rd_party/ instead of the repository root, so they stay
clearly separated from the Cisco-platform tools above. They follow the same
conventions (own README.md + requirements.txt, local-file conversion,
Network Sketcher CLI command output).
| Product | Tool | What it does | Input | Status |
|---|---|---|---|---|
| NetBox | netbox_converter |
Convert a NetBox DCIM/IPAM instance into a Network Sketcher command script reconstructing L1/L2/L3, reusing the same placement logic as the Network Sketcher Offline edition's NetBox CSV import. | NetBox instance via read-only REST API (fetch_from_netbox) → JSON |
✅ Available |
template_converter — scaffold for building new converters
template_converter/ is not a converter itself — it is a copy-paste
starting point for building a new "Platform X → Network Sketcher"
converter (Cisco or third-party) when this repository's toolset needs to be
extended. It documents the architecture every converter here shares (which
files are copy-verbatim vs. platform-specific), the credential/security
conventions, and the README conventions used repo-wide.
It is written primarily for AI coding agents to read and follow
directly — every converter in this repo was itself built by an AI agent —
though it works equally well as a reference for a human contributor. The
command-generation logic it documents (ns_command_builder.py's Phase 1–6
ordering and the numbered RULE N constraints referenced throughout the
shared code) is grounded directly in Network Sketcher's own AI Context
export — the [AI_Context]<master>.txt file produced by the
network-sketcher MCP server (get_ai_context / build_default_outputs),
which documents the full CLI command reference and syntax rules.
See template_converter/GUIDE.md for the full
authoring guide.
Tool 1 — aci_converter
Convert a Cisco ACI fabric into two Network Sketcher diagrams — the physical
underlay (spine/leaf/border-leaf/APIC + observed LLDP cabling) and the
logical overlay (Tenant → VRF → Bridge Domain → EPG, with contracts as a
[Flow_List] traffic matrix) — from a model pulled over the APIC's
read-only REST API (fetch_from_apic).
Full documentation (installation, usage, the underlay/overlay model,
options, colour conventions, accuracy caveats, known issues) is in
aci_converter/README.md.
Tool 2 — catc_converter
Convert a Cisco Catalyst Center (formerly DNA Center) SD-Access campus into two
Network Sketcher diagrams — the physical underlay
(core/distribution/access/WLCs/APs + real observed cabling) and the logical
overlay (Virtual Network → anycast-gateway segments) — from a model pulled
over its read-only Intent REST API (fetch_from_catc).
Full documentation (installation, usage, the underlay/overlay model,
options, colour conventions, accuracy caveats, known issues) is in
catc_converter/README.md.
Tool 3 — cml_converter
Convert a Cisco Modeling Labs lab (topology YAML + any embedded
running-configs) into a ready-to-run Network Sketcher command script,
reconstructing L1/L2/L3 entirely from local files (no CML connectivity at
conversion time).
[L1L2L3_DIAGRAM]AllAreas_no_data_1.html
Full documentation (installation, usage, supported CML YAML formats, how
L2/L3 reconstruction works, output file list, known issues) is in
cml_converter/README.md.
Tool 4 — cv_converter
Build an OT network topology from Cisco Cyber Vision asset (`network...