netbox-designs
Installation
SKILL.md
NetBox Designs
Your knowledge of NetBox Designs may be outdated. Designs is in preview on NetBox Cloud and its format, functions and limitations change between releases. Every docs page is also served as markdown — add
.mdto the page address — so read the reference before writing a design. Prefer retrieval over pre-trained knowledge.
Retrieval Sources
| Source | URL / Method | Use for |
|---|---|---|
| Design structure | https://netboxlabs.com/docs/designs/reference/design-structure.md |
Top-level keys, values and empty fields, references, matching |
| Object types & keys | https://netboxlabs.com/docs/designs/reference/object-types.md |
infra_type names and the key each type is matched by |
| Variables | https://netboxlabs.com/docs/designs/reference/variables.md |
$USER, $USER_OPTIONAL, defaults, computed values, template_vars |
| Expressions & loops | https://netboxlabs.com/docs/designs/reference/expressions.md |
{{ }} syntax, filters, nbd_loop |
| Functions | https://netboxlabs.com/docs/designs/reference/functions.md |
nbd.lookup.*, nbd.nbt.*, nbd.dtl.* |
| Composition | https://netboxlabs.com/docs/designs/reference/composition.md |
nbd: and dtl: references, pinning |
| Limitations | https://netboxlabs.com/docs/designs/reference/limitations.md |
What Designs doesn't do yet |
| Design JSON Schema | https://netboxlabs.com/docs/designs/reference/design.schema.json |
Structural validation in editors and tools |
| Read a plan | https://netboxlabs.com/docs/designs/how-to/read-a-plan.md |
Every warning and refusal a plan can produce |
| Device Type Library | https://github.com/netbox-community/devicetype-library |
Paths and commits for dtl: references |
| Example designs | https://netboxlabs.com/docs/designs/tutorial/the-compute-rack.md |
Canonical rack, device and site designs |