[Docs] [txt|pdf] [Tracker] [WG] [Email] [Diff1] [Diff2] [Nits]

Versions: (draft-zhang-pim-msdp-yang) 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16

PIM WG                                                       Xufeng. Liu
Internet-Draft                                                     Jabil
Intended status: Standards Track                            Zheng. Zhang
Expires: September 2, 2017                               ZTE Corporation
                                                            Anish. Peter
                                                  Individual contributor
                                                       Mahesh. Sivakumar
                                                           Cisco Systems
                                                               Feng. Guo
                                                     Huawei Technologies
                                                        Pete. McAllister
                                                     Metaswitch Networks
                                                           March 1, 2017


                            MSDP YANG Model
                      draft-ietf-pim-msdp-yang-00

Abstract

   This document defines a YANG data model for the configuration and
   management of MSDP Protocol.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on September 2, 2017.

Copyright Notice

   Copyright (c) 2017 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of



Liu, et al.             Expires September 2, 2017               [Page 1]


Internet-Draft               MSDP YANG Model                  March 2017


   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Design of the Data Model  . . . . . . . . . . . . . . . . . .   2
   3.  MSDP configuration  . . . . . . . . . . . . . . . . . . . . .   6
   4.  MSDP State  . . . . . . . . . . . . . . . . . . . . . . . . .   6
   5.  MSDP RPC  . . . . . . . . . . . . . . . . . . . . . . . . . .   6
   6.  Notifications . . . . . . . . . . . . . . . . . . . . . . . .   7
   7.  MSDP YANG model . . . . . . . . . . . . . . . . . . . . . . .   7
   8.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .  22
   9.  Normative References  . . . . . . . . . . . . . . . . . . . .  22
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  22

1.  Introduction

   [RFC3618] introduces the protocol definition of MSDP.  This document
   defines a YANG data model that can be used to configure and manage
   the MSDP protocol.  The operational state data and statistics can
   also be retrieved by this model.

   This model is designed to be used along with other multicast YANG
   models such as PIM, which are not covered in this document.

2.  Design of the Data Model

   This model imports and augments ietf-routing YANG model defined in
   [I-D.ietf-netmod-routing-cfg].  Both configuration branch and state
   branch of [I-D.ietf-netmod-routing-cfg] are augmented.  The
   configuration branch covers global configuration attributes and per
   peer configuration attributes.  The state branch includes global, per
   peer, and source-active information.  The container "msdp" is the top
   level container in this data model.  The presence of this container
   is expected to enable MSDP protocol functionality.

module: ietf-msdp
augment /rt:routing/rt:control-plane-protocols:
   +--rw msdp!
      +--rw global
      |  +--rw connect-source?   if:interface-ref
      |  +--rw default-peer! {global-default-peer}?
      |  |  +--rw peer-addr        leafref



Liu, et al.             Expires September 2, 2017               [Page 2]


Internet-Draft               MSDP YANG Model                  March 2017


      |  |  +--rw prefix-policy?   string {global-default-peer-policy}?
      |  +--rw originating-rp
      |  |  +--rw interface?   if:interface-ref
      |  +--rw sa-filter
      |  |  +--rw in?    string
      |  |  +--rw out?   string
      |  +--rw sa-limit?         uint32 {global-sa-limit}?
      |  +--rw ttl-threshold?    uint8
      +--rw peers
         +--rw peer* [address]
            +--rw address           inet:ipv4-address
            +--rw authentication
            |  +--rw (authentication-type)?
            |     +--:(key-chain) {peer-key-chain}?
            |     |  +--rw key-chain?                key-chain:key-chain-ref
            |     +--:(password) {peer-key-chain}?
            |        +--rw key?                      string
            |        +--rw (algorithm)?
            |           +--:(hmac-sha-1-12) {crypto-hmac-sha-1-12}?
            |           |  +--rw hmac-sha1-12?             empty
            |           +--:(aes-cmac-prf-128) {aes-cmac-prf-128}?
            |           |  +--rw aes-cmac-prf-128?         empty
            |           +--:(md5)
            |           |  +--rw md5?                      empty
            |           +--:(sha-1)
            |           |  +--rw sha-1?                    empty
            |           +--:(hmac-sha-1)
            |           |  +--rw hmac-sha-1?               empty
            |           +--:(hmac-sha-256)
            |           |  +--rw hmac-sha-256?             empty
            |           +--:(hmac-sha-384)
            |           |  +--rw hmac-sha-384?             empty
            |           +--:(hmac-sha-512)
            |           |  +--rw hmac-sha-512?             empty
            |           +--:(clear-text) {clear-text}?
            |           |  +--rw clear-text?               empty
            |           +--:(replay-protection-only) {replay-protection-only}?
            |              +--rw replay-protection-only?   empty
            +--rw enable?           boolean {peer-admin-enable}?
            +--rw connect-source?   if:interface-ref
            +--rw description?      string {peer-description}?
            +--rw mesh-group?       string
            +--rw peer-as?          string {peer-as}?
            +--rw sa-filter
            |  +--rw in?    string
            |  +--rw out?   string
            +--rw sa-limit?         uint32 {peer-sa-limit}?
            +--rw timer



