2 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 module openflow-protocol {
10 namespace "urn:opendaylight:openflow:protocol";
13 import ietf-yang-types {prefix yang;}
15 import openflow-types {prefix oft;}
16 import openflow-extensible-match { prefix oxm;}
17 import openflow-instruction { prefix ofinstruction;}
18 import openflow-action {prefix ofaction;}
20 revision "2013-07-31" {
21 description "OpenFlow 1.3 - protocol objects model";
25 grouping port-grouping {
31 type yang:mac-address;
37 description "Bitmap of OFPPC_* flags.";
41 description "Bitmap of OFPPS_* flags.";
44 leaf current-features {
45 description "Current features.";
46 type oft:port-features;
48 leaf advertised-features {
49 description "Features being advertised by the port.";
50 type oft:port-features;
52 leaf supported-features {
53 description "Features supported by the port.";
54 type oft:port-features;
57 description "Features advertised by peer.";
58 type oft:port-features;
61 description "Current port bitrate in kbps.";
66 description "Max port bitrate in kbps";
73 type oft:port-config-v10;
76 type oft:port-state-v10;
78 leaf current-features-v10 {
79 description "Current features.";
80 type oft:port-features-v10;
82 leaf advertised-features-v10 {
83 description "Features being advertised by the port.";
84 type oft:port-features-v10;
86 leaf supported-features-v10 {
87 description "Features supported by the port.";
88 type oft:port-features-v10;
90 leaf peer-features-v10 {
91 description "Features advertised by peer.";
92 type oft:port-features-v10;
96 grouping buckets-grouping {
102 grouping bucket-grouping {
103 description "Bucket for use in groups.";
105 description "Relative weight of bucket. Only
106 defined for select groups.";
110 description "Port whose state affects whether this
111 bucket is live. Only required for fast
113 type oft:port-number;
116 description "Group whose state affects whether this
117 bucket is live. Only required for fast
122 uses ofaction:actions-grouping;
125 container table-features-properties-container {
126 uses table-features-properties-grouping;
129 grouping table-features-properties-grouping {
130 list table-feature-properties {
133 type oft:table-features-prop-type;
138 // # MESSAGE Structures
139 /* Immutable messages. */
141 reference "ofp_header struct in Openflow Switch 1.3 Spec";
144 description "OpenFlow version";
148 description "Transaction ID";
151 grouping ofHelloElementHeader {
152 reference "ofpt_hello_elem_header struct in Openflow Switch 1.3 Spec";
154 type oft:hello-element-type;
155 //reference "OpenFlow Header element type - OFPHET_*";
159 reference "OFPT_HELLO message in Openflow Switch 1.3 Spec";
160 /* Symmetric message */
164 uses ofHelloElementHeader;
166 leaf-list version-bitmap {
172 reference "OFPT_ERROR message in Openflow Switch 1.3 Spec";
173 /* Symmetric message */
192 grouping echo-request {
193 reference "OFPT_ECHO_REQUEST message in Openflow Switch 1.3 Spec";
194 /* Symmetric message */
201 grouping echo-reply {
202 reference "OFPT_ECHO_REPLY message in Openflow Switch 1.3 Spec";
203 /* Symmetric message */
210 grouping experimenter {
211 reference "OFPT_EXPERIMENTER message in Openflow Switch 1.3 Spec";
212 /* Symmetric message */
216 type oft:experimenter-id;
222 /* Switch configuration messages. */
223 grouping features-request {
224 reference "OFPT_FEATURES_REQUEST message in Openflow Switch 1.3 Spec";
225 /* Controller/switch message */
228 grouping features-reply {
229 reference "OFPT_FEATURES_REPLY message in Openflow Switch 1.3 Spec";
230 /* Controller/switch message */
246 type oft:capabilities;
252 leaf capabilities-v10 {
253 type oft:capabilities-v10;
256 type oft:action-type-v10;
262 grouping get-config-request {
263 reference "OFPT_GET_CONFIG_REQUEST message in Openflow Switch 1.3 Spec";
264 /* Controller/switch message */
267 grouping get-config-reply {
268 reference "OFPT_GET_CONFIG_REPLY message in Openflow Switch 1.3 Spec";
269 /* Controller/switch message */
273 type oft:switch-config-flag;
279 grouping set-config {
280 reference "OFPT_SET_CONFIG message in Openflow Switch 1.3 Spec";
281 /* Controller/switch message */
286 type oft:switch-config-flag;
292 /* Asynchronous messages. */
294 reference "OFPT_PACKET_IN message in Openflow Switch 1.3 Spec";
300 // ID assigned by datapath.
304 // Full length of frame.
308 // Reason packet is being sent (one of OFPR_*)
309 type oft:packet-in-reason;
312 // ID of the table that was looked up
316 // Cookie of the flow entry that was looked up.
319 uses oxm:match-grouping;
330 grouping flow-removed {
331 reference "OFPT_FLOW_REMOVED message in Openflow Switch 1.3 Spec";
342 type oft:flow-removed-reason;
365 uses oxm:match-grouping;
368 uses oxm:match-v10-grouping;
370 grouping port-status {
371 reference "OFPT_PORT_STATUS message in Openflow Switch 1.3 Spec";
378 type oft:port-reason;
381 /* Controller command messages. */
382 grouping packet-out {
383 reference "OFPT_PACKET_OUT message in Openflow Switch 1.3 Spec";
384 /* Controller/switch message */
388 uses ofaction:actions-grouping;
397 type oft:port-number;
401 reference "OFPT_FLOW_MOD message in Openflow Switch 1.3 Spec";
402 /* Controller/switch message */
416 type oft:flow-mod-command;
431 type oft:port-number;
437 type oft:flow-mod-flags;
439 uses oxm:match-grouping;
441 uses ofinstruction:instructions-grouping;
445 type oft:flow-mod-flags-v10;
447 uses oxm:match-v10-grouping;
448 uses ofaction:actions-grouping;
451 reference "OFPT_GROUP_MOD message in Openflow Switch 1.3 Spec";
452 /* Controller/switch message */
457 type oft:group-mod-command;
466 uses buckets-grouping;
470 reference "OFPT_PORT_MOD message in Openflow Switch 1.3 Spec";
471 /* Controller/switch message */
476 type oft:port-number;
479 type yang:mac-address;
482 type oft:port-config;
485 type oft:port-config;
488 type oft:port-features;
492 type oft:port-config-v10;
495 type oft:port-config-v10;
498 type oft:port-features-v10;
502 reference "OFPT_TABLE_MOD message in Openflow Switch 1.3 Spec";
503 /* Controller/switch message */
511 type oft:table-config;
515 /* Multipart messages. */
516 grouping multipart-request {
517 reference "OFPT_MULTIPART_REQUEST message in Openflow Switch 1.3 Spec";
518 /* Controller/switch message */
523 type oft:multipart-type;
526 type oft:multipart-request-flags;
528 choice multipart-request-body {
529 case multipart-request-desc-case {
530 container multipart-request-desc {
536 case multipart-request-flow-case {
537 container multipart-request-flow {
553 uses oxm:match-grouping;
556 uses oxm:match-v10-grouping;
559 case multipart-request-aggregate-case {
560 container multipart-request-aggregate {
576 uses oxm:match-grouping;
579 uses oxm:match-v10-grouping;
582 case multipart-request-table-case {
583 container multipart-request-table {
589 case multipart-request-port-stats-case {
590 container multipart-request-port-stats {
596 case multipart-request-queue-case {
597 container multipart-request-queue {
606 case multipart-request-group-case {
607 container multipart-request-group {
613 case multipart-request-group-desc-case {
614 container multipart-request-group-desc {
620 case multipart-request-group-features-case {
621 container multipart-request-group-features {
627 case multipart-request-meter-case {
628 container multipart-request-meter {
634 case multipart-request-meter-config-case {
635 container multipart-request-meter-config {
641 case multipart-request-meter-features-case {
642 container multipart-request-meter-features {
648 case multipart-request-table-features-case {
649 container multipart-request-table-features {
650 list table-features {
657 leaf metadata-match {
660 leaf metadata-write {
664 type oft:table-config;
669 uses table-features-properties-grouping;
673 case multipart-request-port-desc-case {
674 container multipart-request-port-desc {
680 case multipart-request-experimenter-case {
681 container multipart-request-experimenter {
682 // empty body - used for experimenter augmentation
687 grouping multipart-reply {
688 reference "OFPT_MULTIPART_REPLY message in Openflow Switch 1.3 Spec";
689 /* Controller/switch message */
694 type oft:multipart-type;
697 type oft:multipart-request-flags;
699 choice multipart-reply-body {
700 case multipart-reply-desc-case {
701 container multipart-reply-desc {
719 case multipart-reply-flow-case {
720 container multipart-reply-flow {
741 type oft:flow-mod-flags;
752 uses oxm:match-grouping;
754 uses ofinstruction:instructions-grouping;
757 uses oxm:match-v10-grouping;
758 uses ofaction:actions-grouping;
762 case multipart-reply-aggregate-case {
763 container multipart-reply-aggregate {
775 case multipart-reply-table-case {
776 container multipart-reply-table {
796 type oft:flow-wildcards-v10;
810 case multipart-reply-port-stats-case {
811 container multipart-reply-port-stats {
861 case multipart-reply-queue-case {
862 container multipart-reply-queue {
888 case multipart-reply-group-case {
889 container multipart-reply-group {
920 case multipart-reply-group-desc-case {
921 container multipart-reply-group-desc {
929 uses buckets-grouping;
933 case multipart-reply-group-features-case {
934 container multipart-reply-group-features {
936 type oft:group-types;
939 type oft:group-capabilities;
941 leaf-list max_groups {
944 leaf-list actions-bitmap {
945 type oft:action-type;
949 case multipart-reply-meter-case {
950 container multipart-reply-meter {
958 leaf packet-in-count {
970 list meter-band-stats {
971 leaf packet-band-count {
974 leaf byte-band-count {
981 case multipart-reply-meter-config-case {
982 container multipart-reply-meter-config {
985 type oft:meter-flags;
991 uses meter-band-header;
996 case multipart-reply-meter-features-case {
997 container multipart-reply-meter-features {
1002 type oft:meter-band-type-bitmap;
1005 type oft:meter-flags;
1015 case multipart-reply-table-features-case {
1016 container multipart-reply-table-features {
1017 list table-features {
1024 leaf metadata-match {
1027 leaf metadata-write {
1031 type oft:table-config;
1036 uses table-features-properties-grouping;
1040 case multipart-reply-port-desc-case {
1041 container multipart-reply-port-desc {
1047 case multipart-reply-experimenter-case {
1048 container multipart-reply-experimenter {
1049 // empty body - used for experimenter augmentation
1054 /* Barrier messages. */
1055 grouping barrier-request {
1056 reference "OFPT_BARRIER_REQUEST message in Openflow Switch 1.3 Spec";
1057 /* Controller/switch message */
1060 grouping barrier-reply {
1061 reference "OFPT_BARRIER_REPLY message in Openflow Switch 1.3 Spec";
1062 /* Controller/switch message */
1065 /* Queue Configuration messages. */
1066 grouping queue-get-config-request {
1067 reference "OFPT_QUEUE_GET_CONFIG_REQUEST message in Openflow Switch 1.3 Spec";
1068 /* Controller/switch message */
1073 type oft:port-number;
1076 grouping queue-get-config-reply {
1077 reference "OFPT_QUEUE_GET_CONFIG_REPLY message in Openflow Switch 1.3 Spec";
1078 /* Controller/switch message */
1083 type oft:port-number;
1089 grouping packet-queue {
1094 type oft:port-number;
1096 uses queue-property-header;
1098 container queue-prop-container {
1099 uses queue-property-header;
1101 grouping queue-property-header {
1102 list queue-property {
1105 type oft:queue-properties;
1109 /* Controller role change request messages. */
1110 grouping role-request {
1111 reference "OFPT_ROLE_REQUEST message in Openflow Switch 1.3 Spec";
1112 /* Controller/switch message */
1117 type oft:controller-role;
1119 leaf generation-id {
1123 grouping role-reply {
1124 reference "OFPT_ROLE_REPLY message in Openflow Switch 1.3 Spec";
1125 /* Controller/switch message */
1130 type oft:controller-role;
1132 leaf generation-id {
1136 /* Asynchronous message configuration. */
1137 grouping get-async-request {
1138 reference "OFPT_GET_ASYNC_REQUEST message in Openflow Switch 1.3 Spec";
1139 /* Controller/switch message */
1143 grouping get-async-reply {
1144 reference "OFPT_GET_ASYNC_REPLY message in Openflow Switch 1.3 Spec";
1145 /* Controller/switch message */
1148 uses async-body-grouping;
1150 grouping set-async {
1151 reference "OFPT_SET_ASYNC message in Openflow Switch 1.3 Spec";
1152 /* Controller/switch message */
1155 uses async-body-grouping;
1158 grouping async-body-grouping {
1159 list packet-in-mask {
1161 type oft:packet-in-reason;
1164 list port-status-mask {
1166 type oft:port-reason;
1169 list flow-removed-mask {
1171 type oft:flow-removed-reason;
1175 /* Meters and rate limiters configuration messages. */
1176 grouping meter-mod {
1177 reference "OFPT_METER_MOD message in Openflow Switch 1.3 Spec";
1178 /* Controller/switch message */
1183 type oft:meter-mod-command;
1186 type oft:meter-flags;
1192 uses meter-band-header;
1196 container meter-band-container {
1197 uses meter-band-header;
1199 grouping meter-band-header {
1201 case meter-band-drop-case {
1202 container meter-band-drop {
1203 uses meter-band-commons;
1206 case meter-band-dscp-remark-case {
1207 container meter-band-dscp-remark {
1208 uses meter-band-commons;
1214 case meter-band-experimenter-case {
1215 container meter-band-experimenter {
1216 uses meter-band-commons;
1222 grouping meter-band-commons {
1224 type oft:meter-band-type;
1234 /* Immutable messages. */
1235 notification hello-message {
1237 reference "OFPT_HELLO message in Openflow Switch 1.3 Spec";
1239 /* Symmetric message */
1241 notification error-message {
1243 reference "OFPT_ERROR message in Openflow Switch 1.3 Spec";
1245 /* Symmetric message */
1247 notification echo-request-message {
1249 reference "OFPT_ECHO_REQUEST message in Openflow Switch 1.3 Spec";
1251 /* Symmetric message */
1253 notification experimenter-message {
1255 reference "OFPT_EXPERIMENTER message in Openflow Switch 1.3 Spec";
1256 // TODO:: does switch send this when understood experimenter msg from lib?
1257 /* Symmetric message */
1259 // # Notification and RPCs
1260 /* Symmetric RPC. */
1265 /* Controller/switch message */
1289 /* Switch configuration messages. */
1292 uses features-request;
1294 /* Controller/switch message */
1296 uses features-reply;
1302 uses get-config-request;
1305 uses get-config-reply;
1307 /* Controller/switch message */
1314 /* Controller/switch message */
1316 /* Asynchronous messages. */
1317 notification packet-in-message {
1322 notification flow-removed-message {
1327 notification port-status-message {
1330 } /* Async message */
1332 /* Controller command messages. */
1337 /* Controller/switch message */
1343 /* Controller/switch message */
1349 /* Controller/switch message */
1355 } /* Controller/switch message */
1361 } /* Controller/switch message */
1363 /* Multipart messages. */
1365 rpc multipart-request {
1367 uses multipart-request;
1371 /* Controller/switch message */
1372 notification multipart-reply-message {
1373 uses multipart-reply;
1374 // notification because of multiple following responses
1375 } /* Controller/switch message */
1378 /* Barrier messages. */
1381 uses barrier-request;
1387 /* Queue Configuration messages. */
1388 rpc get-queue-config {
1390 uses queue-get-config-request;
1393 uses queue-get-config-reply;
1397 /* Controller role change request messages. */
1405 } /* Controller/switch message */
1407 /* Asynchronous message configuration. */
1410 uses get-async-request;
1413 uses get-async-reply;
1416 /* Controller/switch message */
1423 /* Meters and rate limiters configuration messages. */
1428 } /* Controller/switch message */