This module contains a collection of YANG definitions for supporting the Broadband Forum requirements on frame classification as...
Version: 2023-12-15
module bbf-frame-classification { yang-version 1.1; namespace "urn:bbf:yang:bbf-frame-classification"; prefix bbf-classif; import ietf-yang-types { prefix yang; } import ietf-inet-types { prefix inet; } import bbf-yang-types { prefix bbf-yang; } import bbf-dot1q-types { prefix bbf-dot1qt; } import bbf-inet-types { prefix bbf-inet; } import bbf-frame-processing-types { prefix bbf-fpt; } organization "Broadband Forum <https://www.broadband-forum.org> Common YANG Work Area"; contact "Comments or questions about this Broadband Forum YANG module should be directed to <mailto:help@broadband-forum.org>. Editor: Nick Hancock, Adtran Editor: Ludwig Pauwels, Nokia PS Leader: Joey Boyd, Adtran WA Director: Joey Boyd, Adtran WA Director: Sven Ooghe, Nokia"; description "This module contains a collection of YANG definitions for supporting the Broadband Forum requirements on frame classification as applicable to access network equipment. As such, this module is specific to access network equipment (e.g., BBF-specified Access Nodes and FTTdp DPUs). Specifically, this module contains reusable groupings defined for frame classification. Copyright (c) 2017-2023, Broadband Forum Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>. Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license. This version of this YANG module is part of TR-383a7; see the TR itself for full legal notices."; revision "2023-12-15" { description "Amendment 7. * Approval Date: 2023-12-15. * Publication Date: 2023-12-15."; reference "TR-383a7: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383_Amendment-7.pdf>"; } revision "2023-03-07" { description "Amendment 6. * Approval Date: 2023-03-07. * Publication Date: 2023-03-07."; reference "TR-383a6: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383_Amendment-6.pdf>"; } revision "2022-03-01" { description "Amendment 5. * Approval Date: 2022-03-01. * Publication Date: 2022-03-01."; reference "TR-383a5: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383_Amendment-5.pdf>"; } revision "2021-06-02" { description "Amendment 4. * Approval Date: 2021-06-02. * Publication Date: 2021-06-02."; reference "TR-383a4: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383_Amendment-4.pdf>"; } revision "2020-10-13" { description "Amendment 3. * Approval Date: 2020-10-13. * Publication Date: 2020-10-13."; reference "TR-383a3: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383_Amendment-3.pdf>"; } revision "2018-07-13" { description "Amendment 1. * Approval Date: 2018-06-04. * Publication Date: see revision date above."; reference "TR-383: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383_Amendment-1.pdf>"; } revision "2017-05-08" { description "Initial revision. * Approval Date: see revision date above. * Publication Date: 2017-06-02."; reference "TR-383: Common YANG Modules <https://www.broadband-forum.org/technical/download/ TR-383.pdf>"; } feature filter-on-ip-prefix { description "This feature indicates whether the network element supports filtering IPv4 and/or IPv6 packets based on configured prefixes."; } typedef protocols { type enumeration { enum "igmp" { value 0; description "Identifies IPv4 IGMP messages, i.e., the IPv4 packets for which in the IPv4 header the protocol field is set to the value 0x02."; } enum "mld" { value 1; description "Identifies IPv6 MLD messages, MLD messages are a subset of the ICMPv6 protocol. ICMPv6 messages are identified with Next Header value of 58. MLD messages are identified by specific values of the Type field. Type field values are defined in RFC 3810."; } enum "dhcpv4" { value 2; description "Identifies IPv4 packets with UDP source port 68 and destination port 67 (client to server), or with UDP source port 67 and destination port 68 (server to client)."; } enum "dhcpv6" { value 3; description "Identifies IPv6 packets with UDP source port 547 and destination port 546 (client to server), or with UDP source port 546 and destination port 547 (server to client)."; } enum "pppoe-discovery" { value 4; description "Identifies PPPoE discovery messages, which are Ethernet frames with Ethertype 0x8863."; } enum "icmpv6" { value 5; description "Identifies ICMPv6 protocol messages. ICMPv6 messages are identified with Next Header value of 58. When the individual ICMPv6 message types are configured then the individual configurations will take precedence over this configuration."; } enum "nd" { value 6; description "Identifies IPv6 ND messages, ND messages are a subset of the ICMPv6 protocol. ICMPv6 messages are identified with Next Header value of 58. ND messages are identified by specific values of the Type field. Type field values are defined in RFC 3810."; } enum "arp" { value 7; description "Identifies the ARP messages, which are Ethernet frames with Ethertype 0x0806."; } enum "cfm" { value 8; description "Identifies the CFM messages, which are Ethernet frames with Ethertype 0x8902."; } enum "dot1x" { value 9; description "Identifies the DOT1X messages, which are Ethernet frames with Ethertype 0x888E."; } enum "lacp" { value 10; description "Identifies the LACP messages, which are Ethernet frames with Ethertype 0x8809."; } } description "Enumerated list of protocols."; } typedef dscp-range-or-any { type union { type bbf-inet:dscp-range; type enumeration { enum "any" { value 0; description "Matches any DSCP value in the range of 0 to 63."; } } } description "Specifies a range of DSCP values. A special value 'any' allows for any DSCP value."; } typedef tag-index { type bbf-fpt:tag-index; status deprecated; description "The index of the VLAN tag in a frame. - Tag 0 refers to the outer tag, i.e., the tag just after the source MAC address. - Tag 1 refers to the tag after tag 0."; } grouping mac-address-match { description "Provides a set of leafs that allow to classify a MAC address."; choice mac-address { description "A choice on the value of the MAC address."; case any-multicast-mac-address { description "This case applies when the to-be-classified MAC address is classified as a multicast MAC address."; leaf any-multicast-mac-address { type empty; description "The MAC address is classified as a multicast address, i.e., it is an address for which the least significant bit of the first octet is set to 1."; } } // case any-multicast-mac-address case unicast-address { description "This case applies when the to-be-classified MAC address is classified as a unicast address."; leaf unicast-address { type empty; description "The MAC address is classified as a unicast address, i.e., it is an address for which the least significant bit of the first octet is set to 0 (zero)."; } } // case unicast-address case broadcast-address { description "This case applies when the to-be-classified MAC address is classified as the broadcast address."; leaf broadcast-address { type empty; description "The MAC address is classified as a broadcast address, i.e., address FF:FF:FF:FF:FF:FF."; } } // case broadcast-address case cfm-multicast-address { description "This case applies when the to-be-classified MAC address is classified as a CFM OAM multicast address."; leaf cfm-multicast-address { type empty; description "The MAC address is classified as a CFM multicast address, i.e., it is an address of the form 01:80:C2:00:00:3X."; reference "IEEE 802.1Q-2014 Clause 8.13.11"; } } // case cfm-multicast-address case ipv4-multicast-address { description "This case applies when the to-be-classified MAC address is classified as an IPv4 multicast address."; leaf ipv4-multicast-address { type empty; description "The MAC address is classified as an IPv4 multicast address, i.e., it is an address in the range 01:00:5E:00:00:00 up to and including 01:00:5E:7F:FF:FF."; } } // case ipv4-multicast-address case ipv6-multicast-address { description "This case applies when the to-be-classified MAC address is classified as an IPv6 multicast address."; leaf ipv6-multicast-address { type empty; description "The MAC address is classified as an IPv6 multicast address, i.e., it is an address of the form 33:33:XX:XX:XX:XX."; } } // case ipv6-multicast-address case mac-address-filter { description "The value and the mask together identify a set of MAC addresses that comply with this classification. Evaluation is performed by making a bit-wise AND operation between the to be evaluated MAC address and the mac-address-mask. There is a match if the result equals the value specified in the mac-address-value."; leaf mac-address-value { type yang:mac-address; description "The value with which a comparison shall be made after performing the bit-wise AND operation on the to be evaluated MAC address."; } leaf mac-address-mask { type yang:mac-address; default "FF:FF:FF:FF:FF:FF"; description "A mask to be applied on the to be evaluated MAC address. The mask is applied as a bit-wise AND operation."; } } // case mac-address-filter } // choice mac-address } // grouping mac-address-match grouping ethertype-match { description "Flexible match on the Ethertype of frames."; leaf ethernet-frame-type { type bbf-dot1qt:ether-type-or-acronym; default "any"; description "The value to be compared with the first Ethertype of an untagged Ethernet frame; or for frames that contain one or more VLAN tags it is the value to be compared with the Ethertype that is defined by the context where this grouping is used. It can be even the Ethertype that identifies a VLAN tag."; } } // grouping ethertype-match grouping ethertype-match-no-default { description "Flexible match on the Ethertype of frames."; leaf-list ethernet-frame-type { type bbf-dot1qt:ether-type-or-acronym; description "The value to be compared with the first Ethertype of an untagged Ethernet frame; or for frames that contain one or more VLAN tags it is the value to be compared with the Ethertype that is defined by the context where this grouping is used. It can be even the Ethertype that identifies a VLAN tag."; } } // grouping ethertype-match-no-default grouping dot1q-tag-ranges-or-any { description "Grouping to allow configuration to identify an 802.1Q VLAN tag that matches any specific VLAN ID within a set of non overlapping VLAN ID ranges, or the 'any' value to match any VLAN ID."; container dot1q-tag { description "Identifies an 802.1Q VLAN tag with an explicit tag-type, an ordered list of VLAN ID ranges, or 'any' VLAN ID."; leaf tag-type { type union { type bbf-dot1qt:dot1q-tag-type; type bbf-dot1qt:ether-type; type bbf-dot1qt:ether-type-hex; type enumeration { enum "any" { value 0; description "Matches any tag type."; } } } mandatory true; description "VLAN tag type."; } leaf vlan-id { type union { type bbf-dot1qt:vlan-id-range; type enumeration { enum "any" { value 0; description "Matches any VLAN ID in the range 1 to 4094, or matches priority tagged frames."; } enum "priority-tagged" { value 1; description "Priority-tagged frames are frames with a VLAN tag present and that match VLAN ID 0."; } } } mandatory true; description "Allowed VLAN IDs."; } leaf pbit { type union { type bbf-dot1qt:pbit-list; type enumeration { enum "any" { value 0; description "Matches any value of the p-bits in the range of 0 to 7."; } } } default "any"; description "Allowed value of the p-bits."; } leaf dei { type union { type bbf-dot1qt:dei; type enumeration { enum "any" { value 0; description "Matches any Drop Eligible Indicator (DEI) value, i.e., value 0 or 1."; } } } default "any"; description "Allowed DEI values."; } } // container dot1q-tag } // grouping dot1q-tag-ranges-or-any grouping vlan-tag-match { description "Flexible match on the VLAN tags of Ethernet frames."; choice vlan-tag-match-type { description "Provides a choice of how the frames may be matched. If no case is configured, then the presence or absence of VLAN tags in the frame is not a matching criterion and then, as to this matching criterion, 'all frames match'."; leaf untagged { type empty; description "Untagged match. Matches all untagged traffic."; } list tag { key "index"; min-elements 1; max-elements 2; description "The tags to match, with the outermost tag to match assigned index 0."; leaf index { type bbf-fpt:tag-index; must "count(../../tag[index = 0]) > 0" { error-message "An inner tag can only be matched on when also matching on an outer tag."; description "Only allow matching on an inner tag, if also matching on the outer tags at the same time."; } description "The index into the tag stack, outermost tag first."; } } // list tag } // choice vlan-tag-match-type } // grouping vlan-tag-match grouping multiple-vlan-tag-match { description "Flexible match on the VLAN tags of Ethernet frames, or the deprecated 'match-all' classification."; uses vlan-tag-match { description "Flexible match on the VLAN tags of Ethernet frames."; augment vlan-tag-match-type { description "Provides a choice of how the frames may be matched. If no case is configured, then the presence or absence of VLAN tags in the frame is not a matching criterion and then, as to this matching criterion, 'all frames match'."; leaf match-all { type empty; status deprecated; description "Matches all traffic, i.e., irrespective of the frame being tagged or untagged."; } } } } // grouping multiple-vlan-tag-match grouping ipv4-address-match { description "Flexible match on the IPv4 address field."; choice ipv4-address { description "A choice on the value of the IPv4 address."; case any-multicast-ipv4-address { description "This represents all IPv4 addresses in the range 224.0.0.0 up to 239.255.255.255."; leaf any-multicast-ipv4-address { type empty; description "Indicates the address is an IPv4 multicast group address."; } } // case any-multicast-ipv4-address case all-hosts-multicast-address { description "This represents the 'all hosts' IPv4 multicast group address 224.0.0.1 that is used to address all hosts on the same network segment."; leaf all-hosts-multicast-address { type empty; description "Indicates the IPv4 address is the 'all hosts' IPv4 multicast group address."; } } // case all-hosts-multicast-address case rip-multicast-address { description "This represents the RIP version 2 IPv4 multicast group address 224.0.0.9 that is used to send routing information to all RIPv2-aware routers on a network segment."; leaf rip-multicast-address { type empty; description "Indicates the IPv4 address is the RIP version 2 IPv4 multicast group address."; } } // case rip-multicast-address case ntp-multicast-address { description "This represents the NTP group IPv4 multicast group address 224.0.1.1 that is used to send network timing protocol messages to all NTP clients on a network segment."; leaf ntp-multicast-address { type empty; description "Indicates the IPv4 address is the NTP IPv4 multicast group address."; } } // case ntp-multicast-address case ipv4-prefix { if-feature bbf-classif:filter-on-ip-prefix; description "This represents an IPv4 address prefix."; leaf ipv4-prefix { type inet:ipv4-prefix; description "This represents an IPv4 address prefix. The prefix length is given by the number following the slash character and must be less than or equal to 32."; } } // case ipv4-prefix } // choice ipv4-address } // grouping ipv4-address-match grouping ipv6-address-match { description "Flexible match on the IPv6 address field."; choice ipv6-address { description "A choice on the value of the IPv6 address."; case any-multicast-ipv6-address { description "This represents all IPv6 addresses which use the prefix ff00::/8."; leaf any-multicast-ipv6-address { type empty; description "Indicates the address is an IPv6 multicast address."; } } // case any-multicast-ipv6-address case all-nodes-multicast-ipv6-address { description "This represents the 'all nodes' IPv6 multicast address ff02::1 which is used to address all nodes on the local network segment."; leaf all-nodes-multicast-ipv6-address { type empty; description "Indicates the IPv6 address is the 'all nodes' IPv6 multicast address."; } } // case all-nodes-multicast-ipv6-address case rip-multicast-ipv6-address { description "This represents the Routing Information Protocol(RIP) IPv6 multicast address ff02::9 which is used to send routing information to all RIP aware routers on a network segment."; leaf rip-multicast-ipv6-address { type empty; description "Indicates the IPv6 address is the RIP routers IPv6 multicast address."; } } // case rip-multicast-ipv6-address case ntp-multicast-ipv6-address { description "This represents the NTP IPv6 multicast address ff02::101 which is used to send Network Timing Protocol (NTP) messages to all NTP clients on a network segment."; leaf ntp-multicast-ipv6-address { type empty; description "Indicates the IPv6 address is the NTP IPv6 multicast address."; } } // case ntp-multicast-ipv6-address case ipv6-prefix { if-feature bbf-classif:filter-on-ip-prefix; description "This represents an IPv6 address prefix."; leaf ipv6-prefix { type inet:ipv6-prefix; description "This represents an IPv6 address prefix. The prefix length is given by the number following the slash character and must be less than or equal to 128."; } } // case ipv6-prefix } // choice ipv6-address } // grouping ipv6-address-match grouping dscp-match { description "Flexible match on the IPv4 or IPv6 Differentiated Services Code Point (DSCP) field."; leaf dscp-range { type dscp-range-or-any; default "any"; description "String identifying the DSCP values and/or range."; reference "RFC 2474"; } } // grouping dscp-match grouping dscp-match-specific { description "Flexible match on the IPv4 or IPv6 Differentiated Services Code Point (DSCP) field."; leaf dscp-range { type bbf-inet:dscp-range; description "String identifying the DSCP values and/or range."; reference "RFC 2474"; } } // grouping dscp-match-specific grouping frame-destination-match { description "Flexible match on the Ethernet or IPv4 or IPv6 destination address."; choice frame-filter { description "Identifies the set of frames to which the frame-forwarding action shall apply. If no case is configured, then the destination of the frame is not a matching criterion and then, as to this matching criterion, 'all frames match'."; case any-frame { description "Any frame. Configuring this 'any-frame' case is equivalent to not configuring any of the cases of this choice and means that 'all frames match'. Configuring allows to have some explicit configuration, e.g., in case of the Transparent LAN service."; leaf any-frame { type empty; description "Any frame."; } } // case any-frame case destination-mac-address { description "The frame classification to be performed on the destination MAC address."; uses bbf-classif:mac-address-match; } // case destination-mac-address case destination-ipv4-address { description "The frame classification to be performed on the destination IPv4 address."; uses bbf-classif:ipv4-address-match; } // case destination-ipv4-address case destination-ipv6-address { description "The frame classification to be performed on the destination IPv6 address."; uses bbf-classif:ipv6-address-match; } // case destination-ipv6-address } // choice frame-filter } // grouping frame-destination-match grouping frame-destination-match-specific { description "Flexible match on the Ethernet or IPv4 or IPv6 destination address."; container frame-destination-filter { presence "The presence of this container enables configuration of match criteria related to one or multiple of the destination fields of a frame. If the container is not present, then none of the destination fields of the frame are used as match criterion and then, as to this match criterion, 'all frames match'. The same applies when the container exists but does not contain any configuration."; description "Identifies the set of frames to which the frame-forwarding action shall apply. If within the container multiple match criteria are configured, then these are to be combined with a logical OR-operation. This applies to multiple entries in the same list, and to entries in different lists."; list destination-mac-address { key "name"; description "The frame classification to be performed on the destination MAC address."; leaf name { type bbf-yang:string-ascii64; description "The rule name."; } uses bbf-classif:mac-address-match; } // list destination-mac-address list destination-ipv4-address { key "name"; description "The frame classification to be performed on the destination IPv4 address."; leaf name { type bbf-yang:string-ascii64; description "The rule name."; } uses bbf-classif:ipv4-address-match; } // list destination-ipv4-address list destination-ipv6-address { key "name"; description "The frame classification to be performed on the destination IPv6 address."; leaf name { type bbf-yang:string-ascii64; description "The rule name."; } uses bbf-classif:ipv6-address-match; } // list destination-ipv6-address } // container frame-destination-filter } // grouping frame-destination-match-specific grouping protocol-match { description "Flexible match on possible frame field combinations that identify a protocol."; choice protocols { description "The choice allows to specify combinations of frame field values that identify a particular protocol/ or allows to indicate any protocol. If no case is configured, then the type of protocol message conveyed in the frame is not a matching criterion and then, as to this matching criterion, 'all frames match'."; leaf any-protocol { type empty; description "Identifies any protocol, i.e., not match is specified for any protocol."; } leaf-list protocol { type protocols; description "Defines the protocols which will be matched."; } } // choice protocols } // grouping protocol-match grouping protocol-match-specific { description "Flexible match on possible frame field combinations that identify a protocol."; leaf-list protocol { type protocols; description "Defines the protocols which will be matched."; } } // grouping protocol-match-specific } // module bbf-frame-classification
© 2023 YumaWorks, Inc. All rights reserved.