From patchwork Thu Jan 29 16:52:01 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Herbert X-Patchwork-Id: 434607 X-Patchwork-Delegate: shemminger@vyatta.com Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id DF78C1402E1 for ; Fri, 30 Jan 2015 03:53:39 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755343AbbA2Qxf (ORCPT ); Thu, 29 Jan 2015 11:53:35 -0500 Received: from mail-ie0-f174.google.com ([209.85.223.174]:51209 "EHLO mail-ie0-f174.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755143AbbA2Qxe (ORCPT ); Thu, 29 Jan 2015 11:53:34 -0500 Received: by mail-ie0-f174.google.com with SMTP id vy18so36062274iec.5 for ; Thu, 29 Jan 2015 08:53:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=from:to:subject:date:message-id:in-reply-to:references; bh=+PjkxGCXv4Qe23adQHiwgY8EZXIMYiLTDoVZPr60p6Y=; b=IYcn2jCsFrdUJP2EKOaEcDqswnxTpxFIOF1WUFOyZ2kG8bePylukig+2KhBMaO2ABv zVyqBvlijr99Y53AZd27uizLx+Qr7RSuB+4IYsYDrppcSSM6H/3cOVuvHoCTPGDTwXlz Db2R8dOl4/H2ostW+IlDTlfoGB4Lilu1FoqVsOaHzItzvEEob77s57wgrAiypaLs/YvV zegxjc3p+gxtbR7wAknfCWRXxqR7tT6Y4pFnuxDoPNcWsLMqhUxYtUFA/ZoecwFufT3V MtU7dNhdjxTtw/akqYX1BZwU3lSkSmlSRl8ByO44grLUsQNLO7ulbSe1H3eZwpigKish 4FRg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=+PjkxGCXv4Qe23adQHiwgY8EZXIMYiLTDoVZPr60p6Y=; b=eM1ejzF8XTgThOOIYljOuMupSrP0DrS6VosclFM+ZFDARkUTQwz+QByC2IFzkR6DRY willDEb1u/qWtXTTCy7eBXeJ6idH10SyS1p6xw7VOjlIOG/cI7afx8fTcN+zK6hpiGQK U5w+iGo25T1jsz8sK7seLRSpPj9TPvXGeWcGU2dOy3/4v2dzyFNl+0Ta52Sx4hR/u82M yF/FQ76i6nSzO1TqfyTeu4RJEgq1JXic5hXYc0bMXTGrRQhrSofOj2Fyn+k7uwfmycxa AzJqGYUUscc87A8nxdvUGEbwZe0aW1k9mwWCVSzfQT3Sz6deIREBPLlCvE/w1yI4ITIs hKbA== X-Gm-Message-State: ALoCoQmCin00IsOYT/oTgIN1XKQARDuElPWrLj3Nu1qPC390niiQNPbkSd3KpC0wWh++vcMN2/GB X-Received: by 10.42.13.77 with SMTP id c13mr1433178ica.75.1422550414051; Thu, 29 Jan 2015 08:53:34 -0800 (PST) Received: from tomh.mtv.corp.google.com ([172.18.117.126]) by mx.google.com with ESMTPSA id kt1sm1159757igb.20.2015.01.29.08.53.33 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 29 Jan 2015 08:53:33 -0800 (PST) From: Tom Herbert To: stephen@networkplumber.org, netdev@vger.kernel.org Subject: [PATCH iproute2 4/4] iproute: Descriptions of fou and gue options in ip-link man pages Date: Thu, 29 Jan 2015 08:52:01 -0800 Message-Id: <1422550321-30901-5-git-send-email-therbert@google.com> X-Mailer: git-send-email 2.2.0.rc0.207.ga3a616c In-Reply-To: <1422550321-30901-1-git-send-email-therbert@google.com> References: <1422550321-30901-1-git-send-email-therbert@google.com> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Add section for additional arguments to GRE, IPIP, and SIT types that are related to Foo-over-UDP and Generic UDP Encapsulation. Also, added an example GUE configuration in the examples section. Signed-off-by: Tom Herbert --- man/man8/ip-link.8.in | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in index a0be895..2634590 100644 --- a/man/man8/ip-link.8.in +++ b/man/man8/ip-link.8.in @@ -369,6 +369,63 @@ are entered into the VXLAN device forwarding database. .in -8 .TP +GRE, IPIP, SIT Type Support +For a link of types +.I GRE/IPIP/SIT +the following additional arguments are supported: + +.BI "ip link add " DEVICE +.BR type " { gre | ipip | sit } " +.BI " remote " ADDR " local " ADDR +.R " [ " +.BR encap " { fou | gue | none } " +.R " ] [ " +.BI "encap-sport { " PORT " | auto } " +.R " ] [ " +.BI "encap-dport " PORT +.R " ] [ " +.I " [no]encap-csum " +.R " ] [ " +.I " [no]encap-remcsum " +.R " ]" + +.in +8 +.sp +.BI remote " ADDR " +- specifies the remote address of the tunnel. + +.sp +.BI local " ADDR " +- specifies the fixed local address for tunneled packets. +It must be an address on another interface on this host. + +.sp +.BR encap " { fou | gue | none } " +- specifies type of secondary UDP encapsulation. "fou" indicates +Foo-Over-UDP, "gue" indicates Generic UDP Encapsulation. + +.sp +.BI "encap-sport { " PORT " | auto } " +- specifies the source port in UDP encapsulation. +.IR PORT +indicates the port by number, "auto" +indicates that the port number should be chosen automatically +(the kernel picks a flow based on the flow hash of the +encapsulated packet). + +.sp +.I [no]encap-csum +- specifies if UDP checksums are enabled in the secondary +encapsulation. + +.sp +.I [no]encap-remcsum +- specifies if Remote Checksum Offload is enabled. This is only +applicable for Generic UDP Encapsulation. + +.in -8 + +.TP IP6GRE/IP6GRETAP Type Support For a link of type .I IP6GRE/IP6GRETAP @@ -404,7 +461,7 @@ the following additional arguments are supported: .sp .BI local " ADDR " - specifies the fixed local IPv6 address for tunneled packets. -It must be and address on another interface on this host. +It must be an address on another interface on this host. .sp .BI [i|o]seq @@ -781,6 +838,15 @@ ip link help gre .RS 4 Display help for the gre link type. .RE +.PP +ip link add name tun1 type ipip remote 192.168.1.1 +local 192.168.1.2 ttl 225 encap gue encap-sport auto +encap-dport 5555 encap-csum encap-remcsum +.RS 4 +Creates an IPIP that is encapsulated with Generic UDP Encapsulation, +and the outer UDP checksum and remote checksum offload are enabled. + +.RE .SH SEE ALSO .br