Liu, et al.             Expires September 2, 2017               [Page 3]


Internet-Draft               MSDP YANG Model                  March 2017


            |  +--rw connect-retry-interval?   uint16 {peer-timer-connect-retry}?
            |  +--rw holdtime-interval?        uint16 {peer-timer-holdtime}?
            |  +--rw keepalive-interval?       uint16 {peer-timer-keepalive}?
            +--rw ttl-threshold?    uint8
augment /rt:routing-state/rt:control-plane-protocols:
   +--ro msdp!
      +--ro global
      |  +--ro connect-source?   if:interface-ref
      |  +--ro default-peer! {global-default-peer}?
      |  |  +--ro peer-addr        leafref
      |  |  +--ro prefix-policy?   string {global-default-peer-policy}?
      |  +--ro originating-rp
      |  |  +--ro interface?   if:interface-ref
      |  +--ro sa-filter
      |  |  +--ro in?    string
      |  |  +--ro out?   string
      |  +--ro sa-limit?         uint32 {global-sa-limit}?
      |  +--ro ttl-threshold?    uint8
      +--ro peers
      |  +--ro peer* [address]
      |     +--ro address                 inet:ipv4-address
      |     +--ro authentication
      |     |  +--ro (authentication-type)?
      |     |     +--:(key-chain) {peer-key-chain}?
      |     |     |  +--ro key-chain?                key-chain:key-chain-ref
      |     |     +--:(password) {peer-key-chain}?
      |     |        +--ro key?                      string
      |     |        +--ro (algorithm)?
      |     |           +--:(hmac-sha-1-12) {crypto-hmac-sha-1-12}?
      |     |           |  +--ro hmac-sha1-12?             empty
      |     |           +--:(aes-cmac-prf-128) {aes-cmac-prf-128}?
      |     |           |  +--ro aes-cmac-prf-128?         empty
      |     |           +--:(md5)
      |     |           |  +--ro md5?                      empty
      |     |           +--:(sha-1)
      |     |           |  +--ro sha-1?                    empty
      |     |           +--:(hmac-sha-1)
      |     |           |  +--ro hmac-sha-1?               empty
      |     |           +--:(hmac-sha-256)
      |     |           |  +--ro hmac-sha-256?             empty
      |     |           +--:(hmac-sha-384)
      |     |           |  +--ro hmac-sha-384?             empty
      |     |           +--:(hmac-sha-512)
      |     |           |  +--ro hmac-sha-512?             empty
      |     |           +--:(clear-text) {clear-text}?
      |     |           |  +--ro clear-text?               empty
      |     |           +--:(replay-protection-only) {replay-protection-only}?
      |     |              +--ro replay-protection-only?   empty



Liu, et al.             Expires September 2, 2017               [Page 4]


