diff options
| author | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2026-06-09 11:18:32 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-06-09 11:18:32 +0100 |
| commit | 6b88b233b56e7231fbdf0ed4644f741cf634b9ba (patch) | |
| tree | 34f63bc99545d9045db232d48148429e08b869d6 /docs | |
| parent | ad414445aa08c6ac8ca703925f2df82ea0a41565 (diff) | |
| download | vyos-documentation-6b88b233b56e7231fbdf0ed4644f741cf634b9ba.tar.gz vyos-documentation-6b88b233b56e7231fbdf0ed4644f741cf634b9ba.zip | |
docs: Update Traffic Engineering page to VyOS 1.5 standards (#2066) (#2092)
* docs: Update Traffic Engineering page to VyOS 1.5 standards
* Update traffic-engineering.md
* Update traffic-engineering.md
(cherry picked from commit 361ea4841449956af979eb24a0b4e2f869d6ebf2)
# Conflicts:
# docs/configuration/protocols/traffic-engineering.md
Co-authored-by: LiudmylaNad <l.nadolina@vyos.io>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/protocols/traffic-engineering.md | 123 |
1 files changed, 107 insertions, 16 deletions
diff --git a/docs/configuration/protocols/traffic-engineering.md b/docs/configuration/protocols/traffic-engineering.md index 832023a7..21907f8c 100644 --- a/docs/configuration/protocols/traffic-engineering.md +++ b/docs/configuration/protocols/traffic-engineering.md @@ -1,54 +1,145 @@ +--- +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 +<<<<<<< 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 \<bit-position-value\> +```{cfgcmd} set protocols traffic-engineering admin-group \<admin-group-name\> bit-position \<0-31\> +<<<<<<< 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. +``` -\<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 +``` |
