ietf-network - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwTopology_IetfNetwork_t_schema
Global Schema Pointer	rw_ypbc_RwTopology_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.
l2-network-attributes	CONTAINER	Containing L2 network attributes
rw-network-attributes	CONTAINER	Containing RW network attributes

JSON Sample

[
  {
    "network-types": {
      "ietf-l2-topology:l2-network": { ... }
    },
    "network-id": "STRING",
    "server-provided": true,
    "supporting-network": [
      {
        "network-ref": "STRING"
      }, {
        ...
      }
    ],
    "node": [
      {
        "node-id": "STRING",
        "supporting-node": [ { ... }, { ... } ],
        "ietf-network-topology:termination-point": [ { ... }, { ... } ],
        "ietf-l2-topology:l2-node-attributes": { ... },
        "rw-topology:rw-node-attributes": { ... }
      }, {
        ...
      }
    ],
    "ietf-network-topology:link": [
      {
        "source": { ... },
        "destination": { ... },
        "link-id": "STRING",
        "supporting-link": [ { ... }, { ... } ],
        "ietf-l2-topology:l2-link-attributes": { ... },
        "rw-topology:rw-link-attributes": { ... }
      }, {
        ...
      }
    ],
    "ietf-l2-topology:l2-network-attributes": {
      "name": "STRING",
      "flag": [ "IDENTITY_VALUE", ... ]
    },
    "rw-topology:rw-network-attributes": {
      "name": "STRING",
      "sdn-account-name": "STRING"
    }
  }, {
    ...
  }
]

XML Sample

<nd:network xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network">
  <nd:network-id>STRING</nd:network-id>
  <nd:network-types>
    <l2t:l2-network xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology"/>
  </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>
    <l2t:l2-node-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:l2-node-attributes>
    <rw-topology:rw-node-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">...</rw-topology:rw-node-attributes>
  </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>
    <l2t:l2-link-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:l2-link-attributes>
    <rw-topology:rw-link-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">...</rw-topology:rw-link-attributes>
  </lnk:link>
  <l2t:l2-network-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
    <l2t:name>STRING</l2t:name>
    <l2t:flag>IDENTITY_VALUE</l2t:flag>
    <l2t:flag>...</l2t:flag>
  </l2t:l2-network-attributes>
  <rw-topology:rw-network-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
    <rw-topology:name>STRING</rw-topology:name>
    <rw-topology:sdn-account-name>STRING</rw-topology:sdn-account-name>
  </rw-topology:rw-network-attributes>
</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

Fields

Name	Type	Description
l2-network	CONTAINER	The presence of the container node indicates L2 Topology

JSON Sample

{
  "ietf-l2-topology:l2-network": {
  }
}

XML Sample

<nd:network-types xmlns:nd="urn:ietf:params:xml:ns:yang:ietf-network">
  <l2t:l2-network xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology"/>
</nd:network-types>

l2t:l2-network

The presence of the container node indicates L2 Topology

Key Identifiers:

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

JSON Sample

{
}

XML Sample

<l2t:l2-network xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology"/>

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.
l2-node-attributes	CONTAINER	Containing L2 node attributes
rw-node-attributes	CONTAINER	Containing RW node attributes

JSON Sample

