proxmox-mirrors/mirror_iproute2
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_iproute2 synced 2025-10-05 09:21:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

man: add documentation for IPv6 SR commands

Browse Source 
This patch adds information about seg6 encapsulation in the ip-route
manual, as well as the ip-sr manual page.

Signed-off-by: David Lebrun <david.lebrun@uclouvain.be>
This commit is contained in:
David Lebrun 2017-04-15 12:17:17 +02:00 committed by Stephen Hemminger
parent e8493916a8
commit e1b7f883e5
2 changed files with 95 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
man/man8/ip-route.8.in
View File

@ -176,7 +176,7 @@ throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
.ti -8
.IR ENCAP " := [ "
.IR MPLS " | " IP | " BPF " ] "
.IR MPLS " | " IP " | " BPF " | " SEG6 " ] "
.ti -8
.IR ENCAP_MPLS " := "
@ -197,7 +197,6 @@ throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
.B ttl
.IR TTL " ]"
.ti -8
.IR ENCAP_BPF " := "
.BR bpf " [ "
@ -210,6 +209,16 @@ throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
.B headroom
.IR SIZE " ]"
.ti -8
.IR ENCAP_SEG6 " := "
.B seg6
.BR mode " [ "
.BR encap " | " inline " ] "
.B segs
.IR SEGMENTS " [ "
.B hmac
.IR KEYID " ]"
.SH DESCRIPTION
.B ip route
is used to manipulate entries in the kernel routing tables.
@ -656,6 +665,8 @@ is a string specifying the supported encapsulation type. Namely:
.BI bpf
- Execution of BPF program
.sp
.BI seg6
- encapsulation type IPv6 Segment Routing
.in -8
.I ENCAPHDR
@ -712,6 +723,25 @@ is a set of encapsulation attributes specific to the
.in -2
.sp
.B seg6
.in +2
.B mode inline
- Directly insert Segment Routing Header after IPv6 header
.sp
.B mode encap
- Encapsulate packet in an outer IPv6 header with SRH
.sp
.I SEGMENTS
- List of comma-separated IPv6 addresses
.sp
.I KEYID
- Numerical value in decimal representation. See \fBip-sr\fR(8).
.in -2
.sp
.in -8
.TP
@ -1001,6 +1031,11 @@ 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
.PP
ip -6 route add 2001:db8:1::/64 encap seg6 mode encap segs 2001:db8:42::1,2001:db8:ffff::2 dev eth0
.RS 4
Adds an IPv6 route with SRv6 encapsulation and two segments attached.
.RE
.SH SEE ALSO
.br
.BR ip (8)

58
man/man8/ip-sr.8 Normal file
View File

@ -0,0 +1,58 @@
.TH IP\-SR 8 "14 Apr 2017" "iproute2" "Linux"
.SH "NAME"
ip-sr \- IPv6 Segment Routing management
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B ip sr
.RI " { " COMMAND " | "
.BR help " }"
.sp
.ti -8
.ti -8
.B ip sr hmac show
.ti -8
.B ip sr hmac set
.I KEYID ALGO
.ti -8
.B ip sr tunsrc show
.ti -8
.B ip sr tunsrc set
.I ADDRESS
.SH DESCRIPTION
The \fBip sr\fR command is used to configure IPv6 Segment Routing (SRv6)
internal parameters.
.PP
Those parameters include the mapping between an HMAC key ID and its associated
hashing algorithm and secret, and the IPv6 address to use as source for encapsulated
packets.
.PP
The \fBip sr hmac set\fR command prompts for a passphrase that will be used as the
HMAC secret for the corresponding key ID. A blank passphrase removes the mapping.
The currently supported algorithms for \fIALGO\fR are \fBsha1\fR and \fBsha256\fR.
.PP
If the tunnel source is set to the address :: (which is the default), then an address
of the egress interface will be selected. As this operation may hinder performances,
it is recommended to set a non-default address.
.SH EXAMPLES
.PP
.SS Configure an HMAC mapping for key ID 42 and hashing algorithm SHA-256
.nf
# ip sr hmac set 42 sha256
.PP
.SS Set the tunnel source address to 2001:db8::1
.nf
# ip sr tunsrc set 2001:db8::1
.SH SEE ALSO
.br
.BR ip-route (8)
.SH AUTHOR
David Lebrun <david.lebrun@uclouvain.be>