Skip to main content

YANG Data Model for Automatic Multicast Tunneling
draft-liu-mboned-amt-yang-01

Document Type Active Internet-Draft (individual)
Authors Yisong Liu , Changwang Lin , Zheng Zhang , Xuesong Geng , Vinod Kumar Nagaraj
Last updated 2022-11-05
RFC stream (None)
Intended RFC status (None)
Formats
Yang Validation 0 errors, 0 warnings
Stream Stream state (No stream defined)
Consensus boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date (None)
Responsible AD (None)
Send notices to (None)
draft-liu-mboned-amt-yang-01
MBONED Working Group                                             Y. Liu
Internet Draft                                             China Mobile
Intended status: Standards Track                                 C. Lin
Expires: May 6, 2023                                            New H3C
                                                               Z. Zhang
                                                                    ZTE
                                                                X. Geng
                                                                 Huawei
                                                       V. Kumar Nagaraj
                                                       Juniper Networks
                                                       November 6, 2022

             YANG Data Model for Automatic Multicast Tunneling
                       draft-liu-mboned-amt-yang-01

Abstract

   This document defines YANG data models for the configuration and
   management of Automatic Multicast Tunneling (AMT) protocol
   operations.

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 https://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 May 6, 2023.

Copyright Notice

   Copyright (c) 2023 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
   publication of this document. Please review these documents
   carefully, as they describe your rights and restrictions with

liu, et al.              Expire May 6, 2023                   [Page 1]
Internet-Draft          YANG Data Model for AMT          November 2022

   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
      1.1. Terminology...............................................2
      1.2. Conventions Used in This Document.........................3
      1.3. Tree Diagrams.............................................3
      1.4. Prefixes in Data Node Names...............................3
   2. Model Overview.................................................4
   3. AMT YANG Module................................................4
      3.1. Tree View.................................................4
      3.2. Yang Module...............................................6
   4. Security Considerations.......................................14
   5. IANA Considerations...........................................14
   6. References....................................................14
      6.1. Normative References.....................................14
      6.2. Informative References...................................15
   Authors' Addresses...............................................16

1. Introduction

   [RFC7450] introduces the protocol definition of the Automatic
   Multicast Tunneling (AMT) for delivering multicast traffic from
   sources in a multicast-enabled network to receivers that lack
   multicast connectivity to the source network.  The protocol uses UDP
   encapsulation and unicast replication to provide this functionality.

   [RFC8777] updates [RFC7450] by modifying the relay discovery
   process. It defines DNS Reverse IP AMT Discovery (DRIAD) mechanism
   for AMT gateways to discover AMT relays that are capable of
   forwarding multicast traffic from a known source IP address.

   This document defines YANG data models for configuring and managing
   AMT Protocol.

1.1. Terminology

   The terminology for describing YANG data models is found in
   [RFC6020] and [RFC7950], including:

   o augment

   o data model

liu, et al.              Expires May 6, 2023                  [Page 2]
Internet-Draft          YANG Data Model for AMT          November 2022

   o data node

   o identity

   o module

   The following abbreviations are used in this document and the
   defined model:

   AMT: Automatic Multicast Tunneling [RFC7450].

1.2. Conventions Used in This Document

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in
   BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

1.3. Tree Diagrams

   Tree diagrams used in this document follow the notation defined in
   [RFC8340].

1.4. Prefixes in Data Node Names

   In this document, names of data nodes, actions, and other data model
   objects are often used without a prefix, as long as it is clear from
   the context in which YANG module each name is defined.  Otherwise,
   names are prefixed using the standard prefix associated with the
   corresponding YANG module, as shown in Table 1.

   +==============+========================+=======================+

   | Prefix       | YANG module            | Reference             |

   +===============+=======================+=======================+

   | inet          | ietf-inet-types       | [RFC6991]             |

   +---------------+-----------------------+-----------------------+

   | rt-types      | ietf-routing-types    | [RFC8294]             |

   +---------------+-----------------------+-----------------------+

