mirror of
https://github.com/netbox-community/netbox.git
synced 2025-07-31 12:56:24 -06:00
Add model docs
This commit is contained in:
parent
6b4b68a598
commit
73b74d4ce8
33
docs/models/circuits/virtualcircuit.md
Normal file
33
docs/models/circuits/virtualcircuit.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
# 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](./providernetwork.md) via an independent [physical circuit](./circuit.md).
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### Provider Network
|
||||||
|
|
||||||
|
The [provider network](./providernetwork.md) across which the virtual circuit is formed.
|
||||||
|
|
||||||
|
### Provider Account
|
||||||
|
|
||||||
|
The [provider account](./provideraccount.md) with which the virtual circuit is associated (if any).
|
||||||
|
|
||||||
|
### Circuit ID
|
||||||
|
|
||||||
|
The unique identifier assigned to the virtual circuit by its [provider](./provider.md).
|
||||||
|
|
||||||
|
### 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/data-validation.md#field_choices) configuration parameter.
|
21
docs/models/circuits/virtualcircuittermination.md
Normal file
21
docs/models/circuits/virtualcircuittermination.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# Virtual Circuit Terminations
|
||||||
|
|
||||||
|
This model represents the connection of a virtual [interface](../dcim/interface.md) to a [virtual circuit](./virtualcircuit.md).
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### Virtual Circuit
|
||||||
|
|
||||||
|
The [virtual circuit](./virtualcircuit.md) to which the interface is connected.
|
||||||
|
|
||||||
|
### Interface
|
||||||
|
|
||||||
|
The [interface](../dcim/interface.md) connected to the virtual circuit.
|
||||||
|
|
||||||
|
### Role
|
||||||
|
|
||||||
|
The functional role of the termination. This depends on the virtual circuit's topology, which is typically either peer-to-peer or hub-and-spoke (multipoint). Valid choices include:
|
||||||
|
|
||||||
|
* Peer
|
||||||
|
* Hub
|
||||||
|
* Spoke
|
@ -174,6 +174,8 @@ nav:
|
|||||||
- Provider: 'models/circuits/provider.md'
|
- Provider: 'models/circuits/provider.md'
|
||||||
- Provider Account: 'models/circuits/provideraccount.md'
|
- Provider Account: 'models/circuits/provideraccount.md'
|
||||||
- Provider Network: 'models/circuits/providernetwork.md'
|
- Provider Network: 'models/circuits/providernetwork.md'
|
||||||
|
- Virtual Circuit: 'models/circuits/virtualcircuit.md'
|
||||||
|
- Virtual Circuit Termination: 'models/circuits/virtualcircuittermination.md'
|
||||||
- Core:
|
- Core:
|
||||||
- DataFile: 'models/core/datafile.md'
|
- DataFile: 'models/core/datafile.md'
|
||||||
- DataSource: 'models/core/datasource.md'
|
- DataSource: 'models/core/datasource.md'
|
||||||
|
@ -350,7 +350,7 @@ class VirtualCircuitTerminationFilterForm(NetBoxModelFilterSetForm):
|
|||||||
label=_('Virtual circuit')
|
label=_('Virtual circuit')
|
||||||
)
|
)
|
||||||
role = forms.MultipleChoiceField(
|
role = forms.MultipleChoiceField(
|
||||||
label=_('ROle'),
|
label=_('Role'),
|
||||||
choices=VirtualCircuitTerminationRoleChoices,
|
choices=VirtualCircuitTerminationRoleChoices,
|
||||||
required=False
|
required=False
|
||||||
)
|
)
|
||||||
|
Loading…
Reference in New Issue
Block a user