ietf-network - User documentation

Schema Globals

Global Schema Type	rw_ypbc_IetfNetwork_IetfNetwork_t_schema
Global Schema Pointer	rw_ypbc_IetfNetwork_IetfNetwork_g_schema

ietf-network data

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.

nd:network

Describes a network. A network typically contains an inventory of nodes, topological information (augmented through network-topology model), as well as layering information.

Key Identifiers:

XPath Path	/nd:network
XPath Keyed Path	/nd:network[nd:network-id='STRING']
RW.REST URI Path	/ietf-network:network/STRING

Fields

Name	Type	Description
network-types	CONTAINER	Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container.
network-id	STRING	Identifies a network.
server-provided	BOOLEAN	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).
supporting-network	LIST	An underlay network, used to represent layered network topologies.
node	LIST	The inventory of nodes of this network.

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>

nd:network-types

Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container.

Key Identifiers:

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"/>

nd:supporting-network

An underlay network, used to represent layered network topologies.

Key Identifiers:

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

Fields

Name	Type	Description
network-ref	LEAFREF	References the underlay network.

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>

nd:node

The inventory of nodes of this network.

Key Identifiers:

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

Fields

Name	Type	Description
node-id	STRING	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.

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>

nd:supporting-node

Represents another node, in an underlay network, that this node is supported by. Used to represent layering structure.

Key Identifiers:

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

Fields

Name	Type	Description
network-ref	LEAFREF	References the underlay network that the underlay node is part of.
node-ref	LEAFREF	References the underlay node itself.

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>