netconfcentral logo

ietf-network-state

HTML

ietf-network-state@2017-12-13



  module ietf-network-state {

    yang-version 1.1;

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

    prefix nw-s;

    import ietf-network {
      prefix nw;
      reference
        "draft-ietf-i2rs-yang-network-topo-19
        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).";


    }

    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.  It represents
     information that is either learned and automatically populated,
     or information that results from applying configured netwok
     information configured per the ietf-network data model,
     mirroring the corresponding data nodes in this data model.

     The data model mirrors ietf-network, but contains only
     read-only state data.  The data model is not needed when the
     underlying implementation infrastructure supports the Network
     Management Datastore Architecture (NMDA).

     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 the publication when published.";
      reference
        "draft-ietf-i2rs-yang-network-topo-19";

    }


    grouping network-ref {
      description
        "Contains the information necessary to reference a network,
       for example an underlay network.";
      leaf network-ref {
        type leafref {
          path
            "/nw-s:networks/nw-s:network/nw-s: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-s:networks/nw-s:network[nw-s:network-id=current()"
              + "/../network-ref]/nw-s:node/nw-s: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 {
      config false;
      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.";
        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

        leaf network-id {
          type nw:network-id;
          description
            "Identifies a network.";
        }

        list supporting-network {
          key "network-ref";
          description
            "An underlay network, used to represent layered network
           topologies.";
          leaf network-ref {
            type leafref {
              path "/nw-s:networks/nw-s:network/nw-s: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 nw: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-s:supporting-network/nw-s:network-ref";
              }
              description
                "References the underlay network that the
               underlay node is part of.";
            }

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

Summary

  
  
Organization IETF I2RS (Interface to the Routing System) Working Group
  
Module ietf-network-state
Version 2017-12-13
File ietf-network-state@2017-12-13.yang
  
Prefix nw-s
Namespace urn:ietf:params:xml:ns:yang:ietf-network-state
  
Cooked /cookedmodules/ietf-network-state/2017-12-13
YANG /src/ietf-network-state@2017-12-13.yang
XSD /xsd/ietf-network-state@2017-12-13.xsd
  
Abstract This module defines a common base data model for a collection of nodes in a network. Node definitions are further used in networ...
  
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.  It represents
information that is either learned and automatically populated,
or information that results from applying configured netwok
information configured per the ietf-network data model,
mirroring the corresponding data nodes in this data model.

The data model mirrors ietf-network, but contains only
read-only state data.  The data model is not needed when the
underlying implementation infrastructure supports the Network
Management Datastore Architecture (NMDA).

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).

Groupings

Grouping Objects Abstract
network-ref network-ref Contains the information necessary to reference a network, for example an underlay network.
node-ref node-ref network-ref Contains the information necessary to reference a node.

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
networks container Serves as top-level container for a list of networks.
   network list Describes a network. A network typically contains an inventory of nodes, topological information (augmented through network-topology data model), as well as layering information.
      network-id leaf Identifies a network.
      network-types container Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container.
      node list The inventory of nodes of this network.
         node-id leaf Identifies a node uniquely within the containing network.
         supporting-node list Represents another node, in an underlay network, that this node is supported by. Used to represent layering structure.
            network-ref leaf References the underlay network that the underlay node is part of.
            node-ref leaf References the underlay node itself.
      supporting-network list An underlay network, used to represent layered network topologies.
         network-ref leaf References the underlay network.