Internet-Draft               MSDP YANG Model                  March 2017


      |     +--ro enable?                 boolean {peer-admin-enable}?
      |     +--ro connect-source?         if:interface-ref
      |     +--ro description?            string {peer-description}?
      |     +--ro mesh-group?             string
      |     +--ro peer-as?                string {peer-as}?
      |     +--ro sa-filter
      |     |  +--ro in?    string
      |     |  +--ro out?   string
      |     +--ro sa-limit?               uint32 {peer-sa-limit}?
      |     +--ro timer
      |     |  +--ro connect-retry-interval?   uint16 {peer-timer-connect-retry}?
      |     |  +--ro holdtime-interval?        uint16 {peer-timer-holdtime}?
      |     |  +--ro keepalive-interval?       uint16 {peer-timer-keepalive}?
      |     +--ro ttl-threshold?          uint8
      |     +--ro session-state?          enumeration
      |     +--ro elapsed-time?           uint32
      |     +--ro connect-retry-expire?   uint32
      |     +--ro hold-expire?            uint32
      |     +--ro is-default-peer?        boolean
      |     +--ro keepalive-expire?       uint32
      |     +--ro reset-count?            uint32
      |     +--ro statistics
      |        +--ro discontinuity-time?   yang:date-and-time
      |        +--ro error
      |        |  +--ro rpf-failure?   uint32
      |        +--ro queue
      |        |  +--ro size-in?    uint32
      |        |  +--ro size-out?   uint32
      |        +--ro received
      |        |  +--ro keepalive?      yang:counter64
      |        |  +--ro notification?   yang:counter64
      |        |  +--ro sa-message?     yang:counter64
      |        |  +--ro sa-response?    yang:counter64
      |        |  +--ro sa-request?     yang:counter64
      |        |  +--ro total?          yang:counter64
      |        +--ro sent
      |           +--ro keepalive?      yang:counter64
      |           +--ro notification?   yang:counter64
      |           +--ro sa-message?     yang:counter64
      |           +--ro sa-response?    yang:counter64
      |           +--ro sa-request?     yang:counter64
      |           +--ro total?          yang:counter64
      +--ro sa-cache
         +--ro entry* [group source-addr]
            +--ro group                inet:ipv4-address
            +--ro source-addr          union
            +--ro origin-rp* [rp-address]
            |  +--ro rp-address       inet:ip-address



Liu, et al.             Expires September 2, 2017               [Page 5]


Internet-Draft               MSDP YANG Model                  March 2017


            |  +--ro is-local-rp?     boolean
            |  +--ro sa-adv-expire?   uint32
            +--ro up-time?             uint32
            +--ro expire?              uint32
            +--ro holddown-interval?   uint32
            +--ro peer-learned-from?   inet:ipv4-address
            +--ro rpf-peer?            inet:ipv4-address
rpcs:
   +---x msdp-clear-peer
   |  +---w input
   |     +---w peer-address?   inet:ipv4-address
   +---x msdp-clear-sa-cache {rpc-clear-sa-cache}?
      +---w input
         +---w entry!
         |  +---w group          inet:ipv4-address
         |  +---w source-addr?   union
         +---w peer-address?   inet:ipv4-address
         +---w peer-as?        string

3.  MSDP configuration

   MSDP configurations require peer configurations.  Several peers may
   be configured in a mesh-group.  The Source-Active information may be
   filtered by peers.

   The configuration modeling branch is composed of MSDP global and peer
   configurations.  The two parts are the most important parts of MSDP.

   Besides the fundamental features of MSDP protocol, several optional
   features are included in the model.  These features help the control
   of MSDP protocol.  The peer features and SA features make the
   deployment and control easier.  The connection parameters can be used
   to control the TCP connection because MSDP protocol is based on TCP.
   The authentication features make the protocol more secure.  The
   filter features allow operators to avoid the irrelevant information.

4.  MSDP State

   MSDP states are composed of MSDP global state, MSDP peer state,
   statistics information and Sa-cache information.  The statistics
   information and Sa-cache information helps the operator to retrieve
   the protocol condition.

5.  MSDP RPC

   The part is used to define some useful and ordinary operations of
   protocol management.




Liu, et al.             Expires September 2, 2017               [Page 6]


Internet-Draft               MSDP YANG Model                  March 2017


