netconfcentral logo

ietf-network@2017-12-13



  module ietf-network {

    yang-version 1.1;

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

    prefix nw;

    import ietf-inet-types {
      prefix inet;
      reference
        "RFC 6991";


    }

    organization
      "IETF I2RS (Interface to the Routing System) Working Group";

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

     Editor:    Alexander Clemm
                <mailto:ludwig@clemm.org>

     Editor:    Jan Medved
                <mailto:jmedved@cisco.com>

     Editor:    Robert Varga
                <mailto:robert.varga@pantheon.tech>

     Editor:    Nitin Bahadur
                <mailto:nitin_bahadur@yahoo.com>

     Editor:    Hariharan Ananthakrishnan
                <mailto:hari@packetdesign.com>

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

    description
      "This module defines a common base data model for a collection
     of nodes in a network. Node definitions are further used
     in network topologies and inventories.

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

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

     This version of this YANG module is part of
     draft-ietf-i2rs-yang-network-topo-19;
     see the RFC itself for full legal notices.

     NOTE TO RFC EDITOR: Please replace above reference to
     draft-ietf-i2rs-yang-network-topo-19 with RFC
     number when published (i.e. RFC xxxx).";

    revision "2017-12-13" {
      description
        "Initial revision.
       NOTE TO RFC EDITOR:
       (1) Please replace the following reference
       to draft-ietf-i2rs-yang-network-topo-19 with
       RFC number when published (i.e. RFC xxxx).
       (2) Please replace the date in the revision statement with the
       date of publication when published. ";
      reference
        "draft-ietf-i2rs-yang-network-topo-19";

    }


    typedef node-id {
      type inet:uri;
      description
        "Identifier for a node.  The precise structure of the node-id
       will be up to the implementation.  Some implementations MAY
       for example, pick a uri that includes the network-id as
       part of the path. The identifier SHOULD be chosen such that
       the same node in a real network topology will always be
       identified through the same identifier, even if the data model
       is instantiated in separate datastores. An implementation MAY
       choose to capture semantics in the identifier, for example to
       indicate the type of node.";
    }

    typedef network-id {
      type inet:uri;
      description
        "Identifier for a network.  The precise structure of the
      network-id will be up to an implementation.
      The identifier SHOULD be chosen such that the same network
      will always be identified through the same identifier,
      even if the data model is instantiated in separate datastores.
      An implementation MAY choose to capture semantics in the
      identifier, for example to indicate the type of network.";
    }

    grouping network-ref {
      description
        "Contains the information necessary to reference a network,
       for example an underlay network.";
      leaf network-ref {
        type leafref {
          path
            "/nw:networks/nw:network/nw:network-id";
        }
        description
          "Used to reference a network, for example an underlay
         network.";
      }
    }  // grouping network-ref

    grouping node-ref {
      description
        "Contains the information necessary to reference a node.";
      leaf node-ref {
        type leafref {
          path
            "/nw:networks/nw:network[nw:network-id=current()/../"
              + "network-ref]/nw:node/nw:node-id";
        }
        description
          "Used to reference a node.
         Nodes are identified relative to the network they are
         contained in.";
      }

      uses network-ref;
    }  // grouping node-ref

    container networks {
      description
        "Serves as top-level container for a list of networks.";
      list network {
        key "network-id";
        description
          "Describes a network.
         A network typically contains an inventory of nodes,
         topological information (augmented through
         network-topology data model), as well as layering
         information.";
        leaf network-id {
          type network-id;
          description
            "Identifies a network.";
        }

        container network-types {
          description
            "Serves as an augmentation target.
           The network type is indicated through corresponding
           presence containers augmented into this container.";
        }  // container network-types

        list supporting-network {
          key "network-ref";
          description
            "An underlay network, used to represent layered network
           topologies.";
          leaf network-ref {
            type leafref {
              path "/nw:networks/nw:network/nw:network-id";
            }
            description
              "References the underlay network.";
          }
        }  // list supporting-network

        list node {
          key "node-id";
          description
            "The inventory of nodes of this network.";
          leaf node-id {
            type node-id;
            description
              "Identifies a node uniquely within the containing
             network.";
          }

          list supporting-node {
            key "network-ref node-ref";
            description
              "Represents another node, in an underlay network, that
             this node is supported by.  Used to represent layering
             structure.";
            leaf network-ref {
              type leafref {
                path "../../../nw:supporting-network/nw:network-ref";
              }
              description
                "References the underlay network that the
               underlay node is part of.";
            }

            leaf node-ref {
              type leafref {
                path "/nw:networks/nw:network/nw:node/nw:node-id";
              }
              description
                "References the underlay node itself.";
            }
          }  // list supporting-node
        }  // list node
      }  // list network
    }  // container networks
  }  // module ietf-network