ietf-network - Programmers API Reference

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
RW Keyspec XPath Path
D,/nd:network
RW Keyspec XPath Keyed Path
D,/nd:network[nd:network-id='STRING']
Protobuf Type
.ietf_network.YangData.IetfNetwork.Network
Python Proto-GI Type
IetfNetworkYang.YangData_IetfNetwork_Network
C Protobuf-C Struct Type
IetfNetwork__YangData__IetfNetwork__Network
C RWPB Identifiers
IetfNetwork_IetfNetwork_data_Network
IetfNetwork_data_Network
YPBC Base Identifier
rw_ypbc_IetfNetwork_IetfNetwork_data_Network

Fields
NameTypeDescription
network-typesCONTAINERServes as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container.
network-idSTRINGIdentifies a network.
server-providedBOOLEANIndicates 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-networkLISTAn underlay network, used to represent layered network topologies.
nodeLISTThe inventory of nodes of this 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
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
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
IetfNetwork_data_Network_SupportingNetwork
YPBC Base Identifier
rw_ypbc_IetfNetwork_IetfNetwork_data_Network_SupportingNetwork

Fields
NameTypeDescription
network-refLEAFREFReferences 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.YangData.IetfNetwork.Network.Node
Python Proto-GI Type
IetfNetworkYang.YangData_IetfNetwork_Network_Node
C Protobuf-C Struct Type
IetfNetwork__YangData__IetfNetwork__Network__Node
C RWPB Identifiers
IetfNetwork_IetfNetwork_data_Network_Node
IetfNetwork_data_Network_Node
YPBC Base Identifier
rw_ypbc_IetfNetwork_IetfNetwork_data_Network_Node

Fields
NameTypeDescription
node-idSTRINGIdentifies a node uniquely within the containing network.
supporting-nodeLISTRepresents another node, in an underlay network, that this node is supported by. Used to represent layering structure.

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
IetfNetwork_data_Network_Node_SupportingNode
YPBC Base Identifier
rw_ypbc_IetfNetwork_IetfNetwork_data_Network_Node_SupportingNode

Fields
NameTypeDescription
network-refLEAFREFReferences the underlay network that the underlay node is part of.
node-refLEAFREFReferences the underlay node itself.