Skip to content

Commit e97d083

Browse files
committed
Reorder the IP tunnel section
Signed-off-by: Gris Ge <fge@redhat.com>
1 parent fdc5191 commit e97d083

File tree

1 file changed

+57
-56
lines changed

1 file changed

+57
-56
lines changed

devel/yaml_api.md

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@
7878
* [Loopback Interface](#loopback-interface)
7979
* [IPVLAN Interface](#ipvlan-interface)
8080
* [HSR/PRP Interface](#hsrprp-interface)
81-
* [Routes](#routes)
8281
* [IP Tunnel Interface](#ip-tunnel-interface)
82+
* [Routes](#routes)
8383
* [Route Rules](#route-rules)
8484
* [DNS Resolver](#dns-resolver)
8585
* [Hostname](#hostname)
@@ -1846,6 +1846,62 @@ interfaces:
18461846
protocol: prp
18471847
```
18481848

1849+
### IP Tunnel Interface
1850+
1851+
New feature since 2.2.59.
1852+
1853+
IP Tunnel interface. Example of IPv4-over-IPv4 tunnel
1854+
1855+
```yml
1856+
interfaces:
1857+
- name: ipip0
1858+
type: ip-tunnel
1859+
state: up
1860+
mtu: 1480
1861+
ipv4:
1862+
enabled: false
1863+
forwarding: false
1864+
ipv6:
1865+
enabled: false
1866+
ip-tunnel:
1867+
mode: ipip
1868+
local: 192.0.2.1
1869+
remote: 192.0.2.2
1870+
ttl: 42
1871+
tos: 22
1872+
pmtu-disc: true
1873+
fwmark: 0
1874+
```
1875+
1876+
Properties of `ip-tunnel` section:
1877+
* `mode`:
1878+
* `ipip`: IPv4-over-IPv4 tunnel
1879+
* `sit`: IPv6-over-IPv4(SIT, Simple Internet Transition) tunnel
1880+
* `ip6ip6`: IPv6-over-IPv6 tunnel
1881+
* `ipip6`: IPv4-over-IPv6 tunnel
1882+
* `base-iface`: The parent interface name of the IP tunnel based on.
1883+
* `local`: Local IP address
1884+
* `remote`: Remote IP address
1885+
* `ttl`: Time to live count, integer from 0 to 255
1886+
* `tos`: Type of service, integer from 0 to 255
1887+
* `flow-label`: Flow label for outgoing packet. Integer from 0 to 0xffffff.
1888+
* `ip6tun-flags`: Flags for `ipip6` and `ip6ip6`. Array of string with these
1889+
valid flags:
1890+
* `ign-encap-limit`
1891+
* `use-orig-tclass`
1892+
* `use-orig-flowlabel`
1893+
* `mip6-dev`
1894+
* `rcv-dscp-copy`
1895+
* `use-orig-fw-mark`
1896+
* `allow-local-remote`
1897+
* `cap-xmit`
1898+
* `cap-rcv`
1899+
* `cap-perpacket`
1900+
* `pmtu-disc`: Enable/disable Path MTU Discovery: boolean.
1901+
* `encap-limit`: Encapsulation limit: integer from 0 to 255
1902+
* `fwmark`: firewall mark: integer 0 to u32::MAX.
1903+
1904+
18491905
## Routes
18501906

18511907
The `routes` top section of network state contains two type routes:
@@ -1928,61 +1984,6 @@ Each route entry could have these parameters:
19281984
* `vrf-name`: String. Store the route to the route table which specified VRF
19291985
is binding to.
19301986

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-
19861987
## Route Rules
19871988

19881989
This is the example of IP route rule:

0 commit comments

Comments
 (0)