6.  Notifications

   This part will be updated in later version.

7.  MSDP YANG model

<CODE BEGINS> file "ietf-msdp@2016-10-18.yang"
module ietf-msdp {
  namespace "urn:ietf:params:xml:ns:yang:ietf-msdp";
  prefix msdp;

  import ietf-yang-types {
    prefix "yang";
  }

  import ietf-inet-types {
    prefix "inet";
  }

  import ietf-routing {
    prefix "rt";
  }

  import ietf-interfaces {
    prefix "if";
  }

  import ietf-ip {
    prefix "ip";
  }

  import ietf-key-chain {
    prefix "key-chain";
  }

  organization
    "IETF PIM( Protocols for IP Multicast ) Working Group";

  contact
    "WG Web:   <http://tools.ietf.org/wg/pim/>
     WG List:  <mailto:pim@ietf.org>
     WG Chair: Stig Venaas
               <mailto:stig@venaas.com>
     WG Chair: Mike McBride
               <mailto:mmcbride7@gmail.com>

     Editors:   ";




Liu, et al.             Expires September 2, 2017               [Page 7]


Internet-Draft               MSDP YANG Model                  March 2017


  description
    "The module defines the YANG definitions for MSDP.";

  revision 2016-10-18 {
    description
      "Initial revision.";
    reference
      "RFC XXXX: A YANG Data Model for MSDP.
       RFC 3618: Multicast Source Discovery Protocol (MSDP).
       RFC 4624: Multicast Source Discovery Protocol (MSDP) MIB";
  }

  /*
   * Features
   */
  feature global-connect-source {
    description
      "Support configuration of global connect-source.";
  }

  feature global-default-peer {
    description
      "Support configuration of global default peer.";
  }

  feature global-default-peer-policy {
    description
      "Support configuration of global default peer.";
  }

  feature global-sa-filter {
    description
      "Support configuration of global SA filter.";
  }

  feature global-sa-limit {
    description
      "Support configuration of global limit on SA entries.";
  }

  feature global-ttl-threshold {
    description
      "Support configuration of global ttl-threshold.";
  }

  feature rpc-clear-sa-cache {
    description
      "Support the rpc to clear SA cache.";



Liu, et al.             Expires September 2, 2017               [Page 8]


Internet-Draft               MSDP YANG Model                  March 2017


  }

  feature peer-admin-enable {
    description
      "Support configuration of peer administrative enabling.";
  }

  feature peer-as {
    description
      "Support configuration of peer AS number.";
  }

  feature peer-connect-source {
    description
      "Support configuration of global connect-source.";
  }

  feature peer-description {
    description
      "Support configuration of peer description.";
  }

  feature peer-key-chain {
    description
      "Support configuration of peer key-chain.";
  }

  feature peer-password {
    description
      "Support configuration of peer key-chain.";
  }

  feature peer-sa-limit {
    description
      "Support configuration of per peer limit on SA entries.";
  }

  feature peer-timer-connect-retry {
    description
      "Support configuration of peer timer for connect-retry.";
  }

  feature peer-timer-keepalive {
    description
      "Support configuration of peer timer for keepalive.";
  }

  feature peer-timer-holdtime {



Liu, et al.             Expires September 2, 2017               [Page 9]


Internet-Draft               MSDP YANG Model                  March 2017


    description
      "Support configuration of peer timer for holdtime.";
  }

  /*
   * Groupings
   */
  grouping authentication-container {
    description
      "A container defining authentication attributes.";
    container authentication {
      description
        "A container defining authentication attributes.";
      choice authentication-type {
        case key-chain {
          if-feature peer-key-chain;
          leaf key-chain {
            type key-chain:key-chain-ref;
            description
              "Reference to a key-chain.";
          }
        }
        case password {
          if-feature peer-key-chain;
          leaf key {
            type string;
            description
              "This leaf describes the authentication key.";
          }
          /*uses key-chain:crypto-algorithm-types;*/ /*will be modified in next version*/
        }
        description
          "Choice of authentication.";
      }
    }
  } // authentication-container

