netconfcentral logo

ietf-msdp

HTML

ietf-msdp@2017-08-30



  module ietf-msdp {

    yang-version 1;

    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>

     Editor:   Xufeng Liu
               <mailto:Xufeng_Liu@jabil.com>

     Editor:   Zheng Zhang
               <mailto:zhang.zheng@zte.com.cn>

     Editor:   Anish Peter
               <mailto:anish.ietf@gmail.com>

     Editor:   Mahesh Sivakumar
               <mailto:masivaku@cisco.com>

     Editor:   Feng Guo
               <mailto:guofeng@huawei.com>";

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

    revision "2017-08-30" {
      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";

    }


    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.";
    }

    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 {
      description
        "Support configuration of peer timer for holdtime.";
    }

    grouping authentication-container {
      description
        "A container defining authentication attributes.";
      container authentication {
        description
          "A container defining authentication attributes.";
        choice authentication-type {
          description
            "Choice of authentication.";
          case key-chain {
            if-feature peer-key-chain;
            leaf key-chain {
              type key-chain:key-chain-ref;
              description
                "Reference to a key-chain.";
            }
          }  // case key-chain

          case password {
            if-feature peer-key-chain;
            leaf key {
              type string;
              description
                "This leaf describes the authentication key.";
            }

            leaf crypto-algorithm {
              type identityref {
                base key-chain:crypto-algorithm;
              }
              description
                "Cryptographic algorithm associated with key.";
            }
          }  // case password
        }  // choice authentication-type
      }  // container authentication
    }  // grouping 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.
         It is a reference to an entry in the global interface
         list.";
      }
    }  // grouping connect-source

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

      container default-peer {
        if-feature global-default-peer;
        presence
          "Present if the default peer is configured.";
        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.";
        }
      }  // container 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
              "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.";
        }
      }  // container originating-rp

      uses sa-filter-container;

      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;
    }  // grouping global-config-attributes

    grouping global-state-attributes {
      description
        "Global MSDP state attributes.";
    }  // grouping 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;

      leaf description {
        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.";
        }
      }  // container timer

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

    grouping peer-state-attributes {
      description
        "Per peer state attributes for MSDP.";
      leaf session-state {
        type enumeration {
          enum "disabled" {
            value 0;
            description "Disabled.";
          }
          enum "inactive" {
            value 1;
            description "Inactive.";
          }
          enum "listen" {
            value 2;
            description "Listen.";
          }
          enum "connecting" {
            value 3;
            description "Connecting.";
          }
          enum "established" {
            value 4;
            description "Established.";
          }
        }
        config false;
        description "Peer session state.";
        reference
          "RFC3618: Multicast Source Discovery Protocol (MSDP).";

      }

      leaf elapsed-time {
        type uint32;
        units "seconds";
        config false;
        description
          "Elapsed time for being in a state.";
      }

      leaf connect-retry-expire {
        type uint32;
        units "seconds";
        config false;
        description
          "Connect retry expire time of peer connection.";
      }

      leaf hold-expire {
        type uint32;
        units "seconds";
        config false;
        description
          "Hold expire time of peer connection.";
      }

      leaf is-default-peer {
        type boolean;
        config false;
        description
          "If this peer is default peer.";
      }

      leaf keepalive-expire {
        type uint32;
        units "seconds";
        config false;
        description
          "Keepalive expire time of this peer.";
      }

      leaf reset-count {
        type uint32;
        config false;
        description
          "The reset count of this peer.";
      }

      uses statistics-container;
    }  // grouping peer-state-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.";
      }
    }  // grouping 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
         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.";
        }
      }  // container sa-filter
    }  // grouping 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.";
      }
    }  // grouping ttl-threshold

    grouping statistics-container {
      description
        "A container defining statistics attributes.";
      container statistics {
        config false;
        description
          "Container of statistic objects.";
        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 "Error counters.";
          uses statistics-error;
        }  // container error

        container queue {
          description "Queue counters.";
          uses statistics-queue;
        }  // container queue

        container received {
          description
            "Received message counters.";
          uses statistics-sent-received;
        }  // container received

        container sent {
          description
            "Sent message counters.";
          uses statistics-sent-received;
        }  // container sent
      }  // container statistics
    }  // grouping statistics-container

    grouping statistics-error {
      description
        "A grouping defining error statistics
      attributes.";
      leaf rpf-failure {
        type uint32;
        description
          "Number of RPF failures.";
      }
    }  // grouping 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.";
      }
    }  // grouping 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.";
      }

      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.";
      }
    }  // grouping statistics-sent-received

    augment /rt:routing/rt:control-plane-protocols {
      description
        "MSDP augmentation to routing instance.";
      container msdp {
        presence
          "Container for MSDP protocol.";
        description
          "MSDP configuration data.";
        container global {
          description "Global attributes.";
          uses global-config-attributes;

          uses global-state-attributes;
        }  // container global

        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;

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

        container sa-cache {
          config false;
          description
            "The sa cache information.";
          list entry {
            key "group source-addr";
            description
              "A list of sa cache entries.";
            leaf group {
              type inet:ipv4-address;
              description
                "The group address of this sa cache.";
            }

            leaf source-addr {
              type union {
                type enumeration {
                  enum "*" {
                    value 0;
                    description
                      "Any source address.";
                  }
                }
                type inet:ipv4-address;
              }
              description
                "Source IPv4 address.";
            }

            list origin-rp {
              key "rp-address";
              description
                "Origin RP address.";
              leaf rp-address {
                type inet:ip-address;
                description
                  "The RP address.";
              }

              leaf is-local-rp {
                type boolean;
                description
                  "The RP is local.";
              }

              leaf sa-adv-expire {
                type uint32;
                units "seconds";
                description
                  "Periodic SA advertisement timer exipiring time on
                 a local RP.";
              }
            }  // list origin-rp

            uses sa-cache-state-attributes;
          }  // list entry
        }  // container sa-cache
      }  // container msdp
    }

    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-peer

    rpc msdp-clear-sa-cache {
      if-feature rpc-clear-sa-cache;
      description
        "Clears MSDP source active (SA) cache entries.";
      input {
        container entry {
          presence
            "Present if a particular is cleared.";
          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 "The group address";
          }

          leaf source-addr {
            type union {
              type enumeration {
                enum "*" {
                  value 0;
                  description
                    "Any source address.";
                }
              }
              type inet:ipv4-address;
            }
            description
              "Source IPv4 address.";
          }
        }  // container entry

        leaf peer-address {
          type inet:ipv4-address;
          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.";
        }
      }
    }  // rpc msdp-clear-sa-cache
  }  // module ietf-msdp

