Patchwork [2/2] iproute2 vxlan documentation update for ip command

login
register
mail settings
Submitter Thomas Richter
Date July 5, 2013, 7:08 a.m.
Message ID <1373008131-8057-2-git-send-email-tmricht@linux.vnet.ibm.com>
Download mbox | patch
Permalink /patch/257049/
State Superseded
Delegated to: stephen hemminger
Headers show

Comments

Thomas Richter - July 5, 2013, 7:08 a.m.
The ip link command line help and the ip-link.8.in
man page are outdated in regards to the vxlan support.
The patch updates both the command line help for the
ip command and its man page.

Signed-off-by: Thomas Richter <tmricht@linux.vnet.ibm.com>
---
 ip/iplink.c           |  2 +-
 man/man8/ip-link.8.in | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 86 insertions(+), 1 deletion(-)
Bjørn Mork - July 5, 2013, 8:22 a.m.
Thomas Richter <tmricht@linux.vnet.ibm.com> writes:

> The ip link command line help and the ip-link.8.in
> man page are outdated in regards to the vxlan support.
> The patch updates both the command line help for the
> ip command and its man page.
>
> Signed-off-by: Thomas Richter <tmricht@linux.vnet.ibm.com>
> ---
>  ip/iplink.c           |  2 +-
>  man/man8/ip-link.8.in | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 86 insertions(+), 1 deletion(-)
>
> diff --git a/ip/iplink.c b/ip/iplink.c
> index dc98019..f677329 100644
> --- a/ip/iplink.c
> +++ b/ip/iplink.c
> @@ -83,7 +83,7 @@ void iplink_usage(void)
>  
>  	if (iplink_have_newlink()) {
>  		fprintf(stderr, "\n");
> -		fprintf(stderr, "TYPE := { vlan | veth | vcan | dummy | ifb | macvlan | can |\n");
> +		fprintf(stderr, "TYPE := { vlan | vxlan | veth | vcan | dummy | ifb | macvlan | can |\n");
>  		fprintf(stderr, "          bridge | ipoib | ip6tnl | ipip | sit | vxlan }\n");

There was already a vxlan entry there.  Now there's two.


Bjørn
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Thomas Richter - July 5, 2013, 12:49 p.m.
On 07/05/2013 10:22 AM, Bjørn Mork wrote:
> Thomas Richter <tmricht@linux.vnet.ibm.com> writes:
> 
>> The ip link command line help and the ip-link.8.in
>> man page are outdated in regards to the vxlan support.
>> The patch updates both the command line help for the
>> ip command and its man page.
>>
>> Signed-off-by: Thomas Richter <tmricht@linux.vnet.ibm.com>
>> ---
>>  ip/iplink.c           |  2 +-
>>  man/man8/ip-link.8.in | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++
>>  2 files changed, 86 insertions(+), 1 deletion(-)
>>
>> diff --git a/ip/iplink.c b/ip/iplink.c
>> index dc98019..f677329 100644
>> --- a/ip/iplink.c
>> +++ b/ip/iplink.c
>> @@ -83,7 +83,7 @@ void iplink_usage(void)
>>  
>>  	if (iplink_have_newlink()) {
>>  		fprintf(stderr, "\n");
>> -		fprintf(stderr, "TYPE := { vlan | veth | vcan | dummy | ifb | macvlan | can |\n");
>> +		fprintf(stderr, "TYPE := { vlan | vxlan | veth | vcan | dummy | ifb | macvlan | can |\n");
>>  		fprintf(stderr, "          bridge | ipoib | ip6tnl | ipip | sit | vxlan }\n");
> 
> There was already a vxlan entry there.  Now there's two.
> 
> 
> Bjørn
> 

Thanks oversight on my side.

Patch

diff --git a/ip/iplink.c b/ip/iplink.c
index dc98019..f677329 100644
--- a/ip/iplink.c
+++ b/ip/iplink.c
@@ -83,7 +83,7 @@  void iplink_usage(void)
 
 	if (iplink_have_newlink()) {
 		fprintf(stderr, "\n");
-		fprintf(stderr, "TYPE := { vlan | veth | vcan | dummy | ifb | macvlan | can |\n");
+		fprintf(stderr, "TYPE := { vlan | vxlan | veth | vcan | dummy | ifb | macvlan | can |\n");
 		fprintf(stderr, "          bridge | ipoib | ip6tnl | ipip | sit | vxlan }\n");
 	}
 	exit(-1);
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index 2e89efe..86e0bc9 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -196,6 +196,91 @@  specifies the number of transmit queues for new device.
 .BI numrxqueues " QUEUE_COUNT "
 specifies the number of receive queues for new device.
 
+.TP
+VXLAN Type Support
+For a link of type 
+.I VXLAN
+the following additional arguments are supported:
+
+.BI "ip link add " DEVICE
+.BI type " vxlan " id " ID
+.R " [ "
+.BI dev " PHYS_DEV "
+.R " ] [ "
+.BI group " IPADDR "
+.R " ] [ "
+.BI local " IPADDR "
+.R " ] [ "
+.BI ttl " TTL "
+.R " ] [ "
+.BI tos " TOS "
+.R " ] [ "
+.BI port " MIN MAX "
+.R " ] [ "
+.I "[no]learning "
+.R " ] [ "
+.I "[no]proxy "
+.R " ] [ "
+.I "[no]rsc "
+.R " ] [ "
+.I "[no]l2miss "
+.R " ] [ "
+.I "[no]l3miss "
+.R " ]"
+
+.in +8
+.sp
+.BI  id " VNI "
+- specifies the VXLAN Network Identifer (or VXLAN Segment
+Identifier) to use.
+
+.BI dev " PHYS_DEV"
+- specifies the physical device to use for tunnel endpoint communication.
+
+.sp
+.BI group " IPADDR"
+- specifies the multicast IP address to join.
+
+.sp
+.BI local " IPADDR"
+- specifies the source IP address to use in outgoing packets.
+
+.sp
+.BI ttl " TTL"
+- specifies the TTL value to use in outgoing packets.
+
+.sp
+.BI tos " TOS"
+- specifies the TOS value to use in outgoing packets.
+
+.sp
+.BI port " MIN MAX"
+- specifies the range of port numbers to use as UDP
+source ports to communicate to the remote VXLAN tunnel endpoint.
+
+.sp
+.I [no]learning
+- specifies if unknown source link layer addresses and IP addresses
+are entered into the VXLAN device forwarding database.
+
+.sp
+.I [no]rsc
+- specifies if route short circuit is turned on.
+
+.sp
+.I [no]proxy
+- specifies ARP proxy is turned on.
+
+.sp
+.I [no]l2miss
+- specifies if netlink LLADDR miss notifications are generated.
+
+.sp
+.I [no]l3miss
+- specifies if netlink IP ADDR miss notifications are generated.
+
+.in -8
+
 .SS ip link delete - delete virtual link
 .I DEVICE
 specifies the virtual  device to act operate on.