liu, et al.              Expires May 6, 2023                  [Page 3]
Internet-Draft          YANG Data Model for AMT          November 2022

   | rt            | ietf-routing          | [RFC8349]             |

   +---------------+-----------------------+-----------------------+

   | yang          | ietf-yang-types       | [RFC6991]             |

   +---------------+-----------------------+-----------------------+

   | if            | ietf-interfaces       | [RFC8343]             |

   +---------------+-----------------------+-----------------------+

                                     Table 1

2. Model Overview

   AMT YANG data models are defined in this document.

   The ietf-amt.yang data model provides the methods for configuring
   and managing AMT Protocol. It includes:

   o Parameters of AMT Relay service, such as Relay Discovery Address,
      Relay Address, service switch, the maximum number of tunnels and
      secret key timeout.

   o Parameters of AMT gateway service, such as Relay Discovery
      Address, Relay Address, Discovery Timeout, Request Timeout and
      Maximum Retransmission Count.

   o AMT tunnel information, such as endpoint address and UDP port,
      local address and UDP port.

   o DNS resource record used by AMTRELAY.

3. AMT YANG Module

3.1. Tree View

   The complete tree of the ietf-amt.yang data model is represented as
   following. See [RFC8340] for an explanation of the symbols used.

   This model augments the core routing data model "ietf-routing"
   specified in [RFC8349].  The AMT model augments
   "/rt:routing/rt:control-plane-protocols".

liu, et al.              Expires May 6, 2023                  [Page 4]
Internet-Draft          YANG Data Model for AMT          November 2022

   module: ietf-amt
     augment /rt:routing/rt:control-plane-protocols:
       +--rw amt!
          +--rw relay
          |  +--rw relay-addresses
          |  |  +--rw relay-address* [family]
          |  |     +--rw family             identityref
          |  |     +--rw anycast-prefix     inet:ip-address
          |  |     +--rw local-address      inet:ip-address
          |  +--rw tunnel-limit?            uint32
          |  +--rw secret-key-timeout?      uint32
          |  +--ro amt-tunnels
          |  |  +--ro amt-tunnel* [gateway-address gateway-port]
          |  |     +--ro gateway-address    inet:ip-address
          |  |     +--ro gateway-port       inet:port-number
          |  |     +--ro local-address      inet:ip-address
          |  |     +--ro local-port         inet:port-number
          |  |     +--ro state              enumeration
          |  |     +--ro multicastflows
          |  |        +--ro multicastflow* [source-address
          |  |           |                      group-address]
          |  |           +--ro source-address
          |  |           |         ip-multicast-source-address
          |  |           +--ro group-address
          |  |                     rt-types:ip-multicast-group-address
          |  +--rw amtrelay-dns-resource-records
          |     +--rw amtrelay-dns-resource-record* [source-address]
          |        +--rw source-address         inet:ip-address
          |        +--rw precedence?            uint32
          |        +--rw d-flag?                boolean
          |        +--rw relay-type?            enumeration
          |        +--rw discovery-address?     inet:ip-address
          |        +--rw domain-name?           inet:domain-name
          +--rw gateway
             +--rw pseudo-interfaces
                +--rw pseudo-interface* [ifIndex]
                   +--rw ifIndex                   if:interface-ref
                   +--rw discovery-method          enumeration
                   +--rw relay-discovery-address?  inet:ip-address
                   +--rw relay-address?            inet:ip-address
                   +--rw upstream-interface?       if:interface-ref
                   +--rw discovery-timeout?        uint32
                   +--rw discovery-retrans-count?  uint32
                   +--rw request-timeout?          uint32
                   +--rw request-retrans-count?    uint32
                   +--rw dest-unreach-retry-count? uint32
                   +--rw relay-port?               inet:port-number
                   +--ro local-address?            inet:ip-address

liu, et al.              Expires May 6, 2023                  [Page 5]
Internet-Draft          YANG Data Model for AMT          November 2022

                   +--ro local-port?               inet:port-number
                   +--ro tunnel-state              enumeration