  grouping connect-source {
    description "Attribute to configure connect-source.";
    leaf connect-source {
      type if:interface-ref;
      must "/if:interfaces/if:interface[if:name = current()]/"
        + "ip:ipv4" {
        description
          "The interface must have IPv4 enabled.";
      }
      description
        "The interface is to be the source for the TCP connection.



Liu, et al.             Expires September 2, 2017              [Page 10]


Internet-Draft               MSDP YANG Model                  March 2017


         It is a reference to an entry in the global interface
         list.";
    }
  } // connect-source

  grouping global-config-attributes {
    description "Global MSDP configuration.";

    uses connect-source {
      if-feature global-connect-source;
    }
    container default-peer {
      if-feature global-default-peer;
      presence "";
      description
        "The default peer accepts all MSDP SA messages.
         A default peer is needed in topologies where MSDP peers do
         not coexist with BGP peers. The reverse path forwarding
         (RPF) check on SA messages can fail, and no SA messages are
         accepted. In these cases, you can configure the peer as a
         default peer and bypass RPF checks.";
      leaf peer-addr {
        type leafref {
          path "../../../peers/peer/address";
        }
        mandatory true;
        description
          "Reference to a peer that is in the peer list.";
      }
      leaf prefix-policy {
        if-feature global-default-peer-policy;
        type string;
        description
          "If specified, only those SA entries whose RP is permitted
           in the prefix list are allowed;
           if not specified, all SA messages from the default peer
           are accepted.";
      }
    } // default-peer

    container originating-rp {
      description
        "The container of originating-rp.";
      leaf interface {
        type if:interface-ref;
        must "/if:interfaces/if:interface[if:name = current()]/"
          + "ip:ipv4" {
          description



Liu, et al.             Expires September 2, 2017              [Page 11]


Internet-Draft               MSDP YANG Model                  March 2017


            "The interface must have IPv4 enabled.";
        }
        description
          "Reference to an entry in the global interface
           list.
           IP address of the interface is used in the RP field of an
           SA message entry. When Anycast RPs are used, all RPs use
           the same IP address. This parameter can be used to define
           a unique IP address for the RP of each MSDP peer.
           By default, the software uses the RP address of the
           local system.";
      }
    } // originating-rp

    uses sa-filter-container {
      if-feature global-sa-filter;
    }
    leaf sa-limit {
      if-feature global-sa-limit;
      type uint32;
      description
        "A limit on the number of SA entries accepted. By default,
         there is no limit.";
    }
    uses ttl-threshold {
      if-feature global-ttl-threshold;
    }
  } // global-config-attributes

  grouping global-state-attributes {
    description "Global MSDP state attributes.";
  } // global-state-attributes

  grouping peer-config-attributes {
    description "Per peer configuration for MSDP.";

    uses authentication-container;
    leaf enable {
      if-feature peer-admin-enable;
      type boolean;
      description
        "true to enable peer;
         false to disable peer.";
    }
    uses connect-source {
      if-feature peer-connect-source;
    }
    leaf description {



Liu, et al.             Expires September 2, 2017              [Page 12]


Internet-Draft               MSDP YANG Model                  March 2017


      if-feature peer-description;
      type string;
      description
        "The peer description.";
    }
    leaf mesh-group {
      type string;
      description
        "Configure this peer to be a member of a mesh group";
    }
    leaf peer-as {
      if-feature peer-as;
      type string;
      description
        "Peer's autonomous system number (ASN).";
    }
    uses sa-filter-container;
    leaf sa-limit {
      if-feature peer-sa-limit;
      type uint32;
      description
        "A limit on the number of SA entries accepted from this peer.
         By default, there is no limit.";
    }
    container timer {
      description "Timer attributes.";
      leaf connect-retry-interval {
        if-feature peer-timer-connect-retry;
        type uint16;
        units seconds;
        default 30;
        description "SHOULD be set to 30 seconds. ";
      }
      leaf holdtime-interval {
        if-feature peer-timer-holdtime;
        type uint16;
        units seconds;
        must ". > 3";
        default 75;
        description "The SA-Hold-Down-Period of this msdp peer.";
      }
      leaf keepalive-interval {
        if-feature peer-timer-keepalive;
        type uint16;
        units seconds;
        must ". > 1 and . < ../holdtime-interval";
        default 60;
        description "The keepalive timer of this msdp peer.";



Liu, et al.             Expires September 2, 2017              [Page 13]


Internet-Draft               MSDP YANG Model                  March 2017


      }
    } // timer
    uses ttl-threshold;
  } // peer-config-attributes

