From patchwork Sun Aug 1 12:45:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Justin Iurman X-Patchwork-Id: 12412931 X-Patchwork-Delegate: dsahern@gmail.com Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 94D4FC4338F for ; Sun, 1 Aug 2021 12:46:27 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 65B1E610D0 for ; Sun, 1 Aug 2021 12:46:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231849AbhHAMqd (ORCPT ); Sun, 1 Aug 2021 08:46:33 -0400 Received: from serv108.segi.ulg.ac.be ([139.165.32.111]:39054 "EHLO serv108.segi.ulg.ac.be" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231546AbhHAMqd (ORCPT ); Sun, 1 Aug 2021 08:46:33 -0400 Received: from localhost.localdomain (148.24-240-81.adsl-dyn.isp.belgacom.be [81.240.24.148]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by serv108.segi.ulg.ac.be (Postfix) with ESMTPSA id BC72A200EEC6; Sun, 1 Aug 2021 14:46:22 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 serv108.segi.ulg.ac.be BC72A200EEC6 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=uliege.be; s=ulg20190529; t=1627821982; bh=ETtCBaOLdQgTMLbydAf8KmI8BKBhqEPCWOVKya2gPDo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ZTP2DSZbhQrTSqmaTazqxDXx7jeVq3+8AbK7AROKBfA7SdHuob7qjlfyxej8GPMAq e36T7kSxwbqViAHG0pYAidxsefruYMjy6RCGGY5t9MPM3xnr5AoiJxwPiL2M4IupN6 ZYleNWCsBhCV2kmes8MTLg603+hcgT0D+D4JnUiPwzKpV6MymlmihfFZv18yxjv99Q eLJejsw1eZct50ca8DgvuaHG684eIJ6RM/2/UQzitxxSJNJ0GGUcJxLXuDkjE0/xBv VFjiJtAgiLdDo6Zy1DFLSxf+W1Fgn9O8WJnIM2/5U3sIJNPVI30X//nh3vAovwkZVE gpEwVD8PBdOJA== From: Justin Iurman To: netdev@vger.kernel.org Cc: stephen@networkplumber.org, dsahern@gmail.com, justin.iurman@uliege.be Subject: [PATCH iproute2-next v3 3/3] IOAM man8 Date: Sun, 1 Aug 2021 14:45:52 +0200 Message-Id: <20210801124552.15728-4-justin.iurman@uliege.be> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210801124552.15728-1-justin.iurman@uliege.be> References: <20210801124552.15728-1-justin.iurman@uliege.be> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org X-Patchwork-Delegate: dsahern@gmail.com This patch provides man8 documentation for IOAM inside ip, ip-ioam and ip-route. Signed-off-by: Justin Iurman --- man/man8/ip-ioam.8 | 72 ++++++++++++++++++++++++++++++++++++++++++ man/man8/ip-route.8.in | 36 ++++++++++++++++++++- man/man8/ip.8 | 7 +++- 3 files changed, 113 insertions(+), 2 deletions(-) create mode 100644 man/man8/ip-ioam.8 diff --git a/man/man8/ip-ioam.8 b/man/man8/ip-ioam.8 new file mode 100644 index 00000000..1bdc0ece --- /dev/null +++ b/man/man8/ip-ioam.8 @@ -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 diff --git a/man/man8/ip-route.8.in b/man/man8/ip-route.8.in index 4b1947ab..c9a9cbf1 100644 --- a/man/man8/ip-route.8.in +++ b/man/man8/ip-route.8.in @@ -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. diff --git a/man/man8/ip.8 b/man/man8/ip.8 index c9f7671e..87cd2df8 100644 --- a/man/man8/ip.8 +++ b/man/man8/ip.8 @@ -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),