[
  {
    "node-id": "STRING",
    "supporting-node": [
      {
        "network-ref": "STRING",
        "node-ref": "STRING"
      }, {
        ...
      }
    ],
    "ietf-network-topology:termination-point": [
      {
        "tp-id": "STRING",
        "supporting-termination-point": [ { ... }, { ... } ],
        "ietf-l2-topology:l2-termination-point-attributes": { ... },
        "rw-topology:rw-termination-point-attributes": { ... }
      }, {
        ...
      }
    ],
    "ietf-l2-topology:l2-node-attributes": {
      "name": "STRING",
      "description": "STRING",
      "management-address": [ "UNION_VALUE", ... ],
      "management-vid": 0,
      "nick-name": [ 0, ... ],
      "flag": [ "IDENTITY_VALUE", ... ]
    },
    "rw-topology:rw-node-attributes": {
      "name": "STRING",
      "ovs-bridge-name": "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>
  <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>
    <l2t:l2-termination-point-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:l2-termination-point-attributes>
    <rw-topology:rw-termination-point-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">...</rw-topology:rw-termination-point-attributes>
  </lnk:termination-point>
  <l2t:l2-node-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
    <l2t:name>STRING</l2t:name>
    <l2t:description>STRING</l2t:description>
    <l2t:management-address>UNION_VALUE</l2t:management-address>
    <l2t:management-address>...</l2t:management-address>
    <l2t:management-vid>0</l2t:management-vid>
    <l2t:nick-name>0</l2t:nick-name>
    <l2t:nick-name>...</l2t:nick-name>
    <l2t:flag>IDENTITY_VALUE</l2t:flag>
    <l2t:flag>...</l2t:flag>
  </l2t:l2-node-attributes>
  <rw-topology:rw-node-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
    <rw-topology:name>STRING</rw-topology:name>
    <rw-topology:ovs-bridge-name>STRING</rw-topology:ovs-bridge-name>
  </rw-topology:rw-node-attributes>
</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.
l2-termination-point-attributes	CONTAINER	Containing L2 TP attributes
rw-termination-point-attributes	CONTAINER	Containing RW TP attributes

JSON Sample

[
  {
    "tp-id": "STRING",
    "supporting-termination-point": [
      {
        "network-ref": "STRING",
        "node-ref": "STRING",
        "tp-ref": "STRING"
      }, {
        ...
      }
    ],
    "ietf-l2-topology:l2-termination-point-attributes": {
      "description": "STRING",
      "maximum-frame-size": 0,
      "mac-address": "STRING",
      "eth-encapsulation": "ethernet",
      "port-vlan-id": 0,
      "vlan-id-name": [ { ... }, { ... } ],
      "encapsulation": "eth-encapsulation-type",
      "tp-state": "in-use"
    },
    "rw-topology:rw-termination-point-attributes": {
      "description": "STRING",
      "ip-attributes": { ... }
    }
  }, {
    ...
  }
]

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>STRING</lnk:network-ref>
    <lnk:node-ref>STRING</lnk:node-ref>
    <lnk:tp-ref>STRING</lnk:tp-ref>
  </lnk:supporting-termination-point>
  <l2t:l2-termination-point-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
    <l2t:description>STRING</l2t:description>
    <l2t:maximum-frame-size>0</l2t:maximum-frame-size>
    <l2t:mac-address>STRING</l2t:mac-address>
    <l2t:eth-encapsulation>ethernet</l2t:eth-encapsulation>
    <l2t:port-vlan-id>0</l2t:port-vlan-id>
    <l2t:vlan-id-name>...</l2t:vlan-id-name>
    <l2t:encapsulation>eth-encapsulation-type</l2t:encapsulation>
    <l2t:tp-state>in-use</l2t:tp-state>
  </l2t:l2-termination-point-attributes>
  <rw-topology:rw-termination-point-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
    <rw-topology:description>STRING</rw-topology:description>
    <rw-topology:ip-attributes>...</rw-topology:ip-attributes>
  </rw-topology:rw-termination-point-attributes>
</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='STRING'][lnk:node-ref='STRING'][lnk:tp-ref='STRING']

RW.REST URI Path

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

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": "STRING",
    "node-ref": "STRING",
    "tp-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

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

l2t:l2-termination-point-attributes

Containing L2 TP attributes

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point/l2t:l2-termination-point-attributes

XPath Keyed Path

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

RW.REST URI Path

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

Fields

Name	Type	Description
description	STRING	Port description
maximum-frame-size	UINT32	Maximum frame size
mac-address	STRING	Interface MAC address
eth-encapsulation	IDREF	Encapsulation type of this ternimation point.
port-vlan-id	UINT16	Port VLAN ID
vlan-id-name	LIST	Interface configured VLANs
encapsulation	IDREF	Encapsulation type of this termination point.
tp-state	ENUM	State of the termination point

JSON Sample

{
  "description": "STRING",
  "maximum-frame-size": 0,
  "mac-address": "STRING",
  "eth-encapsulation": "ethernet",
  "port-vlan-id": 0,
  "vlan-id-name": [
    {
      "vlan-id": 0,
      "vlan-name": "STRING"
    }, {
      ...
    }
  ],
  "encapsulation": "eth-encapsulation-type",
  "tp-state": "in-use"
}

XML Sample

<l2t:l2-termination-point-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
  <l2t:description>STRING</l2t:description>
  <l2t:maximum-frame-size>0</l2t:maximum-frame-size>
  <l2t:mac-address>STRING</l2t:mac-address>
  <l2t:eth-encapsulation>ethernet</l2t:eth-encapsulation>
  <l2t:port-vlan-id>0</l2t:port-vlan-id>
  <l2t:vlan-id-name>
    <l2t:vlan-id>0</l2t:vlan-id>
    <l2t:vlan-name>STRING</l2t:vlan-name>
  </l2t:vlan-id-name>
  <l2t:encapsulation>eth-encapsulation-type</l2t:encapsulation>
  <l2t:tp-state>in-use</l2t:tp-state>
</l2t:l2-termination-point-attributes>

l2t:vlan-id-name

Interface configured VLANs

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point/l2t:l2-termination-point-attributes/l2t:vlan-id-name

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/lnk:termination-point[lnk:tp-id='STRING']/l2t:l2-termination-point-attributes/l2t:vlan-id-name[l2t:vlan-id='0']

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-network-topology:termination-point/STRING/ietf-l2-topology:l2-termination-point-attributes/vlan-id-name/0

Fields

Name	Type	Description
vlan-id	UINT16	VLAN ID
vlan-name	STRING	VLAN Name

JSON Sample

[
  {
    "vlan-id": 0,
    "vlan-name": "STRING"
  }, {
    ...
  }
]

XML Sample

<l2t:vlan-id-name xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
  <l2t:vlan-id>0</l2t:vlan-id>
  <l2t:vlan-name>STRING</l2t:vlan-name>
</l2t:vlan-id-name>

rw-topology:rw-termination-point-attributes

Containing RW TP attributes

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point/rw-topology:rw-termination-point-attributes

XPath Keyed Path

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

RW.REST URI Path

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

Fields

Name	Type	Description
description	STRING	Port description
ip-attributes	CONTAINER	L2 termination points containing IP addresses

JSON Sample

{
  "description": "STRING",
  "ip-attributes": {
    "ip-addresses": [ { ... }, { ... } ]
  }
}

XML Sample

<rw-topology:rw-termination-point-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
  <rw-topology:description>STRING</rw-topology:description>
  <rw-topology:ip-attributes>
    <rw-topology:ip-addresses>...</rw-topology:ip-addresses>
  </rw-topology:ip-attributes>
</rw-topology:rw-termination-point-attributes>

rw-topology:ip-attributes

L2 termination points containing IP addresses

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point/rw-topology:rw-termination-point-attributes/rw-topology:ip-attributes

XPath Keyed Path

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

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-network-topology:termination-point/STRING/rw-topology:rw-termination-point-attributes/ip-attributes

Fields

Name	Type	Description
ip-addresses	LIST

JSON Sample

{
  "ip-addresses": [
    {
      "ip": "UNION_VALUE"
    }, {
      ...
    }
  ]
}

XML Sample

<rw-topology:ip-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
  <rw-topology:ip-addresses>
    <rw-topology:ip>UNION_VALUE</rw-topology:ip>
  </rw-topology:ip-addresses>
</rw-topology:ip-attributes>

rw-topology:ip-addresses

Key Identifiers:

XPath Path

/nd:network/nd:node/lnk:termination-point/rw-topology:rw-termination-point-attributes/rw-topology:ip-attributes/rw-topology:ip-addresses

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/lnk:termination-point[lnk:tp-id='STRING']/rw-topology:rw-termination-point-attributes/rw-topology:ip-attributes/rw-topology:ip-addresses[rw-topology:ip='UNION_VALUE']

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-network-topology:termination-point/STRING/rw-topology:rw-termination-point-attributes/ip-attributes/ip-addresses/UNION_VALUE

Fields

Name	Type	Description
ip	UNION	IPv4 or IPv6 address

JSON Sample

[
  {
    "ip": "UNION_VALUE"
  }, {
    ...
  }
]

XML Sample

<rw-topology:ip-addresses xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
  <rw-topology:ip>UNION_VALUE</rw-topology:ip>
</rw-topology:ip-addresses>

l2t:l2-node-attributes

Containing L2 node attributes

Key Identifiers:

XPath Path

/nd:network/nd:node/l2t:l2-node-attributes

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/l2t:l2-node-attributes

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-l2-topology:l2-node-attributes

Fields

Name	Type	Description
name	STRING	Node name
description	STRING	Node description
management-address	LEAF_LIST	System management address
management-vid	UINT16	System management VID
nick-name	LEAF_LIST	Nickname of the RBridge
flag	LEAF_LIST	Node operational flags

JSON Sample

{
  "name": "STRING",
  "description": "STRING",
  "management-address": [ "UNION_VALUE", ... ],
  "management-vid": 0,
  "nick-name": [ 0, ... ],
  "flag": [ "IDENTITY_VALUE", ... ]
}

XML Sample

<l2t:l2-node-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
  <l2t:name>STRING</l2t:name>
  <l2t:description>STRING</l2t:description>
  <l2t:management-address>UNION_VALUE</l2t:management-address>
  <l2t:management-address>...</l2t:management-address>
  <l2t:management-vid>0</l2t:management-vid>
  <l2t:nick-name>0</l2t:nick-name>
  <l2t:nick-name>...</l2t:nick-name>
  <l2t:flag>IDENTITY_VALUE</l2t:flag>
  <l2t:flag>...</l2t:flag>
</l2t:l2-node-attributes>

l2t:management-address

System management address

Key Identifiers:

XPath Path

/nd:network/nd:node/l2t:l2-node-attributes/l2t:management-address

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/l2t:l2-node-attributes/l2t:management-address

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-l2-topology:l2-node-attributes/management-address

JSON Sample

[ "UNION_VALUE", ... ]

XML Sample

<l2t:management-address xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">UNION_VALUE</l2t:management-address>
<l2t:management-address xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:management-address>

l2t:nick-name

Nickname of the RBridge

Key Identifiers:

XPath Path

/nd:network/nd:node/l2t:l2-node-attributes/l2t:nick-name

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/l2t:l2-node-attributes/l2t:nick-name

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-l2-topology:l2-node-attributes/nick-name

JSON Sample

[ 0, ... ]

XML Sample

<l2t:nick-name xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">0</l2t:nick-name>
<l2t:nick-name xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:nick-name>

l2t:flag

Node operational flags

Key Identifiers:

XPath Path

/nd:network/nd:node/l2t:l2-node-attributes/l2t:flag

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/l2t:l2-node-attributes/l2t:flag

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/ietf-l2-topology:l2-node-attributes/flag

JSON Sample

[ "IDENTITY_VALUE", ... ]

XML Sample

<l2t:flag xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">IDENTITY_VALUE</l2t:flag>
<l2t:flag xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:flag>

rw-topology:rw-node-attributes

Containing RW node attributes

Key Identifiers:

XPath Path

/nd:network/nd:node/rw-topology:rw-node-attributes

XPath Keyed Path

/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/rw-topology:rw-node-attributes

RW.REST URI Path

/ietf-network:network/STRING/node/STRING/rw-topology:rw-node-attributes

Fields

Name	Type	Description
name	STRING	Node name
ovs-bridge-name	STRING	Name of OVS bridge

JSON Sample

{
  "name": "STRING",
  "ovs-bridge-name": "STRING"
}

XML Sample

<rw-topology:rw-node-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
  <rw-topology:name>STRING</rw-topology:name>
  <rw-topology:ovs-bridge-name>STRING</rw-topology:ovs-bridge-name>
</rw-topology:rw-node-attributes>

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.
l2-link-attributes	CONTAINER	Containing L2 link attributes
rw-link-attributes	CONTAINER	Containing RW link attributes

JSON Sample

[
  {
    "source": {
      "source-node": "STRING",
      "source-tp": "STRING"
    },
    "destination": {
      "dest-node": "STRING",
      "dest-tp": "STRING"
    },
    "link-id": "STRING",
    "supporting-link": [
      {
        "network-ref": "STRING",
        "link-ref": "STRING"
      }, {
        ...
      }
    ],
    "ietf-l2-topology:l2-link-attributes": {
      "name": "STRING",
      "flag": [ "IDENTITY_VALUE", ... ],
      "rate": 0.0,
      "delay": 0,
      "srlg": [ 0, ... ]
    },
    "rw-topology:rw-link-attributes": {
      "name": "STRING"
    }
  }, {
    ...
  }
]

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>STRING</lnk:source-node>
    <lnk:source-tp>STRING</lnk:source-tp>
  </lnk:source>
  <lnk:destination>
    <lnk:dest-node>STRING</lnk:dest-node>
    <lnk:dest-tp>STRING</lnk:dest-tp>
  </lnk:destination>
  <lnk:supporting-link>
    <lnk:network-ref>STRING</lnk:network-ref>
    <lnk:link-ref>STRING</lnk:link-ref>
  </lnk:supporting-link>
  <l2t:l2-link-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
    <l2t:name>STRING</l2t:name>
    <l2t:flag>IDENTITY_VALUE</l2t:flag>
    <l2t:flag>...</l2t:flag>
    <l2t:rate>0.0</l2t:rate>
    <l2t:delay>0</l2t:delay>
    <l2t:srlg>0</l2t:srlg>
    <l2t:srlg>...</l2t:srlg>
  </l2t:l2-link-attributes>
  <rw-topology:rw-link-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
    <rw-topology:name>STRING</rw-topology:name>
  </rw-topology:rw-link-attributes>
</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": "STRING",
  "source-tp": "STRING"
}

XML Sample

<lnk:source xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:source-node>STRING</lnk:source-node>
  <lnk:source-tp>STRING</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": "STRING",
  "dest-tp": "STRING"
}

