From 869efd5a12224bf9cc2bd05934cac82d50d6a3e7 Mon Sep 17 00:00:00 2001 From: Michal Cmarada Date: Tue, 28 May 2019 08:50:38 +0200 Subject: HC2VPP-411: fix revisions for updated models Change-Id: I3ac251b1229a08d2c3c909697a6158e5996e6c9b Signed-off-by: Michal Cmarada --- .../main/yang/subinterface-span@2017-06-07.yang | 65 -- .../main/yang/subinterface-span@2019-05-27.yang | 71 ++ v3po/api/src/main/yang/v3po@2019-05-02.yang | 842 -------------------- v3po/api/src/main/yang/v3po@2019-05-27.yang | 849 +++++++++++++++++++++ v3po/api/src/main/yang/vpp-pbb@2016-12-14.yang | 62 -- v3po/api/src/main/yang/vpp-pbb@2019-05-27.yang | 60 ++ v3po/api/src/main/yang/vpp-vlan@2018-03-19.yang | 467 ------------ v3po/api/src/main/yang/vpp-vlan@2019-05-27.yang | 473 ++++++++++++ 8 files changed, 1453 insertions(+), 1436 deletions(-) delete mode 100644 v3po/api/src/main/yang/subinterface-span@2017-06-07.yang create mode 100644 v3po/api/src/main/yang/subinterface-span@2019-05-27.yang delete mode 100644 v3po/api/src/main/yang/v3po@2019-05-02.yang create mode 100644 v3po/api/src/main/yang/v3po@2019-05-27.yang delete mode 100644 v3po/api/src/main/yang/vpp-pbb@2016-12-14.yang create mode 100644 v3po/api/src/main/yang/vpp-pbb@2019-05-27.yang delete mode 100644 v3po/api/src/main/yang/vpp-vlan@2018-03-19.yang create mode 100644 v3po/api/src/main/yang/vpp-vlan@2019-05-27.yang (limited to 'v3po/api/src/main/yang') diff --git a/v3po/api/src/main/yang/subinterface-span@2017-06-07.yang b/v3po/api/src/main/yang/subinterface-span@2017-06-07.yang deleted file mode 100644 index 911181eca..000000000 --- a/v3po/api/src/main/yang/subinterface-span@2017-06-07.yang +++ /dev/null @@ -1,65 +0,0 @@ -module subinterface-span { - yang-version 1; - namespace "http://fd.io/hc2vpp/yang/subinterface-span"; - prefix "subif-span"; - - import ietf-interfaces { - prefix "if"; - } - - import vpp-vlan { - prefix "vpp-vlan"; - } - - import yang-ext { - prefix "ext"; - } - - import v3po { - prefix "v3po"; - } - - organization - "FD.io - The Fast Data Project"; - - contact - "Hc2vpp Wiki - Mailing List "; - - description - "This model contains a collection of YANG definitions for - span interface management in VPP. - - Copyright (c) 2017 Cisco and/or its affiliates. - - Licensed under the Apache License, Version 2.0 (the 'License'); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at: - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an 'AS IS' BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License."; - - revision "2017-06-07" { - description "Eliminated config leafrefs in operational tree"; - } - - revision "2017-05-10" { - description - "Initialial revision that adds support for mirroring interfaces on subinterfaces. - Vpp implementation allows/implements only two cases: - - Src: interface |Dst: interface - covered in v3po.yang - - Src: interface |Dst: subinterface - covered by this model"; - } - - augment /if:interfaces/if:interface/vpp-vlan:sub-interfaces/vpp-vlan:sub-interface { - ext:augment-identifier "vpp-subinterface-span-augmentation"; - container span { - uses v3po:span-attributes; - } - } -} diff --git a/v3po/api/src/main/yang/subinterface-span@2019-05-27.yang b/v3po/api/src/main/yang/subinterface-span@2019-05-27.yang new file mode 100644 index 000000000..82e3eb92e --- /dev/null +++ b/v3po/api/src/main/yang/subinterface-span@2019-05-27.yang @@ -0,0 +1,71 @@ +module subinterface-span { + yang-version 1; + namespace "http://fd.io/hc2vpp/yang/subinterface-span"; + prefix "subif-span"; + + import ietf-interfaces { + prefix "if"; + } + + import vpp-vlan { + prefix "vpp-vlan"; + } + + import yang-ext { + prefix "ext"; + } + + import v3po { + prefix "v3po"; + } + + organization + "FD.io - The Fast Data Project"; + + contact + "Hc2vpp Wiki + Mailing List "; + + description + "This model contains a collection of YANG definitions for + span interface management in VPP. + + Copyright (c) 2017 Cisco and/or its affiliates. + + Licensed under the Apache License, Version 2.0 (the 'License'); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at: + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an 'AS IS' BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License."; + + revision "2019-05-27" { + description + "Removed interfaces-state augmentations due to its deprecation + in ietf-interfaces model"; + } + + revision "2017-06-07" { + description "Eliminated config leafrefs in operational tree"; + } + + revision "2017-05-10" { + description + "Initialial revision that adds support for mirroring interfaces on subinterfaces. + Vpp implementation allows/implements only two cases: + - Src: interface |Dst: interface - covered in v3po.yang + - Src: interface |Dst: subinterface - covered by this model"; + } + + augment /if:interfaces/if:interface/vpp-vlan:sub-interfaces/vpp-vlan:sub-interface { + ext:augment-identifier "vpp-subinterface-span-augmentation"; + container span { + uses v3po:span-attributes; + } + } +} diff --git a/v3po/api/src/main/yang/v3po@2019-05-02.yang b/v3po/api/src/main/yang/v3po@2019-05-02.yang deleted file mode 100644 index dea978724..000000000 --- a/v3po/api/src/main/yang/v3po@2019-05-02.yang +++ /dev/null @@ -1,842 +0,0 @@ -module v3po { - yang-version 1; - namespace "http://fd.io/hc2vpp/yang/v3po"; - prefix "v3po"; - - import iana-if-type { - prefix "ianaift"; - } - import ietf-interfaces { - prefix "if"; - } - import ietf-yang-types { - prefix "yang"; - } - import ietf-inet-types { - prefix "inet"; - } - import yang-ext { - prefix "ext"; - } - import vpp-fib-table-management { - prefix fib-management; - revision-date 2018-05-21; - } - - organization - "FD.io - The Fast Data Project"; - - contact - "Hc2vpp Wiki - Mailing List "; - - description - "This module contains a collection of YANG definitions - that extend ietf-interfaces module with VPP specific interface types. - - Copyright (c) 2015-2017 Cisco and/or its affiliates. - - Licensed under the Apache License, Version 2.0 (the 'License'); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at: - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an 'AS IS' BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License."; - - revision "2019-05-02" { - description - "Revision changes: - - added boolean flag for enabling/disabling statistics collection"; - } - - revision "2019-01-28" { - description - "Revision changes: - - removed deprecated tap-cli interface"; - } - - revision "2018-10-08" { - description - "Revision changes: - - adds support for Tap v2 interface - - fixes tap-name pattern"; - } - - revision "2018-07-03" { - description - "Revision changes: - - adds support for af-packet interface - - uses references to fib-management module instead of uint32 identifiers - - changes type of IP addresses from inet:ip-address to inet:ip-address-no-zone - - fixes some minor issues"; - } - - revision "2017-06-07" { - description "Eliminated config leafrefs in operational tree"; - } - - revision "2017-03-15" { - description - "Revision changes: - - acl and ietf-acl moved to vpp-interface-acl - - vpp-state and rpc moved to vpp-management - - bridge domains moved to standalone container"; - } - - revision "2016-12-14" { - description - "This revision adds the following new features: - - ingress/egress ACLs support - - moved ACL definitions to vpp-acl module - - updated l2 container constraint (permit IP address on BVI interface) - - added PID of vpp process to vpp-state - - added support for Loopback interfaces - - added support for port mirroring"; - } - - revision "2015-01-05" { - description "Initial revision of v3po model"; - } - - typedef bridge-domain-ref { - type leafref { - path "/bridge-domains/bridge-domain/name"; - } - description - "This type is used by to reference a bridge domain table"; - } - - typedef bridged-virtual-interface-ref { - type leafref { - path "/if:interfaces/if:interface/l2/bridged-virtual-interface"; - } - description - "This type is used by to reference a bridged virtual interface"; - } - - identity vxlan-tunnel { - base if:interface-type; - } - - identity gre-tunnel { - base if:interface-type; - } - - identity vhost-user { - base if:interface-type; - } - - identity tap-v2 { - base if:interface-type; - } - - identity loopback { - base if:interface-type; - } - - identity l2-fib-action { - description "Base identity for l2-fib actions"; - } - - identity l2-fib-forward { - base l2-fib-action; - description - "Forwards packet with configured mac address"; - } - - identity l2-fib-filter { - base l2-fib-action; - description - "Drops packet with configured mac address"; - } - - typedef l2-fib-action { - type identityref { - base "l2-fib-action"; - } - description "Identifies a specific L2 FIB action"; - } - - typedef vxlan-vni { - // FIXME: should be in a vxlan-specific model - description "VXLAN Network Identifier"; - type uint32 { - range "0..16777215"; - } - } - - typedef vhost-user-role { - type enumeration { - enum "server"; - enum "client"; - } - } - - identity vxlan-gpe-tunnel { - base if:interface-type; - } - - identity af-packet { - base if:interface-type; - } - - typedef vxlan-gpe-vni { - description "VNI used in a VXLAN-GPE tunnel"; - type uint32 { - range "0..16777215"; - } - } - - typedef vxlan-gpe-next-protocol { - type enumeration { - enum "ipv4" { - value 1; - } - enum "ipv6" { - value 2; - } - enum "ethernet" { - value 3; - } - enum "nsh" { - value 4; - } - } - } - - - typedef span-state { - type enumeration { - enum "receive" { - value "1"; - description - "Receive (Rx) SPAN—The goal of receive (or ingress) SPAN - is to monitor as much as possible all the packets received by the source interface. - A copy of each packet received by the source is sent to the destination port for that SPAN session. - You can monitor a series or range of ingress ports in a SPAN session."; - } - - enum "transmit" { - value "2"; - description - "Transmit (Tx) SPAN—The goal of transmit (or egress) SPAN is to monitor as much as possible all the packets - sent by the source interface after all modification and processing is performed by the switch. - A copy of each packet sent by the source is sent to the destination port for that SPAN session. - The copy is provided after the packet is modified. Monitors a range of egress ports in a SPAN session."; - } - - enum "both" { - value "3"; - description - "In a SPAN session, you can monitor a series or range of ports for both received and sent packets."; - } - } - } - - grouping bridge-domain-attributes { - leaf flood { - type boolean; - default true; - description - "Enable/disable L2 flooding."; - } - leaf forward { - type boolean; - default true; - description - "Enable/disable L2 forwarding."; - } - leaf learn { - type boolean; - default true; - description - "Enable/disable L2 learning."; - } - leaf unknown-unicast-flood { - type boolean; - default true; - } - leaf arp-termination { - type boolean; - default false; - } - - container arp-termination-table { - when "../v3po:arp-termination = 'true'"; - - // TODO(HONEYCOMB-133): add support for read (after VPP-230 is done) - list arp-termination-table-entry { - key "ip-address phys-address"; - leaf ip-address { - type inet:ip-address-no-zone; - } - leaf phys-address { - type yang:phys-address; - } - } - } - } - - // TODO express constraints for L2 FIB entries in YANG if possible - grouping l2-fib-attributes { - container l2-fib-table { - list l2-fib-entry { - key "phys-address"; - - leaf phys-address { - type yang:phys-address; - } - - leaf outgoing-interface { - // either filter must be specified or interface(can't be both) - when "../action != 'l2-fib-filter'"; - type if:interface-ref; - // mandatory true; - when is not actually resolved, so mandatory can't be in place - description - "One of interfaces assigned to the FIB table's bridge-domain."; - } - leaf static-config { - type boolean; - default false; - description - "Static entries cannot be overridden by mac learning."; - } - leaf action { - type l2-fib-action; - mandatory true; - description - "L2 FIB action. For filter action, entry must be configured as static."; - } - leaf bridged-virtual-interface { - when "../action = 'l2-fib-forward'"; - type boolean; - config false; // FIXME setting bvi is currently not supported by VPP's binary api - } - } - } - } - - grouping interface-tag { - leaf tag { - type string { - length 1..63; - } - description - "ASCII string placeholder for interface metadata. Value is stored in vpp, - and returned in read requests. No processing involved."; - } - } - - grouping tap-v2-interface-base-attributes { - leaf id { - type uint32; - description "Interface ID."; - } - - leaf tx-ring-size { - type uint16; - description "Optional transmit ring size, default is 256 entries, must be power of 2."; - default 256; - } - - leaf rx-ring-size { - type uint16; - description "Optional receive ring size, default is 256 entries, must be power of 2."; - default 256; - } - - leaf host-mac { - type yang:phys-address; - description "Mac address to be set for the tap host interface."; - } - - leaf host-interface-name { - type string { - pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; - length 1..63; - } - description "Name of the tap host interface."; - } - - leaf host-namespace { - type string { - pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; - length 1..63; - } - description "Host namespace to assign this tap interface to."; - } - - leaf host-bridge { - type string { - pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; - length 1..63; - } - description "Host bridge to assign this tap interface to."; - } - - leaf host-ipv4-address { - type inet:ipv4-prefix; - description "Host IPv4 address in form of IPv4Prefix."; - } - - leaf host-ipv6-address { - type inet:ipv6-prefix; - description "Host IPv6 address in form of IPv6Prefix."; - } - - uses interface-tag; - } - - grouping tap-v2-interface-config-attributes { - leaf mac { - type yang:phys-address; - description "Mac address to be set for the tap v2 interface. Random will be used if not configured."; - } - leaf host-ipv4-gateway { - type inet:ipv4-address; - description "Host IPv4 gateway address."; - } - - leaf host-ipv6-gateway { - type inet:ipv6-address; - description "Host IPv6 gateway address."; - } - - leaf device-name { - config false; - type string{ - pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; - length 1..63; - } - description "Device name of the Tap v2 interface in VPP."; - } - } - - grouping loopback-interface-base-attributes { - leaf mac { - type yang:phys-address; - mandatory false; - description "Mac address of the loopback interface"; - } - } - - grouping ethernet-base-attributes { - leaf mtu { - type uint16 { - range "64..9216"; - } - units "octets"; - default 9216; - description - "The size, in octets, of the largest packet that the - hardware interface will send and receive. - - Mapped to hw_interface_set_mtu VPP API message which programs the NIC."; - } - - leaf manufacturer-description { - type string; - config false; - } - - leaf duplex { - type enumeration { - enum "half"; - enum "full"; - } - config false; - } - } - - grouping routing-base-attributes { - leaf ipv4-vrf-id { - type fib-management:fib-table-list-ref; - } - leaf ipv6-vrf-id { - type fib-management:fib-table-list-ref; - } - description - "Defines VRF tables used for ipv4 and ipv6 traffic"; - } - - grouping vhost-user-interface-base-attributes { - leaf socket { - type string { - length 1..255; - } - } - leaf role { - type vhost-user-role; - default "server"; - } - uses interface-tag; - description "vhost-user settings"; - } - - grouping vhost-user-interface-config-attributes { - leaf device-instance { - type uint32; - mandatory false; - description "Custom device instance. Autogenerated will be used if not configured"; - } - description "vhost-user settings"; - - leaf features { - type uint64; - config false; - } - leaf virtio-net-hdr-size { - type uint32; - config false; - } - leaf num-memory-regions { - type uint32; - config false; - } - leaf connect-error { - type string; - config false; - } - } - - /* - * Defines the supported decap node for vxlan. - */ - identity decap-node { - description - "Define the supported decap node"; - } - identity l2-input { - base decap-node; - description - "The next decap node is l2-input"; - } - identity nsh-proxy { - base decap-node; - description - "The next decap node is nsh-proxy"; - } - typedef vxlan-decap-node { - type identityref { - base "decap-node"; - } - } - grouping vxlan-base-attributes { - // FIXME: this should be in an vxlan-specific extension - leaf src { - /*mandatory true;*/ - type inet:ip-address-no-zone; - } - leaf dst { - /*mandatory true;*/ - type inet:ip-address-no-zone; - } - leaf vni { - /*mandatory true;*/ - type vxlan-vni; - } - leaf encap-vrf-id { - /*mandatory true;*/ - type fib-management:fib-table-list-ref; - } - leaf decap-next { - type vxlan-decap-node; - default "l2-input"; - } - } - - grouping gre-base-attributes { - leaf src { - /*mandatory true;*/ - type inet:ip-address-no-zone; - } - leaf dst { - /*mandatory true;*/ - type inet:ip-address-no-zone; - } - leaf outer-fib-id { - type uint32; - } - } - - grouping vxlan-gpe-base-attributes { - leaf local { - /*mandatory true;*/ - type inet:ip-address-no-zone; - } - leaf remote { - /*mandatory true;*/ - type inet:ip-address-no-zone; - } - leaf vni { - /*mandatory true;*/ - type vxlan-gpe-vni; - } - leaf next-protocol { - type vxlan-gpe-next-protocol; - } - leaf encap-vrf-id { - type uint32; - } - leaf decap-vrf-id { - type uint32; - } - } - - grouping af-packet-base-attributes { - leaf host-interface-name { - type string { - length "1..63"; - } - /* mandatory true; */ - description "Name of the host interface (veth end point)."; - } - leaf mac { - type yang:phys-address; - mandatory false; - description "Mac address to be set for the af-packet interface. Random will be used if not configured."; - } - reference - "https://docs.fd.io/vpp/18.07/clicmd_src_vnet_devices_af_packet.html"; - } - - grouping l2-config-attributes { - description - "Parameters for configuring Layer2 features on interfaces."; - - choice interconnection { - case xconnect-based { - leaf xconnect-outgoing-interface { - /* Don't allow selection of this interface */ - must "../../if:name != current()"; - type if:interface-ref; - description - "L2 xconnect mode"; - } - } - case bridge-based { - uses bridge-based-attributes; - } - } - } - - grouping bridge-based-attributes { - leaf bridge-domain { - type bridge-domain-ref; - mandatory true; - description - "Interfaces in a bridge-domain forward packets to other - interfaces in the same bridge-domain based on - destination mac address."; - } - leaf split-horizon-group { - when "../bridge-domain"; - type uint8 { - range "0..255"; - } - default 0; //no split horizon group - description - "Interface's split-horizon group. Interfaces in the same - bridge-domain and split-horizon group can not forward - packets between each other. "; - } - leaf bridged-virtual-interface { - when "../bridge-domain"; - type boolean; - default false; - description - "Interface forward packets in the bridge-domain - associated with the BVI."; - } - } - - grouping span-attributes { - description "Parameters of the SPAN feature"; - - container mirrored-interfaces { - list mirrored-interface { - key "iface-ref"; - leaf iface-ref { - type if:interface-ref; - } - - leaf state { - type span-state; - mandatory true; - } - } - } - } - - augment /if:interfaces/if:interface { - ext:augment-identifier "vpp-interface-augmentation"; - - // FIXME using ietf-interfaces model for vpp interfaces makes it hard to implement because: - // 1. The link between interface type and this augmentation is unclear - // 2. Only this augmentation with combination of ifc type is trigger to do something for vpp, what if user only configures base interface stuff ? + We need to get leaves defined by ietf-interfaces when we are processing this augment - // 3. The ietf-interfaces model does not define groupings which makes types reuse difficult - - container tap-v2 { - when "../if:type = 'v3po:tap-v2'"; - uses tap-v2-interface-base-attributes; - uses tap-v2-interface-config-attributes; - } - - container loopback { - presence "Presence of this container indicates loopback nature of the interface"; - when "../if:type = 'v3po:loopback'"; - uses loopback-interface-base-attributes; - } - - container ethernet { - when "../if:type = 'ianaift:ethernetCsmacd'"; - uses ethernet-base-attributes; - } - - container routing { - uses routing-base-attributes; - } - - container vhost-user { - when "../if:type = 'v3po:vhost-user'"; - uses vhost-user-interface-base-attributes; - uses vhost-user-interface-config-attributes; - } - - container vxlan { - when "../if:type = 'v3po:vxlan-tunnel'"; - uses vxlan-base-attributes; - } - - container gre { - when "../if:type = 'v3po:gre-tunnel'"; - uses gre-base-attributes; - } - - container l2 { - must "bridged-virtual-interface = 'true' or " + - "(not (../if:ipv4[if:enabled = 'true']/if:address/if:ip) and " + - "not (../if:ipv6[if:enabled = 'true']/if:address/if:ip))"; - - uses l2-config-attributes; - } - - container vxlan-gpe { - when "../if:type = 'v3po:vxlan-gpe-tunnel'"; - - uses vxlan-gpe-base-attributes; - } - - container af-packet { - when "../if:type = 'v3po:af-packet'"; - uses af-packet-base-attributes; - } - - container span { - uses span-attributes; - } - } - - container bridge-domains { - presence "Bridge domains configuration"; - list bridge-domain { - key "name"; - - leaf name { - type string; - } - - uses bridge-domain-attributes; - uses l2-fib-attributes; - - description - "bridge-domain configuration"; - } - } - - augment /if:interfaces { - ext:augment-identifier "vpp-interfaces-stats-augmentation"; - container statistics{ - leaf enabled { - type boolean; - default false; - } - } - } - - augment /if:interfaces/if:interface/if:statistics { - ext:augment-identifier "vpp-interface-statistics-augmentation"; - leaf in-errors-no-buf { - type yang:counter64; - } - leaf in-errors-miss { - type yang:counter64; - } - leaf out-discards-fifo-full { - type yang:counter64; - } - } - - container bridge-domains-state { - // FIXME: Should this live in bridge-domain.yang in a modular fashion ? - config "false"; - list bridge-domain { - - key "name"; - leaf name { - type string; - } - - uses bridge-domain-attributes; - uses l2-fib-attributes; - - description - "bridge-domain operational data"; - } - } - - // VPP Notifications - - typedef interface-status { - type enumeration { - enum up { - value 1; - } - enum down { - value 0; - } - } - } - - typedef interface-name-or-index { - type union { - type string; - type uint32; - } - } - - notification interface-change { - leaf name { - type interface-name-or-index; - } - - leaf admin-status { - type interface-status; - } - - leaf oper-status { - type interface-status; - } - } - - notification interface-deleted { - leaf name { - type interface-name-or-index; - } - } -} diff --git a/v3po/api/src/main/yang/v3po@2019-05-27.yang b/v3po/api/src/main/yang/v3po@2019-05-27.yang new file mode 100644 index 000000000..cc8e6d398 --- /dev/null +++ b/v3po/api/src/main/yang/v3po@2019-05-27.yang @@ -0,0 +1,849 @@ +module v3po { + yang-version 1; + namespace "http://fd.io/hc2vpp/yang/v3po"; + prefix "v3po"; + + import iana-if-type { + prefix "ianaift"; + } + import ietf-interfaces { + prefix "if"; + } + import ietf-yang-types { + prefix "yang"; + } + import ietf-inet-types { + prefix "inet"; + } + import yang-ext { + prefix "ext"; + } + import vpp-fib-table-management { + prefix fib-management; + revision-date 2018-05-21; + } + + organization + "FD.io - The Fast Data Project"; + + contact + "Hc2vpp Wiki + Mailing List "; + + description + "This module contains a collection of YANG definitions + that extend ietf-interfaces module with VPP specific interface types. + + Copyright (c) 2015-2017 Cisco and/or its affiliates. + + Licensed under the Apache License, Version 2.0 (the 'License'); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at: + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an 'AS IS' BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License."; + + revision "2019-05-27" { + description + " - Removed interfaces-state augmentations due to its deprecation + in ietf-interfaces model. + - Refactor of leafs and groupings to match interfaces-state removal."; + } + + revision "2019-05-02" { + description + "Revision changes: + - added boolean flag for enabling/disabling statistics collection"; + } + + revision "2019-01-28" { + description + "Revision changes: + - removed deprecated tap-cli interface"; + } + + revision "2018-10-08" { + description + "Revision changes: + - adds support for Tap v2 interface + - fixes tap-name pattern"; + } + + revision "2018-07-03" { + description + "Revision changes: + - adds support for af-packet interface + - uses references to fib-management module instead of uint32 identifiers + - changes type of IP addresses from inet:ip-address to inet:ip-address-no-zone + - fixes some minor issues"; + } + + revision "2017-06-07" { + description "Eliminated config leafrefs in operational tree"; + } + + revision "2017-03-15" { + description + "Revision changes: + - acl and ietf-acl moved to vpp-interface-acl + - vpp-state and rpc moved to vpp-management + - bridge domains moved to standalone container"; + } + + revision "2016-12-14" { + description + "This revision adds the following new features: + - ingress/egress ACLs support + - moved ACL definitions to vpp-acl module + - updated l2 container constraint (permit IP address on BVI interface) + - added PID of vpp process to vpp-state + - added support for Loopback interfaces + - added support for port mirroring"; + } + + revision "2015-01-05" { + description "Initial revision of v3po model"; + } + + typedef bridge-domain-ref { + type leafref { + path "/bridge-domains/bridge-domain/name"; + } + description + "This type is used by to reference a bridge domain table"; + } + + typedef bridged-virtual-interface-ref { + type leafref { + path "/if:interfaces/if:interface/l2/bridged-virtual-interface"; + } + description + "This type is used by to reference a bridged virtual interface"; + } + + identity vxlan-tunnel { + base if:interface-type; + } + + identity gre-tunnel { + base if:interface-type; + } + + identity vhost-user { + base if:interface-type; + } + + identity tap-v2 { + base if:interface-type; + } + + identity loopback { + base if:interface-type; + } + + identity l2-fib-action { + description "Base identity for l2-fib actions"; + } + + identity l2-fib-forward { + base l2-fib-action; + description + "Forwards packet with configured mac address"; + } + + identity l2-fib-filter { + base l2-fib-action; + description + "Drops packet with configured mac address"; + } + + typedef l2-fib-action { + type identityref { + base "l2-fib-action"; + } + description "Identifies a specific L2 FIB action"; + } + + typedef vxlan-vni { + // FIXME: should be in a vxlan-specific model + description "VXLAN Network Identifier"; + type uint32 { + range "0..16777215"; + } + } + + typedef vhost-user-role { + type enumeration { + enum "server"; + enum "client"; + } + } + + identity vxlan-gpe-tunnel { + base if:interface-type; + } + + identity af-packet { + base if:interface-type; + } + + typedef vxlan-gpe-vni { + description "VNI used in a VXLAN-GPE tunnel"; + type uint32 { + range "0..16777215"; + } + } + + typedef vxlan-gpe-next-protocol { + type enumeration { + enum "ipv4" { + value 1; + } + enum "ipv6" { + value 2; + } + enum "ethernet" { + value 3; + } + enum "nsh" { + value 4; + } + } + } + + + typedef span-state { + type enumeration { + enum "receive" { + value "1"; + description + "Receive (Rx) SPAN—The goal of receive (or ingress) SPAN + is to monitor as much as possible all the packets received by the source interface. + A copy of each packet received by the source is sent to the destination port for that SPAN session. + You can monitor a series or range of ingress ports in a SPAN session."; + } + + enum "transmit" { + value "2"; + description + "Transmit (Tx) SPAN—The goal of transmit (or egress) SPAN is to monitor as much as possible all the packets + sent by the source interface after all modification and processing is performed by the switch. + A copy of each packet sent by the source is sent to the destination port for that SPAN session. + The copy is provided after the packet is modified. Monitors a range of egress ports in a SPAN session."; + } + + enum "both" { + value "3"; + description + "In a SPAN session, you can monitor a series or range of ports for both received and sent packets."; + } + } + } + + grouping bridge-domain-attributes { + leaf flood { + type boolean; + default true; + description + "Enable/disable L2 flooding."; + } + leaf forward { + type boolean; + default true; + description + "Enable/disable L2 forwarding."; + } + leaf learn { + type boolean; + default true; + description + "Enable/disable L2 learning."; + } + leaf unknown-unicast-flood { + type boolean; + default true; + } + leaf arp-termination { + type boolean; + default false; + } + + container arp-termination-table { + when "../v3po:arp-termination = 'true'"; + + // TODO(HONEYCOMB-133): add support for read (after VPP-230 is done) + list arp-termination-table-entry { + key "ip-address phys-address"; + leaf ip-address { + type inet:ip-address-no-zone; + } + leaf phys-address { + type yang:phys-address; + } + } + } + } + + // TODO express constraints for L2 FIB entries in YANG if possible + grouping l2-fib-attributes { + container l2-fib-table { + list l2-fib-entry { + key "phys-address"; + + leaf phys-address { + type yang:phys-address; + } + + leaf outgoing-interface { + // either filter must be specified or interface(can't be both) + when "../action != 'l2-fib-filter'"; + type if:interface-ref; + // mandatory true; - when is not actually resolved, so mandatory can't be in place + description + "One of interfaces assigned to the FIB table's bridge-domain."; + } + leaf static-config { + type boolean; + default false; + description + "Static entries cannot be overridden by mac learning."; + } + leaf action { + type l2-fib-action; + mandatory true; + description + "L2 FIB action. For filter action, entry must be configured as static."; + } + leaf bridged-virtual-interface { + when "../action = 'l2-fib-forward'"; + type boolean; + config false; // FIXME setting bvi is currently not supported by VPP's binary api + } + } + } + } + + grouping interface-tag { + leaf tag { + type string { + length 1..63; + } + description + "ASCII string placeholder for interface metadata. Value is stored in vpp, + and returned in read requests. No processing involved."; + } + } + + grouping tap-v2-interface-base-attributes { + leaf id { + type uint32; + description "Interface ID."; + } + + leaf tx-ring-size { + type uint16; + description "Optional transmit ring size, default is 256 entries, must be power of 2."; + default 256; + } + + leaf rx-ring-size { + type uint16; + description "Optional receive ring size, default is 256 entries, must be power of 2."; + default 256; + } + + leaf host-mac { + type yang:phys-address; + description "Mac address to be set for the tap host interface."; + } + + leaf host-interface-name { + type string { + pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; + length 1..63; + } + description "Name of the tap host interface."; + } + + leaf host-namespace { + type string { + pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; + length 1..63; + } + description "Host namespace to assign this tap interface to."; + } + + leaf host-bridge { + type string { + pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; + length 1..63; + } + description "Host bridge to assign this tap interface to."; + } + + leaf host-ipv4-address { + type inet:ipv4-prefix; + description "Host IPv4 address in form of IPv4Prefix."; + } + + leaf host-ipv6-address { + type inet:ipv6-prefix; + description "Host IPv6 address in form of IPv6Prefix."; + } + + uses interface-tag; + } + + grouping tap-v2-interface-config-attributes { + leaf mac { + type yang:phys-address; + description "Mac address to be set for the tap v2 interface. Random will be used if not configured."; + } + leaf host-ipv4-gateway { + type inet:ipv4-address; + description "Host IPv4 gateway address."; + } + + leaf host-ipv6-gateway { + type inet:ipv6-address; + description "Host IPv6 gateway address."; + } + + leaf device-name { + config false; + type string{ + pattern '[a-zA-Z0-9\-;.+@$#^&*!_()=\[\]]*'; + length 1..63; + } + description "Device name of the Tap v2 interface in VPP."; + } + } + + grouping loopback-interface-base-attributes { + leaf mac { + type yang:phys-address; + mandatory false; + description "Mac address of the loopback interface"; + } + } + + grouping ethernet-base-attributes { + leaf mtu { + type uint16 { + range "64..9216"; + } + units "octets"; + default 9216; + description + "The size, in octets, of the largest packet that the + hardware interface will send and receive. + + Mapped to hw_interface_set_mtu VPP API message which programs the NIC."; + } + + leaf manufacturer-description { + type string; + config false; + } + + leaf duplex { + type enumeration { + enum "half"; + enum "full"; + } + config false; + } + } + + grouping routing-base-attributes { + leaf ipv4-vrf-id { + type fib-management:fib-table-list-ref; + } + leaf ipv6-vrf-id { + type fib-management:fib-table-list-ref; + } + description + "Defines VRF tables used for ipv4 and ipv6 traffic"; + } + + grouping vhost-user-interface-base-attributes { + leaf socket { + type string { + length 1..255; + } + } + leaf role { + type vhost-user-role; + default "server"; + } + uses interface-tag; + description "vhost-user settings"; + } + + grouping vhost-user-interface-config-attributes { + leaf device-instance { + type uint32; + mandatory false; + description "Custom device instance. Autogenerated will be used if not configured"; + } + description "vhost-user settings"; + + leaf features { + type uint64; + config false; + } + leaf virtio-net-hdr-size { + type uint32; + config false; + } + leaf num-memory-regions { + type uint32; + config false; + } + leaf connect-error { + type string; + config false; + } + } + + /* + * Defines the supported decap node for vxlan. + */ + identity decap-node { + description + "Define the supported decap node"; + } + identity l2-input { + base decap-node; + description + "The next decap node is l2-input"; + } + identity nsh-proxy { + base decap-node; + description + "The next decap node is nsh-proxy"; + } + typedef vxlan-decap-node { + type identityref { + base "decap-node"; + } + } + grouping vxlan-base-attributes { + // FIXME: this should be in an vxlan-specific extension + leaf src { + /*mandatory true;*/ + type inet:ip-address-no-zone; + } + leaf dst { + /*mandatory true;*/ + type inet:ip-address-no-zone; + } + leaf vni { + /*mandatory true;*/ + type vxlan-vni; + } + leaf encap-vrf-id { + /*mandatory true;*/ + type fib-management:fib-table-list-ref; + } + leaf decap-next { + type vxlan-decap-node; + default "l2-input"; + } + } + + grouping gre-base-attributes { + leaf src { + /*mandatory true;*/ + type inet:ip-address-no-zone; + } + leaf dst { + /*mandatory true;*/ + type inet:ip-address-no-zone; + } + leaf outer-fib-id { + type uint32; + } + } + + grouping vxlan-gpe-base-attributes { + leaf local { + /*mandatory true;*/ + type inet:ip-address-no-zone; + } + leaf remote { + /*mandatory true;*/ + type inet:ip-address-no-zone; + } + leaf vni { + /*mandatory true;*/ + type vxlan-gpe-vni; + } + leaf next-protocol { + type vxlan-gpe-next-protocol; + } + leaf encap-vrf-id { + type uint32; + } + leaf decap-vrf-id { + type uint32; + } + } + + grouping af-packet-base-attributes { + leaf host-interface-name { + type string { + length "1..63"; + } + /* mandatory true; */ + description "Name of the host interface (veth end point)."; + } + leaf mac { + type yang:phys-address; + mandatory false; + description "Mac address to be set for the af-packet interface. Random will be used if not configured."; + } + reference + "https://docs.fd.io/vpp/18.07/clicmd_src_vnet_devices_af_packet.html"; + } + + grouping l2-config-attributes { + description + "Parameters for configuring Layer2 features on interfaces."; + + choice interconnection { + case xconnect-based { + leaf xconnect-outgoing-interface { + /* Don't allow selection of this interface */ + must "../../if:name != current()"; + type if:interface-ref; + description + "L2 xconnect mode"; + } + } + case bridge-based { + uses bridge-based-attributes; + } + } + } + + grouping bridge-based-attributes { + leaf bridge-domain { + type bridge-domain-ref; + mandatory true; + description + "Interfaces in a bridge-domain forward packets to other + interfaces in the same bridge-domain based on + destination mac address."; + } + leaf split-horizon-group { + when "../bridge-domain"; + type uint8 { + range "0..255"; + } + default 0; //no split horizon group + description + "Interface's split-horizon group. Interfaces in the same + bridge-domain and split-horizon group can not forward + packets between each other. "; + } + leaf bridged-virtual-interface { + when "../bridge-domain"; + type boolean; + default false; + description + "Interface forward packets in the bridge-domain + associated with the BVI."; + } + } + + grouping span-attributes { + description "Parameters of the SPAN feature"; + + container mirrored-interfaces { + list mirrored-interface { + key "iface-ref"; + leaf iface-ref { + type if:interface-ref; + } + + leaf state { + type span-state; + mandatory true; + } + } + } + } + + augment /if:interfaces/if:interface { + ext:augment-identifier "vpp-interface-augmentation"; + + // FIXME using ietf-interfaces model for vpp interfaces makes it hard to implement because: + // 1. The link between interface type and this augmentation is unclear + // 2. Only this augmentation with combination of ifc type is trigger to do something for vpp, what if user only configures base interface stuff ? + We need to get leaves defined by ietf-interfaces when we are processing this augment + // 3. The ietf-interfaces model does not define groupings which makes types reuse difficult + + container tap-v2 { + when "../if:type = 'v3po:tap-v2'"; + uses tap-v2-interface-base-attributes; + uses tap-v2-interface-config-attributes; + } + + container loopback { + presence "Presence of this container indicates loopback nature of the interface"; + when "../if:type = 'v3po:loopback'"; + uses loopback-interface-base-attributes; + } + + container ethernet { + when "../if:type = 'ianaift:ethernetCsmacd'"; + uses ethernet-base-attributes; + } + + container routing { + uses routing-base-attributes; + } + + container vhost-user { + when "../if:type = 'v3po:vhost-user'"; + uses vhost-user-interface-base-attributes; + uses vhost-user-interface-config-attributes; + } + + container vxlan { + when "../if:type = 'v3po:vxlan-tunnel'"; + uses vxlan-base-attributes; + } + + container gre { + when "../if:type = 'v3po:gre-tunnel'"; + uses gre-base-attributes; + } + + container l2 { + must "bridged-virtual-interface = 'true' or " + + "(not (../if:ipv4[if:enabled = 'true']/if:address/if:ip) and " + + "not (../if:ipv6[if:enabled = 'true']/if:address/if:ip))"; + + uses l2-config-attributes; + } + + container vxlan-gpe { + when "../if:type = 'v3po:vxlan-gpe-tunnel'"; + + uses vxlan-gpe-base-attributes; + } + + container af-packet { + when "../if:type = 'v3po:af-packet'"; + uses af-packet-base-attributes; + } + + container span { + uses span-attributes; + } + } + + container bridge-domains { + presence "Bridge domains configuration"; + list bridge-domain { + key "name"; + + leaf name { + type string; + } + + uses bridge-domain-attributes; + uses l2-fib-attributes; + + description + "bridge-domain configuration"; + } + } + + augment /if:interfaces { + ext:augment-identifier "vpp-interfaces-stats-augmentation"; + container statistics{ + leaf enabled { + type boolean; + default false; + } + } + } + + augment /if:interfaces/if:interface/if:statistics { + ext:augment-identifier "vpp-interface-statistics-augmentation"; + leaf in-errors-no-buf { + type yang:counter64; + } + leaf in-errors-miss { + type yang:counter64; + } + leaf out-discards-fifo-full { + type yang:counter64; + } + } + + container bridge-domains-state { + // FIXME: Should this live in bridge-domain.yang in a modular fashion ? + config "false"; + list bridge-domain { + + key "name"; + leaf name { + type string; + } + + uses bridge-domain-attributes; + uses l2-fib-attributes; + + description + "bridge-domain operational data"; + } + } + + // VPP Notifications + + typedef interface-status { + type enumeration { + enum up { + value 1; + } + enum down { + value 0; + } + } + } + + typedef interface-name-or-index { + type union { + type string; + type uint32; + } + } + + notification interface-change { + leaf name { + type interface-name-or-index; + } + + leaf admin-status { + type interface-status; + } + + leaf oper-status { + type interface-status; + } + } + + notification interface-deleted { + leaf name { + type interface-name-or-index; + } + } +} diff --git a/v3po/api/src/main/yang/vpp-pbb@2016-12-14.yang b/v3po/api/src/main/yang/vpp-pbb@2016-12-14.yang deleted file mode 100644 index 159d05de6..000000000 --- a/v3po/api/src/main/yang/vpp-pbb@2016-12-14.yang +++ /dev/null @@ -1,62 +0,0 @@ -module vpp-pbb { - yang-version 1; - namespace "http://fd.io/hc2vpp/yang/vpp-pbb"; - prefix "vpp-pbb"; - - import ietf-interfaces { - prefix "if"; - } - - import pbb-types { - prefix "pbb-types"; - } - - import yang-ext { - prefix "ext"; - } - - organization - "FD.io - The Fast Data Project"; - - contact - "Hc2vpp Wiki - Mailing List "; - - description - "This module contains a collection of YANG definitions - that extend ietf-interfaces module - with support for PBB based subinterfaces. - - Copyright (c) 2016 Cisco and/or its affiliates. - - Licensed under the Apache License, Version 2.0 (the 'License'); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at: - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an 'AS IS' BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License."; - - revision "2016-12-14" { - description "Initial revision of pbb model"; - } - - augment /if:interfaces/if:interface { - ext:augment-identifier "pbb-rewrite-interface-augmentation"; - container pbb-rewrite { - uses pbb-types:pbb-rewrite-attributes; - } - } - - augment /if:interfaces/if:interface { - ext:augment-identifier "pbb-rewrite-state-interface-augmentation"; - container pbb-rewrite-state { - uses pbb-types:pbb-rewrite-attributes; - config false; - } - } -} diff --git a/v3po/api/src/main/yang/vpp-pbb@2019-05-27.yang b/v3po/api/src/main/yang/vpp-pbb@2019-05-27.yang new file mode 100644 index 000000000..1ea4e437a --- /dev/null +++ b/v3po/api/src/main/yang/vpp-pbb@2019-05-27.yang @@ -0,0 +1,60 @@ +module vpp-pbb { + yang-version 1; + namespace "http://fd.io/hc2vpp/yang/vpp-pbb"; + prefix "vpp-pbb"; + + import ietf-interfaces { + prefix "if"; + } + + import pbb-types { + prefix "pbb-types"; + } + + import yang-ext { + prefix "ext"; + } + + organization + "FD.io - The Fast Data Project"; + + contact + "Hc2vpp Wiki + Mailing List "; + + description + "This module contains a collection of YANG definitions + that extend ietf-interfaces module + with support for PBB based subinterfaces. + + Copyright (c) 2016 Cisco and/or its affiliates. + + Licensed under the Apache License, Version 2.0 (the 'License'); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at: + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an 'AS IS' BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License."; + + revision "2019-05-27" { + description + "Removed interfaces-state augmentations due to its deprecation + in ietf-interfaces model"; + } + + revision "2016-12-14" { + description "Initial revision of pbb model"; + } + + augment /if:interfaces/if:interface { + ext:augment-identifier "pbb-rewrite-interface-augmentation"; + container pbb-rewrite { + uses pbb-types:pbb-rewrite-attributes; + } + } +} diff --git a/v3po/api/src/main/yang/vpp-vlan@2018-03-19.yang b/v3po/api/src/main/yang/vpp-vlan@2018-03-19.yang deleted file mode 100644 index 05b088689..000000000 --- a/v3po/api/src/main/yang/vpp-vlan@2018-03-19.yang +++ /dev/null @@ -1,467 +0,0 @@ -module vpp-vlan { - yang-version 1; - namespace "http://fd.io/hc2vpp/yang/vpp-vlan"; - prefix "vpp-vlan"; - - import ietf-interfaces { - prefix "if"; - } - import ietf-inet-types { - prefix inet; - } - import ietf-yang-types { - prefix "yang"; - } - import yang-ext { - prefix "ext"; - } - import dot1q-types { - prefix dot1q; - } - import v3po { - prefix v3po; - } - - organization - "FD.io - The Fast Data Project"; - - contact - "Hc2vpp Wiki - Mailing List "; - - description - "This module contains a collection of YANG definitions - for managing VPP VLANs. - - Copyright (c) 2016-2018 Cisco and/or its affiliates. - - Licensed under the Apache License, Version 2.0 (the 'License'); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at: - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an 'AS IS' BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License."; - - revision "2018-03-19" { - description "Prefix invalid 802dot1q and 802dot1ad identifiers with underscore."; - } - - revision "2017-06-07" { - description "Eliminated config leafrefs in operational tree"; - } - - revision "2017-05-09" { - description "Revision changes: - - add support for ipv4/6 vrf id for sub interfaces"; - } - - revision "2017-03-15" { - description - "Revision changes: - - acl and ietf-acl moved to vpp-subinterface-acl"; - } - - revision "2016-12-14" { - description - "This revision adds the following new features: - - ingress/egress ACLs support"; - } - - revision "2016-05-27" { - description - "Initial revision of vlan model for VPP. - Reuses some concepts from draft-wilton-netmod-intf-vlan-yang-02 model."; - } - - typedef sub-interface-status { - type enumeration { - enum "up"; - enum "down"; - } - } - - // todo add 802dot1ad support to dot1q-types.yang - /* - * Defines the supported IEEE 802.1Q types that can be used for - * VLAN tag matching. - */ - identity vlan-type { - description "Base identity from which all VLAN types - are derived from"; - } - - identity _802dot1q { - base vlan-type; - description - "An 802.1Q VLAN type"; - } - - identity _802dot1ad { - base vlan-type; - description - "An 802.1ad VLAN type"; - } - - typedef vlan-type { - type identityref { - base "vlan-type"; - } - description "Identifies a specific VLAN type"; - } - - grouping match-attributes { - choice match-type { - mandatory true; - description "Provides a choice of how the frames may be matched"; - - case default { - description "Default match"; - leaf default { - type empty; - description - "Default match. Matches all traffic not matched to any - other peer sub-interface by a more specific - encapsulation."; - } // leaf default - } // case default - - case untagged { - description "Match untagged Ethernet frames only"; - leaf untagged { - type empty; - description - "Untagged match. Matches all untagged traffic."; - } // leaf untagged - } // case untagged - - case vlan-tagged { - container vlan-tagged { - description "Matches VLAN tagged frames. Vlan tags need to be specified to use this match type"; - - leaf match-exact-tags { - type boolean; - default true; - description - "If set, indicates that all 802.1Q VLAN tags in the - Ethernet frame header must be explicitly matched, i.e. - the EtherType following the matched tags must not be a - 802.1Q tag EtherType. If unset then extra 802.1Q VLAN - tags are allowed."; - } - } // container vlan-tagged - } // case vlan-tagged - } - } - - // TODO VPP does not allow to change subinterface nor delete it (except for tag-rewrite operation) - grouping sub-interface-base-attributes { - leaf vlan-type { - type vlan-type; - default _802dot1q; - } - - container tags { - list tag { - key "index"; - max-elements 2; - - description "The VLAN tags to use by locally sourced traffic"; - - leaf index { - type uint8 { - range "0..1"; - } - - /* - * Only allow a push of an inner tag if an outer tag is also - * being pushed. - */ - must "index != 0 or - count(../../push-tags[index = 0]/index) > 0" { - error-message "An inner tag can only be pushed if an outer - tag is also specified"; - description "Only allow a push of an inner tag if an outer - tag is also being pushed"; - } - description "The index into the tag stack"; - } - - uses dot1q:dot1q-tag-or-any; - - } - } - - container match { - description - "The match used to classify frames to this interface"; - uses match-attributes; - } - } - - grouping rewrite-attributes { - container rewrite { - uses tag-rewrite; - } - } - - grouping sub-interface-l2-config-attributes { - container l2 { - uses v3po:l2-config-attributes; - uses rewrite-attributes; - } - } - - grouping sub-interface-config-attributes { - leaf enabled { - type boolean; - default "false"; - description - "Contains the configured, desired state of the sub-interface. - To enable sub-interface, the super inerface needs to be enabled"; - } - - leaf admin-status { - type sub-interface-status; - mandatory true; - config false; - } - - leaf oper-status { - type sub-interface-status; - mandatory true; - config false; - } - - leaf if-index { - type int32 { - range "1..2147483647"; - } - mandatory true; - config false; - } - - leaf phys-address { - type yang:phys-address; - description - "The sub-interface's Media Access Control (MAC) address."; - config false; - } - - leaf speed { - type yang:gauge64; - units "bits/second"; - config false; - } - } - - /* - * Only symetrical rewrite is supported - */ - grouping tag-rewrite { - description "Flexible rewrite"; - - leaf vlan-type { // todo rename to push_dot1q, mandatory(?) with default true - type vlan-type; - default _802dot1q; - } - - leaf pop-tags { - type uint8 { - range 1..2; - } - description "The number of tags to pop (or translate if used in - conjunction with push-tags)"; - } - - list push-tags { - key "index"; - max-elements 2; - description "The number of tags to push (or translate if used - in conjunction with pop-tags)"; - /* - * Server should order by increasing index. - */ - leaf index { - type uint8 { - range 0..1; - } - - /* - * Only allow a push of an inner tag if an outer tag is also - * being pushed. - */ - must "index != 0 or - count(../../push-tags[index = 0]/index) > 0" { - error-message "An inner tag can only be pushed if an outer - tag is also specified"; - description "Only allow a push of an inner tag if an outer - tag is also being pushed"; - } - } - - uses dot1q:dot1q-tag; - } - } - - grouping sub-interface-ip4-attributes { - container ipv4 { - // TODO: add currently unsupported: - // enabled, forwarding, mtu, address/origin(config false), neighbor/origin(config false) - - // TODO: reuse groupings once ietf-ip provides them - - description - "Parameters for the IPv4 address family (based on ietf-ip rev. 2014-06-16)"; - - list address { - key "ip"; - description - "The list of configured IPv4 addresses on the interface."; - leaf ip { - type inet:ipv4-address-no-zone; - description - "The IPv4 address on the interface."; - } - - choice subnet { - mandatory true; - description - "The subnet can be specified as a prefix-length, or, - if the server supports non-contiguous netmasks, as - a netmask."; - leaf prefix-length { - type uint8 { - range "0..32"; - } - description - "The length of the subnet prefix."; - } - leaf netmask { - type yang:dotted-quad; - description - "The subnet specified as a netmask (contiguous)"; - } - } // choice subnet - } // list address - - list neighbor { - key "ip"; - description - "A list of mappings from IPv4 addresses to - link-layer addresses. - - Entries in this list are used as static entries in the - ARP Cache."; - reference - "RFC 826: An Ethernet Address Resolution Protocol"; - - leaf ip { - type inet:ipv4-address-no-zone; - description - "The IPv4 address of the neighbor node."; - } - - leaf link-layer-address { - type yang:phys-address; - mandatory true; - description - "The link-layer address of the neighbor node."; - } - } // list neighbor - } - } - - grouping sub-interface-ip6-attributes { - container ipv6 { - // TODO: add currently unsupported: - // enabled, forwarding, mtu, neighbor, dup-addr-detect-transmits, autoconf, - // address(config false): origin, status - // neighbor(config false): origin, is-router, state - - // TODO: reuse groupings once ietf-ip provides them - - description - "Parameters for the IPv6 address family (based on ietf-ip rev. 2014-06-16)"; - - list address { - key "ip"; - description - "The list of configured IPv6 addresses on the interface."; - leaf ip { - type inet:ipv6-address-no-zone; - description - "The IPv6 address on the interface."; - } - - leaf prefix-length { - type uint8 { - range "0..128"; - } - mandatory true; - description - "The length of the subnet prefix."; - } - } // list address - - list neighbor { - key "ip"; - description - "A list of mappings from IPv6 addresses to - link-layer addresses. - - Entries in this list are used as static entries in the - Neighbor Cache."; - reference - "RFC 4861: Neighbor Discovery for IP version 6 (IPv6)"; - - leaf ip { - type inet:ipv6-address-no-zone; - description - "The IPv6 address of the neighbor node."; - } - - leaf link-layer-address { - type yang:phys-address; - mandatory true; - description - "The link-layer address of the neighbor node."; - } - } // list neighbor - } - } - - grouping sub-interface-routing-attributes { - description "Provides basic attributes for ipv4/6 vrf configuration"; - container routing { - uses v3po:routing-base-attributes; - } - } - - augment /if:interfaces/if:interface { - ext:augment-identifier "subinterface-augmentation"; - - container sub-interfaces { - description "L2 vlan subinterfaces"; - - - list sub-interface { - key "identifier"; - leaf identifier { - type uint32; - } - - uses sub-interface-base-attributes; - uses sub-interface-config-attributes; - uses sub-interface-ip4-attributes; - uses sub-interface-ip6-attributes; - uses sub-interface-routing-attributes; - uses sub-interface-l2-config-attributes; - } - } - } -} diff --git a/v3po/api/src/main/yang/vpp-vlan@2019-05-27.yang b/v3po/api/src/main/yang/vpp-vlan@2019-05-27.yang new file mode 100644 index 000000000..bb788231a --- /dev/null +++ b/v3po/api/src/main/yang/vpp-vlan@2019-05-27.yang @@ -0,0 +1,473 @@ +module vpp-vlan { + yang-version 1; + namespace "http://fd.io/hc2vpp/yang/vpp-vlan"; + prefix "vpp-vlan"; + + import ietf-interfaces { + prefix "if"; + } + import ietf-inet-types { + prefix inet; + } + import ietf-yang-types { + prefix "yang"; + } + import yang-ext { + prefix "ext"; + } + import dot1q-types { + prefix dot1q; + } + import v3po { + prefix v3po; + } + + organization + "FD.io - The Fast Data Project"; + + contact + "Hc2vpp Wiki + Mailing List "; + + description + "This module contains a collection of YANG definitions + for managing VPP VLANs. + + Copyright (c) 2016-2018 Cisco and/or its affiliates. + + Licensed under the Apache License, Version 2.0 (the 'License'); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at: + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an 'AS IS' BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License."; + + revision "2019-05-27" { + description + "Removed interfaces-state augmentations due to its deprecation + in ietf-interfaces model"; + } + + revision "2018-03-19" { + description "Prefix invalid 802dot1q and 802dot1ad identifiers with underscore."; + } + + revision "2017-06-07" { + description "Eliminated config leafrefs in operational tree"; + } + + revision "2017-05-09" { + description "Revision changes: + - add support for ipv4/6 vrf id for sub interfaces"; + } + + revision "2017-03-15" { + description + "Revision changes: + - acl and ietf-acl moved to vpp-subinterface-acl"; + } + + revision "2016-12-14" { + description + "This revision adds the following new features: + - ingress/egress ACLs support"; + } + + revision "2016-05-27" { + description + "Initial revision of vlan model for VPP. + Reuses some concepts from draft-wilton-netmod-intf-vlan-yang-02 model."; + } + + typedef sub-interface-status { + type enumeration { + enum "up"; + enum "down"; + } + } + + // todo add 802dot1ad support to dot1q-types.yang + /* + * Defines the supported IEEE 802.1Q types that can be used for + * VLAN tag matching. + */ + identity vlan-type { + description "Base identity from which all VLAN types + are derived from"; + } + + identity _802dot1q { + base vlan-type; + description + "An 802.1Q VLAN type"; + } + + identity _802dot1ad { + base vlan-type; + description + "An 802.1ad VLAN type"; + } + + typedef vlan-type { + type identityref { + base "vlan-type"; + } + description "Identifies a specific VLAN type"; + } + + grouping match-attributes { + choice match-type { + mandatory true; + description "Provides a choice of how the frames may be matched"; + + case default { + description "Default match"; + leaf default { + type empty; + description + "Default match. Matches all traffic not matched to any + other peer sub-interface by a more specific + encapsulation."; + } // leaf default + } // case default + + case untagged { + description "Match untagged Ethernet frames only"; + leaf untagged { + type empty; + description + "Untagged match. Matches all untagged traffic."; + } // leaf untagged + } // case untagged + + case vlan-tagged { + container vlan-tagged { + description "Matches VLAN tagged frames. Vlan tags need to be specified to use this match type"; + + leaf match-exact-tags { + type boolean; + default true; + description + "If set, indicates that all 802.1Q VLAN tags in the + Ethernet frame header must be explicitly matched, i.e. + the EtherType following the matched tags must not be a + 802.1Q tag EtherType. If unset then extra 802.1Q VLAN + tags are allowed."; + } + } // container vlan-tagged + } // case vlan-tagged + } + } + + // TODO VPP does not allow to change subinterface nor delete it (except for tag-rewrite operation) + grouping sub-interface-base-attributes { + leaf vlan-type { + type vlan-type; + default _802dot1q; + } + + container tags { + list tag { + key "index"; + max-elements 2; + + description "The VLAN tags to use by locally sourced traffic"; + + leaf index { + type uint8 { + range "0..1"; + } + + /* + * Only allow a push of an inner tag if an outer tag is also + * being pushed. + */ + must "index != 0 or + count(../../push-tags[index = 0]/index) > 0" { + error-message "An inner tag can only be pushed if an outer + tag is also specified"; + description "Only allow a push of an inner tag if an outer + tag is also being pushed"; + } + description "The index into the tag stack"; + } + + uses dot1q:dot1q-tag-or-any; + + } + } + + container match { + description + "The match used to classify frames to this interface"; + uses match-attributes; + } + } + + grouping rewrite-attributes { + container rewrite { + uses tag-rewrite; + } + } + + grouping sub-interface-l2-config-attributes { + container l2 { + uses v3po:l2-config-attributes; + uses rewrite-attributes; + } + } + + grouping sub-interface-config-attributes { + leaf enabled { + type boolean; + default "false"; + description + "Contains the configured, desired state of the sub-interface. + To enable sub-interface, the super inerface needs to be enabled"; + } + + leaf admin-status { + type sub-interface-status; + mandatory true; + config false; + } + + leaf oper-status { + type sub-interface-status; + mandatory true; + config false; + } + + leaf if-index { + type int32 { + range "1..2147483647"; + } + mandatory true; + config false; + } + + leaf phys-address { + type yang:phys-address; + description + "The sub-interface's Media Access Control (MAC) address."; + config false; + } + + leaf speed { + type yang:gauge64; + units "bits/second"; + config false; + } + } + + /* + * Only symetrical rewrite is supported + */ + grouping tag-rewrite { + description "Flexible rewrite"; + + leaf vlan-type { // todo rename to push_dot1q, mandatory(?) with default true + type vlan-type; + default _802dot1q; + } + + leaf pop-tags { + type uint8 { + range 1..2; + } + description "The number of tags to pop (or translate if used in + conjunction with push-tags)"; + } + + list push-tags { + key "index"; + max-elements 2; + description "The number of tags to push (or translate if used + in conjunction with pop-tags)"; + /* + * Server should order by increasing index. + */ + leaf index { + type uint8 { + range 0..1; + } + + /* + * Only allow a push of an inner tag if an outer tag is also + * being pushed. + */ + must "index != 0 or + count(../../push-tags[index = 0]/index) > 0" { + error-message "An inner tag can only be pushed if an outer + tag is also specified"; + description "Only allow a push of an inner tag if an outer + tag is also being pushed"; + } + } + + uses dot1q:dot1q-tag; + } + } + + grouping sub-interface-ip4-attributes { + container ipv4 { + // TODO: add currently unsupported: + // enabled, forwarding, mtu, address/origin(config false), neighbor/origin(config false) + + // TODO: reuse groupings once ietf-ip provides them + + description + "Parameters for the IPv4 address family (based on ietf-ip rev. 2014-06-16)"; + + list address { + key "ip"; + description + "The list of configured IPv4 addresses on the interface."; + leaf ip { + type inet:ipv4-address-no-zone; + description + "The IPv4 address on the interface."; + } + + choice subnet { + mandatory true; + description + "The subnet can be specified as a prefix-length, or, + if the server supports non-contiguous netmasks, as + a netmask."; + leaf prefix-length { + type uint8 { + range "0..32"; + } + description + "The length of the subnet prefix."; + } + leaf netmask { + type yang:dotted-quad; + description + "The subnet specified as a netmask (contiguous)"; + } + } // choice subnet + } // list address + + list neighbor { + key "ip"; + description + "A list of mappings from IPv4 addresses to + link-layer addresses. + + Entries in this list are used as static entries in the + ARP Cache."; + reference + "RFC 826: An Ethernet Address Resolution Protocol"; + + leaf ip { + type inet:ipv4-address-no-zone; + description + "The IPv4 address of the neighbor node."; + } + + leaf link-layer-address { + type yang:phys-address; + mandatory true; + description + "The link-layer address of the neighbor node."; + } + } // list neighbor + } + } + + grouping sub-interface-ip6-attributes { + container ipv6 { + // TODO: add currently unsupported: + // enabled, forwarding, mtu, neighbor, dup-addr-detect-transmits, autoconf, + // address(config false): origin, status + // neighbor(config false): origin, is-router, state + + // TODO: reuse groupings once ietf-ip provides them + + description + "Parameters for the IPv6 address family (based on ietf-ip rev. 2014-06-16)"; + + list address { + key "ip"; + description + "The list of configured IPv6 addresses on the interface."; + leaf ip { + type inet:ipv6-address-no-zone; + description + "The IPv6 address on the interface."; + } + + leaf prefix-length { + type uint8 { + range "0..128"; + } + mandatory true; + description + "The length of the subnet prefix."; + } + } // list address + + list neighbor { + key "ip"; + description + "A list of mappings from IPv6 addresses to + link-layer addresses. + + Entries in this list are used as static entries in the + Neighbor Cache."; + reference + "RFC 4861: Neighbor Discovery for IP version 6 (IPv6)"; + + leaf ip { + type inet:ipv6-address-no-zone; + description + "The IPv6 address of the neighbor node."; + } + + leaf link-layer-address { + type yang:phys-address; + mandatory true; + description + "The link-layer address of the neighbor node."; + } + } // list neighbor + } + } + + grouping sub-interface-routing-attributes { + description "Provides basic attributes for ipv4/6 vrf configuration"; + container routing { + uses v3po:routing-base-attributes; + } + } + + augment /if:interfaces/if:interface { + ext:augment-identifier "subinterface-augmentation"; + + container sub-interfaces { + description "L2 vlan subinterfaces"; + + + list sub-interface { + key "identifier"; + leaf identifier { + type uint32; + } + + uses sub-interface-base-attributes; + uses sub-interface-config-attributes; + uses sub-interface-ip4-attributes; + uses sub-interface-ip6-attributes; + uses sub-interface-routing-attributes; + uses sub-interface-l2-config-attributes; + } + } + } +} -- cgit 1.2.3-korg