Updated extension registration keys
[openflowjava.git] / openflow-protocol-api / src / main / yang / openflow-augments.yang
index c7532b426eabb99901a724a401da93f5bc903b0d..44986927df0393ebb05dbcff7d6ee2aa841af887 100644 (file)
-module openflow-augments {\r
+/*\r
+ * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.\r
+ *\r
+ * This program and the accompanying materials are made available under the\r
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+ * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+ */\r
\r
+ module openflow-augments {\r
     namespace "urn:opendaylight:openflow:augments";\r
     prefix "aug";\r
-\r
+    \r
+    import yang-ext {prefix ext;}\r
     import ietf-inet-types {prefix inet;}\r
     import ietf-yang-types {prefix yang;}\r
-    \r
+\r
     import openflow-types {prefix oft;}\r
     import openflow-protocol {prefix ofproto;}\r
     import openflow-action {prefix ofaction;}\r
     import openflow-instruction {prefix ofinstruction;}\r
     import openflow-extensible-match {prefix oxm;}\r
 \r
-\r
     revision "2013-10-02" {\r
-        description "Initial model";\r
+        description "OpenFlow 1.3 - augments model. \r
+                    Please visit \r
+                    https://wiki.opendaylight.org/view/File:OpenFlow_Protocol_Library_-_Project_documentation.pdf\r
+                     - Augmentation Tables chapter";\r
     }\r
+\r
 // OFP_MATCH AUGMENTS\r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "port-number-match-entry";\r
          leaf port-number {\r
              type oft:port-number;\r
          }\r
      }\r
-\r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "metadata-match-entry";\r
          leaf metadata {\r
              type binary;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "mask-match-entry";\r
          leaf mask {\r
              type binary;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "mac-address-match-entry";\r
          leaf mac-address {\r
              type yang:mac-address;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "eth-type-match-entry";\r
          leaf eth-type {\r
              type oft:ether-type;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "vlan-vid-match-entry";\r
          leaf vlan-vid {\r
              type uint16;\r
          }\r
+         leaf cfi-bit {\r
+             type boolean;\r
+         }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "vlan-pcp-match-entry";\r
          leaf vlan-pcp {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "dscp-match-entry";\r
          leaf dscp {\r
              type inet:dscp;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "ecn-match-entry";\r
          leaf ecn {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "protocol-number-match-entry";\r
          leaf protocol-number {\r
              type uint8;\r
          }\r
      }\r
-     \r
-     augment "/oxm:oxm-container/oxm:match-entries" {\r
-         leaf ipv4-prefix {\r
-             type inet:ipv4-prefix;\r
-         }\r
-     }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "port-match-entry";\r
          leaf port {\r
              type inet:port-number;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "icmpv4-type-match-entry";\r
          leaf icmpv4-type {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "icmpv4-code-match-entry";\r
          leaf icmpv4-code {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "op-code-match-entry";\r
          leaf op-code {\r
              type uint16;\r
          }\r
      }\r
-     \r
-     augment "/oxm:oxm-container/oxm:match-entries" {\r
-         leaf ipv6-prefix {\r
-             type inet:ipv6-prefix;\r
-         }\r
-     }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "ipv6-flabel-match-entry";\r
          leaf ipv6-flabel {\r
              type inet:ipv6-flow-label;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "icmpv6-type-match-entry";\r
          leaf icmpv6-type {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "icmpv6-code-match-entry";\r
          leaf icmpv6-code {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "ipv6-address-match-entry";\r
          leaf ipv6-address {\r
              type inet:ipv6-address;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "ipv4-address-match-entry";\r
+         leaf ipv4-address {\r
+             type inet:ipv4-address;\r
+         }\r
+     }\r
+     augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "mpls-label-match-entry";\r
          leaf mpls-label {\r
              type uint32;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "tc-match-entry";\r
          leaf tc {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "bos-match-entry";\r
          leaf bos {\r
              type boolean;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "isid-match-entry";\r
          leaf isid {\r
              type uint32;\r
          }\r
      }\r
-     \r
      augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "pseudo-field-match-entry";\r
          leaf pseudo-field {\r
-             type bits {\r
-                 bit nonext {\r
-                     description "<No next header> encountered.";\r
-                     position 0;\r
-                 }\r
-                 bit esp {\r
-                     description "Encrypted Sec Payload header present.";\r
-                     position 1;\r
-                 }\r
-                 bit auth {\r
-                     description "Authentication header present.";\r
-                     position 2;\r
-                 }\r
-                 bit dest {\r
-                     description "1 or 2 dest headers present.";\r
-                     position 3;\r
-                 }\r
-                 bit frag {\r
-                     description "Fragment header present.";\r
-                     position 4;\r
-                 }\r
-                 bit router {\r
-                     description "Router header present.";\r
-                     position 5;\r
-                 }\r
-                 bit hop {\r
-                     description "Hop-by-hop header present.";\r
-                     position 6;\r
-                 }\r
-                 bit unrep {\r
-                     description "Unexpected repeats encountered.";\r
-                     position 7;\r
-                 }\r
-                 bit unseq {\r
-                     description "Unexpected sequencing encountered.";\r
-                     position 8;\r
-                     }                    \r
-             }\r
+             type oft:ipv6-exthdr-flags;\r
+         }\r
+     }\r
+     augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "experimenter-match-entry";\r
+         leaf experimenter {\r
+             type uint32;\r
+         }\r
+     }\r
+     augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "tcp-flag-match-entry";\r
+         leaf tcp-flag {\r
+             type uint16;\r
+         }\r
+     }\r
+     augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "tunnel-ipv4-dst-match-entry";\r
+         leaf tunnel-ipv4-dst {\r
+             type inet:ipv4-address;\r
+         }\r
+     }\r
+     augment "/oxm:oxm-container/oxm:match-entries" {\r
+         ext:augment-identifier "tunnel-ipv4-src-match-entry";\r
+         leaf tunnel-ipv4-src {\r
+             type inet:ipv4-address;\r
          }\r
      }\r
 \r
 // OFP_ACTION AUGMENTS\r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "port-action";\r
          leaf port {\r
-             type oft:any-port-number;\r
+             type oft:port-number;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "max-length-action";\r
          leaf max-length {\r
              type uint16;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "mpls-ttl-action";\r
          leaf mpls-ttl {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "ethertype-action";\r
          leaf ethertype {\r
              type oft:ether-type;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "queue-id-action";\r
          leaf queue-id {\r
              type uint32;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "group-id-action";\r
          leaf group-id {\r
              type uint32;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "nw-ttl-action";\r
          leaf nw-ttl {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
-         uses oxm:oxm-fields;\r
+         ext:augment-identifier "oxm-fields-action";\r
+         uses oxm:oxm-fields-grouping;\r
      }\r
-     \r
      augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "experimenter-action";\r
          leaf experimenter {\r
              type uint32;\r
          }\r
+         leaf data {\r
+             type binary;\r
+         }\r
+     }\r
+     // OF1.0 structures\r
+     augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "vlan-vid-action";\r
+         leaf vlan-vid {\r
+             type uint16;\r
+         }\r
+     }\r
+     augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "vlan-pcp-action";\r
+         leaf vlan-pcp {\r
+             type uint8;\r
+         }\r
+     }\r
+     augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "dl-address-action";\r
+         leaf dl-address {\r
+             type yang:mac-address;\r
+         }\r
+     }\r
+     augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "nw-tos-action";\r
+         leaf nw-tos {\r
+             type uint8;\r
+         }\r
+     }\r
+     augment "/ofaction:actions-container/ofaction:action" {\r
+         ext:augment-identifier "ip-address-action";\r
+         leaf ip-address {\r
+             type inet:ipv4-address;\r
+         }\r
      }\r
 \r
 // OFP_TABLE_FEATURES_PROPERTIES AUGMENTS\r
      augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {\r
-         list instruction-ids {\r
-             uses ofinstruction:instructions;\r
-         }\r
+         ext:augment-identifier "instruction-related-table-feature-property";\r
+         uses ofinstruction:instructions-grouping;\r
      }\r
-\r
      augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {\r
+         ext:augment-identifier "next-table-related-table-feature-property";\r
          list next-table-ids {\r
+             config false;\r
              leaf table-id {\r
                  type uint8;\r
              }\r
          }\r
      }\r
-\r
      augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {\r
-         list action-ids {\r
-             uses ofaction:action-header;\r
-         }\r
+         ext:augment-identifier "action-related-table-feature-property";\r
+         uses ofaction:actions-grouping;\r
      }\r
-\r
      augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {\r
-         list oxm-ids {\r
-             uses oxm:oxm-fields;\r
-         }\r
+         ext:augment-identifier "oxm-related-table-feature-property";\r
+         uses oxm:oxm-fields-grouping;\r
      }\r
-\r
      augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {\r
+         ext:augment-identifier "experimenter-related-table-feature-property";\r
          leaf experimenter {\r
              type uint32;\r
          }\r
@@ -294,15 +322,16 @@ module openflow-augments {
              type binary;\r
          }\r
      }\r
-     \r
+\r
 // OFP_INSTRUCTION AUGMENTS\r
      augment "/ofinstruction:instruction-container/ofinstruction:instruction" {\r
+         ext:augment-identifier "table-id-instruction";\r
          leaf table-id {\r
              type uint8;\r
          }\r
      }\r
-     \r
      augment "/ofinstruction:instruction-container/ofinstruction:instruction" {\r
+         ext:augment-identifier "metadata-instruction";\r
          leaf metadata {\r
              type binary;\r
          }\r
@@ -310,22 +339,55 @@ module openflow-augments {
              type binary;\r
          }\r
      }\r
-     \r
      augment "/ofinstruction:instruction-container/ofinstruction:instruction" {\r
-         list actions {\r
-             uses ofaction:action-header;\r
-         }\r
+         ext:augment-identifier "actions-instruction";\r
+         uses ofaction:actions-grouping;\r
      }\r
-     \r
      augment "/ofinstruction:instruction-container/ofinstruction:instruction" {\r
+         ext:augment-identifier "meter-id-instruction";\r
          leaf meter-id {\r
              type uint32;\r
          }\r
      }\r
-     \r
      augment "/ofinstruction:instruction-container/ofinstruction:instruction" {\r
+         ext:augment-identifier "experimenter-instruction";\r
+         leaf experimenter {\r
+             type uint32;\r
+         }\r
+         leaf data {\r
+             type binary;\r
+         }\r
+     }\r
+     \r
+// OFP_QUEUE_PROP AUGMENTS\r
+     augment "/ofproto:queue-prop-container/ofproto:queue-property" {\r
+         ext:augment-identifier "rate-queue-property";\r
+         leaf rate {\r
+             type uint16;\r
+         }\r
+     }\r
+     augment "/ofproto:queue-prop-container/ofproto:queue-property" {\r
+         ext:augment-identifier "experimenter-queue-property";\r
+         leaf experimenter {\r
+             type uint32;\r
+         }\r
+         leaf data {\r
+             type binary;\r
+         }\r
+     }\r
+     \r
+// OFP_ERROR_AUGMENTS (only experimenter till OpenFlow v1.3)\r
+    augment "/ofproto:error-message" {\r
+         ext:augment-identifier "experimenter-error";\r
+         leaf exp_type {\r
+             type uint16;\r
+         }\r
          leaf experimenter {\r
              type uint32;\r
          }\r
+         leaf exp-data {\r
+             type binary;\r
+         }\r
      }\r
+\r
 }
\ No newline at end of file