summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols/traffic-engineering.rst
diff options
context:
space:
mode:
authorKyrylo Yatsenko <hedrok@gmail.com>2026-04-07 15:42:36 +0300
committerGitHub <noreply@github.com>2026-04-07 13:42:36 +0100
commitbe1128aaae24bba68e2fe115b41fb4c51fe025ef (patch)
tree2260752cea475717d7cb68ab85790c76c43f9e4f /docs/configuration/protocols/traffic-engineering.rst
parent9f69ca58338f10f8295162d23eba7287f86ab956 (diff)
downloadvyos-documentation-be1128aaae24bba68e2fe115b41fb4c51fe025ef.tar.gz
vyos-documentation-be1128aaae24bba68e2fe115b41fb4c51fe025ef.zip
T8046: traffic-engineering (#1726)
Diffstat (limited to 'docs/configuration/protocols/traffic-engineering.rst')
-rw-r--r--docs/configuration/protocols/traffic-engineering.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/configuration/protocols/traffic-engineering.rst b/docs/configuration/protocols/traffic-engineering.rst
new file mode 100644
index 00000000..977a5e5c
--- /dev/null
+++ b/docs/configuration/protocols/traffic-engineering.rst
@@ -0,0 +1,51 @@
+.. _traffic-engineering:
+
+###################
+Traffic Engineering
+###################
+
+Traffic Engineering (TE) is possibility to send traffic from node to node using
+alternative path.
+
+Common link parameters
+----------------------
+
+Traffic Engineering parameters are used for both IS-IS and OSPF (not supported yet).
+
+.. cfgcmd:: set protocols traffic-engineering admin-group <admin-group-name> bit-position <bit-position-value>
+
+ Create Administrative group and assosiate bit position with it. These groups can be
+ used in the following commands.
+
+ <bit-position-value> can have value 0-31. There cannot be two groups with same bit position.
+
+.. cfgcmd:: set protocols traffic-engineering interface <ifname> admin-group <admin-group-name>
+
+ Set administrative group for interface <ifname>. Multiple values can be provided.
+
+.. cfgcmd:: set protocols traffic-engineering interface <ifname> max-bandwidth <max-bandwidth-value-mbps>
+
+ Set maximum bandwidth for interface <ifname>. Value given in Mbits per second.
+
+.. cfgcmd:: set protocols traffic-engineering interface <ifname> max-reservable-bandwidth <max-reservable-bandwidth-value-mbps>
+
+ Set maximum reservable bandwidth for interface <ifname>. Value given in Mbits per second.
+
+
+IS-IS TE Configuration
+----------------------
+
+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.
+
+.. cfgcmd:: set protocols isis traffic-engineering export
+
+ Export Traffic Engineering data to neighbors.
+
+.. cfgcmd:: set protocols isis traffic-engineering address <ipv4-address>
+
+ Configure IPv4 address for MPLS-TE.