netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Pavel Šimerda" <pavlix@pavlix.net>
To: netdev@vger.kernel.org
Cc: "Stephen Hemminger" <stephen@networkplumber.org>,
	"Vadim Kochan" <vadim4j@gmail.com>,
	"Daniel Borkmann" <daniel@iogearbox.net>,
	"Phil Sutter" <psutter@redhat.com>,
	"Pavel Šimerda" <psimerda@redhat.com>
Subject: [PATCH iproute2 2/3] ip-link: fix and extend documentation
Date: Wed, 12 Aug 2015 22:04:07 +0200	[thread overview]
Message-ID: <1439409848-26464-2-git-send-email-pavlix@pavlix.net> (raw)
In-Reply-To: <1439409848-26464-1-git-send-email-pavlix@pavlix.net>

From: Pavel Šimerda <psimerda@redhat.com>

 * Add `can` to list of supported link types
 * Document `addrgenmode`
 * Document `link-netnsid`
 * Document VLAN link type
 * Improve VXLAN link type documentation
    - Fix VXLAN srcport/dstport docs
    - Document `udpcsum`, `udp6zerocsumtx` and `udp6zerocsumrx`
---
 man/man8/ip-link.8.in | 112 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 108 insertions(+), 4 deletions(-)

diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index 372e6c6..9ff9a23 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -143,9 +143,13 @@ ip-link \- network device configuration
 ] |
 .br
 .B master
-.IR DEVICE
+.IR DEVICE " |"
 .br
-.B nomaster
+.B nomaster " |"
+.br
+.B addrgenmode { eui64 | none }
+.br
+.B link-netnsid ID
 .BR " }"
 
 
@@ -185,6 +189,8 @@ Link types:
 .sp
 .B bond
 - Bonding device
+.B can
+- Controller Area Network interface
 .sp
 .B dummy
 - Dummy network interface
@@ -266,6 +272,66 @@ specifies the number of receive queues for new device.
 specifies the desired index of the new virtual device. The link creation fails, if the index is busy.
 
 .TP
+VLAN Type Support
+For a link of type
+.I VLAN
+the following additional arguments are supported:
+
+.BI "ip link add
+.BI link " DEVICE "
+.BI name " NAME "
+.BI type " vlan "
+.R " [ "
+.BI protocol " VLAN_PROTO "
+.R " ] "
+.BI id " VLANID "
+.R " [ "
+.BR reorder_hdr " { " on " | " off " } "
+.R " ] "
+.R " [ "
+.BR gvrp " { " on " | " off " } "
+.R " ] "
+.R " [ "
+.BR mvrp " { " on " | " off " } "
+.R " ] "
+.R " [ "
+.BR loose_binding " { " on " | " off " } "
+.R " ] "
+.R " [ "
+.BI ingress-qos-map " QOS-MAP "
+.R " ] "
+.R " [ "
+.BI egress-qos-map " QOS-MAP "
+.R " ] "
+
+.in +8
+.sp
+.BI protocol " VLAN_PROTO "
+- either 802.1Q or 802.1ad.
+
+.BI id " VLANID "
+- specifies the VLAN Identifer to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadeimal, respectively.
+
+.BR reorder_hdr " { " on " | " off " } "
+- specifies whether ethernet headers are reordered or not.
+
+.BR gvrp " { " on " | " off " } "
+- specifies whether this VLAN should be registered using GARP VLAN Registration Protocol.
+
+.BR mvrp " { " on " | " off " } "
+- specifies whether this VLAN should be registered using Multiple VLAN Registration Protocol.
+
+.BR loose_binding " { " on " | " off " } "
+- specifies whether the VLAN device state is bound to the physical device state.
+
+.BI ingress-qos-map " QOS-MAP "
+- defines a mapping between priority code points on incoming frames.  The format is FROM:TO with multiple mappings separated by spaces.
+
+.BI egress-qos-map " QOS-MAP "
+- the same as ingress-qos-map but for outgoing frames.
+.in -8
+
+.TP
 VXLAN Type Support
 For a link of type
 .I VXLAN
@@ -284,7 +350,9 @@ the following additional arguments are supported:
 .R " ] [ "
 .BI tos " TOS "
 .R " ] [ "
-.BI port " MIN MAX "
+.BI dstport " PORT "
+.R " ] [ "
+.BI srcport " MIN MAX "
 .R " ] [ "
 .I "[no]learning "
 .R " ] [ "
@@ -296,6 +364,12 @@ the following additional arguments are supported:
 .R " ] [ "
 .I "[no]l3miss "
 .R " ] [ "
+.I "[no]udpcsum "
+.R " ] [ "
+.I "[no]udp6zerocsumtx "
+.R " ] [ "
+.I "[no]udp6zerocsumrx "
+.R " ] [ "
 .BI ageing " SECONDS "
 .R " ] [ "
 .BI maxaddress " NUMBER "
@@ -340,7 +414,11 @@ parameter.
 - specifies the TOS value to use in outgoing packets.
 
 .sp
-.BI port " MIN MAX"
+.BI dstport " PORT"
+- specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
+
+.sp
+.BI srcport " MIN MAX"
 - specifies the range of port numbers to use as UDP
 source ports to communicate to the remote VXLAN tunnel endpoint.
 
@@ -366,6 +444,18 @@ are entered into the VXLAN device forwarding database.
 - specifies if netlink IP ADDR miss notifications are generated.
 
 .sp
+.I [no]udpcsum
+- specifies if UDP checksum is filled in
+
+.sp
+.I [no]udp6zerocsumtx
+- specifies if UDP checksum is filled in
+
+.sp
+.I [no]udp6zerocsumrx
+- specifies if UDP checksum is received
+
+.sp
 .BI ageing " SECONDS"
 - specifies the lifetime in seconds of FDB entries learnt by the kernel.
 
@@ -751,6 +841,12 @@ tool can be used. But it allows to change network namespace only for physical de
 give the device a symbolic name for easy reference.
 
 .TP
+.BI group " GROUP"
+specify the group the device belongs to.
+The available groups are listed in file
+.BR "@SYSCONFDIR@/group" .
+
+.TP
 .BI vf " NUM"
 specify a Virtual Function device to be configured. The associated PF device
 must be specified using the
@@ -829,6 +925,14 @@ set master device of the device (enslave device).
 .BI nomaster
 unset master device of the device (release device).
 
+.TP
+.BR "addrgenmode eui64 " or " addrgenmode none"
+set IPv6 address generation mode
+
+.TP
+.BR "link-netnsid "
+set peer netnsid for a cross-netns interface
+
 .PP
 .B Warning:
 If multiple parameter changes are requested,
-- 
2.4.1

  reply	other threads:[~2015-08-12 20:08 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-12 20:04 [PATCH iproute2 1/3] ip: fix and extend documentation Pavel Šimerda
2015-08-12 20:04 ` Pavel Šimerda [this message]
2015-08-13  6:28   ` [PATCH iproute2 2/3] ip-link: " vkochan
2015-08-12 20:04 ` [PATCH iproute2 3/3] ip-address: " Pavel Šimerda

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1439409848-26464-2-git-send-email-pavlix@pavlix.net \
    --to=pavlix@pavlix.net \
    --cc=daniel@iogearbox.net \
    --cc=netdev@vger.kernel.org \
    --cc=psimerda@redhat.com \
    --cc=psutter@redhat.com \
    --cc=stephen@networkplumber.org \
    --cc=vadim4j@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).