Skip to main content

A YANG Data Model for Layer-2 Network Topologies
draft-ietf-i2rs-yang-l2-network-topology-12

The information below is for an old version of the document.
Document Type
This is an older version of an Internet-Draft that was ultimately published as RFC 8944.
Authors Jie Dong , Xiugang Wei , Qin Wu , Mohamed Boucadair , Anders Liu
Last updated 2019-10-15 (Latest revision 2019-08-30)
Replaces draft-dong-i2rs-l2-network-topology
RFC stream Internet Engineering Task Force (IETF)
Formats
Reviews
Additional resources Mailing list discussion
Stream WG state WG Consensus: Waiting for Write-Up
Document shepherd Susan Hares
Shepherd write-up Show Last changed 2016-11-30
IESG IESG state Became RFC 8944 (Proposed Standard)
Consensus boilerplate Unknown
Telechat date (None)
Responsible AD (None)
Send notices to Susan Hares <shares@ndzh.com.>
draft-ietf-i2rs-yang-l2-network-topology-12
'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.

        Copyright (c) 2019 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

Dong, et al.             Expires April 17, 2020                [Page 27]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

        (https://trustee.ietf.org/license-info).

       This version of this YANG module is part of
       RFC XXXX: A YANG Data Model for Layer-2 Network Topologies
       see the RFC itself for full legal notices.";

    revision "2019-06-04" {
      description "Initial revision";
      reference "RFC XXXX: A YANG Data Model for Layer-2 Network Topologies";
    }

   /*
    * Data nodes
    */
    augment "/nw-s:networks/nw-s:network/nw-s:network-types" {
      description
        "Introduce new network type for L2 topology";
      uses l2t:l2-network-type;
    }

    augment "/nw-s:networks/nw-s:network" {
      when "/nw-s:networks/nw-s:network/nw-s:network-types/"+
        "l2t-s:l2-network" {
        description
          "Augmentation parameters apply only for networks
           with L2 topology.";
      }
      description
        "Configuration parameters for the L2 network
         as a whole.";
      uses l2t:l2-network-attributes;
    }

    augment "/nw-s:networks/nw-s:network/nw-s:node" {
      when "../nw-s:network-types/l2t-s:l2-network" {
        description
          "Augmentation parameters apply only for networks
           with L2 topology.";
      }
      description
        "Configuration parameters for L2 at the node
         level.";
      uses l2t:l2-node-attributes;
    }

    augment "/nw-s:networks/nw-s:network/nt-s:link" {
      when "../nw-s:network-types/l2t-s:l2-network" {
        description

Dong, et al.             Expires April 17, 2020                [Page 28]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

          "Augmentation parameters apply only for networks
           with L2 topology.";
      }
      description "Augments L2 topology link information.";
      uses l2t:l2-link-attributes;
    }

    augment "/nw-s:networks/nw-s:network/nw-s:node/"+
      "nt-s:termination-point" {
      when "../../nw-s:network-types/l2t-s:l2-network" {
        description
          "Augmentation parameters apply only for networks
           with L2 topology.";
      }
      description
        "Augments L2 topology termination point information.";
      uses l2t:l2-termination-point-attributes;
    }

   /*
    * Notifications
    */

    notification l2-node-event {
      description "Notification event for L2 node.";
      leaf event-type {
        type l2t:l2-network-event-type;
        description "Event type.";
      }
      uses nw-s:node-ref;
      uses l2t:l2-network-type;
      uses l2t:l2-node-attributes;
    }

    notification l2-link-event {
      description "Notification event for a L2 link.";
      leaf event-type {
        type l2t:l2-network-event-type;
        description "Event type.";
      }
      uses nt-s:link-ref;
      uses l2t:l2-network-type;
      uses l2t:l2-link-attributes;
    }

    notification l2-termination-point-event {
      description "Notification event for L2 termination point.";
      leaf event-type {

Dong, et al.             Expires April 17, 2020                [Page 29]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

        type l2t:l2-network-event-type;
        description "Event type.";
      }
      uses nt-s:tp-ref;
      uses l2t:l2-network-type;
      uses l2t:l2-termination-point-attributes;
    }
}
<CODE ENDS>

Appendix B.  An Example

   This section contains an example of an instance data tree in JSON
   encoding [RFC7951].  The example instantiates "ietf-l2- topology" for
   the topology that is depicted in the following diagram.  There are
   three nodes: D1, D2, and D3.  D1 has three termination points: 1-0-1,
   1-2-1, and 1-3-1.  D2 has three termination points as well: 2-1-1,
   2-0-1, and 2-3-1.  D3 has two termination points: 3-1-1 and 3-2-1.
   In addition, there are six links, two between each pair of nodes,
   with one going in each direction.

                   +------------+                   +------------+
                   |     D1     |                   |     D2     |
                  /-\          /-\                 /-\          /-\
                  | | 1-0-1    | |---------------->| | 2-1-1    | |
                  | |    1-2-1 | |<----------------| |    2-0-1 | |
                  \-/  1-3-1   \-/                 \-/  2-3-1   \-/
                   |   /----\   |                   |   /----\   |
                   +---|    |---+                   +---|    |---+
                       \----/                           \----/
                        A  |                             A  |
                        |  |                             |  |
                        |  |                             |  |
                        |  |       +------------+        |  |
                        |  |       |     D3     |        |  |
                        |  |      /-\          /-\       |  |
                        |  +----->| | 3-1-1    | |-------+  |
                        +---------| |    3-2-1 | |<---------+
                                  \-/          \-/
                                   |            |
                                   +------------+

                      Figure 2. A Network Topology Example

   The corresponding instance data tree is depicted as below.  Note that
   some lines have been wrapped to adhere to the 72-character line
   limitation of RFCs.

