User documentation for yang module ietf-network.yang

module ietf-network                                                          1
  ietf-network data                                                        1.1
    list nd:network                                                      1.1.1
      container nd:network-types                                       1.1.1.1
      list nd:supporting-network                                       1.1.1.2
      list nd:node                                                     1.1.1.3
        list nd:supporting-node                                      1.1.1.3.1


1  module ietf-network

1.1  ietf-network data
  Description
    This module defines a common base model for a collection
    of nodes in a network. Node definitions s are further used
    in network topologies and inventories.

1.1.1  list nd:network
  Description
    Describes a network.
    A network typically contains an inventory of nodes,
    topological information (augmented through
    network-topology model), as well as layering
    information.
  Leaves
    name: network-id, type: STRING, description: Identifies a network.
    name: server-provided, type: BOOLEAN, description: Indicates whether the information concerning this
    particular network is populated by the server
    (server-provided true, the general case for network
    information discovered from the server),
    or whether it is configured by a client
    (server-provided true, possible e.g. for
    service overlays managed through a controller).
  XPath Path
    /nd:network
  XPath Keyed Path
    /nd:network[nd:network-id='STRING']
  RW.REST URI Path
    /ietf-network:network/STRING
  JSON Sample
    [
      {
        "network-types": {
        },
        "network-id": "STRING",
        "server-provided": true,
        "supporting-network": [
          {
            "network-ref": "STRING"
          }, {
            ...
          }
        ],
        "node": [
          {
            "node-id": "STRING",
            "supporting-node": [ { ... }, { ... } ]
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Sample
    <nd:network xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network">
      <nd:network-id>STRING</nd:network-id>
      <nd:network-types/>
      <nd:server-provided>true</nd:server-provided>
      <nd:supporting-network>
        <nd:network-ref>STRING</nd:network-ref>
      </nd:supporting-network>
      <nd:node>
        <nd:node-id>STRING</nd:node-id>
        <nd:supporting-node>...</nd:supporting-node>
      </nd:node>
    </nd:network>

1.1.1.1  container nd:network-types
  Description
    Serves as an augmentation target.
    The network type is indicated through corresponding
    presence containers augmented into this container.
  XPath Path
    /nd:network/nd:network-types
  XPath Keyed Path
    /nd:network[nd:network-id='STRING']/nd:network-types
  RW.REST URI Path
    /ietf-network:network/STRING/network-types
  JSON Sample
    {
    }
  XML Sample
    <nd:network-types xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network"/>

1.1.1.2  list nd:supporting-network
  Description
    An underlay network, used to represent layered network
    topologies.
  Leaves
    name: network-ref, type: LEAFREF, description: References the underlay network.
  XPath Path
    /nd:network/nd:supporting-network
  XPath Keyed Path
    /nd:network[nd:network-id='STRING']/nd:supporting-network[nd:network-ref='STRING']
  RW.REST URI Path
    /ietf-network:network/STRING/supporting-network/STRING
  JSON Sample
    [
      {
        "network-ref": "STRING"
      }, {
        ...
      }
    ]
  XML Sample
    <nd:supporting-network xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network">
      <nd:network-ref>STRING</nd:network-ref>
    </nd:supporting-network>

1.1.1.3  list nd:node
  Description
    The inventory of nodes of this network.
  Leaves
    name: node-id, type: STRING, description: Identifies a node uniquely within the containing
    network.
  XPath Path
    /nd:network/nd:node
  XPath Keyed Path
    /nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']
  RW.REST URI Path
    /ietf-network:network/STRING/node/STRING
  JSON Sample
    [
      {
        "node-id": "STRING",
        "supporting-node": [
          {
            "network-ref": "STRING",
            "node-ref": "STRING"
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Sample
    <nd:node xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network">
      <nd:node-id>STRING</nd:node-id>
      <nd:supporting-node>
        <nd:network-ref>STRING</nd:network-ref>
        <nd:node-ref>STRING</nd:node-ref>
      </nd:supporting-node>
    </nd:node>

1.1.1.3.1  list nd:supporting-node
  Description
    Represents another node, in an underlay network, that
    this node is supported by.  Used to represent layering
    structure.
  Leaves
    name: network-ref, type: LEAFREF, description: References the underlay network that the
    underlay node is part of.
    name: node-ref, type: LEAFREF, description: References the underlay node itself.
  XPath Path
    /nd:network/nd:node/nd:supporting-node
  XPath Keyed Path
    /nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/nd:supporting-node[nd:network-ref='STRING'][nd:node-ref='STRING']
  RW.REST URI Path
    /ietf-network:network/STRING/node/STRING/supporting-node/STRING,STRING
  JSON Sample
    [
      {
        "network-ref": "STRING",
        "node-ref": "STRING"
      }, {
        ...
      }
    ]
  XML Sample
    <nd:supporting-node xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network">
      <nd:network-ref>STRING</nd:network-ref>
      <nd:node-ref>STRING</nd:node-ref>
    </nd:supporting-node>