  grouping peer-state-attributes {
    description "Per peer state attributes for MSDP.";

    leaf session-state {
      type enumeration {
        enum disabled  {
          description "Disabled.";
        }
        enum inactive {
          description "Inactive.";
        }
        enum listen {
          description "Listen.";
        }
        enum connecting {
          description "Connecting.";
        }
        enum established {
          description "Established.";
        }
      }
      description
        "Peer session state.";
      reference
        "RFC3618: Multicast Source Discovery Protocol (MSDP).";
    }
    leaf elapsed-time {
      type uint32;
      units seconds;
      description "Elapsed time for being in a state.";
    }
    leaf connect-retry-expire {
      type uint32;
      units seconds;
      description "Connect retry expire time of peer connection.";
    }
    leaf hold-expire {
      type uint32;
      units seconds;
      description "Hold expire time of peer connection.";
    }
    leaf is-default-peer {
      type boolean;



Liu, et al.             Expires September 2, 2017              [Page 14]


Internet-Draft               MSDP YANG Model                  March 2017


      description "If this peer is default peer.";
    }
    leaf keepalive-expire {
      type uint32;
      units seconds;
      description "Keepalive expire time of this peer.";
    }
    leaf reset-count {
      type uint32;
      description "The reset count of this peer.";
    }
    uses statistics-container;
  } // peer-config-attributes

  grouping sa-cache-state-attributes {
    description "SA cache state attributes for MSDP.";

    leaf up-time {
      type uint32;
      units seconds;
      description "The up time of this sa cache.";
    }
    leaf expire {
      type uint32;
      units seconds;
      description "If this cache has expired.";
    }
    leaf holddown-interval {
      type uint32;
      units seconds;
      description "Holddown timer value for SA forwarding.";
    }
    leaf peer-learned-from {
      type inet:ipv4-address;
      description
        "The address of peer that we learned this SA from .";
    }
    leaf rpf-peer {
      type inet:ipv4-address;
      description "RPF peer.";
    }
  } // sa-cache-state-attributes

  grouping sa-filter-container {
    description "A container defining SA filters.";
    container sa-filter {
      description
        "Specifies an access control list (ACL) to filter source



Liu, et al.             Expires September 2, 2017              [Page 15]


Internet-Draft               MSDP YANG Model                  March 2017


         active (SA) messages coming in to or going out of the
         peer.";
      leaf in {
        type string;
        description
          "Filters incoming SA messages only.";
      }
      leaf out {
        type string;
        description
          "Filters outgoing SA messages only.";
      }
    } // sa-filter
  } // sa-filter-container

  grouping ttl-threshold {
    description "Attribute to configure TTL threshold.";
    leaf ttl-threshold {
      type uint8 {
        range 1..255;
      }
      description
        "Maximum number of hops data packets can traverse before
         being dropped.";
    }
  } // sa-ttl-threshold

  grouping statistics-container {
    description
      "A container defining statistics attributes.";
    container statistics {
      description "";
      leaf discontinuity-time {
        type yang:date-and-time;
        description
          "The time on the most recent occasion at which any one
          or more of the statistic counters suffered a
          discontinuity. If no such discontinuities have occurred
          since the last re-initialization of the local
          management subsystem, then this node contains the time
          the local management subsystem re-initialized itself.";
      }
      container error {
        description "";
        uses statistics-error;
      }
      container queue {
        description "";



Liu, et al.             Expires September 2, 2017              [Page 16]


Internet-Draft               MSDP YANG Model                  March 2017


        uses statistics-queue;
      }
      container received {
        description "";
        uses statistics-sent-received;
      }
      container sent {
        description "";
        uses statistics-sent-received;
      }
    }
  } // statistics-container

