netbox/docs/models/circuits/virtualcircuit.md
Jeremy Stretch d2168b107f
Closes #13086: Virtual circuits (#17933)
* WIP

* Add API tests

* Add remaining tests

* Add model docs

* Show virtual circuit connections on interfaces

* Misc cleanup per PR feedback

* Renumber migration

* Support nested terminations for virtual circuit bulk import
2024-11-19 10:58:39 -05:00

1.2 KiB

Virtual Circuits

A virtual circuit can connect two or more interfaces atop a set of decoupled physical connections. For example, it's very common to form a virtual connection between two virtual interfaces, each of which is bound to a physical interface on its respective device and physically connected to a provider network via an independent physical circuit.

Fields

Provider Network

The provider network across which the virtual circuit is formed.

Provider Account

The provider account with which the virtual circuit is associated (if any).

Circuit ID

The unique identifier assigned to the virtual circuit by its provider.

Status

The operational status of the virtual circuit. By default, the following statuses are available:

Name
Planned
Provisioning
Active
Offline
Deprovisioning
Decommissioned

!!! tip "Custom circuit statuses" Additional circuit statuses may be defined by setting Circuit.status under the FIELD_CHOICES configuration parameter.