This is an original planning guide. It is not a vendor manual, an official standard, or legal advice. Example addresses use documentation ranges. Review every command before you paste it.
What this hour is for
NetBox holds prefixes, addresses, and device names. The CSV and API builders draft an import or a query. They do not change your network. The source of truth is useful when the plan and the devices are checked against it, not when a secret rides along in a column.
One site. Remove password columns, SNMP communities, and keys before the file is uploaded. A prefix in the import should be one you were assigned, not a documentation range dressed up as production.
The API token is prompt-for-this. A query that lists the world is a query you narrow to the site.
Config backups are a different store. Do not paste a full config into a comment field.
The change you can finish
Apply nothing during the writing of the note. When the lab window opens, it is one change on the device named in the ticket. Read the draft, then the device, then decide.
Rollback is the file or the revision you saved first. You do not invent a rollback after the only copy is gone.
- Name one site.
- Build the CSV from data you may hold.
- Delete secret columns.
- Reject documentation prefixes in the production column.
- Keep the token out of the note.
- Do not import a second site.
Mistakes that outlive the command
NetBox as a Source of Truth goes wrong in a small set of ways. The list is here so the ticket can forbid them before the window.
- A community string in the CSV.
- A documentation prefix marked production.
- A token in git.
- A full config in a custom field.
- An import of a network you do not administer.
Decisions to write down
One decision for NetBox as a Source of Truth: The site is yours. Secrets are absent. Prefixes are assigned. The token is not in the file. And configs stay in the backup store.
Checks before you call it done
Confirm this before you call the change done: One site is named. The CSV was read. No secret column remains. No documentation prefix is marked live. And nothing outside that site was imported. If one of those fails, stop.
Before you leave the device
NetBox as a Source of Truth ends when the hostname on the device matches the hostname in the ticket. If it does not, you are on the wrong box. Stop. A command that succeeded on the wrong box is not progress.
The draft stays a draft until a person has read the names in it. A generator does not log into the device and does not know which interface is the uplink. You delete a line that names a device, a zone, or a prefix you did not write down.
0.0.0.0/0 is not kept because a sample included it. A source you can say is the source you keep. 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, and 2001:db8::/32 are documentation. They belong in the note. They are not prefixes you type onto a production device because they appeared in a draft.
prompt-for-this is a reminder that a secret is missing. It is not a password, a key, a community string, or a pre-shared key you save in the ticket or in git. The real secret stays in the store.
One change is the window. A VLAN and a routing protocol and a VPN do not share it. If two things move and the result is wrong, you will not know which one did it. The next feature waits for its own page.
If the same step fails twice, stop for the day. The failure is the result. Adding a forum command beside a half-applied config produces a device nobody can rebuild. Restore the copy you took first.
A second person reads the device name and the change aloud. If they cannot find them in the ticket, the note is not done. Silence is not agreement. Then leave the device alone.
This page is a planning guide. It is not a vendor manual, not an official standard, and not a permission to touch a network you do not administer. The pillar guide owns the wider design. This page owns one lab proof.
Tools for this guide
These tools run in the browser on this site. They do not log into your machines.
Related pillar guides
More in this cluster
The pillar for this page, and the next published pages filed with it.