  grouping statistics-error {
    description
      "A grouping defining error statistics
      attributes.";
    leaf rpf-failure {
      type uint32;
      description "";
    }
  } // statistics-error

  grouping statistics-queue {
    description
      "A grouping defining queue statistics
      attributes.";
    leaf size-in {
      type uint32;
      description
        "The size of the input queue.";
    }
    leaf size-out {
      type uint32;
      description
        "The size of the output queue.";
    }
  } // statistics-queue

  grouping statistics-sent-received {
    description
      "A grouping defining sent and received statistics
      attributes.";
    leaf keepalive {
      type yang:counter64;
      description
        "The number of keepalive messages.";
    }



Liu, et al.             Expires September 2, 2017              [Page 17]


Internet-Draft               MSDP YANG Model                  March 2017


    leaf notification {
      type yang:counter64;
      description
        "The number of notification messages.";
    }
    leaf sa-message {
      type yang:counter64;
      description
        "The number of SA messages.";
    }
    leaf sa-response {
      type yang:counter64;
      description
        "The number of SA response messages.";
    }
    leaf sa-request {
      type yang:counter64;
      description
        "The number of SA request messages.";
    }
    leaf total {
      type yang:counter64;
      description
        "The number of total messages.";
    }
  } // statistics-sent-received

  /*
   * Configuration data nodes
   */
  augment "/rt:routing/rt:control-plane-protocols" {
    description
      "MSDP augmentation to routing instance configuration.";

    container msdp {
      presence "Container for MSDP protocol.";
      description
        "MSDP configuration data.";

      container global {
        description
          "Global attributes.";
        uses global-config-attributes;
      }

      container peers {
        description
          "Containing a list of peers.";



Liu, et al.             Expires September 2, 2017              [Page 18]


Internet-Draft               MSDP YANG Model                  March 2017


        list peer {
          key "address";
          description
            "List of MSDP peers.";
          leaf address {
            type inet:ipv4-address;
            description
              "";
          }
          uses peer-config-attributes;
        } // peer
      } // peers
    } // msdp
  } // augment

  /*
   * Operational state data nodes
   */
  augment "/rt:routing-state/rt:control-plane-protocols" {
    description
      "MSDP augmentation to routing instance state.";

    container msdp {
      presence "Container for MSDP protocol.";
      description
        "MSDP state data.";

      container global {
        description
          "Global attributes.";
        uses global-config-attributes;
        uses global-state-attributes;
      }

      container peers {
        description
          "Containing a list of peers.";

        list peer {
          key "address";
          description
            "List of MSDP peers.";
          leaf address {
            type inet:ipv4-address;
            description
              "The address of peer";
          }
          uses peer-config-attributes;



Liu, et al.             Expires September 2, 2017              [Page 19]


Internet-Draft               MSDP YANG Model                  March 2017


          uses peer-state-attributes;
        } // peer
      } // peers

      container sa-cache {
        description
          "The sa cache information.";
        list entry {
          key "group source-addr";
          description "";
          leaf group {
            type inet:ipv4-address;
            description "The group address of this sa cache.";
          }
          leaf source-addr {
            type union {
              type enumeration {
                enum '*' {
                  description "The source addr of this sa cache.";
                }
              }
              type inet:ipv4-address;
            }
            description "";
          }
          list origin-rp {
            key "rp-address";
            description
              "";
            leaf rp-address {
              type inet:ip-address;
              description "The rp address.";
            }
            leaf is-local-rp {
              type boolean;
              description "";
            }
            leaf sa-adv-expire {
              type uint32;
              units seconds;
              description
                "Periodic SA advertisement timer exipiring time on
                 a local RP.";
            }
          }
          uses sa-cache-state-attributes;
        } // entry
      } // sa-cache



Liu, et al.             Expires September 2, 2017              [Page 20]


Internet-Draft               MSDP YANG Model                  March 2017


    } // msdp
  } // augment

