#14311: Update model documentation
This commit is contained in:
41
docs/models/vpn/l2vpn.md
Normal file
41
docs/models/vpn/l2vpn.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# L2VPN
|
||||
|
||||
A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by an optional unique identifier (VNI would be an example). Once created, L2VPNs can be terminated to [interfaces](../dcim/interface.md) and [VLANs](../ipam/vlan.md).
|
||||
|
||||
## Fields
|
||||
|
||||
### Name
|
||||
|
||||
A unique human-friendly name.
|
||||
|
||||
### Slug
|
||||
|
||||
A unique URL-friendly identifier. (This value can be used for filtering.)
|
||||
|
||||
### Type
|
||||
|
||||
The technology employed in forming and operating the L2VPN. Choices include:
|
||||
|
||||
* VPLS
|
||||
* VPWS
|
||||
* EPL
|
||||
* EVPL
|
||||
* EP-LAN
|
||||
* EVP-LAN
|
||||
* EP-TREE
|
||||
* EVP-TREE
|
||||
* VXLAN
|
||||
* VXLAN-EVPN
|
||||
* MPLS-EVPN
|
||||
* PBB-EVPN
|
||||
|
||||
!!! note
|
||||
Designating the type as VPWS, EPL, EP-LAN, EP-TREE will limit the L2VPN instance to two terminations.
|
||||
|
||||
### Identifier
|
||||
|
||||
An optional numeric identifier. This can be used to track a pseudowire ID, for example.
|
||||
|
||||
### Import & Export Targets
|
||||
|
||||
The [route targets](../ipam/routetarget.md) associated with this L2VPN to control the import and export of forwarding information.
|
18
docs/models/vpn/l2vpntermination.md
Normal file
18
docs/models/vpn/l2vpntermination.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# L2VPN Termination
|
||||
|
||||
A L2VPN termination is the attachment of an [L2VPN](./l2vpn.md) to an [interface](../dcim/interface.md) or [VLAN](../ipam/vlan.md). Note that the L2VPNs of the following types may have only two terminations assigned to them:
|
||||
|
||||
* VPWS
|
||||
* EPL
|
||||
* EP-LAN
|
||||
* EP-TREE
|
||||
|
||||
## Fields
|
||||
|
||||
### L2VPN
|
||||
|
||||
The [L2VPN](./l2vpn.md) instance.
|
||||
|
||||
### VLAN or Interface
|
||||
|
||||
The [VLAN](../ipam/vlan.md), [device interface](../dcim/interface.md), or [virtual machine interface](../virtualization/virtualmachine.md) attached to the L2VPN.
|
Reference in New Issue
Block a user