netconfcentral logo

ietf-flowspec@2015-09-15



  module ietf-flowspec {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-flowspec";

    prefix flowspec;

    import ietf-inet-types {
      prefix inet;
    }

    organization
      "IETF IDR (Inter-Domain Routing) Working Group";

    contact
      "WG Web:   <http://tools.ietf.org/wg/idr/>
     WG List:  <mailto:idr@ietf.org>

     WG Chair: Susan Hares
               <mailto:shares@ndzh.com>

     WG Chair: John Scudder
               <mailto:jgs@juniper.net>

     Editor:   Shunwan Zhuang
               <mailto:zhuangshunwan@huawei.com>

     Editor:   Nan Wu
               <mailto:eric.wu@huawei.com>

     Editor:   Aseem Choudhary
               <mailto:asechoud@cisco.com>";

    description
      "This module contains a collection of YANG definitions for
     configuring flow specification implementations.

     Copyright (c) 2014 IETF Trust and the persons identified as
     authors of the code.  All rights reserved.

     Redistribution and use in source and binary forms, with or
     without modification, is permitted pursuant to, and subject
     to the license terms contained in, the Simplified BSD License
     set forth in Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (http://trustee.ietf.org/license-info).";

    revision "2015-09-15" {
      description "Initial revision.";
      reference
        "[RFC5575] Dissemination of Flow Specification Rules
        [draft-ietf-netmod-routing-cfg-16]
        A YANG Data Model for Routing Management.
        ";

    }


    typedef component-enum {
      type enumeration {
        enum "destination-prefix" {
          value 1;
          description
            "Type 1 - Destination Prefix";
        }
        enum "source-prefix" {
          value 2;
          description
            "Type 2 - Source Prefix";
        }
        enum "ip-protocol" {
          value 3;
          description "Type 3 - IP Protocol";
        }
        enum "port" {
          value 4;
          description "Type 4 - Port";
        }
        enum "destination-port" {
          value 5;
          description
            "Type 5 - Destination port";
        }
        enum "source-port" {
          value 6;
          description "Type 6 - Source port";
        }
        enum "icmp-type" {
          value 7;
          description "Type 7 - ICMP type";
        }
        enum "icmp-code" {
          value 8;
          description "Type 8 - ICMP code";
        }
        enum "tcp-flags" {
          value 9;
          description "Type 9 - TCP flags";
        }
        enum "packet-length" {
          value 10;
          description
            "Type 10 - Packet length";
        }
        enum "dscp" {
          value 11;
          description
            "Type 11 - DSCP (Diffserv Code Point)";
        }
        enum "fragment" {
          value 12;
          description "Type 12 - Fragment";
        }
      }
      description
        "Definition for component type.";
    }

    typedef action-type {
      type enumeration {
        enum "traffic-rate" {
          value 32774;
          description
            "Carry the 2-octet id and 4-octet of rate information
           in IEEE floating point [IEEE.754.1985] format.";
        }
        enum "traffic-action" {
          value 32775;
          description
            "Consists of 6 bytes of which only the 2 least significant
           bits of the 6th byte (from left to right)
           are currently defined.";
        }
        enum "redirect" {
          value 32776;
          description
            "Allows the traffic to be redirected to a VRF
           routing instance that lists the specified
           route-target in its import policy.";
        }
        enum "traffic-marking" {
          value 32777;
          description
            "Instructs a system to modify the DSCP bits of
           a transiting IP packet to the corresponding value.";
        }
      }
      description
        "Definition for action type.";
    }

    typedef dscp-remarked {
      type enumeration {
        enum "be" {
          value 0;
          description
            "Default dscp (000000)";
        }
        enum "cs1" {
          value 8;
          description
            "CS1(precedence 1) dscp (001000)";
        }
        enum "af11" {
          value 10;
          description "AF11 dscp (001010)";
        }
        enum "af12" {
          value 12;
          description "AF12 dscp (001100)";
        }
        enum "af13" {
          value 14;
          description "AF13 dscp (001110)";
        }
        enum "cs2" {
          value 16;
          description
            "CS2(precedence 2) dscp (010000)";
        }
        enum "af21" {
          value 18;
          description "AF21 dscp (010010)";
        }
        enum "af22" {
          value 20;
          description "AF22 dscp (010100)";
        }
        enum "af23" {
          value 22;
          description "AF23 dscp (010110)";
        }
        enum "cs3" {
          value 24;
          description
            "CS3(precedence 3) dscp (011000)";
        }
        enum "af31" {
          value 26;
          description "AF31 dscp (011010)";
        }
        enum "af32" {
          value 28;
          description "AF32 dscp (011100)";
        }
        enum "af33" {
          value 30;
          description "AF33 dscp (011110)";
        }
        enum "cs4" {
          value 32;
          description
            "CS4(precedence 4) dscp (100000)";
        }
        enum "af41" {
          value 34;
          description "AF41 dscp (100010)";
        }
        enum "af42" {
          value 36;
          description "AF42 dscp (100100)";
        }
        enum "af43" {
          value 38;
          description "AF43 dscp (100110)";
        }
        enum "cs5" {
          value 40;
          description
            "CS5(precedence 5) dscp (101000)";
        }
        enum "ef" {
          value 46;
          description "EF dscp (101110)";
        }
        enum "cs6" {
          value 48;
          description
            "CS6(precedence 6) dscp (110000)";
        }
        enum "cs7" {
          value 56;
          description
            "CS7(precedence 7) dscp (111000)";
        }
      }
      description
        "Definition for dscp type.";
    }

    typedef dscp-type {
      type union {
        type dscp-remarked;
        type uint8;
      }
      description
        "Definition for dscp type.";
    }

    typedef float {
      type union {
        type decimal64 {
          fraction-digits 14;
          range
            "-9999.99999999999999 .. 9999.99999999999999";
        }
        type decimal64 {
          fraction-digits 13;
          range
            "-99999.9999999999999 .. 99999.9999999999999";
        }
        type decimal64 {
          fraction-digits 12;
          range
            "-999999.999999999999 .. 999999.999999999999";
        }
        type decimal64 {
          fraction-digits 11;
          range
            "-9999999.99999999999 .. 9999999.99999999999";
        }
        type decimal64 {
          fraction-digits 10;
          range
            "-99999999.9999999999 .. 99999999.9999999999";
        }
        type decimal64 {
          fraction-digits 9;
          range
            "-999999999.999999999 .. 999999999.999999999";
        }
        type decimal64 {
          fraction-digits 8;
          range
            "-9999999999.99999999 .. 9999999999.99999999";
        }
        type decimal64 {
          fraction-digits 7;
          range
            "-99999999999.9999999 .. 99999999999.9999999";
        }
        type decimal64 {
          fraction-digits 6;
          range
            "-999999999999.999999 .. 999999999999.999999";
        }
        type decimal64 {
          fraction-digits 5;
          range
            "-9999999999999.99999 .. 9999999999999.99999";
        }
        type decimal64 {
          fraction-digits 4;
          range
            "-99999999999999.9999 .. 99999999999999.9999";
        }
        type decimal64 {
          fraction-digits 3;
          range
            "-999999999999999.999 .. 999999999999999.999";
        }
        type decimal64 {
          fraction-digits 2;
          range
            "-9999999999999999.99 .. 9999999999999999.99";
        }
        type decimal64 {
          fraction-digits 1;
          range
            "-99999999999999999.9 .. 99999999999999999.9";
        }
      }
      description
        "Definition for float point referenced from maillist.";
    }

    identity address-family {
      base 
      description
        "Base identity from which identities describing address
       families are derived.";
    }

    identity ipv4 {
      base address-family;
      description
        "This identity represents IPv4 address family.";
    }

    identity ipv6 {
      base address-family;
      description
        "This identity represents IPv6 address family.";
    }

    grouping tcp-flags-value {
      description
        "This group defines TCP flags values for
       tcp-flag component of FlowSpec.";
      leaf value {
        type uint16;
        description
          "Define the value of TCP flags.";
      }
    }  // grouping tcp-flags-value

    grouping dscp-value {
      description
        "This group defines dscp values for
       DSCP component of FlowSpec.";
      leaf min {
        type uint8;
        description
          "Define the minimum value of dscp range.";
      }

      leaf max {
        type uint8;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of dscp range.";
      }
    }  // grouping dscp-value

    grouping ip-protocol-value {
      description
        "This group defines ip-protocol values for
       ip-protocol component of FlowSpec.";
      leaf min {
        type uint8;
        description
          "Define the minimum value of ip-protocol range.";
      }

      leaf max {
        type uint8;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of ip-protocol range.";
      }
    }  // grouping ip-protocol-value

    grouping icmp-type-value {
      description
        "This group defines icmp type values for
       icmp-type component of FlowSpec.";
      leaf min {
        type uint8;
        description
          "Define the minimum value of icmp-type range.";
      }

      leaf max {
        type uint8;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of icmp-type range.";
      }
    }  // grouping icmp-type-value

    grouping icmp-code-value {
      description
        "This group defines icmp code values for
       icmp-code component of FlowSpec.";
      leaf min {
        type uint8;
        description
          "Define the minimum value of icmp-code range.";
      }

      leaf max {
        type uint8;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of icmp-code range.";
      }
    }  // grouping icmp-code-value

    grouping packet-length-value {
      description
        "This group defines packet length values for
       packet-length component of FlowSpec.";
      leaf min {
        type uint16;
        description
          "Define the minimum value of packet-length range.";
      }

      leaf max {
        type uint16;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of packet-length range.";
      }
    }  // grouping packet-length-value

    grouping port-value {
      description
        "This group defines port values for
       port component of FlowSpec.";
      leaf min {
        type uint16;
        description
          "Define the minimum value of port range.";
      }

      leaf max {
        type uint16;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of port range.";
      }
    }  // grouping port-value

    grouping destination-port-value {
      description
        "This group defines destination port values for
       destination-port component of FlowSpec.";
      leaf min {
        type uint16;
        description
          "Define the minimum value of destination-port range.";
      }

      leaf max {
        type uint16;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of destination-port range.";
      }
    }  // grouping destination-port-value

    grouping source-port-value {
      description
        "This group defines source port values for
       source-port component of FlowSpec.";
      leaf min {
        type uint16;
        description
          "Define the minimum value of source-port range.";
      }

      leaf max {
        type uint16;
        must ". >= ../min" {
          error-message
            "The max value must be greater than or
           equal to min value";
          description
            "The max value must be greater than or equal to
           min value.";
        }
        description
          "Define the maximum value of source-port range.";
      }
    }  // grouping source-port-value

    grouping fragment-value {
      description
        "This group defines fragment values for
       Fragment component of FlowSpec.";
      leaf is-fragment {
        type boolean;
        description
          "Match if packet is a fragment ";
      }

      leaf first-fragment {
        type boolean;
        description
          "Match if packet is first fragment ";
      }

      leaf last-fragment {
        type boolean;
        description
          "Match if packet is last fragment ";
      }

      leaf dont-fragment {
        type boolean;
        description
          "Match if don't fragment bit is set in the packet";
      }
    }  // grouping fragment-value

    grouping flowspec-traffic-filter {
      description
        "This group defines the traffic filter rules for FlowSpec.";
      list flowspec-component {
        key "component-type";
        min-elements 1;
        description
          "Define the traffic filter components into a list.";
        leaf component-type {
          type component-enum;
          description
            "Specify the type of component for this list entry.";
        }

        leaf not-operator {
          type boolean;
          description
            "If set to TRUE, the values or ranges specified in the
           component is not to be matched.";
        }

        choice component {
          description
            "Define different kinds of flowspec components involved.";
          leaf destination-prefix {
            type inet:ip-address;
            description
              "Specifies the destination address of the traffic.";
          }
          leaf source-prefix {
            type inet:ip-address;
            description
              "Specifies the source address of the traffic.";
          }
          list ip-protocol {
            key "min max";
            description
              "Define the minimum and maximum ranges
               of an ip-protocol list.";
            uses ip-protocol-value;
          }  // list ip-protocol
          list port {
            key "min max";
            description
              "Define the minimum and maximum ranges
               of a port list.";
            uses port-value;
          }  // list port
          list destination-port {
            key "min max";
            description
              "Define the minimum and maximum ranges of a
               destination-port list.";
            uses destination-port-value;
          }  // list destination-port
          list source-port {
            key "min max";
            description
              "Define the minimum and maximum ranges of a
               source-port list.";
            uses source-port-value;
          }  // list source-port
          list icmp-type {
            key "min max";
            description
              "Define the minimum and maximum ranges of an
               icmp-type list.";
            uses icmp-type-value;
          }  // list icmp-type
          list icmp-code {
            key "min max";
            description
              "Define the minimum and maximum ranges of an
               icmp-code list.";
            uses icmp-code-value;
          }  // list icmp-code
          list tcp-flag {
            key "value";
            description
              "Defines list of tcp-flag entries.";
            uses tcp-flags-value;
          }  // list tcp-flag
          list packet-length {
            key "min max";
            description
              "Define the minimum and maximum ranges of a
               packet-length list.";
            uses packet-length-value;
          }  // list packet-length
          list dscp {
            key "min max";
            description
              "Define the minimum and maximum ranges of a
               dscp list.";
            uses dscp-value;
          }  // list dscp
          container fragment-value {
            description
              "Define Fragment flags value.";
            uses fragment-value;
          }  // container fragment-value
        }  // choice component
      }  // list flowspec-component
    }  // grouping flowspec-traffic-filter

    grouping flowspec-traffic-action {
      description
        "This group defines the traffic actions for FlowSpec.";
      list flowspec-action {
        key "action-type";
        description
          "Define the traffic actions of FlowSpec into a list.";
        leaf action-type {
          type action-type;
          description
            "Specify the type of traffic filter action.";
        }

        choice action {
          description
            "Define different kinds of traffic actions involved.";
          leaf rate {
            type float;
            description
              "Specifies the traffic rate in IEEE floating point
               [IEEE.754.1985] format, units being bytes per
               second.";
          }
          leaf route-target {
            type string {
              length "3..21";
            }
            description
              "Allows the traffic to be redirected to a VRF
               routing instance that lists the specified
               route-target in its import policy";
          }
          leaf remark-dscp {
            type dscp-type;
            description
              "Instructs a system to modify the DSCP bits of
               a transiting IP packet to the corresponding value";
          }
        }  // choice action
      }  // list flowspec-action
    }  // grouping flowspec-traffic-action

    grouping flowspec-bgp-route {
      description
        "This group define extensions of FlowSpec for bgp protocol.";
      leaf neighbor-router-id {
        type inet:ipv4-address;
        description
          "The router-id of the neighbor from whom
         this route received.";
      }

      leaf as-path {
        type string;
        description
          "Number of the AS the BGP FlowSpec route passes.";
      }

      leaf origin {
        type enumeration {
          enum "igp" {
            value 0;
            description
              "Designate this route originated from igp route.";
          }
          enum "egp" {
            value 1;
            description
              "Designate this route originated from egp route.";
          }
          enum "incomplete" {
            value 2;
            description
              "Designate this route originated from other route.";
          }
        }
        description
          "The Origin attribute defines the origin of a route. The
         Origin attribute is classified into the following types:

         Interior Gateway Protocol (IGP): This attribute type has the
         highest priority. IGP is the Origin attribute for routes
         obtained through an IGP in the AS from which the routes
         originate. For example, the Origin attribute of the routes
         imported to the BGP routing table using the network command
         is IGP.

         Exterior Gateway Protocol (EGP): This attribute type has the
         second highest priority. The Origin attribute of the routes
         obtained through EGP is EGP.

         Incomplete: This attribute type has the lowest priority.
         Incomplete is the Origin attribute type of all routes that
         do not have the IGP or EGP Origin attribute. For example,
         the Origin attribute of the routes imported is Incomplete.";
      }

      leaf med {
        type uint32;
        description
          "The Multi-Exit-Discriminator (MED) is transmitted only
         between two neighboring ASs.";
      }

      leaf local-preference {
        type uint8;
        description
          "The local preference of the BGP FlowSpec route.";
      }

      leaf community {
        type string;
        description
          "Community attribute of the BGP FlowSpec route.";
      }

      leaf ext-community {
        type string;
        description
          "Extended community attribute of the BGP FlowSpec route.";
      }

      leaf preference {
        type uint32;
        description
          "The preferred value of a protocol.";
      }

      leaf originator {
        type inet:ip-address;
        description
          "The address of the advertiser of the BGP FlowSpec route.";
      }

      leaf cluster-list {
        type string;
        description
          "Cluster list attribute of the BGP FlowSpec route.";
      }

      uses flowspec-traffic-filter;

      uses flowspec-traffic-action;
    }  // grouping flowspec-bgp-route

    grouping flowspec-protocol-specific {
      description
        "This group define extensions of FlowSpec per protocols.";
      choice protocol {
        description
          "Define specific part of FlowSpec when carried in
         different protocols.";
        case bgp {
          uses flowspec-bgp-route;
        }  // case bgp
      }  // choice protocol
    }  // grouping flowspec-protocol-specific

    container flowspec {
      description
        "Container for flowspec configuration and state";
      container flowspec-cfg {
        description
          "Configuration for flow specification.";
        list flowspec-policy {
          key "policy-name";
          description
            "Configuration of a flow route list.";
          leaf policy-name {
            type string;
            description
              "The name of a flow route.";
          }

          leaf vrf-name {
            type string;
            description
              " Vrf-name of the flowspec-rule";
          }

          leaf address-family {
            type identityref {
              base address-family;
            }
            description
              " address-family of the flowspec-rule";
          }

          list flowspec-rule {
            key "rule-name";
            description
              "Define flow specification filters.";
            leaf rule-name {
              type string;
              description
                "The name of a flowspec rule.";
            }

            uses flowspec-traffic-filter;

            uses flowspec-traffic-action;
          }  // list flowspec-rule
        }  // list flowspec-policy
      }  // container flowspec-cfg

      container flowspec-state {
        config false;
        description
          "Operational state of flow specification.";
        container flowspec-rib {
          description
            "Define the operational state data for FlowSpec entries.";
          list flowspec-entry {
            description
              "FlowSpec entries are organized into list of routes.";
            leaf index {
              type uint32;
              description
                "Flow Specification route entry index.";
            }

            leaf islocal {
              type boolean;
              description
                "Locally configured Flow Specification route.";
            }

            leaf local-name {
              type string;
              description
                "The name of locally configured FlowSpec route.";
            }

            leaf neighbor {
              type inet:ip-address;
              description
                "IP address of an advertising device";
            }

            leaf duration {
              type uint32;
              description
                "Route duration in seconds.";
            }

            container flowspec-protocol-specific {
              description
                "Define the specific extension for each protocol.";
              uses flowspec-protocol-specific;
            }  // container flowspec-protocol-specific
          }  // list flowspec-entry
        }  // container flowspec-rib

        container flowspec-statistics {
          description
            "Define the statistics of list of flowspec rules.";
          list flowspec-stats {
            description
              "Statistics of list of flowspec rules per VRF &
             Address-family.";
            leaf vrf-name {
              type string;
              description
                "Vrf-name of the set of flowspec-rules";
            }

            leaf address-family {
              type string;
              description
                "Address-family of the set of flowspec-rules";
            }

            list flowspec-rule-stats {
              description
                "
               This defines the flowspec filter statistics of
               each flowspec-rules.
              ";
              uses flowspec-traffic-filter;

              uses flowspec-traffic-action;

              leaf classified-pkts {
                type uint64;
                description
                  " Number of total packets which matched
                  to the flowspec-filter";
              }

              leaf classified-bytes {
                type uint64;
                description
                  " Number of total bytes which matched
                  to the flowspec-filter";
              }

              leaf drop-pkts {
                type uint64;
                description
                  " Number of total packets which got dropped";
              }

              leaf drop-bytes {
                type uint64;
                description
                  " Number of total bytes which got dropped";
              }
            }  // list flowspec-rule-stats
          }  // list flowspec-stats
        }  // container flowspec-statistics
      }  // container flowspec-state
    }  // container flowspec
  }  // module ietf-flowspec