  /*
   * RPCs
   */
  rpc msdp-clear-peer {
    description
      "Clears the session to the peer.";
    input {
      leaf peer-address {
        type inet:ipv4-address;
        description
          "Address of peer to be cleared. If this is not provided
           then all peers are cleared.";
      }
    }
  }

  rpc msdp-clear-sa-cache {
    if-feature rpc-clear-sa-cache;
    description
      "Clears MSDP source active (SA) cache entries.";
    input {
      container entry {
        presence "";
        description
          "The SA cache (S,G) or (*,G) entry to be cleared. If this
           is not provided, all entries are cleared.";
        leaf group {
          type inet:ipv4-address;
          mandatory true;
          description "";
        }
        leaf source-addr {
          type union {
            type enumeration {
              enum '*' {
                description "";
              }
            }
            type inet:ipv4-address;
          }
          description "";
        }
      } // s-g
      leaf peer-address {
        type inet:ipv4-address;



Liu, et al.             Expires September 2, 2017              [Page 21]


Internet-Draft               MSDP YANG Model                  March 2017


        description
          "Peer IP address from which MSDP SA cache entries have been
           learned. If this is not provided, entries learned from all
           peers are cleared.";
      }
      leaf peer-as {
        type string;
        description
          "ASN from which MSDP SA cache entries have been learned.
           If this is not provided, entries learned from all AS's
           are cleared.";
      }
    }
  }
}
<CODE ENDS>

8.  Contributors

   The authors would like to thank Yisong Liu (liuyisong@huawei.com),
   Benchong Xu (xu.benchong@zte.com.cn), Tanmoy Kundu
   (tanmoy.kundu@alcatel-lucent.com) for their valuable contributions.

9.  Normative References

   [I-D.ietf-netmod-routing-cfg]
              Lhotka, L. and A. Lindem, "A YANG Data Model for Routing
              Management", draft-ietf-netmod-routing-cfg-25 (work in
              progress), November 2016.

   [RFC3618]  Fenner, B., Ed. and D. Meyer, Ed., "Multicast Source
              Discovery Protocol (MSDP)", RFC 3618,
              DOI 10.17487/RFC3618, October 2003,
              <http://www.rfc-editor.org/info/rfc3618>.

   [RFC4624]  Fenner, B. and D. Thaler, "Multicast Source Discovery
              Protocol (MSDP) MIB", RFC 4624, DOI 10.17487/RFC4624,
              October 2006, <http://www.rfc-editor.org/info/rfc4624>.

   [RFC6087]  Bierman, A., "Guidelines for Authors and Reviewers of YANG
              Data Model Documents", RFC 6087, DOI 10.17487/RFC6087,
              January 2011, <http://www.rfc-editor.org/info/rfc6087>.

Authors' Addresses







Liu, et al.             Expires September 2, 2017              [Page 22]


Internet-Draft               MSDP YANG Model                  March 2017


   Xufeng Liu
   Jabil
   8281 Greensboro Drive, Suite 200
   McLean  VA 22102
   USA

   Email: Xufeng_Liu@jabil.com


   Zheng Zhang
   ZTE Corporation
   No. 50 Software Ave, Yuhuatai Distinct
   Nanjing
   China

   Email: zhang.zheng@zte.com.cn


   Anish Peter
   Individual contributor

   Email: anish.ietf@gmail.com


   Mahesh Sivakumar
   Cisco Systems
   510 McCarthy Boulevard
   Milpitas, California
   USA

   Email: masivaku@cisco.com


   Feng Guo
   Huawei Technologies
   Huawei Bld., No.156 Beiqing Rd.
   Beijing  100095
   China

   Email: guofeng@huawei.com











Liu, et al.             Expires September 2, 2017              [Page 23]


Internet-Draft               MSDP YANG Model                  March 2017


   Pete McAllister
   Metaswitch Networks
   100 Church Street
   Enfield  EN2 6BQ
   UK

   Email: pete.mcallister@metaswitch.com












































Liu, et al.             Expires September 2, 2017              [Page 24]


Html markup produced by rfcmarkup 1.129d, available from https://tools.ietf.org/tools/rfcmarkup/