Summary

  
  
Organization IETF PIM( Protocols for IP Multicast ) Working Group
  
Module ietf-msdp
Version 2017-08-30
File ietf-msdp@2017-08-30.yang
  
Prefix msdp
Namespace urn:ietf:params:xml:ns:yang:ietf-msdp
  
Cooked /cookedmodules/ietf-msdp/2017-08-30
YANG /src/ietf-msdp@2017-08-30.yang
XSD /xsd/ietf-msdp@2017-08-30.xsd
  
Abstract The module defines the YANG definitions for MSDP.
  
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>

Editor:   Xufeng Liu
	  <mailto:Xufeng_Liu@jabil.com>

Editor:   Zheng Zhang
	  <mailto:zhang.zheng@zte.com.cn>

Editor:   Anish Peter
	  <mailto:anish.ietf@gmail.com>

Editor:   Mahesh Sivakumar
	  <mailto:masivaku@cisco.com>

Editor:   Feng Guo
	  <mailto:guofeng@huawei.com>

Description

 
The module defines the YANG definitions for MSDP.

Groupings

Grouping Objects Abstract
authentication-container authentication A container defining authentication attributes.
connect-source connect-source Attribute to configure connect-source.
global-config-attributes connect-sourcedefault-peer originating-rp sa-filtersa-limit ttl-threshold Global MSDP configuration.
global-state-attributes Global MSDP state attributes.
peer-config-attributes authenticationenable connect-sourcedescription mesh-group peer-as sa-filtersa-limit timer ttl-threshold Per peer configuration for MSDP.
peer-state-attributes session-state elapsed-time connect-retry-expire hold-expire is-default-peer keepalive-expire reset-count statistics Per peer state attributes for MSDP.
sa-cache-state-attributes up-time expire holddown-interval peer-learned-from rpf-peer SA cache state attributes for MSDP.
sa-filter-container sa-filter A container defining SA filters.
statistics-container statistics A container defining statistics attributes.
statistics-error rpf-failure A grouping defining error statistics attributes.
statistics-queue size-in size-out A grouping defining queue statistics attributes.
statistics-sent-received keepalive notification sa-message sa-response sa-request total A grouping defining sent and received statistics attributes.
ttl-threshold ttl-threshold Attribute to configure TTL threshold.

RPC Methods

RPC Abstract
msdp-clear-peer Clears the session to the peer.
msdp-clear-sa-cache Clears MSDP source active (SA) cache entries.