Commit 70e46634 authored by Roopa Prabhu's avatar Roopa Prabhu Committed by Stephen Hemminger

ip-route man: add usage and description for lwtunnel encap attributes

This patch updates ip-route man page with lwtunnel encap
usage and description, covering MPLS and IP encapsulation.
Signed-off-by: default avatarRoopa Prabhu <roopa@cumulusnetworks.com>
Signed-off-by: default avatarThomas Graf <tgraf@suug.ch>
Acked-by: default avatarJiri Benc <jbenc@redhat.com>
parent 1e529305
......@@ -80,6 +80,8 @@ replace " } "
.ti -8
.IR NH " := [ "
.B encap
.IR ENCAP " ] [ "
.B via
[
.IR FAMILY " ] " ADDRESS " ] [ "
......@@ -164,6 +166,26 @@ throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
.IR PREF " := [ "
.BR low " | " medium " | " high " ]"
.ti -8
.IR ENCAP " := [ "
.IR MPLS " | " IP " ]"
.ti -8
.IR ENCAP_MPLS " := "
.BR mpls " [ "
.IR LABEL " ]"
.ti -8
.IR ENCAP_IP " := "
.B ip
.B id
.IR TUNNEL_ID
.B dst
.IR REMOTE_IP " [ "
.B tos
.IR TOS " ] ["
.B ttl
.IR TTL " ]"
.SH DESCRIPTION
.B ip route
......@@ -589,6 +611,48 @@ Discovery messages. Namely:
- the route has a highest priority
.sp
.TP
.BI encap " ENCAPTYPE ENCAPHDR"
attach tunnel encapsulation attributes to this route.
.sp
.I ENCAPTYPE
is a string specifying the supported encapsulation type. Namely:
.in +8
.BI mpls
- encapsulation type MPLS
.sp
.BI ip
- IP encapsulation (Geneve, GRE, VXLAN, ...)
.sp
.in -8
.I ENCAPHDR
is a set of encapsulation attributes specific to the
.I ENCAPTYPE.
.in +8
.B mpls
.in +2
.I MPLSLABEL
- mpls label stack with labels separated by
.I "/"
.in -2
.sp
.B ip
.in +2
.B id
.I TUNNEL_ID
.B dst
.IR REMOTE_IP " [ "
.B tos
.IR TOS " ] ["
.B ttl
.IR TTL " ]"
.in -2
.sp
.in -8
.RE
......@@ -847,7 +911,11 @@ ip route add default via 192.168.1.1 dev eth0
Adds a default route (for all addresses) via the local gateway 192.168.1.1 that can
be reached on device eth0.
.RE
.PP
ip route add 10.1.1.0/30 encap mpls 200/300 via 10.1.1.1 dev eth0
.RS 4
Adds an ipv4 route with mpls encapsulation attributes attached to it.
.RE
.SH SEE ALSO
.br
.BR ip (8)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment