netlink/specs/ovs_flow.yaml

1 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
5 protocol: genetlink-legacy
6 uapi-header: linux/openvswitch.h
12   -
13     name: ovs-header
18       -
19         name: dp-ifindex
24   -
25     name: ovs-flow-stats
28       -
29         name: n-packets
32       -
33         name: n-bytes
36   -
37     name: ovs-key-ethernet
40       -
41         name: eth-src
44         display-hint: mac
45       -
46         name: eth-dst
49         display-hint: mac
50   -
51     name: ovs-key-mpls
54       -
55         name: mpls-lse
57         byte-order: big-endian
58   -
59     name: ovs-key-ipv4
62       -
63         name: ipv4-src
65         byte-order: big-endian
66         display-hint: ipv4
67       -
68         name: ipv4-dst
70         byte-order: big-endian
71         display-hint: ipv4
72       -
73         name: ipv4-proto
75       -
76         name: ipv4-tos
78       -
79         name: ipv4-ttl
81       -
82         name: ipv4-frag
84         enum: ovs-frag-type
85   -
86     name: ovs-key-ipv6
89       -
90         name: ipv6-src
93         byte-order: big-endian
94         display-hint: ipv6
95       -
96         name: ipv6-dst
99         byte-order: big-endian
100         display-hint: ipv6
101       -
102         name: ipv6-label
104         byte-order: big-endian
105       -
106         name: ipv6-proto
108       -
109         name: ipv6-tclass
111       -
112         name: ipv6-hlimit
114       -
115         name: ipv6-frag
117   -
118     name: ovs-key-ipv6-exthdrs
121       -
124   -
125     name: ovs-frag-type
126     name-prefix: ovs-frag-type-
129       -
132       -
135       -
138       -
141   -
142     name: ovs-key-tcp
145       -
146         name: tcp-src
148         byte-order: big-endian
149       -
150         name: tcp-dst
152         byte-order: big-endian
153   -
154     name: ovs-key-udp
157       -
158         name: udp-src
160         byte-order: big-endian
161       -
162         name: udp-dst
164         byte-order: big-endian
165   -
166     name: ovs-key-sctp
169       -
170         name: sctp-src
172         byte-order: big-endian
173       -
174         name: sctp-dst
176         byte-order: big-endian
177   -
178     name: ovs-key-icmp
181       -
182         name: icmp-type
184       -
185         name: icmp-code
187   -
188     name: ovs-key-arp
191       -
192         name: arp-sip
194         byte-order: big-endian
195       -
196         name: arp-tip
198         byte-order: big-endian
199       -
200         name: arp-op
202         byte-order: big-endian
203       -
204         name: arp-sha
207         display-hint: mac
208       -
209         name: arp-tha
212         display-hint: mac
213   -
214     name: ovs-key-nd
217       -
221         byte-order: big-endian
222       -
223         name: nd-sll
226         display-hint: mac
227       -
228         name: nd-tll
231         display-hint: mac
232   -
233     name: ovs-key-ct-tuple-ipv4
236       -
237         name: ipv4-src
239         byte-order: big-endian
240       -
241         name: ipv4-dst
243         byte-order: big-endian
244       -
245         name: src-port
247         byte-order: big-endian
248       -
249         name: dst-port
251         byte-order: big-endian
252       -
253         name: ipv4-proto
255   -
256     name: ovs-action-push-vlan
259       -
262         byte-order: big-endian
264       -
267         byte-order: big-endian
269   -
270     name: ovs-ufid-flags
271     name-prefix: ovs-ufid-f-
274       - omit-key
275       - omit-mask
276       - omit-actions
277   -
278     name: ovs-action-hash
281       -
282         name: hash-alg
285       -
286         name: hash-basis
289   -
290     name: ovs-hash-alg
297       - ovs-hash-alg-l4
299   -
300     name: ovs-action-push-mpls
303       -
304         name: mpls-lse
306         byte-order: big-endian
309       -
310         name: mpls-ethertype
312         byte-order: big-endian
317   -
318     name: ovs-action-add-mpls
321       -
322         name: mpls-lse
324         byte-order: big-endian
327       -
328         name: mpls-ethertype
330         byte-order: big-endian
335       -
336         name: tun-flags
340   -
341     name: ct-state-flags
343     name-prefix: ovs-cs-f-
345       -
348       -
351       -
354       -
355         name: reply-dir
357       -
360       -
363       -
364         name: src-nat
366       -
367         name: dst-nat
370 attribute-sets:
371   -
372     name: flow-attrs
373     enum-name: ovs-flow-attr
374     name-prefix: ovs-flow-attr-
376       -
379         nested-attributes: key-attrs
383       -
386         nested-attributes: action-attrs
394       -
397         struct: ovs-flow-stats
401       -
402         name: tcp-flags
405           An 8-bit value giving the ORed value of all of the TCP flags seen on
408       -
412           A 64-bit integer giving the time, in milliseconds on the system
416       -
420           If present in a OVS_FLOW_CMD_SET request, clears the last-used time,
423       -
426         nested-attributes: key-attrs
434       -
439       -
443           A value between 1-16 octets specifying a unique identifier for the
448         display-hint: uuid
449       -
450         name: ufid-flags
452         enum: ovs-ufid-flags
454           A 32-bit value of ORed flags that provide alternative semantics for
456       -
460   -
461     name: key-attrs
462     enum-name: ovs-key-attr
463     name-prefix: ovs-key-attr-
465       -
468         nested-attributes: key-attrs
469       -
472       -
473         name: in-port
475       -
478         struct: ovs-key-ethernet
480       -
483         byte-order: big-endian
484       -
487         byte-order: big-endian
488       -
491         struct: ovs-key-ipv4
492       -
495         struct: ovs-key-ipv6
497       -
500         struct: ovs-key-tcp
501       -
504         struct: ovs-key-udp
505       -
508         struct: ovs-key-icmp
509       -
512         struct: ovs-key-icmp
513       -
516         struct: ovs-key-arp
518       -
521         struct: ovs-key-nd
523       -
524         name: skb-mark
526       -
529         nested-attributes: tunnel-key-attrs
530       -
533         struct: ovs-key-sctp
534       -
535         name: tcp-flags
537         byte-order: big-endian
538       -
539         name: dp-hash
542       -
543         name: recirc-id
545       -
548         struct: ovs-key-mpls
549       -
550         name: ct-state
552         enum: ct-state-flags
553         enum-as-flags: true
554       -
555         name: ct-zone
558       -
559         name: ct-mark
562       -
563         name: ct-labels
565         display-hint: hex
566         doc: 16-octet connection tracking label
567       -
568         name: ct-orig-tuple-ipv4
570         struct: ovs-key-ct-tuple-ipv4
571       -
572         name: ct-orig-tuple-ipv6
575       -
578         nested-attributes: ovs-nsh-key-attrs
579       -
580         name: packet-type
582         byte-order: big-endian
584       -
585         name: nd-extensions
588       -
589         name: tunnel-info
592       -
593         name: ipv6-exthdrs
595         struct: ovs-key-ipv6-exthdrs
597   -
598     name: action-attrs
599     enum-name: ovs-action-attr
600     name-prefix: ovs-action-attr-
602       -
606       -
609         nested-attributes: userspace-attrs
610       -
613         nested-attributes: key-attrs
615       -
616         name: push-vlan
618         struct: ovs-action-push-vlan
620       -
621         name: pop-vlan
624       -
627         nested-attributes: sample-attrs
630       -
634       -
637         struct: ovs-action-hash
638       -
639         name: push-mpls
641         struct: ovs-action-push-mpls
646       -
647         name: pop-mpls
649         byte-order: big-endian
651       -
652         name: set-masked
654         nested-attributes: key-attrs
660           non-masked value bits must be passed in as zeroes. Masking is not
662       -
665         nested-attributes: ct-attrs
667           Track the connection. Populate the conntrack-related entries
669       -
673       -
674         name: push-eth
677       -
678         name: pop-eth
680       -
681         name: ct-clear
683       -
684         name: push-nsh
686         nested-attributes: ovs-nsh-key-attrs
689       -
690         name: pop-nsh
694       -
700       -
703         nested-attributes: action-attrs
707       -
708         name: check-pkt-len
710         nested-attributes: check-pkt-len-attrs
714       -
715         name: add-mpls
717         struct: ovs-action-add-mpls
722       -
723         name: dec-ttl
725         nested-attributes: dec-ttl-attrs
726   -
727     name: tunnel-key-attrs
728     enum-name: ovs-tunnel-key-attr
729     name-prefix: ovs-tunnel-key-attr-
731       -
734         byte-order: big-endian
736       -
737         name: ipv4-src
739         byte-order: big-endian
740       -
741         name: ipv4-dst
743         byte-order: big-endian
744       -
747       -
750       -
751         name: dont-fragment
753       -
756       -
759       -
760         name: geneve-opts
762         sub-type: u32
763       -
764         name: tp-src
766         byte-order: big-endian
767       -
768         name: tp-dst
770         byte-order: big-endian
771       -
772         name: vxlan-opts
774         nested-attributes: vxlan-ext-attrs
775       -
776         name: ipv6-src
780       -
781         name: ipv6-dst
785       -
788       -
789         name: erspan-opts
793       -
794         name: ipv4-info-bridge
796   -
797     name: check-pkt-len-attrs
798     enum-name: ovs-check-pkt-len-attr
799     name-prefix: ovs-check-pkt-len-attr-
801       -
802         name: pkt-len
804       -
805         name: actions-if-greater
807         nested-attributes: action-attrs
808       -
809         name: actions-if-less-equal
811         nested-attributes: action-attrs
812   -
813     name: sample-attrs
814     enum-name: ovs-sample-attr
815     name-prefix: ovs-sample-attr-
817       -
820       -
823         nested-attributes: action-attrs
824   -
825     name: userspace-attrs
826     enum-name: ovs-userspace-attr
827     name-prefix: ovs-userspace-attr-
829       -
832       -
835       -
836         name: egress-tun-port
838       -
841   -
842     name: ovs-nsh-key-attrs
843     enum-name: ovs-nsh-key-attr
844     name-prefix: ovs-nsh-key-attr-
846       -
849       -
852       -
855   -
856     name: ct-attrs
857     enum-name: ovs-ct-attr
858     name-prefix: ovs-ct-attr-
860       -
863       -
866       -
869       -
872       -
875       -
878         nested-attributes: nat-attrs
879       -
880         name: force-commit
882       -
885       -
888   -
889     name: nat-attrs
890     enum-name: ovs-nat-attr
891     name-prefix: ovs-nat-attr-
893       -
896       -
899       -
900         name: ip-min
902       -
903         name: ip-max
905       -
906         name: proto-min
908       -
909         name: proto-max
911       -
914       -
915         name: proto-hash
917       -
918         name: proto-random
920   -
921     name: dec-ttl-attrs
922     enum-name: ovs-dec-ttl-attr
923     name-prefix: ovs-dec-ttl-attr-
925       -
928         nested-attributes: action-attrs
929   -
930     name: vxlan-ext-attrs
931     enum-name: ovs-vxlan-ext-
932     name-prefix: ovs-vxlan-ext-
934       -
939   name-prefix: ovs-flow-cmd-
940   fixed-header: ovs-header
942     -
946       attribute-set: flow-attrs
947       do: &flow-get-op
950             - dp-ifindex
951             - key
952             - ufid
953             - ufid-flags
956             - dp-ifindex
957             - key
958             - ufid
959             - mask
960             - stats
961             - actions
962       dump: *flow-get-op
963     -
967       attribute-set: flow-attrs
971             - dp-ifindex
972             - key
973             - ufid
974             - mask
975             - actions
977 mcast-groups:
979     -