ip-link: fix and extend documentation
* 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`
This commit is contained in:
parent
142434dc51
commit
503aa4e20d
|
|
@ -143,9 +143,13 @@ ip-link \- network device configuration
|
||||||
] |
|
] |
|
||||||
.br
|
.br
|
||||||
.B master
|
.B master
|
||||||
.IR DEVICE
|
.IR DEVICE " |"
|
||||||
.br
|
.br
|
||||||
.B nomaster
|
.B nomaster " |"
|
||||||
|
.br
|
||||||
|
.B addrgenmode { eui64 | none }
|
||||||
|
.br
|
||||||
|
.B link-netnsid ID
|
||||||
.BR " }"
|
.BR " }"
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -185,6 +189,8 @@ Link types:
|
||||||
.sp
|
.sp
|
||||||
.B bond
|
.B bond
|
||||||
- Bonding device
|
- Bonding device
|
||||||
|
.B can
|
||||||
|
- Controller Area Network interface
|
||||||
.sp
|
.sp
|
||||||
.B dummy
|
.B dummy
|
||||||
- Dummy network interface
|
- Dummy network interface
|
||||||
|
|
@ -265,6 +271,66 @@ specifies the number of receive queues for new device.
|
||||||
.BI index " IDX "
|
.BI index " IDX "
|
||||||
specifies the desired index of the new virtual device. The link creation fails, if the index is busy.
|
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
|
.TP
|
||||||
VXLAN Type Support
|
VXLAN Type Support
|
||||||
For a link of type
|
For a link of type
|
||||||
|
|
@ -284,7 +350,9 @@ the following additional arguments are supported:
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
.BI tos " TOS "
|
.BI tos " TOS "
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
.BI port " MIN MAX "
|
.BI dstport " PORT "
|
||||||
|
.R " ] [ "
|
||||||
|
.BI srcport " MIN MAX "
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
.I "[no]learning "
|
.I "[no]learning "
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
|
|
@ -296,6 +364,12 @@ the following additional arguments are supported:
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
.I "[no]l3miss "
|
.I "[no]l3miss "
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
|
.I "[no]udpcsum "
|
||||||
|
.R " ] [ "
|
||||||
|
.I "[no]udp6zerocsumtx "
|
||||||
|
.R " ] [ "
|
||||||
|
.I "[no]udp6zerocsumrx "
|
||||||
|
.R " ] [ "
|
||||||
.BI ageing " SECONDS "
|
.BI ageing " SECONDS "
|
||||||
.R " ] [ "
|
.R " ] [ "
|
||||||
.BI maxaddress " NUMBER "
|
.BI maxaddress " NUMBER "
|
||||||
|
|
@ -340,7 +414,11 @@ parameter.
|
||||||
- specifies the TOS value to use in outgoing packets.
|
- specifies the TOS value to use in outgoing packets.
|
||||||
|
|
||||||
.sp
|
.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
|
- specifies the range of port numbers to use as UDP
|
||||||
source ports to communicate to the remote VXLAN tunnel endpoint.
|
source ports to communicate to the remote VXLAN tunnel endpoint.
|
||||||
|
|
||||||
|
|
@ -365,6 +443,18 @@ are entered into the VXLAN device forwarding database.
|
||||||
.I [no]l3miss
|
.I [no]l3miss
|
||||||
- specifies if netlink IP ADDR miss notifications are generated.
|
- 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
|
.sp
|
||||||
.BI ageing " SECONDS"
|
.BI ageing " SECONDS"
|
||||||
- specifies the lifetime in seconds of FDB entries learnt by the kernel.
|
- specifies the lifetime in seconds of FDB entries learnt by the kernel.
|
||||||
|
|
@ -750,6 +840,12 @@ tool can be used. But it allows to change network namespace only for physical de
|
||||||
.BI alias " NAME"
|
.BI alias " NAME"
|
||||||
give the device a symbolic name for easy reference.
|
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
|
.TP
|
||||||
.BI vf " NUM"
|
.BI vf " NUM"
|
||||||
specify a Virtual Function device to be configured. The associated PF device
|
specify a Virtual Function device to be configured. The associated PF device
|
||||||
|
|
@ -829,6 +925,14 @@ set master device of the device (enslave device).
|
||||||
.BI nomaster
|
.BI nomaster
|
||||||
unset master device of the device (release device).
|
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
|
.PP
|
||||||
.B Warning:
|
.B Warning:
|
||||||
If multiple parameter changes are requested,
|
If multiple parameter changes are requested,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue