rfc-8530

YANG Model for Logical Network Elements

L. Berger, C. Hopps, A. Lindem, D. Bogdanovic, X. Liu
date2019-03 streamIETF areartg wgrtgwg statusPROPOSED STANDARD pages49 canonicalhttps://www.rfc-editor.org/rfc/rfc8530 doi10.17487/RFC8530
This document defines a logical network element (LNE) YANG module that is compliant with the Network Management Datastore Architecture (NMDA). This module can be used to manage the logical resource partitioning that may be present on a network device. Examples of common industry terms for logical resource partitioning are logical systems or logical routers. The YANG model in this document conforms with NMDA as defined in RFC 8342.

Extracted elements (22)

design-rationale §1

An LNE is modeled as an independently managed virtual device analogous to a virtual machine guest: it has its own management interfaces, YANG models, and namespace, so multiple LNEs may each define a 'Tunnel0' without conflict. This independence is expressed via the YANG Schema Mount 'root' mount point rather than a flat namespace.

yang, netconf, routing

design-rationale §2

Interface assignment is performed at the host level via bind-lne-name augmenting ietf-interfaces; to assign an interface to both an LNE and a Network Instance (NI), it is first assigned to the LNE, and then within that LNE's interface model it is assigned to an NI using RFC 8529 mechanisms.

yang, netconf, routing

design-rationale §3.3

The 'inline' schema-mount approach is anticipated for self-managed LNEs (managed=false) where each LNE may have a different module set, while 'shared-schema' is expected when all LNEs share the same schema, enabling more efficient representation at the host level.

yang, netconf

design-rationale §3.3

The 'managed' boolean distinguishes host-device-managed LNEs (where the host can read/write the LNE's mounted data tree) from self-managed LNEs (where only the LNE's own management sessions have access). This distinction is necessary because some implementations—particularly those using traditional hypervisors—cannot expose LNE internals to the host.

yang, netconf

interoperability-note §1

The logical-network-element module currently defines only a single augmentation for interface assignment (bind-lne-name). Future modules defining other host device resources (hardware, QoS, etc.) are expected to provide parallel augmentations for assigning those resources to LNEs.

yang, netconf, routing

interoperability-note §3.1

The name of the system-created interface within the LNE is a local matter and may be identical or completely different from the name used in the host device context; implementations may rename assigned interfaces (e.g., host 'Ethernet0/1' becomes LNE 'eth1').

yang, netconf

normative-requirement §3 MUST

An LNE root MUST contain at least the YANG library (RFC 7895) and the interface module (RFC 8343).

yang, netconf

normative-requirement §3.3 MUST

Attempts to access information below a root node whose associated 'managed' boolean is set to 'false' MUST result in the error message indicated (error-tag 'access-denied', error-app-tag 'lne-not-managed').

yang, netconf, security

normative-requirement §6 SHOULD

If an interface assignment fails for any reason other than a missing leafref, the operation SHALL fail with error-tag 'operation-failed' and error-app-tag 'lne-assignment-failed'; a meaningful error-info SHOULD also be provided.

yang, netconf

normative-requirement §3.1 MUST

On a successful interface assignment to an LNE, an implementation MUST also make the resource available to the LNE by providing a system-created interface to the LNE.

yang, netconf, routing

normative-requirement §3.1 SHOULD

The system-created interface representing an assigned resource within the LNE SHOULD be exposed via the LNE-specific instance of the interface model (RFC 8343).

yang, netconf

normative-requirement §3.1 MUST

When bind-lne-name is set to a valid LNE name, an implementation MUST take whatever steps are internally necessary to assign the interface to the LNE or provide an error message with an indication of why the assignment failed.

yang, netconf, routing

normative-requirement §3.3 MUST

When LNE information is available from both the host device and from within the context of the LNE, the same information MUST be made available via the 'root' element, with paths modified as described in RFC 8528.

yang, netconf

normative-requirement §3.3 MUST

When 'shared-schema' is used with an LNE mount point, the YANG library rooted in the LNE's mount point MUST match the associated schema defined according to the ietf-yang-schema-mount module.

yang, netconf

normative-requirement §3.3 REQUIRED

When the 'managed' boolean is 'true', LNE information SHALL be accessible from the context of the host device; when the associated schema-mount 'config' leaf is 'true', LNE information SHALL also be modifiable from the host device context.

yang, netconf

protocol-element §3

The 'bind-lne-name-failed' notification is generated asynchronously when an interface-to-LNE assignment fails after initial success was returned; it carries mandatory 'name' and 'bind-lne-name' leafrefs and an optional 'error-info' string.

yang, netconf

protocol-element §3

The ietf-logical-network-element YANG module defines a container 'logical-network-elements' holding a list 'logical-network-element' keyed by 'name', with leaves for 'name' (string), 'managed' (boolean, default true), 'description' (string), and a schema mount point 'root'.

yang, netconf, routing

protocol-element §2

The module augments /if:interfaces/if:interface with a 'bind-lne-name' leaf (type leafref pointing to /logical-network-elements/logical-network-element/name) to associate an interface with an LNE.

yang, netconf, routing

protocol-element §3

The 'root' container within each logical-network-element entry is a YANG Schema Mount point (RFC 8528) that exposes the root of the LNE's independent YANG data tree; it SHALL always contain a YANG library (RFC 7895) and interfaces (RFC 8343) instance.

yang, netconf

registry §5

This document registers a URI 'urn:ietf:params:xml:ns:yang:ietf-logical-network-element' in the IETF XML Registry (RFC 3688) and registers the module name 'ietf-logical-network-element' with prefix 'lne' in the YANG Module Names registry (RFC 6020).

registry, yang

security-consideration §4

The bind-lne-name leaf is a high-impact configuration parameter: removing an interface from an LNE is similar to physically removing a hardware interface and can severely disrupt the LNE's operation. Implementations should carefully control when changes to this leaf are permitted.

security, yang, netconf

security-consideration §4

The YANG module MUST be accessed via secure transports: NETCONF over SSH (RFC 6242) or RESTCONF over HTTPS/TLS (RFC 8446); access control is provided by NACM (RFC 8341). The 'managed' leaf is particularly sensitive in multi-party environments where the LNE operator may not wish to share LNE information with the host device operator.

security, yang, netconf, tls