mirror of
https://github.com/netbox-community/netbox.git
synced 2025-07-14 01:41:22 -06:00
65687851fe
* 16547 Add distance to Circuit * 16547 fix test cases * 16547 fix test cases * 16547 add distance to API, forms, tables * 16547 fixes * 16547 fixes * 16547 review changes * 16547 review changes * Clean up DistanceColumn --------- Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
60 lines
1.6 KiB
Markdown
60 lines
1.6 KiB
Markdown
# Circuits
|
|
|
|
A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet connectivity).
|
|
|
|
## Fields
|
|
|
|
### Provider
|
|
|
|
The [provider](./provider.md) to which this circuit belongs.
|
|
|
|
### Provider Account
|
|
|
|
Circuits may optionally be assigned to a specific [provider account](./provideraccount.md).
|
|
|
|
### Circuit ID
|
|
|
|
An identifier for this circuit. This must be unique to the assigned provider. (Circuits assigned to different providers may have the same circuit ID.)
|
|
|
|
### Circuit Type
|
|
|
|
Each circuit is classified by a user-defined [circuit type](./circuittype.md). Generally this is something like "Internet access," "MPLS/VPN," etc.
|
|
|
|
### Status
|
|
|
|
The operational status of the 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/data-validation.md#field_choices) configuration parameter.
|
|
|
|
### Distance
|
|
|
|
!!! info "This field was introduced in NetBox v4.2."
|
|
|
|
The distance between the circuit's two endpoints, including a unit designation (e.g. 100 meters or 25 feet).
|
|
|
|
### Description
|
|
|
|
A brief description of the circuit.
|
|
|
|
### Installation Date
|
|
|
|
The date on which the circuit was installed.
|
|
|
|
### Termination Date
|
|
|
|
The date on which the circuit is scheduled to be disconnected.
|
|
|
|
### Commit Rate
|
|
|
|
The committed rate (throughput) of the circuit, in kilobits per second.
|