Dong, et al.             Expires April 17, 2020                [Page 30]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

    {
        "ietf-network:networks": {
          "network": [
            {
              "network-types": {
                "ietf-l2-topology:l2-network": {}
              },
              "network-id": "l2-topo-example",
              "node": [
                {
                  "node-id": "D1",
                  "termination-point": [
                    {
                      "tp-id": "1-0-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-D0"
                      }
                    },
                    {
                      "tp-id": "1-2-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-D1"
                      }
                    },
                    {
                      "tp-id": "1-3-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-D2"
                      }
                    }
                  ],
                  "ietf-l2-topology:l2-node-attributes": {
                    "management-address": ["192.0.2.1"]
                  }
                },
                {
                  "node-id": "D2",
                  "termination-point": [
                    {
                      "tp-id": "2-0-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-E0"
                      }
                    },

Dong, et al.             Expires April 17, 2020                [Page 31]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

                    {
                      "tp-id": "2-1-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-E1"
                      }
                    },
                    {
                      "tp-id": "2-3-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-E2"
                      }
                    }
                  ],
                  "ietf-l2-topology:l2-node-attributes": {
                    "management-address": ["192.0.2.2"]
                  }
                },
                {
                  "node-id": "D3",
                  "termination-point": [
                    {
                      "tp-id": "3-1-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-F0"
                      }
                    },
                    {
                      "tp-id": "3-2-1",
                      "ietf-l2-topology:
                        l2-termination-point-attributes": {
                        "mac-address": "00-00-5E-00-53-F1"
                      }
                    }
                  ],
                  "ietf-l2-topology:l2-node-attributes": {
                    "management-address": ["192.0.2.3"]
                  }
                }
              ],
              "ietf-network-topology:link": [
                {
                  "link-id": "D1,1-2-1,D2,2-1-1",
                  "source": {
                    "source-node": "D1",
                    "source-tp": "1-2-1"

Dong, et al.             Expires April 17, 2020                [Page 32]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

                  }
                  "destination": {
                    "dest-node": "D2",
                    "dest-tp": "2-1-1"
                  },
                  "ietf-l2-topology:l2-link-attributes": {
                    "rate": "1000"
                  }
                },
                {
                  "link-id": "D2,2-1-1,D1,1-2-1",
                  "source": {
                    "source-node": "D2",
                    "source-tp": "2-1-1"
                  }
                  "destination": {
                    "dest-node": "D1",
                    "dest-tp": "1-2-1"
                  },
                  "ietf-l2-topology:l2-link-attributes": {
                    "rate": "1000"
                  }
                },
                {
                  "link-id": "D1,1-3-1,D3,3-1-1",
                  "source": {
                    "source-node": "D1",
                    "source-tp": "1-3-1"
                  }
                  "destination": {
                    "dest-node": "D3",
                    "dest-tp": "3-1-1"
                  },
                  "ietf-l2-topology:l2-link-attributes": {
                    "rate": "1000"
                  }
                },
                {
                  "link-id": "D3,3-1-1,D1,1-3-1",
                  "source": {
                    "source-node": "D3",
                    "source-tp": "3-1-1"
                  }
                  "destination": {
                    "dest-node": "D1",
                    "dest-tp": "1-3-1"
                  },
                  "ietf-l2-topology:l2-link-attributes": {

Dong, et al.             Expires April 17, 2020                [Page 33]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

                    "rate": "1000"
                  }
                },
                {
                  "link-id": "D2,2-3-1,D3,3-2-1",
                  "source": {
                    "source-node": "D2",
                    "source-tp": "2-3-1"
                  }
                  "destination": {
                    "dest-node": "D3",
                    "dest-tp": "3-2-1"
                  },
                  "ietf-l2-topology:l2-link-attributes": {
                    "rate": "1000"
                  }
                },
                {
                  "link-id": "D3,3-2-1,D2,2-3-1",
                  "source": {
                    "source-node": "D3",
                    "source-tp": "3-2-1"
                  }
                  "destination": {
                    "dest-node": "D2",
                    "dest-tp": "2-3-1"
                  },
                  "ietf-l2-topology:l2-link-attributes": {
                    "rate": "1000"
                  }
                }
              ]
            }
          ]
        }
      }

Authors' Addresses

   Jie Dong
   Huawei
   Huawei Campus, No. 156 Beiqing Rd.
   Beijing  100095
   China

   Email: jie.dong@huawei.com

Dong, et al.             Expires April 17, 2020                [Page 34]
Internet-Draft     Layer-2 Network Topology Data Model      October 2019

   Xiugang Wei
   Huawei
   Huawei Campus, No. 156 Beiqing Rd.
   Beijing  100095
   China

   Email: weixiugang@huawei.com

   Qin Wu
   Huawei
   101 Software Avenue, Yuhua District
   Nanjing  210012
   China

   Email: bill.wu@huawei.com

   Mohamed Boucadair
   Orange
   Rennes 35000
   France

   Email: mohamed.boucadair@orange.com

   Anders Liu
   Tecent
   Yinke Building 38 Haidian St, Haidian District
   Beijing  100080
   China

   Email: andersliu@tencent.com

Dong, et al.             Expires April 17, 2020                [Page 35]