| 1 |
.TH IP\-FOU 8 "2 Nov 2014" "iproute2" "Linux" |
| 2 |
.SH "NAME" |
| 3 |
ip-fou \- Foo-over-UDP receive port configuration |
| 4 |
.P |
| 5 |
ip-gue \- Generic UDP Encapsulation receive port configuration |
| 6 |
.SH "SYNOPSIS" |
| 7 |
.sp |
| 8 |
.ad l |
| 9 |
.in +8 |
| 10 |
.ti -8 |
| 11 |
.B ip |
| 12 |
.RI "[ " OPTIONS " ]" |
| 13 |
.B fou |
| 14 |
.RI " { " COMMAND " | " |
| 15 |
.BR help " }" |
| 16 |
.sp |
| 17 |
.ti -8 |
| 18 |
.BR "ip fou add" |
| 19 |
.B port |
| 20 |
.IR PORT |
| 21 |
.RB "{ " |
| 22 |
.B gue |
| 23 |
.RI "|" |
| 24 |
.B ipproto |
| 25 |
.IR PROTO |
| 26 |
.RB " }" |
| 27 |
.RB "[ " |
| 28 |
.B local |
| 29 |
.IR IFADDR |
| 30 |
.RB " ]" |
| 31 |
.RB "[ " |
| 32 |
.B peer |
| 33 |
.IR IFADDR |
| 34 |
.RB " ]" |
| 35 |
.RB "[ " |
| 36 |
.B peer_port |
| 37 |
.IR PORT |
| 38 |
.RB " ]" |
| 39 |
.RB "[ " |
| 40 |
.B dev |
| 41 |
.IR IFNAME |
| 42 |
.RB " ]" |
| 43 |
.br |
| 44 |
.ti -8 |
| 45 |
.BR "ip fou del" |
| 46 |
.B port |
| 47 |
.IR PORT |
| 48 |
.RB "[ " |
| 49 |
.B local |
| 50 |
.IR IFADDR |
| 51 |
.RB " ]" |
| 52 |
.RB "[ " |
| 53 |
.B peer |
| 54 |
.IR IFADDR |
| 55 |
.RB " ]" |
| 56 |
.RB "[ " |
| 57 |
.B peer_port |
| 58 |
.IR PORT |
| 59 |
.RB " ]" |
| 60 |
.RB "[ " |
| 61 |
.B dev |
| 62 |
.IR IFNAME |
| 63 |
.RB " ]" |
| 64 |
.br |
| 65 |
.ti -8 |
| 66 |
.B ip fou show |
| 67 |
.SH DESCRIPTION |
| 68 |
The |
| 69 |
.B ip fou |
| 70 |
commands are used to create and delete receive ports for Foo-over-UDP |
| 71 |
(FOU) as well as Generic UDP Encapsulation (GUE). |
| 72 |
.PP |
| 73 |
Foo-over-UDP allows encapsulating packets of an IP protocol directly |
| 74 |
over UDP. The receiver infers the protocol of a packet received on |
| 75 |
a FOU UDP port to be the protocol configured for the port. |
| 76 |
.PP |
| 77 |
Generic UDP Encapsulation (GUE) encapsulates packets of an IP protocol |
| 78 |
within UDP and an encapsulation header. The encapsulation header contains the |
| 79 |
IP protocol number for the encapsulated packet. |
| 80 |
.PP |
| 81 |
When creating a FOU or GUE receive port, the port number is specified in |
| 82 |
.I PORT |
| 83 |
argument. If FOU is used, the IP protocol number associated with the port is specified in |
| 84 |
.I PROTO |
| 85 |
argument. You can bind a port to a local address/interface, by specifying the |
| 86 |
address in the local |
| 87 |
.I IFADDR |
| 88 |
argument or the device in the |
| 89 |
.I IFNAME |
| 90 |
argument. If you would like to connect the port, you can specify the peer |
| 91 |
address in the peer |
| 92 |
.I IFADDR |
| 93 |
argument and peer port in the peer_port |
| 94 |
.I PORT |
| 95 |
argument. |
| 96 |
.PP |
| 97 |
A FOU or GUE receive port is deleted by specifying |
| 98 |
.I PORT |
| 99 |
in the delete command, as well as local address/interface or peer address/port |
| 100 |
(if set). |
| 101 |
.SH EXAMPLES |
| 102 |
.PP |
| 103 |
.SS Configure a FOU receive port for GRE bound to 7777 |
| 104 |
.nf |
| 105 |
# ip fou add port 7777 ipproto 47 |
| 106 |
.PP |
| 107 |
.SS Configure a FOU receive port for IPIP bound to 8888 |
| 108 |
.nf |
| 109 |
# ip fou add port 8888 ipproto 4 |
| 110 |
.PP |
| 111 |
.SS Configure a GUE receive port bound to 9999 |
| 112 |
.nf |
| 113 |
# ip fou add port 9999 gue |
| 114 |
.PP |
| 115 |
.SS Delete the GUE receive port bound to 9999 |
| 116 |
.nf |
| 117 |
# ip fou del port 9999 |
| 118 |
.SS Configure a FOU receive port for GRE bound to 1.2.3.4:7777 |
| 119 |
.nf |
| 120 |
# ip fou add port 7777 ipproto 47 local 1.2.3.4 |
| 121 |
.PP |
| 122 |
.SH SEE ALSO |
| 123 |
.br |
| 124 |
.BR ip (8) |
| 125 |
.SH AUTHOR |
| 126 |
Tom Herbert <[email protected]> |