summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@vyos.io>2026-06-09 11:27:26 +0100
committerGitHub <noreply@github.com>2026-06-09 11:27:26 +0100
commitd1ef01fec58cbf860789f8979cc57a44bfa18dc9 (patch)
treed68116c8c0924e98df8c460d2b720bdd1ffe9613 /docs/configuration/protocols
parent2f0d68a79930e5e925257cd5ba9f8e3bcaec8f08 (diff)
downloadvyos-documentation-d1ef01fec58cbf860789f8979cc57a44bfa18dc9.tar.gz
vyos-documentation-d1ef01fec58cbf860789f8979cc57a44bfa18dc9.zip
Revert "docs: Update Traffic Engineering page to VyOS 1.5 standards (#2066) (…" (#2095)
This reverts commit 6b88b233b56e7231fbdf0ed4644f741cf634b9ba.
Diffstat (limited to 'docs/configuration/protocols')
-rw-r--r--docs/configuration/protocols/traffic-engineering.md123
1 files changed, 16 insertions, 107 deletions
diff --git a/docs/configuration/protocols/traffic-engineering.md b/docs/configuration/protocols/traffic-engineering.md
index 21907f8c..832023a7 100644
--- a/docs/configuration/protocols/traffic-engineering.md
+++ b/docs/configuration/protocols/traffic-engineering.md
@@ -1,145 +1,54 @@
----
-myst:
- html_meta:
- description: |
- Traffic Engineering (TE) is a set of techniques for steering traffic
- along paths different from the shortest path computed by the IGP.
- keywords: traffic engineering, te, isis, mpls, srv6, admin-group,
- bandwidth, ted
----
-
(traffic-engineering)=
# Traffic Engineering
-{abbr}`TE (Traffic Engineering)` is a set of techniques for steering traffic
-along paths different from the shortest path computed by the
-{abbr}`IGP (Interior Gateway Protocol)`.
-
-To enforce these paths, TE typically uses a form of source routing, such as
-{abbr}`MPLS (Multiprotocol Label Switching)` labels or
-{abbr}`SRv6 (Segment Routing over IPv6)` extension headers, combined with
-path constraints, such as administrative groups or bandwidth requirements,
-and a method to map traffic to TE paths.
-
-Use the commands below to configure link-level TE attributes (administrative
-groups and bandwidth) and enable TE in the IGP (specifically, IS-IS) so this
-information is distributed across the network.
+Traffic Engineering (TE) is possibility to send traffic from node to node using
+alternative path.
## Common link parameters
-<<<<<<< HEAD
Traffic Engineering parameters are used for both IS-IS and OSPF (not supported yet).
-=======
-The following commands define link-level TE attributes that can be advertised
-by both IS-IS and OSPF (not supported yet).
->>>>>>> 361ea484 (docs: Update Traffic Engineering page to VyOS 1.5 standards (#2066))
-```{cfgcmd} set protocols traffic-engineering admin-group \<admin-group-name\> bit-position \<0-31\>
+```{cfgcmd} set protocols traffic-engineering admin-group \<admin-group-name\> bit-position \<bit-position-value\>
-<<<<<<< HEAD
Create Administrative group and assosiate bit position with it. These groups can be
used in the following commands.
-=======
-**Configure an administrative group and associate it with a bit position.**
->>>>>>> 361ea484 (docs: Update Traffic Engineering page to VyOS 1.5 standards (#2066))
-
-These groups can then be referenced by the per-interface commands below.
-```
-```{note}
-Two administrative groups cannot share the same `bit-position` value.
+\<bit-position-value\> can have value 0-31. There cannot be two groups with same bit position.
```
-Example:
-
-```none
-set protocols traffic-engineering admin-group primary bit-position 0
-set protocols traffic-engineering admin-group backup bit-position 1
-```
```{cfgcmd} set protocols traffic-engineering interface \<ifname\> admin-group \<admin-group-name\>
-**Configure an administrative group on the specified interface.**
-
-You can configure multiple administrative groups on the same interface.
+Set administrative group for interface \<ifname\>. Multiple values can be provided.
```
-Example:
-```none
-set protocols traffic-engineering interface eth0 admin-group primary
-```
+```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-bandwidth \<max-bandwidth-value-mbps\>
-```{cfgcmd} set protocols traffic-engineering interface \<ifname\> metric \<1-4294967295\>
-
-**Configure the TE metric for the specified interface (distinct from the
-OSPF/ISIS metric).**
-```
-
-Example:
-
-```none
-set protocols traffic-engineering interface eth0 metric 100
+Set maximum bandwidth for interface \<ifname\>. Value given in Mbits per second.
```
-```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-bandwidth \<1-4294967295\>
-**Configure the maximum bandwidth, in Mbps, for the specified interface.**
-```
-
-Example:
+```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-reservable-bandwidth \<max-reservable-bandwidth-value-mbps\>
-```none
-set protocols traffic-engineering interface eth0 max-bandwidth 1000
+Set maximum reservable bandwidth for interface \<ifname\>. Value given in Mbits per second.
```
-```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-reservable-bandwidth \<1-4294967295\>
-
-**Configure the maximum reservable bandwidth, in Mbps, for the specified
-interface.**
-```
+## IS-IS TE Configuration
-Example:
-
-```none
-set protocols traffic-engineering interface eth0 max-reservable-bandwidth 800
-```
-
-## IS-IS TE configuration
-
-The following commands enable TE for IS-IS.
+Traffic Engineering (TE) can be enabled and exported for IS-IS
+using the following commands:
```{cfgcmd} set protocols isis traffic-engineering enable
-**Enable Traffic Engineering for IS-IS.**
+Enable Traffic Engineering for IS-IS.
```
-
-Example:
-
-```none
-set protocols isis traffic-engineering enable
-```
-
```{cfgcmd} set protocols isis traffic-engineering export
-**Export the local {abbr}`TED (Traffic Engineering Database)` to other FRR
-daemons.**
+Export Traffic Engineering data to neighbors.
```
-
-Example:
-
-```none
-set protocols isis traffic-engineering export
-```
-
```{cfgcmd} set protocols isis traffic-engineering address \<ipv4-address\>
-**Configure the IPv4 address used as the TE Router ID for MPLS-TE.**
-```
-
-Example:
-
-```none
-set protocols isis traffic-engineering address 198.51.100.1
-```
+Configure IPv4 address for MPLS-TE.
+``` \ No newline at end of file