3.2. Yang Module

   <CODE BEGINS> file "ietf-amt@2022-10-25.yang"

   module ietf-amt {
     yang-version "1.1";
     namespace "urn:ietf:params:xml:ns:yang:ietf-amt";
     prefix "amt";

     import ietf-inet-types {
       prefix "inet";
       reference
         "RFC 6991: Common YANG Data Types";
     }

     import ietf-routing-types {
          prefix rt-types;
          reference
            "RFC 8294, Common YANG Data Types for the Routing Area.";
     }

     import ietf-interfaces {
          prefix if;
          reference
            "RFC 8343, A YANG Data Model for Interface Management.";
     }

     import ietf-routing {
          prefix rt;
          reference
            "RFC 8349, A YANG Data Model for Routing Management
             (NMDA Version).";
     }

     organization
       "IETF MBONE Working Group";

     contact
       "TBD";

     description
       "This module describes a YANG model for configuring and managing
        AMT Protocol.

        This YANG model conforms to the Network Management

liu, et al.              Expires May 6, 2023                  [Page 6]
Internet-Draft          YANG Data Model for AMT          November 2022

        Datastore Architecture (NMDA) as described in RFC 8342.

        Copyright (c) 2022 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 Revised BSD License set
        forth in Section 4.c of the IETF Trust's Legal Provisions
        Relating to IETF Documents
        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of RFC XXXX;
        see the RFC itself for full legal notices.

        The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
        NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
        'MAY', and 'OPTIONAL' in this document are to be interpreted as
        described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
        they appear in all capitals, as shown here.";

     revision 2022-10-25 {
       description
         "Initial Version";
       reference
         "RFC XXXX, YANG Data Model for Automatic Multicast Tunneling";
     }

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

     typedef ip-multicast-source-address {
       type union {
         type rt-types:ipv4-multicast-source-address;
         type rt-types:ipv6-multicast-source-address;
       }
       description
         "This type represents a version-neutral IP multicast source
          address.  The format of the textual representation implies
          the IP version.";
     }

     augment "/rt:routing/rt:control-plane-protocols" {
       description
         "AMT augmentation to the routing instance model.";

liu, et al.              Expires May 6, 2023                  [Page 7]
Internet-Draft          YANG Data Model for AMT          November 2022

       container amt {
         description
           "Configuration parameters for the AMT protocol.";
         container relay {
           description
             "Parameters of AMT Relay service.";
           container relay-addresses {
             description
               "Parameters of AMT Relay addresses.";
             list relay-address {
               key "family";
               description
                 "Each entry contains parameters for a AMT relay
                  Address identified by the 'family' key.";
               leaf family {
                 type identityref {
                   base address-family;
                 }
                 mandatory true;
                 description
                   "The Address family.";
               }
               leaf anycast-prefix {
                 type inet:ip-address;
                 description
                   "The anycast IP address of AMT Relay Discovery
                    Address.";
               }
               leaf local-address {
                 type inet:ip-address;
                 description
                   "The unicast IP address of AMT Relay Address.";
               }
             }
           }
           leaf tunnel-limit {
             type uint32;
             description
               "The total number of endpoints";
           }
           leaf secret-key-timeout {
             type uint32;
             description
               "The timeout interval of secret key.";
           }
           container amt-tunnels {
             config false;
             description

liu, et al.              Expires May 6, 2023                  [Page 8]
Internet-Draft          YANG Data Model for AMT          November 2022

               "The AMT tunnel information on the relay.";
             list amt-tunnel {
               key "gateway-address gateway-port";
               description
                 "An entry of AMT tunnel.";
               leaf gateway-address {
                 type inet:ip-address;
                 description
                   "The IP address of AMT gateway.";
               }
               leaf gateway-port {
                 type inet:port-number;
                 description
                   "The UDP port of AMT gateway.";
               }
               leaf local-address {
                 type inet:ip-address;
                 description
                   "The local IP address of AMT relay.";
               }
               leaf local-port {
                 type inet:port-number;
                 description
                   "The local UDP port of AMT relay.";
               }
               leaf state {
                 type enumeration {
                   enum up {
                     description
                       "The AMT tunnel has been successfully
                        established.";
                   }
                   enum establishing {
                     description
                       "The AMT tunnel is being establishing.";
                   }
                 }
                 description
                   "The state of AMT tunnel.";
               }
               container multicastflows {
                 config false;
                 description
                   "The multicast flow information in the AMT tunnel.";
                 list multicastflow {
                   key "source-address group-address";
                   description
                     "An entry of multicast flow.";

liu, et al.              Expires May 6, 2023                  [Page 9]
Internet-Draft          YANG Data Model for AMT          November 2022

                   leaf source-address {
                     type ip-multicast-source-address;
                     description
                       "The source IP address of multicast flow.";
                   }
                   leaf group-address {
                     type rt-types:ip-multicast-group-address;
                     description
                       "The group address of multicast flow.";
                   }
                 }
               }
             }
           }
           container amtrelay-dns-resource-records {
             description
               "The DNS resource records of AMT relay.";
             list amtrelay-dns-resource-record {
               key "source-address";
               description
                 "An entry of AMTRELAY resource record.";
               leaf source-address {
                 type inet:ip-address;
                 description
                   "The IP address of multicast sender.";
               }
               leaf precedence {
                 type uint32;
                 description
                   "The precedence of this record.";
               }
               leaf d-flag {
                 type boolean;
                 default "false";
                 description
                   "If the D-bit is set to true, the gateway MAY
                    send an AMT Request message directly to the
                    discovered relay address without first
                    sending an AMT Discovery message.
                    If the D-bit is set to false, the gateway MUST
                    receive an AMT Relay Advertisement message
                    for an address before sending an AMT
                    Request message to that address.";
               }
               leaf relay-type {
                 type enumeration {
                   enum empty {
                     value "0";

liu, et al.              Expires May 6, 2023                 [Page 10]
Internet-Draft          YANG Data Model for AMT          November 2022

                     description
                       "The relay field is empty.";
                   }
                   enum ipv4-address {
                     value "1";
                     description
                       "The relay field contains a 4-octet IPv4
                        address.";
                   }
                   enum ipv6-address {
                     value "2";
                     description
                       "The relay field contains a 16-octet IPv6
                        address.";
                   }
                   enum domain-name {
                     value "3";
                     description
                       "The relay field contains a wire-encoded
                        domain name.";
                   }
                 }
                 description
                   "The type of Relay address.";
               }
               leaf discovery-address {
                 type inet:ip-address;
                 description
                   "The IP address of AMT Relay Discovery Address.";
               }
               leaf domain-name {
                 type inet:domain-name;
                 description
                   "The wire-encoded domain name of AMT Relay.";
               }
             }
           }
         } // relay
         container gateway {
           description
             "Parameters of AMT gateway service.";
           container pseudo-interfaces {
             description
               "Parameters of AMT pseudo-interface.";
             list pseudo-interface {
               key ifIndex;
               description
                 "An entry of AMT pseudo-interface.";

liu, et al.              Expires May 6, 2023                 [Page 11]
Internet-Draft          YANG Data Model for AMT          November 2022

               leaf ifIndex {
                 type if:interface-ref;
                 description
                   "Index of pseudo interface, which can be ifindex
                    or interface name.";
               }
               leaf discovery-method {
                 type enumeration {
                   enum by-amt-solicit {
                     description
                       "Find the relay address by sending an AMT
                        Discovery message.";
                   }
                   enum by-dns-reverse-ip {
                     description
                       "Find the relay address by DNS reverse IP
                        AMT Discovery.";
                   }
                 }
                 description
                   "The method of discover relay address.";
               }
               leaf relay-discovery-address {
                 type inet:ip-address;
                 description
                   "The IP address of AMT Relay Discovery Address.";
               }
               leaf relay-address {
                 type inet:ip-address;
                 description
                   "The Ip address of AMT relay Address.";
               }
               leaf upstream-interface {
                 type if:interface-ref;
                 description
                   "The index of upstream interface, which can
                    be ifindex or interface name.";
               }
               leaf discovery-timeout {
                 type uint32;
                 description
                   "Initial time to wait for a response to
                    a Relay Discovery message.";
               }
               leaf discovery-retrans-count {
                 type uint32;
                 description
                   "Maximum number of Relay Discovery retransmissions

liu, et al.              Expires May 6, 2023                 [Page 12]
Internet-Draft          YANG Data Model for AMT          November 2022

                    to allow before terminating relay discovery
                    and reporting an error.";
               }
               leaf request-timeout {
                 type uint32;
                 description
                   "Initial time to wait for a response
                    to a Request message";
               }
               leaf request-retrans-count {
                 type uint32;
                 description
                   "Maximum number of Request retransmissions
                    to allow before abandoning a relay and restarting
                    relay discovery or reporting an error.";
               }
               leaf dest-unreach-retry-count {
                 type uint32;
                 description
                   "The maximum number of times a gateway should
                    attempt to send the same Request or Membership
                    Update message after receiving an ICMP Destination
                    Unreachable message.";
               }
               leaf relay-port {
                 type inet:port-number;
                 description
                   "The UDP port of AMT Relay.";
               }
               leaf local-address {
                 type inet:ip-address;
                 config false;
                 description
                   "The local IP address of this AMT tunnel.";
               }
               leaf local-port {
                 type inet:port-number;
                 config false;
                 description
                   "The local UDP port of this AMT tunnel.";
               }
               leaf tunnel-state {
                 type enumeration {
                   enum initial {
                     description
                       "Initial state.";
                   }
                   enum discoverying {

liu, et al.              Expires May 6, 2023                 [Page 13]
Internet-Draft          YANG Data Model for AMT          November 2022

                     description
                       "The Relay Discovery message has been sent
                        and is waiting for the Advertisement message.";
                   }
                   enum requesting {
                     description
                       "The Request message has been sent,
                        waiting for the Query message.";
                   }
                   enum up {
                     description
                       "The AMT tunnel is Established.";
                   }
                 }
                 config false;
                 description
                   "The tunnel's state.";
               }
             }
           }
         } // gateway
       } // amt
     } // augment
   }

   <CODE ENDS>

