1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

54 lines
1.5 KiB
Markdown
Raw Normal View History

2020-03-05 10:50:13 -05:00
# Circuits
2022-08-12 15:00:45 -04:00
A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet connectivity).
2020-07-28 09:18:13 -04:00
2022-08-12 15:00:45 -04:00
## Fields
2020-07-28 09:18:13 -04:00
2022-08-12 15:00:45 -04:00
### Provider
2020-07-28 09:18:13 -04:00
2022-08-12 15:00:45 -04:00
The [provider](./provider.md) to which this circuit belongs.
2020-07-28 09:18:13 -04:00
### Provider Account
Circuits may optionally be assigned to a specific [provider account](./provideraccount.md).
2022-08-12 15:00:45 -04:00
### Circuit ID
2020-07-28 09:18:13 -04:00
2022-08-12 15:00:45 -04:00
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.
### 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.