XML Sample

<lnk:destination xmlns:lnk="urn:ietf:params:xml:ns:yang:ietf-network-topology">
  <lnk:dest-node>STRING</lnk:dest-node>
  <lnk:dest-tp>STRING</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='STRING'][lnk:link-ref='STRING']

RW.REST URI Path

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

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": "STRING",
    "link-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

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

l2t:l2-link-attributes

Containing L2 link attributes

Key Identifiers:

XPath Path

/nd:network/lnk:link/l2t:l2-link-attributes

XPath Keyed Path

/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/l2t:l2-link-attributes

RW.REST URI Path

/ietf-network:network/STRING/ietf-network-topology:link/STRING/ietf-l2-topology:l2-link-attributes

Fields

Name	Type	Description
name	STRING	Link name
flag	LEAF_LIST	Link flags
rate	DECIMAL64	Link rate
delay	UINT32	Link delay in microseconds
srlg	LEAF_LIST	List of Shared Risk Link Groups this link belongs to.

JSON Sample

{
  "name": "STRING",
  "flag": [ "IDENTITY_VALUE", ... ],
  "rate": 0.0,
  "delay": 0,
  "srlg": [ 0, ... ]
}

XML Sample

<l2t:l2-link-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
  <l2t:name>STRING</l2t:name>
  <l2t:flag>IDENTITY_VALUE</l2t:flag>
  <l2t:flag>...</l2t:flag>
  <l2t:rate>0.0</l2t:rate>
  <l2t:delay>0</l2t:delay>
  <l2t:srlg>0</l2t:srlg>
  <l2t:srlg>...</l2t:srlg>
