summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorLiudmylaNad <l.nadolina@vyos.io>2026-06-08 19:04:56 +0200
committerGitHub <noreply@github.com>2026-06-08 18:04:56 +0100
commit361ea4841449956af979eb24a0b4e2f869d6ebf2 (patch)
tree352f5070f5ccc02a1d63a627a9d9ac32468fe54a /docs/configuration
parentf01638d2e6ac85b0096a0895635c325569a7771a (diff)
downloadvyos-documentation-361ea4841449956af979eb24a0b4e2f869d6ebf2.tar.gz
vyos-documentation-361ea4841449956af979eb24a0b4e2f869d6ebf2.zip
docs: Update Traffic Engineering page to VyOS 1.5 standards (#2066)
* docs: Update Traffic Engineering page to VyOS 1.5 standards * Update traffic-engineering.md * Update traffic-engineering.md
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/protocols/traffic-engineering.md121
1 files changed, 101 insertions, 20 deletions
diff --git a/docs/configuration/protocols/traffic-engineering.md b/docs/configuration/protocols/traffic-engineering.md
index fc0841c7..98c7834c 100644
--- a/docs/configuration/protocols/traffic-engineering.md
+++ b/docs/configuration/protocols/traffic-engineering.md
@@ -1,55 +1,136 @@
+---
+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
-Traffic Engineering (TE) is possibility to send traffic from node to node using
-alternative path.
+{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.
## Common link parameters
-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).
-```{cfgcmd} set protocols traffic-engineering admin-group \<admin-group-name\> bit-position \<bit-position-value\>
+```{cfgcmd} set protocols traffic-engineering admin-group \<admin-group-name\> bit-position \<0-31\>
-Create Administrative group and associate bit position with it. These groups can be
-used in the following commands.
+**Configure an administrative group and associate it with a bit position.**
+
+These groups can then be referenced by the per-interface commands below.
+```
-\<bit-position-value\> can have value 0-31. There cannot be two groups with same bit position.
+```{note}
+Two administrative groups cannot share the same `bit-position` value.
```
+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\>
-Set administrative group for interface \<ifname\>. Multiple values can be provided.
+**Configure an administrative group on the specified interface.**
+
+You can configure multiple administrative groups on the same interface.
```
+Example:
-```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-bandwidth \<max-bandwidth-value-mbps\>
+```none
+set protocols traffic-engineering interface eth0 admin-group primary
+```
-Set maximum bandwidth for interface \<ifname\>. Value given in Mbits per second.
+```{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
```
+```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-bandwidth \<1-4294967295\>
-```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-reservable-bandwidth \<max-reservable-bandwidth-value-mbps\>
+**Configure the maximum bandwidth, in Mbps, for the specified interface.**
+```
+
+Example:
-Set maximum reservable bandwidth for interface \<ifname\>. Value given in Mbits per second.
+```none
+set protocols traffic-engineering interface eth0 max-bandwidth 1000
```
-## IS-IS TE Configuration
+```{cfgcmd} set protocols traffic-engineering interface \<ifname\> max-reservable-bandwidth \<1-4294967295\>
+
+**Configure the maximum reservable bandwidth, in Mbps, for the specified
+interface.**
+```
-Traffic Engineering (TE) can be enabled and exported for IS-IS
-using the following commands:
+Example:
+
+```none
+set protocols traffic-engineering interface eth0 max-reservable-bandwidth 800
+```
+
+## IS-IS TE configuration
+
+The following commands enable TE for IS-IS.
```{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 Traffic Engineering data to neighbors.
+**Export the local {abbr}`TED (Traffic Engineering Database)` to other FRR
+daemons.**
```
+
+Example:
+
+```none
+set protocols isis traffic-engineering export
+```
+
```{cfgcmd} set protocols isis traffic-engineering address \<ipv4-address\>
-Configure IPv4 address for MPLS-TE.
-``` \ No newline at end of file
+**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
+```