ietf-network - User documentation

Schema Globals

Global Schema Type	rw_ypbc_IetfNetworkTopology_IetfNetwork_t_schema
Global Schema Pointer	rw_ypbc_IetfNetworkTopology_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.
link	LIST	A Network Link connects a by Local (Source) node and a Remote (Destination) Network Nodes via a set of the nodes' termination points. As it is possible to have several links between the same source and destination nodes, and as a link could potentially be re-homed between termination points, to ensure that we would always know to distinguish between links, every link is identified by a dedicated link identifier. Note that a link models a point-to-point link, not a multipoint link. Layering dependencies on links in underlay topologies are not represented as the layering information of nodes and of termination points is sufficient.

JSON Sample

[
  {
    "network-types": {
    },
    "network-id": "STRING",
    "server-provided": true,
    "supporting-network": [
      {
        "network-ref": "STRING"
      }, {
        ...
      }
    ],
    "node": [
      {
        "node-id": "STRING",
        "supporting-node": [ { ... }, { ... } ],
        "ietf-network-topology:termination-point": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "ietf-network-topology:link": [
      {
        "source": { ... },
        "destination": { ... },
        "link-id": "STRING",
        "supporting-link": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

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>
    <lnk:termination-point xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">...</lnk:termination-point>
  </nd:node>
  <lnk:link xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
    <lnk:link-id>STRING</lnk:link-id>
    <lnk:source>...</lnk:source>
    <lnk:destination>...</lnk:destination>
    <lnk:supporting-link>...</lnk:supporting-link>
  </lnk:link>
</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.
termination-point	LIST	A termination point can terminate a link. Depending on the type of topology, a termination point could, for example, refer to a port or an interface.

JSON Sample

[
  {
    "node-id": "STRING",
    "supporting-node": [
      {
        "network-ref": "STRING",
        "node-ref": "STRING"
      }, {
        ...
      }
    ],
    "ietf-network-topology:termination-point": [
      {
        "tp-id": "STRING",
        "supporting-termination-point": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

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>
  <lnk:termination-point xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
    <lnk:tp-id>STRING</lnk:tp-id>
    <lnk:supporting-termination-point>...</lnk:supporting-termination-point>
  </lnk:termination-point>
</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>

lnk:termination-point

A termination point can terminate a link. Depending on the type of topology, a termination point could, for example, refer to a port or an interface.

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/lnk:termination-point[lnk:tp-id='STRING']

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-network-topology:termination-point/STRING

Fields

Name	Type	Description
tp-id	STRING	Termination point identifier.
supporting-termination-point	LIST	The leaf list identifies any termination points that the termination point is dependent on, or maps onto. Those termination points will themselves be contained in a supporting node. This dependency information can be inferred from the dependencies between links. For this reason, this item is not separately configurable. Hence no corresponding constraint needs to be articulated. The corresponding information is simply provided by the implementing system.

JSON Sample

[
  {
    "tp-id": "STRING",
    "supporting-termination-point": [
      {
        "network-ref": "LEAFREF_VALUE",
        "node-ref": "LEAFREF_VALUE",
        "tp-ref": "LEAFREF_VALUE"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<lnk:termination-point xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:tp-id>STRING</lnk:tp-id>
  <lnk:supporting-termination-point>
    <lnk:network-ref>LEAFREF_VALUE</lnk:network-ref>
    <lnk:node-ref>LEAFREF_VALUE</lnk:node-ref>
    <lnk:tp-ref>LEAFREF_VALUE</lnk:tp-ref>
  </lnk:supporting-termination-point>
</lnk:termination-point>

lnk:supporting-termination-point

The leaf list identifies any termination points that the termination point is dependent on, or maps onto. Those termination points will themselves be contained in a supporting node. This dependency information can be inferred from the dependencies between links. For this reason, this item is not separately configurable. Hence no corresponding constraint needs to be articulated. The corresponding information is simply provided by the implementing system.

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point/lnk:supporting-termination-point

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/lnk:termination-point[lnk:tp-id='STRING']/lnk:supporting-termination-point[lnk:network-ref='LEAFREF_VALUE'][lnk:node-ref='LEAFREF_VALUE'][lnk:tp-ref='LEAFREF_VALUE']

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-network-topology:termination-point/STRING/supporting-termination-point/LEAFREF_VALUE,LEAFREF_VALUE,LEAFREF_VALUE

Fields

Name	Type	Description
network-ref	LEAFREF	This leaf identifies in which topology the supporting termination point is present.
node-ref	LEAFREF	This leaf identifies in which node the supporting termination point is present.
tp-ref	LEAFREF	Reference to the underlay node, must be in a different topology

JSON Sample

[
  {
    "network-ref": "LEAFREF_VALUE",
    "node-ref": "LEAFREF_VALUE",
    "tp-ref": "LEAFREF_VALUE"
  }, {
    ...
  }
]

XML Sample

<lnk:supporting-termination-point xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:network-ref>LEAFREF_VALUE</lnk:network-ref>
  <lnk:node-ref>LEAFREF_VALUE</lnk:node-ref>
  <lnk:tp-ref>LEAFREF_VALUE</lnk:tp-ref>
</lnk:supporting-termination-point>

lnk:link

A Network Link connects a by Local (Source) node and a Remote (Destination) Network Nodes via a set of the nodes' termination points. As it is possible to have several links between the same source and destination nodes, and as a link could potentially be re-homed between termination points, to ensure that we would always know to distinguish between links, every link is identified by a dedicated link identifier. Note that a link models a point-to-point link, not a multipoint link. Layering dependencies on links in underlay topologies are not represented as the layering information of nodes and of termination points is sufficient.

Key Identifiers:

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

Fields

Name	Type	Description
source	CONTAINER	This container holds the logical source of a particular link.
destination	CONTAINER	This container holds the logical destination of a particular link.
link-id	STRING	The identifier of a link in the topology. A link is specific to a topology to which it belongs.
supporting-link	LIST	Identifies the link, or links, that this link is dependent on.

JSON Sample

[
  {
    "source": {
      "source-node": "LEAFREF_VALUE",
      "source-tp": "LEAFREF_VALUE"
    },
    "destination": {
      "dest-node": "LEAFREF_VALUE",
      "dest-tp": "LEAFREF_VALUE"
    },
    "link-id": "STRING",
    "supporting-link": [
      {
        "network-ref": "LEAFREF_VALUE",
        "link-ref": "LEAFREF_VALUE"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<lnk:link xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:link-id>STRING</lnk:link-id>
  <lnk:source>
    <lnk:source-node>LEAFREF_VALUE</lnk:source-node>
    <lnk:source-tp>LEAFREF_VALUE</lnk:source-tp>
  </lnk:source>
  <lnk:destination>
    <lnk:dest-node>LEAFREF_VALUE</lnk:dest-node>
    <lnk:dest-tp>LEAFREF_VALUE</lnk:dest-tp>
  </lnk:destination>
  <lnk:supporting-link>
    <lnk:network-ref>LEAFREF_VALUE</lnk:network-ref>
    <lnk:link-ref>LEAFREF_VALUE</lnk:link-ref>
  </lnk:supporting-link>
</lnk:link>

lnk:source

This container holds the logical source of a particular link.

Key Identifiers:

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

Fields

Name	Type	Description
source-node	LEAFREF	Source node identifier, must be in same topology.
source-tp	LEAFREF	Termination point within source node that terminates the link.

JSON Sample

{
  "source-node": "LEAFREF_VALUE",
  "source-tp": "LEAFREF_VALUE"
}

XML Sample

<lnk:source xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:source-node>LEAFREF_VALUE</lnk:source-node>
  <lnk:source-tp>LEAFREF_VALUE</lnk:source-tp>
</lnk:source>

lnk:destination

This container holds the logical destination of a particular link.

Key Identifiers:

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

Fields

Name	Type	Description
dest-node	LEAFREF	Destination node identifier, must be in the same network.
dest-tp	LEAFREF	Termination point within destination node that terminates the link.

JSON Sample

{
  "dest-node": "LEAFREF_VALUE",
  "dest-tp": "LEAFREF_VALUE"
}

XML Sample

<lnk:destination xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:dest-node>LEAFREF_VALUE</lnk:dest-node>
  <lnk:dest-tp>LEAFREF_VALUE</lnk:dest-tp>
</lnk:destination>

lnk:supporting-link

Identifies the link, or links, that this link is dependent on.

Key Identifiers:

XPath Path

/nd:network/lnk:link/lnk:supporting-link

XPath Keyed Path

/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/lnk:supporting-link[lnk:network-ref='LEAFREF_VALUE'][lnk:link-ref='LEAFREF_VALUE']

RW.REST URI Path

/ietf-network:network/STRING/ietf-network-topology:link/STRING/supporting-link/LEAFREF_VALUE,LEAFREF_VALUE

Fields

Name	Type	Description
network-ref	LEAFREF	This leaf identifies in which underlay topology supporting link is present.
link-ref	LEAFREF	This leaf identifies a link which is a part of this link's underlay. Reference loops, in which a link identifies itself as its underlay, either directly or transitively, are not allowed.

JSON Sample

[
  {
    "network-ref": "LEAFREF_VALUE",
    "link-ref": "LEAFREF_VALUE"
  }, {
    ...
  }
]

XML Sample

<lnk:supporting-link xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:network-ref>LEAFREF_VALUE</lnk:network-ref>
  <lnk:link-ref>LEAFREF_VALUE</lnk:link-ref>
</lnk:supporting-link>

ietf-network-topology - User documentation

Schema Globals

Global Schema Type	rw_ypbc_IetfNetworkTopology_IetfNetworkTopology_t_schema
Global Schema Pointer	rw_ypbc_IetfNetworkTopology_IetfNetworkTopology_g_schema