4. Security Considerations

   TBD

5. IANA Considerations

   TBD

6. References

6.1. Normative References

   [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
             Requirement Levels", BCP 14, RFC 2119, DOI
             10.17487/RFC2119, March 1997, <https://www.rfc-
             editor.org/info/rfc2119>.

   [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC
             6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-
             editor.org/info/rfc6991>.

liu, et al.              Expires May 6, 2023                 [Page 14]
Internet-Draft          YANG Data Model for AMT          November 2022

   [RFC8294]  Liu, X., Qu, Y., Lindem, A., Hopps, C., and L. Berger,
             "Common YANG Data Types for the Routing Area", RFC 8294,
             DOI 10.17487/RFC8294, December 2017,  <https://www.rfc-
             editor.org/info/rfc8294>.

   [RFC8349]  Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
             Routing Management (NMDA Version)", RFC 8349,  DOI
             10.17487/RFC8349, March 2018,  <https://www.rfc-
             editor.org/info/rfc8349>.

   [RFC7450] Bumgardner, G., " Automatic Multicast Tunneling ", RFC
             7450, DOI 10.17487/RFC7450, February 2015,
             <https://www.rfc-editor.org/info/rfc7450>.

   [RFC8777] Holland, J., " DNS Reverse IP Automatic Multicast
             Tunneling (AMT) Discovery ", RFC 8210, DOI
             10.17487/RFC8777, April 2020, <https://www.rfc-
             editor.org/info/rfc8777>.

   [RFC8340]  Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
             BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
             <https://www.rfc-editor.org/info/rfc8340>.

6.2. Informative References

   XXX

liu, et al.              Expires May 6, 2023                 [Page 15]
Internet-Draft          YANG Data Model for AMT          November 2022

Authors' Addresses

   Yisong Liu
   China Mobile
   China
   Email: liuyisong@chinamobile.com

   Changwang Lin
   New H3C Technologies
   China
   Email: linchangwang.04414@h3c.com

   Zheng(Sandy) Zhang
   ZTE Corporation
   China
   Email: zhang.zheng@zte.com.cn

   Xuesong Geng
   Huawei Technologies
   China
   Email: gengxuesong@huawei.com

   Vinod Kumar Nagaraj
   Juniper Networks

   Email: vinkumar@juniper.net

liu, et al.              Expires May 6, 2023                 [Page 16]