How to tie Circuit ID's to Vlan or prefix?

[jlon125]

We are a small ISP, and we have internal circuit IDs for our customer circuits. How do we tie circuits to a specific customer vlan and/or prefix?

It doesn't seem possible currently, but I assume we aren't the first to need this functionality.

[pheus]

I might not be the best person to help here, as I haven't encountered this exact use case myself, but I’d still like to suggest a possible solution:

You could consider adding a Custom Field of type “Object” to link the relevant circuit ID to either the VLAN or the prefix. This could provide the association you're looking for, even if it's not natively supported.

[Christophoclese]

One of our team members recently asked for something similar-- a way to associate a prefix with a circuit.

The downside of a custom field approach is that you can only have a one-way relationship without having to maintain the relationship in two separate custom fields, one on the Prefix object type and one on the Circuit object type. So, you basically have to choose between seeing the relationship on the Prefix object or the Circuit object or be willing to keep both ends of the relationship up-to-date.

[pheus]

You're right! Custom Fields of type object create a one‑way link. In practice, keeping two separate fields (one on the Prefix and one on the Circuit) mutually updated is brittle. I ran into the same issue (in another context) and ended up writing a plugin.

If you’d prefer not to build your own, you might look at the NetBox Labs Custom Objects plugin: https://github.com/netboxlabs/netbox-custom-objects. It aims to model richer relationships than a single custom field. Just note that it’s currently in preview, so I wouldn’t deploy it to production yet.

[Christophoclese]

Thanks @pheus! We're just getting started on our NetBox journey, so to speak, so I am currently wading into the REST API and have much to learn about the ocean of NetBox.

For the meantime I think we've chosen to use a single Custom Field on the Circuit object since the model and view for Circuit has less to display.