</l2t:l2-link-attributes>

l2t:flag

Link flags

Key Identifiers:

XPath Path

/nd:network/lnk:link/l2t:l2-link-attributes/l2t:flag

XPath Keyed Path

/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/l2t:l2-link-attributes/l2t:flag

RW.REST URI Path

/ietf-network:network/STRING/ietf-network-topology:link/STRING/ietf-l2-topology:l2-link-attributes/flag

JSON Sample

[ "IDENTITY_VALUE", ... ]

XML Sample

<l2t:flag xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">IDENTITY_VALUE</l2t:flag>
<l2t:flag xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:flag>

l2t:srlg

List of Shared Risk Link Groups this link belongs to.

Key Identifiers:

XPath Path

/nd:network/lnk:link/l2t:l2-link-attributes/l2t:srlg

XPath Keyed Path

/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/l2t:l2-link-attributes/l2t:srlg

RW.REST URI Path

/ietf-network:network/STRING/ietf-network-topology:link/STRING/ietf-l2-topology:l2-link-attributes/srlg

JSON Sample

[ 0, ... ]

XML Sample

<l2t:srlg xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">0</l2t:srlg>
<l2t:srlg xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:srlg>

rw-topology:rw-link-attributes

Containing RW link attributes

Key Identifiers:

XPath Path

