ietf-network - Programmers API Reference
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 |
| RW Keyspec XPath Path | D,/nd:network |
| RW Keyspec XPath Keyed Path | D,/nd:network[nd:network-id='STRING'] |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network |
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. |
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 |
| RW Keyspec XPath Path | D,/nd:network/nd:network-types |
| RW Keyspec XPath Keyed Path | D,/nd:network[nd:network-id='STRING']/nd:network-types |
| Protobuf Type | .ietf_network.YangData.IetfNetwork.Network.NetworkTypes |
| Python Proto-GI Type | IetfNetworkYang.YangData_IetfNetwork_Network_NetworkTypes |
| C Protobuf-C Struct Type | IetfNetwork__YangData__IetfNetwork__Network__NetworkTypes |
| C RWPB Identifiers | IetfNetwork_IetfNetwork_data_Network_NetworkTypes |
| YPBC Base Identifier | rw_ypbc_IetfNetwork_IetfNetwork_data_Network_NetworkTypes |
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 |
| RW Keyspec XPath Path | D,/nd:network/nd:supporting-network |
| RW Keyspec XPath Keyed Path | D,/nd:network[nd:network-id='STRING']/nd:supporting-network[nd:network-ref='STRING'] |
| Protobuf Type | .ietf_network.YangData.IetfNetwork.Network.SupportingNetwork |
| Python Proto-GI Type | IetfNetworkYang.YangData_IetfNetwork_Network_SupportingNetwork |
| C Protobuf-C Struct Type | IetfNetwork__YangData__IetfNetwork__Network__SupportingNetwork |
| C RWPB Identifiers | IetfNetwork_IetfNetwork_data_Network_SupportingNetwork |
| YPBC Base Identifier | rw_ypbc_IetfNetwork_IetfNetwork_data_Network_SupportingNetwork |
Fields
| Name | Type | Description |
|---|
| network-ref | LEAFREF | References the underlay 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 |
| RW Keyspec XPath Path | D,/nd:network/nd:node |
| RW Keyspec XPath Keyed Path | D,/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING'] |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Node |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Node |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Node |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Node |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Node |
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. |
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 |
| RW Keyspec XPath Path | D,/nd:network/nd:node/nd:supporting-node |
| RW Keyspec XPath Keyed Path | D,/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/nd:supporting-node[nd:network-ref='STRING'][nd:node-ref='STRING'] |
| Protobuf Type | .ietf_network.YangData.IetfNetwork.Network.Node.SupportingNode |
| Python Proto-GI Type | IetfNetworkYang.YangData_IetfNetwork_Network_Node_SupportingNode |
| C Protobuf-C Struct Type | IetfNetwork__YangData__IetfNetwork__Network__Node__SupportingNode |
| C RWPB Identifiers | IetfNetwork_IetfNetwork_data_Network_Node_SupportingNode |
| YPBC Base Identifier | rw_ypbc_IetfNetwork_IetfNetwork_data_Network_Node_SupportingNode |
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. |
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 |
| RW Keyspec XPath Path | C,/nd:network/nd:node/lnk:termination-point |
| RW Keyspec XPath Keyed Path | C,/nd:network[nd:network-id='STRING']/nd:node[nd:node-id='STRING']/lnk:termination-point[lnk:tp-id='STRING'] |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Node.TerminationPoint |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Node_TerminationPoint |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Node__TerminationPoint |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Node_TerminationPoint |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Node_TerminationPoint |
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. |
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 |
| RW Keyspec XPath Path | C,/nd:network/nd:node/lnk:termination-point/lnk:supporting-termination-point |
| RW Keyspec XPath Keyed Path | C,/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'] |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Node.TerminationPoint.SupportingTerminationPoint |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Node_TerminationPoint_SupportingTerminationPoint |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Node__TerminationPoint__SupportingTerminationPoint |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Node_TerminationPoint_SupportingTerminationPoint |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Node_TerminationPoint_SupportingTerminationPoint |
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 |
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 |
| RW Keyspec XPath Path | C,/nd:network/lnk:link |
| RW Keyspec XPath Keyed Path | C,/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING'] |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Link |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Link |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Link |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Link |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Link |
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. |
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 |
| RW Keyspec XPath Path | C,/nd:network/lnk:link/lnk:source |
| RW Keyspec XPath Keyed Path | C,/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/lnk:source |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Link.Source |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Link_Source |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Link__Source |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Link_Source |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Link_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. |
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 |
| RW Keyspec XPath Path | C,/nd:network/lnk:link/lnk:destination |
| RW Keyspec XPath Keyed Path | C,/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/lnk:destination |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Link.Destination |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Link_Destination |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Link__Destination |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Link_Destination |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Link_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. |
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 |
| RW Keyspec XPath Path | C,/nd:network/lnk:link/lnk:supporting-link |
| RW Keyspec XPath Keyed Path | C,/nd:network[nd:network-id='STRING']/lnk:link[lnk:link-id='STRING']/lnk:supporting-link[lnk:network-ref='STRING'][lnk:link-ref='STRING'] |
| Protobuf Type | .ietf_network_topology.YangData.IetfNetwork.Network.Link.SupportingLink |
| Python Proto-GI Type | IetfNetworkTopologyYang.YangData_IetfNetwork_Network_Link_SupportingLink |
| C Protobuf-C Struct Type | IetfNetworkTopology__YangData__IetfNetwork__Network__Link__SupportingLink |
| C RWPB Identifiers | IetfNetworkTopology_IetfNetwork_data_Network_Link_SupportingLink |
| YPBC Base Identifier | rw_ypbc_IetfNetworkTopology_IetfNetwork_data_Network_Link_SupportingLink |
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. |
ietf-network-topology - Programmers API Reference
Schema Globals
| Global Schema Type |
rw_ypbc_IetfNetworkTopology_IetfNetworkTopology_t_schema |
| Global Schema Pointer |
rw_ypbc_IetfNetworkTopology_IetfNetworkTopology_g_schema |