Skip to content

Commit fdc5191

Browse files
committed
Add IP tunnel document
Signed-off-by: Gris Ge <fge@redhat.com>
1 parent 38ef55f commit fdc5191

File tree

1 file changed

+67
-1
lines changed

1 file changed

+67
-1
lines changed

devel/yaml_api.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
* [IPVLAN Interface](#ipvlan-interface)
8080
* [HSR/PRP Interface](#hsrprp-interface)
8181
* [Routes](#routes)
82+
* [IP Tunnel Interface](#ip-tunnel-interface)
8283
* [Route Rules](#route-rules)
8384
* [DNS Resolver](#dns-resolver)
8485
* [Hostname](#hostname)
@@ -1830,9 +1831,19 @@ New feature since 2.2.22
18301831
HSR (High Availability Seamless Redundancy) and PRP (Parallel Redundancy
18311832
Protocol) interface are treat as `type: hsr`.
18321833

1833-
Example YAML for you to create a HSR interface:
1834+
Example YAML for PRP interface:
18341835

18351836
```yml
1837+
interfaces:
1838+
- name: hsr0
1839+
type: hsr
1840+
state: up
1841+
copy-mac-from: eth1
1842+
hsr:
1843+
port1: eth1
1844+
port2: eth2
1845+
multicast-spec: 40
1846+
protocol: prp
18361847
```
18371848

18381849
## Routes
@@ -1917,6 +1928,61 @@ Each route entry could have these parameters:
19171928
* `vrf-name`: String. Store the route to the route table which specified VRF
19181929
is binding to.
19191930

1931+
### IP Tunnel Interface
1932+
1933+
New feature since 2.2.59.
1934+
1935+
IP Tunnel interface. Example of IPv4-over-IPv4 tunnel
1936+
1937+
```yml
1938+
interfaces:
1939+
- name: ipip0
1940+
type: ip-tunnel
1941+
state: up
1942+
mtu: 1480
1943+
ipv4:
1944+
enabled: false
1945+
forwarding: false
1946+
ipv6:
1947+
enabled: false
1948+
ip-tunnel:
1949+
mode: ipip
1950+
local: 192.0.2.1
1951+
remote: 192.0.2.2
1952+
ttl: 42
1953+
tos: 22
1954+
pmtu-disc: true
1955+
fwmark: 0
1956+
```
1957+
1958+
Properties of `ip-tunnel` section:
1959+
* `mode`:
1960+
* `ipip`: IPv4-over-IPv4 tunnel
1961+
* `sit`: IPv6-over-IPv4(SIT, Simple Internet Transition) tunnel
1962+
* `ip6ip6`: IPv6-over-IPv6 tunnel
1963+
* `ipip6`: IPv4-over-IPv6 tunnel
1964+
* `base-iface`: The parent interface name of the IP tunnel based on.
1965+
* `local`: Local IP address
1966+
* `remote`: Remote IP address
1967+
* `ttl`: Time to live count, integer from 0 to 255
1968+
* `tos`: Type of service, integer from 0 to 255
1969+
* `flow-label`: Flow label for outgoing packet. Integer from 0 to 0xffffff.
1970+
* `ip6tun-flags`: Flags for `ipip6` and `ip6ip6`. Array of string with these
1971+
valid flags:
1972+
* `ign-encap-limit`
1973+
* `use-orig-tclass`
1974+
* `use-orig-flowlabel`
1975+
* `mip6-dev`
1976+
* `rcv-dscp-copy`
1977+
* `use-orig-fw-mark`
1978+
* `allow-local-remote`
1979+
* `cap-xmit`
1980+
* `cap-rcv`
1981+
* `cap-perpacket`
1982+
* `pmtu-disc`: Enable/disable Path MTU Discovery: boolean.
1983+
* `encap-limit`: Encapsulation limit: integer from 0 to 255
1984+
* `fwmark`: firewall mark: integer 0 to u32::MAX.
1985+
19201986
## Route Rules
19211987

19221988
This is the example of IP route rule:

0 commit comments

Comments
 (0)