/nd:network/lnk:link/rw-topology:rw-link-attributes

XPath Keyed Path

/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/rw-topology:rw-link-attributes

RW.REST URI Path

/ietf-network:network/STRING/ietf-network-topology:link/STRING/rw-topology:rw-link-attributes

Fields

Name	Type	Description
name	STRING	Link name

JSON Sample

{
  "name": "STRING"
}

XML Sample

<rw-topology:rw-link-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
  <rw-topology:name>STRING</rw-topology:name>
</rw-topology:rw-link-attributes>

l2t:l2-network-attributes

Containing L2 network attributes

Key Identifiers:

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

Fields

Name	Type	Description
name	STRING	Name of the L2 network
flag	LEAF_LIST	L2 network flags

JSON Sample

{
  "name": "STRING",
  "flag": [ "IDENTITY_VALUE", ... ]
}

XML Sample

<l2t:l2-network-attributes xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">
  <l2t:name>STRING</l2t:name>
  <l2t:flag>IDENTITY_VALUE</l2t:flag>
  <l2t:flag>...</l2t:flag>
</l2t:l2-network-attributes>

l2t:flag

L2 network flags

Key Identifiers:

XPath Path	/nd:network/l2t:l2-network-attributes/l2t:flag
XPath Keyed Path	/nd:network[nd:network-id='STRING']/l2t:l2-network-attributes/l2t:flag
RW.REST URI Path	/ietf-network:network/STRING/ietf-l2-topology:l2-network-attributes/flag

JSON Sample

[ "IDENTITY_VALUE", ... ]

XML Sample

<l2t:flag xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">IDENTITY_VALUE</l2t:flag>
<l2t:flag xmlns:l2t="urn:ietf:params:xml:ns:yang:ietf-l2-topology">...</l2t:flag>

rw-topology:rw-network-attributes

Containing RW network attributes

Key Identifiers:

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

Fields

Name	Type	Description
name	STRING	Name of the RW Topology network
sdn-account-name	STRING	Name of the SDN account from which topology is got

JSON Sample

{
  "name": "STRING",
  "sdn-account-name": "STRING"
}

XML Sample

<rw-topology:rw-network-attributes xmlns:rw-topology="http://riftio.com/ns/riftware-1.0/rw-topology">
  <rw-topology:name>STRING</rw-topology:name>
  <rw-topology:sdn-account-name>STRING</rw-topology:sdn-account-name>
</rw-topology:rw-network-attributes>

ietf-network-topology - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwTopology_IetfNetworkTopology_t_schema
Global Schema Pointer	rw_ypbc_RwTopology_IetfNetworkTopology_g_schema

rw-topology - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwTopology_RwTopology_t_schema
Global Schema Pointer	rw_ypbc_RwTopology_RwTopology_g_schema