Topology diagrams
Ask Claude for a diagram and it draws your switches, APs and the links between them as a Mermaid flowchart, built from the inventory. Each pair of linked devices gets one edge labelled with its port pairs. Down links are dotted and down devices are outlined in red. Claude shows it in the chat as a Mermaid block.
Diagrams are Claude-only: there is no diagram page on the dashboard. Any role can ask for one.
How do I get one?
Section titled “How do I get one?”Ask, for example “Draw the network for Hall B” or “Show switch
IDF-3 and what is plugged into it.” Claude calls inventory.diagram with these
options:
| Option | Default | Meaning |
|---|---|---|
within | The whole organisation | A domain, zone, AP group, switch group or location, or one switch or AP (it and its links). A bare MAC works |
tags | none | Only devices with these tags |
status | none | Only devices in this state, e.g. Offline |
groupBy | container | container (domain › zone › AP group, and switch group), location, or none |
collapse | auto | Fold APs into one node per switch: auto (above collapseOver), always or never |
collapseOver | 40 | APs in scope before auto folds them (1 to 2,000) |
limit | 300 | Devices drawn at most (1 to 2,000) |
mesh | true | Caption mesh APs with their role and hop (one controller read) |
What does the diagram show?
Section titled “What does the diagram show?”| Element | Drawn as |
|---|---|
| Switch | A box |
| AP | A rounded box |
| Another device seen over LLDP | A hexagon labelled LLDP neighbour, with a dashed outline |
| Link | One edge per pair of linked devices, labelled with up to two port pairs such as 1/1/49 — 1/1/50 (then +N for more), a LAG’s name first |
| Link that is down | A dotted edge: its port, or either end, is down |
| Device that is down | Outlined in red, dashed, with its status under its name |
| Managed device outside the scope that a link reaches | In an Outside the scope group, with a dashed outline |
| Groups | Nested by container (or location), stopping below the scope |
When there are more than 40 APs (with collapse: 'auto'), the APs fold into
one rounded node per switch they hang off, captioned with how many there are and
how many are down (12 APs, 1 down), and its edge is labelled with the number
of links. A folded node is drawn down only when all its APs are, and its link
only when every member link is down. Folded APs with no reported link show
no link reported.
What are mesh captions?
Section titled “What are mesh captions?”Mesh APs are labelled with their role and hop, such as mesh AP, hop 2,
from one POST /query/mesh/topology read. Mesh uplinks are not drawn, because
SmartZone doesn’t say which AP is the uplink. If that read fails, the diagram
is still drawn without the captions, and the result carries meshError:
POST /query/mesh/topology answered <status>; mesh roles left out. Pass
mesh: false to skip the read.
What if the network is too big?
Section titled “What if the network is too big?”The diagram stops at limit devices (300 by default, up to 2,000) and the
result says truncated. Narrow it with within, tags or status, or let the
APs fold. These answers mean nothing was drawn:
| Result | Meaning |
|---|---|
| ”The inventory is empty: run inventory.sync() first.” | No sync has run |
| ”No switches or APs match that scope.” | The scope or filters matched nothing |
No entity or location … Use find({ text }) or locations() for ids. | The within id doesn’t exist |