1 module openflow-protocol {
\r
2 namespace "urn:opendaylight:openflow:protocol";
\r
5 import ietf-inet-types {prefix inet;}
\r
6 import ietf-yang-types {prefix yang;}
\r
8 import openflow-types {prefix oft;}
\r
9 import openflow-extensible-match { prefix oxm;}
\r
10 import openflow-instruction { prefix ofinstruction;}
\r
11 import openflow-action {prefix ofaction;}
\r
13 revision "2013-07-31" {
\r
14 description "OpenFlow 1.3 - protocol objects model";
\r
17 // Generic Structures
\r
19 // reference "ofp_port";
\r
21 // reference "ofp_port.port_no";
\r
25 // reference "ofp_port.hw_addr";
\r
26 type yang:mac-address;
\r
29 // reference "ofp_port.name";
\r
33 // reference "ofp_port.config";
\r
34 type oft:port-config;
\r
37 // reference "ofp_port.state";
\r
38 type oft:port-state;
\r
40 leaf current-features {
\r
41 description "Current features.";
\r
42 // reference "ofp_port.curr";
\r
43 type oft:port-features;
\r
45 leaf advertised-features {
\r
46 description "Features being advertised by the port.";
\r
47 // reference "ofp_port.advertised";
\r
48 type oft:port-features;
\r
50 leaf supported-features {
\r
51 description "Features supported by the port.";
\r
52 // reference "ofp_port.supported";
\r
53 type oft:port-features;
\r
55 leaf peer-features {
\r
56 description "Features advertised by peer.";
\r
57 // reference "ofp_port.peer";
\r
58 type oft:port-features;
\r
61 description "Current port bitrate in kbps.";
\r
62 // reference "ofp_port.curr_speed";
\r
67 description "Max port bitrate in kbps";
\r
68 // reference "ofp_port.max_speed";
\r
75 // reference "ofp_port.config";
\r
76 type oft:port-config-v10;
\r
79 // reference "ofp_port.state";
\r
80 type oft:port-state-v10;
\r
82 leaf current-features-v10 {
\r
83 description "Current features.";
\r
84 // reference "ofp_port.curr";
\r
85 type oft:port-features-v10;
\r
87 leaf advertised-features-v10 {
\r
88 description "Features being advertised by the port.";
\r
89 // reference "ofp_port.advertised";
\r
90 type oft:port-features-v10;
\r
92 leaf supported-features-v10 {
\r
93 description "Features supported by the port.";
\r
94 // reference "ofp_port.supported";
\r
95 type oft:port-features-v10;
\r
97 leaf peer-features-v10 {
\r
98 description "Features advertised by peer.";
\r
99 // reference "ofp_port.peer";
\r
100 type oft:port-features-v10;
\r
104 grouping match-grouping {
\r
108 base oft:match-type-base;
\r
111 uses oxm:oxm-fields;
\r
116 list buckets-list {
\r
126 type oft:port-number;
\r
132 uses ofaction:actions;
\r
135 container table-features-properties-container {
\r
136 uses table-features-properties;
\r
139 grouping table-features-properties {
\r
140 list table-feature-properties {
\r
142 type oft:table-features-prop-type;
\r
147 // # MESSAGE Structures
\r
148 /* Immutable messages. */
\r
149 grouping ofHeader {
\r
150 //reference "ofpt_header struct in Openflow Switch 1.3 Spec"
\r
153 //reference "OpenFlow Header - OFP_VERSION";
\r
157 //reference "OpenFlow Header - transaction id";
\r
160 grouping ofHelloElementHeader {
\r
161 //reference "ofpt_hello_elem_header struct in Openflow Switch 1.3 Spec"
\r
163 type oft:hello-element-type;
\r
164 //reference "OpenFlow Header element type - OFPHET_*";
\r
168 // reference "OFPT_HELLO message in Openflow Switch 1.3 Spec"
\r
169 /* Symmetric message */
\r
173 uses ofHelloElementHeader;
\r
175 leaf-list version-bitmap {
\r
181 // reference "OFPT_ERROR message in Openflow Switch 1.3 Spec"
\r
182 /* Symmetric message */
\r
201 grouping echo-request {
\r
202 // reference "OFPT_ECHO_REQUEST message in Openflow Switch 1.3 Spec"
\r
203 /* Symmetric message */
\r
210 grouping echo-reply {
\r
211 // reference "OFPT_ECHO_REPLY message in Openflow Switch 1.3 Spec"
\r
212 /* Symmetric message */
\r
219 grouping experimenter {
\r
220 // reference "OFPT_EXPERIMENTER message in Openflow Switch 1.3 Spec"
\r
221 /* Symmetric message */
\r
224 leaf experimenter {
\r
234 /* Switch configuration messages. */
\r
235 grouping features-request {
\r
236 // reference "OFPT_FEATURES_REQUEST message in Openflow Switch 1.3 Spec"
\r
237 /* Controller/switch message */
\r
240 grouping features-reply {
\r
241 // reference "OFPT_FEATURES_REPLY message in Openflow Switch 1.3 Spec"
\r
242 /* Controller/switch message */
\r
257 leaf capabilities {
\r
258 type oft:capabilities;
\r
263 // OF1.0 structures
\r
264 leaf capabilities-v10 {
\r
265 type oft:capabilities-v10;
\r
268 type oft:action-type-v10;
\r
274 grouping get-config-request {
\r
275 // reference "OFPT_GET_CONFIG_REQUEST message in Openflow Switch 1.3 Spec"
\r
276 /* Controller/switch message */
\r
279 grouping get-config-reply {
\r
280 // reference "OFPT_GET_CONFIG_REPLY message in Openflow Switch 1.3 Spec"
\r
281 /* Controller/switch message */
\r
285 type oft:switch-config-flag;
\r
287 leaf miss-send-len {
\r
291 grouping set-config {
\r
292 // reference "OFPT_SET_CONFIG message in Openflow Switch 1.3 Spec"
\r
293 /* Controller/switch message */
\r
298 type oft:switch-config-flag;
\r
300 leaf miss-send-len {
\r
304 /* Asynchronous messages. */
\r
305 grouping packet-in {
\r
306 // reference "OFPT_PACKET_IN message in Openflow Switch 1.3 Spec"
\r
307 /* Async message */
\r
312 // ID assigned by datapath.
\r
316 // Full length of frame.
\r
320 // Reason packet is being sent (one of OFPR_*)
\r
321 type oft:packet-in-reason;
\r
324 // ID of the table that was looked up
\r
328 // Cookie of the flow entry that was looked up.
\r
331 uses match-grouping;
\r
333 // struct ofp_match match; /* Packet metadata. Variable size. */
\r
334 // /* The variable size and padded match is always followed by:
\r
335 // * - Exactly 2 all-zero padding bytes, then
\r
336 // * - An Ethernet frame whose length is inferred from header.length.
\r
337 // * The padding bytes preceding the Ethernet frame ensure that the IP
\r
338 // * header (if any) following the Ethernet header is 32-bit aligned.
\r
344 // OF1.0 structures
\r
349 grouping flow-removed {
\r
350 // reference "OFPT_FLOW_REMOVED message in Openflow Switch 1.3 Spec"
\r
351 /* Async message */
\r
361 type oft:flow-removed-reason;
\r
366 leaf duration-sec {
\r
369 leaf duration-nsec {
\r
372 leaf idle-timeout {
\r
375 leaf hard-timeout {
\r
378 leaf packet-count {
\r
384 uses match-grouping;
\r
386 // OF1.0 structures
\r
387 uses oxm:match-v10-grouping;
\r
389 grouping port-status {
\r
390 // reference "OFPT_PORT_STATUS message in Openflow Switch 1.3 Spec"
\r
397 type oft:port-reason;
\r
399 } /* Async message */
\r
400 /* Controller command messages. */
\r
401 grouping packet-out {
\r
402 // reference "OFPT_PACKET_OUT message in Openflow Switch 1.3 Spec"
\r
403 /* Controller/switch message */
\r
407 uses ofaction:actions;
\r
416 type oft:port-number;
\r
419 grouping flow-mod {
\r
420 // reference "OFPT_FLOW_MOD message in Openflow Switch 1.3 Spec"
\r
421 /* Controller/switch message */
\r
435 type oft:flow-mod-command;
\r
437 leaf idle-timeout {
\r
440 leaf hard-timeout {
\r
450 type oft:port-number;
\r
456 type oft:flow-mod-flags;
\r
458 uses match-grouping;
\r
460 uses ofinstruction:instructions;
\r
462 // OF1.0 structures
\r
464 type oft:flow-mod-flags-v10;
\r
466 uses oxm:match-v10-grouping;
\r
467 uses ofaction:actions;
\r
469 grouping group-mod {
\r
470 // reference "OFPT_GROUP_MOD message in Openflow Switch 1.3 Spec"
\r
471 /* Controller/switch message */
\r
476 type oft:group-mod-command;
\r
479 type oft:group-type;
\r
488 grouping port-mod {
\r
489 // reference "OFPT_PORT_MOD message in Openflow Switch 1.3 Spec"
\r
490 /* Controller/switch message */
\r
495 type oft:port-number;
\r
498 type yang:mac-address;
\r
501 type oft:port-config;
\r
504 type oft:port-config;
\r
507 type oft:port-features;
\r
509 // OF1.0 structures
\r
511 type oft:port-config-v10;
\r
514 type oft:port-config-v10;
\r
516 leaf advertise-v10 {
\r
517 type oft:port-features-v10;
\r
520 grouping table-mod {
\r
521 // reference "OFPT_TABLE_MOD message in Openflow Switch 1.3 Spec"
\r
522 /* Controller/switch message */
\r
530 type oft:table-config;
\r
534 /* Multipart messages. */
\r
535 grouping multipart-request {
\r
536 // reference "OFPT_MULTIPART_REQUEST message in Openflow Switch 1.3 Spec"
\r
537 /* Controller/switch message */
\r
542 type oft:multipart-type;
\r
545 type oft:multipart-request-flags;
\r
547 choice multipart-request-body {
\r
548 case multipart-request-desc {
\r
553 case multipart-request-flow {
\r
569 uses match-grouping;
\r
571 // OF1.0 structures
\r
572 uses oxm:match-v10-grouping;
\r
574 case multipart-request-aggregate {
\r
590 uses match-grouping;
\r
592 // OF1.0 structures
\r
593 uses oxm:match-v10-grouping;
\r
595 case multipart-request-table {
\r
600 case multipart-request-port-stats {
\r
605 case multipart-request-queue {
\r
613 case multipart-request-group {
\r
618 case multipart-request-group-desc {
\r
623 case multipart-request-group-features {
\r
628 case multipart-request-meter {
\r
633 case multipart-request-meter-config {
\r
638 case multipart-request-meter-features {
\r
643 case multipart-request-table-features {
\r
644 list table-features {
\r
651 leaf metadata-match {
\r
654 leaf metadata-write {
\r
658 type oft:table-config;
\r
663 uses table-features-properties;
\r
666 case multipart-request-port-desc {
\r
671 case multipart-request-experimenter {
\r
672 leaf experimenter {
\r
684 grouping multipart-reply {
\r
685 // reference "OFPT_MULTIPART_REPLY message in Openflow Switch 1.3 Spec"
\r
686 /* Controller/switch message */
\r
691 type oft:multipart-type;
\r
694 type oft:multipart-request-flags;
\r
696 choice multipart-reply-body {
\r
697 case multipart-reply-desc {
\r
714 case multipart-reply-flow {
\r
719 leaf duration-sec {
\r
722 leaf duration-nsec {
\r
728 leaf idle-timeout {
\r
731 leaf hard-timeout {
\r
735 type oft:flow-mod-flags;
\r
740 leaf packet-count {
\r
746 uses match-grouping;
\r
748 uses ofinstruction:instructions;
\r
750 // OF1.0 structures
\r
751 uses oxm:match-v10-grouping;
\r
752 uses ofaction:actions;
\r
755 case multipart-reply-aggregate {
\r
756 leaf packet-count {
\r
766 case multipart-reply-table {
\r
771 leaf active-count {
\r
774 leaf lookup-count {
\r
777 leaf matched-count {
\r
781 // OF1.0 structures
\r
787 case multipart-reply-port-stats {
\r
816 leaf rx-frame-err {
\r
828 leaf duration-sec {
\r
831 leaf duration-nsec {
\r
836 case multipart-reply-queue {
\r
853 leaf duration-sec {
\r
856 leaf duration-nsec {
\r
861 case multipart-reply-group {
\r
869 leaf packet-count {
\r
875 leaf duration-sec {
\r
878 leaf duration-nsec {
\r
881 list bucket-stats {
\r
882 leaf packet-count {
\r
891 case multipart-reply-group-desc {
\r
894 type oft:group-type;
\r
902 case multipart-reply-group-features {
\r
904 type oft:group-types;
\r
906 leaf capabilities {
\r
907 type oft:group-capabilities;
\r
909 leaf-list max_groups {
\r
912 leaf-list actions-bitmap {
\r
913 type oft:action-type;
\r
916 case multipart-reply-meter {
\r
924 leaf packet-in-count {
\r
927 leaf byte-in-count {
\r
930 leaf duration-sec {
\r
933 leaf duration-nsec {
\r
936 list meter-band-stats {
\r
937 leaf packet-band-count {
\r
940 leaf byte-band-count {
\r
946 case multipart-reply-meter-config {
\r
947 list meter-config {
\r
949 type oft:meter-flags;
\r
955 uses meter-band-header;
\r
959 case multipart-reply-meter-features {
\r
964 type oft:meter-band-type-bitmap;
\r
966 leaf capabilities {
\r
967 type oft:meter-flags;
\r
976 case multipart-reply-table-features {
\r
977 list table-features {
\r
984 leaf metadata-match {
\r
987 leaf metadata-write {
\r
991 type oft:table-config;
\r
996 uses table-features-properties;
\r
999 case multipart-reply-port-desc {
\r
1004 case multipart-reply-experimenter {
\r
1005 leaf experimenter {
\r
1017 /* Barrier messages. */
\r
1018 grouping barrier-request {
\r
1019 // reference "OFPT_BARRIER_REQUEST message in Openflow Switch 1.3 Spec"
\r
1020 /* Controller/switch message */
\r
1023 grouping barrier-reply {
\r
1024 // reference "OFPT_BARRIER_REPLY message in Openflow Switch 1.3 Spec"
\r
1025 /* Controller/switch message */
\r
1028 /* Queue Configuration messages. */
\r
1029 grouping queue-get-config-request {
\r
1030 // reference "OFPT_QUEUE_GET_CONFIG_REQUEST message in Openflow Switch 1.3 Spec"
\r
1031 /* Controller/switch message */
\r
1036 type oft:port-number;
\r
1039 grouping queue-get-config-reply {
\r
1040 // reference "OFPT_QUEUE_GET_CONFIG_REPLY message in Openflow Switch 1.3 Spec"
\r
1041 /* Controller/switch message */
\r
1046 type oft:port-number;
\r
1049 uses packet-queue;
\r
1052 grouping packet-queue {
\r
1054 type oft:queue-id;
\r
1057 type oft:port-number;
\r
1059 uses queue-property-header;
\r
1061 container queue-prop-container {
\r
1062 uses queue-property-header;
\r
1064 grouping queue-property-header {
\r
1065 list queue-property {
\r
1067 type oft:queue-properties;
\r
1071 /* Controller role change request messages. */
\r
1072 grouping role-request {
\r
1073 // reference "OFPT_ROLE_REQUEST message in Openflow Switch 1.3 Spec"
\r
1074 /* Controller/switch message */
\r
1079 type oft:controller-role;
\r
1081 leaf generation-id {
\r
1085 grouping role-reply {
\r
1086 // reference "OFPT_ROLE_REPLY message in Openflow Switch 1.3 Spec"
\r
1087 /* Controller/switch message */
\r
1092 type oft:controller-role;
\r
1094 leaf generation-id {
\r
1098 /* Asynchronous message configuration. */
\r
1099 grouping get-async-request {
\r
1100 // reference "OFPT_GET_ASYNC_REQUEST message in Openflow Switch 1.3 Spec"
\r
1101 /* Controller/switch message */
\r
1105 grouping get-async-reply {
\r
1106 // reference "OFPT_GET_ASYNC_REPLY message in Openflow Switch 1.3 Spec"
\r
1107 /* Controller/switch message */
\r
1110 uses async-body-grouping;
\r
1112 grouping set-async {
\r
1113 // reference "OFPT_SET_ASYNC message in Openflow Switch 1.3 Spec"
\r
1114 /* Controller/switch message */
\r
1117 uses async-body-grouping;
\r
1120 grouping async-body-grouping {
\r
1121 list packet-in-mask {
\r
1123 type oft:packet-in-reason;
\r
1126 list port-status-mask {
\r
1128 type oft:port-reason;
\r
1131 list flow-removed-mask {
\r
1133 type oft:flow-removed-reason;
\r
1137 /* Meters and rate limiters configuration messages. */
\r
1138 grouping meter-mod {
\r
1139 // reference "OFPT_METER_MOD message in Openflow Switch 1.3 Spec"
\r
1140 /* Controller/switch message */
\r
1145 type oft:meter-mod-command;
\r
1148 type oft:meter-flags;
\r
1151 type oft:meter-id;
\r
1154 uses meter-band-header;
\r
1158 grouping meter-band-header {
\r
1159 choice meter-band {
\r
1160 case meter-band-drop {
\r
1161 uses meter-band-commons;
\r
1163 case meter-band-dscp-remark {
\r
1164 uses meter-band-commons;
\r
1169 case meter-band-experimenter {
\r
1170 uses meter-band-commons;
\r
1171 leaf experimenter {
\r
1178 grouping meter-band-commons {
\r
1180 type oft:meter-band-type;
\r
1190 /* Immutable messages. */
\r
1191 notification hello-message {
\r
1193 // reference "OFPT_HELLO message in Openflow Switch 1.3 Spec"
\r
1195 /* Symmetric message */
\r
1197 notification error-message {
\r
1199 // reference "OFPT_ERROR message in Openflow Switch 1.3 Spec"
\r
1201 /* Symmetric message */
\r
1203 notification echo-request-message {
\r
1204 uses echo-request;
\r
1205 // reference "OFPT_ECHO_REQUEST message in Openflow Switch 1.3 Spec"
\r
1207 /* Symmetric message */
\r
1209 notification experimenter-message {
\r
1210 uses experimenter;
\r
1211 // reference "OFPT_EXPERIMENTER message in Openflow Switch 1.3 Spec"
\r
1212 // TODO:: does switch send this when understood experimenter msg from lib?
\r
1213 /* Symmetric message */
\r
1215 // # Notification and RPCs
\r
1216 /* Symmetric RPC. */
\r
1218 // reference "OFPT_ECHO_REQUEST message in Openflow Switch 1.3 Spec"
\r
1220 uses echo-request;
\r
1222 /* Controller/switch message */
\r
1229 // reference "OFPT_ECHO_REQUEST message in Openflow Switch 1.3 Spec"
\r
1236 // reference "OFPT_HELLO message in Openflow Switch 1.3 Spec"
\r
1242 rpc experimenter {
\r
1243 // reference "OFPT_EXPERIMENTER message in Openflow Switch 1.3 Spec"
\r
1245 uses experimenter;
\r
1249 /* Switch configuration messages. */
\r
1250 rpc get-features {
\r
1251 // reference "OFPT_FEATURES_REQUEST message in Openflow Switch 1.3 Spec"
\r
1253 uses features-request;
\r
1255 /* Controller/switch message */
\r
1257 uses features-reply;
\r
1262 // reference "OFPT_GET_CONFIG_REQUEST message in Openflow Switch 1.3 Spec"
\r
1264 uses get-config-request;
\r
1267 uses get-config-reply;
\r
1269 /* Controller/switch message */
\r
1273 // reference "OFPT_SET_CONFIG message in Openflow Switch 1.3 Spec"
\r
1277 /* Controller/switch message */
\r
1279 /* Asynchronous messages. */
\r
1280 notification packet-in-message {
\r
1282 // reference "OFPT_PACKET_IN message in Openflow Switch 1.3 Spec"
\r
1284 /* Async message */
\r
1286 notification flow-removed-message {
\r
1287 uses flow-removed;
\r
1288 // reference "OFPT_FLOW_REMOVED message in Openflow Switch 1.3 Spec"
\r
1290 /* Async message */
\r
1292 notification port-status-message {
\r
1294 // reference "OFPT_PORT_STATUS message in Openflow Switch 1.3 Spec"
\r
1296 } /* Async message */
\r
1298 /* Controller command messages. */
\r
1302 // reference "OFPT_PACKET_OUT message in Openflow Switch 1.3 Spec"
\r
1304 /* Controller/switch message */
\r
1309 // reference "OFPT_FLOW_MOD message in Openflow Switch 1.3 Spec"
\r
1311 /* Controller/switch message */
\r
1316 // reference "OFPT_GROUP_MOD message in Openflow Switch 1.3 Spec"
\r
1318 /* Controller/switch message */
\r
1323 // reference "OFPT_PORT_MOD message in Openflow Switch 1.3 Spec"
\r
1325 } /* Controller/switch message */
\r
1330 // reference "OFPT_TABLE_MOD message in Openflow Switch 1.3 Spec"
\r
1332 } /* Controller/switch message */
\r
1334 /* Multipart messages. */
\r
1336 rpc multipart-request {
\r
1338 uses multipart-request;
\r
1342 /* Controller/switch message */
\r
1343 notification multipart-reply-message {
\r
1344 uses multipart-reply;
\r
1345 // reference "OFPT_MULTIPART_REPLY message in Openflow Switch 1.3 Spec"
\r
1346 // notification because of multiple following responses
\r
1347 } /* Controller/switch message */
\r
1350 /* Barrier messages. */
\r
1353 uses barrier-request;
\r
1354 // reference "OFPT_BARRIER_REQUEST message in Openflow Switch 1.3 Spec"
\r
1357 uses barrier-reply;
\r
1358 // reference "OFPT_BARRIER_REPLY message in Openflow Switch 1.3 Spec"
\r
1361 /* Queue Configuration messages. */
\r
1362 rpc get-queue-config {
\r
1364 uses queue-get-config-request;
\r
1365 // reference "OFPT_QUEUE_GET_CONFIG_REQUEST message in Openflow Switch 1.3 Spec"
\r
1368 uses queue-get-config-reply;
\r
1369 // reference "OFPT_QUEUE_GET_CONFIG_REPLY message in Openflow Switch 1.3 Spec"
\r
1373 /* Controller role change request messages. */
\r
1374 rpc role-request {
\r
1376 uses role-request;
\r
1377 // reference "OFPT_ROLE_REQUEST message in Openflow Switch 1.3 Spec"
\r
1381 // reference "OFPT_ROLE_REPLY message in Openflow Switch 1.3 Spec"
\r
1383 } /* Controller/switch message */
\r
1385 /* Asynchronous message configuration. */
\r
1388 uses get-async-request;
\r
1389 // reference "OFPT_GET_ASYNC_REQUEST message in Openflow Switch 1.3 Spec"
\r
1392 uses get-async-reply;
\r
1393 // reference "OFPT_GET_ASYNC_REPLY message in Openflow Switch 1.3 Spec"
\r
1396 /* Controller/switch message */
\r
1400 // reference "OFPT_SET_ASYNC message in Openflow Switch 1.3 Spec"
\r
1404 /* Meters and rate limiters configuration messages. */
\r
1408 // reference "OFPT_METER_MOD message in Openflow Switch 1.3 Spec"
\r
1410 } /* Controller/switch message */
\r