blob: a61be19a75951ddb78dd8b0b203dc324cbe3f58e [file] [log] [blame]
Ratan Gupta564282b2017-04-05 18:51:18 +05301description: >
2 This defines network tunneling parameters.
3
4# TODO Fix it through https://github.com/openbmc/openbmc/issues/1438
5# creatable: true
6
7properties:
8 - name: InterfaceName
9 type: string
10 description: >
11 Name of the interface.
12 - name: Local
13 type: string
14 description: >
15 Local endpoint of tunnel.
16 - name: Remote
17 type: string
18 description: >
19 Remote endpoint of tunnel.
20 - name: TOS
21 type: uint32
22 description: >
23 The Type Of Service byte value for a tunnel interface.
24 - name: TTL
25 type: uint32
26 description: >
27 Number of hops that a packet is permitted to travel.
28 - name: DiscoverPathMTU
29 type: boolean
30 description: >
31 When true, enables Path MTU Discovery on the tunnel.
32 - name: IPv6FlowLabel
33 type: uint32
34 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060035 Configures the 20-bit flow label. It can be configured to a value in
36 the range 0–0xFFFFF, or be set to "inherit", in which case the
Ratan Gupta564282b2017-04-05 18:51:18 +053037 original flowlabel is used.
38 - name: CopyDSCP
39 type: boolean
40 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060041 When true, the Differentiated Service Code Point (DSCP) field will be
42 copied to the inner header from outer header during the decapsulation
43 of an IPv6 tunnel packet.
Ratan Gupta564282b2017-04-05 18:51:18 +053044 - name: EncapsulationLimit
45 type: uint32
46 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060047 The Tunnel Encapsulation Limit option specifies how many additional
48 levels of encapsulation are permitted to be prepended to the packet.
Ratan Gupta564282b2017-04-05 18:51:18 +053049 - name: Key
50 type: string
51 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060052 This parameter specifies the same key to use in both directions
53 (InputKey= and OutputKey=).
Ratan Gupta564282b2017-04-05 18:51:18 +053054 - name: InputKey
55 type: string
56 description: >
57 This parameter specifies the key to use for input.
58 - name: OutputKey
59 type: string
60 description: >
61 This parameter specifies the key to use for output.
62 - name: Mode
63 type: enum[self.IPv6Tunnel]
64 description: >
65 An "ip6tnl" tunnel can be in one of three modes.
66 default: any
67
68enumerations:
69 - name: IPv6Tunnel
70 description: >
71 Possible IPv6 tunnel types.
72 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050073 - name: ip6ip6
74 description: >
75 IPv6 over IPv6.
76 - name: ipip6
77 description: >
78 IPv4 over IPv6.
79 - name: any
80 description: >
81 Either ip6ip6 or ipip6.