mirror of
https://git.kernel.org/pub/scm/network/iproute2/iproute2.git
synced 2024-11-16 06:25:35 +08:00
IOAM man8
This patch provides man8 documentation for IOAM inside ip, ip-ioam and ip-route. Signed-off-by: Justin Iurman <justin.iurman@uliege.be> Signed-off-by: David Ahern <dsahern@kernel.org>
This commit is contained in:
Justin Iurman
Stephen Hemminger
parent
2d83c71082
commit
86c596ed91
72
man/man8/ip-ioam.8
Normal file
72
man/man8/ip-ioam.8
Normal file
@ -0,0 +1,72 @@
|
||||
.TH IP\-IOAM 8 "05 Jul 2021" "iproute2" "Linux"
|
||||
.SH "NAME"
|
||||
ip-ioam \- IPv6 In-situ OAM (IOAM)
|
||||
.SH SYNOPSIS
|
||||
.sp
|
||||
.ad l
|
||||
.in +8
|
||||
.ti -8
|
||||
.B ip ioam
|
||||
.RI " { " COMMAND " | "
|
||||
.BR help " }"
|
||||
.sp
|
||||
.ti -8
|
||||
|
||||
.ti -8
|
||||
.B ip ioam namespace show
|
||||
|
||||
.ti -8
|
||||
.B ip ioam namespace add
|
||||
.I ID
|
||||
.BR " [ "
|
||||
.B data
|
||||
.I DATA32
|
||||
.BR "]"
|
||||
.BR " [ "
|
||||
.B wide
|
||||
.I DATA64
|
||||
.BR "]"
|
||||
|
||||
.ti -8
|
||||
.B ip ioam namespace del
|
||||
.I ID
|
||||
|
||||
.ti -8
|
||||
.B ip ioam schema show
|
||||
|
||||
.ti -8
|
||||
.B ip ioam schema add
|
||||
.I ID DATA
|
||||
|
||||
.ti -8
|
||||
.B ip ioam schema del
|
||||
.I ID
|
||||
|
||||
.ti -8
|
||||
.B ip ioam namespace set
|
||||
.I ID
|
||||
.B schema
|
||||
.RI " { " ID " | "
|
||||
.BR none " }"
|
||||
|
||||
.SH DESCRIPTION
|
||||
The \fBip ioam\fR command is used to configure IPv6 In-situ OAM (IOAM6)
|
||||
internal parameters, namely IOAM namespaces and schemas.
|
||||
.PP
|
||||
Those parameters also include the mapping between an IOAM namespace and an IOAM
|
||||
schema.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.SS Configure an IOAM namespace (ID = 1) with both data (32 bits) and wide data (64 bits)
|
||||
.nf
|
||||
# ip ioam namespace add 1 data 0xdeadbeef wide 0xcafec0caf00dc0de
|
||||
.PP
|
||||
.SS Link an existing IOAM schema (ID = 7) to an existing IOAM namespace (ID = 1)
|
||||
.nf
|
||||
# ip ioam namespace set 1 schema 7
|
||||
.SH SEE ALSO
|
||||
.br
|
||||
.BR ip-route (8)
|
||||
.SH AUTHOR
|
||||
Justin Iurman <justin.iurman@uliege.be>
|
||||
@ -190,7 +190,7 @@ throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
|
||||
.ti -8
|
||||
.IR ENCAP " := [ "
|
||||
.IR ENCAP_MPLS " | " ENCAP_IP " | " ENCAP_BPF " | "
|
||||
.IR ENCAP_SEG6 " | " ENCAP_SEG6LOCAL " ] "
|
||||
.IR ENCAP_SEG6 " | " ENCAP_SEG6LOCAL " | " ENCAP_IOAM6 " ] "
|
||||
|
||||
.ti -8
|
||||
.IR ENCAP_MPLS " := "
|
||||
@ -243,6 +243,18 @@ throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
|
||||
.IR SEG6_ACTION_PARAM " ] [ "
|
||||
.BR count " ] "
|
||||
|
||||
.ti -8
|
||||
.IR ENCAP_IOAM6 " := "
|
||||
.B ioam6
|
||||
.BR trace
|
||||
.BR prealloc
|
||||
.BR type
|
||||
.IR IOAM6_TRACE_TYPE
|
||||
.BR ns
|
||||
.IR IOAM6_NAMESPACE
|
||||
.BR size
|
||||
.IR IOAM6_TRACE_SIZE
|
||||
|
||||
.ti -8
|
||||
.IR ROUTE_GET_FLAGS " := "
|
||||
.BR " [ "
|
||||
@ -717,6 +729,9 @@ is a string specifying the supported encapsulation type. Namely:
|
||||
.sp
|
||||
.BI seg6local
|
||||
- local SRv6 segment processing
|
||||
.sp
|
||||
.BI ioam6
|
||||
- encapsulation type IPv6 IOAM
|
||||
|
||||
.in -8
|
||||
.I ENCAPHDR
|
||||
@ -896,6 +911,20 @@ Additionally, encapsulate the matching packet within an outer IPv6 header
|
||||
followed by the specified SRH. The destination address of the outer IPv6
|
||||
header is set to the first segment of the new SRH. The source
|
||||
address is set as described in \fBip-sr\fR(8).
|
||||
.in -2
|
||||
|
||||
.B ioam6
|
||||
.in +2
|
||||
.I IOAM6_TRACE_TYPE
|
||||
- List of IOAM data required in the trace, represented by a bitfield (24 bits).
|
||||
.sp
|
||||
|
||||
.I IOAM6_NAMESPACE
|
||||
- Numerical value to represent an IOAM namespace. See \fBip-ioam\fR(8).
|
||||
.sp
|
||||
|
||||
.I IOAM6_TRACE_SIZE
|
||||
- Size, in octets, of the pre-allocated trace data block.
|
||||
.in -4
|
||||
|
||||
.in -8
|
||||
@ -1220,6 +1249,11 @@ ip -6 route add 2001:db8:1::/64 encap seg6local action End.DT46 vrftable 100 dev
|
||||
Adds an IPv6 route with SRv6 decapsulation and forward with lookup in VRF table.
|
||||
.RE
|
||||
.PP
|
||||
ip -6 route add 2001:db8:1::/64 encap ioam6 trace prealloc type 0x800000 ns 1 size 12 dev eth0
|
||||
.RS 4
|
||||
Adds an IPv6 route with an IOAM Pre-allocated Trace encapsulation that only includes the hop limit and the node id, configured for the IOAM namespace 1 and a pre-allocated data block of 12 octets.
|
||||
.RE
|
||||
.PP
|
||||
ip route add 10.1.1.0/30 nhid 10
|
||||
.RS 4
|
||||
Adds an ipv4 route using nexthop object with id 10.
|
||||
|
||||
@ -22,7 +22,7 @@ ip \- show / manipulate routing, network devices, interfaces and tunnels
|
||||
.BR link " | " address " | " addrlabel " | " route " | " rule " | " neigh " | "\
|
||||
ntable " | " tunnel " | " tuntap " | " maddress " | " mroute " | " mrule " | "\
|
||||
monitor " | " xfrm " | " netns " | " l2tp " | " tcp_metrics " | " token " | "\
|
||||
macsec " | " vrf " | " mptcp " }"
|
||||
macsec " | " vrf " | " mptcp " | " ioam " }"
|
||||
.sp
|
||||
|
||||
.ti -8
|
||||
@ -252,6 +252,10 @@ readability.
|
||||
.B addrlabel
|
||||
- label configuration for protocol address selection.
|
||||
|
||||
.TP
|
||||
.B ioam
|
||||
- manage IOAM namespaces and IOAM schemas.
|
||||
|
||||
.TP
|
||||
.B l2tp
|
||||
- tunnel ethernet over IP (L2TPv3).
|
||||
@ -405,6 +409,7 @@ was written by Alexey N. Kuznetsov and added in Linux 2.2.
|
||||
.SH SEE ALSO
|
||||
.BR ip-address (8),
|
||||
.BR ip-addrlabel (8),
|
||||
.BR ip-ioam (8),
|
||||
.BR ip-l2tp (8),
|
||||
.BR ip-link (8),
|
||||
.BR ip-maddress (8),
|
||||
|
||||
Loading…
Reference in New Issue
Block a user